Класс Option

Открытые статические члены
static	get ($moduleId, $name, $default="", $siteId=false)
static	getRealValue ($moduleId, $name, $siteId=false)
static	getDefaults ($moduleId)
static	getForModule ($moduleId, $siteId=false)
static	set ($moduleId, $name, $value="", $siteId="")
static	delete ($moduleId, array $filter=array())

Защищенные статические члены
static	load ($moduleId)
static	loadTriggers ($moduleId)
static	getCacheTtl ()
static	clearCache ($moduleId)
static	getDefaultSite ()

Защищенные данные
const	CACHE_DIR = "b_option"

Статические защищенные данные
static	$options = []
static	$loading = []

Подробное описание

Примеры

C:/bitrix/modules/main/lib/ui/copyright.php.

См. определение в файле option.php строка 14

Методы

clearCache()

clearCache ( $moduleId )

staticprotected

См. определение в файле option.php строка 464

delete()

delete ( $moduleId, array $filter = array() )

static

Deletes options from a DB.

Аргументы

string	$moduleId	The module ID.
array	$filter	{name: string, site_id: string} The array with filter keys: name - the name of the option; site_id - the site ID (can be empty).

Исключения

Main

ArgumentNullException

Исключения

Main

ArgumentException

См. определение в файле option.php строка 388

get()

get ( $moduleId, $name, $default = "", $siteId = false )

static

Returns a value of an option.

Аргументы

string	$moduleId	The module ID.
string	$name	The option name.
string	$default	The default value to return, if a value doesn't exist.
bool | string	$siteId	The site ID, if the option differs for sites.

Возвращает

string

См. определение в файле option.php строка 30

getCacheTtl()

getCacheTtl ( )

staticprotected

См. определение в файле option.php строка 366

getDefaults()

getDefaults ( $moduleId )

static

Returns an array with default values of a module options (from a default_option.php file).

Аргументы

string

$moduleId

The module ID.

Возвращает

array

Исключения

Main

ArgumentOutOfRangeException

См. определение в файле option.php строка 108

getDefaultSite()

getDefaultSite ( )

staticprotected

См. определение в файле option.php строка 475

getForModule()

getForModule ( $moduleId, $siteId = false )

static

Returns an array of set options array(name => value).

Аргументы

string	$moduleId	The module ID.
bool | string	$siteId	The site ID, if the option differs for sites.

Возвращает

array

Исключения

Main

ArgumentNullException

См. определение в файле option.php строка 150

getRealValue()

getRealValue ( $moduleId, $name, $siteId = false )

static

Returns the real value of an option as it's written in a DB.

Аргументы

string	$moduleId	The module ID.
string	$name	The option name.
bool | string	$siteId	The site ID.

Возвращает

null|string

Исключения

Main

ArgumentNullException

См. определение в файле option.php строка 65

load()

load ( $moduleId )

staticprotected

См. определение в файле option.php строка 178

loadTriggers()

loadTriggers ( $moduleId )

staticprotected

См. определение в файле option.php строка 341

set()

set ( $moduleId, $name, $value = "", $siteId = "" )

static

Sets an option value and saves it into a DB. After saving the OnAfterSetOption event is triggered.

Аргументы

string	$moduleId	The module ID.
string	$name	The option name.
string	$value	The option value.
string	$siteId	The site ID, if the option depends on a site.

Исключения

Main

ArgumentOutOfRangeException

См. определение в файле option.php строка 261

Поля

$loading

$loading = []

staticprotected

См. определение в файле option.php строка 19

$options

$options = []

staticprotected

См. определение в файле option.php строка 18

CACHE_DIR

const CACHE_DIR = "b_option"

protected

См. определение в файле option.php строка 16

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/main/lib/config/option.php