class DataCollectorTranslator in Plug 7

@author Abdellatif Ait boudad <[e-mail]>

Hierarchy

• class \Symfony\Component\Translation\DataCollectorTranslator implements TranslatorBagInterface, TranslatorInterface

3 files declare their use of DataCollectorTranslator

DataCollectorTranslatorTest.php in lib/Symfony/translation/Tests/DataCollectorTranslatorTest.php

TranslationDataCollector.php in lib/Symfony/translation/DataCollector/TranslationDataCollector.php

TranslationDataCollectorTest.php in lib/Symfony/translation/Tests/DataCollector/TranslationDataCollectorTest.php

File

lib/Symfony/translation/DataCollectorTranslator.php, line 17

Namespace

Symfony\Component\Translation

class DataCollectorTranslator implements TranslatorInterface, TranslatorBagInterface {
  const MESSAGE_DEFINED = 0;
  const MESSAGE_MISSING = 1;
  const MESSAGE_EQUALS_FALLBACK = 2;

  /**
   * @var TranslatorInterface|TranslatorBagInterface
   */
  private $translator;

  /**
   * @var array
   */
  private $messages = array();

  /**
   * @param TranslatorInterface $translator The translator must implement TranslatorBagInterface
   */
  public function __construct(TranslatorInterface $translator) {
    if (!$translator instanceof TranslatorBagInterface) {
      throw new \InvalidArgumentException(sprintf('The Translator "%s" must implement TranslatorInterface and TranslatorBagInterface.', get_class($translator)));
    }
    $this->translator = $translator;
  }

  /**
   * {@inheritdoc}
   */
  public function trans($id, array $parameters = array(), $domain = null, $locale = null) {
    $trans = $this->translator
      ->trans($id, $parameters, $domain, $locale);
    $this
      ->collectMessage($locale, $domain, $id, $trans);
    return $trans;
  }

  /**
   * {@inheritdoc}
   */
  public function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null) {
    $trans = $this->translator
      ->transChoice($id, $number, $parameters, $domain, $locale);
    $this
      ->collectMessage($locale, $domain, $id, $trans);
    return $trans;
  }

  /**
   * {@inheritdoc}
   *
   * @api
   */
  public function setLocale($locale) {
    $this->translator
      ->setLocale($locale);
  }

  /**
   * {@inheritdoc}
   *
   * @api
   */
  public function getLocale() {
    return $this->translator
      ->getLocale();
  }

  /**
   * {@inheritdoc}
   */
  public function getCatalogue($locale = null) {
    return $this->translator
      ->getCatalogue($locale);
  }

  /**
   * Passes through all unknown calls onto the translator object.
   */
  public function __call($method, $args) {
    return call_user_func_array(array(
      $this->translator,
      $method,
    ), $args);
  }

  /**
   * @return array
   */
  public function getCollectedMessages() {
    return $this->messages;
  }

  /**
   * @param string|null $locale
   * @param string|null $domain
   * @param string      $id
   * @param string      $trans
   */
  private function collectMessage($locale, $domain, $id, $translation) {
    if (null === $domain) {
      $domain = 'messages';
    }
    $id = (string) $id;
    $catalogue = $this->translator
      ->getCatalogue($locale);
    $locale = $catalogue
      ->getLocale();
    if ($catalogue
      ->defines($id, $domain)) {
      $state = self::MESSAGE_DEFINED;
    }
    elseif ($catalogue
      ->has($id, $domain)) {
      $state = self::MESSAGE_EQUALS_FALLBACK;
      $fallbackCatalogue = $catalogue
        ->getFallBackCatalogue();
      while ($fallbackCatalogue) {
        if ($fallbackCatalogue
          ->defines($id, $domain)) {
          $locale = $fallbackCatalogue
            ->getLocale();
          break;
        }
        $fallbackCatalogue = $fallbackCatalogue
          ->getFallBackCatalogue();
      }
    }
    else {
      $state = self::MESSAGE_MISSING;
    }
    $this->messages[] = array(
      'locale' => $locale,
      'domain' => $domain,
      'id' => $id,
      'translation' => $translation,
      'state' => $state,
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DataCollectorTranslator::$messages	private	property
DataCollectorTranslator::$translator	private	property
DataCollectorTranslator::collectMessage	private	function
DataCollectorTranslator::getCatalogue	public	function	Gets the catalogue by locale. Overrides TranslatorBagInterface::getCatalogue
DataCollectorTranslator::getCollectedMessages	public	function
DataCollectorTranslator::getLocale	public	function	@api Overrides TranslatorInterface::getLocale
DataCollectorTranslator::MESSAGE_DEFINED		constant
DataCollectorTranslator::MESSAGE_EQUALS_FALLBACK		constant
DataCollectorTranslator::MESSAGE_MISSING		constant
DataCollectorTranslator::setLocale	public	function	@api Overrides TranslatorInterface::setLocale
DataCollectorTranslator::trans	public	function	Translates the given message. Overrides TranslatorInterface::trans
DataCollectorTranslator::transChoice	public	function	Translates the given choice message by choosing a translation according to a number. Overrides TranslatorInterface::transChoice
DataCollectorTranslator::__call	public	function	Passes through all unknown calls onto the translator object.
DataCollectorTranslator::__construct	public	function