Gettext\Utils\ParsedFunction Class Reference

Function parsed by PhpFunctionsScanner. More...

Collaboration diagram for Gettext\Utils\ParsedFunction:

Public Member Functions
	__construct ($name, $line)
	Initializes the instance. More...
	stopArgument ()
	Stop extracting strings from the current argument (because we found something that's not a string). More...
	nextArgument ()
	Go to the next argument because we a comma was found. More...
	addArgumentChunk ($chunk)
	Add a string to the current argument. More...
	addComment ($comment)
	Add a comment associated to this function. More...
	close ()

Protected Attributes
	$name
	$line
	$arguments
	$argumentIndex
	$argumentStopped
	$comments

Detailed Description

Function parsed by PhpFunctionsScanner.

Definition at line 8 of file ParsedFunction.php.

Constructor & Destructor Documentation

__construct()

Gettext\Utils\ParsedFunction::__construct	(		$name,
			$line
	)

Initializes the instance.

Parameters

string	$name	The function name.
int	$line	The line where the function starts.

Definition at line 58 of file ParsedFunction.php.

    {
        $this->name = $name;
        $this->line = $line;
        $this->arguments = array();
        $this->argumentIndex = -1;
        $this->argumentStopped = false;
        $this->comments = null;
    }

References Gettext\Utils\ParsedFunction\$line, and Gettext\Utils\ParsedFunction\$name.

Member Function Documentation

addArgumentChunk()

Gettext\Utils\ParsedFunction::addArgumentChunk

(

$chunk

)

Add a string to the current argument.

Parameters

string

$chunk

Definition at line 98 of file ParsedFunction.php.

    {
        if ($this->argumentStopped === false) {
            if ($this->argumentIndex === -1) {
                $this->argumentIndex = 0;
            }
            if (isset($this->arguments[$this->argumentIndex])) {
                $this->arguments[$this->argumentIndex] .= $chunk;
            } else {
                $this->arguments[$this->argumentIndex] = $chunk;
            }
        }
    }

References Gettext\Utils\ParsedFunction\$argumentIndex.

addComment()

Gettext\Utils\ParsedFunction::addComment

(

$comment

)

Add a comment associated to this function.

Parameters

string

$comment

Definition at line 117 of file ParsedFunction.php.

    {
        if ($this->comments === null) {
            $this->comments = array();
        }
        $this->comments[] = $comment;
    }

References $comment.

close()

Gettext\Utils\ParsedFunction::close

(

)

Definition at line 135 of file ParsedFunction.php.

    {
        $arguments = array();
        for ($i = 0; $i <= $this->argumentIndex; ++$i) {
            $arguments[$i] = isset($this->arguments[$i]) ? $this->arguments[$i] : '';
        }
 
        return array(
            $this->name,
            $this->line,
            $arguments,
            $this->comments,
        );
    }

References Gettext\Utils\ParsedFunction\$argumentIndex, Gettext\Utils\ParsedFunction\$arguments, and $i.

nextArgument()

Gettext\Utils\ParsedFunction::nextArgument

(

)

Go to the next argument because we a comma was found.

Definition at line 82 of file ParsedFunction.php.

    {
        if ($this->argumentIndex === -1) {
            // This should neve occur, but let's stay safe - During test/development an Exception should be thrown.
            $this->argumentIndex = 1;
        } else {
            ++$this->argumentIndex;
        }
        $this->argumentStopped = false;
    }

References Gettext\Utils\ParsedFunction\$argumentIndex.

stopArgument()

Gettext\Utils\ParsedFunction::stopArgument

(

)

Stop extracting strings from the current argument (because we found something that's not a string).

Definition at line 71 of file ParsedFunction.php.

    {
        if ($this->argumentIndex === -1) {
            $this->argumentIndex = 0;
        }
        $this->argumentStopped = true;
    }

Field Documentation

$argumentIndex

Gettext\Utils\ParsedFunction::$argumentIndex

protected

Definition at line 36 of file ParsedFunction.php.

Referenced by Gettext\Utils\ParsedFunction\addArgumentChunk(), Gettext\Utils\ParsedFunction\close(), and Gettext\Utils\ParsedFunction\nextArgument().

$arguments

Gettext\Utils\ParsedFunction::$arguments

protected

Definition at line 29 of file ParsedFunction.php.

Referenced by Gettext\Utils\ParsedFunction\close().

$argumentStopped

Gettext\Utils\ParsedFunction::$argumentStopped

protected

Definition at line 43 of file ParsedFunction.php.

$comments

Gettext\Utils\ParsedFunction::$comments

protected

Definition at line 50 of file ParsedFunction.php.

$line

Gettext\Utils\ParsedFunction::$line

protected

Definition at line 22 of file ParsedFunction.php.

Referenced by Gettext\Utils\ParsedFunction\__construct().

$name

Gettext\Utils\ParsedFunction::$name

protected

Definition at line 15 of file ParsedFunction.php.

Referenced by Gettext\Utils\ParsedFunction\__construct().

---

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

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