Gettext\Extractors\PhpArray Class Reference

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

Inheritance diagram for Gettext\Extractors\PhpArray:

Collaboration diagram for Gettext\Extractors\PhpArray:

Static Public Member Functions
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. Parameters string $string Translations | null $translations string $file The file path to insert the reference Returns Translations } More...
static	handleArray (array $content, Translations $translations)
	Handle an array of translations and append to the Translations instance. More...
static	fromFile ($file, Translations $translations=null)
	Extract the translations from a file. More...
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...

Static Protected Member Functions
static	insertTranslation (Translations $translations, $key, $message)
	Extract and insert a new translation. More...
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 PhpArray.php.

Member Function Documentation

fromFile()

static Gettext\Extractors\PhpArray::fromFile (   $file, Translations  $translations = null  )

static

Extract the translations from a file.

Parameters

array | string	$file	A path of a file or files
null | Translations	$translations	The translations instance to append the new translations.

Returns

Translations

Reimplemented from Gettext\Extractors\Extractor.

Definition at line 21 of file PhpArray.php.

    {
        if ($translations === null) {
            $translations = new Translations();
        }
 
        foreach (self::getFiles($file) as $file) {
            self::handleArray(include($file), $translations);
        }
 
        return $translations;
    }

References Gettext\Extractors\PhpArray\handleArray().

Here is the call graph for this function:

fromString()

static Gettext\Extractors\PhpArray::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.

Reimplemented in Gettext\Extractors\Jed.

Definition at line 37 of file PhpArray.php.

    {
        throw new Exception('PhpArray::fromString() cannot be called. Use PhpArray::fromFile()');
    }

handleArray()

static Gettext\Extractors\PhpArray::handleArray ( array  $content, Translations  $translations  )

static

Handle an array of translations and append to the Translations instance.

Parameters

array	$content
Translations	$translations

Definition at line 48 of file PhpArray.php.

    {
        $content = current($content);
 
        $translations_info = isset($content['']) ? $content[''] : null;
        unset($content['']);
 
        if (isset($translations_info['domain'])) {
            $translations->setDomain($translations_info['domain']);
        }
 
        foreach ($content as $key => $message) {
            static::insertTranslation($translations, $key, $message);
        }
    }

References $key, $message, and Gettext\Translations\setDomain().

Referenced by Gettext\Extractors\PhpArray\fromFile(), and Gettext\Extractors\Jed\fromString().

Here is the call graph for this function:

Here is the caller graph for this function:

insertTranslation()

static Gettext\Extractors\PhpArray::insertTranslation ( Translations  $translations,   $key,   $message  )

staticprotected

Extract and insert a new translation.

Parameters

Translations	$translations
string	$key
string	$message

Reimplemented in Gettext\Extractors\Jed.

Definition at line 71 of file PhpArray.php.

    {
        $context_glue = '\u0004';
        $key = explode($context_glue, $key);
 
        $context = isset($key[1]) ? array_shift($key) : '';
        $original = array_shift($key);
        $plural = array_shift($message);
        $translation = array_shift($message);
        $plural_translation = array_shift($message);
 
        $entry = $translations->insert($context, $original, $plural);
        $entry->setTranslation($translation);
        $entry->setPluralTranslation($plural_translation);
    }

References $context, $key, $message, and Gettext\Translations\insert().

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/PhpArray.php