class ForStatement

A node that represents a for statement.

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

Hierarchy

Expanded class hierarchy of ForStatement

5 string references to 'ForStatement'
Parser::parseForLetConstStatement in vendor/mck89/peast/lib/Peast/Syntax/Parser.php
Parses a for(let ...) or for(const ...) statement
Parser::parseForNotVarLetConstStatement in vendor/mck89/peast/lib/Peast/Syntax/Parser.php
Parses a for statement that does not start with var, let or const
Parser::parseForVarStatement in vendor/mck89/peast/lib/Peast/Syntax/Parser.php
Parses a for(var ...) statement
Renderer::needsBrackets in vendor/mck89/peast/lib/Peast/Renderer.php
Check if the node or the array of nodes need brackets to be rendered
Renderer::renderNode in vendor/mck89/peast/lib/Peast/Renderer.php
Renders a node

File

vendor/mck89/peast/lib/Peast/Syntax/Node/ForStatement.php, line 17

Namespace

Peast\Syntax\Node
View source 
class ForStatement extends Node implements Statement {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "init" => true,
        "test" => true,
        "update" => true,
        "body" => true,
    );
    
    /**
     * Initializer
     * 
     * @var VariableDeclaration|Expression
     */
    protected $init;
    
    /**
     * Test expression
     * 
     * @var Expression 
     */
    protected $test;
    
    /**
     * Update expression
     * 
     * @var Expression 
     */
    protected $update;
    
    /**
     * Loop body
     * 
     * @var Statement 
     */
    protected $body;
    
    /**
     * Returns the initializer
     * 
     * @return VariableDeclaration|Expression
     */
    public function getInit() {
        return $this->init;
    }
    
    /**
     * Sets the initializer
     * 
     * @param VariableDeclaration|Expression $init Initializer
     * 
     * @return $this
     */
    public function setInit($init) {
        $this->assertType($init, array(
            "VariableDeclaration",
            "Expression",
        ), true);
        $this->init = $init;
        return $this;
    }
    
    /**
     * Returns the test expression
     * 
     * @return Expression
     */
    public function getTest() {
        return $this->test;
    }
    
    /**
     * Sets the test expression
     * 
     * @param Expression $test Test expression
     * 
     * @return $this
     */
    public function setTest($test) {
        $this->assertType($test, "Expression", true);
        $this->test = $test;
        return $this;
    }
    
    /**
     * Returns the update expression
     * 
     * @return Expression
     */
    public function getUpdate() {
        return $this->update;
    }
    
    /**
     * Sets the update expression
     * 
     * @param Expression $update Update expression
     * 
     * @return $this
     */
    public function setUpdate($update) {
        $this->assertType($update, "Expression", true);
        $this->update = $update;
        return $this;
    }
    
    /**
     * Returns the loop body
     * 
     * @return Statement
     */
    public function getBody() {
        return $this->body;
    }
    
    /**
     * Sets the loop body
     * 
     * @param Statement $body Loop body
     * 
     * @return $this
     */
    public function setBody(Statement $body) {
        $this->body = $body;
        return $this;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ForStatement::$body protected property Loop body
ForStatement::$init protected property Initializer
ForStatement::$propertiesMap protected property Map of node properties Overrides Node::$propertiesMap
ForStatement::$test protected property Test expression
ForStatement::$update protected property Update expression
ForStatement::getBody public function Returns the loop body
ForStatement::getInit public function Returns the initializer
ForStatement::getTest public function Returns the test expression
ForStatement::getUpdate public function Returns the update expression
ForStatement::setBody public function Sets the loop body
ForStatement::setInit public function Sets the initializer
ForStatement::setTest public function Sets the test expression
ForStatement::setUpdate public function Sets the update expression
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