AbstractOperation.php
1 month ago
MergeOperation.php
2 years ago
OperationInterface.php
1 month ago
TargetOperation.php
2 years ago
OperationInterface.php
57 lines
| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | * This file is part of the Symfony package. |
| 5 | * |
| 6 | * (c) Fabien Potencier <fabien@symfony.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | namespace IAWPSCOPED\Symfony\Component\Translation\Catalogue; |
| 12 | |
| 13 | use IAWPSCOPED\Symfony\Component\Translation\MessageCatalogueInterface; |
| 14 | /** |
| 15 | * Represents an operation on catalogue(s). |
| 16 | * |
| 17 | * An instance of this interface performs an operation on one or more catalogues and |
| 18 | * stores intermediate and final results of the operation. |
| 19 | * |
| 20 | * The first catalogue in its argument(s) is called the 'source catalogue' or 'source' and |
| 21 | * the following results are stored: |
| 22 | * |
| 23 | * Messages: also called 'all', are valid messages for the given domain after the operation is performed. |
| 24 | * |
| 25 | * New Messages: also called 'new' (new = all ∖ source = {x: x ∈ all ∧ x ∉ source}). |
| 26 | * |
| 27 | * Obsolete Messages: also called 'obsolete' (obsolete = source ∖ all = {x: x ∈ source ∧ x ∉ all}). |
| 28 | * |
| 29 | * Result: also called 'result', is the resulting catalogue for the given domain that holds the same messages as 'all'. |
| 30 | * |
| 31 | * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com> |
| 32 | * @internal |
| 33 | */ |
| 34 | interface OperationInterface |
| 35 | { |
| 36 | /** |
| 37 | * Returns domains affected by operation. |
| 38 | */ |
| 39 | public function getDomains() : array; |
| 40 | /** |
| 41 | * Returns all valid messages ('all') after operation. |
| 42 | */ |
| 43 | public function getMessages(string $domain) : array; |
| 44 | /** |
| 45 | * Returns new messages ('new') after operation. |
| 46 | */ |
| 47 | public function getNewMessages(string $domain) : array; |
| 48 | /** |
| 49 | * Returns obsolete messages ('obsolete') after operation. |
| 50 | */ |
| 51 | public function getObsoleteMessages(string $domain) : array; |
| 52 | /** |
| 53 | * Returns resulting catalogue ('result'). |
| 54 | */ |
| 55 | public function getResult() : MessageCatalogueInterface; |
| 56 | } |
| 57 |