class VariableDeclarator

A node that represents a declaration in a VariableDeclaration node. For example "a=1" in: var a = 1

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

Hierarchy

  • class \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\JSONSerializable

Expanded class hierarchy of VariableDeclarator

4 string references to 'VariableDeclarator'
Parser::parseForBinding in vendor/mck89/peast/lib/Peast/Syntax/Parser.php
Parses a binding pattern or an identifier that come after a const or let declaration in a for statement definition
Parser::parseVariableDeclaration in vendor/mck89/peast/lib/Peast/Syntax/Parser.php
Parses a variable declarations
Renderer::renderNode in vendor/mck89/peast/lib/Peast/Renderer.php
Renders a node
VariableDeclaration::setDeclarations in vendor/mck89/peast/lib/Peast/Syntax/Node/VariableDeclaration.php
Sets the declarations array

File

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

Namespace

Peast\Syntax\Node
View source 
class VariableDeclarator extends Node {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "id" => true,
        "init" => true,
    );
    
    /**
     * Declaration identifier or pattern
     * 
     * @var Pattern 
     */
    protected $id;
    
    /**
     * Optional initializer
     * 
     * @var Expression 
     */
    protected $init;
    
    /**
     * Returns the declaration identifier or pattern
     * 
     * @return Pattern
     */
    public function getId() {
        return $this->id;
    }
    
    /**
     * Sets the declaration identifier or pattern
     * 
     * @param Pattern $id Declaration identifier or pattern
     * 
     * @return $this
     */
    public function setId(Pattern $id) {
        $this->id = $id;
        return $this;
    }
    
    /**
     * Returns the initializer
     * 
     * @return Expression
     */
    public function getInit() {
        return $this->init;
    }
    
    /**
     * Sets the initializer
     * 
     * @param Expression $init Initializer
     * 
     * @return $this
     */
    public function setInit($init) {
        $this->assertType($init, "Expression", true);
        $this->init = $init;
        return $this;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
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
VariableDeclarator::$id protected property Declaration identifier or pattern
VariableDeclarator::$init protected property Optional initializer
VariableDeclarator::$propertiesMap protected property Map of node properties Overrides Node::$propertiesMap
VariableDeclarator::getId public function Returns the declaration identifier or pattern
VariableDeclarator::getInit public function Returns the initializer
VariableDeclarator::setId public function Sets the declaration identifier or pattern
VariableDeclarator::setInit public function Sets the initializer