nikic/php-parser

Fixed

• Treat _ as label character in formatting-preserving pretty printer.
• Handle comment after object operator in keyword emulator.

Changed

• Drop support for pipe operator in constant expression evaluator. It is not supported in constant expressions and may pose security risks, as it allows calls to arbitrary functions.
• void parameter types now generate a (recoverable) error during parsing.
• Restored reverse emulation support for fn keywords when targeting PHP before 7.4.

Fixed

• Treat _ as label character in formatting-preserving pretty printer.
• Handle comment after object operator in keyword emulator.

Changed

• Drop support for pipe operator in constant expression evaluator. It is not supported in constant expressions and may pose security risks, as it allows calls to arbitrary functions.
• void parameter types now generate a (recoverable) error during parsing.
• Restored reverse emulation support for fn keywords when targeting PHP before 7.4.

Fixed

• Fixed changing modifier on anonymous class with formatting preserving pretty printer.
• Emit an error for unparenthesized arrow functions in pipe operator, and print necessary parentheses in the pretty printer.
• Fix PHP 8.5 deprecation warning in php-parse binary.

Changed

• When targeting PHP 8.4 or newer, omit parentheses around immediately dereferenced new expressions.

Added

• Added shouldPrintRawValue attribute to Scalar\Int_, which makes the pretty printer use the rawValue of the node. This can be used to print integers with separators.

Fixed

• Fixed changing modifier on anonymous class with formatting preserving pretty printer.
• Emit an error for unparenthesized arrow functions in pipe operator, and print necessary parentheses in the pretty printer.
• Fix PHP 8.5 deprecation warning in php-parse binary.

Changed

• When targeting PHP 8.4 or newer, omit parentheses around immediately dereferenced new expressions.

Added

• Added shouldPrintRawValue attribute to Scalar\Int_, which makes the pretty printer use the rawValue of the node. This can be used to print integers with separators.

Fixed

• Fixed formatting-preserving pretty-printing when changing the visibility modifier on a node that has attributes.
• Fixed chr() deprecation warning on PHP 8.5.

Added

• Added Param::isFinal() method.

Fixed

• Fixed formatting-preserving pretty-printing when changing the visibility modifier on a node that has attributes.
• Fixed chr() deprecation warning on PHP 8.5.

Added

• Added Param::isFinal() method.

Fixed

• Fixed Param::isPublic() for parameters with asymmetric visibility keyword.
• Fixed PHP 8.5 deprecation warnings for SplObjectStorage methods.

Added

• Added cast kind attributes to Cast\Int_, Cast\Bool_ and Cast\String_. These allow distinguishing the deprecated versions of these casts.

Fixed

• Fixed Param::isPublic() for parameters with asymmetric visibility keyword.
• Fixed PHP 8.5 deprecation warnings for SplObjectStorage methods.

Added

• Added cast kind attributes to Cast\Int_, Cast\Bool_ and Cast\String_. These allow distinguishing the deprecated versions of these casts.

Added

• [8.5] Added support for clone with arbitrary function arguments. This will be parsed as an Expr\FuncCall node, instead of the usual Expr\Clone_ node.
• [8.5] Permit declaration of function clone for use in stubs.
• [8.5] Added support for the pipe operator, represented by Expr\BinaryOp\Pipe.
• [8.5] Added support for the (void) cast, represented by Expr\Cast\Void_.
• [8.5] Added support for the final modifier on promoted properties.
• Added CallLike::getArg() to fetch an argument by position and name.

Added

• [8.5] Added support for clone with arbitrary function arguments. This will be parsed as an Expr\FuncCall node, instead of the usual Expr\Clone_ node.
• [8.5] Permit declaration of function clone for use in stubs.
• [8.5] Added support for the pipe operator, represented by Expr\BinaryOp\Pipe.
• [8.5] Added support for the (void) cast, represented by Expr\Cast\Void_.
• [8.5] Added support for the final modifier on promoted properties.
• Added CallLike::getArg() to fetch an argument by position and name.

Added

