- Added support for declaring functions with name
exit
ordie
, to allow their use in stubs.
- 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.
- Resolve names in
PropertyHook
s in theNameResolver
. - Include the trailing semicolon inside
Stmt\GroupUse
nodes, making them consistent withStmt\Use_
nodes. - Fixed indentation sometimes becoming negative in formatting-preserving pretty printer, resulting
in
ValueError
s.
- [8.4] Added support for
__PROPERTY__
magic constant, represented using aNode\Scalar\MagicConst\Property
node. - [8.4] Added support for property hooks, which are represented using a new
hooks
subnode onNode\Stmt\Property
andNode\Param
, which contains an array ofNode\PropertyHook
. - [8.4] Added support for asymmetric visibility modifiers. Property
flags
can now hold the additional bitsModifiers::PUBLIC_SET
,Modifiers::PROTECTED_SET
andModifiers::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 plainNode\Expr\FuncCall
. - Added support for passing enum values to various builder methods, like
BuilderFactory::val()
.
- 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.
- [8.4] Added support for dereferencing
new
expressions without parentheses.
- Fixed redundant parentheses being added when pretty printing ternary expressions.
- Made some phpdoc types more precise.
- Fix handling of indentation on next line after opening PHP tag in formatting-preserving pretty printer.
- 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.
- 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 toTypeError
s down the line. Now anError
will be thrown early to indicate the problem.
See UPGRADE-5.0 for detailed migration instructions.
- Fixed parent class of
PropertyItem
andUseItem
.
See UPGRADE-5.0 for detailed migration instructions.
- Fixed parsing of empty files.
- Added support for printing additional attributes (like
kind
) inNodeDumper
. - Added
rawValue
attribute toInterpolatedStringPart
and heredoc/nowdocString_
s, which provides the original, unparsed value. It was previously only available for non-interpolated single/double quoted strings. - Added
Stmt\Block
to represent{}
code blocks. Previously, such code blocks were flattened into the parent statements array.Stmt\Block
will not be created for structures that are typically used with code blocks, for exampleif ($x) { $y; }
will be represented as previously, whileif ($x) { { $x; } }
will have an extraStmt\Block
wrapper.
- Use visitor to assign comments. This fixes the long-standing issue where comments were assigned to all nodes sharing a starting position. Now only the outer-most node will hold the comments.
- Don't parse unicode escape sequences when targeting PHP < 7.0.
- Improve NodeDumper performance for large dumps.
- Removed
Stmt\Throw_
node, useExpr\Throw_
insideStmt\Expression
instead. - Removed
ParserFactory::create()
.
See UPGRADE-5.0 for detailed migration instructions.
- Visitors can now be passed directly to the
NodeTraverser
constructor. A separate call toaddVisitor()
is no longer required.
- The minimum host PHP version is now PHP 7.4. It is still possible to parse code from older versions. Property types have been added where possible.
- The
Lexer
no longer accepts options.Lexer\Emulative
only accepts aPhpVersion
. ThestartLexing()
,getTokens()
andhandleHaltCompiler()
methods have been removed. Instead, there is a single methodtokenize()
returning the tokens. - The
Parser::getLexer()
method has been replaced byParser::getTokens()
. - Attribute handling has been moved from the lexer to the parser, and is no longer configurable. The comments, startLine, endLine, startTokenPos, endTokenPos, startFilePos, and endFilePos attributes will always be added.
- The pretty printer now defaults to PHP 7.4 as the target version.
- The pretty printer now indents heredoc/nowdoc strings if the target version is >= 7.3 (flexible heredoc/nowdoc).
- The deprecated
Comment::getLine()
,Comment::getTokenPos()
andComment::getFilePos()
methods have been removed. UseComment::getStartLine()
,Comment::getStartTokenPos()
andComment::getStartFilePos()
instead.
- The
Node::getLine()
method has been deprecated. UseNode::getStartLine()
instead.
See UPGRADE-5.0 for detailed migration instructions.
- [PHP 8.3] Added support for typed constants.
- [PHP 8.3] Added support for readonly anonymous classes.
- Added support for
NodeVisitor::REPLACE_WITH_NULL
. - Added support for CRLF newlines in the pretty printer, using the new
newline
option.
- Use PHP 7.1 as the default target version for the pretty printer.
- Print
else if { }
instead ofelse { if { } }
. - The
leaveNode()
method on visitors is now invoked in reverse order ofenterNode()
. - Moved
NodeTraverser::REMOVE_NODE
etc. toNodeVisitor::REMOVE_NODE
. The old constants are still available for compatibility. - The
Name
subnodeparts
has been replaced byname
, which stores the name as a string rather than an array of parts separated by namespace separators. ThegetParts()
method returns the old representation. - No longer accept strings for types in Node constructors. Instead, either an
Identifier
,Name
orComplexType
must be passed. Comment::getReformattedText()
now normalizes CRLF newlines to LF newlines.
- Don't trim leading whitespace in formatting preserving printer.
- Treat DEL as a label character in the formatting preserving printer depending on the targeted PHP version.
- Fix error reporting in emulative lexer without explicitly specified error handler.
- Gracefully handle non-contiguous array indices in the
Differ
.
See UPGRADE-5.0 for detailed migration instructions.
- [PHP 8.3] Added support for dynamic class constant fetch.
- Added many additional type annotations. PhpStan is now used.
- Added a fuzzing target for PHP-Fuzzer, which was how a lot of pretty printer bugs were found.
- Added
isPromoted()
,isPublic()
,isProtected()
,isPrivate()
andisReadonly()
methods onParam
. - Added support for class constants in trait builder.
- Added
PrettyPrinter
interface. - Added support for formatting preservation when toggling static modifiers.
- The
php-parse
binary now accepts-
as the file name, in which case it will read from stdin.
- The pretty printer now uses a more accurate treatment of unary operator precedence, and will only wrap them in parentheses if required. This allowed fixing a number of other precedence related bugs.
- The pretty printer now respects the precedence of
clone
,throw
and arrow functions. - The pretty printer no longer unconditionally wraps
yield
in parentheses, unless the target version is set to older than PHP 7.0. - Fixed formatting preservation for alternative elseif/else syntax.
- Fixed checks for when it is safe to print strings as heredoc/nowdoc to accommodate flexible doc string semantics.
- The pretty printer now prints parentheses around new/instanceof operands in all required situations.
- Similar, differences in allowed expressions on the LHS of
->
and::
are now taken into account. - Fixed various cases where
\r
at the end of a doc string could be incorrectly merged into a CRLF sequence with a following\n
. __halt_compiler
is no longer recognized as a semi-reserved keyword, in line with PHP behavior.<?=
is no longer recognized as a semi-reserved keyword.- Fix handling of very large overflowing
\u
escape sequences.
- Removed deprecated
Error
constructor taking a line number instead of an attributes array.
See UPGRADE-5.0 for detailed migration instructions.
- PHP 7.1 is now required to run PHP-Parser.
- Formatting of the standard pretty printer has been adjusted to match PSR-12 more closely.
- The internal token representation now uses a
PhpParser\Token
class, which is compatible with PHP 8 token representation (PhpToken
). - Destructuring is now always represented using
Expr\List_
nodes, even if it uses[]
syntax. - Renamed a number of node classes, and moved things that were not real expressions/statements
outside the
Expr
/Stmt
hierarchy. Compatibility shims for the old names have been retained.
- Added
PhpVersion
class, which is accepted in a number of places (e.g. ParserFactory, Parser, Lexer, PrettyPrinter) and gives more precise control over the PHP version being targeted. - Added PHP 8 parser though it only differs from the PHP 7 parser in concatenation precedence.
- Added
Parser::getLexer()
method. - Added a
Modifiers
class, as a replacement forStmt\Class_::MODIFIER_*
. - Added support for returning an array or
REMOVE_NODE
fromNodeVisitor::enterNode()
.
- The PHP 5 parser has been removed. The PHP 7 parser has been adjusted to deal with PHP 5 code more gracefully.
- 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.
- PHP 8.2: Added support for
true
type. - PHP 8.2: Added support for DNF types.
- 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 support for readonly classes.
- Added
rawValue
attribute toLNumber
,DNumber
andString_
nodes, which stores the unparsed value of the literal (e.g."1_000"
rather than1000
).
- Added builders for enums and enum cases.
- NullsafeMethodCall now extends from CallLike.
- The
namespacedName
property populated by theNameResolver
is now declared on relevant nodes, to avoid a dynamic property deprecation warning with PHP 8.2.
- Support reserved keywords as enum cases.
- Support array unpacking in constant expression evaluator.
- [PHP 8.1] Added support for intersection types using a new
IntersectionType
node. Additionally aComplexType
parent class forNullableType
,UnionType
andIntersectionType
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 fromExpr\CallLike
, which provides anisFirstClassCallable()
method to determine whether a placeholder id present.getArgs()
can be used to assert that the call is not a first-class callable and returnsArg[]
rather thanarray<Arg|VariadicPlaceholder>
.
- 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.
- [PHP 8.1] Added support for readonly properties (through a new
MODIFIER_READONLY
). - [PHP 8.1] Added support for final class constants.
- Fixed compatibility with PHP 8.1.
&
tokens are now canonicalized to theT_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG
andT_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG
tokens used in PHP 8.1. This happens unconditionally, regardless of whether the emulative lexer is used.
BuilderFactory::args()
now accepts named arguments.BuilderFactory::attribute()
has been added.- An
addAttribute()
method accepting anAttribute
orAttributeGroup
has been adde to all builders that accept attributes, such asBuilder\Class_
.
NameResolver
now handles enums.PrettyPrinter
now prints backing enum type.- Builder methods for types now property handle
never
type.
- [PHP 8.1] Added support for enums. These are represented using the
Stmt\Enum_
andStmt\EnumCase
nodes. - [PHP 8.1] Added support for never type. This type will now be returned as an
Identifier
rather thanName
. - Added
ClassConst
builder.
- Non-UTF-8 code units in strings will now be hex-encoded.
- Fixed precedence of arrow functions.
- Fixed position information for variable-variables (#741).
- Fixed position information for traits/interfaces preceded by if statement (#738).
- 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 check for token emulation conflicts with other libraries.
- Added support for recovering from a missing semicolon after a property or class constant declaration.
- 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.
- [PHP 8.0] Added support for attributes. These are represented using a new
AttributeGroup
node containingAttribute
nodes. A newattrGroups
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
andParam
. - [PHP 8.0] Added support for nullsafe properties inside interpolated strings, in line with an upstream change.
- Improved compatibility with other libraries that use forward compatibility defines for PHP tokens.
- Added support for removing the first element of a list to the formatting-preserving pretty printer.
- Allow member modifiers as part of namespaced names. These were missed when support for other keywords was added.
- [PHP 8.0] Added support for named arguments, represented using a new
name
subnode onArg
. - [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 usingStmt\Throw_
. - [PHP 8.0] Added support for keywords as parts of namespaced names.
- Emit parentheses for class constant fetch with complex left-hand-side.
- Emit parentheses for new/instanceof on complex class expression.
- [PHP 8.0] Added support for nullsafe operator, represented using the new
Expr\NullsafePropertyFetch
andExpr\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.
- Add
ParentConnectingVisitor
andNodeConnectingVisitor
classes. - [PHP 8.0] Added support for match expressions. These are represented using a new
Expr\Match_
containingMatchArm
s. - [PHP 8.0] Added support for trailing comma in closure use lists.
- 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.
- [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
.
- 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.
- [PHP 8.0] Added support for the mixed type. This means
mixed
types are now parsed as anIdentifier
rather than aName
. - [PHP 8.0] Added support for catching without capturing the exception. This means that
Catch_::$var
may now be null.
- Added support for passing union types in builders.
- Added end line, token position and file position information for comments.
- Added
getProperty()
method toClassLike
nodes.
- 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()
andlist()
, rather than just variables. In particular, this allowsisset(($x))
, which is legal PHP code. - [PHP 8.0] Add support for variable syntax tweaks RFC.
- [PHP 8.0] Added support for union types using a new
UnionType
node.
- 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 getProperties(), getConstants() and getTraitUses() to ClassLike. (#629, #630)
- Fixed flexible heredoc emulation to check for digits after the end label. This synchronizes behavior with the upcoming PHP 7.3.10 release.
- [PHP 7.4] Add support for numeric literal separators. (#615)
- Fixed resolution of return types for arrow functions. (#613)
- Fixed compatibility with PHP 7.4.
- [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 onArrayItem
. (#609) - Added support for inserting into empty list nodes in the formatting preserving pretty printer.
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 attribute assignment for zero-length nop statements, and a related assertion failure in the formatting-preserving pretty printer. (#589)
- [PHP 7.4] Add support for
??=
operator through a newAssignOp\Coalesce
node. (#575)
- [PHP 7.4] Add support for typed properties through a new
type
subnode ofStmt\Property
. AdditionallyBuilder\Property
now has asetType()
method. (#567) - Add
kind
attribute toCast\Double_
, which allows to distinguish between(float)
,(double)
and(real)
. The form of the cast will be preserved by the pretty printer. (#565)
- Remove assertion when pretty printing anonymous class with a name (#554).
- Fix "undefined offset" notice when parsing specific malformed code (#551).
- Support error recovery for missing return type (
function foo() : {}
) (#544).
- 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
toNodeTraverser
to skip both traversal of child nodes, and prevent subsequent visitors from visiting the current node.
- The following methods have been added to
BuilderFactory
:useTrait()
(fluent builder)traitUseAdaptation()
(fluent builder)useFunction()
(fluent builder)useConst()
(fluent builder)var()
propertyFetch()
Builder\Param::setTypeHint()
has been deprecated in favor of the newly introducedBuilder\Param::setType()
.
- Fixed possible undefined offset notice in formatting-preserving printer. (#513)
- 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)
- Improved error recovery inside classes.
- Support error recovery for
foreach
withoutas
. - Support error recovery for parameters without variable (
function (Type ) {}
). - Support error recovery for functions without body (
function ($foo)
).
- [PHP 7.3] Added support for trailing commas in function calls.
- [PHP 7.3] Added support for by-reference array destructuring.
- Added checks to node traverser to prevent replacing a statement with an expression or vice versa. This should prevent common mistakes in the implementation of node visitors.
- Added the following methods to
BuilderFactory
, to simplify creation of expressions:funcCall()
methodCall()
staticCall()
new()
constFetch()
classConstFetch()
- No significant code changes since the beta 1 release.
- In formatting-preserving pretty printer: Fixed indentation when inserting into lists. (#466)
- In formatting-preserving pretty printer: Improved formatting of elements inserted into multi-line arrays.
- The
Autoloader
class has been removed. It is now required to use the Composer autoloader.
- In the formatting-preserving pretty printer:
- Fixed comment indentation.
- Fixed handling of inline HTML in the fallback case.
- Fixed insertion into list nodes that require creation of a code block.
- Added support for inserting at the start of list nodes in formatting-preserving pretty printer.
- In the formatting-preserving pretty printer:
- Added support for changing modifiers.
- Added support for anonymous classes.
- Added support for removing from list nodes.
- Improved support for changing comments.
- Added start token offsets to comments.
- Added experimental support for format-preserving pretty-printing. In this mode formatting will be preserved for parts of the code which have not been modified.
- Added
replaceNodes
option toNameResolver
, defaulting to true. If this option is disabled, resolved names will be added asresolvedName
attributes, instead of replacing the original names. - Added
NodeFinder
class, which can be used to find nodes based on a callback or class name. This is a utility to avoid custom node visitor implementations for simple search operations. - Added
ClassMethod::isMagic()
method. - Added
BuilderFactory
methods:val()
method for creating an AST for a simple value,concat()
for creating concatenation trees,args()
for preparing function arguments. - Added
NameContext
class, which encapsulates theNameResolver
logic independently of the actual AST traversal. This facilitates use in other context, such as class names in doc comments. Additionally it provides an API for getting the shortest representation of a name. - Added
Node::setAttributes()
method. - Added
JsonDecoder
. This allows conversion JSON back into an AST. - Added
Name
methodstoLowerString()
andisSpecialClassName()
. - Added
Identifier
andVarLikeIdentifier
nodes, which are used in place of simple strings in many places. - Added
getComments()
,getStartLine()
,getEndLine()
,getStartTokenPos()
,getEndTokenPos()
,getStartFilePos()
andgetEndFilePos()
methods toNode
. These provide a more obvious access point for the already existing attributes of the same name. - Added
ConstExprEvaluator
to evaluate constant expressions to PHP values. - Added
Expr\BinaryOp::getOperatorSigil()
, returning+
forExpr\BinaryOp\Plus
, etc.
- Many subnodes that previously held simple strings now use
Identifier
(orVarLikeIdentifier
) nodes. Please see the UPGRADE-4.0 file for an exhaustive list of affected nodes and some notes on possible impact. - Expression statements (
expr;
) are now represented using aStmt\Expression
node. Previously these statements were directly represented as their constituent expression. - The
name
subnode ofParam
has been renamed tovar
and now contains aVariable
rather than a plain string. - The
name
subnode ofStaticVar
has been renamed tovar
and now contains aVariable
rather than a plain string. - The
var
subnode ofClosureUse
now contains aVariable
rather than a plain string. - The
var
subnode ofCatch
now contains aVariable
rather than a plain string. - The
alias
subnode ofUseUse
is nownull
if no explicit alias is given. As such,use Foo\Bar
anduse Foo\Bar as Bar
are now represented differently. ThegetAlias()
method can be used to get the effective alias, even if it is not explicitly given.
- Support for running on PHP 5 and HHVM has been removed. You can however still parse code of old PHP versions (such as PHP 5.2), while running on PHP 7.
- Removed
type
subnode onClass
,ClassMethod
andProperty
nodes. Useflags
instead. - The
ClassConst::isStatic()
method has been removed. Constants cannot have a static modifier. - The
NodeTraverser
no longer acceptsfalse
as a return value from aleaveNode()
method.NodeTraverser::REMOVE_NODE
should be returned instead. - The
Node::setLine()
method has been removed. If you really need to, you can usesetAttribute()
instead. - The misspelled
Class_::VISIBILITY_MODIFER_MASK
constant has been dropped in favor ofClass_::VISIBILITY_MODIFIER_MASK
. - The XML serializer has been removed. As such, the classes
Serializer\XML
, andUnserializer\XML
, as well as the interfacesSerializer
andUnserializer
no longer exist. - The
BuilderAbstract
class has been removed. It's functionality is moved intoBuilderHelpers
. However, this is an internal class and should not be used directly.
- Fixed duplicate comment assignment in switch statements. (#469)
- Improve compatibility with PHP-Scoper. (#477)
- Fixed pretty printing of
-(-$x)
and+(+$x)
. (#459)
- Improve compatibility with php-scoper, by supporting prefixed namespaces in
NodeAbstract::getType()
.
- Comments on empty blocks are now preserved on a
Stmt\Nop
node. (#382)
- Added
kind
attribute forStmt\Namespace_
node, which is one ofKIND_SEMICOLON
orKIND_BRACED
. (#417) - Added
setDocComment()
method to namespace builder. (#437)
- Fixed syntax error on comment after brace-style namespace declaration. (#412)
- Added support for TraitUse statements in trait builder. (#413)
- [PHP 7.2] Added support for trailing comma in group use statements.
- [PHP 7.2] Added support for
object
type. This meansobject
types will now be represented as a builtin type (a simple"object"
string), rather than a className
.
- Floating-point numbers are now printed correctly if the LC_NUMERIC locale uses a comma as decimal separator.
Name::$parts
is no longer deprecated.
- Fixed the spelling of
Class_::VISIBILITY_MODIFIER_MASK
. The previous spelling ofClass_::VISIBILITY_MODIFER_MASK
is preserved for backwards compatibility. - The pretty printing will now preserve comments inside array literals and function calls by printing the array items / function arguments on separate lines. Array literals and functions that do not contain comments are not affected.
- Added
Builder\Param::makeVariadic()
.
- The
Node::setLine()
method has been deprecated.
- Name resolution of
NullableType
s is now performed earlier, so that a fully resolved signature is available when a function is entered. (#360) Error
nodes are now considered empty, while previously they extended until the token where the error occurred. This made some nodes larger than expected. (#359)- Fixed notices being thrown during error recovery in some situations. (#362)
- Fixed some extensibility issues in pretty printer (
pUseType()
is now public andpPrec()
calls intop()
, instead of directly dispatching to the type-specific printing method). - Fixed notice in
bin/php-parse
script.
- Error recovery from missing semicolons is now supported in more cases.
- Error recovery from trailing commas in positions where PHP does not support them is now supported.
- In
"$foo[0]"
the0
is now parsed as anLNumber
rather thanString
. (#325) - Ensure integers and floats are always pretty printed preserving semantics, even if the particular value can only be manually constructed.
- Throw a
LogicException
when trying to pretty-print anError
node. Previously this resulted in an undefined method exception or fatal error.
- [PHP 7.1] Added support for negative interpolated offsets:
"$foo[-1]"
- Added
preserveOriginalNames
option toNameResolver
. If this option is enabled, anoriginalName
attribute, containing the unresolved name, will be added to each resolved name. - Added
php-parse --with-positions
option, which dumps nodes with position information.
- The XML serializer has been deprecated. In particular, the classes
Serializer\XML
,Unserializer\XML
, as well as the interfacesSerializer
andUnserializer
are deprecated.
- Fixed name resolution of nullable types. (#324)
- Fixed pretty-printing of nullable types.
- Fixed handling of nested
list()
s: If the nested list was unkeyed, it was directly included in the list items. If it was keyed, it was wrapped inArrayItem
. Now nestedList_
nodes are always wrapped inArrayItem
s. (#321)
- Added support for dumping node positions in the NodeDumper through the
dumpPositions
option. - Added error recovery support for
$
,new
,Foo::
.
This release primarily improves our support for error recovery.
- Added
Node::setDocComment()
method. - Added
Error::getMessageWithColumnInfo()
method. - Added support for recovery from lexer errors.
- Added support for recovering from "special" errors (i.e. non-syntax parse errors).
- Added precise location information for lexer errors.
- Added
ErrorHandler
interface, andErrorHandler\Throwing
andErrorHandler\Collecting
as specific implementations. These provide a general mechanism for handling error recovery. - Added optional
ErrorHandler
argument toParser::parse()
,Lexer::startLexing()
andNameResolver::__construct()
. - The
NameResolver
now adds anamespacedName
attribute on name nodes that cannot be statically resolved (unqualified unaliased function or constant names in namespaces).
- Fixed attribute assignment for
GroupUse
prefix and variables in interpolated strings.
- The constants on
NameTraverserInterface
have been moved into theNameTraverser
class. - Due to the error handling changes, the
Parser
interface andLexer
API have changed. - The emulative lexer now directly postprocesses tokens, instead of using
~__EMU__~
sequences. This changes the protected API of the lexer. - The
Name::slice()
method now returnsnull
for empty slices, previouslynew Name([])
was used.Name::concat()
now also supports concatenation withnull
.
- Removed
Name::append()
andName::prepend()
. These mutable methods have been superseded by the immutableName::concat()
. - Removed
Error::getRawLine()
andError::setRawLine()
. These methods have been superseded byError::getStartLine()
andError::setStartLine()
. - Removed support for node cloning in the
NodeTraverser
. - Removed
$separator
argument fromName::toString()
. - Removed
throw_on_error
parser option andParser::getErrors()
method. Use theErrorHandler
mechanism instead.
- [7.1] Function/method and parameter builders now support PHP 7.1 type hints (void, iterable and nullable types).
- Nodes and Comments now implement
JsonSerializable
. The node kind is stored in anodeType
property. - The
InlineHTML
node now has anhasLeadingNewline
attribute, that specifies whether the preceding closing tag contained a newline. The pretty printer honors this attribute. - Partial parsing of
$obj->
(with missing property name) is now supported in error recovery mode. - The error recovery mode is now exposed in the
php-parse
script through the--with-recovery
or-r
flags.
The following changes are also part of PHP-Parser 2.1.1:
- The PHP 7 parser will now generate a parse error for
$var =& new Obj
assignments. - Comments on free-standing code blocks will now be retained as comments on the first statement in the code block.
- [7.1] Added support for
void
anditerable
types. These will now be represented as strings (instead ofName
instances) similar to other builtin types. - [7.1] Added support for class constant visibility. The
ClassConst
node now has aflags
subnode holding the visibility modifier, as well asisPublic()
,isProtected()
andisPrivate()
methods. The constructor changed to accept the additional subnode. - [7.1] Added support for nullable types. These are represented using a new
NullableType
node with a singletype
subnode. - [7.1] Added support for short array destructuring syntax. This means that
Array
nodes may now appear as the left-hand-side of assignments and foreach value targets. Additionally the array items may now containnull
values if elements are skipped. - [7.1] Added support for keys in list() destructuring. The
List
subnodevars
has been renamed toitems
and now containsArrayItem
s instead of plain variables. - [7.1] Added support for multi-catch. The
Catch
subnodetype
has been renamed totypes
and is now an array ofName
s. Name::slice()
now supports lengths and negative offsets. This brings it in line witharray_slice()
functionality.
Due to PHP 7.1 support additions described above, the node structure changed as follows:
void
anditerable
types are now stored as strings if the PHP 7 parser is used.- The
ClassConst
constructor changed to accept an additionalflags
subnode. - The
Array
subnodeitems
may now containnull
elements (destructuring). - The
List
subnodevars
has been renamed toitems
and now containsArrayItem
s instead of plain variables. - The
Catch
subnodetype
has been renamed totypes
and is now an array ofName
s.
Additionally the following changes were made:
- The
type
subnode onClass
,ClassMethod
andProperty
has been renamed toflags
. Thetype
subnode has retained for backwards compatibility and is populated to the same value asflags
. However, writes totype
will not updateflags
. - The
TryCatch
subnodefinallyStmts
has been replaced with afinally
subnode that holds an explicitFinally
node. This allows for more accurate attribute assignment. - The
Trait
constructor now has the same form as theClass
andInterface
constructors: It takes an array of subnodes. Unlike classes/interfaces, traits can only have astmts
subnode. - The
NodeDumper
now prints class/method/property/constant modifiers, as well as the include and use type in a textual representation, instead of only showing the number. - All methods on
PrettyPrinter\Standard
are now protected. Previously most of them were public.
- Removed support for running on PHP 5.4. It is however still possible to parse PHP 5.2-5.4 code while running on a newer version.
- The deprecated
Comment::setLine()
andComment::setText()
methods have been removed. - The deprecated
Name::set()
,Name::setFirst()
andName::setLast()
methods have been removed.
- The pretty printer will now escape all control characters in the range
\x00-\x1F
inside double quoted strings. If no special escape sequence is available, an octal escape will be used. - The quality of the error recovery has been improved. In particular unterminated expressions should be handled more gracefully.
- The PHP 7 parser will now generate a parse error for
$var =& new Obj
assignments. - Comments on free-standing code blocks will no be retained as comments on the first statement in the code block.
- Properly support
B""
strings (with uppercaseB
) in a number of places. - Fixed reformatting of indented parts in a certain non-standard comment style.
- Added
dumpComments
option to node dumper, to enable dumping of comments associated with nodes. - Added
Stmt\Nop
node, that is used to collect comments located at the end of a block or at the end of a file (without a following node with which they could otherwise be associated). - Added
kind
attribute toExpr\Exit
to distinguish betweenexit
anddie
. - Added
kind
attribute toScalar\LNumber
to distinguish between decimal, binary, octal and hexadecimal numbers. - Added
kind
attribute toExpr\Array
to distinguish betweenarray()
and[]
. - Added
kind
attribute toScalar\String
andScalar\Encapsed
to distinguish between single-quoted, double-quoted, heredoc and nowdoc string. - Added
docLabel
attribute toScalar\String
andScalar\Encapsed
, if it is a heredoc or nowdoc string. - Added start file offset information to
Comment
nodes. - Added
setReturnType()
method to function and method builders. - Added
-h
and--help
options tophp-parse
script.
- Invalid octal literals now throw a parse error in PHP 7 mode.
- The pretty printer takes all the new attributes mentioned in the previous section into account.
- The protected
AbstractPrettyPrinter::pComments()
method no longer returns a trailing newline. - The bundled autoloader supports library files being stored in a different directory than
PhpParser
for easier downstream distribution.
- The
Comment::setLine()
andComment::setText()
methods have been deprecated. Construct new objects instead.
- The internal (but public) method
Scalar\LNumber::parse()
has been removed. A non-internalLNumber::fromString()
method has been added instead.
declare() {}
anddeclare();
are not semantically equivalent and will now result in different ASTs. The format case will have an emptystmts
array, while the latter will setstmts
tonull
.- Magic constants are now supported as semi-reserved keywords.
- A shebang line like
#!/usr/bin/env php
is now allowed at the start of a namespaced file. Previously this generated an exception. - The
prettyPrintFile()
method will not strip a trailing?>
from the raw data that follows a__halt_compiler()
statement. - The
prettyPrintFile()
method will not strip an opening<?php
if the file starts with a comment followed by InlineHTML.
- String parts of encapsed strings are now represented using
Scalar\EncapsStringPart
nodes. Previously raw strings were used. This affects theparts
child ofScalar\Encaps
andExpr\ShellExec
. The change has been done to allow assignment of attributes to encapsed string parts.
- Fixed issue with too many newlines being stripped at the end of heredoc/nowdoc strings in some cases. (#227)
- Update group use support to be in line with recent PHP 7.0 builds.
- Renamed
php-parse.php
tophp-parse
and registered it as a composer bin. - Use composer PSR-4 autoloader instead of custom autoloader.
- Specify phpunit as a dev dependency.
- Added
shortArraySyntax
option to pretty printer, to print all arrays using short syntax.
A more detailed description of backwards incompatible changes can be found in the upgrading guide.
- Removed support for running on PHP 5.3. It is however still possible to parse PHP 5.2 and PHP 5.3 code while running on a newer version.
- Removed legacy class name aliases. This includes the old non-namespaced class names and the old names for classes that were renamed for PHP 7 compatibility.
- Removed support for legacy node format. All nodes must have a
getSubNodeNames()
method now.
- Added support for remaining PHP 7 features that were not present in 1.x:
- Group use declarations. These are represented using
Stmt\GroupUse
nodes. Furthermore atype
attribute was added toStmt\UseUse
to handle mixed group use declarations. - Uniform variable syntax.
- Generalized yield operator.
- Scalar type declarations. These are presented using
'bool'
,'int'
,'float'
and'string'
as the type. The PHP 5 parser also accepts these, however they'll beName
instances there. - Unicode escape sequences.
- Group use declarations. These are represented using
- Added
PhpParser\ParserFactory
class, which should be used to create parser instances. - Added
Name::concat()
which concatenates two names. - Added
Name->slice()
which takes a subslice of a name.
PhpParser\Parser
is now an interface, implemented byParser\Php5
,Parser\Php7
andParser\Multiple
. TheMultiple
parser will try multiple parsers, until one succeeds.- Token constants are now defined on
PhpParser\Parser\Tokens
rather thanPhpParser\Parser
. - The
Name->set()
,Name->append()
,Name->prepend()
andName->setFirst()
methods are deprecated in favor ofName::concat()
andName->slice()
. - The
NodeTraverser
no longer clones nodes by default. The old behavior can be restored by passingtrue
to the constructor. - The constructor for
Scalar
nodes no longer has a default value. E.g.new LNumber()
should now be written asnew LNumber(0)
.
This changelog only includes changes from the 2.0 series. For older changes see the 1.x series changelog and the 0.9 series changelog.