Bitrix API

ActivityController extends BaseController

Table of Contents

Methods

erase()  : void
Erase entity from Recycle Bin.
getActivityOwnerNotFoundMessage()  : mixed
getEntityFields()  : mixed
getEntityInfos()  : mixed
getEntityTypeID()  : int
Get Entity Type ID
getEntityTypeName()  : string
Get Entity Type Name
getFieldNames()  : mixed
getInstance()  : ActivityController|null
getRecyclebinEntityTypeName()  : string
Get recyclebin entity type name.
getRecyclingEntityId()  : int
getSuspendedEntityTypeID()  : int
Get Suspended Entity Type ID
getSuspendedEntityTypeName()  : string
Get Suspended Entity Type Name
isEnabled()  : bool
Check if current manager enabled.
isItemLocked()  : mixed
moveToBin()  : void
Move entity to Recycle Bin.
prepareEntityData()  : mixed
recover()  : int|null
Recover entity from Recycle Bin.

Methods

erase()

Erase entity from Recycle Bin.

public erase(mixed $entityID[, array<string|int, mixed> $params = [] ]) : void
Parameters
$entityID : mixed

Entity ID.

$params : array<string|int, mixed> = []

Additional operation parameters.

getActivityOwnerNotFoundMessage()

public getActivityOwnerNotFoundMessage(mixed $entityTypeID, mixed $entityID, array<string|int, mixed> $params) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$params : array<string|int, mixed>

getEntityFields()

public getEntityFields(mixed $entityID) : mixed
Parameters
$entityID : mixed

getEntityInfos()

public getEntityInfos(mixed $entityIDs) : mixed
Parameters
$entityIDs : mixed

getEntityTypeID()

Get Entity Type ID

public getEntityTypeID() : int
Return values
int

getEntityTypeName()

Get Entity Type Name

public getEntityTypeName() : string
Return values
string

getRecyclebinEntityTypeName()

Get recyclebin entity type name.

public getRecyclebinEntityTypeName() : string
Tags
see
Company::getEntityName
Return values
string

getRecyclingEntityId()

public final getRecyclingEntityId(int $entityId) : int
Parameters
$entityId : int
Return values
int

getSuspendedEntityTypeID()

Get Suspended Entity Type ID

public getSuspendedEntityTypeID() : int
Return values
int

getSuspendedEntityTypeName()

Get Suspended Entity Type Name

public getSuspendedEntityTypeName() : string
Return values
string

isEnabled()

Check if current manager enabled.

public static isEnabled() : bool
Return values
bool

isItemLocked()

public static isItemLocked(mixed $itemID) : mixed
Parameters
$itemID : mixed

moveToBin()

Move entity to Recycle Bin.

public moveToBin(mixed $entityID[, array<string|int, mixed> $params = array() ]) : void
Parameters
$entityID : mixed

Entity ID.

$params : array<string|int, mixed> = array()

Additional operation parameters.

prepareEntityData()

public prepareEntityData(mixed $entityID[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$entityID : mixed
$params : array<string|int, mixed> = array()

recover()

Recover entity from Recycle Bin.

public recover(int $entityID[, array<string|int, mixed> $params = [] ]) : int|null
Parameters
$entityID : int
$params : array<string|int, mixed> = []
Return values
int|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results