class ForOfStatement

A node that represents the "for...of" statement. For example: for (var a of b) {}

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

Hierarchy

Expanded class hierarchy of ForOfStatement

5 string references to 'ForOfStatement'
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/ForOfStatement.php, line 18

Namespace

Peast\Syntax\Node
View source 
class ForOfStatement extends ForInStatement {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "left" => true,
        "right" => true,
        "body" => true,
        "await" => false,
    );
    
    /**
     * Async iteration flag
     * 
     * @var bool
     */
    protected $await = false;
    
    /**
     * Returns the async iteration flag
     * 
     * @return bool
     */
    public function getAwait() {
        return $this->await;
    }
    
    /**
     * Sets the async iteration flag
     * 
     * @param bool $await Async iteration flag
     * 
     * @return $this
     */
    public function setAwait($await) {
        $this->await = (bool) $await;
        return $this;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ForInStatement::$body protected property Loop body
ForInStatement::$left protected property Iteration variable
ForInStatement::$right protected property Iterated object
ForInStatement::getBody public function Returns the loop body
ForInStatement::getLeft public function Returns the iteration variable
ForInStatement::getRight public function Returns the iterated object
ForInStatement::setBody public function Sets the loop body
ForInStatement::setLeft public function Sets the iteration variable
ForInStatement::setRight public function Sets the iterated object
ForOfStatement::$await protected property Async iteration flag
ForOfStatement::$propertiesMap protected property Map of node properties Overrides ForInStatement::$propertiesMap
ForOfStatement::getAwait public function Returns the async iteration flag
ForOfStatement::setAwait public function Sets the async iteration flag
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