grids.php

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

<?php
 
use Bitrix\Main\Application;
 
IncludeModuleLangFile(__FILE__);
 
class CGridOptions
{
    protected $grid_id;
    protected $all_options;
    protected $options;
    protected $filter;
    protected $filterPresets;
    protected $currentView;
 
    public function __construct($grid_id, array $filterPresets = array())
    {
        $this->grid_id = $grid_id;
        $this->options = array();
        $this->filter = array();
        $this->filterPresets = $filterPresets;
 
        $aOptions = CUserOptions::GetOption("main.interface.grid", $this->grid_id, array());
 
        if(!is_array($aOptions))
        {
            $aOptions = array();
        }
        if (!isset($aOptions["views"]) || !is_array($aOptions["views"]))
        {
            $aOptions["views"] = [];
        }
 
        if (!isset($aOptions["filters"]) || !is_array($aOptions["filters"]))
        {
            $aOptions["filters"] = [];
        }
 
        if(!isset($aOptions["current_view"]) || $aOptions["current_view"] == '' || !isset($aOptions["views"][$aOptions["current_view"]]))
        {
            $aOptions["current_view"] = "default";
        }
 
        $defaultOptions = CUserOptions::GetOption("main.interface.grid.common", $this->grid_id, array());
 
        if (isset($defaultOptions["view"]) && is_array($defaultOptions["view"]) && !isset($aOptions["views"]["default"]))
        {
            $aOptions["views"]["default"] = $defaultOptions["view"];
        }
        if(!isset($aOptions["views"]["default"]))
        {
            $aOptions["views"]["default"] = array("columns"=>"");
        }
 
        $this->all_options = $aOptions;
        $this->currentView = $aOptions["current_view"];
 
        if(isset($aOptions["views"][$this->currentView]))
        {
            $this->options = $aOptions["views"][$this->currentView];
        }
    }
 
    public function InitFilter()
    {
        if(isset($this->options["saved_filter"]) && $this->options["saved_filter"] <> '')
        {
            if(isset($this->all_options["filters"][$this->options["saved_filter"]]) && is_array($this->all_options["filters"][$this->options["saved_filter"]]["fields"]))
            {
                $this->filter = $this->all_options["filters"][$this->options["saved_filter"]]["fields"];
            }
            elseif(isset($this->filterPresets[$this->options["saved_filter"]]) && is_array($this->filterPresets[$this->options["saved_filter"]]["fields"]))
            {
                $this->filter = $this->filterPresets[$this->options["saved_filter"]]["fields"];
            }
        }
    }
 
    public function GetOptions()
    {
        return $this->all_options;
    }
 
    public function GetSorting($default=array())
    {
        if (!isset($default["vars"]) || !is_array($default["vars"]))
        {
            $default["vars"] = ["by" => "by", "order" => "order"];
        }
        if (!isset($default["sort"]) || !is_array($default["sort"]))
        {
            $default["sort"] = [];
        }
 
        $arResult = array(
            "sort" => $default["sort"],
            "vars" => $default["vars"],
        );
 
        $key = '';
        if(isset($_REQUEST[$default["vars"]["by"]]))
        {
            Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["sort_by"] = $_REQUEST[$default["vars"]["by"]];
        }
        elseif(!isset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["sort_by"]))
        {
            if(!empty($this->options["sort_by"]))
            {
                //sorting explicitly set in the view
                $key = $this->options["sort_by"];
            }
            elseif(!empty($this->options["last_sort_by"]))
            {
                //last saved user sorting
                $key = $this->options["last_sort_by"];
            }
        }
        if(isset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["sort_by"]))
            $key = Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["sort_by"];
 
        if($key <> '')
        {
            if(isset($_REQUEST[$default["vars"]["order"]]))
            {
                Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["sort_order"] = $_REQUEST[$default["vars"]["order"]];
            }
            elseif(!isset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["sort_order"]))
            {
                if(!empty($this->options["sort_order"]))
                {
                    $arResult["sort"] = array($key => $this->options["sort_order"]);
                }
                elseif(!empty($this->options["last_sort_order"]))
                {
                    $arResult["sort"] = array($key => $this->options["last_sort_order"]);
                }
                else
                {
                    $arResult["sort"] = array($key => reset($default["sort"]));
                }
            }
            if(isset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["sort_order"]))
                $arResult["sort"] = array($key => Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["sort_order"]);
        }
 
        return $arResult;
    }
 
    public function GetNavParams($arParams=array())
    {
        $arResult = array(
            "nPageSize" => $arParams["nPageSize"] ?? 20,
        );
 
        if(!empty($this->options["page_size"]))
            $arResult["nPageSize"] = $this->options["page_size"];
 
        return $arResult;
    }
 
    public function GetVisibleColumns()
    {
        if(!empty($this->options["columns"]))
            return explode(",", $this->options["columns"]);
        return [];
    }
 
    public function SetVisibleColumns($arColumns)
    {
        $this->options['columns'] = implode(',', $arColumns);
        $aOptions = CUserOptions::GetOption('main.interface.grid', $this->grid_id, array());
        if (!is_array($aOptions['views']))
            $aOptions['views'] = array();
        if (!is_array($aOptions['filters']))
            $aOptions['filters'] = array();
        if (!array_key_exists('default', $aOptions['views']))
            $aOptions['views']['default'] = array('columns'=>'');
        if ($aOptions['current_view'] == '' || !array_key_exists($aOptions['current_view'], $aOptions['views']))
            $aOptions['current_view'] = 'default';
 
        $aOptions['views'][$aOptions['current_view']]['columns'] = $this->options['columns'];
        CUserOptions::SetOption('main.interface.grid', $this->grid_id, $aOptions);
    }
 
    public function GetFilter($arFilter)
    {
        $aRes = array();
        foreach($arFilter as $field)
        {
            //date
            if(isset($_REQUEST[$field["id"]."_datesel"]))
            {
                if($_REQUEST[$field["id"]."_datesel"] <> '')
                {
                    $aRes[$field["id"]."_datesel"] = $_REQUEST[$field["id"]."_datesel"];
                    CGridOptions::CalcDates($field["id"], $_REQUEST, $aRes);
                }
                else
                {
                    unset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["filter"][$field["id"]."_datesel"]);
                    unset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["filter"][$field["id"]."_from"]);
                    unset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["filter"][$field["id"]."_to"]);
                    unset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["filter"][$field["id"]."_days"]);
                }
                continue;
            }
 
            //quick
            if (
                isset($_REQUEST[$field["id"] . "_list"])
                && $_REQUEST[$field["id"] . "_list"] <> ''
                && isset($_REQUEST[$field["id"]])
                && $_REQUEST[$field["id"]] <> ''
            )
            {
                $aRes[$field["id"] . "_list"] = $_REQUEST[$field["id"] . "_list"];
            }
 
            //number interval
            if(isset($_REQUEST[$field["id"]."_from"]))
            {
                if($_REQUEST[$field["id"]."_from"] <> '')
                    $aRes[$field["id"]."_from"] = $_REQUEST[$field["id"]."_from"];
                else
                    unset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["filter"][$field["id"]."_from"]);
            }
            if(isset($_REQUEST[$field["id"]."_to"]))
            {
                if($_REQUEST[$field["id"]."_to"] <> '')
                    $aRes[$field["id"]."_to"] = $_REQUEST[$field["id"]."_to"];
                else
                    unset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["filter"][$field["id"]."_to"]);
            }
 
            //filtered outside, we don't control the filter field value
            if(isset($field["filtered"]) && $field["filtered"])
            {
                if(isset($field["filter_value"]))
                    $aRes[$field["id"]] = $field["filter_value"];
                else
                    $aRes[$field["id"]] = true;
                continue;
            }
 
            //list or string
            if(isset($_REQUEST[$field["id"]]))
            {
                if(is_array($_REQUEST[$field["id"]]) && !empty($_REQUEST[$field["id"]]) && reset($_REQUEST[$field["id"]]) <> '' || !is_array($_REQUEST[$field["id"]]) && $_REQUEST[$field["id"]] <> '')
                    $aRes[$field["id"]] = $_REQUEST[$field["id"]];
                else
                    unset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["filter"][$field["id"]]);
            }
        }
 
        //Check for filter ID -->
        if(isset($_REQUEST["apply_filter"]) && $_REQUEST["apply_filter"] === 'Y' && isset($_REQUEST["grid_filter_id"]))
        {
            $aRes["GRID_FILTER_APPLIED"] = true;
            $aRes["GRID_FILTER_ID"] = $_REQUEST["grid_filter_id"];
        }
        //<-- Check for filter ID
 
        if(!empty($aRes))
        {
            Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["filter"] = $aRes;
        }
        elseif(isset($_REQUEST["clear_filter"]) && $_REQUEST["clear_filter"] <> '')
        {
            Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["filter"] = array();
        }
        elseif(
            isset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["filter"])
            && is_array(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["filter"])
        )
        {
            $aRes = Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["filter"];
        }
        else
        {
            $this->InitFilter();
            if(!empty($this->filter))
            {
                foreach($arFilter as $field)
                {
                    if($this->filter[$field["id"]."_datesel"] <> '')
                    {
                        $aRes[$field["id"]."_datesel"] = $this->filter[$field["id"]."_datesel"];
                        CGridOptions::CalcDates($field["id"], $this->filter, $aRes);
                        continue;
                    }
                    if($this->filter[$field["id"]."_list"] <> '' && $this->filter[$field["id"]] <> '')
                    {
                        $aRes[$field["id"]."_list"] = $this->filter[$field["id"]."_list"];
                    }
                    if($this->filter[$field["id"]."_from"] <> '')
                    {
                        $aRes[$field["id"]."_from"] = $this->filter[$field["id"]."_from"];
                    }
                    if($this->filter[$field["id"]."_to"] <> '')
                    {
                        $aRes[$field["id"]."_to"] = $this->filter[$field["id"]."_to"];
                    }
                    if(is_array($this->filter[$field["id"]]))
                    {
                        //multiselect values
                        if(!empty($this->filter[$field["id"]]) && reset($this->filter[$field["id"]]) <> '')
                        {
                            $aRes[$field["id"]] = array_values($this->filter[$field["id"]]);
                        }
                    }
                    elseif($this->filter[$field["id"]] <> '')
                    {
                        $aRes[$field["id"]] = $this->filter[$field["id"]];
                    }
                }
                if(!empty($aRes))
                {
                    Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["filter"] = $aRes;
                }
            }
        }
 
        return $aRes;
    }
 
    public function Save()
    {
        CUserOptions::SetOption("main.interface.grid", $this->grid_id, $this->all_options);
    }
 
    public function SetColumns($columns)
    {
        $aColsTmp = explode(",", $columns);
        $aCols = array();
        foreach($aColsTmp as $col)
            if(($col = trim($col)) <> "")
                $aCols[] = $col;
        $this->all_options["views"][$this->currentView]["columns"] = implode(",", $aCols);
    }
 
    public function SetSorting($by, $order)
    {
        $this->all_options["views"][$this->currentView]["last_sort_by"] = $by;
        $this->all_options["views"][$this->currentView]["last_sort_order"] = $order;
    }
 
    public function SetTheme($theme)
    {
        $this->all_options["theme"] = $theme;
    }
 
    public function SetViewSettings($view_id, $settings)
    {
        $this->all_options["views"][$view_id] = array(
            "name"=>$settings["name"],
            "columns"=>$settings["columns"],
            "sort_by"=>$settings["sort_by"],
            "sort_order"=>$settings["sort_order"],
            "page_size"=>$settings["page_size"],
            "saved_filter"=>$settings["saved_filter"],
            "custom_names"=>$settings["custom_names"] ?? [],
        );
    }
 
    public function SetDefaultView($settings)
    {
        $options = array(
            "view" => array(
                "name"=>$settings["name"],
                "columns"=>$settings["columns"],
                "sort_by"=>$settings["sort_by"],
                "sort_order"=>$settings["sort_order"],
                "page_size"=>$settings["page_size"],
                "saved_filter"=>$settings["saved_filter"],
                "custom_names"=>$settings["custom_names"],
            )
        );
 
        CUserOptions::SetOption("main.interface.grid.common", $this->grid_id, $options, true);
    }
 
    public function ResetDefaultView()
    {
        $res = CUserOptions::GetList(
            null,
            array(
                "CATEGORY" => "main.interface.grid",
                "NAME" => $this->grid_id,
            )
        );
        while($row = $res->Fetch())
        {
            $options = unserialize($row["VALUE"], ['allowed_classes' => false]);
            if(!is_array($options))
            {
                $options = array();
            }
            unset($options["views"]["default"]);
            $options["current_view"] = "default";
            CUserOptions::SetOption("main.interface.grid", $this->grid_id, $options, false, $row["USER_ID"]);
        }
    }
 
    public function DeleteView($viewId)
    {
        unset($this->all_options["views"][$viewId]);
    }
 
    public function SetView($view_id)
    {
        if(!array_key_exists($view_id, $this->all_options["views"]))
            $view_id = "default";
 
        $this->all_options["current_view"] = $view_id;
        $this->currentView = $view_id;
 
        //get sorting from view, not session
        unset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["sort_by"]);
        unset(Application::getInstance()->getSession()["main.interface.grid"][$this->grid_id]["sort_order"]);
    }
 
    public function SetFilterRows($rows, $filter_id='')
    {
        $aColsTmp = explode(",", $rows);
        $aCols = array();
        foreach($aColsTmp as $col)
            if(($col = trim($col)) <> "")
                $aCols[] = $col;
        if($filter_id <> '')
            $this->all_options["filters"][$filter_id]["filter_rows"] = implode(",", $aCols);
        else
            $this->all_options["filter_rows"] = implode(",", $aCols);
    }
 
    public function SetFilterSettings($filter_id, $settings)
    {
        $option = array(
            "name"=>$settings["name"],
            "fields"=>$settings["fields"] ?? [],
        );
 
        if(isset($settings["rows"]))
        {
            $rows = $settings["rows"];
            if(is_array($rows))
            {
                $result = array();
                foreach($rows as $id)
                {
                    $id = trim($id);
                    if($id !== "")
                    {
                        $result[] = $id;
                    }
                }
                $option["filter_rows"] = implode(",", $result);
            }
            elseif(is_string($settings["rows"]))
            {
                $option["filter_rows"] = $settings["rows"];
            }
        }
 
        $this->all_options["filters"][$filter_id] = $option;
    }
 
    public function DeleteFilter($filter_id)
    {
        unset($this->all_options["filters"][$filter_id]);
    }
 
    public function SetFilterSwitch($show)
    {
        $this->all_options["filter_shown"] = ($show == "Y"? "Y":"N");
    }
 
    public static function CalcDates($field_id, $aInput, &$aRes)
    {
        switch($aInput[$field_id."_datesel"])
        {
            case "today":
                $aRes[$field_id."_from"] = $aRes[$field_id."_to"] = ConvertTimeStamp();
                break;
            case "yesterday":
                $aRes[$field_id."_from"] = $aRes[$field_id."_to"] = ConvertTimeStamp(time()-86400);
                break;
            case "tomorrow":
                $aRes[$field_id."_from"] = $aRes[$field_id."_to"] = ConvertTimeStamp(time()+86400);
                break;
            case "week":
                $day = date("w");
                if($day == 0)
                    $day = 7;
                $aRes[$field_id."_from"] = ConvertTimeStamp(time()-($day-1)*86400);
                $aRes[$field_id."_to"] = ConvertTimeStamp(time()+(7-$day)*86400);
                break;
            case "week_ago":
                $day = date("w");
                if($day == 0)
                    $day = 7;
                $aRes[$field_id."_from"] = ConvertTimeStamp(time()-($day-1+7)*86400);
                $aRes[$field_id."_to"] = ConvertTimeStamp(time()-($day)*86400);
                break;
            case "month":
                $aRes[$field_id."_from"] = ConvertTimeStamp(mktime(0, 0, 0, date("n"), 1));
                $aRes[$field_id."_to"] = ConvertTimeStamp(mktime(0, 0, 0, (int)date("n") + 1, 0));
                break;
            case "month_ago":
                $aRes[$field_id."_from"] = ConvertTimeStamp(mktime(0, 0, 0, (int)date("n") - 1, 1));
                $aRes[$field_id."_to"] = ConvertTimeStamp(mktime(0, 0, 0, date("n"), 0));
                break;
            case "days":
                $aRes[$field_id."_days"] = $aInput[$field_id."_days"];
                $aRes[$field_id."_from"] = ConvertTimeStamp(time() - intval($aRes[$field_id."_days"])*86400);
                $aRes[$field_id."_to"] = "";
                break;
            case "exact":
                $aRes[$field_id."_from"] = $aRes[$field_id."_to"] = $aInput[$field_id."_from"];
                break;
            case "after":
                $aRes[$field_id."_from"] = $aInput[$field_id."_from"];
                $aRes[$field_id."_to"] = "";
                break;
            case "before":
                $aRes[$field_id."_from"] = "";
                $aRes[$field_id."_to"] = $aInput[$field_id."_to"];
                break;
            case "interval":
                $aRes[$field_id."_from"] = $aInput[$field_id."_from"];
                $aRes[$field_id."_to"] = $aInput[$field_id."_to"];
                break;
        }
    }
 
    public static function GetThemes($path)
    {
        //color schemes
        $aColorNames = array(
            "grey"=>GetMessage("interface_grid_theme_grey"),
            "blue"=>GetMessage("interface_grid_theme_blue"),
            "brown"=>GetMessage("interface_grid_theme_brown"),
            "green"=>GetMessage("interface_grid_theme_green"),
            "lightblue"=>GetMessage("interface_grid_theme_lightblue"),
            "red"=>GetMessage("interface_grid_theme_red"),
            "lightgrey"=>GetMessage("interface_grid_theme_lightgrey"),
        );
        $arThemes = array();
        $themesPath = $_SERVER["DOCUMENT_ROOT"].$path.'/themes';
        if(is_dir($themesPath))
        {
            if($dir = opendir($themesPath))
            {
                while(($file = readdir($dir)) !== false)
                {
                    if($file != '.' && $file != '..' && is_dir($themesPath."/".$file))
                        $arThemes[$file] = array("theme"=>$file, "name"=>($aColorNames[$file] ?? $file));
                }
                closedir($dir);
            }
        }
 
        uasort(
            $arThemes,
            function ($a, $b) {
                return strcmp($a["name"], $b["name"]);
            }
        );
 
        return $arThemes;
    }
 
    public static function GetTheme($grid_id)
    {
        $aOptions = CUserOptions::GetOption("main.interface.grid", $grid_id, array());
        if($aOptions["theme"] == '')
        {
            $aGlobalOptions = CUserOptions::GetOption("main.interface", "global", array(), 0);
            if($aGlobalOptions["theme_template"][SITE_TEMPLATE_ID] <> '')
                $theme = $aGlobalOptions["theme_template"][SITE_TEMPLATE_ID];
            else
                $theme = "";
        }
        else
        {
            $theme = $aOptions["theme"];
        }
        if($theme <> '')
        {
            $theme = preg_replace("/[^a-z0-9_.-]/i", "", $theme);
        }
        return $theme;
    }
}