OperationInterface
interface OperationInterface
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'.
Methods
array | getDomains() Returns domains affected by operation. | |
array | getMessages(string $domain) Returns all valid messages ('all') after operation. | |
array | getNewMessages(string $domain) Returns new messages ('new') after operation. | |
array | getObsoleteMessages(string $domain) Returns obsolete messages ('obsolete') after operation. | |
MessageCatalogueInterface | getResult() Returns resulting catalogue ('result'). |
Details
array getDomains()
Returns domains affected by operation.
Return Value
array |
array getMessages(string $domain)
Returns all valid messages ('all') after operation.
Parameters
string | $domain |
Return Value
array |
array getNewMessages(string $domain)
Returns new messages ('new') after operation.
Parameters
string | $domain |
Return Value
array |
array getObsoleteMessages(string $domain)
Returns obsolete messages ('obsolete') after operation.
Parameters
string | $domain |
Return Value
array |
MessageCatalogueInterface getResult()
Returns resulting catalogue ('result').
Return Value
MessageCatalogueInterface |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Translation/Catalogue/OperationInterface.html