@jorgsowa/php-parser 3.2.5-1

package/src/ast/declare.js

@@ -0,0 +1,71 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Block = require("./block");
+const KIND = "declare";
+
+/**
+ * The declare construct is used to set execution directives for a block of code
+ * @constructor Declare
+ * @memberOf module:php-parser
+ * @extends {Block}
+ * @property {DeclareDirective[]} directives
+ * @property {string} mode
+ * @see http://php.net/manual/en/control-structures.declare.php
+ */
+const Declare = Block.extends(
+  KIND,
+  function Declare(directives, body, mode, docs, location) {
+    Block.apply(this, [KIND, body, docs, location]);
+    this.directives = directives;
+    this.mode = mode;
+  },
+);
+
+/**
+ * The node is declared as a short tag syntax :
+ * ```php
+ * <?php
+ * declare(ticks=1):
+ * // some statements
+ * enddeclare;
+ * ```
+ * @constant {String} Declare#MODE_SHORT
+ * @memberOf module:php-parser
+ */
+Declare.MODE_SHORT = "short";
+
+/**
+ * The node is declared bracket enclosed code :
+ * ```php
+ * <?php
+ * declare(ticks=1) {
+ * // some statements
+ * }
+ * ```
+ * @constant {String} Declare#MODE_BLOCK
+ * @memberOf module:php-parser
+ */
+Declare.MODE_BLOCK = "block";
+
+/**
+ * The node is declared as a simple statement. In order to make things simpler
+ * children of the node are automatically collected until the next
+ * declare statement.
+ * ```php
+ * <?php
+ * declare(ticks=1);
+ * // some statements
+ * declare(ticks=2);
+ * // some statements
+ * ```
+ * @constant {String} Declare#MODE_NONE
+ * @memberOf module:php-parser
+ */
+Declare.MODE_NONE = "none";
+
+module.exports = Declare;

package/src/ast/declaredirective.js

@@ -0,0 +1,26 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Node = require("./node");
+const KIND = "declaredirective";
+
+/**
+ * Defines a constant
+ * @constructor DeclareDirective
+ * @memberOf module:php-parser
+ * @extends {Node}
+ * @property {Identifier} key
+ * @property {Node|string|number|boolean|null} value
+ */
+module.exports = Node.extends(
+  KIND,
+  function DeclareDirective(key, value, docs, location) {
+    Node.apply(this, [KIND, docs, location]);
+    this.key = key;
+    this.value = value;
+  },
+);

package/src/ast/do.js

@@ -0,0 +1,26 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Statement = require("./statement");
+const KIND = "do";
+
+/**
+ * Defines a do/while statement
+ * @constructor Do
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Expression} test
+ * @property {Block | null} body
+ */
+module.exports = Statement.extends(
+  KIND,
+  function Do(test, body, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.test = test;
+    this.body = body;
+  },
+);

package/src/ast/echo.js

@@ -0,0 +1,26 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Statement = require("./statement");
+const KIND = "echo";
+
+/**
+ * Defines system based call
+ * @constructor Echo
+ * @memberOf module:php-parser
+ * @property {boolean} shortForm
+ * @property {Expression[]} expressions
+ * @extends {Statement}
+ */
+module.exports = Statement.extends(
+  KIND,
+  function Echo(expressions, shortForm, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.shortForm = shortForm;
+    this.expressions = expressions;
+  },
+);

package/src/ast/empty.js

@@ -0,0 +1,23 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Expression = require("./expression");
+const KIND = "empty";
+
+/**
+ * Defines an empty check call
+ * @constructor Empty
+ * @memberOf module:php-parser
+ * @extends {Expression}
+ */
+module.exports = Expression.extends(
+  KIND,
+  function Empty(expression, docs, location) {
+    Expression.apply(this, [KIND, docs, location]);
+    this.expression = expression;
+  },
+);

package/src/ast/encapsed.js

@@ -0,0 +1,75 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Literal = require("./literal");
+const KIND = "encapsed";
+
+/**
+ * Defines an encapsed string (contains expressions)
+ * @constructor Encapsed
+ * @memberOf module:php-parser
+ * @extends {Literal}
+ * @property {String} type - Defines the type of encapsed string (shell, heredoc, string)
+ * @property {String|Null} label - The heredoc label, defined only when the type is heredoc
+ * @property {EncapsedPart[]} value
+ */
+const Encapsed = Literal.extends(
+  KIND,
+  function Encapsed(value, raw, type, docs, location) {
+    Literal.apply(this, [KIND, value, raw, docs, location]);
+    this.type = type;
+  },
+);
+
+/**
+ * The node is a double quote string :
+ * ```php
+ * <?php
+ * echo "hello $world";
+ * ```
+ * @constant {String} Encapsed#TYPE_STRING - `string`
+ * @memberOf module:php-parser
+ */
+Encapsed.TYPE_STRING = "string";
+
+/**
+ * The node is a shell execute string :
+ * ```php
+ * <?php
+ * echo `ls -larth $path`;
+ * ```
+ * @constant {String} Encapsed#TYPE_SHELL - `shell`
+ * @memberOf module:php-parser
+ */
+Encapsed.TYPE_SHELL = "shell";
+
+/**
+ * The node is a shell execute string :
+ * ```php
+ * <?php
+ * echo <<<STR
+ *  Hello $world
+ * STR
+ * ;
+ * ```
+ * @constant {String} Encapsed#TYPE_HEREDOC - `heredoc`
+ * @memberOf module:php-parser
+ */
+Encapsed.TYPE_HEREDOC = "heredoc";
+
+/**
+ * The node contains a list of constref / variables / expr :
+ * ```php
+ * <?php
+ * echo $foo->bar_$baz;
+ * ```
+ * @constant {String} Encapsed#TYPE_OFFSET - `offset`
+ * @memberOf module:php-parser
+ */
+Encapsed.TYPE_OFFSET = "offset";
+
+module.exports = Encapsed;

