option.php

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

<?php

 
namespace Bitrix\Main\Config;
 
use Bitrix\Main;
 
class Option
{
    protected const CACHE_DIR = "b_option";
 
    protected static $options = [];
    protected static $loading = [];

    public static function get($moduleId, $name, $default = "", $siteId = false)
    {
        $value = static::getRealValue($moduleId, $name, $siteId);
 
        if ($value !== null)
        {
            return $value;
        }
 
        if (isset(self::$options[$moduleId]["-"][$name]))
        {
            return self::$options[$moduleId]["-"][$name];
        }
 
        if ($default == "")
        {
            $moduleDefaults = static::getDefaults($moduleId);
            if (isset($moduleDefaults[$name]))
            {
                return $moduleDefaults[$name];
            }
        }
 
        return $default;
    }

    public static function getRealValue($moduleId, $name, $siteId = false)
    {
        if ($moduleId == '')
        {
            throw new Main\ArgumentNullException("moduleId");
        }
        if ($name == '')
        {
            throw new Main\ArgumentNullException("name");
        }
 
        if (isset(self::$loading[$moduleId]))
        {
            trigger_error("Options are already in the process of loading for the module {$moduleId}. Default value will be used for the option {$name}.", E_USER_WARNING);
        }
 
        if (!isset(self::$options[$moduleId]))
        {
            static::load($moduleId);
        }
 
        if ($siteId === false)
        {
            $siteId = static::getDefaultSite();
        }
 
        $siteKey = ($siteId == ""? "-" : $siteId);
 
        if (isset(self::$options[$moduleId][$siteKey][$name]))
        {
            return self::$options[$moduleId][$siteKey][$name];
        }
 
        return null;
    }

    public static function getDefaults($moduleId)
    {
        static $defaultsCache = [];
 
        if (isset($defaultsCache[$moduleId]))
        {
            return $defaultsCache[$moduleId];
        }
 
        if (preg_match("#[^a-zA-Z0-9._]#", $moduleId))
        {
            throw new Main\ArgumentOutOfRangeException("moduleId");
        }
 
        $path = Main\Loader::getLocal("modules/".$moduleId."/default_option.php");
        if ($path === false)
        {
            $defaultsCache[$moduleId] = [];
            return $defaultsCache[$moduleId];
        }
 
        include($path);
 
        $varName = str_replace(".", "_", $moduleId)."_default_option";
        if (isset(${$varName}) && is_array(${$varName}))
        {
            $defaultsCache[$moduleId] = ${$varName};
            return $defaultsCache[$moduleId];
        }
 
        $defaultsCache[$moduleId] = [];
        return $defaultsCache[$moduleId];
    }

    public static function getForModule($moduleId, $siteId = false)
    {
        if ($moduleId == '')
        {
            throw new Main\ArgumentNullException("moduleId");
        }
 
        if (!isset(self::$options[$moduleId]))
        {
            static::load($moduleId);
        }
 
        if ($siteId === false)
        {
            $siteId = static::getDefaultSite();
        }
 
        $result = self::$options[$moduleId]["-"];
 
        if($siteId <> "" && !empty(self::$options[$moduleId][$siteId]))
        {
            //options for the site override general ones
            $result = array_replace($result, self::$options[$moduleId][$siteId]);
        }
 
        return $result;
    }
 
    protected static function load($moduleId)
    {
        $cache = Main\Application::getInstance()->getManagedCache();
        $cacheTtl = static::getCacheTtl();
        $loadFromDb = true;
 
        if ($cacheTtl !== false)
        {
            if($cache->read($cacheTtl, "b_option:{$moduleId}", self::CACHE_DIR))
            {
                self::$options[$moduleId] = $cache->get("b_option:{$moduleId}");
                $loadFromDb = false;
            }
        }
 
        if($loadFromDb)
        {
            self::$loading[$moduleId] = true;
 
            $con = Main\Application::getConnection();
            $sqlHelper = $con->getSqlHelper();
 
            // prevents recursion and cache miss
            self::$options[$moduleId] = ["-" => []];
 
            // prevents recursion on early stages with cluster module installed
            $pool = Main\Application::getInstance()->getConnectionPool();
            $pool->useMasterOnly(true);
 
            $query = "
                SELECT NAME, VALUE
                FROM b_option
                WHERE MODULE_ID = '{$sqlHelper->forSql($moduleId)}'
            ";
 
            $res = $con->query($query);
            while ($ar = $res->fetch())
            {
                self::$options[$moduleId]["-"][$ar["NAME"]] = $ar["VALUE"];
            }
 
            try
            {
                //b_option_site possibly doesn't exist
 
                $query = "
                    SELECT SITE_ID, NAME, VALUE
                    FROM b_option_site
                    WHERE MODULE_ID = '{$sqlHelper->forSql($moduleId)}'
                ";
 
                $res = $con->query($query);
                while ($ar = $res->fetch())
                {
                    self::$options[$moduleId][$ar["SITE_ID"]][$ar["NAME"]] = $ar["VALUE"];
                }
            }
            catch(Main\DB\SqlQueryException)
            {
            }
 
            $pool->useMasterOnly(false);
 
            if($cacheTtl !== false)
            {
                $cache->setImmediate("b_option:{$moduleId}", self::$options[$moduleId]);
            }
 
            unset(self::$loading[$moduleId]);
        }
 
        /*patchvalidationoptions4*/
    }

