class SwitchCase

A node that represents a case in a switch statement.

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

Hierarchy

class \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\JSONSerializable
- class \Peast\Syntax\Node\SwitchCase extends \Peast\Syntax\Node\Node

Expanded class hierarchy of SwitchCase

6 string references to 'SwitchCase'

Parser::parseCaseClause in vendor/mck89/peast/lib/Peast/Syntax/Parser.php: Parses a case in a switch statement
Parser::parseDefaultClause in vendor/mck89/peast/lib/Peast/Syntax/Parser.php: Parses default case in a switch statement
Renderer::needsBrackets in vendor/mck89/peast/lib/Peast/Renderer.php: Check if the node or the array of nodes need brackets to be rendered
Renderer::renderNode in vendor/mck89/peast/lib/Peast/Renderer.php: Renders a node
Renderer::renderStatementBlock in vendor/mck89/peast/lib/Peast/Renderer.php: Renders a node as a block statement

... See full list

File

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

Namespace

Peast\Syntax\Node

View source

class SwitchCase extends Node {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "test" => true,
        "consequent" => true,
    );
    
    /**
     * Test expression that is null in the "default" case
     * 
     * @var Expression 
     */
    protected $test;
    
    /**
     * Consequent statements array
     * 
     * @var Statement[] 
     */
    protected $consequent = array();
    
    /**
     * Returns the test expression that is null in the "default" case
     * 
     * @return Expression
     */
    public function getTest() {
        return $this->test;
    }
    
    /**
     * Sets the test expression that is null in the "default" case
     * 
     * @param Expression $test Test expression
     * 
     * @return $this
     */
    public function setTest($test) {
        $this->assertType($test, "Expression", true);
        $this->test = $test;
        return $this;
    }
    
    /**
     * Returns the consequent statements array
     * 
     * @return Statement[]
     */
    public function getConsequent() {
        return $this->consequent;
    }
    
    /**
     * Sets the consequent statements array
     * 
     * @param Expression[] $consequent Consequent statements array
     * 
     * @return $this
     */
    public function setConsequent($consequent) {
        $this->assertArrayOf($consequent, "Statement");
        $this->consequent = $consequent;
        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
SwitchCase::$consequent	protected	property	Consequent statements array
SwitchCase::$propertiesMap	protected	property	Map of node properties	Overrides Node::$propertiesMap
SwitchCase::$test	protected	property	Test expression that is null in the "default" case
SwitchCase::getConsequent	public	function	Returns the consequent statements array
SwitchCase::getTest	public	function	Returns the test expression that is null in the "default" case
SwitchCase::setConsequent	public	function	Sets the consequent statements array
SwitchCase::setTest	public	function	Sets the test expression that is null in the "default" case