format.php

См. документацию.

<?php
 
namespace Bitrix\Location\Entity;
 
use Bitrix\Location\Entity\Address\FieldType;
use Bitrix\Location\Entity\Format\Converter\ArrayConverter;
use Bitrix\Location\Entity\Format\FieldCollection;
use Bitrix\Location\Entity\Format\Template;
use Bitrix\Location\Entity\Format\TemplateCollection;
use Bitrix\Location\Entity\Format\TemplateType;
use Bitrix\Main\Web\Json;

final class Format
{
    private $name = '';
    private $description = '';
    private $code = '';
    private $languageId;
    private $delimiter = '';
    private $fieldForUnRecognized = FieldType::UNKNOWN;
    private $fieldCollection;
    private $templateCollection;

    public function __construct(string $languageId)
    {
        $this->languageId = $languageId;
        $this->fieldCollection = new FieldCollection();
        $this->templateCollection = new TemplateCollection();
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function setName(string $name): Format
    {
        $this->name = $name;
        return $this;
    }

    public function getDescription(): string
    {
        return $this->description;
    }

    public function setDescription(string $description): Format
    {
        $this->description = $description;
        return $this;
    }

    public function getLanguageId(): string
    {
        return $this->languageId;
    }

    public function setLanguageId(string $languageId): Format
    {
        $this->languageId = $languageId;
        return $this;
    }

    public function getCode(): string
    {
        return $this->code;
    }

    public function setCode(string $code): Format
    {
        $this->code = $code;
        return $this;
    }

    public function setFieldCollection(FieldCollection $fieldCollection): self
    {
        $this->fieldCollection = $fieldCollection;
        return $this;
    }

    public function getFieldCollection(): FieldCollection
    {
        return $this->fieldCollection;
    }

    public function toJson(): string
    {
        return Json::encode(ArrayConverter::convertToArray($this));
    }

    public function getTemplate(string $type = TemplateType::DEFAULT): ?Template
    {
        return $this->templateCollection->getTemplate($type);
    }

    public function getTemplateCollection(): TemplateCollection
    {
        return $this->templateCollection;
    }

    public function setTemplateCollection(TemplateCollection $templateCollection): self
    {
        $this->templateCollection = $templateCollection;
        return $this;
    }

    public function getDelimiter(): string
    {
        return $this->delimiter;
    }

    public function setDelimiter(string $delimiter): self
    {
        $this->delimiter = $delimiter;
        return $this;
    }

    public function setFieldForUnRecognized(int $fieldType): self
    {
        $this->fieldForUnRecognized = $fieldType;
        return $this;
    }

    public function getFieldForUnRecognized(): int
    {
        return $this->fieldForUnRecognized;
    }
}