Bitrix API

Base extends Controller

AbstractYes

Table of Contents

Methods

__construct()  : mixed
clearPermissionAttributesCache()  : void
extractCategoryId()  : int
getEntity()  : Entity
getEntityFields()  : array<string|int, mixed>|null
getEntityTypeId()  : int
getPermissionAttributes()  : array<string|int, mixed>
getProgressSteps()  : array<string|int, mixed>
getQueryBuilder()  : QueryBuilder
getTableName()  : string
hasCategories()  : bool
hasProgressSteps()  : bool
isEntityTypeSupported()  : bool
isObservable()  : bool
isPermissionEntityTypeSupported()  : bool
prepareProgressStepAttribute()  : string
register()  : void
setEnabled()  : void
tryParseProgressStep()  : bool
unregister()  : void

Methods

__construct()

public __construct() : mixed

clearPermissionAttributesCache()

public clearPermissionAttributesCache(int $entityId) : void
Parameters
$entityId : int

extractCategoryId()

public extractCategoryId(string $permissionEntityType) : int
Parameters
$permissionEntityType : string
Return values
int

getEntityFields()

public getEntityFields(mixed $entityId) : array<string|int, mixed>|null
Parameters
$entityId : mixed
Return values
array<string|int, mixed>|null

getEntityTypeId()

public abstract getEntityTypeId() : int
Return values
int

getPermissionAttributes()

public getPermissionAttributes(string $permissionEntityType, array<string|int, mixed> $entityIDs) : array<string|int, mixed>
Parameters
$permissionEntityType : string
$entityIDs : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

getProgressSteps()

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

getTableName()

public getTableName() : string
Return values
string

hasCategories()

public hasCategories() : bool
Return values
bool

hasProgressSteps()

public hasProgressSteps() : bool
Return values
bool

isEntityTypeSupported()

public isEntityTypeSupported(int $entityTypeId) : bool
Parameters
$entityTypeId : int
Return values
bool

isObservable()

public isObservable() : bool
Return values
bool

isPermissionEntityTypeSupported()

public isPermissionEntityTypeSupported(mixed $entityType) : bool
Parameters
$entityType : mixed
Return values
bool

prepareProgressStepAttribute()

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

register()

public register(string $permissionEntityType, int $entityId[, RegisterOptions|null $options = null ]) : void
Parameters
$permissionEntityType : string
$entityId : int
$options : RegisterOptions|null = null

setEnabled()

public static setEnabled(bool $enabled) : void

left for backward compatibility The "controller enabled" mechanic has been completely removed and is no longer relevant.

Parameters
$enabled : bool

tryParseProgressStep()

public tryParseProgressStep(mixed $attribute, mixed &$value) : bool
Parameters
$attribute : mixed
$value : mixed
Return values
bool

unregister()

public unregister(string $permissionEntityType, int $entityId) : void
Parameters
$permissionEntityType : string
$entityId : int

        
On this page

Search results