Skip to content

EspoCRM – Open Source CRM Application

2.7 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\Entities;

use Espo\Core\ORM\Entity;
use UnexpectedValueException;

class Template extends Entity
{
    public const string ENTITY_TYPE = 'Template';

    public const string STATUS_ACTIVE = 'Active';

    public const string FIELD_ENTITY_TYPE = 'entityType';

    /** @since 10.1.0 */
    public const string FIELD_BODY = 'body';
    /** @since 10.1.0 */
    public const string FIELD_HEADER = 'header';
    /** @since 10.1.0 */
    public const string FIELD_FOOTER = 'footer';

    public function getTargetEntityType(): string
    {
        $entityType = $this->get(self::FIELD_ENTITY_TYPE);

        if ($entityType === null) {
            throw new UnexpectedValueException();
        }

        return $entityType;
    }

    public function isActive(): bool
    {
        return $this->get('status') === self::STATUS_ACTIVE;
    }

    public function getFilename(): ?string
    {
        return $this->get('filename');
    }

    /**
     * since 10.1.0
     */
    public function getBody(): ?string
    {
        return $this->get(self::FIELD_BODY);
    }

    /**
     * since 10.1.0
     */
    public function getHeader(): ?string
    {
        return $this->get(self::FIELD_HEADER);
    }

    /**
     * since 10.1.0
     */
    public function getFooter(): ?string
    {
        return $this->get(self::FIELD_FOOTER);
    }
}