package/src/ast/encapsedpart.js

@@ -0,0 +1,28 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Expression = require("./expression");
+const KIND = "encapsedpart";
+
+/**
+ * Part of `Encapsed` node
+ * @constructor EncapsedPart
+ * @memberOf module:php-parser
+ * @extends {Expression}
+ * @property {Expression} expression
+ * @property {String} syntax
+ * @property {Boolean} curly
+ */
+module.exports = Expression.extends(
+  KIND,
+  function EncapsedPart(expression, syntax, curly, docs, location) {
+    Expression.apply(this, [KIND, docs, location]);
+    this.expression = expression;
+    this.syntax = syntax;
+    this.curly = curly;
+  },
+);

package/src/ast/entry.js

@@ -0,0 +1,30 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Expression = require("./expression");
+const KIND = "entry";
+
+/**
+ * An array entry - see [Array](#array)
+ * @memberOf module:php-parser
+ * @constructor Entry
+ * @extends {Expression}
+ * @property {Node|null} key The entry key/offset
+ * @property {Node} value The entry value
+ * @property {Boolean} byRef By reference
+ * @property {Boolean} unpack Argument unpacking
+ */
+module.exports = Expression.extends(
+  KIND,
+  function Entry(key, value, byRef, unpack, docs, location) {
+    Expression.apply(this, [KIND, docs, location]);
+    this.key = key;
+    this.value = value;
+    this.byRef = byRef;
+    this.unpack = unpack;
+  },
+);

package/src/ast/enum.js

@@ -0,0 +1,30 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Declaration = require("./declaration");
+const KIND = "enum";
+
+/**
+ * A enum definition
+ * @constructor Enum
+ * @memberOf module:php-parser
+ * @extends {Declaration}
+ * @property {Identifier|null} valueType
+ * @property {Identifier[]} implements
+ * @property {Declaration[]} body
+ * @property {AttrGroup[]} attrGroups
+ */
+module.exports = Declaration.extends(
+  KIND,
+  function Enum(name, valueType, impl, body, docs, location) {
+    Declaration.apply(this, [KIND, name, docs, location]);
+    this.valueType = valueType;
+    this.implements = impl;
+    this.body = body;
+    this.attrGroups = [];
+  },
+);

package/src/ast/enumcase.js

@@ -0,0 +1,26 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Node = require("./node");
+const KIND = "enumcase";
+
+/**
+ * Declares a cases into the current scope
+ * @constructor EnumCase
+ * @memberOf module:php-parser
+ * @extends {Node}
+ * @property {string} name
+ * @property {string|number|null} value
+ */
+module.exports = Node.extends(
+  KIND,
+  function EnumCase(name, value, docs, location) {
+    Node.apply(this, [KIND, docs, location]);
+    this.name = name;
+    this.value = value;
+  },
+);

package/src/ast/error.js

@@ -0,0 +1,30 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Node = require("./node");
+const KIND = "error";
+
+/**
+ * Defines an error node (used only on silentMode)
+ * @constructor Error
+ * @memberOf module:php-parser
+ * @extends {Node}
+ * @property {string} message
+ * @property {number} line
+ * @property {number|string} token
+ * @property {string|array} expected
+ */
+module.exports = Node.extends(
+  KIND,
+  function Error(message, token, line, expected, docs, location) {
+    Node.apply(this, [KIND, docs, location]);
+    this.message = message;
+    this.token = token;
+    this.line = line;
+    this.expected = expected;
+  },
+);

package/src/ast/eval.js

@@ -0,0 +1,24 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Expression = require("./expression");
+const KIND = "eval";
+
+/**
+ * Defines an eval statement
+ * @constructor Eval
+ * @memberOf module:php-parser
+ * @extends {Expression}
+ * @property {Node} source
+ */
+module.exports = Expression.extends(
+  KIND,
+  function Eval(source, docs, location) {
+    Expression.apply(this, [KIND, docs, location]);
+    this.source = source;
+  },
+);

