Просмотр файла vendor/symfony/translation/Catalogue/AbstractOperation.php

<?php
 
/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
 
namespace Symfony\Component\Translation\Catalogue;
 
use Symfony\Component\Translation\MessageCatalogue;
use Symfony\Component\Translation\MessageCatalogueInterface;
use Symfony\Component\Translation\Exception\InvalidArgumentException;
use Symfony\Component\Translation\Exception\LogicException;
 
/**
 * Base catalogues binary operation class.
 *
 * A catalogue binary operation performs operation on
 * source (the left argument) and target (the right argument) catalogues.
 *
 * @author Jean-François Simon <contact@jfsimon.fr>
 */
abstract class AbstractOperation implements OperationInterface
{
    /**
     * @var MessageCatalogueInterface The source catalogue
     */
    protected $source;
 
    /**
     * @var MessageCatalogueInterface The target catalogue
     */
    protected $target;
 
    /**
     * @var MessageCatalogue The result catalogue
     */
    protected $result;
 
    /**
     * @var null|array The domains affected by this operation
     */
    private $domains;
 
    /**
     * This array stores 'all', 'new' and 'obsolete' messages for all valid domains.
     *
     * The data structure of this array is as follows:
     * ```php
     * array(
     *     'domain 1' => array(
     *         'all' => array(...),
     *         'new' => array(...),
     *         'obsolete' => array(...)
     *     ),
     *     'domain 2' => array(
     *         'all' => array(...),
     *         'new' => array(...),
     *         'obsolete' => array(...)
     *     ),
     *     ...
     * )
     * ```
     *
     * @var array The array that stores 'all', 'new' and 'obsolete' messages
     */
    protected $messages;
 
    /**
     * @param MessageCatalogueInterface $source The source catalogue
     * @param MessageCatalogueInterface $target The target catalogue
     *
     * @throws LogicException
     */
    public function __construct(MessageCatalogueInterface $source, MessageCatalogueInterface $target)
    {
        if ($source->getLocale() !== $target->getLocale()) {
            throw new LogicException('Operated catalogues must belong to the same locale.');
        }
 
        $this->source = $source;
        $this->target = $target;
        $this->result = new MessageCatalogue($source->getLocale());
        $this->domains = null;
        $this->messages = array();
    }
 
    /**
     * {@inheritdoc}
     */
    public function getDomains()
    {
        if (null === $this->domains) {
            $this->domains = array_values(array_unique(array_merge($this->source->getDomains(), $this->target->getDomains())));
        }
 
        return $this->domains;
    }
 
    /**
     * {@inheritdoc}
     */
    public function getMessages($domain)
    {
        if (!in_array($domain, $this->getDomains())) {
            throw new InvalidArgumentException(sprintf('Invalid domain: %s.', $domain));
        }
 
        if (!isset($this->messages[$domain]['all'])) {
            $this->processDomain($domain);
        }
 
        return $this->messages[$domain]['all'];
    }
 
    /**
     * {@inheritdoc}
     */
    public function getNewMessages($domain)
    {
        if (!in_array($domain, $this->getDomains())) {
            throw new InvalidArgumentException(sprintf('Invalid domain: %s.', $domain));
        }
 
        if (!isset($this->messages[$domain]['new'])) {
            $this->processDomain($domain);
        }
 
        return $this->messages[$domain]['new'];
    }
 
    /**
     * {@inheritdoc}
     */
    public function getObsoleteMessages($domain)
    {
        if (!in_array($domain, $this->getDomains())) {
            throw new InvalidArgumentException(sprintf('Invalid domain: %s.', $domain));
        }
 
        if (!isset($this->messages[$domain]['obsolete'])) {
            $this->processDomain($domain);
        }
 
        return $this->messages[$domain]['obsolete'];
    }
 
    /**
     * {@inheritdoc}
     */
    public function getResult()
    {
        foreach ($this->getDomains() as $domain) {
            if (!isset($this->messages[$domain])) {
                $this->processDomain($domain);
            }
        }
 
        return $this->result;
    }
 
    /**
     * Performs operation on source and target catalogues for the given domain and
     * stores the results.
     *
     * @param string $domain The domain which the operation will be performed for
     */
    abstract protected function processDomain($domain);
}