class RestElement

A node that represents the rest element in array binding patterns or function parameters. For example "...rest" in: [a, ...rest] = b

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

Hierarchy

class \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\JSONSerializable
- class \Peast\Syntax\Node\RestElement extends \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\Pattern

Expanded class hierarchy of RestElement

6 string references to 'RestElement'

ObjectPattern::setProperties in vendor/mck89/peast/lib/Peast/Syntax/Node/ObjectPattern.php: Sets object properties
Parser::expressionToPattern in vendor/mck89/peast/lib/Peast/Syntax/Parser.php: Converts an expression node to a pattern node
Parser::parseBindingRestElement in vendor/mck89/peast/lib/Peast/Syntax/Parser.php: Parses a rest element
Parser::parseFormalParameterList in vendor/mck89/peast/lib/Peast/Syntax/Parser.php: Parses a parameter list
Parser::parseRestProperty in vendor/mck89/peast/lib/Peast/Syntax/Parser.php: Parses a rest property

... See full list

File

vendor/mck89/peast/lib/Peast/Syntax/Node/RestElement.php, line 19

Namespace

Peast\Syntax\Node

View source

class RestElement extends Node implements Pattern {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "argument" => true,
    );
    
    /**
     * The node's argument
     * 
     * @var Pattern
     */
    protected $argument;
    
    /**
     * Returns the node's argument
     * 
     * @return Pattern
     */
    public function getArgument() {
        return $this->argument;
    }
    
    /**
     * Sets the node's argument
     * 
     * @param Pattern $argument Node's argument
     * 
     * @return $this
     */
    public function setArgument(Pattern $argument) {
        $this->argument = $argument;
        return $this;
    }

}

Members

Title Sort descending	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
RestElement::$argument	protected	property	The node's argument
RestElement::$propertiesMap	protected	property	Map of node properties	Overrides Node::$propertiesMap
RestElement::getArgument	public	function	Returns the node's argument
RestElement::setArgument	public	function	Sets the node's argument