Gettext\Extractors\Po Class Reference

Class to get gettext strings from php files returning arrays. More...

Inheritance diagram for Gettext\Extractors\Po:

Collaboration diagram for Gettext\Extractors\Po:

Static Public Member Functions
static	fromString ($string, Translations $translations=null, $file='')
	Parses a .po file and append the translations found in the Translations instance. More...
static	convertString ($value)
	Convert a string from its PO representation. 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 Private Member Functions
static	isHeaderDefinition ($line)
	Checks if it is a header definition line. More...
static	parseHeaders ($headers, Translations $translations)
	Parse the po headers. More...
static	fixMultiLines ($line, array $lines, &$i)
	Gets one string from multiline strings. More...

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 php files returning arrays.

Definition at line 11 of file Po.php.

Member Function Documentation

convertString()

static Gettext\Extractors\Po::convertString (   $value )

static

Convert a string from its PO representation.

Parameters

string

$value

Returns

string

Definition at line 212 of file Po.php.

References array.

    {
        if (!$value) {
            return '';
        }

        if ($value[0] === '"') {
            $value = substr($value, 1, -1);
        }

        return strtr(
            $value,
            array(
                '\\\\' => '\\',
                '\\a' => "\x07",
                '\\b' => "\x08",
                '\\t' => "\t",
                '\\n' => "\n",
                '\\v' => "\x0b",
                '\\f' => "\x0c",
                '\\r' => "\r",
                '\\"' => '"',
            )
        );
    }

fixMultiLines()

static Gettext\Extractors\Po::fixMultiLines (   $line, array  $lines, &  $i  )

staticprivate

Gets one string from multiline strings.

Parameters

string	$line
array	$lines
int	&$i

Returns

string

Definition at line 188 of file Po.php.

References $i, and $t.

    {
        for ($j = $i, $t = count($lines); $j < $t; ++$j) {
            if (substr($line, -1, 1) == '"'
                && isset($lines[$j + 1])
                && substr(trim($lines[$j + 1]), 0, 1) == '"'
            ) {
                $line = substr($line, 0, -1).substr(trim($lines[$j + 1]), 1);
            } else {
                $i = $j;
                break;
            }
        }

        return $line;
    }

fromString()

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

static

Parses a .po file and append the translations found in the Translations instance.

{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 18 of file Po.php.

References $data, $i, $key, and $n.

    {
        if ($translations === null) {
            $translations = new Translations();
        }

        $lines = explode("\n", $string);
        $i = 0;

        $translation = new Translation('', '');

        for ($n = count($lines); $i < $n; ++$i) {
            $line = trim($lines[$i]);

            $line = self::fixMultiLines($line, $lines, $i);

            if ($line === '') {
                if ($translation->is('', '')) {
                    self::parseHeaders($translation->getTranslation(), $translations);
                } elseif ($translation->hasOriginal()) {
                    $translations[] = $translation;
                }

                $translation = new Translation('', '');
                continue;
            }

            $splitLine = preg_split('/\s+/', $line, 2);
            $key = $splitLine[0];
            $data = isset($splitLine[1]) ? $splitLine[1] : '';

            switch ($key) {
                case '#':
                    $translation->addComment($data);
                    $append = null;
                    break;

                case '#.':
                    $translation->addExtractedComment($data);
                    $append = null;
                    break;

                case '#,':
                    foreach (array_map('trim', explode(',', trim($data))) as $value) {
                        $translation->addFlag($value);
                    }
                    $append = null;
                    break;

                case '#:':
                    foreach (preg_split('/\s+/', trim($data)) as $value) {
                        if (preg_match('/^(.+)(:(\d*))?$/U', $value, $matches)) {
                            $translation->addReference($matches[1], isset($matches[3]) ? $matches[3] : null);
                        }
                    }
                    $append = null;
                    break;

                case 'msgctxt':
                    $translation = $translation->getClone(self::convertString($data));
                    $append = 'Context';
                    break;

                case 'msgid':
                    $translation = $translation->getClone(null, self::convertString($data));
                    $append = 'Original';
                    break;

                case 'msgid_plural':
                    $translation->setPlural(self::convertString($data));
                    $append = 'Plural';
                    break;

                case 'msgstr':
                case 'msgstr[0]':
                    $translation->setTranslation(self::convertString($data));
                    $append = 'Translation';
                    break;

                case 'msgstr[1]':
                    $translation->setPluralTranslation(self::convertString($data), 0);
                    $append = 'PluralTranslation';
                    break;

                default:
                    if (strpos($key, 'msgstr[') === 0) {
                        $translation->setPluralTranslation(self::convertString($data), intval(substr($key, 7, -1)) - 1);
                        $append = 'PluralTranslation';
                        break;
                    }

                    if (isset($append)) {
                        if ($append === 'Context') {
                            $translation = $translation->getClone($translation->getContext()."\n".self::convertString($data));
                            break;
                        }

                        if ($append === 'Original') {
                            $translation = $translation->getClone(null, $translation->getOriginal()."\n".self::convertString($data));
                            break;
                        }

                        if ($append === 'PluralTranslation') {
                            $key = count($translation->getPluralTranslation()) - 1;
                            $translation->setPluralTranslation($translation->getPluralTranslation($key)."\n".self::convertString($data), $key);
                            break;
                        }

                        $getMethod = 'get'.$append;
                        $setMethod = 'set'.$append;
                        $translation->$setMethod($translation->$getMethod()."\n".self::convertString($data));
                    }
                    break;
            }
        }

        if ($translation->hasOriginal() && !in_array($translation, iterator_to_array($translations))) {
            $translations[] = $translation;
        }

        return $translations;
    }

isHeaderDefinition()

static Gettext\Extractors\Po::isHeaderDefinition (   $line )

staticprivate

Checks if it is a header definition line.

Useful for distguishing between header definitions and possible continuations of a header entry.

Parameters

string

$line

Line to parse

Returns

bool

Definition at line 149 of file Po.php.

    {
        return (bool) preg_match('/^[\w-]+:/', $line);
    }

parseHeaders()

static Gettext\Extractors\Po::parseHeaders (   $headers, Translations  $translations  )

staticprivate

Parse the po headers.

Parameters

string	$headers
Translations	$translations

Definition at line 160 of file Po.php.

References $header, Gettext\Translations\getHeader(), and Gettext\Translations\setHeader().

    {
        $headers = explode("\n", $headers);
        $currentHeader = null;

        foreach ($headers as $line) {
            $line = self::convertString($line);

            if (self::isHeaderDefinition($line)) {
                $header = array_map('trim', explode(':', $line, 2));
                $currentHeader = $header[0];
                $translations->setHeader($currentHeader, $header[1]);
            } else {
                $entry = $translations->getHeader($currentHeader);
                $translations->setHeader($currentHeader, $entry.$line);
            }
        }
    }

Here is the call graph for this function:

---

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

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