OperationInterface
in
Represents an operation on catalogue(s).
An instance of this interface performs an operation on one or more catalogues and stores intermediate and final results of the operation.
The first catalogue in its argument(s) is called the 'source catalogue' or 'source' and the following results are stored:
Messages: also called 'all', are valid messages for the given domain after the operation is performed.
New Messages: also called 'new' (new = all ∖ source = {x: x ∈ all ∧ x ∉ source}).
Obsolete Messages: also called 'obsolete' (obsolete = source ∖ all = {x: x ∈ source ∧ x ∉ all}).
Result: also called 'result', is the resulting catalogue for the given domain that holds the same messages as 'all'.
Tags
Table of Contents
- getDomains() : array<string|int, mixed>
- Returns domains affected by operation.
- getMessages() : array<string|int, mixed>
- Returns all valid messages ('all') after operation.
- getNewMessages() : array<string|int, mixed>
- Returns new messages ('new') after operation.
- getObsoleteMessages() : array<string|int, mixed>
- Returns obsolete messages ('obsolete') after operation.
- getResult() : MessageCatalogueInterface
- Returns resulting catalogue ('result').
Methods
getDomains()
Returns domains affected by operation.
public
getDomains() : array<string|int, mixed>
Return values
array<string|int, mixed> —getMessages()
Returns all valid messages ('all') after operation.
public
getMessages(string $domain) : array<string|int, mixed>
Parameters
- $domain : string
Return values
array<string|int, mixed> —getNewMessages()
Returns new messages ('new') after operation.
public
getNewMessages(string $domain) : array<string|int, mixed>
Parameters
- $domain : string
Return values
array<string|int, mixed> —getObsoleteMessages()
Returns obsolete messages ('obsolete') after operation.
public
getObsoleteMessages(string $domain) : array<string|int, mixed>
Parameters
- $domain : string
Return values
array<string|int, mixed> —getResult()
Returns resulting catalogue ('result').
public
getResult() : MessageCatalogueInterface