BaseProvider.php

<?php
 
namespace Bitrix\Iblock\Integration\UI\Grid\General;
 
use Bitrix\Main\Grid\Panel\Snippet;
use Bitrix\Main\UI\PageNavigation;
use CFile;
 
abstract class BaseProvider
{
    private array $rows;
    private ?PageNavigation $pagination = null;
 
    abstract public function getId(): string;
 
    abstract public function getColumns(): array;
 
    protected function getTemplateRow(): ?array
    {
        return null;
    }
 
    public function setRows(array $rows): void
    {
        $this->rows = $rows;
    }
 
    protected function getRows(): array
    {
        $result = $this->rows ?? [];
 
        $templateRow = $this->getTemplateRow();
        if (isset($templateRow))
        {
            $templateRowId = 'template_0';
 
            $isHasTemplateRow = false;
            foreach ($result as $row)
            {
                if ($row['id'] === $templateRowId)
                {
                    $isHasTemplateRow = true;
 
                    break;
                }
            }
 
            if (!$isHasTemplateRow)
            {
                $templateRow['id'] = $templateRowId;
                array_unshift($result, $templateRow);
            }
        }
 
        return $result;
    }
 
    public function setNavObject(PageNavigation $pagination): void
    {
        $this->pagination = $pagination;
    }
 
    protected function getNavObject(): ?PageNavigation
    {
        return $this->pagination;
    }
 
    public function getPageSizes(): array
    {
        return PageSizes::SIZE_5_10_20_50_100;
    }
 
    protected function getDefaultPageSize(): int
    {
        $sizes = $this->getPageSizes();
        $sizesCount = count($sizes);
 
        if ($sizesCount > 0)
        {
            $middleIndex = ceil($sizesCount / 2) - 1;
            if (isset($sizes[$middleIndex]))
            {
                return (int)$sizes[$middleIndex]['VALUE'];
            }
        }
 
        return 0;
    }
 
    protected function getDefaultSort(): ?array
    {
        return null;
    }
 
    protected function getActionPanel(): ?array
    {
        $snippet = new Snippet();
 
        $items = [];
        $items[] = $snippet->getRemoveButton();
        $items[] = $snippet->getEditButton();
 
        if ($items)
        {
            return [
                'GROUPS' => [
                    [
                        'ITEMS' => $items,
                    ],
                ],
            ];
        }
 
        return null;
    }
 
    protected function getAjaxId(): string
    {
        return $this->getId();
    }
 
    protected function getRowIdColumn(): string
    {
        return 'ID';
    }
 
    public function prepareRow(array $rawRow): array
    {
        $isEditable = $this->isEditable($rawRow);
 
        return [
            'id' => $rawRow[$this->getRowIdColumn()],
            'data' => $rawRow,
            'editable' => $isEditable,
            'columns' => $this->getRowColumns($rawRow),
            'actions' => $this->getRowActions($rawRow, $isEditable),
        ];
    }
 
    protected function isEditable(array $row): bool
    {
        return true;
    }
 
    protected function getRowColumns(array $row): array
    {
        $result = [];
 
        $columns = $this->getColumns();
        foreach ($columns as $column)
        {
            $colName = $column['id'] ?? null;
            if (!isset($colName))
            {
                continue;
            }
 
            $type = $column['type'] ?? null;
            if ($type === 'list')
            {
                $value = $row[$colName] ?? null;
 
                $items = $column['editable']['items'] ?? null;
                if (is_array($items))
                {
                    $value = $items[$value] ?? null;
                }
 
                $result[$colName] = $value;
            }
            elseif ($type === 'image')
            {
                $value = null;
 
                $fileId = (int)($row[$colName] ?? null);
                if ($fileId > 0)
                {
                    $value = CFile::GetPath($fileId);
                }
 
                $result[$colName] = $value;
            }
            else
            {
                $result[$colName] = $row[$colName] ?? null;
            }
        }
 
        return $result;
    }
 
    public function cleanFields(array $fields): array
    {
        $availableFields = array_column($this->getColumns(), 'id');
 
        return array_filter(
            $fields,
            static fn($key) => isset($key) && in_array($key, $availableFields, true),
            ARRAY_FILTER_USE_KEY
        );
    }
 
    protected function getRowActions(array $row, bool $isEditable): array
    {
        return [];
    }
 
    public function toArray(): array
    {
        $pagination = $this->getNavObject();
        $actionPanel = $this->getActionPanel();
        $sort = $this->getDefaultSort();
 
        return [
            // general
            'GRID_ID' => $this->getId(),
            // rows
            'ROWS' => $this->getRows(),
            'COLUMNS' => $this->getColumns(),
            'SORT' => $sort,
            // navigation
            'NAV_OBJECT' => $pagination,
            'NAV_PARAM_NAME' => $pagination ? $pagination->getId() : null,
            'CURRENT_PAGE' => $pagination ? $pagination->getCurrentPage() : null,
            'TOTAL_ROWS_COUNT' => $pagination ? $pagination->getRecordCount() : 0,
            'SHOW_PAGINATION' => $pagination ? $pagination->getPageCount() > 1 : false,
            'SHOW_NAVIGATION_PANEL' => isset($pagination),
            'SHOW_PAGESIZE' => isset($pagination),
            'PAGE_SIZES' => $this->getPageSizes(),
            'DEFAULT_PAGE_SIZE' => $this->getDefaultPageSize(),
            // ajax
            'AJAX_ID' => $this->getAjaxId(),
            'AJAX_MODE' => 'Y',
            'AJAX_OPTION_JUMP' => 'N',
            'AJAX_OPTION_STYLE' => 'N',
            'AJAX_OPTION_HISTORY' => 'N',
            // actions
            'ACTION_PANEL' => $actionPanel,
            'SHOW_ACTION_PANEL' => isset($actionPanel),
            // allows & shows
            'ALLOW_ROWS_SORT' => isset($sort),
            'SHOW_ROW_CHECKBOXES' => isset($actionPanel),
            'SHOW_CHECK_ALL_CHECKBOXES' => isset($actionPanel),
            'HANDLE_RESPONSE_ERRORS' => true,
        ];
    }
}