@jorgsowa/php-parser 3.2.5-1

package/src/ast/static.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 = "static";
+
+/**
+ * Declares a static variable into the current scope
+ * @constructor Static
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {StaticVariable[]} variables
+ */
+module.exports = Statement.extends(
+  KIND,
+  function Static(variables, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.variables = variables;
+  },
+);

package/src/ast/staticlookup.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 Lookup = require("./lookup");
+const KIND = "staticlookup";
+
+/**
+ * Lookup to a static property
+ * @constructor StaticLookup
+ * @memberOf module:php-parser
+ * @extends {Lookup}
+ */
+module.exports = Lookup.extends(
+  KIND,
+  function StaticLookup(what, offset, docs, location) {
+    Lookup.apply(this, [KIND, what, offset, docs, location]);
+  },
+);

package/src/ast/staticreference.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 Reference = require("./reference");
+const KIND = "staticreference";
+
+/**
+ * Defines a class reference node
+ * @constructor StaticReference
+ * @memberOf module:php-parser
+ * @extends {Reference}
+ */
+const StaticReference = Reference.extends(
+  KIND,
+  function StaticReference(raw, docs, location) {
+    Reference.apply(this, [KIND, docs, location]);
+    this.raw = raw;
+  },
+);
+module.exports = StaticReference;

package/src/ast/staticvariable.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 = "staticvariable";
+
+/**
+ * Defines a constant
+ * @constructor StaticVariable
+ * @memberOf module:php-parser
+ * @extends {Node}
+ * @property {Variable} variable
+ * @property {Node|string|number|boolean|null} defaultValue
+ */
+module.exports = Node.extends(
+  KIND,
+  function StaticVariable(variable, defaultValue, docs, location) {
+    Node.apply(this, [KIND, docs, location]);
+    this.variable = variable;
+    this.defaultValue = defaultValue;
+  },
+);

package/src/ast/string.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 Literal = require("./literal");
+const KIND = "string";
+
+/**
+ * Defines a string (simple or double quoted) - chars are already escaped
+ * @constructor String
+ * @memberOf module:php-parser
+ * @extends {Literal}
+ * @property {boolean} unicode
+ * @property {boolean} isDoubleQuote
+ * @see {Encapsed}
+ * @property {string} value
+ */
+module.exports = Literal.extends(
+  KIND,
+  function String(isDoubleQuote, value, unicode, raw, docs, location) {
+    Literal.apply(this, [KIND, value, raw, docs, location]);
+    this.unicode = unicode;
+    this.isDoubleQuote = isDoubleQuote;
+  },
+);

package/src/ast/switch.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 Statement = require("./statement");
+const KIND = "switch";
+
+/**
+ * Defines a switch statement
+ * @constructor Switch
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Expression} test
+ * @property {Block} body
+ * @property {boolean} shortForm
+ */
+module.exports = Statement.extends(
+  KIND,
+  function Switch(test, body, shortForm, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.test = test;
+    this.body = body;
+    this.shortForm = shortForm;
+  },
+);

package/src/ast/throw.js

@@ -0,0 +1,21 @@
+/**
+ * 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 = "throw";
+
+/**
+ * Defines a throw statement
+ * @constructor Throw
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Expression} what
+ */
+module.exports = Statement.extends(KIND, function Throw(what, docs, location) {
+  Statement.apply(this, [KIND, docs, location]);
+  this.what = what;
+});

package/src/ast/trait.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 Declaration = require("./declaration");
+const KIND = "trait";
+
+/**
+ * A trait definition
+ * @constructor Trait
+ * @memberOf module:php-parser
+ * @extends {Declaration}
+ * @property {Declaration[]} body
+ */
+module.exports = Declaration.extends(
+  KIND,
+  function Trait(name, body, docs, location) {
+    Declaration.apply(this, [KIND, name, docs, location]);
+    this.body = body;
+  },
+);

package/src/ast/traitalias.js

