EspoCRM – Open Source CRM Application
PHP calendarcontactscrmcrm-platformcrm-systemcustomer-portalcustomer-supportcustomizabledocumentsemail-marketingkanbanleadsopen-sourcephpplatformsales-automationsingle-page-applicationsupport
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 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\Formula;
use Espo\Core\Binding\BindingContainerBuilder;
use Espo\Core\Formula\Exceptions\UnknownFunction;
use Espo\Core\Formula\Functions\Base;
use Espo\Core\Formula\Functions\BaseFunction;
use Espo\ORM\Entity;
use Espo\Core\InjectableFactory;
use ReflectionClass;
use stdClass;
class FunctionFactory
{
/** @var array<string, class-string<BaseFunction|Func|Base>> */
private $classNameMap;
/**
* @param array<string, class-string<BaseFunction|Func|Base>> $classNameMap
*/
public function __construct(
private Processor $processor,
private InjectableFactory $injectableFactory,
private AttributeFetcher $attributeFetcher,
?array $classNameMap = null
) {
$this->classNameMap = $classNameMap ?? [];
}
/**
* @throws UnknownFunction
*/
public function create(
string $name,
?Entity $entity = null,
?stdClass $variables = null
): Func|FuncVariablesAware|BaseFunction|Base {
if ($this->classNameMap && array_key_exists($name, $this->classNameMap)) {
$className = $this->classNameMap[$name];
} else {
$arr = explode('\\', $name);
foreach ($arr as $i => $part) {
if ($i < count($arr) - 1) {
$part = $part . 'Group';
}
$arr[$i] = ucfirst($part);
}
$typeName = implode('\\', $arr);
/** @var class-string<Func|FuncVariablesAware|BaseFunction|Base> $className */
$className = 'Espo\\Core\\Formula\\Functions\\' . $typeName . 'Type';
}
if (!class_exists($className)) {
throw new UnknownFunction("Unknown function: " . $name);
}
$class = new ReflectionClass($className);
if (
$class->implementsInterface(Func::class) ||
$class->implementsInterface(FuncVariablesAware::class)
) {
$binding = new BindingContainerBuilder();
if ($entity) {
$binding->bindInstance(Entity::class, $entity);
}
return $this->injectableFactory->createWithBinding($className, $binding->build());
}
$object = $this->injectableFactory->createWith($className, [
'name' => $name,
'processor' => $this->processor,
'entity' => $entity,
'variables' => $variables,
'attributeFetcher' => $this->attributeFetcher,
]);
if (method_exists($object, 'setAttributeFetcher')) {
$object->setAttributeFetcher($this->attributeFetcher);
}
/** @var BaseFunction|Base */
return $object;
}
}