Skip to content

EspoCRM – Open Source CRM Application

2.3 KB
Raw Blame
<?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\Tools\EmailTemplate;

use Espo\Core\InjectableFactory;
use Espo\Core\Utils\Metadata;

class PlaceholdersProvider
{
    public function __construct(
        private Metadata $metadata,
        private InjectableFactory $injectableFactory
    ) {}

    /**
     * @return array{string, Placeholder}[]
     */
    public function get(): array
    {
        $defs = $this->metadata->get("app.emailTemplate.placeholders") ?? [];

        /** @var string[] $list */
        $list = array_keys($defs);

        usort($list, function ($a, $b) use ($defs) {
            $o1 = $defs[$a]['order'] ?? 0;
            $o2 = $defs[$b]['order'] ?? 0;

            return $o1 - $o2;
        });

        return array_map(function ($name) use ($defs) {
            /** @var class-string<Placeholder> $className */
            $className = $defs[$name]['className'];

            $placeholder = $this->injectableFactory->create($className);

            return [$name, $placeholder];
        }, $list);
    }
}