@@ -0,0 +1,44 @@
+/**
+ * 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 = "traitalias";
+
+const IS_UNDEFINED = "";
+const IS_PUBLIC = "public";
+const IS_PROTECTED = "protected";
+const IS_PRIVATE = "private";
+
+/**
+ * Defines a trait alias
+ * @constructor TraitAlias
+ * @memberOf module:php-parser
+ * @extends {Node}
+ * @property {Identifier|null} trait
+ * @property {Identifier} method
+ * @property {Identifier|null} as
+ * @property {string|null} visibility
+ */
+module.exports = Node.extends(
+  KIND,
+  function TraitAlias(trait, method, as, flags, docs, location) {
+    Node.apply(this, [KIND, docs, location]);
+    this.trait = trait;
+    this.method = method;
+    this.as = as;
+    this.visibility = IS_UNDEFINED;
+    if (flags) {
+      if (flags[0] === 0) {
+        this.visibility = IS_PUBLIC;
+      } else if (flags[0] === 1) {
+        this.visibility = IS_PROTECTED;
+      } else if (flags[0] === 2) {
+        this.visibility = IS_PRIVATE;
+      }
+    }
+  },
+);

package/src/ast/traitprecedence.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 Node = require("./node");
+const KIND = "traitprecedence";
+
+/**
+ * Defines a trait alias
+ * @constructor TraitPrecedence
+ * @memberOf module:php-parser
+ * @extends {Node}
+ * @property {Identifier|null} trait
+ * @property {Identifier} method
+ * @property {Identifier[]} instead
+ */
+module.exports = Node.extends(
+  KIND,
+  function TraitPrecedence(trait, method, instead, docs, location) {
+    Node.apply(this, [KIND, docs, location]);
+    this.trait = trait;
+    this.method = method;
+    this.instead = instead;
+  },
+);

package/src/ast/traituse.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 = "traituse";
+
+/**
+ * Defines a trait usage
+ * @constructor TraitUse
+ * @memberOf module:php-parser
+ * @extends {Node}
+ * @property {Identifier[]} traits
+ * @property {Node[]|null} adaptations
+ */
+module.exports = Node.extends(
+  KIND,
+  function TraitUse(traits, adaptations, docs, location) {
+    Node.apply(this, [KIND, docs, location]);
+    this.traits = traits;
+    this.adaptations = adaptations;
+  },
+);

package/src/ast/try.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 Statement = require("./statement");
+const KIND = "try";
+
+/**
+ * Defines a try statement
+ * @constructor Try
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Block} body
+ * @property {Catch[]} catches
+ * @property {Block} always
+ */
+module.exports = Statement.extends(
+  KIND,
+  function Try(body, catches, always, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.body = body;
+    this.catches = catches;
+    this.always = always;
+  },
+);

package/src/ast/typereference.js

@@ -0,0 +1,40 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Reference = require("./reference");
+const KIND = "typereference";
+
+/**
+ * Defines a class reference node
+ * @constructor TypeReference
+ * @memberOf module:php-parser
+ * @extends {Reference}
+ * @property {string} name
+ */
+const TypeReference = Reference.extends(
+  KIND,
+  function TypeReference(name, raw, docs, location) {
+    Reference.apply(this, [KIND, docs, location]);
+    this.name = name;
+    this.raw = raw;
+  },
+);
+
+TypeReference.types = [
+  "int",
+  "float",
+  "string",
+  "bool",
+  "object",
+  "array",
+  "callable",
+  "iterable",
+  "void",
+  "static",
+];
+
+module.exports = TypeReference;

package/src/ast/unary.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 Operation = require("./operation");
+const KIND = "unary";
+
+/**
+ * Unary operations
+ * @constructor Unary
+ * @memberOf module:php-parser
+ * @extends {Operation}
+ * @property {string} type
+ * @property {Expression} what
+ */
+module.exports = Operation.extends(
+  KIND,
+  function Unary(type, what, docs, location) {
+    Operation.apply(this, [KIND, docs, location]);
+    this.type = type;
+    this.what = what;
+  },
+);

package/src/ast/uniontype.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 Declaration = require("./declaration");
+const KIND = "uniontype";
+
+/**
+ * A union of types
+ * @memberOf module:php-parser
+ * @constructor UnionType
+ * @extends {Declaration}
+ * @property {TypeReference[]} types
+ */
+module.exports = Declaration.extends(
+  KIND,
+  function UnionType(types, docs, location) {
+    Declaration.apply(this, [KIND, null, docs, location]);
+    this.types = types;
+  },
+);

package/src/ast/unset.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 Statement = require("./statement");
+const KIND = "unset";
+
+/**
+ * Deletes references to a list of variables
+ * @constructor Unset
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ */
+module.exports = Statement.extends(
+  KIND,
+  function Unset(variables, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.variables = variables;
+  },
+);

