\Gettext\ExtractorsVueJs

Class to get gettext strings from VueJS template files.

Summary

Methods

Properties

Constants

fromString()
fromFile()

$options

No constants found

getFiles()
readFile()

No protected properties found

N/A

extractScriptTag()
convertHtmlToDom()
getScriptTranslationsFromString()
getTemplateTranslations()
getTemplateAttributeFakeJs()
getVueAttributeExpressions()
isAttributeMatching()
getTemplateFakeJs()
parseOneTemplateLine()

No private properties found

N/A

Properties

$options

$options :

Type

Methods

fromString()

fromString(string  $string, \Gettext\Translations  $translations, array  $options = array())

Parses a string and append the translations found in the Translations instance.

Parameters

string	$string
\Gettext\Translations	$translations
array	$options

Throws

\Exception

static

Tags

inheritdoc

fromFile()

fromFile(array|string  $file, \Gettext\Translations  $translations, array  $options = array())

Extract the translations from a file.

Parameters

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

getFiles()

getFiles(string|array  $file) : array

Checks and returns all files.

Parameters

string|array

$file

The file/s

Returns

array —

The file paths

readFile()

readFile(string  $file) : string

Reads and returns the content of a file.

Parameters

string

$file

Returns

string

extractScriptTag()

extractScriptTag(  $string) : boolean|string

Extracts script tag contents using regex instead of DOM operations.

If we parse using DOM, some contents may change, for example, tags within strings will be stripped

Parameters

$string

Returns

boolean|string

convertHtmlToDom()

convertHtmlToDom(string  $html) : \DOMDocument

Parameters

string

$html

Returns

\DOMDocument

getScriptTranslationsFromString()

getScriptTranslationsFromString(string  $scriptContents, \Gettext\Translations  $translations, array  $options = array(), integer  $lineOffset)

Extract translations from script part

Parameters

string	$scriptContents	Only script tag contents, not the whole template
\Gettext\Translations	$translations
array	$options
integer	$lineOffset	Number of lines the script is offset in the vue template file

Throws

\Exception

getTemplateTranslations()

getTemplateTranslations(\DOMElement  $dom, \Gettext\Translations  $translations, array  $options, integer  $lineOffset)

Parse template to extract all translations (element content and dynamic element attributes)

Parameters

\DOMElement	$dom
\Gettext\Translations	$translations
array	$options
integer	$lineOffset	Line number where the template part starts in the vue file

Throws

\Exception

getTemplateAttributeFakeJs()

getTemplateAttributeFakeJs(array  $options, \DOMElement  $dom) : string

Extract JS expressions from element attribute bindings (excluding text within elements) For example: <span :title="__('extract this')"> skip element content </span>

Parameters

array	$options
\DOMElement	$dom

Returns

string —

JS code

getVueAttributeExpressions()

getVueAttributeExpressions(array  $attributePrefixes, \DOMElement  $dom, array  $expressionByLine = array()) : array

Loop DOM element recursively and parse out all dynamic vue attributes which are basically JS expressions

Parameters

array	$attributePrefixes	List of attribute prefixes we parse as JS (may contain translations)
\DOMElement	$dom
array	$expressionByLine	[lineNumber => [jsExpression, ..], ..]

Returns

array —

[lineNumber => [jsExpression, ..], ..]

isAttributeMatching()

isAttributeMatching(string  $attributeName, array<mixed,string>  $attributePrefixes) : boolean

Check if this attribute name should be parsed for translations

Parameters

string	$attributeName
array<mixed,string>	$attributePrefixes

Returns

boolean

getTemplateFakeJs()

getTemplateFakeJs(\DOMElement  $dom) : string

Extract JS expressions from within template elements (excluding attributes) For example: <span :title="skip attributes"> {{__("extract element content")}} </span>

Parameters

\DOMElement

$dom

Returns

string —

JS code

parseOneTemplateLine()

parseOneTemplateLine(string  $line) : array<mixed,string>

Match JS expressions in a template line

Parameters

string

$line

Returns

array<mixed,string>