class ImportDeclaration

A node that represents in import declaration. For example: import a from "mod"

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

Hierarchy

class \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\JSONSerializable
- class \Peast\Syntax\Node\ImportDeclaration extends \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\ModuleDeclaration

Expanded class hierarchy of ImportDeclaration

2 string references to 'ImportDeclaration'

Parser::parseImportDeclaration in vendor/mck89/peast/lib/Peast/Syntax/Parser.php: Parses an import declaration
Renderer::renderNode in vendor/mck89/peast/lib/Peast/Renderer.php: Renders a node

File

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

Namespace

Peast\Syntax\Node

View source

class ImportDeclaration extends Node implements ModuleDeclaration {
    
    /**
     * Map of node properties
     * 
     * @var array 
     */
    protected $propertiesMap = array(
        "specifiers" => true,
        "source" => true,
    );
    
    /**
     * Import specifiers array
     * 
     * @var array
     */
    protected $specifiers = array();
    
    /**
     * Import source
     * 
     * @var Literal 
     */
    protected $source;
    
    /**
     * Returns the import specifiers array
     * 
     * @return array
     */
    public function getSpecifiers() {
        return $this->specifiers;
    }
    
    /**
     * Sets the import specifiers array
     * 
     * @param array $specifiers Import specifiers array
     * 
     * @return $this
     */
    public function setSpecifiers($specifiers) {
        $this->assertArrayOf($specifiers, array(
            "ImportSpecifier",
            "ImportDefaultSpecifier",
            "ImportNamespaceSpecifier",
        ));
        $this->specifiers = $specifiers;
        return $this;
    }
    
    /**
     * Returns the import source
     * 
     * @return Literal
     */
    public function getSource() {
        return $this->source;
    }
    
    /**
     * Sets the import source
     * 
     * @param Literal $source Import source
     * 
     * @return $this
     */
    public function setSource(Literal $source) {
        $this->source = $source;
        return $this;
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
ImportDeclaration::$propertiesMap	protected	property	Map of node properties	Overrides Node::$propertiesMap
ImportDeclaration::$source	protected	property	Import source
ImportDeclaration::$specifiers	protected	property	Import specifiers array
ImportDeclaration::getSource	public	function	Returns the import source
ImportDeclaration::getSpecifiers	public	function	Returns the import specifiers array
ImportDeclaration::setSource	public	function	Sets the import source
ImportDeclaration::setSpecifiers	public	function	Sets the import specifiers array
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