Gettext\Generators\Po Class Reference

Inheritance diagram for Gettext\Generators\Po:

Collaboration diagram for Gettext\Generators\Po:

Static Public Member Functions
static	toString (Translations $translations)
	{@parentDoc}. More...
static	convertString ($value)
	Convert a string to its PO representation. More...
Static Public Member Functions inherited from Gettext\Generators\Generator
static	toFile (Translations $translations, $file)
	Saves the translations in a file. More...
Static Public Member Functions inherited from Gettext\Generators\GeneratorInterface
static	toFile (Translations $translations, $file)
	Saves the translations in a file. More...
static	toString (Translations $translations)
	Generates a string with the translations ready to save in a file. More...

Static Private Member Functions
static	multilineQuote ($string)
	Escapes and adds double quotes to a string. More...
static	addLines (array &$lines, $name, $value)
	Add one or more lines depending whether the string is multiline or not. More...

Detailed Description

Definition at line 7 of file Po.php.

Member Function Documentation

addLines()

static Gettext\Generators\Po::addLines ( array &  $lines,   $name,   $value  )

staticprivate

Add one or more lines depending whether the string is multiline or not.

Parameters

array	&$lines
string	$name
string	$value

Definition at line 101 of file Po.php.

    {
        $newLines = self::multilineQuote($value);
 
        if (count($newLines) === 1) {
            $lines[] = $name.' '.$newLines[0];
        } else {
            $lines[] = $name.' ""';
 
            foreach ($newLines as $line) {
                $lines[] = $line;
            }
        }
    }

References $name, and Gettext\Generators\Po\multilineQuote().

Referenced by Gettext\Generators\Po\toString().

Here is the call graph for this function:

Here is the caller graph for this function:

convertString()

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

static

Convert a string to its PO representation.

Parameters

string

$value

Returns

string

Definition at line 123 of file Po.php.

    {
        return '"'.strtr(
            $value,
            array(
                "\x00" => '',
                '\\' => '\\\\',
                "\t" => '\t',
                "\n" => '\n',
                '"' => '\\"',
            )
        ).'"';
    }

Referenced by Gettext\Generators\Po\multilineQuote().

Here is the caller graph for this function:

multilineQuote()

static Gettext\Generators\Po::multilineQuote (   $string )

staticprivate

Escapes and adds double quotes to a string.

Parameters

string

$string

Returns

string

Definition at line 78 of file Po.php.

    {
        $lines = explode("\n", $string);
        $last = count($lines) - 1;
 
        foreach ($lines as $k => $line) {
            if ($k === $last) {
                $lines[$k] = self::convertString($line);
            } else {
                $lines[$k] = self::convertString($line."\n");
            }
        }
 
        return $lines;
    }

References Gettext\Generators\Po\convertString().

Referenced by Gettext\Generators\Po\addLines().

Here is the call graph for this function:

Here is the caller graph for this function:

toString()

static Gettext\Generators\Po::toString ( Translations  $translations )

static

{@parentDoc}.

Implements Gettext\Generators\GeneratorInterface.

Definition at line 12 of file Po.php.

    {
        $lines = array('msgid ""', 'msgstr ""');
 
        $headers = $translations->getHeaders();
        $headers['PO-Revision-Date'] = date('c');
 
        foreach ($headers as $name => $value) {
            $lines[] = '"'.$name.': '.$value.'\\n"';
        }
 
        $lines[] = '';
 
        //Translations
        foreach ($translations as $translation) {
            if ($translation->hasComments()) {
                foreach ($translation->getComments() as $comment) {
                    $lines[] = '# '.$comment;
                }
            }
 
            if ($translation->hasExtractedComments()) {
                foreach ($translation->getExtractedComments() as $comment) {
                    $lines[] = '#. '.$comment;
                }
            }
 
            if ($translation->hasReferences()) {
                foreach ($translation->getReferences() as $reference) {
                    $lines[] = '#: '.$reference[0].(!is_null($reference[1]) ? ':'.$reference[1] : null);
                }
            }
 
            if ($translation->hasFlags()) {
                $lines[] = '#, '.implode(',', $translation->getFlags());
            }
 
            if ($translation->hasContext()) {
                $lines[] = 'msgctxt '.self::convertString($translation->getContext());
            }
 
            self::addLines($lines, 'msgid', $translation->getOriginal());
            if ($translation->hasPlural()) {
                self::addLines($lines, 'msgid_plural', $translation->getPlural());
                self::addLines($lines, 'msgstr[0]', $translation->getTranslation());
 
                foreach ($translation->getPluralTranslation() as $k => $v) {
                    self::addLines($lines, 'msgstr['.($k + 1).']', $v);
                }
            } else {
                self::addLines($lines, 'msgstr', $translation->getTranslation());
            }
 
            $lines[] = '';
        }
 
        return implode("\n", $lines);
    }

References $comment, $name, Gettext\Generators\Po\addLines(), date, and Gettext\Translations\getHeaders().

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/Generators/Po.php