class ArrayPattern

A node that represents an array binding pattern. For example: [a, b, c] = d

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

Hierarchy

Expanded class hierarchy of ArrayPattern

3 string references to 'ArrayPattern'
Parser::expressionToPattern in vendor/mck89/peast/lib/Peast/Syntax/Parser.php
Converts an expression node to a pattern node
Parser::parseArrayBindingPattern in vendor/mck89/peast/lib/Peast/Syntax/Parser.php
Parses an array binding pattern
Renderer::renderNode in vendor/mck89/peast/lib/Peast/Renderer.php
Renders a node

File

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

Namespace

Peast\Syntax\Node
View source 
class ArrayPattern extends Node implements Pattern {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "elements" => true,
    );
    
    /**
     * Array elements
     * 
     * @var Pattern[]
     */
    protected $elements = array();
    
    /**
     * Returns array elements
     * 
     * @return Pattern[]
     */
    public function getElements() {
        return $this->elements;
    }
    
    /**
     * Sets array elements
     * 
     * @param Pattern[] $elements Array elements to set
     * 
     * @return $this
     */
    public function setElements($elements) {
        $this->assertArrayOf($elements, "Pattern", true);
        $this->elements = $elements;
        return $this;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ArrayPattern::$elements protected property Array elements
ArrayPattern::$propertiesMap protected property Map of node properties Overrides Node::$propertiesMap
ArrayPattern::getElements public function Returns array elements
ArrayPattern::setElements public function Sets array elements
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