Bitrix API

IPayload

Table of Contents

Methods

getCost()  : int
Returns cost of usage for specific Payload.
getData()  : mixed
Returns current payload data.
getHiddenTokens()  : array<string|int, mixed>
getMarkers()  : array<string|int, mixed>
Returns markers was sets.
getProcessedReplacements()  : array<string|int, mixed>
getRawData()  : mixed
Returns current payload data without any transformations as is.
getRole()  : Role|null
Returns Role instance
getTokenProcessor()  : TokenProcessor
pack()  : string
Packs the payload's data in string and returns it.
setCost()  : static
setEngine()  : static
Sets Engine instance for Payload.
setHiddenTokens()  : static
setMarkers()  : static
Sets markers for replacing in payload.
setProcessedReplacements()  : void
setRole()  : self
Sets Role instance for Payload.
shouldUseCache()  : bool
Check can we cache current payload
unpack()  : static|null
Unpacks data and creates Payload instance from it.

Methods

getCost()

Returns cost of usage for specific Payload.

public getCost() : int
Return values
int

getData()

Returns current payload data.

public getData() : mixed

Method MUST replace all markers in payload, and apply conditions.

getHiddenTokens()

public 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()

public 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

pack()

Packs the payload's data in string and returns it.

public pack() : 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) : static
Parameters
$engine : IEngine

Engine instance.

Return values
static

setHiddenTokens()

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

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 setProcessedReplacements(array<string|int, mixed> $processedReplacements) : void
Parameters
$processedReplacements : array<string|int, mixed>

setRole()

Sets Role instance for Payload.

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

Role instance.

$append : bool = false

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

Return values
self

shouldUseCache()

Check can we cache current payload

public shouldUseCache() : bool
Return values
bool

unpack()

Unpacks data and creates Payload instance from it.

public static unpack(string $packedData) : static|null
Parameters
$packedData : string

Packed data by using method self::pack().

Return values
static|null 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results