Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\Translation\Catalogue;
Chris@0: 
Chris@0: use Symfony\Component\Translation\MessageCatalogueInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Represents an operation on catalogue(s).
Chris@0:  *
Chris@0:  * An instance of this interface performs an operation on one or more catalogues and
Chris@0:  * stores intermediate and final results of the operation.
Chris@0:  *
Chris@0:  * The first catalogue in its argument(s) is called the 'source catalogue' or 'source' and
Chris@0:  * the following results are stored:
Chris@0:  *
Chris@0:  * Messages: also called 'all', are valid messages for the given domain after the operation is performed.
Chris@0:  *
Chris@0:  * New Messages: also called 'new' (new = all ∖ source = {x: x ∈ all ∧ x ∉ source}).
Chris@0:  *
Chris@0:  * Obsolete Messages: also called 'obsolete' (obsolete = source ∖ all = {x: x ∈ source ∧ x ∉ all}).
Chris@0:  *
Chris@0:  * Result: also called 'result', is the resulting catalogue for the given domain that holds the same messages as 'all'.
Chris@0:  *
Chris@0:  * @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com>
Chris@0:  */
Chris@0: interface OperationInterface
Chris@0: {
Chris@0:     /**
Chris@0:      * Returns domains affected by operation.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function getDomains();
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns all valid messages ('all') after operation.
Chris@0:      *
Chris@0:      * @param string $domain
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function getMessages($domain);
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns new messages ('new') after operation.
Chris@0:      *
Chris@0:      * @param string $domain
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function getNewMessages($domain);
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns obsolete messages ('obsolete') after operation.
Chris@0:      *
Chris@0:      * @param string $domain
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function getObsoleteMessages($domain);
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns resulting catalogue ('result').
Chris@0:      *
Chris@0:      * @return MessageCatalogueInterface
Chris@0:      */
Chris@0:     public function getResult();
Chris@0: }