package/src/ast/exit.js

@@ -0,0 +1,26 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Expression = require("./expression");
+const KIND = "exit";
+
+/**
+ * Defines an exit / die call
+ * @constructor Exit
+ * @memberOf module:php-parser
+ * @extends {Expression}
+ * @property {Node|null} expression
+ * @property {boolean} useDie
+ */
+module.exports = Expression.extends(
+  KIND,
+  function Exit(expression, useDie, docs, location) {
+    Expression.apply(this, [KIND, docs, location]);
+    this.expression = expression;
+    this.useDie = useDie;
+  },
+);

package/src/ast/expression.js

@@ -0,0 +1,20 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Node = require("./node");
+const KIND = "expression";
+
+/**
+ * Any expression node. Since the left-hand side of an assignment may
+ * be any expression in general, an expression can also be a pattern.
+ * @constructor Expression
+ * @memberOf module:php-parser
+ * @extends {Node}
+ */
+module.exports = Node.extends(KIND, function Expression(kind, docs, location) {
+  Node.apply(this, [kind || KIND, docs, location]);
+});

package/src/ast/expressionstatement.js

@@ -0,0 +1,24 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Statement = require("./statement");
+const KIND = "expressionstatement";
+
+/**
+ * Defines an expression based statement
+ * @constructor ExpressionStatement
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Expression} expression
+ */
+module.exports = Statement.extends(
+  KIND,
+  function ExpressionStatement(expr, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.expression = expr;
+  },
+);

package/src/ast/for.js

@@ -0,0 +1,33 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Statement = require("./statement");
+const KIND = "for";
+
+/**
+ * Defines a for iterator
+ * @constructor For
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Expression[]} init
+ * @property {Expression[]} test
+ * @property {Expression[]} increment
+ * @property {Block | null} body
+ * @property {boolean} shortForm
+ * @see http://php.net/manual/en/control-structures.for.php
+ */
+module.exports = Statement.extends(
+  KIND,
+  function For(init, test, increment, body, shortForm, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.init = init;
+    this.test = test;
+    this.increment = increment;
+    this.shortForm = shortForm;
+    this.body = body;
+  },
+);

package/src/ast/foreach.js

@@ -0,0 +1,33 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Statement = require("./statement");
+const KIND = "foreach";
+
+/**
+ * Defines a foreach iterator
+ * @constructor Foreach
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Expression} source
+ * @property {Expression|null} key
+ * @property {Expression} value
+ * @property {Block | null} body
+ * @property {boolean} shortForm
+ * @see http://php.net/manual/en/control-structures.foreach.php
+ */
+module.exports = Statement.extends(
+  KIND,
+  function Foreach(source, key, value, body, shortForm, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.source = source;
+    this.key = key;
+    this.value = value;
+    this.shortForm = shortForm;
+    this.body = body;
+  },
+);

package/src/ast/function.js

@@ -0,0 +1,34 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Declaration = require("./declaration");
+const KIND = "function";
+
+/**
+ * Defines a classic function
+ * @constructor Function
+ * @memberOf module:php-parser
+ * @extends {Declaration}
+ * @property {Parameter[]} arguments
+ * @property {Identifier} type
+ * @property {boolean} byref
+ * @property {boolean} nullable
+ * @property {Block|null} body
+ * @property {AttrGroup[]} attrGroups
+ */
+module.exports = Declaration.extends(
+  KIND,
+  function _Function(name, args, byref, type, nullable, docs, location) {
+    Declaration.apply(this, [KIND, name, docs, location]);
+    this.arguments = args;
+    this.byref = byref;
+    this.type = type;
+    this.nullable = nullable;
+    this.body = null;
+    this.attrGroups = [];
+  },
+);

package/src/ast/global.js

@@ -0,0 +1,24 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Statement = require("./statement");
+const KIND = "global";
+
+/**
+ * Imports a variable from the global scope
+ * @constructor Global
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Variable[]} items
+ */
+module.exports = Statement.extends(
+  KIND,
+  function Global(items, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.items = items;
+  },
+);

package/src/ast/goto.js

@@ -0,0 +1,22 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Statement = require("./statement");
+const KIND = "goto";
+
+/**
+ * Defines goto statement
+ * @constructor Goto
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {string} label
+ * @see {Label}
+ */
+module.exports = Statement.extends(KIND, function Goto(label, docs, location) {
+  Statement.apply(this, [KIND, docs, location]);
+  this.label = label;
+});

package/src/ast/halt.js

@@ -0,0 +1,22 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Statement = require("./statement");
+const KIND = "halt";
+
+/**
+ * Halts the compiler execution
+ * @constructor Halt
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {String} after - String after the halt statement
+ * @see http://php.net/manual/en/function.halt-compiler.php
+ */
+module.exports = Statement.extends(KIND, function Halt(after, docs, location) {
+  Statement.apply(this, [KIND, docs, location]);
+  this.after = after;
+});