• [8.5] Added support for attributes on constants. Stmt\Const_ now has an attrGroups subnode.
• Added weakReferences option to NodeConnectingVisitor and ParentConnectingVisitor. This will create the parent/next/prev references as WeakReferences, to avoid making the AST cyclic and thus increasing GC pressure.

Changed

• Attributes on parameters are now printed on separate lines if the pretty printer target version is PHP 7.4 or older (which is the default). This allows them to be interpreted as comments, instead of causing a parse error. Specify a target version of PHP 8.0 or newer to restore the previous behavior.

Added

• [8.5] Added support for attributes on constants. Stmt\Const_ now has an attrGroups subnode.
• Added weakReferences option to NodeConnectingVisitor and ParentConnectingVisitor. This will create the parent/next/prev references as WeakReferences, to avoid making the AST cyclic and thus increasing GC pressure.

Changed

• Attributes on parameters are now printed on separate lines if the pretty printer target version is PHP 7.4 or older (which is the default). This allows them to be interpreted as comments, instead of causing a parse error. Specify a target version of PHP 8.0 or newer to restore the previous behavior.

Added

• Added Property::isAbstract() and Property::isFinal() methods.
• Added PropertyHook::isFinal() method.
• Emit an error if property hook is used on declaration with multiple properties.

Fixed

• Make legacy class aliases compatible with classmap-authoritative autoloader.
• Param::isPromoted() and Param::isPublic() now returns true for parameters that have property hooks but no explicit visibility modifier.
• PropertyHook::getStmts() now correctly desugars short set hooks. set => $value will be expanded to set { $this->propertyName = $value; }. This requires the propertyName attribute on the hook to be set, which is now also set by the parser. If the attribute is not set, getStmts() will throw an error for short set hooks, as it is not possible to produce a correct desugaring.

Added

• Added Property::isAbstract() and Property::isFinal() methods.
• Added PropertyHook::isFinal() method.
• Emit an error if property hook is used on declaration with multiple properties.

Fixed

• Make legacy class aliases compatible with classmap-authoritative autoloader.
• Param::isPromoted() and Param::isPublic() now returns true for parameters that have property hooks but no explicit visibility modifier.
• PropertyHook::getStmts() now correctly desugars short set hooks. set => $value will be expanded to set { $this->propertyName = $value; }. This requires the propertyName attribute on the hook to be set, which is now also set by the parser. If the attribute is not set, getStmts() will throw an error for short set hooks, as it is not possible to produce a correct desugaring.

Added

• Added support for declaring functions with name exit or die, to allow their use in stubs.

Added

• Added support for declaring functions with name exit or die, to allow their use in stubs.

Added

• Added indent option to pretty printer, which can be used to specify the indentation to use (defaulting to four spaces). This also allows using tab indentation.

Fixed

• Resolve names in PropertyHooks in the NameResolver.
• Include the trailing semicolon inside Stmt\GroupUse nodes, making them consistent with Stmt\Use_ nodes.
• Fixed indentation sometimes becoming negative in formatting-preserving pretty printer, resulting in ValueErrors.

Added

• Added indent option to pretty printer, which can be used to specify the indentation to use (defaulting to four spaces). This also allows using tab indentation.

Fixed

• Resolve names in PropertyHooks in the NameResolver.
• Include the trailing semicolon inside Stmt\GroupUse nodes, making them consistent with Stmt\Use_ nodes.
• Fixed indentation sometimes becoming negative in formatting-preserving pretty printer, resulting in ValueErrors.

Added

• [8.4] Added support for __PROPERTY__ magic constant, represented using a Node\Scalar\MagicConst\Property node.
• [8.4] Added support for property hooks, which are represented using a new hooks subnode on Node\Stmt\Property and Node\Param, which contains an array of Node\PropertyHook.
• [8.4] Added support for asymmetric visibility modifiers. Property flags can now hold the additional bits Modifiers::PUBLIC_SET, Modifiers::PROTECTED_SET and Modifiers::PRIVATE_SET.
• [8.4] Added support for generalized exit function. For backwards compatibility, exit without argument or a single plain argument continues to use a Node\Expr\Exit_ node. Otherwise (e.g. if a named argument is used) it will be represented as a plain Node\Expr\FuncCall.
• Added support for passing enum values to various builder methods, like BuilderFactory::val().

