class MoFileLoader in Zircon Profile 8.0

@copyright Copyright (c) 2010, Union of RAD http://union-of-rad.org (http://lithify.me/)

Hierarchy

• class \Symfony\Component\Translation\Loader\ArrayLoader implements LoaderInterface
  • class \Symfony\Component\Translation\Loader\MoFileLoader

2 files declare their use of MoFileLoader

MoFileDumper.php in vendor/symfony/translation/Dumper/MoFileDumper.php

MoFileLoaderTest.php in vendor/symfony/translation/Tests/Loader/MoFileLoaderTest.php

1 string reference to 'MoFileLoader'

TranslatorTest::getTransFileTests in vendor/symfony/translation/Tests/TranslatorTest.php

File

vendor/symfony/translation/Loader/MoFileLoader.php, line 21

Namespace

Symfony\Component\Translation\Loader

class MoFileLoader extends ArrayLoader {

  /**
   * Magic used for validating the format of a MO file as well as
   * detecting if the machine used to create that file was little endian.
   *
   * @var float
   */
  const MO_LITTLE_ENDIAN_MAGIC = 0x950412de;

  /**
   * Magic used for validating the format of a MO file as well as
   * detecting if the machine used to create that file was big endian.
   *
   * @var float
   */
  const MO_BIG_ENDIAN_MAGIC = 0xde120495;

  /**
   * The size of the header of a MO file in bytes.
   *
   * @var int Number of bytes.
   */
  const MO_HEADER_SIZE = 28;
  public function load($resource, $locale, $domain = 'messages') {
    if (!stream_is_local($resource)) {
      throw new InvalidResourceException(sprintf('This is not a local file "%s".', $resource));
    }
    if (!file_exists($resource)) {
      throw new NotFoundResourceException(sprintf('File "%s" not found.', $resource));
    }
    $messages = $this
      ->parse($resource);

    // empty file
    if (null === $messages) {
      $messages = array();
    }

    // not an array
    if (!is_array($messages)) {
      throw new InvalidResourceException(sprintf('The file "%s" must contain a valid mo file.', $resource));
    }
    $catalogue = parent::load($messages, $locale, $domain);
    if (class_exists('Symfony\\Component\\Config\\Resource\\FileResource')) {
      $catalogue
        ->addResource(new FileResource($resource));
    }
    return $catalogue;
  }

  /**
   * Parses machine object (MO) format, independent of the machine's endian it
   * was created on. Both 32bit and 64bit systems are supported.
   *
   * @param resource $resource
   *
   * @return array
   *
   * @throws InvalidResourceException If stream content has an invalid format.
   */
  private function parse($resource) {
    $stream = fopen($resource, 'r');
    $stat = fstat($stream);
    if ($stat['size'] < self::MO_HEADER_SIZE) {
      throw new InvalidResourceException('MO stream content has an invalid format.');
    }
    $magic = unpack('V1', fread($stream, 4));
    $magic = hexdec(substr(dechex(current($magic)), -8));
    if ($magic == self::MO_LITTLE_ENDIAN_MAGIC) {
      $isBigEndian = false;
    }
    elseif ($magic == self::MO_BIG_ENDIAN_MAGIC) {
      $isBigEndian = true;
    }
    else {
      throw new InvalidResourceException('MO stream content has an invalid format.');
    }

    // formatRevision
    $this
      ->readLong($stream, $isBigEndian);
    $count = $this
      ->readLong($stream, $isBigEndian);
    $offsetId = $this
      ->readLong($stream, $isBigEndian);
    $offsetTranslated = $this
      ->readLong($stream, $isBigEndian);

    // sizeHashes
    $this
      ->readLong($stream, $isBigEndian);

    // offsetHashes
    $this
      ->readLong($stream, $isBigEndian);
    $messages = array();
    for ($i = 0; $i < $count; ++$i) {
      $singularId = $pluralId = null;
      $translated = null;
      fseek($stream, $offsetId + $i * 8);
      $length = $this
        ->readLong($stream, $isBigEndian);
      $offset = $this
        ->readLong($stream, $isBigEndian);
      if ($length < 1) {
        continue;
      }
      fseek($stream, $offset);
      $singularId = fread($stream, $length);
      if (strpos($singularId, "\0") !== false) {
        list($singularId, $pluralId) = explode("\0", $singularId);
      }
      fseek($stream, $offsetTranslated + $i * 8);
      $length = $this
        ->readLong($stream, $isBigEndian);
      $offset = $this
        ->readLong($stream, $isBigEndian);
      if ($length < 1) {
        continue;
      }
      fseek($stream, $offset);
      $translated = fread($stream, $length);
      if (strpos($translated, "\0") !== false) {
        $translated = explode("\0", $translated);
      }
      $ids = array(
        'singular' => $singularId,
        'plural' => $pluralId,
      );
      $item = compact('ids', 'translated');
      if (is_array($item['translated'])) {
        $messages[$item['ids']['singular']] = stripcslashes($item['translated'][0]);
        if (isset($item['ids']['plural'])) {
          $plurals = array();
          foreach ($item['translated'] as $plural => $translated) {
            $plurals[] = sprintf('{%d} %s', $plural, $translated);
          }
          $messages[$item['ids']['plural']] = stripcslashes(implode('|', $plurals));
        }
      }
      elseif (!empty($item['ids']['singular'])) {
        $messages[$item['ids']['singular']] = stripcslashes($item['translated']);
      }
    }
    fclose($stream);
    return array_filter($messages);
  }

  /**
   * Reads an unsigned long from stream respecting endianess.
   *
   * @param resource $stream
   * @param bool     $isBigEndian
   *
   * @return int
   */
  private function readLong($stream, $isBigEndian) {
    $result = unpack($isBigEndian ? 'N1' : 'V1', fread($stream, 4));
    $result = current($result);
    return (int) substr($result, -8);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ArrayLoader::flatten	private	function	Flattens an nested array of translations.
MoFileLoader::load	public	function	Loads a locale. Overrides ArrayLoader::load
MoFileLoader::MO_BIG_ENDIAN_MAGIC		constant	Magic used for validating the format of a MO file as well as detecting if the machine used to create that file was big endian.
MoFileLoader::MO_HEADER_SIZE		constant	The size of the header of a MO file in bytes.
MoFileLoader::MO_LITTLE_ENDIAN_MAGIC		constant	Magic used for validating the format of a MO file as well as detecting if the machine used to create that file was little endian.
MoFileLoader::parse	private	function	Parses machine object (MO) format, independent of the machine's endian it was created on. Both 32bit and 64bit systems are supported.
MoFileLoader::readLong	private	function	Reads an unsigned long from stream respecting endianess.