Initial commit
This commit is contained in:
44
application/Espo/Core/Utils/Metadata/AdditionalBuilder.php
Normal file
44
application/Espo/Core/Utils/Metadata/AdditionalBuilder.php
Normal file
@@ -0,0 +1,44 @@
|
||||
<?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\Utils\Metadata;
|
||||
|
||||
use stdClass;
|
||||
|
||||
/**
|
||||
* An additional metadata builder. Allows adding conditional metadata.
|
||||
* Warning: Dependency injection is not available here. Instantiate
|
||||
* needed classes explicitly.
|
||||
*
|
||||
* @since 8.4.0
|
||||
*/
|
||||
interface AdditionalBuilder
|
||||
{
|
||||
public function build(stdClass $data): void;
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
<?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\Utils\Metadata\AdditionalBuilder;
|
||||
|
||||
use Espo\Core\Utils\Metadata\AdditionalBuilder;
|
||||
use stdClass;
|
||||
|
||||
class DeleteIdField implements AdditionalBuilder
|
||||
{
|
||||
public function build(stdClass $data): void
|
||||
{
|
||||
if (!isset($data->entityDefs)) {
|
||||
return;
|
||||
}
|
||||
|
||||
foreach (get_object_vars($data->entityDefs) as $entityType => $entityDefsItem) {
|
||||
if (!($entityDefsItem->deleteId ?? false)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$entityDefsItem->fields ??= (object) [];
|
||||
|
||||
$data->entityDefs->$entityType->fields->deleteId = (object) [
|
||||
"type" => "varchar",
|
||||
"maxLength" => 17,
|
||||
"readOnly" => true,
|
||||
"notNull" => true,
|
||||
"default" => "0",
|
||||
"utility" => true,
|
||||
"customizationDisabled" => true
|
||||
];
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,106 @@
|
||||
<?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\Utils\Metadata\AdditionalBuilder;
|
||||
|
||||
use Espo\Core\Utils\DataUtil;
|
||||
use Espo\Core\Utils\Metadata\AdditionalBuilder;
|
||||
use Espo\Core\Utils\Metadata\BuilderHelper;
|
||||
use Espo\Core\Utils\Util;
|
||||
use stdClass;
|
||||
|
||||
class Fields implements AdditionalBuilder
|
||||
{
|
||||
private BuilderHelper $builderHelper;
|
||||
|
||||
public function __construct()
|
||||
{
|
||||
$this->builderHelper = new BuilderHelper();
|
||||
}
|
||||
|
||||
public function build(stdClass $data): void
|
||||
{
|
||||
if (!isset($data->entityDefs)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$defs = Util::objectToArray($data->fields);
|
||||
|
||||
foreach (get_object_vars($data->entityDefs) as $entityType => $entityDefsItem) {
|
||||
if (isset($data->entityDefs->$entityType->collection)) {
|
||||
/** @var stdClass $collectionItem */
|
||||
$collectionItem = $data->entityDefs->$entityType->collection;
|
||||
|
||||
if (isset($collectionItem->orderBy)) {
|
||||
$collectionItem->sortBy = $collectionItem->orderBy;
|
||||
} else if (isset($collectionItem->sortBy)) {
|
||||
$collectionItem->orderBy = $collectionItem->sortBy;
|
||||
}
|
||||
|
||||
if (isset($collectionItem->order)) {
|
||||
$collectionItem->asc = $collectionItem->order === 'asc';
|
||||
} else if (isset($collectionItem->asc)) {
|
||||
$collectionItem->order = $collectionItem->asc === true ? 'asc' : 'desc';
|
||||
}
|
||||
}
|
||||
|
||||
if (!isset($entityDefsItem->fields)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach (get_object_vars($entityDefsItem->fields) as $field => $fieldDefsItem) {
|
||||
$additionalFields = $this->builderHelper->getAdditionalFields(
|
||||
field: $field,
|
||||
params: Util::objectToArray($fieldDefsItem),
|
||||
defs: $defs,
|
||||
);
|
||||
|
||||
if (!$additionalFields) {
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach ($additionalFields as $subFieldName => $subFieldParams) {
|
||||
$item = Util::arrayToObject($subFieldParams);
|
||||
|
||||
if (isset($entityDefsItem->fields->$subFieldName)) {
|
||||
$data->entityDefs->$entityType->fields->$subFieldName =
|
||||
DataUtil::merge(
|
||||
$item,
|
||||
$entityDefsItem->fields->$subFieldName
|
||||
);
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
$data->entityDefs->$entityType->fields->$subFieldName = $item;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,67 @@
|
||||
<?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\Utils\Metadata\AdditionalBuilder;
|
||||
|
||||
use Espo\Core\Utils\Metadata\AdditionalBuilder;
|
||||
use stdClass;
|
||||
|
||||
/**
|
||||
* @noinspection PhpUnused
|
||||
*/
|
||||
class FilterFields implements AdditionalBuilder
|
||||
{
|
||||
public function __construct()
|
||||
{}
|
||||
|
||||
public function build(stdClass $data): void
|
||||
{
|
||||
if (!isset($data->entityDefs)) {
|
||||
return;
|
||||
}
|
||||
|
||||
foreach (get_object_vars($data->entityDefs) as $entityDefsItem) {
|
||||
if (isset($entityDefsItem->fields) && is_object($entityDefsItem->fields)) {
|
||||
foreach (get_object_vars($entityDefsItem->fields) as $field => $fieldDefsItem) {
|
||||
if (!isset($fieldDefsItem->type)) {
|
||||
unset($entityDefsItem->fields->$field);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($entityDefsItem->links) && is_object($entityDefsItem->links)) {
|
||||
foreach (get_object_vars($entityDefsItem->links) as $link => $linkDefsItem) {
|
||||
if (!isset($linkDefsItem->type)) {
|
||||
unset($entityDefsItem->links->$link);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,168 @@
|
||||
<?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\Utils\Metadata\AdditionalBuilder;
|
||||
|
||||
use Espo\Core\Utils\Metadata\AdditionalBuilder;
|
||||
use Espo\Core\Utils\ObjectUtil;
|
||||
use stdClass;
|
||||
|
||||
/**
|
||||
* Establishes backward compatibility of clientDefs > {scope} > dynamicLogic.
|
||||
* The dynamic logic is NOT supposed to be set in custom clientDefs as of v9.1.
|
||||
* The custom dynamic logic is supposed to be moved to logicDefs by an upgrade script.
|
||||
* But extensions can have a dynamic logic defined in clientDefs as they may be supposed
|
||||
* to be compatible with older Espo versions.
|
||||
*
|
||||
* @noinspection PhpUnused
|
||||
*/
|
||||
class LogicDefsBc implements AdditionalBuilder
|
||||
{
|
||||
public function build(stdClass $data): void
|
||||
{
|
||||
if (!isset($data->clientDefs)) {
|
||||
return;
|
||||
}
|
||||
|
||||
/** @var array<string, stdClass> $clientDefs */
|
||||
$clientDefs = get_object_vars($data->clientDefs);
|
||||
|
||||
foreach ($clientDefs as $scope => $defs) {
|
||||
$this->processScope($scope, $data);
|
||||
}
|
||||
}
|
||||
|
||||
private function processScope(string $scope, stdClass $data): void
|
||||
{
|
||||
if (!isset($data->clientDefs->$scope)) {
|
||||
return;
|
||||
}
|
||||
|
||||
/** @var stdClass $clientDefs */
|
||||
$clientDefs = $data->clientDefs->$scope;
|
||||
|
||||
if (!isset($clientDefs->dynamicLogic)) {
|
||||
return;
|
||||
}
|
||||
|
||||
/** @var stdClass $dynamicLogic */
|
||||
$dynamicLogic = $clientDefs->dynamicLogic;
|
||||
|
||||
$keys = [
|
||||
'fields',
|
||||
'panels',
|
||||
];
|
||||
|
||||
$subKeys = [
|
||||
'visible',
|
||||
'required',
|
||||
'readOnly',
|
||||
'invalid',
|
||||
];
|
||||
|
||||
$data->logicDefs ??= (object) [];
|
||||
$data->logicDefs->$scope ??= (object) [];
|
||||
|
||||
/** @var stdClass $logicDefs */
|
||||
$logicDefs = $data->logicDefs->$scope;
|
||||
|
||||
$customFile = "custom/Espo/Custom/Resources/metadata/logicDefs/$scope.json";
|
||||
|
||||
$customLogicDefs = file_exists($customFile) ?
|
||||
json_decode(file_get_contents($customFile) ?: '') :
|
||||
null;
|
||||
|
||||
if (!$customLogicDefs instanceof stdClass) {
|
||||
$customLogicDefs = (object) [];
|
||||
}
|
||||
|
||||
foreach ($keys as $key) {
|
||||
if (!isset($dynamicLogic->$key) || !is_object($dynamicLogic->$key)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
/** @var array<string, stdClass> $defs */
|
||||
$defs = get_object_vars($dynamicLogic->$key);
|
||||
|
||||
foreach ($defs as $name => $subDefs) {
|
||||
|
||||
foreach ($subKeys as $subKey) {
|
||||
if (!property_exists($subDefs, $subKey)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (
|
||||
isset($customLogicDefs->$key->$name) &&
|
||||
property_exists($customLogicDefs->$key->$name, $subKey)
|
||||
) {
|
||||
// Overridden in custom.
|
||||
continue;
|
||||
}
|
||||
|
||||
/** @var stdClass|null $item */
|
||||
$item = $subDefs->$subKey;
|
||||
|
||||
$logicDefs->$key ??= (object) [];
|
||||
|
||||
// Fix if corrupted.
|
||||
if (is_array($logicDefs->$key)) {
|
||||
$logicDefs->$key = (object) [];
|
||||
}
|
||||
|
||||
$logicDefs->$key->$name ??= (object) [];
|
||||
|
||||
$logicDefs->$key->$name->$subKey = $item !== null ?
|
||||
ObjectUtil::clone($item) :
|
||||
null;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($dynamicLogic->options)) {
|
||||
/** @var array<string, stdClass[]> $defs */
|
||||
$defs = get_object_vars($dynamicLogic->options);
|
||||
|
||||
foreach ($defs as $name => $subDefs) {
|
||||
if (
|
||||
isset($customLogicDefs->options) &&
|
||||
property_exists($customLogicDefs->options, $name)
|
||||
) {
|
||||
// Overridden in custom.
|
||||
continue;
|
||||
}
|
||||
|
||||
$logicDefs->options ??= (object) [];
|
||||
|
||||
$logicDefs->options->$name = $subDefs !== null ?
|
||||
array_map(fn ($it) => ObjectUtil::clone($it), $subDefs) :
|
||||
null;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,67 @@
|
||||
<?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\Utils\Metadata\AdditionalBuilder;
|
||||
|
||||
use Espo\Core\Name\Field;
|
||||
use Espo\Core\ORM\Type\FieldType;
|
||||
use Espo\Core\Utils\Metadata\AdditionalBuilder;
|
||||
use stdClass;
|
||||
|
||||
class StreamUpdatedAtField implements AdditionalBuilder
|
||||
{
|
||||
public function build(stdClass $data): void
|
||||
{
|
||||
if (!isset($data->entityDefs)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$field = Field::STREAM_UPDATED_AT;
|
||||
|
||||
foreach (get_object_vars($data->entityDefs) as $entityType => $entityDefsItem) {
|
||||
$hasStream = $data->scopes?->$entityType->stream ?? false;
|
||||
|
||||
if (!$hasStream) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (isset($entityDefsItem?->fields->$field)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$entityDefsItem->fields ??= (object) [];
|
||||
|
||||
$entityDefsItem->fields->$field = (object) [
|
||||
'type' => FieldType::DATETIME,
|
||||
'readOnly' => true,
|
||||
'customizationReadOnlyDisabled' => true,
|
||||
];
|
||||
}
|
||||
}
|
||||
}
|
||||
113
application/Espo/Core/Utils/Metadata/Builder.php
Normal file
113
application/Espo/Core/Utils/Metadata/Builder.php
Normal file
@@ -0,0 +1,113 @@
|
||||
<?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\Utils\Metadata;
|
||||
|
||||
use Espo\Core\Utils\Resource\Reader as ResourceReader;
|
||||
use Espo\Core\Utils\Resource\Reader\Params as ResourceReaderParams;
|
||||
use Espo\Core\Utils\Util;
|
||||
use stdClass;
|
||||
|
||||
class Builder
|
||||
{
|
||||
/** @var array<int, string[]> */
|
||||
private $forceAppendPathList = [
|
||||
['app', 'metadata', 'additionalBuilderClassNameList'],
|
||||
['app', 'rebuild', 'actionClassNameList'],
|
||||
['app', 'formula', 'functionList'],
|
||||
['app', 'fieldProcessing', 'readLoaderClassNameList'],
|
||||
['app', 'fieldProcessing', 'listLoaderClassNameList'],
|
||||
['app', 'fieldProcessing', 'saverClassNameList'],
|
||||
['app', 'hook', 'suppressClassNameList'],
|
||||
['app', 'api', 'globalMiddlewareClassNameList'],
|
||||
['app', 'api', 'routeMiddlewareClassNameListMap', self::ANY_KEY],
|
||||
['app', 'api', 'controllerMiddlewareClassNameListMap', self::ANY_KEY],
|
||||
['app', 'api', 'controllerActionMiddlewareClassNameListMap', self::ANY_KEY],
|
||||
['app', 'entityManager', 'createHookClassNameList'],
|
||||
['app', 'entityManager', 'deleteHookClassNameList'],
|
||||
['app', 'entityManager', 'updateHookClassNameList'],
|
||||
['app', 'linkManager', 'createHookClassNameList'],
|
||||
['app', 'linkManager', 'deleteHookClassNameList'],
|
||||
['app', 'client', 'scriptList'],
|
||||
['app', 'client', 'cssList'],
|
||||
['app', 'client', 'linkList'],
|
||||
['recordDefs', self::ANY_KEY, 'readLoaderClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'listLoaderClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'saverClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'selectApplierClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'createInputFilterClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'updateInputFilterClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'outputFilterClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'beforeReadHookClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'earlyBeforeCreateHookClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'beforeCreateHookClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'earlyBeforeUpdateHookClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'beforeUpdateHookClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'beforeDeleteHookClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'afterCreateHookClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'afterUpdateHookClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'afterDeleteHookClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'beforeLinkHookClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'beforeUnlinkHookClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'afterLinkHookClassNameList'],
|
||||
['recordDefs', self::ANY_KEY, 'afterUnlinkHookClassNameList'],
|
||||
];
|
||||
|
||||
private const ANY_KEY = '__ANY__';
|
||||
|
||||
public function __construct(private ResourceReader $resourceReader) {}
|
||||
|
||||
public function build(): stdClass
|
||||
{
|
||||
$readerParams = ResourceReaderParams::create()
|
||||
->withForceAppendPathList($this->forceAppendPathList);
|
||||
|
||||
$data = $this->resourceReader->read('metadata', $readerParams);
|
||||
|
||||
$this->applyAdditional($data);
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
private function applyAdditional(stdClass $data): void
|
||||
{
|
||||
/** @var class-string<AdditionalBuilder>[] $builderClassNameList */
|
||||
$builderClassNameList = Util::getValueByKey($data, 'app.metadata.additionalBuilderClassNameList') ?? [];
|
||||
|
||||
/** @var AdditionalBuilder[] $builderList */
|
||||
$builderList = array_map(
|
||||
fn ($className) => new $className(),
|
||||
$builderClassNameList
|
||||
);
|
||||
|
||||
foreach ($builderList as $builder) {
|
||||
$builder->build($data);
|
||||
}
|
||||
}
|
||||
}
|
||||
117
application/Espo/Core/Utils/Metadata/BuilderHelper.php
Normal file
117
application/Espo/Core/Utils/Metadata/BuilderHelper.php
Normal file
@@ -0,0 +1,117 @@
|
||||
<?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\Utils\Metadata;
|
||||
|
||||
use Espo\Core\Utils\Util;
|
||||
use Espo\ORM\Defs\Params\FieldParam;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
class BuilderHelper
|
||||
{
|
||||
/**
|
||||
* A list of copy-from-parent params for metadata -> fields.
|
||||
*
|
||||
* @var string[]
|
||||
*/
|
||||
private array $copiedDefParams = [
|
||||
'readOnly',
|
||||
'disabled',
|
||||
FieldParam::NOT_STORABLE,
|
||||
'layoutListDisabled',
|
||||
'layoutDetailDisabled',
|
||||
'layoutMassUpdateDisabled',
|
||||
'layoutFiltersDisabled',
|
||||
'directAccessDisabled',
|
||||
'directUpdateDisabled',
|
||||
'customizationDisabled',
|
||||
'importDisabled',
|
||||
'exportDisabled',
|
||||
];
|
||||
|
||||
private string $defaultFieldNaming = 'postfix';
|
||||
|
||||
/**
|
||||
* Get additional field list based on field definition in metadata 'fields'.
|
||||
*
|
||||
* @param string $field
|
||||
* @param array<string, mixed> $params
|
||||
* @param array<string, mixed> $defs
|
||||
* @return ?array<string, mixed>
|
||||
* @internal
|
||||
*/
|
||||
public function getAdditionalFields(string $field, array $params, array $defs): ?array
|
||||
{
|
||||
if (!$defs) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$type = $params['type'] ?? null;
|
||||
|
||||
if (!$type) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$typeDefs = $defs[$type] ?? null;
|
||||
|
||||
if (!$typeDefs) {
|
||||
return null;
|
||||
}
|
||||
|
||||
/** @var ?array<string, mixed> $fields */
|
||||
$fields = $typeDefs['fields'] ?? null;
|
||||
/** @var string $naming */
|
||||
$naming = $typeDefs['naming'] ?? $this->defaultFieldNaming;;
|
||||
|
||||
if (!is_array($fields)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$copiedParams = array_intersect_key($params, array_flip($this->copiedDefParams));
|
||||
|
||||
$output = [];
|
||||
|
||||
foreach ($fields as $subField => $subParams) {
|
||||
$subName = Util::getNaming($field, $subField, $naming);
|
||||
|
||||
$output[$subName] = array_merge($copiedParams, $subParams);
|
||||
|
||||
// A trick to allow some fields to be combined with the main field.
|
||||
if (array_key_exists('detailLayoutIncompatibleFieldList', $output[$subName])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$output[$subName]['detailLayoutIncompatibleFieldList'] = [$field];
|
||||
}
|
||||
|
||||
return $output;
|
||||
}
|
||||
}
|
||||
104
application/Espo/Core/Utils/Metadata/Helper.php
Normal file
104
application/Espo/Core/Utils/Metadata/Helper.php
Normal file
@@ -0,0 +1,104 @@
|
||||
<?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\Utils\Metadata;
|
||||
|
||||
use Espo\Core\Utils\Metadata;
|
||||
|
||||
class Helper
|
||||
{
|
||||
public function __construct(private Metadata $metadata)
|
||||
{}
|
||||
|
||||
/**
|
||||
* Get field definitions by a type in metadata, "fields" key.
|
||||
*
|
||||
* @param array<string, mixed> $defs It can be a string or field definition from entityDefs.
|
||||
* @return ?array<string, mixed>
|
||||
*/
|
||||
public function getFieldDefsByType($defs)
|
||||
{
|
||||
if (isset($defs['type'])) {
|
||||
return $this->metadata->get('fields.' . $defs['type']);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $defs
|
||||
* @return ?array<string, mixed>
|
||||
*/
|
||||
public function getFieldDefsInFieldMetadata($defs)
|
||||
{
|
||||
$fieldDefsByType = $this->getFieldDefsByType($defs);
|
||||
|
||||
if (isset($fieldDefsByType['fieldDefs'])) {
|
||||
return $fieldDefsByType['fieldDefs'];
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get link definition defined in 'fields' metadata.
|
||||
* In linkDefs can be used as value (e.g. "type": "hasChildren") and/or variables (e.g. "entityName": "{entity}").
|
||||
* Variables should be defined into fieldDefs (in 'entityDefs' metadata).
|
||||
*
|
||||
* @param string $entityType
|
||||
* @param array<string, mixed> $defs
|
||||
* @return ?array<string, mixed>
|
||||
*/
|
||||
public function getLinkDefsInFieldMeta($entityType, $defs)
|
||||
{
|
||||
$fieldDefsByType = $this->getFieldDefsByType($defs);
|
||||
|
||||
if (!isset($fieldDefsByType['linkDefs'])) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$linkFieldDefsByType = $fieldDefsByType['linkDefs'];
|
||||
|
||||
foreach ($linkFieldDefsByType as &$paramValue) {
|
||||
if (preg_match('/{(.*?)}/', $paramValue, $matches)) {
|
||||
if (in_array($matches[1], array_keys($defs))) {
|
||||
$value = $defs[$matches[1]];
|
||||
} else if (strtolower($matches[1]) == 'entity') {
|
||||
$value = $entityType;
|
||||
}
|
||||
|
||||
if (isset($value)) {
|
||||
$paramValue = str_replace('{'.$matches[1].'}', $value, $paramValue);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $linkFieldDefsByType;
|
||||
}
|
||||
}
|
||||
117
application/Espo/Core/Utils/Metadata/OrmMetadataData.php
Normal file
117
application/Espo/Core/Utils/Metadata/OrmMetadataData.php
Normal file
@@ -0,0 +1,117 @@
|
||||
<?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\Utils\Metadata;
|
||||
|
||||
use Espo\Core\InjectableFactory;
|
||||
use Espo\Core\Utils\Config;
|
||||
use Espo\Core\Utils\Database\Orm\Converter;
|
||||
use Espo\Core\Utils\DataCache;
|
||||
use Espo\Core\Utils\Util;
|
||||
|
||||
class OrmMetadataData
|
||||
{
|
||||
/** @var ?array<string, array<string, mixed>> */
|
||||
private $data = null;
|
||||
private string $cacheKey = 'ormMetadata';
|
||||
private bool $useCache;
|
||||
private ?Converter $converter = null;
|
||||
|
||||
public function __construct(
|
||||
private DataCache $dataCache,
|
||||
private InjectableFactory $injectableFactory,
|
||||
Config\SystemConfig $systemConfig,
|
||||
) {
|
||||
$this->useCache = $systemConfig->useCache();
|
||||
}
|
||||
|
||||
private function getConverter(): Converter
|
||||
{
|
||||
if (!isset($this->converter)) {
|
||||
$this->converter = $this->injectableFactory->create(Converter::class);
|
||||
}
|
||||
|
||||
return $this->converter;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reloads data.
|
||||
*/
|
||||
public function reload(): void
|
||||
{
|
||||
$this->getDataInternal(true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get raw data.
|
||||
*
|
||||
* @return array<string, array<string, mixed>>
|
||||
*/
|
||||
public function getData(): array
|
||||
{
|
||||
return $this->getDataInternal();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, array<string, mixed>>
|
||||
*/
|
||||
private function getDataInternal(bool $reload = false): array
|
||||
{
|
||||
if (isset($this->data) && !$reload) {
|
||||
return $this->data;
|
||||
}
|
||||
|
||||
if ($this->useCache && $this->dataCache->has($this->cacheKey) && !$reload) {
|
||||
/** @var array<string, array<string, mixed>> $data */
|
||||
$data = $this->dataCache->get($this->cacheKey);
|
||||
|
||||
$this->data = $data;
|
||||
|
||||
return $this->data;
|
||||
}
|
||||
|
||||
$this->data = $this->getConverter()->process();
|
||||
|
||||
if ($this->useCache) {
|
||||
$this->dataCache->store($this->cacheKey, $this->data);
|
||||
}
|
||||
|
||||
return $this->data;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|string[]|null $key
|
||||
* @param mixed $default
|
||||
* @return mixed
|
||||
*/
|
||||
public function get($key = null, $default = null)
|
||||
{
|
||||
return Util::getValueByKey($this->getData(), $key, $default);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user