Removed

• Removed support for alternative array syntax $array{0} from the PHP 8 parser. It is still supported by the PHP 7 parser. This is necessary in order to support property hooks.

Added

• [8.4] Added support for dereferencing new expressions without parentheses.

Fixed

• Fixed redundant parentheses being added when pretty printing ternary expressions.

Changed

• Made some phpdoc types more precise.

Fixed

• Fix handling of indentation on next line after opening PHP tag in formatting-preserving pretty printer.

Changed

• Avoid cyclic references in Parser objects. This means that no longer used parser objects are immediately destroyed now, instead of requiring cycle GC.
• Update PhpVersion::getNewestSupported() to report PHP 8.3 instead of PHP 8.2.

Changed

• Added check to detect use of PHP-Parser with libraries that define T_* compatibility tokens with incorrect type (such as string instead of int). This would lead to TypeErrors down the line. Now an Error will be thrown early to indicate the problem.

See UPGRADE-5.0 for detailed migration instructions.

Fixed

• Fixed parent class of PropertyItem and UseItem.

Fixed

• Fixed deprecation warnings on PHP 8.5.

Fixed

• Fixed formatting preservation when adding multiple attributes to a class/method/etc that previously had none. This fixes a regression in the 4.15.0 release.

Added

• PHP 8.2: Added support for true type.
• PHP 8.2: Added support for DNF types.

Fixed

• Support readonly as a function name.
• Added __serialize and __unserialize to magic method list.
• Fixed bounds check in Name::slice().
• Fixed formatting preservation when adding attributes to a class/method/etc that previously had none.

Added

• Added support for readonly classes.
• Added rawValue attribute to LNumber, DNumber and String_ nodes, which stores the unparsed value of the literal (e.g. "1_000" rather than 1000).

Added

• Added builders for enums and enum cases.

Fixed

• NullsafeMethodCall now extends from CallLike.
• The namespacedName property populated by the NameResolver is now declared on relevant nodes, to avoid a dynamic property deprecation warning with PHP 8.2.

Fixed

• Support reserved keywords as enum cases.
• Support array unpacking in constant expression evaluator.

Added

• [PHP 8.1] Added support for intersection types using a new IntersectionType node. Additionally a ComplexType parent class for NullableType, UnionType and IntersectionType has been added.
• [PHP 8.1] Added support for explicit octal literals.
• [PHP 8.1] Added support for first-class callables. These are represented using a call whose first argument is a VariadicPlaceholder. The representation is intended to be forward-compatible with partial function application, just like the PHP feature itself. Call nodes now extend from Expr\CallLike, which provides an isFirstClassCallable() method to determine whether a placeholder id present. getArgs() can be used to assert that the call is not a first-class callable and returns Arg[] rather than array<Arg|VariadicPlaceholder>.

Fixed

• Multiple modifiers for promoted properties are now accepted. In particular this allows something like public readonly for promoted properties.
• Formatting-preserving pretty printing for comments in array literals has been fixed.

Added

• [PHP 8.1] Added support for readonly properties (through a new MODIFIER_READONLY).
• [PHP 8.1] Added support for final class constants.

Fixed

• Fixed compatibility with PHP 8.1. & tokens are now canonicalized to the T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG and T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG tokens used in PHP 8.1. This happens unconditionally, regardless of whether the emulative lexer is used.

Added

• BuilderFactory::args() now accepts named arguments.
• BuilderFactory::attribute() has been added.
• An addAttribute() method accepting an Attribute or AttributeGroup has been adde to all builders that accept attributes, such as Builder\Class_.

Fixed

• NameResolver now handles enums.
• PrettyPrinter now prints backing enum type.
• Builder methods for types now property handle never type.

Added

