Chris@0: Version 3.1.3-dev Chris@0: ----------------- Chris@0: Chris@0: Nothing yet. Chris@0: Chris@0: Version 3.1.2 (2017-11-04) Chris@0: -------------------------- Chris@0: Chris@0: ### Fixed Chris@0: Chris@0: * Comments on empty blocks are now preserved on a `Stmt\Nop` node. (#382) Chris@0: Chris@0: ### Added Chris@0: Chris@0: * Added `kind` attribute for `Stmt\Namespace_` node, which is one of `KIND_SEMICOLON` or Chris@0: `KIND_BRACED`. (#417) Chris@0: * Added `setDocComment()` method to namespace builder. (#437) Chris@0: Chris@0: Version 3.1.1 (2017-09-02) Chris@0: -------------------------- Chris@0: Chris@0: ### Fixed Chris@0: Chris@0: * Fixed syntax error on comment after brace-style namespace declaration. (#412) Chris@0: * Added support for TraitUse statements in trait builder. (#413) Chris@0: Chris@0: Version 3.1.0 (2017-07-28) Chris@0: -------------------------- Chris@0: Chris@0: ### Added Chris@0: Chris@0: * [PHP 7.2] Added support for trailing comma in group use statements. Chris@0: * [PHP 7.2] Added support for `object` type. This means `object` types will now be represented as a Chris@0: builtin type (a simple `"object"` string), rather than a class `Name`. Chris@0: Chris@0: ### Fixed Chris@0: Chris@0: * Floating-point numbers are now printed correctly if the LC_NUMERIC locale uses a comma as decimal Chris@0: separator. Chris@0: Chris@0: ### Changed Chris@0: Chris@0: * `Name::$parts` is no longer deprecated. Chris@0: Chris@0: Version 3.0.6 (2017-06-28) Chris@0: -------------------------- Chris@0: Chris@0: ### Fixed Chris@0: Chris@0: * Fixed the spelling of `Class_::VISIBILITY_MODIFIER_MASK`. The previous spelling of Chris@0: `Class_::VISIBILITY_MODIFER_MASK` is preserved for backwards compatibility. Chris@0: * The pretty printing will now preserve comments inside array literals and function calls by Chris@0: printing the array items / function arguments on separate lines. Array literals and functions that Chris@0: do not contain comments are not affected. Chris@0: Chris@0: ### Added Chris@0: Chris@0: * Added `Builder\Param::makeVariadic()`. Chris@0: Chris@0: ### Deprecated Chris@0: Chris@0: * The `Node::setLine()` method has been deprecated. Chris@0: Chris@0: Version 3.0.5 (2017-03-05) Chris@0: -------------------------- Chris@0: Chris@0: ### Fixed Chris@0: Chris@0: * Name resolution of `NullableType`s is now performed earlier, so that a fully resolved signature is Chris@0: available when a function is entered. (#360) Chris@0: * `Error` nodes are now considered empty, while previously they extended until the token where the Chris@0: error occurred. This made some nodes larger than expected. (#359) Chris@0: * Fixed notices being thrown during error recovery in some situations. (#362) Chris@0: Chris@0: Version 3.0.4 (2017-02-10) Chris@0: -------------------------- Chris@0: Chris@0: ### Fixed Chris@0: Chris@0: * Fixed some extensibility issues in pretty printer (`pUseType()` is now public and `pPrec()` calls Chris@0: into `p()`, instead of directly dispatching to the type-specific printing method). Chris@0: * Fixed notice in `bin/php-parse` script. Chris@0: Chris@0: ### Added Chris@0: Chris@0: * Error recovery from missing semicolons is now supported in more cases. Chris@0: * Error recovery from trailing commas in positions where PHP does not support them is now supported. Chris@0: Chris@0: Version 3.0.3 (2017-02-03) Chris@0: -------------------------- Chris@0: Chris@0: ### Fixed Chris@0: Chris@0: * In `"$foo[0]"` the `0` is now parsed as an `LNumber` rather than `String`. (#325) Chris@0: * Ensure integers and floats are always pretty printed preserving semantics, even if the particular Chris@0: value can only be manually constructed. Chris@0: * Throw a `LogicException` when trying to pretty-print an `Error` node. Previously this resulted in Chris@0: an undefined method exception or fatal error. Chris@0: Chris@0: ### Added Chris@0: Chris@0: * [PHP 7.1] Added support for negative interpolated offsets: `"$foo[-1]"` Chris@0: * Added `preserveOriginalNames` option to `NameResolver`. If this option is enabled, an Chris@0: `originalName` attribute, containing the unresolved name, will be added to each resolved name. Chris@0: * Added `php-parse --with-positions` option, which dumps nodes with position information. Chris@0: Chris@0: ### Deprecated Chris@0: Chris@0: * The XML serializer has been deprecated. In particular, the classes `Serializer\XML`, Chris@0: `Unserializer\XML`, as well as the interfaces `Serializer` and `Unserializer` are deprecated. Chris@0: Chris@0: Version 3.0.2 (2016-12-06) Chris@0: -------------------------- Chris@0: Chris@0: ### Fixed Chris@0: Chris@0: * Fixed name resolution of nullable types. (#324) Chris@0: * Fixed pretty-printing of nullable types. Chris@0: Chris@0: Version 3.0.1 (2016-12-01) Chris@0: -------------------------- Chris@0: Chris@0: ### Fixed Chris@0: Chris@0: * Fixed handling of nested `list()`s: If the nested list was unkeyed, it was directly included in Chris@0: the list items. If it was keyed, it was wrapped in `ArrayItem`. Now nested `List_` nodes are Chris@0: always wrapped in `ArrayItem`s. (#321) Chris@0: Chris@0: Version 3.0.0 (2016-11-30) Chris@0: -------------------------- Chris@0: Chris@0: ### Added Chris@0: Chris@0: * Added support for dumping node positions in the NodeDumper through the `dumpPositions` option. Chris@0: * Added error recovery support for `$`, `new`, `Foo::`. Chris@0: Chris@0: Version 3.0.0-beta2 (2016-10-29) Chris@0: -------------------------------- Chris@0: Chris@0: This release primarily improves our support for error recovery. Chris@0: Chris@0: ### Added Chris@0: Chris@0: * Added `Node::setDocComment()` method. Chris@0: * Added `Error::getMessageWithColumnInfo()` method. Chris@0: * Added support for recovery from lexer errors. Chris@0: * Added support for recovering from "special" errors (i.e. non-syntax parse errors). Chris@0: * Added precise location information for lexer errors. Chris@0: * Added `ErrorHandler` interface, and `ErrorHandler\Throwing` and `ErrorHandler\Collecting` as Chris@0: specific implementations. These provide a general mechanism for handling error recovery. Chris@0: * Added optional `ErrorHandler` argument to `Parser::parse()`, `Lexer::startLexing()` and Chris@0: `NameResolver::__construct()`. Chris@0: * The `NameResolver` now adds a `namespacedName` attribute on name nodes that cannot be statically Chris@0: resolved (unqualified unaliased function or constant names in namespaces). Chris@0: Chris@0: ### Fixed Chris@0: Chris@0: * Fixed attribute assignment for `GroupUse` prefix and variables in interpolated strings. Chris@0: Chris@0: ### Changed Chris@0: Chris@0: * The constants on `NameTraverserInterface` have been moved into the `NameTraverser` class. Chris@0: * Due to the error handling changes, the `Parser` interface and `Lexer` API have changed. Chris@0: * The emulative lexer now directly postprocesses tokens, instead of using `~__EMU__~` sequences. Chris@0: This changes the protected API of the lexer. Chris@0: * The `Name::slice()` method now returns `null` for empty slices, previously `new Name([])` was Chris@0: used. `Name::concat()` now also supports concatenation with `null`. Chris@0: Chris@0: ### Removed Chris@0: Chris@0: * Removed `Name::append()` and `Name::prepend()`. These mutable methods have been superseded by Chris@0: the immutable `Name::concat()`. Chris@0: * Removed `Error::getRawLine()` and `Error::setRawLine()`. These methods have been superseded by Chris@0: `Error::getStartLine()` and `Error::setStartLine()`. Chris@0: * Removed support for node cloning in the `NodeTraverser`. Chris@0: * Removed `$separator` argument from `Name::toString()`. Chris@0: * Removed `throw_on_error` parser option and `Parser::getErrors()` method. Use the `ErrorHandler` Chris@0: mechanism instead. Chris@0: Chris@0: Version 3.0.0-beta1 (2016-09-16) Chris@0: -------------------------------- Chris@0: Chris@0: ### Added Chris@0: Chris@0: * [7.1] Function/method and parameter builders now support PHP 7.1 type hints (void, iterable and Chris@0: nullable types). Chris@0: * Nodes and Comments now implement `JsonSerializable`. The node kind is stored in a `nodeType` Chris@0: property. Chris@0: * The `InlineHTML` node now has an `hasLeadingNewline` attribute, that specifies whether the Chris@0: preceding closing tag contained a newline. The pretty printer honors this attribute. Chris@0: * Partial parsing of `$obj->` (with missing property name) is now supported in error recovery mode. Chris@0: * The error recovery mode is now exposed in the `php-parse` script through the `--with-recovery` Chris@0: or `-r` flags. Chris@0: Chris@0: The following changes are also part of PHP-Parser 2.1.1: Chris@0: Chris@0: * The PHP 7 parser will now generate a parse error for `$var =& new Obj` assignments. Chris@0: * Comments on free-standing code blocks will now be retained as comments on the first statement in Chris@0: the code block. Chris@0: Chris@0: Version 3.0.0-alpha1 (2016-07-25) Chris@0: --------------------------------- Chris@0: Chris@0: ### Added Chris@0: Chris@0: * [7.1] Added support for `void` and `iterable` types. These will now be represented as strings Chris@0: (instead of `Name` instances) similar to other builtin types. Chris@0: * [7.1] Added support for class constant visibility. The `ClassConst` node now has a `flags` subnode Chris@0: holding the visibility modifier, as well as `isPublic()`, `isProtected()` and `isPrivate()` Chris@0: methods. The constructor changed to accept the additional subnode. Chris@0: * [7.1] Added support for nullable types. These are represented using a new `NullableType` node Chris@0: with a single `type` subnode. Chris@0: * [7.1] Added support for short array destructuring syntax. This means that `Array` nodes may now Chris@0: appear as the left-hand-side of assignments and foreach value targets. Additionally the array Chris@0: items may now contain `null` values if elements are skipped. Chris@0: * [7.1] Added support for keys in list() destructuring. The `List` subnode `vars` has been renamed Chris@0: to `items` and now contains `ArrayItem`s instead of plain variables. Chris@0: * [7.1] Added support for multi-catch. The `Catch` subnode `type` has been renamed to `types` and Chris@0: is now an array of `Name`s. Chris@0: * `Name::slice()` now supports lengths and negative offsets. This brings it in line with Chris@0: `array_slice()` functionality. Chris@0: Chris@0: ### Changed Chris@0: Chris@0: Due to PHP 7.1 support additions described above, the node structure changed as follows: Chris@0: Chris@0: * `void` and `iterable` types are now stored as strings if the PHP 7 parser is used. Chris@0: * The `ClassConst` constructor changed to accept an additional `flags` subnode. Chris@0: * The `Array` subnode `items` may now contain `null` elements (destructuring). Chris@0: * The `List` subnode `vars` has been renamed to `items` and now contains `ArrayItem`s instead of Chris@0: plain variables. Chris@0: * The `Catch` subnode `type` has been renamed to `types` and is now an array of `Name`s. Chris@0: Chris@0: Additionally the following changes were made: Chris@0: Chris@0: * The `type` subnode on `Class`, `ClassMethod` and `Property` has been renamed to `flags`. The Chris@0: `type` subnode has retained for backwards compatibility and is populated to the same value as Chris@0: `flags`. However, writes to `type` will not update `flags`. Chris@0: * The `TryCatch` subnode `finallyStmts` has been replaced with a `finally` subnode that holds an Chris@0: explicit `Finally` node. This allows for more accurate attribute assignment. Chris@0: * The `Trait` constructor now has the same form as the `Class` and `Interface` constructors: It Chris@0: takes an array of subnodes. Unlike classes/interfaces, traits can only have a `stmts` subnode. Chris@0: * The `NodeDumper` now prints class/method/property/constant modifiers, as well as the include and Chris@0: use type in a textual representation, instead of only showing the number. Chris@0: * All methods on `PrettyPrinter\Standard` are now protected. Previoulsy most of them were public. Chris@0: Chris@0: ### Removed Chris@0: Chris@0: * Removed support for running on PHP 5.4. It is however still possible to parse PHP 5.2-5.4 code Chris@0: while running on a newer version. Chris@0: * The deprecated `Comment::setLine()` and `Comment::setText()` methods have been removed. Chris@0: * The deprecated `Name::set()`, `Name::setFirst()` and `Name::setLast()` methods have been removed. Chris@0: Chris@0: Version 2.1.1 (2016-09-16) Chris@0: -------------------------- Chris@0: Chris@0: ### Changed Chris@0: Chris@0: * The pretty printer will now escape all control characters in the range `\x00-\x1F` inside double Chris@0: quoted strings. If no special escape sequence is available, an octal escape will be used. Chris@0: * The quality of the error recovery has been improved. In particular unterminated expressions should Chris@0: be handled more gracefully. Chris@0: * The PHP 7 parser will now generate a parse error for `$var =& new Obj` assignments. Chris@0: * Comments on free-standing code blocks will no be retained as comments on the first statement in Chris@0: the code block. Chris@0: Chris@0: Version 2.1.0 (2016-04-19) Chris@0: -------------------------- Chris@0: Chris@0: ### Fixed Chris@0: Chris@0: * Properly support `B""` strings (with uppercase `B`) in a number of places. Chris@0: * Fixed reformatting of indented parts in a certain non-standard comment style. Chris@0: Chris@0: ### Added Chris@0: Chris@0: * Added `dumpComments` option to node dumper, to enable dumping of comments associated with nodes. Chris@0: * Added `Stmt\Nop` node, that is used to collect comments located at the end of a block or at the Chris@0: end of a file (without a following node with which they could otherwise be associated). Chris@0: * Added `kind` attribute to `Expr\Exit` to distinguish between `exit` and `die`. Chris@0: * Added `kind` attribute to `Scalar\LNumber` to distinguish between decimal, binary, octal and Chris@0: hexadecimal numbers. Chris@0: * Added `kind` attribtue to `Expr\Array` to distinguish between `array()` and `[]`. Chris@0: * Added `kind` attribute to `Scalar\String` and `Scalar\Encapsed` to distinguish between Chris@0: single-quoted, double-quoted, heredoc and nowdoc string. Chris@0: * Added `docLabel` attribute to `Scalar\String` and `Scalar\Encapsed`, if it is a heredoc or Chris@0: nowdoc string. Chris@0: * Added start file offset information to `Comment` nodes. Chris@0: * Added `setReturnType()` method to function and method builders. Chris@0: * Added `-h` and `--help` options to `php-parse` script. Chris@0: Chris@0: ### Changed Chris@0: Chris@0: * Invalid octal literals now throw a parse error in PHP 7 mode. Chris@0: * The pretty printer takes all the new attributes mentioned in the previous section into account. Chris@0: * The protected `AbstractPrettyPrinter::pComments()` method no longer returns a trailing newline. Chris@0: * The bundled autoloader supports library files being stored in a different directory than Chris@0: `PhpParser` for easier downstream distribution. Chris@0: Chris@0: ### Deprecated Chris@0: Chris@0: * The `Comment::setLine()` and `Comment::setText()` methods have been deprecated. Construct new Chris@0: objects instead. Chris@0: Chris@0: ### Removed Chris@0: Chris@0: * The internal (but public) method `Scalar\LNumber::parse()` has been removed. A non-internal Chris@0: `LNumber::fromString()` method has been added instead. Chris@0: Chris@0: Version 2.0.1 (2016-02-28) Chris@0: -------------------------- Chris@0: Chris@0: ### Fixed Chris@0: Chris@0: * `declare() {}` and `declare();` are not semantically equivalent and will now result in different Chris@0: ASTs. The format case will have an empty `stmts` array, while the latter will set `stmts` to Chris@0: `null`. Chris@0: * Magic constants are now supported as semi-reserved keywords. Chris@0: * A shebang line like `#!/usr/bin/env php` is now allowed at the start of a namespaced file. Chris@0: Previously this generated an exception. Chris@0: * The `prettyPrintFile()` method will not strip a trailing `?>` from the raw data that follows a Chris@0: `__halt_compiler()` statement. Chris@0: * The `prettyPrintFile()` method will not strip an opening `slice()` which takes a subslice of a name. Chris@0: Chris@0: ### Changed Chris@0: Chris@0: * `PhpParser\Parser` is now an interface, implemented by `Parser\Php5`, `Parser\Php7` and Chris@0: `Parser\Multiple`. The `Multiple` parser will try multiple parsers, until one succeeds. Chris@0: * Token constants are now defined on `PhpParser\Parser\Tokens` rather than `PhpParser\Parser`. Chris@0: * The `Name->set()`, `Name->append()`, `Name->prepend()` and `Name->setFirst()` methods are Chris@0: deprecated in favor of `Name::concat()` and `Name->slice()`. Chris@0: * The `NodeTraverser` no longer clones nodes by default. The old behavior can be restored by Chris@0: passing `true` to the constructor. Chris@0: * The constructor for `Scalar` nodes no longer has a default value. E.g. `new LNumber()` should now Chris@0: be written as `new LNumber(0)`. Chris@0: Chris@0: --- Chris@0: Chris@0: **This changelog only includes changes from the 2.0 series. For older changes see the Chris@0: [1.x series changelog](https://github.com/nikic/PHP-Parser/blob/1.x/CHANGELOG.md) and the Chris@0: [0.9 series changelog](https://github.com/nikic/PHP-Parser/blob/0.9/CHANGELOG.md).**