Класс Permission

Открытые статические члены
static	check (array $permissions, $entityCode, $actionCode, $minPerm=null)
static	getByUserId ($userId)
static	getMap ()
static	normalize (array $source)
static	getEntityName ($entity)
static	getActionName ($action)
static	getPermissionName ($permission)

Открытые атрибуты
const	ENTITY_AD = 'AD'
const	ENTITY_RC = 'RC'
const	ENTITY_LETTER = 'LETTER'
const	ENTITY_SEGMENT = 'SEGMENT'
const	ENTITY_BLACKLIST = 'BLACKLIST'
const	ENTITY_SETTINGS = 'SETTINGS'
const	ACTION_VIEW = 'VIEW'
const	ACTION_MODIFY = 'MODIFY'
const	PERMISSION_NONE = ''
const	PERMISSION_SELF = 'A'
const	PERMISSION_DEPARTMENT = 'D'
const	PERMISSION_ANY = 'X'

Защищенные статические члены
static	getAdminPermissions ()

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

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

Методы

check()

static check ( array $permissions, $entityCode, $actionCode, $minPerm = null )

static

Returns permission code according to the user's Permission.

Аргументы

string	$entityCode	Code of the entity.
string	$actionCode	Code of the action.

Возвращает

string

Исключения

ArgumentException

Returns true if user can perform specified action on the entity.

Аргументы

array	$permissions	Permissions.
string	$entityCode	Code of the entity.
string	$actionCode	Code of the action.
string	$minPerm	Code of minimal permission.

Возвращает

bool

Исключения

ArgumentException

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

getActionName()

static getActionName ( $action )

static

Returns name of the action by its code.

Аргументы

string

$action

Action code.

Возвращает

string

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

getAdminPermissions()

static getAdminPermissions ( )

staticprotected

Returns maximum available permissions.

Возвращает

array

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

getByUserId()

static getByUserId ( $userId )

static

Get permissions by user ID.

Аргументы

int

$userId

User ID.

Возвращает

array

Исключения

Bitrix\Main\ArgumentException

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

getEntityName()

static getEntityName ( $entity )

static

Returns name of the entity by its code.

Аргументы

string

$entity

Entity code.

Возвращает

string

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

getMap()

static getMap ( )

static

Returns Permission map.

Возвращает

array

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

getPermissionName()

static getPermissionName ( $permission )

static

Returns name of the permission by its code.

Аргументы

string

$permission

Permission code.

Возвращает

string

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

normalize()

static normalize ( array $source )

static

Returns normalized permission array.

Аргументы

array

$source

Some not normalized permission array.

Возвращает

array

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

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

ACTION_MODIFY

const ACTION_MODIFY = 'MODIFY'

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

ACTION_VIEW

const ACTION_VIEW = 'VIEW'

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

ENTITY_AD

const ENTITY_AD = 'AD'

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

ENTITY_BLACKLIST

const ENTITY_BLACKLIST = 'BLACKLIST'

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

ENTITY_LETTER

const ENTITY_LETTER = 'LETTER'

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

ENTITY_RC

const ENTITY_RC = 'RC'

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

ENTITY_SEGMENT

const ENTITY_SEGMENT = 'SEGMENT'

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

ENTITY_SETTINGS

const ENTITY_SETTINGS = 'SETTINGS'

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

PERMISSION_ANY

const PERMISSION_ANY = 'X'

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

PERMISSION_DEPARTMENT

const PERMISSION_DEPARTMENT = 'D'

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

PERMISSION_NONE

const PERMISSION_NONE = ''

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

PERMISSION_SELF

const PERMISSION_SELF = 'A'

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