Files
espocrm/application/Espo/Core/Utils/Metadata/BuilderHelper.php
Yuri Kuznetsov c635b23b56 metadata ref
2023-11-05 10:08:23 +02:00

98 lines
3.3 KiB
PHP

<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2023 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
* Website: https://www.espocrm.com
*
* EspoCRM is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* EspoCRM 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with EspoCRM. If not, see http://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 General Public License version 3.
*
* In accordance with Section 7(b) of the GNU 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;
class BuilderHelper
{
/**
* A list of copy-from-parent params for metadata -> fields.
*
* @var string[]
*/
private array $copiedDefParams = [
'readOnly',
'disabled',
'notStorable',
'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 $fieldName
* @param array<string, mixed> $fieldParams
* @param array<string, mixed> $definitionList
* @return ?array<string, mixed>
*/
public function getAdditionalFieldList(string $fieldName, array $fieldParams, array $definitionList): ?array
{
if (empty($fieldParams['type']) || empty($definitionList)) {
return null;
}
$fieldType = $fieldParams['type'];
$fieldDefinition = $definitionList[$fieldType] ?? null;
if (
isset($fieldDefinition) &&
!empty($fieldDefinition['fields']) &&
is_array($fieldDefinition['fields'])
) {
$copiedParams = array_intersect_key($fieldParams, array_flip($this->copiedDefParams));
$additionalFields = [];
foreach ($fieldDefinition['fields'] as $subFieldName => $subFieldParams) {
$namingType = $fieldDefinition['naming'] ?? $this->defaultFieldNaming;
$subFieldNaming = Util::getNaming($fieldName, $subFieldName, $namingType);
$additionalFields[$subFieldNaming] = array_merge($copiedParams, $subFieldParams);
}
return $additionalFields;
}
return null;
}
}