Bitrix API

WorkflowEntity extends Entity

FinalYes

Table of Contents

Constants

ENTITY_TYPE  = 'wf'
MODULE_ID  = 'lists'
XML_ID_PREFIX  = 'WF_'

Methods

__construct()  : mixed
canAdd()  : bool
canEdit()  : bool
canEditOwn()  : bool
canModerate()  : bool
canRead()  : bool
className()  : mixed
getEntityByType()  : array<string|int, mixed>|null
getEntityByXmlId()  : array<string|int, mixed>|null
getEntityType()  : mixed
getFullId()  : array<string|int, mixed>
getId()  : mixed
getModule()  : mixed
getPermission()  : $this
getType()  : mixed
getXmlId()  : mixed
getXmlIdPrefix()  : mixed
onMessageIsIndexed()  : bool
Event before indexing message.
setEditOwn()  : $this
setPermission()  : $this

Constants

Methods

__construct()

public __construct(array<string|int, mixed> $entity, array<string|int, mixed> $storage) : mixed
Parameters
$entity : array<string|int, mixed>
$storage : array<string|int, mixed>

canAdd()

public canAdd(mixed $userId) : bool
Parameters
$userId : mixed

User id.

Return values
bool

canEdit()

public canEdit(mixed $userId) : bool
Parameters
$userId : mixed

User id.

Return values
bool

canEditOwn()

public canEditOwn(int $userId) : bool
Parameters
$userId : int

User id.

Return values
bool

canModerate()

public canModerate(int $userId) : bool
Parameters
$userId : int

User id.

Return values
bool

canRead()

public canRead(mixed $userId) : bool
Parameters
$userId : mixed

User id.

Return values
bool

className()

public static className() : mixed

getEntityByType()

public static getEntityByType([string $type = "" ]) : array<string|int, mixed>|null
Parameters
$type : string = ""

Type entity.

Return values
array<string|int, mixed>|null

getEntityByXmlId()

public static getEntityByXmlId([string $xmlId = "" ]) : array<string|int, mixed>|null
Parameters
$xmlId : string = ""

Type entity.

Return values
array<string|int, mixed>|null

getEntityType()

public static getEntityType() : mixed

getFullId()

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

getModule()

public static getModule() : mixed

getPermission()

public getPermission(int $userId) : $this
Parameters
$userId : int

User id.

Return values
$this

getType()

public getType() : mixed

getXmlId()

public getXmlId() : mixed

getXmlIdPrefix()

public static getXmlIdPrefix() : mixed

onMessageIsIndexed()

Event before indexing message.

public static onMessageIsIndexed(int $id, array<string|int, mixed> $message, array<string|int, mixed> &$index) : bool
Parameters
$id : int

Message ID.

$message : array<string|int, mixed>

Message data.

$index : array<string|int, mixed>

Search index array.

Return values
bool

setEditOwn()

public setEditOwn(bool $permission) : $this
Parameters
$permission : bool
Return values
$this

setPermission()

public setPermission(int $userId, string $permission) : $this
Parameters
$userId : int

User id.

$permission : string

A < E < I < M < Q < U < Y // A - NO ACCESS E - READ I - ANSWER // M - NEW TOPIC Q - MODERATE U - EDIT Y - FULL_ACCESS.

Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results