field.php

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

<?php
namespace Bitrix\Main\Filter;
 
class Field
{
    protected $dataProvider = null;
    protected $id = '';
    protected $name = '';
    protected $type = '';
    protected $isDefault = false;
    protected $data = null;
    protected $isPartial = false;
    protected $sectionId = '';
    protected $iconParams = [];
 
    protected ?string $subtype = null;
 
    public function __construct(DataProvider $dataProvider, $id, array $params = null)
    {
        $this->dataProvider = $dataProvider;
        $this->id = $id;
 
        if(!is_array($params))
        {
            $params = [];
        }
 
        $this->name = $params['name'] ?? $id;
        $this->type = $params['type'] ?? '';
        $this->isDefault = $params['default'] ?? false;
 
        $this->isPartial = $params['partial'] ?? false;
        $this->data = $params['data'] ?? null;
        $this->subtype = $params['subtype'] ?? null;
    }

    public function getDataProvider()
    {
        return $this->dataProvider;
    }

    public function setDataProvider(DataProvider $dataProvider)
    {
        $this->dataProvider = $dataProvider;
    }

    protected function prepareData()
    {
        return $this->dataProvider->prepareFieldData($this->id);
    }

    public function prepareHtml()
    {
        return $this->dataProvider->prepareFieldHtml($this);
    }

    public function getId()
    {
        return $this->id;
    }

    public function setID($id)
    {
        $this->id = $id;
    }

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

    public function setName($name)
    {
        $this->name = $name;
    }

    public function getType()
    {
        return $this->type;
    }

    public function setType($type)
    {
        $this->type = $type;
    }

    public function isDefault()
    {
        return $this->isDefault;
    }

    public function markAsDefault($isDefault)
    {
        $this->isDefault = $isDefault;
    }

    public function isPartial()
    {
        return $this->isPartial;
    }

    public function getData()
    {
        return $this->data;
    }

    public function getDataItem($key)
    {
        return $this->data !== null && isset($this->data[$key]) ? $this->data[$key] : null;
    }

    public function getSectionId(): string
    {
        return $this->sectionId;
    }

    public function setSectionId(string $sectionId): void
    {
        $this->sectionId = $sectionId;
    }

    public function getIconParams(): array
    {
        return $this->iconParams;
    }

    public function setIconParams(array $iconParams): void
    {
        $this->iconParams = $iconParams;
    }

    public function assemble()
    {
        if(!$this->isPartial)
        {
            return;
        }
 
        $this->data = $this->prepareData();
        $this->isPartial = false;
 
        if(is_array($this->data))
        {
            $html = $this->prepareHtml();
            if($html !== '')
            {
                $this->data['html'] = $html;
            }
        }
    }

    public function toArray(array $options = null)
    {
        if(!is_array($options))
        {
            $options = [];
        }
 
        $result = [ 'id' => $this->id, 'name' => $this->name ];
        if($this->type !== '')
        {
            $result['type'] = $this->type;
        }
 
        if($this->isDefault)
        {
            $result['default'] = true;
        }
 
        if ($this->sectionId !== '')
        {
            $result['sectionId'] = $this->sectionId;
        }
        if (!empty($this->iconParams))
        {
            $result['icon'] = $this->iconParams;
        }
 
        if(isset($options['lightweight']) && $options['lightweight'])
        {
            $result['lightweight'] = true;
            return $result;
        }
 
        if($this->isPartial())
        {
            $this->assemble();
        }
 
        if(is_array($this->data))
        {
            foreach($this->data as $key => $data)
            {
                $result[$key] = $data;
            }
        }
 
        if ($this->subtype)
        {
            $result['subtype'] = $this->subtype;
        }
 
        return $result;
    }
 
    public function getSubtype(): ?string
    {
        return $this->subtype;
    }
 
    public function setSubtype(?string $subtype): void
    {
        $this->subtype = $subtype;
    }
}