class ObjectPattern

A node that represents an object binding pattern. For example: var {a, b, c} = d

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

Hierarchy

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

Expanded class hierarchy of ObjectPattern

3 string references to 'ObjectPattern'

Parser::expressionToPattern in vendor/mck89/peast/lib/Peast/Syntax/Parser.php: Converts an expression node to a pattern node
Parser::parseObjectBindingPattern in vendor/mck89/peast/lib/Peast/Syntax/Parser.php: Parses an object binding pattern
Renderer::renderNode in vendor/mck89/peast/lib/Peast/Renderer.php: Renders a node

File

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

Namespace

Peast\Syntax\Node

View source

class ObjectPattern extends Node implements Pattern {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "properties" => true,
    );
    
    /**
     * Object properties
     * 
     * @var Property[] 
     */
    protected $properties = array();
    
    /**
     * Returns object properties
     * 
     * @return Property[] 
     */
    public function getProperties() {
        return $this->properties;
    }
    
    /**
     * Sets object properties
     * 
     * @param Property[] $properties Object properties
     * 
     * @return $this
     */
    public function setProperties($properties) {
        $this->assertArrayOf($properties, array(
            "AssignmentProperty",
            "RestElement",
        ));
        $this->properties = $properties;
        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
ObjectPattern::$properties	protected	property	Object properties
ObjectPattern::$propertiesMap	protected	property	Map of node properties	Overrides Node::$propertiesMap
ObjectPattern::getProperties	public	function	Returns object properties
ObjectPattern::setProperties	public	function	Sets object properties