You are here

class ArrayLoader in Plug 7

ArrayLoader loads translations from a PHP array.

@author Fabien Potencier <fabien@symfony.com>

@api

Hierarchy

Expanded class hierarchy of ArrayLoader

4 files declare their use of ArrayLoader
DataCollectorTranslatorTest.php in lib/Symfony/translation/Tests/DataCollectorTranslatorTest.php
LoggingTranslatorTest.php in lib/Symfony/translation/Tests/LoggingTranslatorTest.php
TranslatorCacheTest.php in lib/Symfony/translation/Tests/TranslatorCacheTest.php
TranslatorTest.php in lib/Symfony/translation/Tests/TranslatorTest.php

File

lib/Symfony/translation/Loader/ArrayLoader.php, line 23

Namespace

Symfony\Component\Translation\Loader
View source
class ArrayLoader implements LoaderInterface {

  /**
   * {@inheritdoc}
   *
   * @api
   */
  public function load($resource, $locale, $domain = 'messages') {
    $this
      ->flatten($resource);
    $catalogue = new MessageCatalogue($locale);
    $catalogue
      ->add($resource, $domain);
    return $catalogue;
  }

  /**
   * Flattens an nested array of translations.
   *
   * The scheme used is:
   *   'key' => array('key2' => array('key3' => 'value'))
   * Becomes:
   *   'key.key2.key3' => 'value'
   *
   * This function takes an array by reference and will modify it
   *
   * @param array  &$messages The array that will be flattened
   * @param array  $subnode   Current subnode being parsed, used internally for recursive calls
   * @param string $path      Current path being parsed, used internally for recursive calls
   */
  private function flatten(array &$messages, array $subnode = null, $path = null) {
    if (null === $subnode) {
      $subnode =& $messages;
    }
    foreach ($subnode as $key => $value) {
      if (is_array($value)) {
        $nodePath = $path ? $path . '.' . $key : $key;
        $this
          ->flatten($messages, $value, $nodePath);
        if (null === $path) {
          unset($messages[$key]);
        }
      }
      elseif (null !== $path) {
        $messages[$path . '.' . $key] = $value;
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ArrayLoader::flatten private function Flattens an nested array of translations.
ArrayLoader::load public function @api Overrides LoaderInterface::load 1