Bitrix API

Payload

AbstractYes

Table of Contents

Methods

getCost()  : int
Returns cost of usage for specific Payload.
getHiddenTokens()  : array<string|int, mixed>
getMarkers()  : array<string|int, mixed>
Returns markers was sets.
getProcessedReplacements()  : array<string|int, mixed>
Returns processed replacements. Should be used after QueueJob evaluation.
getRawData()  : mixed
Returns current payload data without any transformations as is.
getRole()  : Role|null
Returns Role instance
getShareService()  : ShareService
getTokenProcessor()  : TokenProcessor
hasHiddenTokens()  : bool
hideTokens()  : string
setCost()  : static
setEngine()  : self
Sets Engine instance for Payload.
setHiddenTokens()  : $this
setMarkers()  : static
Sets markers for replacing in payload.
setProcessedReplacements()  : void
setRole()  : self
Sets Role instance for Payload.
shouldUseCache()  : bool

Methods

getCost()

Returns cost of usage for specific Payload.

public getCost() : int
Return values
int

getHiddenTokens()

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

getMarkers()

Returns markers was sets.

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

getProcessedReplacements()

Returns processed replacements. Should be used after QueueJob evaluation.

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

getRawData()

Returns current payload data without any transformations as is.

public getRawData() : mixed

getRole()

Returns Role instance

public getRole() : Role|null
Return values
Role|null

hasHiddenTokens()

public final hasHiddenTokens() : bool
Return values
bool

hideTokens()

public final hideTokens(string $value) : string
Parameters
$value : string
Return values
string

setCost()

public setCost(int $cost) : static
Parameters
$cost : int
Return values
static

setEngine()

Sets Engine instance for Payload.

public setEngine(IEngine $engine) : self
Parameters
$engine : IEngine

Engine instance.

Return values
self

setHiddenTokens()

public final setHiddenTokens(array<string|int, HiddenToken> $tokens) : $this
Parameters
$tokens : array<string|int, HiddenToken>
Return values
$this

setMarkers()

Sets markers for replacing in payload.

public setMarkers(array<string|int, mixed> $markers) : static

If your payload contains some markers (for {example}) you should use this method.

Parameters
$markers : array<string|int, mixed>

Markers for replace.

Return values
static

setProcessedReplacements()

public final setProcessedReplacements(array<string|int, mixed> $processedReplacements) : void
Parameters
$processedReplacements : array<string|int, mixed>

setRole()

Sets Role instance for Payload.

public setRole(Role|null $role[, bool $append = false ]) : self
Parameters
$role : Role|null

Role instance.

$append : bool = false

If true, content of Role will be appended, otherwise Role will be replaced.

Return values
self

shouldUseCache()

public shouldUseCache() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results