package/src/ast/usegroup.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 Statement = require("./statement");
+const KIND = "usegroup";
+
+/**
+ * Defines a use statement (with a list of use items)
+ * @constructor UseGroup
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {string|null} name
+ * @property {string|null} type - Possible value : function, const
+ * @property {UseItem[]} item
+ * @see {Namespace}
+ * @see http://php.net/manual/en/language.namespaces.importing.php
+ */
+module.exports = Statement.extends(
+  KIND,
+  function UseGroup(name, type, items, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.name = name;
+    this.type = type;
+    this.items = items;
+  },
+);

package/src/ast/useitem.js

@@ -0,0 +1,45 @@
+/**
+ * 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 = "useitem";
+
+/**
+ * Defines a use statement (from namespace)
+ * @constructor UseItem
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {string} name
+ * @property {string|null} type - Possible value : function, const
+ * @property {Identifier|null} alias
+ * @see {Namespace}
+ * @see http://php.net/manual/en/language.namespaces.importing.php
+ */
+const UseItem = Statement.extends(
+  KIND,
+  function UseItem(name, alias, type, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.name = name;
+    this.alias = alias;
+    this.type = type;
+  },
+);
+
+/**
+ * Importing a constant
+ * @constant {string} UseItem#TYPE_CONST
+ * @memberOf module:php-parser
+ */
+UseItem.TYPE_CONST = "const";
+/**
+ * Importing a function
+ * @constant {string} UseItem#TYPE_FUNC
+ * @memberOf module:php-parser
+ */
+UseItem.TYPE_FUNCTION = "function";
+
+module.exports = UseItem;

package/src/ast/variable.js

@@ -0,0 +1,36 @@
+/**
+ * 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 = "variable";
+
+/**
+ * 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 Variable
+ * @memberOf module:php-parser
+ * @extends {Expression}
+ * @example
+ * // PHP code :
+ * $foo
+ * // AST output
+ * {
+ *  "kind": "variable",
+ *  "name": "foo",
+ *  "curly": false
+ * }
+ * @property {string|Node} name The variable name (can be a complex expression when the name is resolved dynamically)
+ * @property {boolean} curly Indicate if the name is defined between curlies, ex `${foo}`
+ */
+module.exports = Expression.extends(
+  KIND,
+  function Variable(name, curly, docs, location) {
+    Expression.apply(this, [KIND, docs, location]);
+    this.name = name;
+    this.curly = curly || false;
+  },
+);

package/src/ast/variadic.js

@@ -0,0 +1,25 @@
+/**
+ * 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 = "variadic";
+
+/**
+ * Introduce a list of items into the arguments of the call
+ * @constructor Variadic
+ * @memberOf module:php-parser
+ * @extends {Expression}
+ * @property {Array|Expression} what
+ * @see https://wiki.php.net/rfc/argument_unpacking
+ */
+module.exports = Expression.extends(
+  KIND,
+  function variadic(what, docs, location) {
+    Expression.apply(this, [KIND, docs, location]);
+    this.what = what;
+  },
+);

package/src/ast/variadicplaceholder.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 Node = require("./node");
+const KIND = "variadicplaceholder";
+
+/**
+ * Defines a variadic placeholder (the ellipsis in PHP 8.1+'s first-class callable syntax)
+ * @constructor VariadicPlaceholder
+ * @memberOf module:php-parser
+ * @extends {Node}
+ * @see {Namespace}
+ * @see http://php.net/manual/en/language.namespaces.importing.php
+ */
+module.exports = Node.extends(
+  KIND,
+  function VariadicPlaceholder(docs, location) {
+    Node.apply(this, [KIND, docs, location]);
+  },
+);

package/src/ast/while.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 Statement = require("./statement");
+const KIND = "while";
+
+/**
+ * Defines a while statement
+ * @constructor While
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Expression} test
+ * @property {Block | null} body
+ * @property {boolean} shortForm
+ */
+module.exports = Statement.extends(
+  KIND,
+  function While(test, body, shortForm, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.test = test;
+    this.body = body;
+    this.shortForm = shortForm;
+  },
+);

package/src/ast/yield.js

@@ -0,0 +1,27 @@
+/**
+ * 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 = "yield";
+
+/**
+ * Defines a yield generator statement
+ * @constructor Yield
+ * @memberOf module:php-parser
+ * @extends {Expression}
+ * @property {Expression|null} value
+ * @property {Expression|null} key
+ * @see http://php.net/manual/en/language.generators.syntax.php
+ */
+module.exports = Expression.extends(
+  KIND,
+  function Yield(value, key, docs, location) {
+    Expression.apply(this, [KIND, docs, location]);
+    this.value = value;
+    this.key = key;
+  },
+);