Gettext\Extractors\Twig Class Reference

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

Inheritance diagram for Gettext\Extractors\Twig:

Collaboration diagram for Gettext\Extractors\Twig:

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	addExtension ($extension)
	Initialise Twig if it isn't already, and add a given Twig extension. 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...

Static Protected Member Functions
static	checkHasExtensionByClassName ($className)
	Checks if a given Twig extension is already registered or not. 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...

Static Protected Attributes
static	$twig

Detailed Description

Class to get gettext strings from twig files returning arrays.

Definition at line 12 of file Twig.php.

Member Function Documentation

addExtension()

static Gettext\Extractors\Twig::addExtension (   $extension )

static

Initialise Twig if it isn't already, and add a given Twig extension.

This must be called before calling fromString().

Parameters

mixed

$extension

Already initialised extension to add

Definition at line 44 of file Twig.php.

    {
        // initialise twig
        if (!isset(self::$twig)) {
            $twigCompiler = new Twig_Loader_String();
 
            self::$twig = new Twig_Environment($twigCompiler);
        }
 
        if (!self::checkHasExtensionByClassName($extension)) {
            self::$twig->addExtension(new $extension());
        }
    }

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

Here is the caller graph for this function:

checkHasExtensionByClassName()

static Gettext\Extractors\Twig::checkHasExtensionByClassName (   $className )

staticprotected

Checks if a given Twig extension is already registered or not.

Parameters

string

Name of Twig extension to check

Returns

bool Whether it has been registered already or not

Definition at line 65 of file Twig.php.

    {
        foreach (self::$twig->getExtensions() as $extension) {
            if ($className == get_class($extension)) {
                return true;
            }
        }
 
        return false;
    }

fromString()

static Gettext\Extractors\Twig::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 24 of file Twig.php.

    {
        self::addExtension('Twig_Extensions_Extension_I18n');
 
        $string = self::$twig->compileSource($string);
 
        // add default global php gettext functions
        PhpCode::$functions['gettext'] = '__';
        PhpCode::$functions['ngettext'] = '__';
        PhpCode::$functions['_'] = '__';
 
        return PhpCode::fromString($string, $translations, $file);
    }

References Gettext\Extractors\PhpCode\$functions, Gettext\Extractors\Twig\addExtension(), and Gettext\Extractors\PhpCode\fromString().

Here is the call graph for this function:

Field Documentation

$twig

Gettext\Extractors\Twig::$twig

staticprotected

Definition at line 19 of file Twig.php.

---

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

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