class FunctionDeclaration

A node that represents a function declaration For example: function test () {}

@author Marco Marchiò <marco.mm89@gmail.com>

Hierarchy

Expanded class hierarchy of FunctionDeclaration

4 string references to 'FunctionDeclaration'
IfStatement::setAlternate in vendor/mck89/peast/lib/Peast/Syntax/Node/IfStatement.php
Sets the "else" statement
IfStatement::setConsequent in vendor/mck89/peast/lib/Peast/Syntax/Node/IfStatement.php
Sets the statement that is activated if the test expression is true
Parser::parseFunctionOrGeneratorDeclaration in vendor/mck89/peast/lib/Peast/Syntax/Parser.php
Parses function or generator declaration
Renderer::renderNode in vendor/mck89/peast/lib/Peast/Renderer.php
Renders a node

File

vendor/mck89/peast/lib/Peast/Syntax/Node/FunctionDeclaration.php, line 18

Namespace

Peast\Syntax\Node
View source 
class FunctionDeclaration extends Function_ implements Declaration {
    
    /**
     * Sets the function identifier
     * 
     * @param Identifier $id Function identifier
     * 
     * @return $this
     */
    public function setId($id) {
        $this->assertType($id, "Identifier");
        $this->id = $id;
        return $this;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
FunctionDeclaration::setId public function Sets the function identifier Overrides Function_::setId
Function_::$async protected property Async flag that is true when it is an async function
Function_::$body protected property Function body
Function_::$generator protected property Generator flag that is true when the function is a generator
Function_::$id protected property Function name
Function_::$params protected property Function parameters array
Function_::$propertiesMap protected property Map of node properties Overrides Node::$propertiesMap 1
Function_::getAsync public function Returns the async flag that is true when it is an async function
Function_::getBody public function Returns function body
Function_::getGenerator public function Returns the generator flag that is true when the function is a generator
Function_::getId public function Returns function name
Function_::getParams public function Returns function parameters array
Function_::setAsync public function Sets the async flag that is true when it is an async function
Function_::setBody public function Sets function body 1
Function_::setGenerator public function Sets the generator flag that is true when the function is a generator
Function_::setParams public function Sets function parameters array
Node::$leadingComments protected property Leading comments array
Node::$location public property Node location in the source code
Node::$trailingComments protected property Trailing comments array
Node::assertArrayOf protected function Asserts that the given value is an array of defined type
Node::assertType protected function Asserts that the given value respects the defined type
Node::getLeadingComments public function Returns leading comments array
Node::getLocation public function Returns node location in the source code
Node::getTrailingComments public function Returns trailing comments array
Node::getType public function Returns node type 2
Node::jsonSerialize public function Returns a serializable version of the node 2
Node::render public function Renders the current node
Node::setEndPosition public function Sets the end position of the node in the source code
Node::setLeadingComments public function Sets leading comments array 1
Node::setStartPosition public function Sets the start position of the node in the source code
Node::setTrailingComments public function Sets trailing comments array 1
Node::traverse public function Traverses the current node and all its child nodes using the given
function
Node::typeError protected function Throws an error if the defined type is not supported b
Node::__construct public function Class constructor