StyledPicture extends Payload implements IPayload
Table of Contents
Interfaces
Methods
- __construct() : mixed
- 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>
- 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
- pack() : string
- Packs the payload's data in string and returns it.
- 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
- unpack() : static|null
- Unpacks data and creates Payload instance from it.
Methods
__construct()
public
__construct(string $payload) : mixed
Parameters
- $payload : string
getCost()
Returns cost of usage for specific Payload.
public
getCost() : int
Return values
intgetData()
Returns current payload data.
public
getData() : mixed
Tags
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|nullgetShareService()
public
static getShareService() : ShareService
Return values
ShareServicegetTokenProcessor()
public
final getTokenProcessor() : TokenProcessor
Return values
TokenProcessorhasHiddenTokens()
public
final hasHiddenTokens() : bool
Return values
boolhideTokens()
public
final hideTokens(string $value) : string
Parameters
- $value : string
Return values
stringpack()
Packs the payload's data in string and returns it.
public
pack() : string
Return values
stringsetCost()
public
setCost(int $cost) : static
Parameters
- $cost : int
Return values
staticsetEngine()
Sets Engine instance for Payload.
public
setEngine(IEngine $engine) : self
Parameters
- $engine : IEngine
-
Engine instance.
Return values
selfsetHiddenTokens()
public
final setHiddenTokens(array<string|int, HiddenToken> $tokens) : $this
Parameters
- $tokens : array<string|int, HiddenToken>
Return values
$thissetMarkers()
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
staticsetProcessedReplacements()
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
selfshouldUseCache()
public
shouldUseCache() : bool
Return values
boolunpack()
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().