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

Breadcrumb

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

class VariableDeclaration

A node that represents a "var", "const" or "let" declaration. For example: var a = 1

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

Hierarchy

  • class \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\JSONSerializable
    • class \Peast\Syntax\Node\VariableDeclaration extends \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\Declaration

Expanded class hierarchy of VariableDeclaration

8 string references to 'VariableDeclaration'
ForInStatement::setLeft in vendor/mck89/peast/lib/Peast/Syntax/Node/ForInStatement.php
Sets the iteration variable
ForStatement::setInit in vendor/mck89/peast/lib/Peast/Syntax/Node/ForStatement.php
Sets the initializer
Parser::parseForDeclaration in vendor/mck89/peast/lib/Peast/Syntax/Parser.php
Parses a let or const declaration in a for statement definition
Parser::parseForVarStatement in vendor/mck89/peast/lib/Peast/Syntax/Parser.php
Parses a for(var ...) statement
Parser::parseLexicalDeclaration in vendor/mck89/peast/lib/Peast/Syntax/Parser.php
Parses a let or const declaration

... See full list

File

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

Namespace

Peast\Syntax\Node
View source
class VariableDeclaration extends Node implements Declaration {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "declarations" => true,
        "kind" => false,
    );
    
    //Kind constants
    
    /**
     * "var" kind
     */
    const KIND_VAR = "var";
    
    /**
     * "let" kind
     */
    const KIND_LET = "let";
    
    /**
     * "const" kind
     */
    const KIND_CONST = "const";
    
    /**
     * Declarations array
     * 
     * @var VariableDeclarator[] 
     */
    protected $declarations = array();
    
    /**
     * Declaration kind that is one of the kind constants
     * 
     * @var string 
     */
    protected $kind = self::KIND_VAR;
    
    /**
     * Returns the declarations array
     * 
     * @return VariableDeclarator[]
     */
    public function getDeclarations() {
        return $this->declarations;
    }
    
    /**
     * Sets the declarations array
     * 
     * @param VariableDeclarator[] $declarations Declarations array
     * 
     * @return $this
     */
    public function setDeclarations($declarations) {
        $this->assertArrayOf($declarations, "VariableDeclarator");
        $this->declarations = $declarations;
        return $this;
    }
    
    /**
     * Returns the declaration kind that is one of the kind constants
     * 
     * @return string
     */
    public function getKind() {
        return $this->kind;
    }
    
    /**
     * Sets the declaration kind that is one of the kind constants
     * 
     * @param string $kind Declaration kind
     * 
     * @return $this
     */
    public function setKind($kind) {
        $this->kind = $kind;
        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
VariableDeclaration::$declarations protected property Declarations array
VariableDeclaration::$kind protected property Declaration kind that is one of the kind constants
VariableDeclaration::$propertiesMap protected property Map of node properties Overrides Node::$propertiesMap
VariableDeclaration::getDeclarations public function Returns the declarations array
VariableDeclaration::getKind public function Returns the declaration kind that is one of the kind constants
VariableDeclaration::KIND_CONST constant &quot;const&quot; kind
VariableDeclaration::KIND_LET constant &quot;let&quot; kind
VariableDeclaration::KIND_VAR constant &quot;var&quot; kind
VariableDeclaration::setDeclarations public function Sets the declarations array
VariableDeclaration::setKind public function Sets the declaration kind that is one of the kind constants

API Navigation

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