Bitrix API

Template

Class Template

Table of Contents

Methods

__construct()  : mixed
Template constructor.
createByTpl()  : mixed
deleteRobots()  : Result
getActivatedRobots()  : array<string|int, mixed>
getActivities()  : array<string|int, mixed>
getAvailableRobots()  : mixed
getDocumentStatus()  : mixed
getDocumentType()  : array<string|int, mixed>
getExecuteType()  : mixed
getId()  : mixed
getModified()  : DateTime|null
getParameters()  : array<string|int, mixed>
getProperty()  : array<string|int, mixed>|null
getRobotByName()  : Robot|null
Returns Robot by it`s id.
getRobots()  : array<string|int, Robot>
getRobotsByNames()  : array<string|int, mixed>
getRobotSettingsDialog()  : mixed
getTemplate()  : array<string|int, mixed>|null
isExternalModified()  : bool
Checks is template was modified by external editor.
save()  : mixed
saveRobotSettings()  : mixed
setDocumentStatus()  : mixed
setExecuteType()  : mixed
setName()  : mixed
setRobots()  : mixed
setTemplate()  : static
toArray()  : array<string|int, mixed>
Convert instance data to array.

Methods

__construct()

Template constructor.

public __construct(array<string|int, mixed> $documentType[, null $documentStatus = null ]) : mixed
Parameters
$documentType : array<string|int, mixed>
$documentStatus : null = null
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException

createByTpl()

public static createByTpl(Tpl $tpl) : mixed
Parameters
$tpl : Tpl

deleteRobots()

public deleteRobots(array<string|int, mixed> $robots, int $userId) : Result
Parameters
$robots : array<string|int, mixed>
$userId : int
Return values
Result

getActivatedRobots()

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

getActivities()

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

Template activities.

getAvailableRobots()

public static getAvailableRobots(array<string|int, mixed> $documentType) : mixed
Parameters
$documentType : array<string|int, mixed>

getDocumentStatus()

public getDocumentStatus() : mixed

getDocumentType()

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

getExecuteType()

public getExecuteType(mixed $autoExecuteType) : mixed
Parameters
$autoExecuteType : mixed

getParameters()

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

getProperty()

public getProperty(mixed $object, mixed $field) : array<string|int, mixed>|null
Parameters
$object : mixed
$field : mixed
Return values
array<string|int, mixed>|null

getRobotByName()

Returns Robot by it`s id.

public getRobotByName(string $name) : Robot|null
Parameters
$name : string

Robot identificator.

Return values
Robot|null —

Robot instance.

getRobots()

public getRobots() : array<string|int, Robot>
Return values
array<string|int, Robot> —

Robot activities.

getRobotsByNames()

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

getRobotSettingsDialog()

public getRobotSettingsDialog(array<string|int, mixed> $robot[, mixed $request = null ][, array<string|int, mixed>|null $contextRobots = null ]) : mixed
Parameters
$robot : array<string|int, mixed>
$request : mixed = null
$contextRobots : array<string|int, mixed>|null = null

getTemplate()

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

isExternalModified()

Checks is template was modified by external editor.

public isExternalModified() : bool
Return values
bool

save()

public save(array<string|int, mixed> $robots, mixed $userId[, array<string|int, mixed> $additional = [] ]) : mixed
Parameters
$robots : array<string|int, mixed>
$userId : mixed
$additional : array<string|int, mixed> = []

saveRobotSettings()

public saveRobotSettings(array<string|int, mixed> $robot, array<string|int, mixed> $request) : mixed
Parameters
$robot : array<string|int, mixed>
$request : array<string|int, mixed>

setDocumentStatus()

public setDocumentStatus(mixed $status) : mixed
Parameters
$status : mixed

setExecuteType()

public setExecuteType(mixed $autoExecuteType) : mixed
Parameters
$autoExecuteType : mixed

setName()

public setName(string $name) : mixed
Parameters
$name : string

setRobots()

public setRobots(array<string|int, mixed> $robots) : mixed
Parameters
$robots : array<string|int, mixed>

setTemplate()

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

toArray()

Convert instance data to array.

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results