options.php

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

<?php
 
namespace Bitrix\Main\Grid;
 
use Bitrix\Main\Application;

class Options extends \CGridOptions
{
    protected $id;
 

    public function __construct($gridId, array $filterPresets = array())
    {
        $this->id = $gridId;
        parent::__construct($gridId, $filterPresets);
 
        if (!static::isAuthorized() &&
            isset(Application::getInstance()->getSession()["main.ui.grid.options"][$this->id]) &&
            is_array(Application::getInstance()->getSession()["main.ui.grid.options"][$this->id]) &&
            !empty(Application::getInstance()->getSession()["main.ui.grid.options"][$this->id]))
        {
            $this->all_options = Application::getInstance()->getSession()["main.ui.grid.options"][$this->id];
        }
    }
 

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

    protected static function getUser()
    {
        global $USER;
        return $USER;
    }
 

    public function setColumnsSizes($expand, $sizes)
    {
        $columns = array();
        foreach ((array) $sizes as $name => $width)
        {
            $name  = trim($name);
            $width = is_scalar($width) ? (int) $width : 0;
            if ($name != '' && $width > 0)
                $columns[$name] = $width;
        }
 
        $this->all_options['views'][$this->currentView]['columns_sizes'] = array(
            'expand'  => is_scalar($expand) ? round((float) $expand, 8) : 1,
            'columns' => $columns
        );
    }
 

    public function setPageSize($size)
    {
        $size = is_scalar($size) ? (int) $size : 20;
        $size = $size >= 0 ? $size : 20;
 
        $this->all_options['views'][$this->currentView]['page_size'] = $size;
    }
 

    public function setCustomNames($names)
    {
        $this->all_options["views"]["default"]["custom_names"] = $names;
    }
 

    public function resetExpandedRows()
    {
        $this->setExpandedRows();
    }
 

    public function setExpandedRows($ids = array())
    {
        Application::getInstance()->getSession()["main.ui.grid"][$this->getId()]["expanded_rows"] = $ids;
    }
 

    public function getExpandedRows()
    {
        return Application::getInstance()->getSession()["main.ui.grid"][$this->getId()]["expanded_rows"] ?? null;
    }
 

    public function setCollapsedGroups($ids = array())
    {
        Application::getInstance()->getSession()["main.ui.grid"][$this->getId()]["collapsed_groups"] = is_array($ids) ? $ids : array();
    }
 

    public function getCollapsedGroups()
    {
        return Application::getInstance()->getSession()["main.ui.grid"][$this->getId()]["collapsed_groups"] ?? null;
    }
 

    public function resetView($viewId)
    {
        $gridId = $this->getId();
        $this->all_options["views"][$viewId] = array();
        unset(Application::getInstance()->getSession()["main.interface.grid"][$gridId]);
        unset(Application::getInstance()->getSession()["main.ui.grid"][$gridId]);
        $this->Save();
        parent::__construct($gridId);
    }
 

    public function deleteView($viewId)
    {
        $gridId = $this->getId();
        unset($this->all_options["views"][$viewId]);
        unset(Application::getInstance()->getSession()["main.interface.grid"][$gridId]);
        unset(Application::getInstance()->getSession()["main.ui.grid"][$gridId]);
        $this->Save();
        parent::__construct($gridId);
    }
 

    public function getCurrentOptions()
    {
        $options = $this->getOptions();
        $currentViewId = $options["current_view"];
        return $options["views"][$currentViewId];
    }
 

    private static function getDefaultGetSortingResult()
    {
        return array(
            "sort" => array(),
            "vars" => array(
                "by" => "by",
                "order" => "order"
            )
        );
    }
 

    public function getSorting($default = array())
    {
        $result = static::getDefaultGetSortingResult();
        $result["sort"] = isset($default["sort"]) && is_array($default["sort"]) ? $default["sort"] : $result["sort"];
        $result["vars"] = isset($default["vars"]) && is_array($default["vars"]) ? $default["vars"] : $result["vars"];
 
        $options = $this->getCurrentOptions();
 
        if (!empty($options["last_sort_by"]) && !empty($options["last_sort_order"]))
        {
            $result["sort"] = array($options["last_sort_by"] => $options["last_sort_order"]);
        }
 
        return $result;
    }
 

    protected static function getUserId()
    {
        return (int)static::getUser()?->getID();
    }
 

    protected static function isAuthorized()
    {
        return (bool)static::getUser()?->isAuthorized();
    }
 

    public function save()
    {
        $gridId = $this->getId();
 
        if (static::isAuthorized())
        {
            \CUserOptions::setOption("main.interface.grid", $gridId, $this->all_options);
        }
        else
        {
            Application::getInstance()->getSession()["main.ui.grid.options"][$gridId] = $this->all_options;
        }
    }
 

    public function getUsedColumns($defaultColumns = array())
    {
        $currentOptions = $this->getCurrentOptions();
 
        if (isset($currentOptions["columns"]) && is_string($currentOptions["columns"]) && $currentOptions["columns"] !== "")
        {
            return explode(",", $currentOptions["columns"]);
        }
 
        return $defaultColumns;
    }
 

    public function setStickedColumns($columns = [])
    {
        $this->all_options["views"]["default"]["sticked_columns"] = is_array($columns) ? $columns : [];
    }

    public function getStickedColumns()
    {
        $currentOptions = $this->getCurrentOptions();
 
        if (isset($currentOptions["sticked_columns"]) && is_array($currentOptions["sticked_columns"]))
        {
            return $currentOptions["sticked_columns"];
        }
 
        return null;
    }
}