Gettext\Extractors\PhpCode Class Reference

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

Inheritance diagram for Gettext\Extractors\PhpCode:

Collaboration diagram for Gettext\Extractors\PhpCode:

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	convertString ($value)
	Decodes a T_CONSTANT_ENCAPSED_STRING string. 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 Public Attributes
static	$functions
static	$extractComments = false

Static Private Member Functions
static	unicodeChar ($dec)

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 PhpCode.php.

Member Function Documentation

convertString()

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

static

Decodes a T_CONSTANT_ENCAPSED_STRING string.

Parameters

string

$value

Returns

string

Definition at line 72 of file PhpCode.php.

    {
        if (strpos($value, '\\') === false) {
            return substr($value, 1, -1);
        }
 
        if ($value[0] === "'") {
            return strtr(substr($value, 1, -1), array('\\\\' => '\\', '\\\'' => '\''));
        }
 
        $value = substr($value, 1, -1);
 
        return preg_replace_callback('/\\\‍(n|r|t|v|e|f|\$|"|\\\|x[0-9A-Fa-f]{1,2}|u{[0-9a-f]{1,6}}|[0-7]{1,3})/', function ($match) {
            switch ($match[1][0]) {
                case 'n':
                    return "\n";
                case 'r':
                    return "\r";
                case 't':
                    return "\t";
                case 'v':
                    return "\v";
                case 'e':
                    return "\e";
                case 'f':
                    return "\f";
                case '$':
                    return '$';
                case '"':
                    return '"';
                case '\\':
                    return '\\';
                case 'x':
                    return chr(hexdec(substr($match[0], 1)));
                case 'u':
                    return self::unicodeChar(hexdec(substr($match[0], 1)));
                default:
                    return chr(octdec($match[0]));
            }
        }, $value);
    }

References Gettext\Extractors\PhpCode\unicodeChar().

Referenced by Gettext\Utils\PhpFunctionsScanner\getFunctions().

Here is the call graph for this function:

Here is the caller graph for this function:

fromString()

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

    {
        if ($translations === null) {
            $translations = new Translations();
        }
 
        $functions = new PhpFunctionsScanner($string);
        if (self::$extractComments !== false) {
            $functions->enableCommentsExtraction(self::$extractComments);
        }
        $functions->saveGettextFunctions(self::$functions, $translations, $file);
 
        return $translations;
    }

References $file, and Gettext\Extractors\PhpCode\$functions.

Referenced by Gettext\Extractors\Blade\fromString(), and Gettext\Extractors\Twig\fromString().

Here is the caller graph for this function:

unicodeChar()

static Gettext\Extractors\PhpCode::unicodeChar (   $dec )

staticprivate

Definition at line 115 of file PhpCode.php.

    {
        if ($dec < 0x80) {
            return chr($dec);
        }
 
        if ($dec < 0x0800) {
            return chr(0xC0 + ($dec >> 6))
                .chr(0x80 + ($dec & 0x3f));
        }
 
        if ($dec < 0x010000) {
            return chr(0xE0 + ($dec >> 12))
                    .chr(0x80 + (($dec >> 6) & 0x3f))
                    .chr(0x80 + ($dec & 0x3f));
        }
 
        if ($dec < 0x200000) {
            return chr(0xF0 + ($dec >> 18))
                    .chr(0x80 + (($dec >> 12) & 0x3f))
                    .chr(0x80 + (($dec >> 6) & 0x3f))
                    .chr(0x80 + ($dec & 0x3f));
        }
    }

Referenced by Gettext\Extractors\PhpCode\convertString().

Here is the caller graph for this function:

Field Documentation

$extractComments

Gettext\Extractors\PhpCode::$extractComments = false

static

Definition at line 45 of file PhpCode.php.

$functions

Gettext\Extractors\PhpCode::$functions

static

Initial value:

= array(
        'gettext' => '__',
        '__' => '__',
        '__e' => '__',
        'ngettext' => 'n__',
        'n__' => 'n__',
        'n__e' => 'n__',
        'pgettext' => 'p__',
        'p__' => 'p__',
        'p__e' => 'p__',
        'dgettext' => 'd__',
        'd__' => 'd__',
        'd__e' => 'd__',
        'dpgettext' => 'dp__',
        'dp__' => 'dp__',
        'dp__e' => 'dp__',
        'npgettext' => 'np__',
        'np__' => 'np__',
        'np__e' => 'np__',
        'dnpgettext' => 'dnp__',
        'dnp__' => 'dnp__',
        'dnp__e' => 'dnp__',
    )

Definition at line 13 of file PhpCode.php.

Referenced by Gettext\Extractors\PhpCode\fromString(), and Gettext\Extractors\Twig\fromString().

---

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

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