Класс Options

Граф наследования:Options:

Открытые члены
	__construct ($gridId, array $filterPresets=array())
	getId ()
	setColumnsSizes ($expand, $sizes)
	setPageSize ($size)
	setCustomNames ($names)
	resetExpandedRows ()
	setExpandedRows ($ids=array())
	getExpandedRows ()
	setCollapsedGroups ($ids=array())
	getCollapsedGroups ()
	resetView ($viewId)
	deleteView ($viewId)
	getCurrentOptions ()
	getSorting ($default=array())
	save ()
	getUsedColumns ($defaultColumns=array())
	setStickedColumns ($columns=[])
	getStickedColumns ()

Защищенные статические члены
static	getUser ()
static	getUserId ()
static	isAuthorized ()

Защищенные данные
	$id

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

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

Конструктор(ы)

__construct()

__construct	(		$gridId,
		array	$filterPresets = array() )

Options constructor.

Аргументы

	$gridId	$arParams["GRID_ID"]
array	$filterPresets

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

Методы

deleteView()

deleteView

(

$viewId

)

Deletes view settings by view id

Аргументы

string

$viewId

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

getCollapsedGroups()

getCollapsedGroups

(

)

Gets ids of collapsed groups

Возвращает

?array

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

getCurrentOptions()

getCurrentOptions

(

)

Возвращает

array

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

getExpandedRows()

getExpandedRows

(

)

Gets ids of expanded rows

Возвращает

array|null

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

getId()

getId

(

)

Gets grid id

Возвращает

string $arParams["GRID_ID"]

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

getSorting()

getSorting

(

$default = array()

)

Gets current grid sorting

Аргументы

array

$default

- Default value

Возвращает

array

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

getStickedColumns()

getStickedColumns

(

)

Gets sticked columns

Возвращает

string[]|null

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

getUsedColumns()

getUsedColumns

(

$defaultColumns = array()

)

Gets used columns

Аргументы

array

$defaultColumns

Возвращает

array

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

getUser()

static getUser ( )

staticprotected

Gets $USER object

Возвращает

\CUser

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

getUserId()

static getUserId ( )

staticprotected

Gets current user id

Возвращает

int

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

isAuthorized()

static isAuthorized ( )

staticprotected

Checks that current user is authorized

Возвращает

bool

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

resetExpandedRows()

resetExpandedRows

(

)

Resets saved expanded ids of rows

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

resetView()

resetView

(

$viewId

)

Resets view settings by view id

Аргументы

string

$viewId

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

save()

save

(

)

Saves all options

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

setCollapsedGroups()

setCollapsedGroups

(

$ids = array()

)

Sets collapsed groups

Аргументы

array

$ids

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

setColumnsSizes()

setColumnsSizes	(		$expand,
			$sizes )

Sets width of grid columns

Аргументы

number  |  null	$expand
array	$sizes

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

setCustomNames()

setCustomNames

(

$names

)

Sets custom names of grid columns

Аргументы

array

$names

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

setExpandedRows()

setExpandedRows

(

$ids = array()

)

Sets ids of expanded rows

Аргументы

array

$ids

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

setPageSize()

setPageSize

(

$size

)

Sets page size

Аргументы

int

$size

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

setStickedColumns()

setStickedColumns

(

$columns = []

)

Sets sticked columns

Аргументы

string[]

$columns

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

Данные класса

$id

$id

protected

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