151 lines
4.9 KiB
PHP
151 lines
4.9 KiB
PHP
<?php
|
||
/************************************************************************
|
||
* This file is part of EspoCRM.
|
||
*
|
||
* EspoCRM – Open Source CRM application.
|
||
* Copyright (C) 2014-2025 EspoCRM, Inc.
|
||
* Website: https://www.espocrm.com
|
||
*
|
||
* This program is free software: you can redistribute it and/or modify
|
||
* it under the terms of the GNU Affero General Public License as published by
|
||
* the Free Software Foundation, either version 3 of the License, or
|
||
* (at your option) any later version.
|
||
*
|
||
* This program is distributed in the hope that it will be useful,
|
||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
* GNU Affero General Public License for more details.
|
||
*
|
||
* You should have received a copy of the GNU Affero General Public License
|
||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
*
|
||
* The interactive user interfaces in modified source and object code versions
|
||
* of this program must display Appropriate Legal Notices, as required under
|
||
* Section 5 of the GNU Affero General Public License version 3.
|
||
*
|
||
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
|
||
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
|
||
************************************************************************/
|
||
|
||
namespace Espo\Core\Binding;
|
||
|
||
use Closure;
|
||
use Espo\Core\Binding\Key\NamedClassKey;
|
||
|
||
class BindingContainerBuilder
|
||
{
|
||
private BindingData $data;
|
||
private Binder $binder;
|
||
|
||
public function __construct()
|
||
{
|
||
$this->data = new BindingData();
|
||
$this->binder = new Binder($this->data);
|
||
}
|
||
|
||
/**
|
||
* Bind an interface to an implementation.
|
||
*
|
||
* @template T of object
|
||
* @param class-string<T>|NamedClassKey<T> $key An interface or interface with a parameter name.
|
||
* @param class-string<T> $implementationClassName An implementation class name.
|
||
*/
|
||
public function bindImplementation(string|NamedClassKey $key, string $implementationClassName): self
|
||
{
|
||
$this->binder->bindImplementation($key, $implementationClassName);
|
||
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Bind an interface to a specific service.
|
||
*
|
||
* @param class-string<object>|NamedClassKey<object> $key An interface or interface with a parameter name.
|
||
* @param string $serviceName A service name.
|
||
* @noinspection PhpUnused
|
||
*/
|
||
public function bindService(string|NamedClassKey $key, string $serviceName): self
|
||
{
|
||
$this->binder->bindService($key, $serviceName);
|
||
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Bind an interface to a callback.
|
||
*
|
||
* @template T of object
|
||
* @param class-string<T>|NamedClassKey<T> $key An interface or interface with a parameter name.
|
||
* @param Closure $callback A callback that will resolve a dependency.
|
||
* @todo Change to Closure(...): T Once https://github.com/phpstan/phpstan/issues/8214 is implemented.
|
||
* @noinspection PhpUnused
|
||
*/
|
||
public function bindCallback(string|NamedClassKey $key, Closure $callback): self
|
||
{
|
||
$this->binder->bindCallback($key, $callback);
|
||
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Bind an interface to a specific instance.
|
||
*
|
||
* @template T of object
|
||
* @param class-string<T>|NamedClassKey<T> $key An interface or interface with a parameter name.
|
||
* @param T $instance An instance.
|
||
* @noinspection PhpDocSignatureInspection
|
||
*/
|
||
public function bindInstance(string|NamedClassKey $key, object $instance): self
|
||
{
|
||
$this->binder->bindInstance($key, $instance);
|
||
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Bind an interface to a factory.
|
||
*
|
||
* @template T of object
|
||
* @param class-string<T>|NamedClassKey<T> $key An interface or interface with a parameter name.
|
||
* @param class-string<Factory<T>> $factoryClassName A factory class name.
|
||
* @noinspection PhpUnused
|
||
*/
|
||
public function bindFactory(string|NamedClassKey $key, string $factoryClassName): self
|
||
{
|
||
$this->binder->bindFactory($key, $factoryClassName);
|
||
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Creates a contextual binder and pass it as an argument of a callback.
|
||
*
|
||
* @param class-string<object> $className A context.
|
||
* @param Closure(ContextualBinder): void $callback A callback with a `ContextualBinder` argument.
|
||
*/
|
||
public function inContext(string $className, Closure $callback): self
|
||
{
|
||
$contextualBinder = new ContextualBinder($this->data, $className);
|
||
|
||
$callback($contextualBinder);
|
||
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Build.
|
||
*/
|
||
public function build(): BindingContainer
|
||
{
|
||
return new BindingContainer($this->data);
|
||
}
|
||
|
||
/**
|
||
* Create an instance.
|
||
*/
|
||
public static function create(): self
|
||
{
|
||
return new self();
|
||
}
|
||
}
|