• [PHP 8.1] Added support for enums. These are represented using the Stmt\Enum_ and Stmt\EnumCase nodes.
• [PHP 8.1] Added support for never type. This type will now be returned as an Identifier rather than Name.
• Added ClassConst builder.

Changed

• Non-UTF-8 code units in strings will now be hex-encoded.

Fixed

• Fixed precedence of arrow functions.

Fixed

• Fixed position information for variable-variables (#741).
• Fixed position information for traits/interfaces preceded by if statement (#738).

Fixed

• Fixed formatting-preserving pretty printing for "{$x}".
• Ternary expressions are now treated as non-associative in the pretty printer, in order to generate code that is compatible with the parentheses requirement introduced in PHP 8.
• Removed no longer necessary error_clear_last() call in lexer, which may interfere with fatal error handlers if invoked during shutdown.

Fixed

• Fixed check for token emulation conflicts with other libraries.

Added

• Added support for recovering from a missing semicolon after a property or class constant declaration.

Fixed

• Fix spurious whitespace in formatting-preserving pretty printer when both removing and adding elements at the start of a list.
• Fix incorrect case-sensitivity in keyword token emulation.

Added

• [PHP 8.0] Added support for attributes. These are represented using a new AttributeGroup node containing Attribute nodes. A new attrGroups subnode is available on all node types that support attributes, i.e. Stmt\Class_, Stmt\Trait_, Stmt\Interface_, Stmt\Function_, Stmt\ClassMethod, Stmt\ClassConst, Stmt\Property, Expr\Closure, Expr\ArrowFunction and Param.
• [PHP 8.0] Added support for nullsafe properties inside interpolated strings, in line with an upstream change.

Fixed

• Improved compatibility with other libraries that use forward compatibility defines for PHP tokens.

Added

• Added support for removing the first element of a list to the formatting-preserving pretty printer.

Fixed

• Allow member modifiers as part of namespaced names. These were missed when support for other keywords was added.

Added

• [PHP 8.0] Added support for named arguments, represented using a new name subnode on Arg.
• [PHP 8.0] Added support for static return type, represented like a normal class return type.
• [PHP 8.0] Added support for throw expression, represented using a new Expr\Throw_ node. For backwards compatibility reasons, throw expressions in statement context continue to be represented using Stmt\Throw_.
• [PHP 8.0] Added support for keywords as parts of namespaced names.

Fixed

• Emit parentheses for class constant fetch with complex left-hand-side.
• Emit parentheses for new/instanceof on complex class expression.

Added

• [PHP 8.0] Added support for nullsafe operator, represented using the new Expr\NullsafePropertyFetch and Expr\NullsafeMethodCall nodes.
• Added phpVersion option to the emulative lexer, which allows controlling the target version to emulate (defaults to the latest available, currently PHP 8.0). This is useful to parse code that uses reserved keywords from newer PHP versions as identifiers.

Added

• Add ParentConnectingVisitor and NodeConnectingVisitor classes.
• [PHP 8.0] Added support for match expressions. These are represented using a new Expr\Match_ containing MatchArms.
• [PHP 8.0] Added support for trailing comma in closure use lists.

Fixed

• Fixed missing error for unterminated comment with trailing newline (#688).
• Compatibility with PHP 8.0 has been restored: Namespaced names are now always represented by T_NAME_* tokens, using emulationg on older PHP versions. Full support for reserved keywords in namespaced names is not yet present.

Added

• [PHP 8.0] Added support for trailing commas in parameter lists.
• [PHP 8.0] Added support for constructor promotion. The parameter visibility is stored in Node\Param::$flags.

Fixed

• Comment tokens now always follow the PHP 8 interpretation, and do not include trailing whitespace.
• As a result of the previous change, some whitespace issues when inserting a statement into a method containing only a comment, and using the formatting-preserving pretty printer, have been resolved.

Added

• [PHP 8.0] Added support for the mixed type. This means mixed types are now parsed as an Identifier rather than a Name.
• [PHP 8.0] Added support for catching without capturing the exception. This means that Catch_::$var may now be null.

Added

• Added support for passing union types in builders.
• Added end line, token position and file position information for comments.
• Added getProperty() method to ClassLike nodes.

Fixed

• Fixed generation of invalid code when using the formatting preserving pretty printer, and inserting code next to certain nop statements. The formatting is still ugly though.
• getDocComment() no longer requires that the very last comment before a node be a doc comment. There may not be non-doc comments between the doc comment and the declaration.
• Allowed arbitrary expressions in isset() and list(), rather than just variables. In particular, this allows isset(($x)), which is legal PHP code.
• [PHP 8.0] Add support for variable syntax tweaks RFC.

Added

• [PHP 8.0] Added support for union types using a new UnionType node.

Changed

• Tests and documentation are no longer included in source archives. They can still be accessed by cloning the repository.
• php-yacc is now used to generate the parser. This has no impact on users of the library.

Added

• Added getProperties(), getConstants() and getTraitUses() to ClassLike. (#629, #630)

Fixed

• Fixed flexible heredoc emulation to check for digits after the end label. This synchronizes behavior with the upcoming PHP 7.3.10 release.

Added

• [PHP 7.4] Add support for numeric literal separators. (#615)

Fixed

• Fixed resolution of return types for arrow functions. (#613)
• Fixed compatibility with PHP 7.4.

Added

• [PHP 7.4] Add support for arrow functions using a new Expr\ArrowFunction node. (#602)
• [PHP 7.4] Add support for array spreads, using a new unpack subnode on ArrayItem. (#609)
• Added support for inserting into empty list nodes in the formatting preserving pretty printer.

Changed

• php-parse will now print messages to stderr, so that stdout only contains the actual result of the operation (such as a JSON dump). (#605)

Fixed

• Fixed attribute assignment for zero-length nop statements, and a related assertion failure in the formatting-preserving pretty printer. (#589)

Added

• [PHP 7.4] Add support for ??= operator through a new AssignOp\Coalesce node. (#575)

Added

• [PHP 7.4] Add support for typed properties through a new type subnode of Stmt\Property. Additionally Builder\Property now has a setType() method. (#567)
• Add kind attribute to Cast\Double_, which allows to distinguish between (float), (double) and (real). The form of the cast will be preserved by the pretty printer. (#565)

Fixed

• Remove assertion when pretty printing anonymous class with a name (#554).

Fixed

• Fix "undefined offset" notice when parsing specific malformed code (#551).

Added

• Support error recovery for missing return type (function foo() : {}) (#544).

Added

• Added support for PHP 7.3 flexible heredoc/nowdoc strings, completing support for PHP 7.3. There are two caveats for this feature:
  • In some rare, pathological cases flexible heredoc/nowdoc strings change the interpretation of existing doc strings. PHP-Parser will now use the new interpretation.
  • Flexible heredoc/nowdoc strings require special support from the lexer. Because this is not available on PHP versions before 7.3, support has to be emulated. This emulation is not perfect and some cases which we do not expect to occur in practice (such as flexible doc strings being nested within each other through abuse of variable-variable interpolation syntax) may not be recognized correctly.
• Added DONT_TRAVERSE_CURRENT_AND_CHILDREN to NodeTraverser to skip both traversal of child nodes, and prevent subsequent visitors from visiting the current node.

Added

• The following methods have been added to BuilderFactory:
  • useTrait() (fluent builder)
  • traitUseAdaptation() (fluent builder)
  • useFunction() (fluent builder)
  • useConst() (fluent builder)
  • var()
  • propertyFetch()

Deprecated

• Builder\Param::setTypeHint() has been deprecated in favor of the newly introduced Builder\Param::setType().

Fixed

• Fixed possible undefined offset notice in formatting-preserving printer. (#513)

Added

• Improved error recovery inside arrays.
• Preserve trailing comment inside classes. Note: This change is possibly BC breaking if your code validates that classes can only contain certain statement types. After this change, classes can also contain Nop statements, while this was not previously possible. (#509)