\Gettext\UtilsPhpFunctionsScanner

Summary

Methods

Properties

Constants

getFunctions()
saveGettextFunctions()
enableCommentsExtraction()
disableCommentsExtraction()
__construct()

No public properties found

No constants found

parsePhpComment()

$tokens
$extractComments

N/A

No private methods found

No private properties found

N/A

File: Gettext/Utils/PhpFunctionsScanner.php
Package: Default
Class hierarchy: \Gettext\Utils\FunctionsScanner

\Gettext\Utils\PhpFunctionsScanner

Properties

$tokens

$tokens : array

PHP tokens of the code to be parsed.

Type

array

$extractComments

$extractComments : string|false|array

If not false, comments will be extracted.

Type

string|false|array

Methods

getFunctions()

getFunctions(array  $constants = array()) : array

Scan and returns the functions and the arguments.

Parameters

array

$constants

Constants used in the code to replace

Returns

array

saveGettextFunctions()

saveGettextFunctions(\Gettext\Translations  $translations, array  $options)

Search for specific functions and create translations.

Parameters

\Gettext\Translations	$translations	The translations instance where save the values
array	$options	The extractor options

Throws

\Exception

enableCommentsExtraction()

enableCommentsExtraction(mixed  $tag = '')

Enable extracting comments that start with a tag (if $tag is empty all the comments will be extracted).

Parameters

mixed

$tag

disableCommentsExtraction()

disableCommentsExtraction()

Disable comments extraction.

__construct()

__construct(string  $code)

Constructor.

Parameters

string

$code

The php code to scan

parsePhpComment()

parsePhpComment(string  $value, integer  $line) : null|\Gettext\Utils\ParsedComment

Extract the actual text from a PHP comment.

If set, only returns comments that match the prefix(es).

Parameters

string	$value	The PHP comment.
integer	$line	Line number.

Returns

null|\Gettext\Utils\ParsedComment —

Comment or null if comment extraction is disabled or if there is a prefix mismatch.