    public static function set($moduleId, $name, $value = "", $siteId = "")
    {
        if ($moduleId == '')
        {
            throw new Main\ArgumentNullException("moduleId");
        }
        if ($name == '')
        {
            throw new Main\ArgumentNullException("name");
        }
 
        if (mb_strlen($name) > 100)
        {
            trigger_error("Option name {$name} will be truncated on saving.", E_USER_WARNING);
        }
 
        if ($siteId === false)
        {
            $siteId = static::getDefaultSite();
        }
 
        $con = Main\Application::getConnection();
        $sqlHelper = $con->getSqlHelper();
 
        $updateFields = [
            "VALUE" => $value,
        ];
 
        if($siteId == "")
        {
            $insertFields = [
                "MODULE_ID" => $moduleId,
                "NAME" => $name,
                "VALUE" => $value,
            ];
 
            $keyFields = ["MODULE_ID", "NAME"];
 
            $sql = $sqlHelper->prepareMerge("b_option", $keyFields, $insertFields, $updateFields);
        }
        else
        {
            $insertFields = [
                "MODULE_ID" => $moduleId,
                "NAME" => $name,
                "SITE_ID" => $siteId,
                "VALUE" => $value,
            ];
 
            $keyFields = ["MODULE_ID", "NAME", "SITE_ID"];
 
            $sql = $sqlHelper->prepareMerge("b_option_site", $keyFields, $insertFields, $updateFields);
        }
 
        $con->queryExecute(current($sql));
 
        static::clearCache($moduleId);
 
        static::loadTriggers($moduleId);
 
        $event = new Main\Event(
            "main",
            "OnAfterSetOption_".$name,
            array("value" => $value)
        );
        $event->send();
 
        $event = new Main\Event(
            "main",
            "OnAfterSetOption",
            array(
                "moduleId" => $moduleId,
                "name" => $name,
                "value" => $value,
                "siteId" => $siteId,
            )
        );
        $event->send();
    }
 
    protected static function loadTriggers($moduleId)
    {
        static $triggersCache = [];
 
        if (isset($triggersCache[$moduleId]))
        {
            return;
        }
 
        if (preg_match("#[^a-zA-Z0-9._]#", $moduleId))
        {
            throw new Main\ArgumentOutOfRangeException("moduleId");
        }
 
        $triggersCache[$moduleId] = true;
 
        $path = Main\Loader::getLocal("modules/".$moduleId."/option_triggers.php");
        if ($path === false)
        {
            return;
        }
 
        include($path);
    }
 
    protected static function getCacheTtl()
    {
        static $cacheTtl = null;
 
        if($cacheTtl === null)
        {
            $cacheFlags = Configuration::getValue("cache_flags");
            $cacheTtl = $cacheFlags["config_options"] ?? 3600;
        }
        return $cacheTtl;
    }

    public static function delete($moduleId, array $filter = array())
    {
        if ($moduleId == '')
        {
            throw new Main\ArgumentNullException("moduleId");
        }
 
        $con = Main\Application::getConnection();
        $sqlHelper = $con->getSqlHelper();
 
        $deleteForSites = true;
        $sqlWhere = '';
        $sqlWhereSite = '';
 
        foreach ($filter as $field => $value)
        {
            switch ($field)
            {
                case "name":
                    if ($value == '')
                    {
                        throw new Main\ArgumentNullException("filter[name]");
                    }
                    $sqlWhere .= " AND NAME = '{$sqlHelper->forSql($value)}'";
                    break;
 
                case "site_id":
                    if ($value != '')
                    {
                        $sqlWhereSite = " AND SITE_ID = '{$sqlHelper->forSql($value, 2)}'";
                    }
                    else
                    {
                        $deleteForSites = false;
                    }
                    break;
 
                default:
                    throw new Main\ArgumentException("filter[{$field}]");
            }
        }
 
        if($moduleId == 'main')
        {
            $sqlWhere .= "
                AND NAME NOT LIKE '~%'
                AND NAME NOT IN ('crc_code', 'admin_passwordh', 'server_uniq_id','PARAM_MAX_SITES', 'PARAM_MAX_USERS')
            ";
        }
        else
        {
            $sqlWhere .= " AND NAME <> '~bsm_stop_date'";
        }
 
        if($sqlWhereSite == '')
        {
            $con->queryExecute("
                DELETE FROM b_option
                WHERE MODULE_ID = '{$sqlHelper->forSql($moduleId)}'
                    {$sqlWhere}
            ");
        }
 
        if($deleteForSites)
        {
            $con->queryExecute("
                DELETE FROM b_option_site
                WHERE MODULE_ID = '{$sqlHelper->forSql($moduleId)}'
                    {$sqlWhere}
                    {$sqlWhereSite}
            ");
        }
 
        static::clearCache($moduleId);
    }
 
    protected static function clearCache($moduleId)
    {
        unset(self::$options[$moduleId]);
 
        if (static::getCacheTtl() !== false)
        {
            $cache = Main\Application::getInstance()->getManagedCache();
            $cache->clean("b_option:{$moduleId}", self::CACHE_DIR);
        }
    }
 
    protected static function getDefaultSite()
    {
        static $defaultSite;
 
        if ($defaultSite === null)
        {
            $context = Main\Application::getInstance()->getContext();
            if ($context != null)
            {
                $defaultSite = $context->getSite();
            }
        }
        return $defaultSite;
    }
}