class BreakStatement

A node that represents the "break" statement inside loops.

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

Hierarchy

class \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\JSONSerializable
- class \Peast\Syntax\Node\BreakStatement extends \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\Statement

Expanded class hierarchy of BreakStatement

2 string references to 'BreakStatement'

Parser::parseBreakStatement in vendor/mck89/peast/lib/Peast/Syntax/Parser.php: Parses a break statement
Renderer::renderNode in vendor/mck89/peast/lib/Peast/Renderer.php: Renders a node

File

vendor/mck89/peast/lib/Peast/Syntax/Node/BreakStatement.php, line 17

Namespace

Peast\Syntax\Node

View source

class BreakStatement extends Node implements Statement {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "label" => true,
    );
    
    /**
     * The optional label of the break statement
     * 
     * @var Identifier 
     */
    protected $label;
    
    /**
     * Returns the node's label
     * 
     * @return Identifier
     */
    public function getLabel() {
        return $this->label;
    }
    
    /**
     * Sets the node's label
     * 
     * @param Identifier $label Node's label
     * 
     * @return $this
     */
    public function setLabel($label) {
        $this->assertType($label, "Identifier", true);
        $this->label = $label;
        return $this;
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
BreakStatement::$label	protected	property	The optional label of the break statement
BreakStatement::$propertiesMap	protected	property	Map of node properties	Overrides Node::$propertiesMap
BreakStatement::getLabel	public	function	Returns the node's label
BreakStatement::setLabel	public	function	Sets the node's label
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