class WhileStatement

A node that represents a while loop. For example: while (test) {}

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

Hierarchy

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

Expanded class hierarchy of WhileStatement

3 string references to 'WhileStatement'

Parser::parseWhileStatement in vendor/mck89/peast/lib/Peast/Syntax/Parser.php: Parses a while 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

File

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

Namespace

Peast\Syntax\Node

View source

class WhileStatement extends Node implements Statement {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "test" => true,
        "body" => true,
    );
    
    /**
     * The loop condition
     * 
     * @var Expression 
     */
    protected $test;
    
    /**
     * The loop body
     * 
     * @var Statement 
     */
    protected $body;
    
    /**
     * Returns the loop condition
     * 
     * @return Expression
     */
    public function getTest() {
        return $this->test;
    }
    
    /**
     * Sets the loop condition
     * 
     * @param Expression $test Loop
     * 
     * @return $this
     */
    public function setTest(Expression $test) {
        $this->test = $test;
        return $this;
    }
    
    /**
     * Returns the loop body
     * 
     * @return Statement
     */
    public function getBody() {
        return $this->body;
    }
    
    /**
     * Sets the loop body
     * 
     * @param Statement $body Loop body
     * 
     * @return $this
     */
    public function setBody(Statement $body) {
        $this->body = $body;
        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
WhileStatement::$body	protected	property	The loop body
WhileStatement::$propertiesMap	protected	property	Map of node properties	Overrides Node::$propertiesMap
WhileStatement::$test	protected	property	The loop condition
WhileStatement::getBody	public	function	Returns the loop body
WhileStatement::getTest	public	function	Returns the loop condition
WhileStatement::setBody	public	function	Sets the loop body
WhileStatement::setTest	public	function	Sets the loop condition