Bitrix API

Variants

Permission value variants with extra params of any variant

Table of Contents

Methods

add()  : void
Add new variant with extra params
createFromArray()  : self
Create instance from simple key-value array
getValuesForSection()  : array<string|int, mixed>
Get variants for permission in base entity
getValuesForSubsection()  : array<string|int, mixed>
Get variants for permission in entity stage permissions
has()  : bool
Check if variant $id exists
moveToEndOfList()  : void
Move variant $id to the end of variants list
moveToTopOfList()  : void
remove()  : void
toArray()  : array<string|int, mixed>
Convert variants to simple key-value array (for old permissions interface)

Methods

add()

Add new variant with extra params

public add(string|null $id, string $value[, array<string|int, mixed> $params = [] ]) : void
Parameters
$id : string|null
$value : string
$params : array<string|int, mixed> = []

createFromArray()

Create instance from simple key-value array

public static createFromArray(array<string|int, mixed> $values) : self
Parameters
$values : array<string|int, mixed>
Return values
self

getValuesForSection()

Get variants for permission in base entity

public getValuesForSection() : array<string|int, mixed>
Return values
array<string|int, mixed>

getValuesForSubsection()

Get variants for permission in entity stage permissions

public getValuesForSubsection(string $subsectionCode) : array<string|int, mixed>
Parameters
$subsectionCode : string
Return values
array<string|int, mixed>

has()

Check if variant $id exists

public has(string $id) : bool
Parameters
$id : string
Return values
bool

moveToEndOfList()

Move variant $id to the end of variants list

public moveToEndOfList(string $id) : void
Parameters
$id : string

moveToTopOfList()

public moveToTopOfList(string $id) : void
Parameters
$id : string

remove()

public remove(string $id) : void
Parameters
$id : string

toArray()

Convert variants to simple key-value array (for old permissions interface)

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results