class YieldExpression

A node that represents a yield statement.

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

Hierarchy

Expanded class hierarchy of YieldExpression

2 string references to 'YieldExpression'
Parser::parseYieldExpression in vendor/mck89/peast/lib/Peast/Syntax/Parser.php
Parses yield statement
Renderer::renderNode in vendor/mck89/peast/lib/Peast/Renderer.php
Renders a node

File

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

Namespace

Peast\Syntax\Node
View source 
class YieldExpression extends Node implements Expression {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "argument" => true,
        "delegate" => false,
    );
    
    /**
     * Yield argument
     * 
     * @var Expression 
     */
    protected $argument;
    
    /**
     * Delegate flag that is true when the yield keyword is preceded by *
     * 
     * @var bool 
     */
    protected $delegate = false;
    
    /**
     * Returns yield argument
     * 
     * @return Expression
     */
    public function getArgument() {
        return $this->argument;
    }
    
    /**
     * Sets yield argument
     * 
     * @param Expression $argument Argument
     * 
     * @return $this
     */
    public function setArgument($argument) {
        $this->assertType($argument, "Expression", true);
        $this->argument = $argument;
        return $this;
    }
    
    /**
     * Returns the delegate flag that is true when the yield keyword is
     * preceded by *
     * 
     * @return bool
     */
    public function getDelegate() {
        return $this->delegate;
    }
    
    /**
     * Sets the delegate flag that is true when the yield keyword is
     * preceded by *
     * 
     * @param bool $delegate Delegate flag
     * 
     * @return $this
     */
    public function setDelegate($delegate) {
        $this->delegate = (bool) $delegate;
        return $this;
    }

}

Members

Title 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
YieldExpression::$argument protected property Yield argument
YieldExpression::$delegate protected property Delegate flag that is true when the yield keyword is preceded by *
YieldExpression::$propertiesMap protected property Map of node properties Overrides Node::$propertiesMap
YieldExpression::getArgument public function Returns yield argument
YieldExpression::getDelegate public function Returns the delegate flag that is true when the yield keyword is
preceded by *
YieldExpression::setArgument public function Sets yield argument
YieldExpression::setDelegate public function Sets the delegate flag that is true when the yield keyword is
preceded by *