MutationSuggestion implements JsonSerializable

FinalYes

Representation of a mutation suggested by a handler.

The identifier is used to keep track of the original handling class/aspect. Higher priorities take precedence when being visualized in the backend module.

Table of Contents

Interfaces

JsonSerializable

Properties

$collection  : MutationCollection
$identifier  : string
$label  : string|null
$priority  : int|null

Methods

__construct()  : mixed
hash()  : string
hmac()  : string
jsonSerialize()  : array<string|int, mixed>

Properties

$identifier read-only

public string $identifier

$label read-only

public string|null $label = null

$priority read-only

public int|null $priority = null

Methods

__construct()

public __construct(MutationCollection $collection, string $identifier[, int|null $priority = null ][, string|null $label = null ]) : mixed
Parameters
$collection : MutationCollection
$identifier : string

a unique identifier (e.g. Vendor\Extension\MyHandler@knownJavaScript)

$priority : int|null = null

an integer in the range of [0; 10]

$label : string|null = null

to be shown in backend module

hash()

public hash() : string
Return values
string

hmac()

public hmac() : string
Return values
string

jsonSerialize()

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

        
On this page

Search results