columns.php

<?php
 
namespace Bitrix\Main\Grid\Column;
 
class Columns implements \IteratorAggregate, \Countable
{
    private array $providers;
    private array $columns;
    private array $providersColumns;
 
    public function __construct(DataProvider ...$providers)
    {
        $this->providers = [];
        foreach ($providers as $provider)
        {
            $this->providers[] = $provider;
        }
    }
 
    final public function getIterator(): \ArrayIterator
    {
        return new \ArrayIterator($this->getColumns());
    }
 
    final public function count(): int
    {
        return count($this->getColumns());
    }
 
    final public function getColumn(string $id): ?Column
    {
        return $this->getColumns()[$id] ?? null;
    }
 
    final public function getColumns(): array
    {
        if (!isset($this->columns))
        {
            $this->columns = [];
 
            foreach ($this->getProvidersColumns() as $providerColumns)
            {
                foreach ($providerColumns as $column)
                {
                    $this->columns[$column->getId()] = $column;
                }
            }
        }
 
        return $this->columns;
    }
 
    final protected function getProvidersColumns(): array
    {
        if (!isset($this->providersColumns))
        {
            $this->providersColumns = [];
 
            foreach ($this->providers as $provider)
            {
                $providerColumns = $provider->prepareColumns();
                if (empty($providerColumns))
                {
                    continue;
                }
 
                $providerClass = get_class($provider);
                $this->providersColumns[$providerClass] = $providerColumns;
            }
        }
 
        return $this->providersColumns;
    }
 
    public function getSelect(?array $columnIds = null, ?array $providers = null): array
    {
        $result = [];
 
        // filter by providers
        if (isset($providers))
        {
            $columns = [];
            foreach ($providers as $providerClass)
            {
                $providerColumns = $this->getProvidersColumns()[$providerClass] ?? null;
                if (!empty($providerColumns))
                {
                    array_push($columns, ...$providerColumns);
                }
            }
 
            if (empty($columns))
            {
                return [];
            }
        }
        else
        {
            $columns = $this->getColumns();
        }
 
        // filter by columns
        if (isset($columnIds))
        {
            $columnIds = array_fill_keys($columnIds, true);
            foreach ($columns as $column)
            {
                if (
                    $column->isNecessary()
                    || isset($columnIds[$column->getId()])
                )
                {
                    array_push($result, ...$column->getSelect());
                }
            }
        }
        else
        {
            foreach ($columns as $column)
            {
                array_push($result, ...$column->getSelect());
            }
        }
 
        return $result;
    }
 
    public function prepareEditableColumnsValues(array $values): array
    {
        $result = [];
 
        foreach ($this->getColumns() as $column)
        {
            if (!$column->isEditable())
            {
                continue;
            }
 
            $id = $column->getId();
            if (array_key_exists($id, $values))
            {
                $result[$id] = $values[$id];
            }
        }
 
        return $result;
    }
}