class ImportSpecifier

A node that represents a specifier in an import declaration. For example "{a}" in: import {a} from "test"

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

Hierarchy

  • class \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\JSONSerializable
    • class \Peast\Syntax\Node\ModuleSpecifier extends \Peast\Syntax\Node\Node
      • class \Peast\Syntax\Node\ImportSpecifier extends \Peast\Syntax\Node\ModuleSpecifier

Expanded class hierarchy of ImportSpecifier

3 string references to 'ImportSpecifier'
ImportDeclaration::setSpecifiers in vendor/mck89/peast/lib/Peast/Syntax/Node/ImportDeclaration.php
Sets the import specifiers array
Parser::parseImportSpecifier in vendor/mck89/peast/lib/Peast/Syntax/Parser.php
Parses an import specifier
Renderer::renderNode in vendor/mck89/peast/lib/Peast/Renderer.php
Renders a node

File

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

Namespace

Peast\Syntax\Node
View source 
class ImportSpecifier extends ModuleSpecifier {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "imported" => true,
    );
    
    /**
     * Imported identifier
     * 
     * @var Identifier|StringLiteral
     */
    protected $imported;
    
    /**
     * Returns the imported identifier
     * 
     * @return Identifier|StringLiteral
     */
    public function getImported() {
        return $this->imported;
    }
    
    /**
     * Sets the imported identifier
     * 
     * @param Identifier|StringLiteral $imported Imported identifier
     * 
     * @return $this
     */
    public function setImported($imported) {
        $this->assertType($imported, array(
            "Identifier",
            "StringLiteral",
        ));
        $this->imported = $imported;
        return $this;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ImportSpecifier::$imported protected property Imported identifier
ImportSpecifier::$propertiesMap protected property Map of node properties Overrides ModuleSpecifier::$propertiesMap
ImportSpecifier::getImported public function Returns the imported identifier
ImportSpecifier::setImported public function Sets the imported identifier
ModuleSpecifier::$local protected property Local identifier
ModuleSpecifier::getLocal public function Returns the local identifier
ModuleSpecifier::setLocal public function Sets the local identifier
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