Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ForInStatement.php

class ForInStatement

A node that represents a for-in statement. For example: for (var a in b) {}

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

Hierarchy

  • class \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\JSONSerializable
    • class \Peast\Syntax\Node\ForInStatement extends \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\Statement

Expanded class hierarchy of ForInStatement

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

Namespace

Peast\Syntax\Node
View source
class ForInStatement extends Node implements Statement {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "left" => true,
        "right" => true,
        "body" => true,
    );
    
    /**
     * Iteration variable
     * 
     * @var VariableDeclaration|Expression|Pattern
     */
    protected $left;
    
    /**
     * Iterated object
     * 
     * @var Expression
     */
    protected $right;
    
    /**
     * Loop body
     * 
     * @var Statement 
     */
    protected $body;
    
    /**
     * Returns the iteration variable
     * 
     * @return VariableDeclaration|Expression|Pattern
     */
    public function getLeft() {
        return $this->left;
    }
    
    /**
     * Sets the iteration variable
     * 
     * @param VariableDeclaration|Expression|Pattern $left Iteration variable
     * 
     * @return $this
     */
    public function setLeft($left) {
        $this->assertType($left, array(
            "VariableDeclaration",
            "Expression",
            "Pattern",
        ));
        $this->left = $left;
        return $this;
    }
    
    /**
     * Returns the iterated object
     * 
     * @return Expression
     */
    public function getRight() {
        return $this->right;
    }
    
    /**
     * Sets the iterated object
     * 
     * @param Expression $right Iterated object
     * 
     * @return $this
     */
    public function setRight(Expression $right) {
        $this->right = $right;
        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 Sort descending Modifiers Object type Summary Overriden Title Overrides
ForInStatement::$body protected property Loop body
ForInStatement::$left protected property Iteration variable
ForInStatement::$propertiesMap protected property Map of node properties Overrides Node::$propertiesMap 1
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
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

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal