@jorgsowa/php-parser 3.2.5-1

package/src/ast/attribute.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 = "attribute";
+
+/**
+ * Attribute Value
+ * @memberOf module:php-parser
+ * @constructor Attribute
+ * @extends {Node}
+ * @property {String} name
+ * @property {Parameter[]} args
+ */
+module.exports = Node.extends(
+  KIND,
+  function Attribute(name, args, docs, location) {
+    Node.apply(this, [KIND, docs, location]);
+    this.name = name;
+    this.args = args;
+  },
+);

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

package/src/ast/block.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 = "block";
+
+/**
+ * A block statement, i.e., a sequence of statements surrounded by braces.
+ * @constructor Block
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Node[]} children
+ */
+module.exports = Statement.extends(
+  KIND,
+  function Block(kind, children, docs, location) {
+    Statement.apply(this, [kind || KIND, docs, location]);
+    this.children = children.filter(Boolean);
+  },
+);

package/src/ast/boolean.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 Literal = require("./literal");
+const KIND = "boolean";
+
+/**
+ * Defines a boolean value (true/false)
+ * @constructor Boolean
+ * @memberOf module:php-parser
+ * @extends {Literal}
+ * @property {boolean} value
+ */
+module.exports = Literal.extends(
+  KIND,
+  function Boolean(value, raw, docs, location) {
+    Literal.apply(this, [KIND, value, raw, docs, location]);
+  },
+);

package/src/ast/break.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 = "break";
+
+/**
+ * A break statement
+ * @constructor Break
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Number|Null} level
+ */
+module.exports = Statement.extends(KIND, function Break(level, docs, location) {
+  Statement.apply(this, [KIND, docs, location]);
+  this.level = level;
+});

package/src/ast/byref.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 Expression = require("./expression");
+const KIND = "byref";
+
+/**
+ * Passing by Reference - so the function can modify the variable
+ * @constructor ByRef
+ * @memberOf module:php-parser
+ * @extends {Expression}
+ * @property {ExpressionStatement} what
+ */
+module.exports = Expression.extends(KIND, function ByRef(what, docs, location) {
+  Expression.apply(this, [KIND, docs, location]);
+  this.what = what;
+});

package/src/ast/call.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 = "call";
+
+/**
+ * Executes a call statement
+ * @constructor Call
+ * @memberOf module:php-parser
+ * @extends {Expression}
+ * @property {Identifier|Variable} what
+ * @property {Expression[]} arguments
+ */
+module.exports = Expression.extends(
+  KIND,
+  function Call(what, args, docs, location) {
+    Expression.apply(this, [KIND, docs, location]);
+    this.what = what;
+    this.arguments = args;
+  },
+);

package/src/ast/case.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 = "case";
+
+/**
+ * A switch case statement
+ * @constructor Case
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Expression|null} test - if null, means that the default case
+ * @property {Block|null} body
+ */
+module.exports = Statement.extends(
+  KIND,
+  function Case(test, body, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.test = test;
+    this.body = body;
+  },
+);

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

package/src/ast/catch.js

@@ -0,0 +1,29 @@
+/**
+ * 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 = "catch";
+
+/**
+ * Defines a catch statement
+ * @constructor Catch
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Name[]} what
+ * @property {Variable} variable
+ * @property {Block} body
+ * @see http://php.net/manual/en/language.exceptions.php
+ */
+module.exports = Statement.extends(
+  KIND,
+  function Catch(body, what, variable, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.body = body;
+    this.what = what;
+    this.variable = variable;
+  },
+);

package/src/ast/class.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 Declaration = require("./declaration");
+const KIND = "class";
+
+/**
+ * A class definition
+ * @constructor Class
+ * @memberOf module:php-parser
+ * @extends {Declaration}
+ * @property {Identifier|null} extends
+ * @property {Identifier[]|null} implements
+ * @property {Declaration[]} body
+ * @property {boolean} isAnonymous
+ * @property {boolean} isAbstract
+ * @property {boolean} isFinal
+ * @property {boolean} isReadonly
+ * @property {AttrGroup[]} attrGroups
+ */
+module.exports = Declaration.extends(
+  KIND,
+  function Class(name, ext, impl, body, flags, docs, location) {
+    Declaration.apply(this, [KIND, name, docs, location]);
+    this.isAnonymous = name ? false : true;
+    this.extends = ext;
+    this.implements = impl;
+    this.body = body;
+    this.attrGroups = [];
+    this.parseFlags(flags);
+  },
+);

package/src/ast/classconstant.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 ConstantStatement = require("./constantstatement");
+const KIND = "classconstant";
+
+const IS_UNDEFINED = "";
+const IS_PUBLIC = "public";
+const IS_PROTECTED = "protected";
+const IS_PRIVATE = "private";
+
+/**
+ * Defines a class/interface/trait constant
+ * @constructor ClassConstant
+ * @memberOf module:php-parser
+ * @extends {ConstantStatement}
+ * @property {string} visibility
+ * @property {boolean} final
+ * @property {boolean} nullable
+ * @property {TypeReference|IntersectionType|UnionType|null} type
+ * @property {AttrGroup[]} attrGroups
+ */
+const ClassConstant = ConstantStatement.extends(
+  KIND,
+  function ClassConstant(
+    kind,
+    constants,
+    flags,
+    nullable,
+    type,
+    attrGroups,
+    docs,
+    location,
+  ) {
+    ConstantStatement.apply(this, [kind || KIND, constants, docs, location]);
+    this.parseFlags(flags);
+    this.nullable = nullable;
+    this.type = type;
+    this.attrGroups = attrGroups;
+  },
+);
+
+/**
+ * Generic flags parser
+ * @function
+ * @name ClassConstant#parseFlags
+ * @memberOf module:php-parser
+ * @param {Array<number|null>} flags
+ * @return {void}
+ */
+ClassConstant.prototype.parseFlags = function (flags) {
+  if (flags[0] === -1) {
+    this.visibility = IS_UNDEFINED;
+  } else if (flags[0] === null) {
+    /* istanbul ignore next */
+    this.visibility = null;
+  } else 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;
+  }
+  this.final = flags[2] === 2;
+};
+
+module.exports = ClassConstant;

package/src/ast/clone.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 Expression = require("./expression");
+const KIND = "clone";
+
+/**
+ * Defines a clone call
+ * @constructor Clone
+ * @memberOf module:php-parser
+ * @extends {Expression}
+ * @property {Expression} what
+ */
+module.exports = Expression.extends(KIND, function Clone(what, docs, location) {
+  Expression.apply(this, [KIND, docs, location]);
+  this.what = what;
+});

package/src/ast/closure.js

@@ -0,0 +1,47 @@
+/**
+ * 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 = "closure";
+
+/**
+ * Defines a closure
+ * @constructor Closure
+ * @memberOf module:php-parser
+ * @extends {Expression}
+ * @property {Parameter[]} arguments
+ * @property {Variable[]} uses
+ * @property {Identifier} type
+ * @property {Boolean} byref
+ * @property {boolean} nullable
+ * @property {Block|null} body
+ * @property {boolean} isStatic
+ * @property {AttrGroup[]} attrGroups
+ */
+module.exports = Expression.extends(
+  KIND,
+  function Closure(
+    args,
+    byref,
+    uses,
+    type,
+    nullable,
+    isStatic,
+    docs,
+    location,
+  ) {
+    Expression.apply(this, [KIND, docs, location]);
+    this.uses = uses;
+    this.arguments = args;
+    this.byref = byref;
+    this.type = type;
+    this.nullable = nullable;
+    this.isStatic = isStatic || false;
+    this.body = null;
+    this.attrGroups = [];
+  },
+);

package/src/ast/comment.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 Node = require("./node");
+
+/**
+ * Abstract documentation node (ComentLine or CommentBlock)
+ * @constructor Comment
+ * @memberOf module:php-parser
+ * @extends {Node}
+ * @property {String} value
+ */
+module.exports = Node.extends(
+  "comment",
+  function Comment(kind, value, docs, location) {
+    Node.apply(this, [kind, docs, location]);
+    this.value = value;
+  },
+);

package/src/ast/commentblock.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 Comment = require("./comment");
+const KIND = "commentblock";
+
+/**
+ * A comment block (multiline)
+ * @constructor CommentBlock
+ * @memberOf module:php-parser
+ * @extends {Comment}
+ */
+module.exports = Comment.extends(
+  KIND,
+  function CommentBlock(value, docs, location) {
+    Comment.apply(this, [KIND, value, docs, location]);
+  },
+);

package/src/ast/commentline.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 Comment = require("./comment");
+const KIND = "commentline";
+
+/**
+ * A single line comment
+ * @constructor CommentLine
+ * @memberOf module:php-parser
+ * @extends {Comment}
+ */
+module.exports = Comment.extends(
+  KIND,
+  function CommentLine(value, docs, location) {
+    Comment.apply(this, [KIND, value, docs, location]);
+  },
+);

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

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

package/src/ast/continue.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 = "continue";
+
+/**
+ * A continue statement
+ * @constructor Continue
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {number|null} level
+ */
+module.exports = Statement.extends(
+  KIND,
+  function Continue(level, docs, location) {
+    Statement.apply(this, [KIND, docs, location]);
+    this.level = level;
+  },
+);

package/src/ast/declaration.js

@@ -0,0 +1,60 @@
+/**
+ * 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 = "declaration";
+
+const IS_UNDEFINED = "";
+const IS_PUBLIC = "public";
+const IS_PROTECTED = "protected";
+const IS_PRIVATE = "private";
+
+/**
+ * A declaration statement (function, class, interface...)
+ * @constructor Declaration
+ * @memberOf module:php-parser
+ * @extends {Statement}
+ * @property {Identifier|string} name
+ */
+const Declaration = Statement.extends(
+  KIND,
+  function Declaration(kind, name, docs, location) {
+    Statement.apply(this, [kind || KIND, docs, location]);
+    this.name = name;
+  },
+);
+
+/**
+ * Generic flags parser
+ * @function
+ * @name Declaration#parseFlags
+ * @memberOf module:php-parser
+ * @param {Array<number|null>} flags
+ * @return {void}
+ */
+Declaration.prototype.parseFlags = function (flags) {
+  this.isAbstract = flags[2] === 1;
+  this.isFinal = flags[2] === 2;
+  this.isReadonly = flags[3] === 1;
+  if (this.kind !== "class") {
+    if (flags[0] === -1) {
+      this.visibility = IS_UNDEFINED;
+    } else if (flags[0] === null) {
+      /* istanbul ignore next */
+      this.visibility = null;
+    } else 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;
+    }
+    this.isStatic = flags[1] === 1;
+  }
+};
+
+module.exports = Declaration;