Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ChainElement.php

class ChainElement

A node that represents a chain element.

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

Hierarchy

  • class \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\JSONSerializable
    • class \Peast\Syntax\Node\ChainElement extends \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\Expression

Expanded class hierarchy of ChainElement

File

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

Namespace

Peast\Syntax\Node
View source
abstract class ChainElement extends Node implements Expression {
    protected $propertiesMap = array(
        "optional" => false,
    );
    
    /**
     * Optional flag that is true if the node is in the optional
     * part of a chain expression
     *
     * @var bool
     */
    protected $optional = false;
    
    /**
     * Returns the optional flag that is true if the node is in
     * the optional part of a chain expression
     *
     * @return bool
     */
    public function getOptional() {
        return $this->optional;
    }
    
    /**
     * Sets the optional flag that is true if the node is in
     * the optional part of a chain expression
     *
     * @param bool $optional Optional flag
     *
     * @return $this
     */
    public function setOptional($optional) {
        $this->optional = (bool) $optional;
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ChainElement::$optional protected property Optional flag that is true if the node is in the optional
part of a chain expression
ChainElement::$propertiesMap protected property Map of node properties Overrides Node::$propertiesMap 2
ChainElement::getOptional public function Returns the optional flag that is true if the node is in
the optional part of a chain expression
ChainElement::setOptional public function Sets the optional flag that is true if the node is in
the optional part of a chain expression
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

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal