Gettext\Utils\PhpFunctionsScanner Class Reference

Inheritance diagram for Gettext\Utils\PhpFunctionsScanner:

Collaboration diagram for Gettext\Utils\PhpFunctionsScanner:

Public Member Functions
	enableCommentsExtraction ($tag='')
	Enable extracting comments that start with a tag (if $tag is empty all the comments will be extracted). More...
	disableCommentsExtraction ()
	Disable comments extraction. More...
	__construct ($code)
	Constructor. More...
	getFunctions ()
	{Scan and returns the functions and the arguments. Returns array } More...
Public Member Functions inherited from Gettext\Utils\FunctionsScanner
	getFunctions ()
	Scan and returns the functions and the arguments. More...
	saveGettextFunctions (array $functions, Translations $translations, $file='')
	Search for specific functions and create translations. More...

Protected Member Functions
	parsePhpComment ($value)

Protected Attributes
	$tokens
	$extractComments = false

Detailed Description

Definition at line 7 of file PhpFunctionsScanner.php.

Constructor & Destructor Documentation

__construct()

Gettext\Utils\PhpFunctionsScanner::__construct

(

$code

)

Constructor.

Parameters

string

$code

The php code to scan

Definition at line 46 of file PhpFunctionsScanner.php.

    {
        $this->tokens = array_values(
            array_filter(
                token_get_all($code),
                function ($token) {
                    return !is_array($token) || $token[0] !== T_WHITESPACE;
                }
            )
        );
    }

References $code, and PHPMailer\PHPMailer\$token.

Member Function Documentation

disableCommentsExtraction()

Gettext\Utils\PhpFunctionsScanner::disableCommentsExtraction

(

)

Disable comments extraction.

Definition at line 36 of file PhpFunctionsScanner.php.

    {
        $this->extractComments = false;
    }

enableCommentsExtraction()

Gettext\Utils\PhpFunctionsScanner::enableCommentsExtraction

(

$tag = ''

)

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

Parameters

string

$tag

Definition at line 28 of file PhpFunctionsScanner.php.

    {
        $this->extractComments = (string) $tag;
    }

References $tag.

getFunctions()

Gettext\Utils\PhpFunctionsScanner::getFunctions

(

)

{Scan and returns the functions and the arguments.

Returns

array

}

Reimplemented from Gettext\Utils\FunctionsScanner.

Definition at line 61 of file PhpFunctionsScanner.php.

    {
        $count = count($this->tokens);
        $bufferFunctions = array();
        /* @var ParsedFunction[] $bufferFunctions */
        $functions = array();
        /* @var ParsedFunction[] $functions */
 
        for ($k = 0; $k < $count; ++$k) {
            $value = $this->tokens[$k];
 
            if (is_string($value)) {
                if (isset($bufferFunctions[0])) {
                    switch ($value) {
                        case ',':
                            $bufferFunctions[0]->nextArgument();
                            break;
                        case ')':
                            $functions[] = array_shift($bufferFunctions)->close();
                            break;
                        case '.':
                            break;
                        default:
                            $bufferFunctions[0]->stopArgument();
                            break;
                    }
                }
                continue;
            }
 
            switch ($value[0]) {
                case T_CONSTANT_ENCAPSED_STRING:
                    //add an argument to the current function
                    if (isset($bufferFunctions[0])) {
                        $bufferFunctions[0]->addArgumentChunk(PhpCode::convertString($value[1]));
                    }
                    break;
                case T_STRING:
                    if (isset($bufferFunctions[0])) {
                        $bufferFunctions[0]->stopArgument();
                    }
                    //new function found
                    for ($j = $k + 1; $j < $count; ++$j) {
                        $nextToken = $this->tokens[$j];
                        if (is_array($nextToken) && $nextToken[0] === T_COMMENT) {
                            continue;
                        }
                        if ($nextToken === '(') {
                            $newFunction = new ParsedFunction($value[1], $value[2]);
                            if ($k > 0 && is_array($this->tokens[$k - 1]) && $this->tokens[$k - 1][0] === T_COMMENT) {
                                $comment = $this->parsePhpComment($this->tokens[$k - 1][1]);
                                if ($comment !== null) {
                                    $newFunction->addComment($comment);
                                }
                            }
                            array_unshift($bufferFunctions, $newFunction);
                            $k = $j;
                        }
                        break;
                    }
                    break;
                case T_COMMENT:
                    if (isset($bufferFunctions[0])) {
                        $comment = $this->parsePhpComment($value[1]);
                        if ($comment !== null) {
                            $bufferFunctions[0]->addComment($comment);
                        }
                    }
                    break;
                default:
                    if (isset($bufferFunctions[0])) {
                        $bufferFunctions[0]->stopArgument();
                    }
                    break;
            }
        }
 
        return $functions;
    }

References $comment, Gettext\Extractors\PhpCode\convertString(), and Gettext\Utils\PhpFunctionsScanner\parsePhpComment().

Here is the call graph for this function:

parsePhpComment()

Gettext\Utils\PhpFunctionsScanner::parsePhpComment (   $value )

protected

Definition at line 141 of file PhpFunctionsScanner.php.

    {
        $result = null;
        if ($this->extractComments !== false) {
            if ($value[0] === '#') {
                $value = substr($value, 1);
            } elseif ($value[1] === '/') {
                $value = substr($value, 2);
            } else {
                $value = substr($value, 2, -2);
            }
            $value = trim($value);
            if ($value !== '' && ($this->extractComments === '' || strpos($value, $this->extractComments) === 0)) {
                $result = $value;
            }
        }
 
        return $result;
    }

References $result.

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

Here is the caller graph for this function:

Field Documentation

$extractComments

Gettext\Utils\PhpFunctionsScanner::$extractComments = false

protected

Definition at line 21 of file PhpFunctionsScanner.php.

$tokens

Gettext\Utils\PhpFunctionsScanner::$tokens

protected

Definition at line 14 of file PhpFunctionsScanner.php.

---

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

• libs/composer/vendor/gettext/gettext/src/Utils/PhpFunctionsScanner.php