Gettext\Extractors\Mo Class Reference

Class to get gettext strings from .mo files. More...

Inheritance diagram for Gettext\Extractors\Mo:

Collaboration diagram for Gettext\Extractors\Mo:

Static Public Member Functions
static	fromString ($string, Translations $translations=null, $file='')
	{Parses a string and append the translations found in the Translations instance. Parameters string $string Translations | null $translations string $file The file path to insert the reference Returns Translations } More...
Static Public Member Functions inherited from Gettext\Extractors\Extractor
static	fromFile ($file, Translations $translations=null)
	Extract the translations from a file. More...
Static Public Member Functions inherited from Gettext\Extractors\ExtractorInterface
static	fromFile ($file, Translations $translations=null)
	Extract the translations from a file. More...
static	fromString ($string, Translations $translations=null, $file='')
	Parses a string and append the translations found in the Translations instance. More...

Data Fields
const	MAGIC1 = -1794895138
const	MAGIC2 = -569244523
const	MAGIC3 = 2500072158

Static Private Member Functions
static	readInt (StringReader $stream, $byteOrder)
static	readIntArray (StringReader $stream, $byteOrder, $count)

Additional Inherited Members
Static Protected Member Functions inherited from Gettext\Extractors\Extractor
static	getFiles ($file)
	Checks and returns all files. More...
static	readFile ($file)
	Reads and returns the content of a file. More...

Detailed Description

Class to get gettext strings from .mo files.

Definition at line 12 of file Mo.php.

Member Function Documentation

fromString()

static Gettext\Extractors\Mo::fromString (   $string, Translations  $translations = null,   $file = ''  )

static

{Parses a string and append the translations found in the Translations instance.

Parameters

string	$string
Translations | null	$translations
string	$file	The file path to insert the reference

Returns

Translations

}

Implements Gettext\Extractors\ExtractorInterface.

Definition at line 21 of file Mo.php.

    {
        if ($translations === null) {
            $translations = new Translations();
        }
 
        $stream = new StringReader($string);
        $magic = self::readInt($stream, 'V');
 
        if (($magic === self::MAGIC1) || ($magic === self::MAGIC3)) { //to make sure it works for 64-bit platforms
            $byteOrder = 'V'; //low endian
        } elseif ($magic === (self::MAGIC2 & 0xFFFFFFFF)) {
            $byteOrder = 'N'; //big endian
        } else {
            throw new Exception('Not MO file');
        }
 
        self::readInt($stream, $byteOrder);
 
        $total = self::readInt($stream, $byteOrder); //total string count
        $originals = self::readInt($stream, $byteOrder); //offset of original table
        $tran = self::readInt($stream, $byteOrder); //offset of translation table
 
        $stream->seekto($originals);
        $table_originals = self::readIntArray($stream, $byteOrder, $total * 2);
 
        $stream->seekto($tran);
        $table_translations = self::readIntArray($stream, $byteOrder, $total * 2);
 
        for ($i = 0; $i < $total; ++$i) {
            $next = $i * 2;
 
            $stream->seekto($table_originals[$next + 2]);
            $original = $stream->read($table_originals[$next + 1]);
 
            $stream->seekto($table_translations[$next + 2]);
            $translated = $stream->read($table_translations[$next + 1]);
 
            if ($original === '') {
                // Headers
                foreach (explode("\n", $translated) as $headerLine) {
                    if ($headerLine === '') {
                        continue;
                    }
 
                    $headerChunks = preg_split('/:\s*/', $headerLine, 2);
                    $translations->setHeader($headerChunks[0], isset($headerChunks[1]) ? $headerChunks[1] : '');
                }
 
                continue;
            }
 
            $chunks = explode("\x04", $original, 2);
 
            if (isset($chunks[1])) {
                $context = $chunks[0];
                $original = $chunks[1];
            } else {
                $context = '';
            }
 
            $chunks = explode("\x00", $original, 2);
 
            if (isset($chunks[1])) {
                $original = $chunks[0];
                $plural = $chunks[1];
            } else {
                $plural = '';
            }
 
            $translation = $translations->insert($context, $original, $plural);
 
            if ($translated === '') {
                continue;
            }
 
            if ($plural === '') {
                $translation->setTranslation($translated);
                continue;
            }
 
            foreach (explode("\x00", $translated) as $pluralIndex => $pluralValue) {
                if ($pluralIndex === 0) {
                    $translation->setTranslation($pluralValue);
                } else {
                    $translation->setPluralTranslation($pluralValue, $pluralIndex - 1);
                }
            }
        }
 
        return $translations;
    }

References $context, $i, GuzzleHttp\Psr7\$stream, $total, Gettext\Extractors\Mo\readInt(), and Gettext\Extractors\Mo\readIntArray().

Here is the call graph for this function:

readInt()

static Gettext\Extractors\Mo::readInt ( StringReader  $stream,   $byteOrder  )

staticprivate

Parameters

StringReader	$stream
string	$byteOrder

Definition at line 118 of file Mo.php.

    {
        if (($read = $stream->read(4)) === false) {
            return false;
        }
 
        $read = unpack($byteOrder, $read);
 
        return array_shift($read);
    }

References GuzzleHttp\Psr7\$stream.

Referenced by Gettext\Extractors\Mo\fromString().

Here is the caller graph for this function:

readIntArray()

static Gettext\Extractors\Mo::readIntArray ( StringReader  $stream,   $byteOrder,   $count  )

staticprivate

Parameters

StringReader	$stream
string	$byteOrder
int	$count

Definition at line 134 of file Mo.php.

    {
        return unpack($byteOrder.$count, $stream->read(4 * $count));
    }

References GuzzleHttp\Psr7\$stream.

Referenced by Gettext\Extractors\Mo\fromString().

Here is the caller graph for this function:

Field Documentation

MAGIC1

const Gettext\Extractors\Mo::MAGIC1 = -1794895138

Definition at line 14 of file Mo.php.

MAGIC2

const Gettext\Extractors\Mo::MAGIC2 = -569244523

Definition at line 15 of file Mo.php.

MAGIC3

const Gettext\Extractors\Mo::MAGIC3 = 2500072158

Definition at line 16 of file Mo.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/gettext/gettext/src/Extractors/Mo.php