Compare commits

...

108 Commits

Author SHA1 Message Date
dff239267f Release PHP-Parser 1.3.0 2015-05-02 17:40:40 +02:00
8b64195cf2 Try .17G print if .16G is not enough
This should be enough for all cases, because: A double has 53 bits
of mantissa (including the implicit 1 bit), which is 53*ln(2)/ln(10)
= 15.95 decimal digits. However the leading decimal digit may encode
less than the usual 3.32 bits, which will push this over the edge to
requiring 17 decimal digits.
2015-05-02 11:48:55 +02:00
9caa51b3a5 Add some more tests 2015-05-01 20:18:04 +02:00
5513073a53 Drop Lexer::getPosition()
This was a leftover from the original column info implementation.
2015-05-01 20:18:01 +02:00
659d26c231 Update changelog, fix typos 2015-05-01 19:57:10 +02:00
648800f07f Increase float pretty printing precision
This removes the reliance on the "precision" ini setting.
Furthermore the default of precision=14 is not sufficient.
2015-05-01 19:15:33 +02:00
23bf4f0c13 Add some error documentation 2015-04-30 21:58:45 +02:00
57ac7e39bf Drop name magic from rebuildParser.php
Now using explicitly imported names, instead of magically
prepending Name\.

Also remove trailing whitespace from generated file.
2015-04-30 19:20:38 +02:00
272ab6c8d8 Add some recovery tests 2015-04-30 19:02:51 +02:00
0731b47655 Don't distinguish test-fail / test
With error recovery this is fluid. Using .test for everything.
2015-04-30 17:45:36 +02:00
3b7d8e8b5d Enable basic error recovery
Adding only a single recovery rule for now.

The API is now:
 * throwOnError parser option must be disabled.
 * List of Errors is available through $parser->getErrors(). This
   method is available either way.
 * If no recovery is possible $parser->parse() will return null.
   (Obviously only if throwOnError is disabled).
2015-04-30 17:41:57 +02:00
a35c2a2067 Add column info to EOF errors
EOF errors are now located one past the end of the file.
2015-04-27 15:37:41 +02:00
55b2ead967 Make special class name checks case insensitive 2015-04-26 23:13:27 +02:00
e1a0ec3724 Add support for anonymous classes
Has not landed upstream yet, but syntax is unlikely to change.
2015-04-26 23:04:31 +02:00
66896dbde6 Poison attribute initializations in parser
Those should error if they end up being used.
2015-04-26 22:32:18 +02:00
338bc1f8e7 Fix "print" pretty-printing
Precedence was previously ignored.
2015-04-26 11:56:04 +02:00
ab80054e97 Add support for "yield from" 2015-04-26 11:56:02 +02:00
a6d2cd69f8 Clarify attribute assignment code
* Don't assign to attribute stack on reduce - why was that there
in the first place?
* Assign attributes to the position in the stack where the first
token of the production is, instead of one position earlier.
* Add a comment to clarify why we also assign attributes on read,
instead of just on shift.
2015-04-26 11:56:01 +02:00
6996db1e3a Build node attributes inside semantic action methods
Minor performance improvement for parsing, also allows to access
attributes with higher granulity in the parser, though this is not
currently done.

* #n can now be used to access the stack position of a token. $n
  is the same as $this->semStack[#n]. (Post-translate $n will
  actually be the stack position.)
* $attributeStack is now $this->startAttributeStack and
  $endAttributes is now $this->endAttributes.
* Attributes for a node are now computed inside the individual
  reduction methods, instead of being passed as a parameter.
  Accessible through the attributes() macro.
2015-04-26 11:55:59 +02:00
e30c3ac01b Merge pull request #195 from GrahamCampbell/patch-1
Bump version to 1.3
2015-04-19 20:52:51 +02:00
a5477a4eaf Version bump 2015-04-19 17:57:38 +01:00
7a40498cb4 Regenerate parser
Also drop the error() parser macro.
2015-04-19 18:12:56 +02:00
65f1adbe65 Merge primary error recovery code
The grammar does not yet actually implement error recovery.
2015-04-19 18:11:05 +02:00
c8454271e1 Make column info 1-based 2015-04-18 21:20:45 +02:00
62f83a0dc2 Add column info for non-syntax errors where relatively precise
Should it also be added if only rough information is available? E.g.
spanning an entire class?
2015-04-18 13:27:58 +02:00
611fa5c7f1 Test parser position information (syntax errors) 2015-04-18 13:27:57 +02:00
4defbc2174 Make Error column info attribute based 2015-04-18 12:51:26 +02:00
33a39fae06 added column-numbers to syntax errors 2015-04-18 10:14:49 +02:00
e4eab9ec0c Simplify code
The new class couldn't already exist at that point - if it did, the
old name would have been aliased already and the autoloader wouldn't
trigger.
2015-04-03 22:30:30 +02:00
6aaa87f143 Fix PHP 7 alias registration
This fixes the case where the old name is used before the new one
is ever used, e.g. when manually constructing nodes, as opposed to
parsing them.

The previous approach would try to register the alias from OLD to
NEW. This would trigger autoloading on NEW and afterwards it would
register the alias from OLD to NEW. Afterwards the alias registration
which originally triggered the autoload would run, thus redeclaring
the class.

TL;DR aliases suck, closes #192.
2015-04-03 22:22:39 +02:00
08f97eb4ef Release PHP-Parser 1.2.2 2015-04-03 16:33:59 +02:00
8d18848fb0 Don't set unserialize_callback_func in Autoloader::register() as it has side effects even when the library is not used 2015-04-03 16:25:33 +02:00
805078e0a9 Add missing type hints 2015-03-28 18:14:24 +01:00
52dafafd10 Resolve param type hints earlier
For convenience of concurrent visitors that want to perform
enterNode actions based on Stmt\Function_ etc.

Fixes #188.
2015-03-25 20:57:39 +01:00
dba7524b37 Release PHP-Parser 1.2.1 2015-03-24 20:10:28 +01:00
617bf0aa41 Fix registering of PHP 7 aliases
The previous approach was causing issues, because "instanceof"
does not invoke the autoloader.
2015-03-24 20:04:50 +01:00
dce19b074b Strict type compliance
Were this library to be fully annotated with scalar types and
return types where possible and were strict types to be enabled
for all files, the test suite would now pass.
2015-03-24 11:19:17 +01:00
edbf162e4c Release PHP-Parser 1.2.0 2015-03-22 17:17:25 +01:00
b23c53df5f Update CHANGELOG 2015-03-22 16:03:59 +01:00
cea0c4a9d6 Don't register aliases on PHP 7 2015-03-22 16:03:57 +01:00
879e8dcd6d Merge pull request #186 from mnapoli/clone-nodes
Added a flag to NodeTraverser to avoid cloning nodes
2015-03-22 15:19:10 +01:00
729c7bde0c #184 Add a flag to NodeTraverser to avoid cloning nodes 2015-03-22 11:19:04 +13:00
8982315b4e Rename Cast\Object as well
As it will very likely be soft-reserved in PHP 7.

Old alias is still available, as usual.
2015-03-21 18:57:55 +01:00
0f556c16f5 Fix a few more Scalar\String_ occurances
Totally forgot that the parser uses macros...
2015-03-21 18:54:52 +01:00
7ec277e1e1 Replace another Scalar\String occurance
Also canonicalize NameResover tests to avoid those pesky CRLF
issues.
2015-03-21 18:47:20 +01:00
1a627872f0 Rename nodes for compat with PHP 7
The old names will still be available on PHP 5.x.
2015-03-20 21:49:38 +01:00
592836c4dc Add support for T_HASHBANG (HHVM) 2015-03-14 19:53:08 +01:00
68defc2c6a Merge pull request #183 from alprs/fix-autoloader
Ensure compatibility with multiple composer autoloaders
2015-03-14 09:07:35 +01:00
d225555830 Ensure compatibility with multiple autoloaders
Running a .phar or regular PHP executable that requires and includes its own
version of php-parser will cause a "cannot redeclare class" error if said
executable also includes the autoloader of the current working directory.
2015-03-13 23:54:32 +01:00
251e689283 Add support for spaceship operator (<=>) [PHP 7]
Added as Expr\BinaryOp\Spaceship.
2015-03-12 23:13:31 +01:00
01f4be6b4d Add support for null coalesce operator (??) [PHP 7]
Added as Expr\BinaryOp\Coalesce.
2015-03-12 22:45:56 +01:00
dc28449d81 Drop whitespace after ... varargs collection
Also drop an obsolete pretty printer test.
2015-03-12 22:19:34 +01:00
3ad0d4b310 Add support for return type declarations [PHP 7]
This adds an additional "returnType" subnode to Stmt\Function_,
Stmt\ClassMethod and Expr\Closure, as well as the corresponding
support in the name resolver and pretty printer.
2015-03-12 22:16:12 +01:00
4dbf067b4b Add a few more string interpolation tests
Originally wanted to simplify the pretty-printer output, but ...
edge cases everywhere :/
2015-03-11 20:01:26 +01:00
5567f0ab3b Add documentation TOC to readme 2015-03-10 21:32:21 +01:00
0c34706799 Add "use" builder 2015-03-10 16:05:55 +01:00
f9fc2fc9ee Add support for global namespace in NS builder
NULL argument can now be used to create a global namespace {} block.
2015-03-10 15:28:19 +01:00
a2d7e8977a Use real properties for storing subnodes
Instead of storing subnodes in a subNodes dictionary, they are
now stored as simple properties. This requires declarating the
properties, assigning them in the constructor, overriding
the getSubNodeNames() method and passing NULL to the first argument
of the NodeAbstract constructor.

[Deprecated: It's still possible to use the old mode of operation
for custom nodes by passing an array of subnodes to the constructor.]

The only behavior difference this should cause is that getSubNodeNames()
will always return the original subnode names and skip any additional
properties that were dynamically added. E.g. this means that the
"namespacedName" node added by the NameResolver visitor is not treated
as a subnode, but as a dynamic property instead.

This change improves performance and memory usage.
2015-03-09 08:54:20 +01:00
73cace360d Implicit public should not generate as explicit public 2015-03-08 20:21:01 +01:00
c96636d192 Revert "Create .gitattributes with basic export-ignores"
This reverts commit 0dd2b9a74c.

Not having tests available causes issues for downstream
distributors. See issue #178.
2015-03-08 19:38:13 +01:00
d56ff5a351 Fix lexer tests for HHVM
HHVM does not throw warnings from token_get_all()
for invalid chars and unterminated comments. This
is not really integral functionality, so I'm okay
to just skip it to get a passing HHVM build.
2015-02-26 19:19:40 +01:00
3028bc8081 And make it work on PHP 5 as well... 2015-02-26 16:40:21 +01:00
91295a0790 Make tests compatible with PHP 7
When parsing on PHP 7 we will no longer be able to deal with
code that contains invalid octal literals. Currently we'll fatal,
after engine exceptions land we'll throw an exception instead.
2015-02-26 16:26:29 +01:00
d600c60779 Add PHP 7 to travis build 2015-02-26 15:25:34 +01:00
e3bc5b564d Added php shebang 2015-02-24 21:43:12 +01:00
53eac36a3f Merge pull request #175 from staabm/patch-1
prevent a unnecessary concat
2015-02-13 18:03:18 +01:00
ce5c76d79b prevent a unnecessary concat
analog to b7ffdbbb92
2015-02-13 16:02:54 +01:00
b7ffdbbb92 Optimize node dumper
For very deeply nested node trees this extra concatenation makes a
huge difference...
2015-02-13 15:20:25 +01:00
8f1eacdab7 Increase recommended xdebug.max_nesting_level
Looks like 2000 is not quite enough for some cases...
2015-02-13 15:04:00 +01:00
1366e833a1 Move getMethods() to new ClassLike node
Class_, Interface_ and Trait_ extend the ClassLike node, which
provides the getMethods() method.
2015-01-31 22:59:38 +01:00
6930feac43 Add some tests for pretty printing expressions 2015-01-18 19:57:09 +01:00
54275ad181 Merge pull request #167 from GrahamCampbell/patch-1
Fixed branch alias
2015-01-18 12:54:05 +01:00
21ca7eaf1b Fixed branch alias 2015-01-18 11:46:36 +00:00
a86779198f Fix branch alias (maybe?) 2015-01-18 12:41:16 +01:00
ac05ef6f95 Release PHP-Parser 1.1 2015-01-18 12:29:59 +01:00
74251fca9f Update changelog 2015-01-18 00:11:19 +01:00
0a445c7656 Test lexer returning invalid token 2015-01-18 00:11:10 +01:00
a710f32a6a Make Node\Expr\BinOp an abstract class
Only the children should be used ...
2015-01-18 00:10:02 +01:00
9689763e20 Cover both DONT_TRAVERSE_CHILDREN cases 2015-01-18 00:10:01 +01:00
1a63a915f2 Merge pull request #163 from rmruano/gitattributes
Create .gitattributes with basic export-ignores
2015-01-11 22:34:05 +01:00
4071c4645d Add NodeTraverser::DONT_TRAVERSE_CHILDREN support 2015-01-11 22:13:58 +01:00
f56db26d8b Doc fixes 2015-01-11 21:39:02 +01:00
0dd2b9a74c Create .gitattributes with basic export-ignores 2015-01-09 21:19:19 +01:00
4cd2b95a23 Fix 5.3 build and some small cleanups 2014-12-19 18:54:56 +01:00
7ab88416ac Enforce Name|string for names in builders
While array (with name components) could technically be allowed (as
they are supported by the Name node itself), more likely than not
an array would due to incorrect usage of the API (e.g. array instead
of variadics).
2014-12-19 18:50:16 +01:00
ba625063e7 Support fully-qualified and ns-relative names in builders 2014-12-19 18:48:21 +01:00
b4b93ccb21 Add integration test for builders 2014-12-19 18:35:19 +01:00
01643e06d3 Add namespace builder 2014-12-19 18:19:33 +01:00
4387454fe0 Add trait builder (for completeness...) 2014-12-19 17:59:23 +01:00
55fdbc6dbc Extract common builder methods to abstract classes
Declaration for fns/classes in general and FunctionLike for
functions/methods in particular.
2014-12-19 17:47:51 +01:00
e69c9ee38c Fix attribute assigment test with crlf newlines 2014-12-19 17:28:22 +01:00
894c3f787d Add test for attribute assignment by parser
Weird that this wasn't tested yet...
2014-12-19 00:37:38 +01:00
a7797918b8 Update lexer docs for attribute options 2014-12-19 00:37:37 +01:00
46975107a7 Support token position attributes in lexer
Also change endFilePos semantics to refer to the last character that
is *included* in the token, rather than one past the last character.
This ensures that all end* attributes have the same semantics.
2014-12-19 00:37:36 +01:00
e0f3e8a492 Merge pull request #160 from jamiehannaford/patch-1
Fix apostrophe
2014-12-15 14:23:36 +01:00
158322e1e4 Fix apostrophe 2014-12-15 10:05:52 +00:00
2438848487 Add support for doc comments in builders 2014-12-13 13:44:40 +01:00
f5432a76b6 Add a a reference to PrettyPrinter to code generation doc
The `$prettyPrinter` variable was undefined in the doc.

Also, the PrettyPrinter was mentioned as `default`, but it's `Standard`, actually.
2014-12-13 13:06:36 +01:00
800d278369 Merge pull request #152 from Fullmetal5/master
Add line returns in php-parse help message
2014-11-27 21:30:29 +01:00
8507af6f4a Add missing require in tests
Test files aren't autoloaded, so this was order-dependent.
2014-11-27 21:01:56 +01:00
7c98ad6f9b Support file offsets in emulative lexer as well
Also run normal lexer tests against emulative lexer and fix a bug
in __halt_compiler() handling found as a result.
2014-11-27 20:57:38 +01:00
d774dbc1b7 Add optional startFilePos and endFilePos attributes
The lexer can now optionally add startFilePos and endFilePos
attributes, which are offsets in to the lexed code string.

The end offset currently points one past the last character of
the token - this is pending further discussion.

The attributes are not added by default and have to be enabled
using the new 'usedAttributes' lexer option:

	$lexer = new Lexer([
		'usedAttributes' => [
			'comments', 'startLine', 'endLine',
			'startFilePos', 'endFilePos'
		]
	]);
2014-11-27 20:38:29 +01:00
1a93cc3b9d Add line returns
Add line returns to the help message so that the terminal won't end up on the same line.
2014-11-25 19:03:35 -06:00
e26e63e9b0 Error on final or abstract properties 2014-11-13 20:25:52 +01:00
0f69f12b94 Use "public" visibility when not explicitly given
Fixes issue #143
2014-11-13 20:21:21 +01:00
a8ffc6fcfc Release PHP-Parser 1.0.2 2014-11-04 23:12:46 +01:00
7fbdb79a08 Fix whitespace when printing trait alias modifiers 2014-11-03 16:16:15 +01:00
6fad8ff32a Make NameResolver resolve trait alias and precedence names 2014-11-03 16:06:43 +01:00
221 changed files with 7156 additions and 3752 deletions

View File

@ -5,9 +5,10 @@ php:
- 5.4 - 5.4
- 5.5 - 5.5
- 5.6 - 5.6
- 7.0
- hhvm - hhvm
matrix: matrix:
allow_failures: allow_failures:
- php: hhvm - php: 7.0
fast_finish: true fast_finish: true

View File

@ -1,9 +1,129 @@
Version 1.0.2-dev Version 1.3.1-dev
----------------- -----------------
Nothing yet. Nothing yet.
Version 1.0.1 (14.10.2014) Version 1.3.0 (2015-05-02)
--------------------------
### Added
* Errors can now store the attributes of the node/token where the error occurred. Previously only the start line was
stored.
* If file positions are enabled in the lexer, errors can now provide column information if it is available. See
[documentation](https://github.com/nikic/PHP-Parser/blob/master/doc/component/Error.markdown#column-information).
* The parser now provides an experimental error recovery mode, which can be enabled by disabling the `throwOnError`
parser option. In this mode the parser will try to construct a partial AST even if the code is not valid PHP. See
[documentation](https://github.com/nikic/PHP-Parser/blob/master/doc/component/Error.markdown#error-recovery).
* Added support for PHP 7 `yield from` expression. It is represented by `Expr\YieldFrom`.
* Added support for PHP 7 anonymous classes. These are represented by ordinary `Stmt\Class_` nodes with the name set to
`null`. Furthermore this implies that `Expr\New_` can now contain a `Stmt\Class_` in its `class` subnode.
### Fixed
* Fixed registration of PHP 7 aliases, for the case where the old name was used before the new name.
* Fixed handling of precedence when pretty-printing `print` expressions.
* Floating point numbers are now pretty-printed with a higher precision.
* Checks for special class names like `self` are now case-insensitive.
Version 1.2.2 (2015-04-03)
--------------------------
* The `NameResolver` now resolves parameter type hints when entering the function/method/closure node. As such other
visitors running after it will be able to make use of the resolved names at that point already.
* The autoloader no longer sets the `unserialize_callback_func` ini option on registration - this is not necessary and
may cause issues when running PhpUnit tests with process isolation.
Version 1.2.1 (2015-03-24)
--------------------------
* Fixed registration of the aliases introduced in 1.2.0. Previously the old class names could not be used in
`instanceof` checks under some circumstances.
Version 1.2.0 (2015-03-22)
--------------------------
### Changed
* To ensure compatibility with PHP 7, the following node classes have been renamed:
OLD => NEW
PhpParser\Node\Expr\Cast\Bool => PhpParser\Node\Expr\Cast\Bool_
PhpParser\Node\Expr\Cast\Int => PhpParser\Node\Expr\Cast\Int_
PhpParser\Node\Expr\Cast\Object => PhpParser\Node\Expr\Cast\Object_
PhpParser\Node\Expr\Cast\String => PhpParser\Node\Expr\Cast\String_
PhpParser\Node\Scalar\String => PhpParser\Node\Scalar\String_
**The previous class names are still supported as aliases.** However it is strongly encouraged to use the new names
in order to make your code compatible with PHP 7.
* Subnodes are now stored using real properties instead of an array. This improves performance and memory usage of the
initial parse and subsequent node tree operations. The `NodeAbstract` class still supports the old way of specifying
subnodes, however this is *deprecated*. In any case properties that are assigned to a node after creation will no
longer be considered as subnodes.
* Methods and property declarations will no longer set the `Stmt\Class_::MODIFIER_PUBLIC` flag if no visibility is
explicitly given. However the `isPublic()` method will continue to return true. This allows you to distinguish whether
a method/property is explicitly or implicitly public and control the pretty printer output more precisely.
* The `Stmt\Class_`, `Stmt\Interface_` and `Stmt\Trait_` nodes now inherit from `Stmt\ClassLike`, which provides a
`getMethods()` method. Previously this method was only available on `Stmt\Class_`.
* Support including the `bootstrap.php` file multiple times.
* Make documentation and tests part of the release tarball again.
* Improve support for HHVM and PHP 7.
### Added
* Added support for PHP 7 return type declarations. This adds an additional `returnType` subnode to `Stmt\Function_`,
`Stmt\ClassMethod` and `Expr\Closure`.
* Added support for the PHP 7 null coalesce operator `??`. The operator is represented by `Expr\BinaryOp\Coalesce`.
* Added support for the PHP 7 spaceship operator `<=>`. The operator is represented by `Expr\BinaryOp\Spaceship`.
* Added use builder.
* Added global namespace support to the namespace builder.
* Added a constructor flag to `NodeTraverser`, which disables cloning of nodes.
Version 1.1.0 (2015-01-18)
--------------------------
* Methods that do not specify an explicit visibility (e.g. `function method()`) will now have the `MODIFIER_PUBLIC`
flag set. This also means that their `isPublic()` method will return true.
* Declaring a property as abstract or final is now an error.
* The `Lexer` and `Lexer\Emulative` classes now accept an `$options` array in their constructors. Currently only the
`usedAttributes` option is supported, which determines which attributes will be added to AST nodes. In particular
it is now possible to add information on the token and file positions corresponding to a node. For more details see
the [Lexer component](https://github.com/nikic/PHP-Parser/blob/master/doc/component/Lexer.markdown) documentation.
* Node visitors can now return `NodeTraverser::DONT_TRAVERSE_CHILDREN` from `enterNode()` in order to skip all children
of the current node, for all visitors.
* Added builders for traits and namespaces.
* The class, interface, trait, function, method and property builders now support adding doc comments using the
`setDocComment()` method.
* Added support for fully-qualified and namespace-relative names in builders. No longer allow use of name component
arrays.
* Do not add documentation and tests to distribution archive files.
Version 1.0.2 (2014-11-04)
--------------------------
* The `NameResolver` visitor now also resolves names in trait adaptations (aliases and precedence declarations).
* Remove stray whitespace when pretty-printing trait adaptations that only change visibility.
Version 1.0.1 (2014-10-14)
-------------------------- --------------------------
* Disallow `new` expressions without a class name. Previously `new;` was accidentally considered to be valid code. * Disallow `new` expressions without a class name. Previously `new;` was accidentally considered to be valid code.
@ -14,14 +134,14 @@ Version 1.0.1 (14.10.2014)
* Prevent truncation of `var_dump()` output in the `php-parse.php` script if XDebug is used. * Prevent truncation of `var_dump()` output in the `php-parse.php` script if XDebug is used.
Version 1.0.0 (12.09.2014) Version 1.0.0 (2014-09-12)
-------------------------- --------------------------
* [BC] Removed deprecated `Template` and `TemplateLoader` classes. * [BC] Removed deprecated `Template` and `TemplateLoader` classes.
* Fixed XML unserializer to properly work with new namespaced node names. * Fixed XML unserializer to properly work with new namespaced node names.
Version 1.0.0-beta2 (31.08.2014) Version 1.0.0-beta2 (2014-08-31)
-------------------------------- --------------------------------
* [PHP 5.6] Updated support for constant scalar expressions to comply with latest changes. This means that arrays * [PHP 5.6] Updated support for constant scalar expressions to comply with latest changes. This means that arrays
@ -46,7 +166,7 @@ Version 1.0.0-beta2 (31.08.2014)
`lib/PhpParser/Parser.php`). Furthermore the parser now uses meaningful variable names and contains comments `lib/PhpParser/Parser.php`). Furthermore the parser now uses meaningful variable names and contains comments
explaining their usage. explaining their usage.
Version 1.0.0-beta1 (27.03.2014) Version 1.0.0-beta1 (2014-03-27)
-------------------------------- --------------------------------
* [BC] PHP-Parser now requires PHP 5.3 or newer to run. It is however still possible to *parse* PHP 5.2 source code, * [BC] PHP-Parser now requires PHP 5.3 or newer to run. It is however still possible to *parse* PHP 5.2 source code,
@ -105,4 +225,4 @@ Version 1.0.0-beta1 (27.03.2014)
**This changelog only includes changes from the 1.0 series. For older changes see the [0.9 series changelog][1].** **This changelog only includes changes from the 1.0 series. For older changes see the [0.9 series changelog][1].**
[1]: https://github.com/nikic/PHP-Parser/blob/0.9/CHANGELOG.md [1]: https://github.com/nikic/PHP-Parser/blob/0.9/CHANGELOG.md

View File

@ -1,10 +1,10 @@
PHP Parser PHP Parser
========== ==========
This is a PHP 5.2 to PHP 5.6 parser written in PHP. It's purpose is to simplify static code analysis and This is a PHP 5.2 to PHP 5.6 parser written in PHP. Its purpose is to simplify static code analysis and
manipulation. manipulation.
[**Documentation for version 1.0.x**][doc_master] (stable; for running on PHP >= 5.3). [**Documentation for version 1.x**][doc_master] (stable; for running on PHP >= 5.3).
[Documentation for version 0.9.x][doc_0_9] (unsupported; for running on PHP 5.2). [Documentation for version 0.9.x][doc_0_9] (unsupported; for running on PHP 5.2).
@ -70,7 +70,18 @@ programming errors or security issues).
Additionally, you can convert a syntax tree back to PHP code. This allows you to do code preprocessing Additionally, you can convert a syntax tree back to PHP code. This allows you to do code preprocessing
(like automatedly porting code to older PHP versions). (like automatedly porting code to older PHP versions).
So, that's it, in a nutshell. You can find everything else in the [docs][doc_master]. Documentation
-------------
1. [Introduction](doc/0_Introduction.markdown)
2. [Installation](doc/1_Installation.markdown)
3. [Usage of basic components](doc/2_Usage_of_basic_components.markdown)
4. [Other node tree representations](doc/3_Other_node_tree_representations.markdown)
5. [Code generation](doc/4_Code_generation.markdown)
Component documentation:
1. [Lexer](doc/component/Lexer.markdown)
[doc_0_9]: https://github.com/nikic/PHP-Parser/tree/0.9/doc [doc_0_9]: https://github.com/nikic/PHP-Parser/tree/0.9/doc
[doc_master]: https://github.com/nikic/PHP-Parser/tree/master/doc [doc_master]: https://github.com/nikic/PHP-Parser/tree/master/doc

46
bin/php-parse.php Normal file → Executable file
View File

@ -1,15 +1,16 @@
#!/usr/bin/env php
<?php <?php
require __DIR__ . '/../lib/bootstrap.php'; require __DIR__ . '/../lib/bootstrap.php';
ini_set('xdebug.max_nesting_level', 2000); ini_set('xdebug.max_nesting_level', 3000);
// Disable XDebug var_dump() output truncation // Disable XDebug var_dump() output truncation
ini_set('xdebug.var_display_max_children', -1); ini_set('xdebug.var_display_max_children', -1);
ini_set('xdebug.var_display_max_data', -1); ini_set('xdebug.var_display_max_data', -1);
ini_set('xdebug.var_display_max_depth', -1); ini_set('xdebug.var_display_max_depth', -1);
list($operations, $files) = parseArgs($argv); list($operations, $files, $attributes) = parseArgs($argv);
/* Dump nodes by default */ /* Dump nodes by default */
if (empty($operations)) { if (empty($operations)) {
@ -20,7 +21,10 @@ if (empty($files)) {
showHelp("Must specify at least one file."); showHelp("Must specify at least one file.");
} }
$parser = new PhpParser\Parser(new PhpParser\Lexer\Emulative); $lexer = new PhpParser\Lexer\Emulative(array('usedAttributes' => array(
'startLine', 'endLine', 'startFilePos', 'endFilePos'
)));
$parser = new PhpParser\Parser($lexer);
$dumper = new PhpParser\NodeDumper; $dumper = new PhpParser\NodeDumper;
$prettyPrinter = new PhpParser\PrettyPrinter\Standard; $prettyPrinter = new PhpParser\PrettyPrinter\Standard;
$serializer = new PhpParser\Serializer\XML; $serializer = new PhpParser\Serializer\XML;
@ -44,7 +48,17 @@ foreach ($files as $file) {
try { try {
$stmts = $parser->parse($code); $stmts = $parser->parse($code);
} catch (PhpParser\Error $e) { } catch (PhpParser\Error $e) {
die("==> Parse Error: {$e->getMessage()}\n"); if ($attributes['with-column-info'] && $e->hasColumnInfo()) {
$startLine = $e->getStartLine();
$endLine = $e->getEndLine();
$startColumn = $e->getStartColumn($code);
$endColumn = $e->getEndColumn($code);
$message .= $e->getRawMessage() . " from $startLine:$startColumn to $endLine:$endColumn";
} else {
$message = $e->getMessage();
}
die($message . "\n");
} }
foreach ($operations as $operation) { foreach ($operations as $operation) {
@ -80,17 +94,20 @@ The file arguments can also be replaced with a code string:
Operations is a list of the following options (--dump by default): Operations is a list of the following options (--dump by default):
--dump -d Dump nodes using NodeDumper --dump -d Dump nodes using NodeDumper
--pretty-print -p Pretty print file using PrettyPrinter\Standard --pretty-print -p Pretty print file using PrettyPrinter\Standard
--serialize-xml Serialize nodes using Serializer\XML --serialize-xml Serialize nodes using Serializer\XML
--var-dump var_dump() nodes (for exact structure) --var-dump var_dump() nodes (for exact structure)
--resolve-names -N Resolve names using NodeVisitor\NameResolver --resolve-names -N Resolve names using NodeVisitor\NameResolver
--with-column-info -c Show column-numbers for errors (if available)
Example: Example:
php php-parse.php -d -p -N -d file.php php php-parse.php -d -p -N -d file.php
Dumps nodes, pretty prints them, then resolves names and dumps them again. Dumps nodes, pretty prints them, then resolves names and dumps them again.
OUTPUT OUTPUT
); );
} }
@ -98,6 +115,9 @@ OUTPUT
function parseArgs($args) { function parseArgs($args) {
$operations = array(); $operations = array();
$files = array(); $files = array();
$attributes = array(
'with-column-info' => false,
);
array_shift($args); array_shift($args);
$parseOptions = true; $parseOptions = true;
@ -126,6 +146,10 @@ function parseArgs($args) {
case '-N'; case '-N';
$operations[] = 'resolve-names'; $operations[] = 'resolve-names';
break; break;
case '--with-column-info':
case '-c';
$attributes['with-column-info'] = true;
break;
case '--': case '--':
$parseOptions = false; $parseOptions = false;
break; break;
@ -138,5 +162,5 @@ function parseArgs($args) {
} }
} }
return array($operations, $files); return array($operations, $files, $attributes);
} }

View File

@ -18,7 +18,7 @@
}, },
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-master": "1.0-dev" "dev-master": "1.3-dev"
} }
} }
} }

View File

@ -6,22 +6,14 @@ There are multiple ways to include the PHP parser into your project:
Installing via Composer Installing via Composer
----------------------- -----------------------
Create a `composer.json` file in your project root and use it to define your dependencies: Run the following command inside your project:
{ php composer.phar require nikic/php-parser
"require": {
"nikic/php-parser": "~1.0.1"
}
}
Then install Composer in your project (or [download the composer.phar][1] directly): If you haven't installed [Composer][1] yet, you can do so using:
curl -s http://getcomposer.org/installer | php curl -s http://getcomposer.org/installer | php
And finally ask Composer to install the dependencies:
php composer.phar install
Installing as a Git Submodule Installing as a Git Submodule
----------------------------- -----------------------------
@ -35,5 +27,5 @@ Installing from the Zip- or Tarball
Download the latest version from [the download page][2], unpack it and move the files somewhere into your project. Download the latest version from [the download page][2], unpack it and move the files somewhere into your project.
[1]: http://getcomposer.org/composer.phar [1]: https://getcomposer.org/
[2]: https://github.com/nikic/PHP-Parser/tags [2]: https://github.com/nikic/PHP-Parser/tags

View File

@ -6,7 +6,7 @@ This document explains how to use the parser, the pretty printer and the node tr
Bootstrapping Bootstrapping
------------- -------------
The library needs to register a class autoloader. You can either use the ''vendor/autoload.php'' file generated by The library needs to register a class autoloader. You can either use the `vendor/autoload.php` file generated by
Composer or by including the bundled `lib/bootstrap.php` file: Composer or by including the bundled `lib/bootstrap.php` file:
```php ```php
@ -20,7 +20,7 @@ Additionally you may want to set the `xdebug.max_nesting_level` ini option to a
```php ```php
<?php <?php
ini_set('xdebug.max_nesting_level', 2000); ini_set('xdebug.max_nesting_level', 3000);
``` ```
This ensures that there will be no errors when traversing highly nested node trees. This ensures that there will be no errors when traversing highly nested node trees.
@ -102,7 +102,7 @@ with them easier they are grouped into three categories:
and thus can occur in other expressions. Examples of expressions are `$var` and thus can occur in other expressions. Examples of expressions are `$var`
(`PhpParser\Node\Expr\Variable`) and `func()` (`PhpParser\Node\Expr\FuncCall`). (`PhpParser\Node\Expr\Variable`) and `func()` (`PhpParser\Node\Expr\FuncCall`).
* `PhpParser\Node\Scalar`s are nodes representing scalar values, like `'string'` * `PhpParser\Node\Scalar`s are nodes representing scalar values, like `'string'`
(`PhpParser\Node\Scalar\String`), `0` (`PhpParser\Node\Scalar\LNumber`) or magic constants (`PhpParser\Node\Scalar\String_`), `0` (`PhpParser\Node\Scalar\LNumber`) or magic constants
like `__FILE__` (`PhpParser\Node\Scalar\MagicConst\File`). All `PhpParser\Node\Scalar`s extend like `__FILE__` (`PhpParser\Node\Scalar\MagicConst\File`). All `PhpParser\Node\Scalar`s extend
`PhpParser\Node\Expr`, as scalars are expressions, too. `PhpParser\Node\Expr`, as scalars are expressions, too.
* There are some nodes not in either of these groups, for example names (`PhpParser\Node\Name`) * There are some nodes not in either of these groups, for example names (`PhpParser\Node\Name`)
@ -224,7 +224,7 @@ use PhpParser\Node;
class MyNodeVisitor extends PhpParser\NodeVisitorAbstract class MyNodeVisitor extends PhpParser\NodeVisitorAbstract
{ {
public function leaveNode(Node $node) { public function leaveNode(Node $node) {
if ($node instanceof Node\Scalar\String) { if ($node instanceof Node\Scalar\String_) {
$node->value = 'foo'; $node->value = 'foo';
} }
} }
@ -241,23 +241,27 @@ methods:
public function leaveNode(PhpParser\Node $node); public function leaveNode(PhpParser\Node $node);
public function afterTraverse(array $nodes); public function afterTraverse(array $nodes);
The `beforeTraverse` method is called once before the traversal begins and is passed the nodes the The `beforeTraverse()` method is called once before the traversal begins and is passed the nodes the
traverser was called with. This method can be used for resetting values before traversation or traverser was called with. This method can be used for resetting values before traversation or
preparing the tree for traversal. preparing the tree for traversal.
The `afterTraverse` method is similar to the `beforeTraverse` method, with the only difference that The `afterTraverse()` method is similar to the `beforeTraverse()` method, with the only difference that
it is called once after the traversal. it is called once after the traversal.
The `enterNode` and `leaveNode` methods are called on every node, the former when it is entered, The `enterNode()` and `leaveNode()` methods are called on every node, the former when it is entered,
i.e. before its subnodes are traversed, the latter when it is left. i.e. before its subnodes are traversed, the latter when it is left.
All four methods can either return the changed node or not return at all (i.e. `null`) in which All four methods can either return the changed node or not return at all (i.e. `null`) in which
case the current node is not changed. The `leaveNode` method can additionally return two special case the current node is not changed.
values:
If `false` is returned the current node will be removed from the parent array. If an array is returned The `enterNode()` method can additionally return the value `NodeTraverser::DONT_TRAVERSE_CHILDREN`,
it will be merged into the parent array at the offset of the current node. I.e. if in `array(A, B, C)` which instructs the traverser to skip all children of the current node.
the node `B` should be replaced with `array(X, Y, Z)` the result will be `array(A, X, Y, Z, C)`.
The `leaveNode()` method can additionally return the value `NodeTraverser::REMOVE_NODE`, in which
case the current node will be removed from the parent array. Furthermove it is possible to return
an array of nodes, which will be merged into the parent array at the offset of the current node.
I.e. if in `array(A, B, C)` the node `B` should be replaced with `array(X, Y, Z)` the result will
be `array(A, X, Y, Z, C)`.
Instead of manually implementing the `NodeVisitor` interface you can also extend the `NodeVisitorAbstract` Instead of manually implementing the `NodeVisitor` interface you can also extend the `NodeVisitorAbstract`
class, which will define empty default implementations for all the above methods. class, which will define empty default implementations for all the above methods.
@ -415,4 +419,4 @@ class NodeVisitor_NamespaceConverter extends PhpParser\NodeVisitorAbstract
} }
``` ```
That's all. That's all.

View File

@ -2,52 +2,76 @@ Code generation
=============== ===============
It is also possible to generate code using the parser, by first creating an Abstract Syntax Tree and then using the It is also possible to generate code using the parser, by first creating an Abstract Syntax Tree and then using the
pretty printer to convert it to PHP code. To simplify code generation, the project comes with a set of builders for pretty printer to convert it to PHP code. To simplify code generation, the project comes with builders which allow
classes, interfaces, methods, functions, parameters and properties. The builders allow creating node trees using a creating node trees using a fluid interface, instead of instantiating all nodes manually. Builders are available for
fluid interface, instead of instantiating all nodes manually. the following syntactic elements:
* namespaces and use statements
* classes, interfaces and traits
* methods, functions and parameters
* properties
Here is an example: Here is an example:
```php ```php
<?php <?php
$factory = new PhpParser\BuilderFactory; $factory = new PhpParser\BuilderFactory;
$node = $factory->class('SomeClass') $node = $factory->namespace('Name\Space')
->extend('SomeOtherClass') ->addStmt($factory->use('Some\Other\Thingy')->as('SomeOtherClass'))
->implement('A\Few', 'Interfaces') ->addStmt($factory->class('SomeClass')
->makeAbstract() // ->makeFinal() ->extend('SomeOtherClass')
->implement('A\Few', '\Interfaces')
->addStmt($factory->method('someMethod')
->makeAbstract() // ->makeFinal() ->makeAbstract() // ->makeFinal()
->addParam($factory->param('someParam')->setTypeHint('SomeClass'))
)
->addStmt($factory->method('anotherMethod') ->addStmt($factory->method('someMethod')
->makeProtected() // ->makePublic() [default], ->makePrivate() ->makePublic()
->addParam($factory->param('someParam')->setDefault('test')) ->makeAbstract() // ->makeFinal()
// it is possible to add manually created nodes ->addParam($factory->param('someParam')->setTypeHint('SomeClass'))
->addStmt(new PhpParser\Node\Expr\Print_(new PhpParser\Node\Expr\Variable('someParam'))) ->setDocComment('/**
) * This method does something.
*
* @param SomeClass And takes a parameter
*/')
)
// properties will be correctly reordered above the methods ->addStmt($factory->method('anotherMethod')
->addStmt($factory->property('someProperty')->makeProtected()) ->makeProtected() // ->makePublic() [default], ->makePrivate()
->addStmt($factory->property('anotherProperty')->makePrivate()->setDefault(array(1, 2, 3))) ->addParam($factory->param('someParam')->setDefault('test'))
// it is possible to add manually created nodes
->addStmt(new PhpParser\Node\Expr\Print_(new PhpParser\Node\Expr\Variable('someParam')))
)
// properties will be correctly reordered above the methods
->addStmt($factory->property('someProperty')->makeProtected())
->addStmt($factory->property('anotherProperty')->makePrivate()->setDefault(array(1, 2, 3)))
)
->getNode() ->getNode()
; ;
$stmts = array($node); $stmts = array($node);
echo $prettyPrinter->prettyPrint($stmts); $prettyPrinter = new PhpParser\PrettyPrinter\Standard();
echo $prettyPrinter->prettyPrintFile($stmts);
``` ```
This will produce the following output with the default pretty printer: This will produce the following output with the standard pretty printer:
```php ```php
<?php <?php
abstract class SomeClass extends SomeOtherClass implements A\Few, Interfaces
namespace Name\Space;
use Some\Other\Thingy as SomeClass;
abstract class SomeClass extends SomeOtherClass implements A\Few, \Interfaces
{ {
protected $someProperty; protected $someProperty;
private $anotherProperty = array(1, 2, 3); private $anotherProperty = array(1, 2, 3);
abstract function someMethod(SomeClass $someParam); /**
* This method does something.
*
* @param SomeClass And takes a parameter
*/
public abstract function someMethod(SomeClass $someParam);
protected function anotherMethod($someParam = 'test') protected function anotherMethod($someParam = 'test')
{ {
print $someParam; print $someParam;

View File

@ -0,0 +1,77 @@
Error handling
==============
Errors during parsing or analysis are represented using the `PhpParser\Error` exception class. In addition to an error
message, an error can also store additional information about the location the error occurred at.
How much location information is available depends on the origin of the error and how many lexer attributes have been
enabled. At a minimum the start line of the error is usually available.
Column information
------------------
In order to receive information about not only the line, but also the column span an error occurred at, the file
position attributes in the lexer need to be enabled:
```php
$lexer = new PhpParser\Lexer(array(
'usedAttributes' => array('comments', 'startLine', 'endLine', 'startFilePos', 'endFilePos'),
));
$parser = new PhpParser\Parser($lexer);
try {
$stmts = $parser->parse($code);
// ...
} catch (PhpParser\Error $e) {
// ...
}
```
Before using column information its availability needs to be checked with `$e->hasColumnInfo()`, as the precise
location of an error cannot always be determined. The methods for retrieving column information also have to be passed
the source code of the parsed file. An example for printing an error:
```php
if ($e->hasColumnInfo()) {
echo $e->getRawMessage() . ' from ' . $e->getStartLine() . ':' . $e->getStartColumn($code)
. ' to ' . $e->getEndLine() . ':' . $e->getEndColumn($code);
} else {
echo $e->getMessage();
}
```
Both line numbers and column numbers are 1-based. EOF errors will be located at the position one past the end of the
file.
Error recovery
--------------
> **EXPERIMENTAL**
By default the parser will throw an exception upon encountering the first error during parsing. An alternative mode is
also supported, in which the parser will remember the error, but try to continue parsing the rest of the source code.
To enable this mode the `throwOnError` parser option needs to be disabled. Any errors that occurred during parsing can
then be retrieved using `$parser->getErrors()`. The `$parser->parse()` method will either return a partial syntax tree
or `null` if recovery fails.
A usage example:
```php
$parser = new PhpParser\Parser(new PhpParser\Lexer, array(
'throwOnError' => false,
));
$stmts = $parser->parse($code);
$errors = $parser->getErrors();
foreach ($errors as $error) {
// $error is an ordinary PhpParser\Error
}
if (null !== $stmts) {
// $stmts is a best-effort partial AST
}
```
The error recovery implementation is experimental -- it currently won't be able to recover from many types of errors.

View File

@ -5,83 +5,47 @@ The lexer is responsible for providing tokens to the parser. The project comes w
`PhpParser\Lexer\Emulative`. The latter is an extension of the former, which adds the ability to emulate tokens of `PhpParser\Lexer\Emulative`. The latter is an extension of the former, which adds the ability to emulate tokens of
newer PHP versions and thus allows parsing of new code on older versions. newer PHP versions and thus allows parsing of new code on older versions.
A lexer has to define the following public interface: This documentation discusses options available for the default lexers and explains how lexers can be extended.
void startLexing(string $code); Lexer options
string handleHaltCompiler(); -------------
int getNextToken(string &$value = null, array &$startAttributes = null, array &$endAttributes = null);
The `startLexing()` method is invoked with the source code that is to be lexed (including the opening tag) whenever the The two default lexers accept an `$options` array in the constructor. Currently only the `'usedAttributes'` option is
`parse()` method of the parser is called. It can be used to reset state or preprocess the source code or tokens. supported, which allows you to specify which attributes will be added to the AST nodes. The attributes can then be
accessed using `$node->getAttribute()`, `$node->setAttribute()`, `$node->hasAttribute()` and `$node->getAttributes()`
The `handleHaltCompiler()` method is called whenever a `T_HALT_COMPILER` token is encountered. It has to return the methods. A sample options array:
remaining string after the construct (not including `();`).
The `getNextToken()` method returns the ID of the next token (as defined by the `Parser::T_*` constants). If no more
tokens are available it must return `0`, which is the ID of the `EOF` token. Furthermore the string content of the
token should be written into the by-reference `$value` parameter (which will then be available as `$n` in the parser).
Attribute handling
------------------
The other two by-ref variables `$startAttributes` and `$endAttributes` define which attributes will eventually be
assigned to the generated nodes: The parser will take the `$startAttributes` from the first token which is part of the
node and the `$endAttributes` from the last token that is part of the node.
E.g. if the tokens `T_FUNCTION T_STRING ... '{' ... '}'` constitute a node, then the `$startAttributes` from the
`T_FUNCTION` token will be taken and the `$endAttributes` from the `'}'` token.
By default the lexer creates the attributes `startLine`, `comments` (both part of `$startAttributes`) and `endLine`
(part of `$endAttributes`).
If you don't want all these attributes to be added (to reduce memory usage of the AST) you can simply remove them by
overriding the method:
```php ```php
<?php $lexer = new PhpParser\Lexer(array(
'usedAttributes' => array(
class LessAttributesLexer extends PhpParser\Lexer { 'comments', 'startLine', 'endLine'
public function getNextToken(&$value = null, &$startAttributes = null, &$endAttributes = null) { )
$tokenId = parent::getNextToken($value, $startAttributes, $endAttributes); ));
// only keep startLine attribute
unset($startAttributes['comments']);
unset($endAttributes['endLine']);
return $tokenId;
}
}
``` ```
Token offset lexer The attributes used in this example match the default behavior of the lexer. The following attributes are supported:
------------------
A useful application for custom attributes is the token offset lexer, which provides the start and end token for a node * `comments`: Array of `PhpParser\Comment` or `PhpParser\Comment\Doc` instances, representing all comments that occurred
as attributes: between the previous non-discarded token and the current one. Use of this attribute is required for the
`$node->getDocComment()` method to work. The attribute is also needed if you wish the pretty printer to retain
comments present in the original code.
* `startLine`: Line in which the node starts. This attribute is required for the `$node->getLine()` to work. It is also
required if syntax errors should contain line number information.
* `endLine`: Line in which the node ends.
* `startTokenPos`: Offset into the token array of the first token in the node.
* `endTokenPos`: Offset into the token array of the last token in the node.
* `startFilePos`: Offset into the code string of the first character that is part of the node.
* `endFilePos`: Offset into the code string of the last character that is part of the node.
```php ### Using token positions
<?php
class TokenOffsetLexer extends PhpParser\Lexer { The token offset information is useful if you wish to examine the exact formatting used for a node. For example the AST
public function getNextToken(&$value = null, &$startAttributes = null, &$endAttributes = null) { does not distinguish whether a property was declared using `public` or using `var`, but you can retrieve this
$tokenId = parent::getNextToken($value, $startAttributes, $endAttributes); information based on the token position:
$startAttributes['startOffset'] = $endAttributes['endOffset'] = $this->pos;
return $tokenId;
}
public function getTokens() {
return $this->tokens;
}
}
```
This information can now be used to examine the exact formatting used for a node. For example the AST does not
distinguish whether a property was declared using `public` or using `var`, but you can retrieve this information based
on the token offset:
```php ```php
function isDeclaredUsingVar(array $tokens, PhpParser\Node\Stmt\Property $prop) { function isDeclaredUsingVar(array $tokens, PhpParser\Node\Stmt\Property $prop) {
$i = $prop->getAttribute('startOffset'); $i = $prop->getAttribute('startTokenPos');
return $tokens[$i][0] === T_VAR; return $tokens[$i][0] === T_VAR;
} }
``` ```
@ -103,7 +67,11 @@ class MyNodeVisitor extends PhpParser\NodeVisitorAbstract {
} }
} }
$lexer = new TokenOffsetLexer(); $lexer = new PhpParser\Lexer(array(
'usedAttributes' => array(
'comments', 'startLine', 'endLine', 'startTokenPos', 'endTokenPos'
)
));
$parser = new PhpParser\Parser($lexer); $parser = new PhpParser\Parser($lexer);
$visitor = new MyNodeVisitor(); $visitor = new MyNodeVisitor();
@ -121,3 +89,58 @@ try {
The same approach can also be used to perform specific modifications in the code, without changing the formatting in The same approach can also be used to perform specific modifications in the code, without changing the formatting in
other places (which is the case when using the pretty printer). other places (which is the case when using the pretty printer).
Lexer extension
---------------
A lexer has to define the following public interface:
void startLexing(string $code);
array getTokens();
string handleHaltCompiler();
int getNextToken(string &$value = null, array &$startAttributes = null, array &$endAttributes = null);
The `startLexing()` method is invoked with the source code that is to be lexed (including the opening tag) whenever the
`parse()` method of the parser is called. It can be used to reset state or preprocess the source code or tokens.
The `getTokens()` method returns the current token array, in the usual `token_get_all()` format. This method is not
used by the parser (which uses `getNextToken()`), but is useful in combination with the token position attributes.
The `handleHaltCompiler()` method is called whenever a `T_HALT_COMPILER` token is encountered. It has to return the
remaining string after the construct (not including `();`).
The `getNextToken()` method returns the ID of the next token (as defined by the `Parser::T_*` constants). If no more
tokens are available it must return `0`, which is the ID of the `EOF` token. Furthermore the string content of the
token should be written into the by-reference `$value` parameter (which will then be available as `$n` in the parser).
### Attribute handling
The other two by-ref variables `$startAttributes` and `$endAttributes` define which attributes will eventually be
assigned to the generated nodes: The parser will take the `$startAttributes` from the first token which is part of the
node and the `$endAttributes` from the last token that is part of the node.
E.g. if the tokens `T_FUNCTION T_STRING ... '{' ... '}'` constitute a node, then the `$startAttributes` from the
`T_FUNCTION` token will be taken and the `$endAttributes` from the `'}'` token.
An application of custom attributes is storing the original formatting of literals: The parser does not retain
information about the formatting of integers (like decimal vs. hexadecimal) or strings (like used quote type or used
escape sequences). This can be remedied by storing the original value in an attribute:
```php
class KeepOriginalValueLexer extends PHPParser\Lexer // or PHPParser\Lexer\Emulative
{
public function getNextToken(&$value = null, &$startAttributes = null, &$endAttributes = null) {
$tokenId = parent::getNextToken($value, $startAttributes, $endAttributes);
if ($tokenId == PHPParser\Parser::T_CONSTANT_ENCAPSED_STRING // non-interpolated string
|| $tokenId == PHPParser\Parser::T_LNUMBER // integer
|| $tokenId == PHPParser\Parser::T_DNUMBER // floating point number
) {
// could also use $startAttributes, doesn't really matter here
$endAttributes['originalValue'] = $value;
}
return $tokenId;
}
}
```

View File

@ -13,8 +13,7 @@ The `.phpy` file is a normal grammer in `kmyacc` (`yacc`) style, with some trans
applied to it: applied to it:
* Nodes are created using the syntax `Name[..., ...]`. This is transformed into * Nodes are created using the syntax `Name[..., ...]`. This is transformed into
`new Node\Name(..., ..., $attributes)` `new Name(..., ..., attributes())`
* `Name::abc` is transformed to `Node\Name::abc`
* Some function-like constructs are resolved (see `rebuildParser.php` for a list) * Some function-like constructs are resolved (see `rebuildParser.php` for a list)
* Associative arrays are written as `[key: value, ...]`, which is transformed to * Associative arrays are written as `[key: value, ...]`, which is transformed to
`array('key' => value, ...)` `array('key' => value, ...)`
@ -25,5 +24,5 @@ Building the parser
In order to rebuild the parser, you need [moriyoshi's fork of kmyacc](https://github.com/moriyoshi/kmyacc-forked). In order to rebuild the parser, you need [moriyoshi's fork of kmyacc](https://github.com/moriyoshi/kmyacc-forked).
After you compiled/installed it, run the `rebuildParser.php` script. After you compiled/installed it, run the `rebuildParser.php` script.
By default only the `Parser.php` is built. If you want to additionally build `Parser/Debug.php` and `y.output` run the By default only the `Parser.php` is built. If you want to additionally emit debug symbols and create `y.output`, run the
script with `--debug`. If you want to retain the preprocessed grammar pass `--keep-tmp-grammar`. script with `--debug`. If you want to retain the preprocessed grammar pass `--keep-tmp-grammar`.

View File

@ -2,11 +2,11 @@
$meta # $meta #
#semval($) $this->semValue #semval($) $this->semValue
#semval($,%t) $this->semValue #semval($,%t) $this->semValue
#semval(%n) $this->semStack[$this->stackPos-(%l-%n)] #semval(%n) $this->stackPos-(%l-%n)
#semval(%n,%t) $this->semStack[$this->stackPos-(%l-%n)] #semval(%n,%t) $this->stackPos-(%l-%n)
#include;
namespace PhpParser; namespace PhpParser;
#include;
/* This is an automatically GENERATED file, which should not be manually edited. /* This is an automatically GENERATED file, which should not be manually edited.
* Instead edit one of the following: * Instead edit one of the following:
@ -20,7 +20,8 @@ class Parser extends ParserAbstract
protected $actionTableSize = #(YYLAST); protected $actionTableSize = #(YYLAST);
protected $gotoTableSize = #(YYGLAST); protected $gotoTableSize = #(YYGLAST);
protected $invalidToken = #(YYBADCH); protected $invalidSymbol = #(YYBADCH);
protected $errorSymbol = #(YYINTERRTOK);
protected $defaultAction = #(YYDEFAULT); protected $defaultAction = #(YYDEFAULT);
protected $unexpectedTokenRule = #(YYUNEXPECTED); protected $unexpectedTokenRule = #(YYUNEXPECTED);
@ -86,7 +87,7 @@ class Parser extends ParserAbstract
#endif #endif
#reduce #reduce
protected function reduceRule%n($attributes) { protected function reduceRule%n() {
%b %b
} }
#noact #noact

View File

@ -39,10 +39,10 @@ echo 'Building temporary preproprocessed grammar file.', "\n";
$grammarCode = file_get_contents($grammarFile); $grammarCode = file_get_contents($grammarFile);
$grammarCode = resolveConstants($grammarCode);
$grammarCode = resolveNodes($grammarCode); $grammarCode = resolveNodes($grammarCode);
$grammarCode = resolveMacros($grammarCode); $grammarCode = resolveMacros($grammarCode);
$grammarCode = resolveArrays($grammarCode); $grammarCode = resolveArrays($grammarCode);
$grammarCode = resolveStackAccess($grammarCode);
file_put_contents($tmpGrammarFile, $grammarCode); file_put_contents($tmpGrammarFile, $grammarCode);
@ -52,7 +52,12 @@ echo "Building parser.\n";
$output = trim(shell_exec("$kmyacc $additionalArgs -l -m $skeletonFile $tmpGrammarFile 2>&1")); $output = trim(shell_exec("$kmyacc $additionalArgs -l -m $skeletonFile $tmpGrammarFile 2>&1"));
echo "Output: \"$output\"\n"; echo "Output: \"$output\"\n";
moveFileWithDirCheck($tmpResultFile, $parserResultFile); $resultCode = file_get_contents($tmpResultFile);
$resultCode = removeTrailingWhitespace($resultCode);
ensureDirExists(dirname($parserResultFile));
file_put_contents($parserResultFile, $resultCode);
unlink($tmpResultFile);
if (!$optionKeepTmpGrammar) { if (!$optionKeepTmpGrammar) {
unlink($tmpGrammarFile); unlink($tmpGrammarFile);
@ -62,10 +67,6 @@ if (!$optionKeepTmpGrammar) {
/// Preprocessing functions /// /// Preprocessing functions ///
/////////////////////////////// ///////////////////////////////
function resolveConstants($code) {
return preg_replace('~[A-Z][a-zA-Z_\\\\]++::~', 'Node\\\\$0', $code);
}
function resolveNodes($code) { function resolveNodes($code) {
return preg_replace_callback( return preg_replace_callback(
'~(?<name>[A-Z][a-zA-Z_\\\\]++)\s*' . PARAMS . '~', '~(?<name>[A-Z][a-zA-Z_\\\\]++)\s*' . PARAMS . '~',
@ -83,7 +84,7 @@ function resolveNodes($code) {
$paramCode .= $param . ', '; $paramCode .= $param . ', ';
} }
return 'new Node\\' . $matches['name'] . '(' . $paramCode . '$attributes)'; return 'new ' . $matches['name'] . '(' . $paramCode . 'attributes())';
}, },
$code $code
); );
@ -102,10 +103,9 @@ function resolveMacros($code) {
$matches['args'] $matches['args']
); );
if ('error' == $name) { if ('attributes' == $name) {
assertArgs(1, $args, $name); assertArgs(0, $args, $name);
return '$this->startAttributeStack[#1] + $this->endAttributes';
return 'throw new Error(' . $args[0] . ')';
} }
if ('init' == $name) { if ('init' == $name) {
@ -139,16 +139,16 @@ function resolveMacros($code) {
if ('parseEncapsed' == $name) { if ('parseEncapsed' == $name) {
assertArgs(2, $args, $name); assertArgs(2, $args, $name);
return 'foreach (' . $args[0] . ' as &$s) { if (is_string($s)) { $s = Node\Scalar\String::parseEscapeSequences($s, ' . $args[1] . '); } }'; return 'foreach (' . $args[0] . ' as &$s) { if (is_string($s)) { $s = Node\Scalar\String_::parseEscapeSequences($s, ' . $args[1] . '); } }';
} }
if ('parseEncapsedDoc' == $name) { if ('parseEncapsedDoc' == $name) {
assertArgs(1, $args, $name); assertArgs(1, $args, $name);
return 'foreach (' . $args[0] . ' as &$s) { if (is_string($s)) { $s = Node\Scalar\String::parseEscapeSequences($s, null); } } $s = preg_replace(\'~(\r\n|\n|\r)$~\', \'\', $s); if (\'\' === $s) array_pop(' . $args[0] . ');'; return 'foreach (' . $args[0] . ' as &$s) { if (is_string($s)) { $s = Node\Scalar\String_::parseEscapeSequences($s, null); } } $s = preg_replace(\'~(\r\n|\n|\r)$~\', \'\', $s); if (\'\' === $s) array_pop(' . $args[0] . ');';
} }
throw new Exception(sprintf('Unknown macro "%s"', $name)); return $matches[0];
}, },
$code $code
); );
@ -191,12 +191,22 @@ function resolveArrays($code) {
); );
} }
function moveFileWithDirCheck($fromPath, $toPath) { function resolveStackAccess($code) {
$dir = dirname($toPath); $code = preg_replace('/\$\d+/', '$this->semStack[$0]', $code);
$code = preg_replace('/#(\d+)/', '$$1', $code);
return $code;
}
function removeTrailingWhitespace($code) {
$lines = explode("\n", $code);
$lines = array_map('rtrim', $lines);
return implode("\n", $lines);
}
function ensureDirExists($dir) {
if (!is_dir($dir)) { if (!is_dir($dir)) {
mkdir($dir, 0777, true); mkdir($dir, 0777, true);
} }
rename($fromPath, $toPath);
} }
////////////////////////////// //////////////////////////////

View File

@ -8,14 +8,16 @@
%left T_LOGICAL_AND %left T_LOGICAL_AND
%right T_PRINT %right T_PRINT
%right T_YIELD %right T_YIELD
%right T_YIELD_FROM
%left '=' T_PLUS_EQUAL T_MINUS_EQUAL T_MUL_EQUAL T_DIV_EQUAL T_CONCAT_EQUAL T_MOD_EQUAL T_AND_EQUAL T_OR_EQUAL T_XOR_EQUAL T_SL_EQUAL T_SR_EQUAL T_POW_EQUAL %left '=' T_PLUS_EQUAL T_MINUS_EQUAL T_MUL_EQUAL T_DIV_EQUAL T_CONCAT_EQUAL T_MOD_EQUAL T_AND_EQUAL T_OR_EQUAL T_XOR_EQUAL T_SL_EQUAL T_SR_EQUAL T_POW_EQUAL
%left '?' ':' %left '?' ':'
%right T_COALESCE
%left T_BOOLEAN_OR %left T_BOOLEAN_OR
%left T_BOOLEAN_AND %left T_BOOLEAN_AND
%left '|' %left '|'
%left '^' %left '^'
%left '&' %left '&'
%nonassoc T_IS_EQUAL T_IS_NOT_EQUAL T_IS_IDENTICAL T_IS_NOT_IDENTICAL %nonassoc T_IS_EQUAL T_IS_NOT_EQUAL T_IS_IDENTICAL T_IS_NOT_IDENTICAL T_SPACESHIP
%nonassoc '<' T_IS_SMALLER_OR_EQUAL '>' T_IS_GREATER_OR_EQUAL %nonassoc '<' T_IS_SMALLER_OR_EQUAL '>' T_IS_GREATER_OR_EQUAL
%left T_SL T_SR %left T_SL T_SR
%left '+' '-' '.' %left '+' '-' '.'
@ -109,6 +111,13 @@
%token T_NS_SEPARATOR %token T_NS_SEPARATOR
%token T_ELLIPSIS %token T_ELLIPSIS
%{
use PhpParser\Node\Expr;
use PhpParser\Node\Name;
use PhpParser\Node\Scalar;
use PhpParser\Node\Stmt;
%}
%% %%
start: start:
@ -162,7 +171,7 @@ constant_declaration_list:
; ;
constant_declaration: constant_declaration:
T_STRING '=' static_scalar { $$ = Const_[$1, $3]; } T_STRING '=' static_scalar { $$ = Node\Const_[$1, $3]; }
; ;
inner_statement_list: inner_statement_list:
@ -174,7 +183,8 @@ inner_statement:
statement { $$ = $1; } statement { $$ = $1; }
| function_declaration_statement { $$ = $1; } | function_declaration_statement { $$ = $1; }
| class_declaration_statement { $$ = $1; } | class_declaration_statement { $$ = $1; }
| T_HALT_COMPILER { error('__HALT_COMPILER() can only be used from the outermost scope'); } | T_HALT_COMPILER
{ throw new Error('__HALT_COMPILER() can only be used from the outermost scope', attributes()); }
; ;
statement: statement:
@ -212,6 +222,7 @@ statement:
| T_THROW expr ';' { $$ = Stmt\Throw_[$2]; } | T_THROW expr ';' { $$ = Stmt\Throw_[$2]; }
| T_GOTO T_STRING ';' { $$ = Stmt\Goto_[$2]; } | T_GOTO T_STRING ';' { $$ = Stmt\Goto_[$2]; }
| T_STRING ':' { $$ = Stmt\Label[$1]; } | T_STRING ':' { $$ = Stmt\Label[$1]; }
| error { $$ = array(); /* means: no statement */ }
; ;
catches: catches:
@ -245,8 +256,8 @@ optional_ellipsis:
; ;
function_declaration_statement: function_declaration_statement:
T_FUNCTION optional_ref T_STRING '(' parameter_list ')' '{' inner_statement_list '}' T_FUNCTION optional_ref T_STRING '(' parameter_list ')' optional_return_type '{' inner_statement_list '}'
{ $$ = Stmt\Function_[$3, [byRef: $2, params: $5, stmts: $8]]; } { $$ = Stmt\Function_[$3, [byRef: $2, params: $5, returnType: $7, stmts: $9]]; }
; ;
class_declaration_statement: class_declaration_statement:
@ -380,23 +391,32 @@ non_empty_parameter_list:
; ;
parameter: parameter:
optional_class_type optional_ref optional_ellipsis T_VARIABLE optional_param_type optional_ref optional_ellipsis T_VARIABLE
{ $$ = Param[parseVar($4), null, $1, $2, $3]; } { $$ = Node\Param[parseVar($4), null, $1, $2, $3]; }
| optional_class_type optional_ref optional_ellipsis T_VARIABLE '=' static_scalar | optional_param_type optional_ref optional_ellipsis T_VARIABLE '=' static_scalar
{ $$ = Param[parseVar($4), $6, $1, $2, $3]; } { $$ = Node\Param[parseVar($4), $6, $1, $2, $3]; }
; ;
optional_class_type: type:
/* empty */ { $$ = null; } name { $$ = $1; }
| name { $$ = $1; }
| T_ARRAY { $$ = 'array'; } | T_ARRAY { $$ = 'array'; }
| T_CALLABLE { $$ = 'callable'; } | T_CALLABLE { $$ = 'callable'; }
; ;
optional_param_type:
/* empty */ { $$ = null; }
| type { $$ = $1; }
;
optional_return_type:
/* empty */ { $$ = null; }
| ':' type { $$ = $2; }
;
argument_list: argument_list:
'(' ')' { $$ = array(); } '(' ')' { $$ = array(); }
| '(' non_empty_argument_list ')' { $$ = $2; } | '(' non_empty_argument_list ')' { $$ = $2; }
| '(' yield_expr ')' { $$ = array(Arg[$2, false, false]); } | '(' yield_expr ')' { $$ = array(Node\Arg[$2, false, false]); }
; ;
non_empty_argument_list: non_empty_argument_list:
@ -405,9 +425,9 @@ non_empty_argument_list:
; ;
argument: argument:
expr { $$ = Arg[$1, false, false]; } expr { $$ = Node\Arg[$1, false, false]; }
| '&' variable { $$ = Arg[$2, true, false]; } | '&' variable { $$ = Node\Arg[$2, true, false]; }
| T_ELLIPSIS expr { $$ = Arg[$2, false, true]; } | T_ELLIPSIS expr { $$ = Node\Arg[$2, false, true]; }
; ;
global_var_list: global_var_list:
@ -439,8 +459,8 @@ class_statement_list:
class_statement: class_statement:
variable_modifiers property_declaration_list ';' { $$ = Stmt\Property[$1, $2]; } variable_modifiers property_declaration_list ';' { $$ = Stmt\Property[$1, $2]; }
| T_CONST constant_declaration_list ';' { $$ = Stmt\ClassConst[$2]; } | T_CONST constant_declaration_list ';' { $$ = Stmt\ClassConst[$2]; }
| method_modifiers T_FUNCTION optional_ref T_STRING '(' parameter_list ')' method_body | method_modifiers T_FUNCTION optional_ref T_STRING '(' parameter_list ')' optional_return_type method_body
{ $$ = Stmt\ClassMethod[$4, [type: $1, byRef: $3, params: $6, stmts: $8]]; } { $$ = Stmt\ClassMethod[$4, [type: $1, byRef: $3, params: $6, returnType: $8, stmts: $9]]; }
| T_USE name_list trait_adaptations { $$ = Stmt\TraitUse[$2, $3]; } | T_USE name_list trait_adaptations { $$ = Stmt\TraitUse[$2, $3]; }
; ;
@ -480,11 +500,11 @@ method_body:
variable_modifiers: variable_modifiers:
non_empty_member_modifiers { $$ = $1; } non_empty_member_modifiers { $$ = $1; }
| T_VAR { $$ = Stmt\Class_::MODIFIER_PUBLIC; } | T_VAR { $$ = 0; }
; ;
method_modifiers: method_modifiers:
/* empty */ { $$ = Stmt\Class_::MODIFIER_PUBLIC; } /* empty */ { $$ = 0; }
| non_empty_member_modifiers { $$ = $1; } | non_empty_member_modifiers { $$ = $1; }
; ;
@ -571,6 +591,7 @@ expr:
| expr T_IS_NOT_IDENTICAL expr { $$ = Expr\BinaryOp\NotIdentical [$1, $3]; } | expr T_IS_NOT_IDENTICAL expr { $$ = Expr\BinaryOp\NotIdentical [$1, $3]; }
| expr T_IS_EQUAL expr { $$ = Expr\BinaryOp\Equal [$1, $3]; } | expr T_IS_EQUAL expr { $$ = Expr\BinaryOp\Equal [$1, $3]; }
| expr T_IS_NOT_EQUAL expr { $$ = Expr\BinaryOp\NotEqual [$1, $3]; } | expr T_IS_NOT_EQUAL expr { $$ = Expr\BinaryOp\NotEqual [$1, $3]; }
| expr T_SPACESHIP expr { $$ = Expr\BinaryOp\Spaceship [$1, $3]; }
| expr '<' expr { $$ = Expr\BinaryOp\Smaller [$1, $3]; } | expr '<' expr { $$ = Expr\BinaryOp\Smaller [$1, $3]; }
| expr T_IS_SMALLER_OR_EQUAL expr { $$ = Expr\BinaryOp\SmallerOrEqual[$1, $3]; } | expr T_IS_SMALLER_OR_EQUAL expr { $$ = Expr\BinaryOp\SmallerOrEqual[$1, $3]; }
| expr '>' expr { $$ = Expr\BinaryOp\Greater [$1, $3]; } | expr '>' expr { $$ = Expr\BinaryOp\Greater [$1, $3]; }
@ -581,6 +602,7 @@ expr:
| '(' new_expr ')' { $$ = $2; } | '(' new_expr ')' { $$ = $2; }
| expr '?' expr ':' expr { $$ = Expr\Ternary[$1, $3, $5]; } | expr '?' expr ':' expr { $$ = Expr\Ternary[$1, $3, $5]; }
| expr '?' ':' expr { $$ = Expr\Ternary[$1, null, $4]; } | expr '?' ':' expr { $$ = Expr\Ternary[$1, null, $4]; }
| expr T_COALESCE expr { $$ = Expr\BinaryOp\Coalesce[$1, $3]; }
| T_ISSET '(' variables_list ')' { $$ = Expr\Isset_[$3]; } | T_ISSET '(' variables_list ')' { $$ = Expr\Isset_[$3]; }
| T_EMPTY '(' expr ')' { $$ = Expr\Empty_[$3]; } | T_EMPTY '(' expr ')' { $$ = Expr\Empty_[$3]; }
| T_INCLUDE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_INCLUDE]; } | T_INCLUDE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_INCLUDE]; }
@ -588,12 +610,12 @@ expr:
| T_EVAL parentheses_expr { $$ = Expr\Eval_[$2]; } | T_EVAL parentheses_expr { $$ = Expr\Eval_[$2]; }
| T_REQUIRE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_REQUIRE]; } | T_REQUIRE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_REQUIRE]; }
| T_REQUIRE_ONCE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_REQUIRE_ONCE]; } | T_REQUIRE_ONCE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_REQUIRE_ONCE]; }
| T_INT_CAST expr { $$ = Expr\Cast\Int [$2]; } | T_INT_CAST expr { $$ = Expr\Cast\Int_ [$2]; }
| T_DOUBLE_CAST expr { $$ = Expr\Cast\Double [$2]; } | T_DOUBLE_CAST expr { $$ = Expr\Cast\Double [$2]; }
| T_STRING_CAST expr { $$ = Expr\Cast\String [$2]; } | T_STRING_CAST expr { $$ = Expr\Cast\String_ [$2]; }
| T_ARRAY_CAST expr { $$ = Expr\Cast\Array_ [$2]; } | T_ARRAY_CAST expr { $$ = Expr\Cast\Array_ [$2]; }
| T_OBJECT_CAST expr { $$ = Expr\Cast\Object [$2]; } | T_OBJECT_CAST expr { $$ = Expr\Cast\Object_ [$2]; }
| T_BOOL_CAST expr { $$ = Expr\Cast\Bool [$2]; } | T_BOOL_CAST expr { $$ = Expr\Cast\Bool_ [$2]; }
| T_UNSET_CAST expr { $$ = Expr\Cast\Unset_ [$2]; } | T_UNSET_CAST expr { $$ = Expr\Cast\Unset_ [$2]; }
| T_EXIT exit_expr { $$ = Expr\Exit_ [$2]; } | T_EXIT exit_expr { $$ = Expr\Exit_ [$2]; }
| '@' expr { $$ = Expr\ErrorSuppress[$2]; } | '@' expr { $$ = Expr\ErrorSuppress[$2]; }
@ -603,10 +625,13 @@ expr:
| '`' backticks_expr '`' { $$ = Expr\ShellExec[$2]; } | '`' backticks_expr '`' { $$ = Expr\ShellExec[$2]; }
| T_PRINT expr { $$ = Expr\Print_[$2]; } | T_PRINT expr { $$ = Expr\Print_[$2]; }
| T_YIELD { $$ = Expr\Yield_[null, null]; } | T_YIELD { $$ = Expr\Yield_[null, null]; }
| T_FUNCTION optional_ref '(' parameter_list ')' lexical_vars '{' inner_statement_list '}' | T_YIELD_FROM expr { $$ = Expr\YieldFrom[$2]; }
{ $$ = Expr\Closure[[static: false, byRef: $2, params: $4, uses: $6, stmts: $8]]; } | T_FUNCTION optional_ref '(' parameter_list ')' lexical_vars optional_return_type
| T_STATIC T_FUNCTION optional_ref '(' parameter_list ')' lexical_vars '{' inner_statement_list '}' '{' inner_statement_list '}'
{ $$ = Expr\Closure[[static: true, byRef: $3, params: $5, uses: $7, stmts: $9]]; } { $$ = Expr\Closure[[static: false, byRef: $2, params: $4, uses: $6, returnType: $7, stmts: $9]]; }
| T_STATIC T_FUNCTION optional_ref '(' parameter_list ')' lexical_vars optional_return_type
'{' inner_statement_list '}'
{ $$ = Expr\Closure[[static: true, byRef: $3, params: $5, uses: $7, returnType: $8, stmts: $10]]; }
; ;
parentheses_expr: parentheses_expr:
@ -627,14 +652,20 @@ array_expr:
scalar_dereference: scalar_dereference:
array_expr '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; } array_expr '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| T_CONSTANT_ENCAPSED_STRING '[' dim_offset ']' | T_CONSTANT_ENCAPSED_STRING '[' dim_offset ']'
{ $$ = Expr\ArrayDimFetch[Scalar\String[Scalar\String::parse($1)], $3]; } { $$ = Expr\ArrayDimFetch[Scalar\String_[Scalar\String_::parse($1)], $3]; }
| constant '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; } | constant '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| scalar_dereference '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; } | scalar_dereference '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
/* alternative array syntax missing intentionally */ /* alternative array syntax missing intentionally */
; ;
anonymous_class:
T_CLASS ctor_arguments extends_from implements_list '{' class_statement_list '}'
{ $$ = array(Stmt\Class_[null, [type: 0, extends: $3, implements: $4, stmts: $6]], $2); }
new_expr: new_expr:
T_NEW class_name_reference ctor_arguments { $$ = Expr\New_[$2, $3]; } T_NEW class_name_reference ctor_arguments { $$ = Expr\New_[$2, $3]; }
| T_NEW anonymous_class
{ list($class, $ctorArgs) = $2; $$ = Expr\New_[$class, $ctorArgs]; }
; ;
lexical_vars: lexical_vars:
@ -721,7 +752,7 @@ exit_expr:
backticks_expr: backticks_expr:
/* empty */ { $$ = array(); } /* empty */ { $$ = array(); }
| T_ENCAPSED_AND_WHITESPACE { $$ = array(Scalar\String::parseEscapeSequences($1, '`')); } | T_ENCAPSED_AND_WHITESPACE { $$ = array(Scalar\String_::parseEscapeSequences($1, '`')); }
| encaps_list { parseEncapsed($1, '`'); $$ = $1; } | encaps_list { parseEncapsed($1, '`'); $$ = $1; }
; ;
@ -733,7 +764,7 @@ ctor_arguments:
common_scalar: common_scalar:
T_LNUMBER { $$ = Scalar\LNumber[Scalar\LNumber::parse($1)]; } T_LNUMBER { $$ = Scalar\LNumber[Scalar\LNumber::parse($1)]; }
| T_DNUMBER { $$ = Scalar\DNumber[Scalar\DNumber::parse($1)]; } | T_DNUMBER { $$ = Scalar\DNumber[Scalar\DNumber::parse($1)]; }
| T_CONSTANT_ENCAPSED_STRING { $$ = Scalar\String[Scalar\String::parse($1)]; } | T_CONSTANT_ENCAPSED_STRING { $$ = Scalar\String_[Scalar\String_::parse($1)]; }
| T_LINE { $$ = Scalar\MagicConst\Line[]; } | T_LINE { $$ = Scalar\MagicConst\Line[]; }
| T_FILE { $$ = Scalar\MagicConst\File[]; } | T_FILE { $$ = Scalar\MagicConst\File[]; }
| T_DIR { $$ = Scalar\MagicConst\Dir[]; } | T_DIR { $$ = Scalar\MagicConst\Dir[]; }
@ -743,9 +774,9 @@ common_scalar:
| T_FUNC_C { $$ = Scalar\MagicConst\Function_[]; } | T_FUNC_C { $$ = Scalar\MagicConst\Function_[]; }
| T_NS_C { $$ = Scalar\MagicConst\Namespace_[]; } | T_NS_C { $$ = Scalar\MagicConst\Namespace_[]; }
| T_START_HEREDOC T_ENCAPSED_AND_WHITESPACE T_END_HEREDOC | T_START_HEREDOC T_ENCAPSED_AND_WHITESPACE T_END_HEREDOC
{ $$ = Scalar\String[Scalar\String::parseDocString($1, $2)]; } { $$ = Scalar\String_[Scalar\String_::parseDocString($1, $2)]; }
| T_START_HEREDOC T_END_HEREDOC | T_START_HEREDOC T_END_HEREDOC
{ $$ = Scalar\String['']; } { $$ = Scalar\String_['']; }
; ;
static_scalar: static_scalar:
@ -955,8 +986,8 @@ encaps_var:
; ;
encaps_var_offset: encaps_var_offset:
T_STRING { $$ = Scalar\String[$1]; } T_STRING { $$ = Scalar\String_[$1]; }
| T_NUM_STRING { $$ = Scalar\String[$1]; } | T_NUM_STRING { $$ = Scalar\String_[$1]; }
| T_VARIABLE { $$ = Expr\Variable[parseVar($1)]; } | T_VARIABLE { $$ = Expr\Variable[parseVar($1)]; }
; ;

View File

@ -7,14 +7,25 @@ namespace PhpParser;
*/ */
class Autoloader class Autoloader
{ {
/** @var bool Whether the autoloader has been registered. */
private static $registered = false;
/** @var bool Whether we're running on PHP 7. */
private static $runningOnPhp7;
/** /**
* Registers PhpParser\Autoloader as an SPL autoloader. * Registers PhpParser\Autoloader as an SPL autoloader.
* *
* @param bool $prepend Whether to prepend the autoloader instead of appending * @param bool $prepend Whether to prepend the autoloader instead of appending
*/ */
static public function register($prepend = false) { static public function register($prepend = false) {
ini_set('unserialize_callback_func', 'spl_autoload_call'); if (self::$registered === true) {
return;
}
spl_autoload_register(array(__CLASS__, 'autoload'), true, $prepend); spl_autoload_register(array(__CLASS__, 'autoload'), true, $prepend);
self::$registered = true;
self::$runningOnPhp7 = version_compare(PHP_VERSION, '7.0-dev', '>=');
} }
/** /**
@ -24,24 +35,58 @@ class Autoloader
*/ */
static public function autoload($class) { static public function autoload($class) {
if (0 === strpos($class, 'PhpParser\\')) { if (0 === strpos($class, 'PhpParser\\')) {
if (isset(self::$php7AliasesOldToNew[$class])) {
if (self::$runningOnPhp7) {
return;
}
// Load the new class, alias will be registered afterwards
$class = self::$php7AliasesOldToNew[$class];
}
$fileName = dirname(__DIR__) . '/' . strtr($class, '\\', '/') . '.php'; $fileName = dirname(__DIR__) . '/' . strtr($class, '\\', '/') . '.php';
if (file_exists($fileName)) { if (file_exists($fileName)) {
require $fileName; require $fileName;
} }
if (isset(self::$php7AliasesNewToOld[$class])) {
// New class name was used, register alias for old one, otherwise
// it won't be usable in "instanceof" and other non-autoloading places.
if (!self::$runningOnPhp7) {
class_alias($class, self::$php7AliasesNewToOld[$class]);
}
}
} else if (0 === strpos($class, 'PHPParser_')) { } else if (0 === strpos($class, 'PHPParser_')) {
if (isset(self::$oldToNewMap[$class])) { if (isset(self::$nonNamespacedAliases[$class])) {
self::registerLegacyAliases(); // Register all aliases at once to avoid dependency issues
self::registerNonNamespacedAliases();
} }
} }
} }
private static function registerLegacyAliases() { private static function registerNonNamespacedAliases() {
foreach (self::$oldToNewMap as $old => $new) { foreach (self::$nonNamespacedAliases as $old => $new) {
class_alias($new, $old); class_alias($new, $old);
} }
} }
private static $oldToNewMap = array( private static $php7AliasesOldToNew = array(
'PhpParser\Node\Expr\Cast\Bool' => 'PhpParser\Node\Expr\Cast\Bool_',
'PhpParser\Node\Expr\Cast\Int' => 'PhpParser\Node\Expr\Cast\Int_',
'PhpParser\Node\Expr\Cast\Object' => 'PhpParser\Node\Expr\Cast\Object_',
'PhpParser\Node\Expr\Cast\String' => 'PhpParser\Node\Expr\Cast\String_',
'PhpParser\Node\Scalar\String' => 'PhpParser\Node\Scalar\String_',
);
private static $php7AliasesNewToOld = array(
'PhpParser\Node\Expr\Cast\Bool_' => 'PhpParser\Node\Expr\Cast\Bool',
'PhpParser\Node\Expr\Cast\Int_' => 'PhpParser\Node\Expr\Cast\Int',
'PhpParser\Node\Expr\Cast\Object_' => 'PhpParser\Node\Expr\Cast\Object',
'PhpParser\Node\Expr\Cast\String_' => 'PhpParser\Node\Expr\Cast\String',
'PhpParser\Node\Scalar\String_' => 'PhpParser\Node\Scalar\String',
);
private static $nonNamespacedAliases = array(
'PHPParser_Builder' => 'PhpParser\Builder', 'PHPParser_Builder' => 'PhpParser\Builder',
'PHPParser_BuilderAbstract' => 'PhpParser\BuilderAbstract', 'PHPParser_BuilderAbstract' => 'PhpParser\BuilderAbstract',
'PHPParser_BuilderFactory' => 'PhpParser\BuilderFactory', 'PHPParser_BuilderFactory' => 'PhpParser\BuilderFactory',
@ -141,11 +186,11 @@ class Autoloader
'PHPParser_Node_Expr_Cast' => 'PhpParser\Node\Expr\Cast', 'PHPParser_Node_Expr_Cast' => 'PhpParser\Node\Expr\Cast',
'PHPParser_Node_Expr_Cast_Array' => 'PhpParser\Node\Expr\Cast\Array_', 'PHPParser_Node_Expr_Cast_Array' => 'PhpParser\Node\Expr\Cast\Array_',
'PHPParser_Node_Expr_Cast_Bool' => 'PhpParser\Node\Expr\Cast\Bool', 'PHPParser_Node_Expr_Cast_Bool' => 'PhpParser\Node\Expr\Cast\Bool_',
'PHPParser_Node_Expr_Cast_Double' => 'PhpParser\Node\Expr\Cast\Double', 'PHPParser_Node_Expr_Cast_Double' => 'PhpParser\Node\Expr\Cast\Double',
'PHPParser_Node_Expr_Cast_Int' => 'PhpParser\Node\Expr\Cast\Int', 'PHPParser_Node_Expr_Cast_Int' => 'PhpParser\Node\Expr\Cast\Int_',
'PHPParser_Node_Expr_Cast_Object' => 'PhpParser\Node\Expr\Cast\Object', 'PHPParser_Node_Expr_Cast_Object' => 'PhpParser\Node\Expr\Cast\Object_',
'PHPParser_Node_Expr_Cast_String' => 'PhpParser\Node\Expr\Cast\String', 'PHPParser_Node_Expr_Cast_String' => 'PhpParser\Node\Expr\Cast\String_',
'PHPParser_Node_Expr_Cast_Unset' => 'PhpParser\Node\Expr\Cast\Unset_', 'PHPParser_Node_Expr_Cast_Unset' => 'PhpParser\Node\Expr\Cast\Unset_',
'PHPParser_Node_Expr_BitwiseAnd' => 'PhpParser\Node\Expr\BinaryOp\BitwiseAnd', 'PHPParser_Node_Expr_BitwiseAnd' => 'PhpParser\Node\Expr\BinaryOp\BitwiseAnd',
@ -223,8 +268,8 @@ class Autoloader
'PHPParser_Node_Scalar_DNumber' => 'PhpParser\Node\Scalar\DNumber', 'PHPParser_Node_Scalar_DNumber' => 'PhpParser\Node\Scalar\DNumber',
'PHPParser_Node_Scalar_Encapsed' => 'PhpParser\Node\Scalar\Encapsed', 'PHPParser_Node_Scalar_Encapsed' => 'PhpParser\Node\Scalar\Encapsed',
'PHPParser_Node_Scalar_LNumber' => 'PhpParser\Node\Scalar\LNumber', 'PHPParser_Node_Scalar_LNumber' => 'PhpParser\Node\Scalar\LNumber',
'PHPParser_Node_Scalar_String' => 'PhpParser\Node\Scalar\String', 'PHPParser_Node_Scalar_String' => 'PhpParser\Node\Scalar\String_',
); );
} }
class_alias('PhpParser\Autoloader', 'PHPParser_Autoloader'); class_alias('PhpParser\Autoloader', 'PHPParser_Autoloader');

View File

@ -6,18 +6,18 @@ use PhpParser;
use PhpParser\Node\Name; use PhpParser\Node\Name;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Class_ extends PhpParser\BuilderAbstract class Class_ extends Declaration
{ {
protected $name; protected $name;
protected $extends; protected $extends = null;
protected $implements; protected $implements = array();
protected $type; protected $type = 0;
protected $uses; protected $uses = array();
protected $constants; protected $constants = array();
protected $properties; protected $properties = array();
protected $methods; protected $methods = array();
/** /**
* Creates a class builder. * Creates a class builder.
@ -26,12 +26,6 @@ class Class_ extends PhpParser\BuilderAbstract
*/ */
public function __construct($name) { public function __construct($name) {
$this->name = $name; $this->name = $name;
$this->type = 0;
$this->extends = null;
$this->implements = array();
$this->uses = $this->constants = $this->properties = $this->methods = array();
} }
/** /**
@ -39,7 +33,7 @@ class Class_ extends PhpParser\BuilderAbstract
* *
* @param Name|string $class Name of class to extend * @param Name|string $class Name of class to extend
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function extend($class) { public function extend($class) {
$this->extends = $this->normalizeName($class); $this->extends = $this->normalizeName($class);
@ -53,7 +47,7 @@ class Class_ extends PhpParser\BuilderAbstract
* @param Name|string $interface Name of interface to implement * @param Name|string $interface Name of interface to implement
* @param Name|string $... More interfaces to implement * @param Name|string $... More interfaces to implement
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function implement() { public function implement() {
foreach (func_get_args() as $interface) { foreach (func_get_args() as $interface) {
@ -66,7 +60,7 @@ class Class_ extends PhpParser\BuilderAbstract
/** /**
* Makes the class abstract. * Makes the class abstract.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeAbstract() { public function makeAbstract() {
$this->setModifier(Stmt\Class_::MODIFIER_ABSTRACT); $this->setModifier(Stmt\Class_::MODIFIER_ABSTRACT);
@ -77,7 +71,7 @@ class Class_ extends PhpParser\BuilderAbstract
/** /**
* Makes the class final. * Makes the class final.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeFinal() { public function makeFinal() {
$this->setModifier(Stmt\Class_::MODIFIER_FINAL); $this->setModifier(Stmt\Class_::MODIFIER_FINAL);
@ -90,7 +84,7 @@ class Class_ extends PhpParser\BuilderAbstract
* *
* @param Stmt|PhpParser\Builder $stmt The statement to add * @param Stmt|PhpParser\Builder $stmt The statement to add
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function addStmt($stmt) { public function addStmt($stmt) {
$stmt = $this->normalizeNode($stmt); $stmt = $this->normalizeNode($stmt);
@ -112,21 +106,6 @@ class Class_ extends PhpParser\BuilderAbstract
return $this; return $this;
} }
/**
* Adds multiple statements.
*
* @param array $stmts The statements to add
*
* @return self The builder instance (for fluid interface)
*/
public function addStmts(array $stmts) {
foreach ($stmts as $stmt) {
$this->addStmt($stmt);
}
return $this;
}
/** /**
* Returns the built class node. * Returns the built class node.
* *
@ -138,6 +117,6 @@ class Class_ extends PhpParser\BuilderAbstract
'extends' => $this->extends, 'extends' => $this->extends,
'implements' => $this->implements, 'implements' => $this->implements,
'stmts' => array_merge($this->uses, $this->constants, $this->properties, $this->methods), 'stmts' => array_merge($this->uses, $this->constants, $this->properties, $this->methods),
)); ), $this->attributes);
} }
} }

View File

@ -0,0 +1,44 @@
<?php
namespace PhpParser\Builder;
use PhpParser;
use PhpParser\Node;
use PhpParser\Node\Stmt;
abstract class Declaration extends PhpParser\BuilderAbstract
{
protected $attributes = array();
abstract public function addStmt($stmt);
/**
* Adds multiple statements.
*
* @param array $stmts The statements to add
*
* @return $this The builder instance (for fluid interface)
*/
public function addStmts(array $stmts) {
foreach ($stmts as $stmt) {
$this->addStmt($stmt);
}
return $this;
}
/**
* Sets doc comment for the declaration.
*
* @param PhpParser\Comment\Doc|string $docComment Doc comment to set
*
* @return $this The builder instance (for fluid interface)
*/
public function setDocComment($docComment) {
$this->attributes['comments'] = array(
$this->normalizeDocComment($docComment)
);
return $this;
}
}

View File

@ -0,0 +1,58 @@
<?php
namespace PhpParser\Builder;
use PhpParser;
use PhpParser\Node;
use PhpParser\Node\Stmt;
abstract class FunctionLike extends Declaration
{
protected $returnByRef = false;
protected $params = array();
/**
* Make the function return by reference.
*
* @return $this The builder instance (for fluid interface)
*/
public function makeReturnByRef() {
$this->returnByRef = true;
return $this;
}
/**
* Adds a parameter.
*
* @param Node\Param|Param $param The parameter to add
*
* @return $this The builder instance (for fluid interface)
*/
public function addParam($param) {
$param = $this->normalizeNode($param);
if (!$param instanceof Node\Param) {
throw new \LogicException(sprintf('Expected parameter node, got "%s"', $param->getType()));
}
$this->params[] = $param;
return $this;
}
/**
* Adds multiple parameters.
*
* @param array $params The parameters to add
*
* @return $this The builder instance (for fluid interface)
*/
public function addParams(array $params) {
foreach ($params as $param) {
$this->addParam($param);
}
return $this;
}
}

View File

@ -6,13 +6,10 @@ use PhpParser;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Function_ extends PhpParser\BuilderAbstract class Function_ extends FunctionLike
{ {
protected $name; protected $name;
protected $stmts = array();
protected $returnByRef;
protected $params;
protected $stmts;
/** /**
* Creates a function builder. * Creates a function builder.
@ -21,55 +18,6 @@ class Function_ extends PhpParser\BuilderAbstract
*/ */
public function __construct($name) { public function __construct($name) {
$this->name = $name; $this->name = $name;
$this->returnByRef = false;
$this->params = array();
$this->stmts = array();
}
/**
* Make the function return by reference.
*
* @return self The builder instance (for fluid interface)
*/
public function makeReturnByRef() {
$this->returnByRef = true;
return $this;
}
/**
* Adds a parameter.
*
* @param Node\Param|Param $param The parameter to add
*
* @return self The builder instance (for fluid interface)
*/
public function addParam($param) {
$param = $this->normalizeNode($param);
if (!$param instanceof Node\Param) {
throw new \LogicException(sprintf('Expected parameter node, got "%s"', $param->getType()));
}
$this->params[] = $param;
return $this;
}
/**
* Adds multiple parameters.
*
* @param array $params The parameters to add
*
* @return self The builder instance (for fluid interface)
*/
public function addParams(array $params) {
foreach ($params as $param) {
$this->addParam($param);
}
return $this;
} }
/** /**
@ -77,7 +25,7 @@ class Function_ extends PhpParser\BuilderAbstract
* *
* @param Node|PhpParser\Builder $stmt The statement to add * @param Node|PhpParser\Builder $stmt The statement to add
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function addStmt($stmt) { public function addStmt($stmt) {
$this->stmts[] = $this->normalizeNode($stmt); $this->stmts[] = $this->normalizeNode($stmt);
@ -85,21 +33,6 @@ class Function_ extends PhpParser\BuilderAbstract
return $this; return $this;
} }
/**
* Adds multiple statements.
*
* @param array $stmts The statements to add
*
* @return self The builder instance (for fluid interface)
*/
public function addStmts(array $stmts) {
foreach ($stmts as $stmt) {
$this->addStmt($stmt);
}
return $this;
}
/** /**
* Returns the built function node. * Returns the built function node.
* *
@ -110,6 +43,6 @@ class Function_ extends PhpParser\BuilderAbstract
'byRef' => $this->returnByRef, 'byRef' => $this->returnByRef,
'params' => $this->params, 'params' => $this->params,
'stmts' => $this->stmts, 'stmts' => $this->stmts,
)); ), $this->attributes);
} }
} }

View File

@ -6,12 +6,12 @@ use PhpParser;
use PhpParser\Node\Name; use PhpParser\Node\Name;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Interface_ extends PhpParser\BuilderAbstract class Interface_ extends Declaration
{ {
protected $name; protected $name;
protected $extends; protected $extends = array();
protected $constants; protected $constants = array();
protected $methods; protected $methods = array();
/** /**
* Creates an interface builder. * Creates an interface builder.
@ -20,8 +20,6 @@ class Interface_ extends PhpParser\BuilderAbstract
*/ */
public function __construct($name) { public function __construct($name) {
$this->name = $name; $this->name = $name;
$this->extends = array();
$this->constants = $this->methods = array();
} }
/** /**
@ -30,7 +28,7 @@ class Interface_ extends PhpParser\BuilderAbstract
* @param Name|string $interface Name of interface to extend * @param Name|string $interface Name of interface to extend
* @param Name|string $... More interfaces to extend * @param Name|string $... More interfaces to extend
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function extend() { public function extend() {
foreach (func_get_args() as $interface) { foreach (func_get_args() as $interface) {
@ -45,7 +43,7 @@ class Interface_ extends PhpParser\BuilderAbstract
* *
* @param Stmt|PhpParser\Builder $stmt The statement to add * @param Stmt|PhpParser\Builder $stmt The statement to add
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function addStmt($stmt) { public function addStmt($stmt) {
$stmt = $this->normalizeNode($stmt); $stmt = $this->normalizeNode($stmt);
@ -70,22 +68,7 @@ class Interface_ extends PhpParser\BuilderAbstract
} }
/** /**
* Adds multiple statements. * Returns the built interface node.
*
* @param array $stmts The statements to add
*
* @return self The builder instance (for fluid interface)
*/
public function addStmts(array $stmts) {
foreach ($stmts as $stmt) {
$this->addStmt($stmt);
}
return $this;
}
/**
* Returns the built class node.
* *
* @return Stmt\Interface_ The built interface node * @return Stmt\Interface_ The built interface node
*/ */
@ -93,6 +76,6 @@ class Interface_ extends PhpParser\BuilderAbstract
return new Stmt\Interface_($this->name, array( return new Stmt\Interface_($this->name, array(
'extends' => $this->extends, 'extends' => $this->extends,
'stmts' => array_merge($this->constants, $this->methods), 'stmts' => array_merge($this->constants, $this->methods),
)); ), $this->attributes);
} }
} }

View File

@ -6,14 +6,11 @@ use PhpParser;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Method extends PhpParser\BuilderAbstract class Method extends FunctionLike
{ {
protected $name; protected $name;
protected $type = 0;
protected $type; protected $stmts = array();
protected $returnByRef;
protected $params;
protected $stmts;
/** /**
* Creates a method builder. * Creates a method builder.
@ -22,17 +19,12 @@ class Method extends PhpParser\BuilderAbstract
*/ */
public function __construct($name) { public function __construct($name) {
$this->name = $name; $this->name = $name;
$this->type = 0;
$this->returnByRef = false;
$this->params = array();
$this->stmts = array();
} }
/** /**
* Makes the method public. * Makes the method public.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makePublic() { public function makePublic() {
$this->setModifier(Stmt\Class_::MODIFIER_PUBLIC); $this->setModifier(Stmt\Class_::MODIFIER_PUBLIC);
@ -43,7 +35,7 @@ class Method extends PhpParser\BuilderAbstract
/** /**
* Makes the method protected. * Makes the method protected.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeProtected() { public function makeProtected() {
$this->setModifier(Stmt\Class_::MODIFIER_PROTECTED); $this->setModifier(Stmt\Class_::MODIFIER_PROTECTED);
@ -54,7 +46,7 @@ class Method extends PhpParser\BuilderAbstract
/** /**
* Makes the method private. * Makes the method private.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makePrivate() { public function makePrivate() {
$this->setModifier(Stmt\Class_::MODIFIER_PRIVATE); $this->setModifier(Stmt\Class_::MODIFIER_PRIVATE);
@ -65,7 +57,7 @@ class Method extends PhpParser\BuilderAbstract
/** /**
* Makes the method static. * Makes the method static.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeStatic() { public function makeStatic() {
$this->setModifier(Stmt\Class_::MODIFIER_STATIC); $this->setModifier(Stmt\Class_::MODIFIER_STATIC);
@ -76,7 +68,7 @@ class Method extends PhpParser\BuilderAbstract
/** /**
* Makes the method abstract. * Makes the method abstract.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeAbstract() { public function makeAbstract() {
if (!empty($this->stmts)) { if (!empty($this->stmts)) {
@ -92,7 +84,7 @@ class Method extends PhpParser\BuilderAbstract
/** /**
* Makes the method final. * Makes the method final.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeFinal() { public function makeFinal() {
$this->setModifier(Stmt\Class_::MODIFIER_FINAL); $this->setModifier(Stmt\Class_::MODIFIER_FINAL);
@ -100,57 +92,12 @@ class Method extends PhpParser\BuilderAbstract
return $this; return $this;
} }
/**
* Make the method return by reference.
*
* @return self The builder instance (for fluid interface)
*/
public function makeReturnByRef() {
$this->returnByRef = true;
return $this;
}
/**
* Adds a parameter.
*
* @param Node\Param|Param $param The parameter to add
*
* @return self The builder instance (for fluid interface)
*/
public function addParam($param) {
$param = $this->normalizeNode($param);
if (!$param instanceof Node\Param) {
throw new \LogicException(sprintf('Expected parameter node, got "%s"', $param->getType()));
}
$this->params[] = $param;
return $this;
}
/**
* Adds multiple parameters.
*
* @param array $params The parameters to add
*
* @return self The builder instance (for fluid interface)
*/
public function addParams(array $params) {
foreach ($params as $param) {
$this->addParam($param);
}
return $this;
}
/** /**
* Adds a statement. * Adds a statement.
* *
* @param Node|PhpParser\Builder $stmt The statement to add * @param Node|PhpParser\Builder $stmt The statement to add
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function addStmt($stmt) { public function addStmt($stmt) {
if (null === $this->stmts) { if (null === $this->stmts) {
@ -162,21 +109,6 @@ class Method extends PhpParser\BuilderAbstract
return $this; return $this;
} }
/**
* Adds multiple statements.
*
* @param array $stmts The statements to add
*
* @return self The builder instance (for fluid interface)
*/
public function addStmts(array $stmts) {
foreach ($stmts as $stmt) {
$this->addStmt($stmt);
}
return $this;
}
/** /**
* Returns the built method node. * Returns the built method node.
* *
@ -184,10 +116,10 @@ class Method extends PhpParser\BuilderAbstract
*/ */
public function getNode() { public function getNode() {
return new Stmt\ClassMethod($this->name, array( return new Stmt\ClassMethod($this->name, array(
'type' => $this->type !== 0 ? $this->type : Stmt\Class_::MODIFIER_PUBLIC, 'type' => $this->type,
'byRef' => $this->returnByRef, 'byRef' => $this->returnByRef,
'params' => $this->params, 'params' => $this->params,
'stmts' => $this->stmts, 'stmts' => $this->stmts,
)); ), $this->attributes);
} }
} }

View File

@ -0,0 +1,59 @@
<?php
namespace PhpParser\Builder;
use PhpParser;
use PhpParser\Node;
use PhpParser\Node\Stmt;
class Namespace_ extends PhpParser\BuilderAbstract
{
private $name;
private $stmts = array();
/**
* Creates a namespace builder.
*
* @param Node\Name|string|null $name Name of the namespace
*/
public function __construct($name) {
$this->name = null !== $name ? $this->normalizeName($name) : null;
}
/**
* Adds a statement.
*
* @param Node|PhpParser\Builder $stmt The statement to add
*
* @return $this The builder instance (for fluid interface)
*/
public function addStmt($stmt) {
$this->stmts[] = $this->normalizeNode($stmt);
return $this;
}
/**
* Adds multiple statements.
*
* @param array $stmts The statements to add
*
* @return $this The builder instance (for fluid interface)
*/
public function addStmts(array $stmts) {
foreach ($stmts as $stmt) {
$this->addStmt($stmt);
}
return $this;
}
/**
* Returns the built node.
*
* @return Node The built node
*/
public function getNode() {
return new Stmt\Namespace_($this->name, $this->stmts);
}
}

View File

@ -9,9 +9,9 @@ class Param extends PhpParser\BuilderAbstract
{ {
protected $name; protected $name;
protected $default; protected $default = null;
protected $type; protected $type = null;
protected $byRef; protected $byRef = false;
/** /**
* Creates a parameter builder. * Creates a parameter builder.
@ -20,10 +20,6 @@ class Param extends PhpParser\BuilderAbstract
*/ */
public function __construct($name) { public function __construct($name) {
$this->name = $name; $this->name = $name;
$this->default = null;
$this->type = null;
$this->byRef = false;
} }
/** /**
@ -31,7 +27,7 @@ class Param extends PhpParser\BuilderAbstract
* *
* @param mixed $value Default value to use * @param mixed $value Default value to use
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function setDefault($value) { public function setDefault($value) {
$this->default = $this->normalizeValue($value); $this->default = $this->normalizeValue($value);
@ -44,7 +40,7 @@ class Param extends PhpParser\BuilderAbstract
* *
* @param string|Node\Name $type Type hint to use * @param string|Node\Name $type Type hint to use
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function setTypeHint($type) { public function setTypeHint($type) {
if ($type === 'array' || $type === 'callable') { if ($type === 'array' || $type === 'callable') {
@ -59,7 +55,7 @@ class Param extends PhpParser\BuilderAbstract
/** /**
* Make the parameter accept the value by reference. * Make the parameter accept the value by reference.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeByRef() { public function makeByRef() {
$this->byRef = true; $this->byRef = true;

View File

@ -9,8 +9,9 @@ class Property extends PhpParser\BuilderAbstract
{ {
protected $name; protected $name;
protected $type; protected $type = 0;
protected $default; protected $default = null;
protected $attributes = array();
/** /**
* Creates a property builder. * Creates a property builder.
@ -19,15 +20,12 @@ class Property extends PhpParser\BuilderAbstract
*/ */
public function __construct($name) { public function __construct($name) {
$this->name = $name; $this->name = $name;
$this->type = 0;
$this->default = null;
} }
/** /**
* Makes the property public. * Makes the property public.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makePublic() { public function makePublic() {
$this->setModifier(Stmt\Class_::MODIFIER_PUBLIC); $this->setModifier(Stmt\Class_::MODIFIER_PUBLIC);
@ -38,7 +36,7 @@ class Property extends PhpParser\BuilderAbstract
/** /**
* Makes the property protected. * Makes the property protected.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeProtected() { public function makeProtected() {
$this->setModifier(Stmt\Class_::MODIFIER_PROTECTED); $this->setModifier(Stmt\Class_::MODIFIER_PROTECTED);
@ -49,7 +47,7 @@ class Property extends PhpParser\BuilderAbstract
/** /**
* Makes the property private. * Makes the property private.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makePrivate() { public function makePrivate() {
$this->setModifier(Stmt\Class_::MODIFIER_PRIVATE); $this->setModifier(Stmt\Class_::MODIFIER_PRIVATE);
@ -60,7 +58,7 @@ class Property extends PhpParser\BuilderAbstract
/** /**
* Makes the property static. * Makes the property static.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeStatic() { public function makeStatic() {
$this->setModifier(Stmt\Class_::MODIFIER_STATIC); $this->setModifier(Stmt\Class_::MODIFIER_STATIC);
@ -73,7 +71,7 @@ class Property extends PhpParser\BuilderAbstract
* *
* @param mixed $value Default value to use * @param mixed $value Default value to use
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function setDefault($value) { public function setDefault($value) {
$this->default = $this->normalizeValue($value); $this->default = $this->normalizeValue($value);
@ -81,6 +79,21 @@ class Property extends PhpParser\BuilderAbstract
return $this; return $this;
} }
/**
* Sets doc comment for the property.
*
* @param PhpParser\Comment\Doc|string $docComment Doc comment to set
*
* @return $this The builder instance (for fluid interface)
*/
public function setDocComment($docComment) {
$this->attributes = array(
'comments' => array($this->normalizeDocComment($docComment))
);
return $this;
}
/** /**
* Returns the built class node. * Returns the built class node.
* *
@ -91,7 +104,8 @@ class Property extends PhpParser\BuilderAbstract
$this->type !== 0 ? $this->type : Stmt\Class_::MODIFIER_PUBLIC, $this->type !== 0 ? $this->type : Stmt\Class_::MODIFIER_PUBLIC,
array( array(
new Stmt\PropertyProperty($this->name, $this->default) new Stmt\PropertyProperty($this->name, $this->default)
) ),
$this->attributes
); );
} }
} }

View File

@ -0,0 +1,49 @@
<?php
namespace PhpParser\Builder;
use PhpParser;
use PhpParser\Node\Name;
use PhpParser\Node\Stmt;
class Trait_ extends Declaration
{
protected $name;
protected $methods = array();
/**
* Creates an interface builder.
*
* @param string $name Name of the interface
*/
public function __construct($name) {
$this->name = $name;
}
/**
* Adds a statement.
*
* @param Stmt|PhpParser\Builder $stmt The statement to add
*
* @return $this The builder instance (for fluid interface)
*/
public function addStmt($stmt) {
$stmt = $this->normalizeNode($stmt);
if (!$stmt instanceof Stmt\ClassMethod) {
throw new \LogicException(sprintf('Unexpected node of type "%s"', $stmt->getType()));
}
$this->methods[] = $stmt;
return $this;
}
/**
* Returns the built trait node.
*
* @return Stmt\Trait_ The built interface node
*/
public function getNode() {
return new Stmt\Trait_($this->name, $this->methods, $this->attributes);
}
}

View File

@ -0,0 +1,54 @@
<?php
namespace PhpParser\Builder;
use PhpParser\BuilderAbstract;
use PhpParser\Node;
use PhpParser\Node\Stmt;
/**
* @method $this as(string $alias) Sets alias for used name.
*/
class Use_ extends BuilderAbstract {
protected $name;
protected $type;
protected $alias = null;
/**
* Creates a name use (alias) builder.
*
* @param Node\Name|string $name Name of the entity (namespace, class, function, constant) to alias
* @param int $type One of the Stmt\Use_::TYPE_* constants
*/
public function __construct($name, $type) {
$this->name = $this->normalizeName($name);
$this->type = $type;
}
/**
* Sets alias for used name.
*
* @param string $alias Alias to use (last component of full name by default)
*
* @return $this The builder instance (for fluid interface)
*/
protected function as_($alias) {
$this->alias = $alias;
return $this;
}
public function __call($method, $args) {
return call_user_func_array(array($this, $method . '_'), $args);
}
/**
* Returns the built node.
*
* @return Node The built node
*/
public function getNode() {
$alias = null !== $this->alias ? $this->alias : $this->name->getLast();
return new Stmt\Use_(array(
new Stmt\UseUse($this->name, $alias)
), $this->type);
}
}

View File

@ -6,6 +6,7 @@ use PhpParser\Node\Name;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
use PhpParser\Node\Scalar; use PhpParser\Node\Scalar;
use PhpParser\Comment;
abstract class BuilderAbstract implements Builder { abstract class BuilderAbstract implements Builder {
/** /**
@ -35,9 +36,21 @@ abstract class BuilderAbstract implements Builder {
protected function normalizeName($name) { protected function normalizeName($name) {
if ($name instanceof Name) { if ($name instanceof Name) {
return $name; return $name;
} else { } elseif (is_string($name)) {
return new Name($name); if (!$name) {
throw new \LogicException('Name cannot be empty');
}
if ($name[0] == '\\') {
return new Name\FullyQualified(substr($name, 1));
} elseif (0 === strpos($name, 'namespace\\')) {
return new Name\Relative(substr($name, strlen('namespace\\')));
} else {
return new Name($name);
}
} }
throw new \LogicException('Name must be a string or an instance of PhpParser\Node\Name');
} }
/** /**
@ -64,7 +77,7 @@ abstract class BuilderAbstract implements Builder {
} elseif (is_float($value)) { } elseif (is_float($value)) {
return new Scalar\DNumber($value); return new Scalar\DNumber($value);
} elseif (is_string($value)) { } elseif (is_string($value)) {
return new Scalar\String($value); return new Scalar\String_($value);
} elseif (is_array($value)) { } elseif (is_array($value)) {
$items = array(); $items = array();
$lastKey = -1; $lastKey = -1;
@ -89,6 +102,23 @@ abstract class BuilderAbstract implements Builder {
} }
} }
/**
* Normalizes a doc comment: Converts plain strings to PhpParser\Comment\Doc.
*
* @param Comment\Doc|string $docComment The doc comment to normalize
*
* @return Comment\Doc The normalized doc comment
*/
protected function normalizeDocComment($docComment) {
if ($docComment instanceof Comment\Doc) {
return $docComment;
} else if (is_string($docComment)) {
return new Comment\Doc($docComment);
} else {
throw new \LogicException('Doc comment must be a string or an instance of PhpParser\Comment\Doc');
}
}
/** /**
* Sets a modifier in the $this->type property. * Sets a modifier in the $this->type property.
* *
@ -98,4 +128,4 @@ abstract class BuilderAbstract implements Builder {
Stmt\Class_::verifyModifier($this->type, $modifier); Stmt\Class_::verifyModifier($this->type, $modifier);
$this->type |= $modifier; $this->type |= $modifier;
} }
} }

View File

@ -3,18 +3,32 @@
namespace PhpParser; namespace PhpParser;
use PhpParser\Builder; use PhpParser\Builder;
use PhpParser\Node\Stmt\Use_;
/** /**
* "class", "interface" and "function" are reserved keywords, so the methods are defined as _class(), * The following methods use reserved keywords, so their implementation is defined with an underscore and made available
* _interface() and _function() in the class and are made available as class(), interface() and function() * with the reserved name through __call() magic.
* through __call() magic.
* *
* @method Builder\Namespace_ namespace(string $name) Creates a namespace builder.
* @method Builder\Class_ class(string $name) Creates a class builder. * @method Builder\Class_ class(string $name) Creates a class builder.
* @method Builder\Function_ function(string $name) Creates a function builder
* @method Builder\Interface_ interface(string $name) Creates an interface builder. * @method Builder\Interface_ interface(string $name) Creates an interface builder.
* @method Builder\Trait_ trait(string $name) Creates a trait builder.
* @method Builder\Function_ function(string $name) Creates a function builder.
* @method Builder\Use_ use(string $name) Creates a namespace/class use builder.
*/ */
class BuilderFactory class BuilderFactory
{ {
/**
* Creates a namespace builder.
*
* @param null|string|Node\Name $name Name of the namespace
*
* @return Builder\Namespace_ The created namespace builder
*/
protected function _namespace($name) {
return new Builder\Namespace_($name);
}
/** /**
* Creates a class builder. * Creates a class builder.
* *
@ -27,7 +41,7 @@ class BuilderFactory
} }
/** /**
* Creates a interface builder. * Creates an interface builder.
* *
* @param string $name Name of the interface * @param string $name Name of the interface
* *
@ -37,6 +51,17 @@ class BuilderFactory
return new Builder\Interface_($name); return new Builder\Interface_($name);
} }
/**
* Creates a trait builder.
*
* @param string $name Name of the trait
*
* @return Builder\Trait_ The created trait builder
*/
protected function _trait($name) {
return new Builder\Trait_($name);
}
/** /**
* Creates a method builder. * Creates a method builder.
* *
@ -81,6 +106,17 @@ class BuilderFactory
return new Builder\Function_($name); return new Builder\Function_($name);
} }
/**
* Creates a namespace/class use builder.
*
* @param string|Node\Name Name to alias
*
* @return Builder\Use_ The create use builder
*/
protected function _use($name) {
return new Builder\Use_($name, Use_::TYPE_NORMAL);
}
public function __call($name, array $args) { public function __call($name, array $args) {
if (method_exists($this, '_' . $name)) { if (method_exists($this, '_' . $name)) {
return call_user_func_array(array($this, '_' . $name), $args); return call_user_func_array(array($this, '_' . $name), $args);
@ -88,4 +124,4 @@ class BuilderFactory
throw new \LogicException(sprintf('Method "%s" does not exist', $name)); throw new \LogicException(sprintf('Method "%s" does not exist', $name));
} }
} }

View File

@ -5,17 +5,22 @@ namespace PhpParser;
class Error extends \RuntimeException class Error extends \RuntimeException
{ {
protected $rawMessage; protected $rawMessage;
protected $rawLine; protected $attributes;
/** /**
* Creates an Exception signifying a parse error. * Creates an Exception signifying a parse error.
* *
* @param string $message Error message * @param string $message Error message
* @param int $line Error line in PHP file * @param array|int $attributes Attributes of node/token where error occurred
* (or start line of error -- deprecated)
*/ */
public function __construct($message, $line = -1) { public function __construct($message, $attributes = array()) {
$this->rawMessage = (string) $message; $this->rawMessage = (string) $message;
$this->rawLine = (int) $line; if (is_array($attributes)) {
$this->attributes = $attributes;
} else {
$this->attributes = array('startLine' => $attributes);
}
$this->updateMessage(); $this->updateMessage();
} }
@ -28,6 +33,34 @@ class Error extends \RuntimeException
return $this->rawMessage; return $this->rawMessage;
} }
/**
* Gets the line the error starts in.
*
* @return int Error start line
*/
public function getStartLine() {
return isset($this->attributes['startLine']) ? $this->attributes['startLine'] : -1;
}
/**
* Gets the line the error ends in.
*
* @return int Error end line
*/
public function getEndLine() {
return isset($this->attributes['endLine']) ? $this->attributes['endLine'] : -1;
}
/**
* Gets the attributes of the node/token the error occurred at.
*
* @return array
*/
public function getAttributes() {
return $this->attributes;
}
/** /**
* Sets the line of the PHP file the error occurred in. * Sets the line of the PHP file the error occurred in.
* *
@ -39,22 +72,65 @@ class Error extends \RuntimeException
} }
/** /**
* Gets the error line in the PHP file. * Sets the line the error starts in.
* *
* @return int Error line in the PHP file * @param int $line Error start line
*/ */
public function getRawLine() { public function setStartLine($line) {
return $this->rawLine; $this->attributes['startLine'] = (int) $line;
$this->updateMessage();
} }
/** /**
* Sets the line of the PHP file the error occurred in. * Returns whether the error has start and end column information.
* *
* @param int $line Error line in the PHP file * For column information enable the startFilePos and endFilePos in the lexer options.
*
* @return bool
*/ */
public function setRawLine($line) { public function hasColumnInfo() {
$this->rawLine = (int) $line; return isset($this->attributes['startFilePos']) && isset($this->attributes['endFilePos']);
$this->updateMessage(); }
/**
* Gets the start column (1-based) into the line where the error started.
*
* @param string $code Source code of the file
* @return int
*/
public function getStartColumn($code) {
if (!$this->hasColumnInfo()) {
throw new \RuntimeException('Error does not have column information');
}
return $this->toColumn($code, $this->attributes['startFilePos']);
}
/**
* Gets the end column (1-based) into the line where the error ended.
*
* @param string $code Source code of the file
* @return int
*/
public function getEndColumn($code) {
if (!$this->hasColumnInfo()) {
throw new \RuntimeException('Error does not have column information');
}
return $this->toColumn($code, $this->attributes['endFilePos']);
}
private function toColumn($code, $pos) {
if ($pos > strlen($code)) {
throw new \RuntimeException('Invalid position information');
}
$lineStartPos = strrpos($code, "\n", $pos - strlen($code));
if (false === $lineStartPos) {
$lineStartPos = -1;
}
return $pos - $lineStartPos;
} }
/** /**
@ -63,10 +139,20 @@ class Error extends \RuntimeException
protected function updateMessage() { protected function updateMessage() {
$this->message = $this->rawMessage; $this->message = $this->rawMessage;
if (-1 === $this->rawLine) { if (-1 === $this->getStartLine()) {
$this->message .= ' on unknown line'; $this->message .= ' on unknown line';
} else { } else {
$this->message .= ' on line ' . $this->rawLine; $this->message .= ' on line ' . $this->getStartLine();
} }
} }
}
/** @deprecated Use getStartLine() instead */
public function getRawLine() {
return $this->getStartLine();
}
/** @deprecated Use setStartLine() instead */
public function setRawLine($line) {
$this->setStartLine($line);
}
}

View File

@ -8,20 +8,36 @@ class Lexer
protected $tokens; protected $tokens;
protected $pos; protected $pos;
protected $line; protected $line;
protected $filePos;
protected $tokenMap; protected $tokenMap;
protected $dropTokens; protected $dropTokens;
protected $usedAttributes;
/** /**
* Creates a Lexer. * Creates a Lexer.
*
* @param array $options Options array. Currently only the 'usedAttributes' option is supported,
* which is an array of attributes to add to the AST nodes. Possible attributes
* are: 'comments', 'startLine', 'endLine', 'startTokenPos', 'endTokenPos',
* 'startFilePos', 'endFilePos'. The option defaults to the first three.
* For more info see getNextToken() docs.
*/ */
public function __construct() { public function __construct(array $options = array()) {
// map from internal tokens to PhpParser tokens // map from internal tokens to PhpParser tokens
$this->tokenMap = $this->createTokenMap(); $this->tokenMap = $this->createTokenMap();
// map of tokens to drop while lexing (the map is only used for isset lookup, // map of tokens to drop while lexing (the map is only used for isset lookup,
// that's why the value is simply set to 1; the value is never actually used.) // that's why the value is simply set to 1; the value is never actually used.)
$this->dropTokens = array_fill_keys(array(T_WHITESPACE, T_OPEN_TAG), 1); $this->dropTokens = array_fill_keys(array(T_WHITESPACE, T_OPEN_TAG), 1);
// the usedAttributes member is a map of the used attribute names to a dummy
// value (here "true")
$options += array(
'usedAttributes' => array('comments', 'startLine', 'endLine'),
);
$this->usedAttributes = array_fill_keys($options['usedAttributes'], true);
} }
/** /**
@ -32,17 +48,20 @@ class Lexer
* @throws Error on lexing errors (unterminated comment or unexpected character) * @throws Error on lexing errors (unterminated comment or unexpected character)
*/ */
public function startLexing($code) { public function startLexing($code) {
$scream = ini_set('xdebug.scream', 0); $scream = ini_set('xdebug.scream', '0');
$this->resetErrors(); $this->resetErrors();
$this->tokens = @token_get_all($code); $this->tokens = @token_get_all($code);
$this->handleErrors(); $this->handleErrors();
ini_set('xdebug.scream', $scream); if (false !== $scream) {
ini_set('xdebug.scream', $scream);
}
$this->code = $code; // keep the code around for __halt_compiler() handling $this->code = $code; // keep the code around for __halt_compiler() handling
$this->pos = -1; $this->pos = -1;
$this->line = 1; $this->line = 1;
$this->filePos = 0;
} }
protected function resetErrors() { protected function resetErrors() {
@ -59,7 +78,7 @@ class Lexer
'~^Unterminated comment starting line ([0-9]+)$~', '~^Unterminated comment starting line ([0-9]+)$~',
$error['message'], $matches $error['message'], $matches
)) { )) {
throw new Error('Unterminated comment', $matches[1]); throw new Error('Unterminated comment', (int) $matches[1]);
} }
if (preg_match( if (preg_match(
@ -81,6 +100,19 @@ class Lexer
/** /**
* Fetches the next token. * Fetches the next token.
* *
* The available attributes are determined by the 'usedAttributes' option, which can
* be specified in the constructor. The following attributes are supported:
*
* * 'comments' => Array of PhpParser\Comment or PhpParser\Comment\Doc instances,
* representing all comments that occurred between the previous
* non-discarded token and the current one.
* * 'startLine' => Line in which the node starts.
* * 'endLine' => Line in which the node ends.
* * 'startTokenPos' => Offset into the token array of the first token in the node.
* * 'endTokenPos' => Offset into the token array of the last token in the node.
* * 'startFilePos' => Offset into the code string of the first character that is part of the node.
* * 'endFilePos' => Offset into the code string of the last character that is part of the node
*
* @param mixed $value Variable to store token content in * @param mixed $value Variable to store token content in
* @param mixed $startAttributes Variable to store start attributes in * @param mixed $startAttributes Variable to store start attributes in
* @param mixed $endAttributes Variable to store end attributes in * @param mixed $endAttributes Variable to store end attributes in
@ -91,42 +123,95 @@ class Lexer
$startAttributes = array(); $startAttributes = array();
$endAttributes = array(); $endAttributes = array();
while (isset($this->tokens[++$this->pos])) { while (1) {
$token = $this->tokens[$this->pos]; if (isset($this->tokens[++$this->pos])) {
$token = $this->tokens[$this->pos];
} else {
// EOF token with ID 0
$token = "\0";
}
if (isset($this->usedAttributes['startTokenPos'])) {
$startAttributes['startTokenPos'] = $this->pos;
}
if (isset($this->usedAttributes['startFilePos'])) {
$startAttributes['startFilePos'] = $this->filePos;
}
if (is_string($token)) { if (is_string($token)) {
$startAttributes['startLine'] = $this->line;
$endAttributes['endLine'] = $this->line;
// bug in token_get_all // bug in token_get_all
if ('b"' === $token) { if ('b"' === $token) {
$value = 'b"'; $value = 'b"';
return ord('"'); $this->filePos += 2;
$id = ord('"');
} else { } else {
$value = $token; $value = $token;
return ord($token); $this->filePos += 1;
$id = ord($token);
} }
if (isset($this->usedAttributes['startLine'])) {
$startAttributes['startLine'] = $this->line;
}
if (isset($this->usedAttributes['endLine'])) {
$endAttributes['endLine'] = $this->line;
}
if (isset($this->usedAttributes['endTokenPos'])) {
$endAttributes['endTokenPos'] = $this->pos;
}
if (isset($this->usedAttributes['endFilePos'])) {
$endAttributes['endFilePos'] = $this->filePos - 1;
}
return $id;
} else { } else {
$this->line += substr_count($token[1], "\n"); $this->line += substr_count($token[1], "\n");
$this->filePos += strlen($token[1]);
if (T_COMMENT === $token[0]) { if (T_COMMENT === $token[0]) {
$startAttributes['comments'][] = new Comment($token[1], $token[2]); if (isset($this->usedAttributes['comments'])) {
$startAttributes['comments'][] = new Comment($token[1], $token[2]);
}
} elseif (T_DOC_COMMENT === $token[0]) { } elseif (T_DOC_COMMENT === $token[0]) {
$startAttributes['comments'][] = new Comment\Doc($token[1], $token[2]); if (isset($this->usedAttributes['comments'])) {
$startAttributes['comments'][] = new Comment\Doc($token[1], $token[2]);
}
} elseif (!isset($this->dropTokens[$token[0]])) { } elseif (!isset($this->dropTokens[$token[0]])) {
$value = $token[1]; $value = $token[1];
$startAttributes['startLine'] = $token[2];
$endAttributes['endLine'] = $this->line; if (isset($this->usedAttributes['startLine'])) {
$startAttributes['startLine'] = $token[2];
}
if (isset($this->usedAttributes['endLine'])) {
$endAttributes['endLine'] = $this->line;
}
if (isset($this->usedAttributes['endTokenPos'])) {
$endAttributes['endTokenPos'] = $this->pos;
}
if (isset($this->usedAttributes['endFilePos'])) {
$endAttributes['endFilePos'] = $this->filePos - 1;
}
return $this->tokenMap[$token[0]]; return $this->tokenMap[$token[0]];
} }
} }
} }
$startAttributes['startLine'] = $this->line; throw new \RuntimeException('Reached end of lexer loop');
}
// 0 is the EOF token /**
return 0; * Returns the token array for current code.
*
* The token array is in the same format as provided by the
* token_get_all() function and does not discard tokens (i.e.
* whitespace and comments are included). The token position
* attributes are against this token array.
*
* @return array Array of tokens in token_get_all() format
*/
public function getTokens() {
return $this->tokens;
} }
/** /**
@ -177,20 +262,23 @@ class Lexer
// 256 is the minimum possible token number, as everything below // 256 is the minimum possible token number, as everything below
// it is an ASCII value // it is an ASCII value
for ($i = 256; $i < 1000; ++$i) { for ($i = 256; $i < 1000; ++$i) {
// T_DOUBLE_COLON is equivalent to T_PAAMAYIM_NEKUDOTAYIM
if (T_DOUBLE_COLON === $i) { if (T_DOUBLE_COLON === $i) {
// T_DOUBLE_COLON is equivalent to T_PAAMAYIM_NEKUDOTAYIM
$tokenMap[$i] = Parser::T_PAAMAYIM_NEKUDOTAYIM; $tokenMap[$i] = Parser::T_PAAMAYIM_NEKUDOTAYIM;
// T_OPEN_TAG_WITH_ECHO with dropped T_OPEN_TAG results in T_ECHO
} elseif(T_OPEN_TAG_WITH_ECHO === $i) { } elseif(T_OPEN_TAG_WITH_ECHO === $i) {
// T_OPEN_TAG_WITH_ECHO with dropped T_OPEN_TAG results in T_ECHO
$tokenMap[$i] = Parser::T_ECHO; $tokenMap[$i] = Parser::T_ECHO;
// T_CLOSE_TAG is equivalent to ';'
} elseif(T_CLOSE_TAG === $i) { } elseif(T_CLOSE_TAG === $i) {
// T_CLOSE_TAG is equivalent to ';'
$tokenMap[$i] = ord(';'); $tokenMap[$i] = ord(';');
// and the others can be mapped directly } elseif ('UNKNOWN' !== $name = token_name($i)) {
} elseif ('UNKNOWN' !== ($name = token_name($i)) if ('T_HASHBANG' === $name) {
&& defined($name = 'PhpParser\Parser::' . $name) // HHVM uses a special token for #! hashbang lines
) { $tokenMap[$i] = Parser::T_INLINE_HTML;
$tokenMap[$i] = constant($name); } else if (defined($name = 'PhpParser\Parser::' . $name)) {
// Other tokens can be mapped directly
$tokenMap[$i] = constant($name);
}
} }
} }

View File

@ -12,16 +12,20 @@ class Emulative extends \PhpParser\Lexer
protected $newKeywords; protected $newKeywords;
protected $inObjectAccess; protected $inObjectAccess;
const T_ELLIPSIS = 1001; const T_ELLIPSIS = 1001;
const T_POW = 1002; const T_POW = 1002;
const T_POW_EQUAL = 1003; const T_POW_EQUAL = 1003;
const T_COALESCE = 1004;
const T_SPACESHIP = 1005;
const T_YIELD_FROM = 1006;
const PHP_7_0 = '7.0.0dev';
const PHP_5_6 = '5.6.0rc1'; const PHP_5_6 = '5.6.0rc1';
const PHP_5_5 = '5.5.0beta1'; const PHP_5_5 = '5.5.0beta1';
const PHP_5_4 = '5.4.0beta1'; const PHP_5_4 = '5.4.0beta1';
public function __construct() { public function __construct(array $options = array()) {
parent::__construct(); parent::__construct($options);
$newKeywordsPerVersion = array( $newKeywordsPerVersion = array(
self::PHP_5_5 => array( self::PHP_5_5 => array(
@ -45,11 +49,19 @@ class Emulative extends \PhpParser\Lexer
$this->newKeywords += $newKeywords; $this->newKeywords += $newKeywords;
} }
if (version_compare(PHP_VERSION, self::PHP_5_6, '<')) { if (version_compare(PHP_VERSION, self::PHP_7_0, '>=')) {
$this->tokenMap[self::T_ELLIPSIS] = Parser::T_ELLIPSIS; return;
$this->tokenMap[self::T_POW] = Parser::T_POW;
$this->tokenMap[self::T_POW_EQUAL] = Parser::T_POW_EQUAL;
} }
$this->tokenMap[self::T_COALESCE] = Parser::T_COALESCE;
$this->tokenMap[self::T_SPACESHIP] = Parser::T_SPACESHIP;
$this->tokenMap[self::T_YIELD_FROM] = Parser::T_YIELD_FROM;
if (version_compare(PHP_VERSION, self::PHP_5_6, '>=')) {
return;
}
$this->tokenMap[self::T_ELLIPSIS] = Parser::T_ELLIPSIS;
$this->tokenMap[self::T_POW] = Parser::T_POW;
$this->tokenMap[self::T_POW_EQUAL] = Parser::T_POW_EQUAL;
} }
public function startLexing($code) { public function startLexing($code) {
@ -60,6 +72,10 @@ class Emulative extends \PhpParser\Lexer
if ($preprocessedCode !== $code) { if ($preprocessedCode !== $code) {
$this->postprocessTokens(); $this->postprocessTokens();
} }
// Set code property back to the original code, so __halt_compiler()
// handling and (start|end)FilePos attributes use the correct offsets
$this->code = $code;
} }
/* /*
@ -71,6 +87,17 @@ class Emulative extends \PhpParser\Lexer
* inside a string, i.e. a place where they don't have a special meaning). * inside a string, i.e. a place where they don't have a special meaning).
*/ */
protected function preprocessCode($code) { protected function preprocessCode($code) {
if (version_compare(PHP_VERSION, self::PHP_7_0, '>=')) {
return $code;
}
$code = str_replace('??', '~__EMU__COALESCE__~', $code);
$code = str_replace('<=>', '~__EMU__SPACESHIP__~', $code);
$code = preg_replace_callback('(yield[ \n\r\t]+from)', function($matches) {
// Encoding $0 in order to preserve exact whitespace
return '~__EMU__YIELDFROM__' . bin2hex($matches[0]) . '__~';
}, $code);
if (version_compare(PHP_VERSION, self::PHP_5_6, '>=')) { if (version_compare(PHP_VERSION, self::PHP_5_6, '>=')) {
return $code; return $code;
} }
@ -106,8 +133,9 @@ class Emulative extends \PhpParser\Lexer
if ('BINARY' === $matches[1]) { if ('BINARY' === $matches[1]) {
// the binary number can either be an integer or a double, so return a LNUMBER // the binary number can either be an integer or a double, so return a LNUMBER
// or DNUMBER respectively // or DNUMBER respectively
$isInt = is_int(bindec($matches[2]));
$replace = array( $replace = array(
array(is_int(bindec($matches[2])) ? T_LNUMBER : T_DNUMBER, $matches[2], $this->tokens[$i + 1][2]) array($isInt ? T_LNUMBER : T_DNUMBER, $matches[2], $this->tokens[$i + 1][2])
); );
} else if ('ELLIPSIS' === $matches[1]) { } else if ('ELLIPSIS' === $matches[1]) {
$replace = array( $replace = array(
@ -121,9 +149,21 @@ class Emulative extends \PhpParser\Lexer
$replace = array( $replace = array(
array(self::T_POW_EQUAL, '**=', $this->tokens[$i + 1][2]) array(self::T_POW_EQUAL, '**=', $this->tokens[$i + 1][2])
); );
} else if ('COALESCE' === $matches[1]) {
$replace = array(
array(self::T_COALESCE, '??', $this->tokens[$i + 1][2])
);
} else if ('SPACESHIP' === $matches[1]) {
$replace = array(
array(self::T_SPACESHIP, '<=>', $this->tokens[$i + 1][2]),
);
} else if ('YIELDFROM' === $matches[1]) {
$content = $this->hex2bin($matches[2]);
$replace = array(
array(self::T_YIELD_FROM, $content, $this->tokens[$i + 1][2] - substr_count($content, "\n"))
);
} else { } else {
// just ignore all other __EMU__ sequences throw new \RuntimeException('Invalid __EMU__ sequence');
continue;
} }
array_splice($this->tokens, $i, 3, $replace); array_splice($this->tokens, $i, 3, $replace);
@ -155,11 +195,22 @@ class Emulative extends \PhpParser\Lexer
return '**'; return '**';
} else if ('POWEQUAL' === $matches[1]) { } else if ('POWEQUAL' === $matches[1]) {
return '**='; return '**=';
} else if ('COALESCE' === $matches[1]) {
return '??';
} else if ('SPACESHIP' === $matches[1]) {
return '<=>';
} else if ('YIELDFROM' === $matches[1]) {
return $this->hex2bin($matches[2]);
} else { } else {
return $matches[0]; return $matches[0];
} }
} }
private function hex2bin($str) {
// TODO Drop when removing support for PHP 5.3
return pack('H*', $str);
}
public function getNextToken(&$value = null, &$startAttributes = null, &$endAttributes = null) { public function getNextToken(&$value = null, &$startAttributes = null, &$endAttributes = null) {
$token = parent::getNextToken($value, $startAttributes, $endAttributes); $token = parent::getNextToken($value, $startAttributes, $endAttributes);
@ -170,13 +221,11 @@ class Emulative extends \PhpParser\Lexer
if (isset($this->newKeywords[strtolower($value)])) { if (isset($this->newKeywords[strtolower($value)])) {
return $this->newKeywords[strtolower($value)]; return $this->newKeywords[strtolower($value)];
} }
// keep track of whether we currently are in an object access (after ->)
} elseif (Parser::T_OBJECT_OPERATOR === $token) {
$this->inObjectAccess = true;
} else { } else {
$this->inObjectAccess = false; // keep track of whether we currently are in an object access (after ->)
$this->inObjectAccess = Parser::T_OBJECT_OPERATOR === $token;
} }
return $token; return $token;
} }
} }

View File

@ -4,13 +4,15 @@ namespace PhpParser\Node;
use PhpParser\NodeAbstract; use PhpParser\NodeAbstract;
/**
* @property Expr $value Value to pass
* @property bool $byRef Whether to pass by ref
* @property bool $unpack Whether to unpack the argument
*/
class Arg extends NodeAbstract class Arg extends NodeAbstract
{ {
/** @var Expr Value to pass */
public $value;
/** @var bool Whether to pass by ref */
public $byRef;
/** @var bool Whether to unpack the argument */
public $unpack;
/** /**
* Constructs a function call argument node. * Constructs a function call argument node.
* *
@ -20,13 +22,13 @@ class Arg extends NodeAbstract
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $value, $byRef = false, $unpack = false, array $attributes = array()) { public function __construct(Expr $value, $byRef = false, $unpack = false, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->value = $value;
'value' => $value, $this->byRef = $byRef;
'byRef' => $byRef, $this->unpack = $unpack;
'unpack' => $unpack,
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('value', 'byRef', 'unpack');
}
}

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node;
use PhpParser\NodeAbstract; use PhpParser\NodeAbstract;
/**
* @property string $name Name
* @property Expr $value Value
*/
class Const_ extends NodeAbstract class Const_ extends NodeAbstract
{ {
/** @var string Name */
public $name;
/** @var Expr Value */
public $value;
/** /**
* Constructs a const node for use in class const and const statements. * Constructs a const node for use in class const and const statements.
* *
@ -18,12 +19,12 @@ class Const_ extends NodeAbstract
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($name, Expr $value, array $attributes = array()) { public function __construct($name, Expr $value, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->name = $name;
'name' => $name, $this->value = $value;
'value' => $value,
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('name', 'value');
}
}

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable
* @property null|Expr $dim Array index / dim
*/
class ArrayDimFetch extends Expr class ArrayDimFetch extends Expr
{ {
/** @var Expr Variable */
public $var;
/** @var null|Expr Array index / dim */
public $dim;
/** /**
* Constructs an array index fetch node. * Constructs an array index fetch node.
* *
@ -18,12 +19,12 @@ class ArrayDimFetch extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, Expr $dim = null, array $attributes = array()) { public function __construct(Expr $var, Expr $dim = null, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->var = $var;
'var' => $var, $this->dim = $dim;
'dim' => $dim
),
$attributes
);
} }
}
public function getSubnodeNames() {
return array('var', 'dim');
}
}

View File

@ -4,13 +4,15 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $value Value
* @property null|Expr $key Key
* @property bool $byRef Whether to assign by reference
*/
class ArrayItem extends Expr class ArrayItem extends Expr
{ {
/** @var null|Expr Key */
public $key;
/** @var Expr Value */
public $value;
/** @var bool Whether to assign by reference */
public $byRef;
/** /**
* Constructs an array item node. * Constructs an array item node.
* *
@ -20,13 +22,13 @@ class ArrayItem extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $value, Expr $key = null, $byRef = false, array $attributes = array()) { public function __construct(Expr $value, Expr $key = null, $byRef = false, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->key = $key;
'key' => $key, $this->value = $value;
'value' => $value, $this->byRef = $byRef;
'byRef' => $byRef
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('key', 'value', 'byRef');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property ArrayItem[] $items Items
*/
class Array_ extends Expr class Array_ extends Expr
{ {
/** @var ArrayItem[] Items */
public $items;
/** /**
* Constructs an array node. * Constructs an array node.
* *
@ -16,11 +16,11 @@ class Array_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $items = array(), array $attributes = array()) { public function __construct(array $items = array(), array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->items = $items;
'items' => $items
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('items');
}
}

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable
* @property Expr $expr Expression
*/
class Assign extends Expr class Assign extends Expr
{ {
/** @var Expr Variable */
public $var;
/** @var Expr Expression */
public $expr;
/** /**
* Constructs an assignment node. * Constructs an assignment node.
* *
@ -18,12 +19,12 @@ class Assign extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, Expr $expr, array $attributes = array()) { public function __construct(Expr $var, Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->var = $var;
'var' => $var, $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('var', 'expr');
}
}

View File

@ -10,6 +10,11 @@ use PhpParser\Node\Expr;
*/ */
abstract class AssignOp extends Expr abstract class AssignOp extends Expr
{ {
/** @var Expr Variable */
public $var;
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a compound assignment operation node. * Constructs a compound assignment operation node.
* *
@ -18,12 +23,12 @@ abstract class AssignOp extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, Expr $expr, array $attributes = array()) { public function __construct(Expr $var, Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->var = $var;
'var' => $var, $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('var', 'expr');
}
}

View File

@ -10,6 +10,11 @@ use PhpParser\Node\Expr;
*/ */
class AssignRef extends Expr class AssignRef extends Expr
{ {
/** @var Expr Variable reference is assigned to */
public $var;
/** @var Expr Variable which is referenced */
public $expr;
/** /**
* Constructs an assignment node. * Constructs an assignment node.
* *
@ -18,12 +23,12 @@ class AssignRef extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, Expr $expr, array $attributes = array()) { public function __construct(Expr $var, Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->var = $var;
'var' => $var, $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('var', 'expr');
}
}

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/** abstract class BinaryOp extends Expr
* @property Expr $left The left hand side expression
* @property Expr $right The right hand side expression
*/
class BinaryOp extends Expr
{ {
/** @var Expr The left hand side expression */
public $left;
/** @var Expr The right hand side expression */
public $right;
/** /**
* Constructs a bitwise and node. * Constructs a bitwise and node.
* *
@ -18,12 +19,12 @@ class BinaryOp extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $left, Expr $right, array $attributes = array()) { public function __construct(Expr $left, Expr $right, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->left = $left;
'left' => $left, $this->right = $right;
'right' => $right
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('left', 'right');
}
}

View File

@ -0,0 +1,9 @@
<?php
namespace PhpParser\Node\Expr\BinaryOp;
use PhpParser\Node\Expr\BinaryOp;
class Coalesce extends BinaryOp
{
}

View File

@ -0,0 +1,9 @@
<?php
namespace PhpParser\Node\Expr\BinaryOp;
use PhpParser\Node\Expr\BinaryOp;
class Spaceship extends BinaryOp
{
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class BitwiseNot extends Expr class BitwiseNot extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a bitwise not node. * Constructs a bitwise not node.
* *
@ -16,11 +16,11 @@ class BitwiseNot extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('expr');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class BooleanNot extends Expr class BooleanNot extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a boolean not node. * Constructs a boolean not node.
* *
@ -16,11 +16,11 @@ class BooleanNot extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('expr');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
abstract class Cast extends Expr abstract class Cast extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a cast node. * Constructs a cast node.
* *
@ -16,11 +16,11 @@ abstract class Cast extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('expr');
}
}

View File

@ -4,6 +4,6 @@ namespace PhpParser\Node\Expr\Cast;
use PhpParser\Node\Expr\Cast; use PhpParser\Node\Expr\Cast;
class Int extends Cast class Bool_ extends Cast
{ {
} }

View File

@ -6,4 +6,4 @@ use PhpParser\Node\Expr\Cast;
class Double extends Cast class Double extends Cast
{ {
} }

View File

@ -4,6 +4,6 @@ namespace PhpParser\Node\Expr\Cast;
use PhpParser\Node\Expr\Cast; use PhpParser\Node\Expr\Cast;
class Bool extends Cast class Int_ extends Cast
{ {
} }

View File

@ -4,6 +4,6 @@ namespace PhpParser\Node\Expr\Cast;
use PhpParser\Node\Expr\Cast; use PhpParser\Node\Expr\Cast;
class Object extends Cast class Object_ extends Cast
{ {
} }

View File

@ -4,6 +4,6 @@ namespace PhpParser\Node\Expr\Cast;
use PhpParser\Node\Expr\Cast; use PhpParser\Node\Expr\Cast;
class String extends Cast class String_ extends Cast
{ {
} }

View File

@ -5,12 +5,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Name; use PhpParser\Node\Name;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Name|Expr $class Class name
* @property string $name Constant name
*/
class ClassConstFetch extends Expr class ClassConstFetch extends Expr
{ {
/** @var Name|Expr Class name */
public $class;
/** @var string Constant name */
public $name;
/** /**
* Constructs a class const fetch node. * Constructs a class const fetch node.
* *
@ -19,12 +20,12 @@ class ClassConstFetch extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($class, $name, array $attributes = array()) { public function __construct($class, $name, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->class = $class;
'class' => $class, $this->name = $name;
'name' => $name
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('class', 'name');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class Clone_ extends Expr class Clone_ extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a clone node. * Constructs a clone node.
* *
@ -16,11 +16,11 @@ class Clone_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('expr');
}
}

View File

@ -5,36 +5,44 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Node[] $stmts Statements
* @property Node\Param[] $params Parameters
* @property ClosureUse[] $uses use()s
* @property bool $byRef Whether to return by reference
* @property bool $static Whether the closure is static
*/
class Closure extends Expr class Closure extends Expr
{ {
/** @var bool Whether the closure is static */
public $static;
/** @var bool Whether to return by reference */
public $byRef;
/** @var Node\Param[] Parameters */
public $params;
/** @var ClosureUse[] use()s */
public $uses;
/** @var null|string|Node\Name[] Return type */
public $returnType;
/** @var Node[] Statements */
public $stmts;
/** /**
* Constructs a lambda function node. * Constructs a lambda function node.
* *
* @param array $subNodes Array of the following optional subnodes: * @param array $subNodes Array of the following optional subnodes:
* 'static' => false : Whether the closure is static * 'static' => false : Whether the closure is static
* 'byRef' => false : Whether to return by reference * 'byRef' => false : Whether to return by reference
* 'params' => array(): Parameters * 'params' => array(): Parameters
* 'uses' => array(): use()s * 'uses' => array(): use()s
* 'stmts' => array(): Statements * 'returnType' => null : Return type
* 'stmts' => array(): Statements
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $subNodes = array(), array $attributes = array()) { public function __construct(array $subNodes = array(), array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->static = isset($subNodes['static']) ? $subNodes['static'] : false;
'static' => isset($subNodes['static']) ? $subNodes['static'] : false, $this->byRef = isset($subNodes['byRef']) ? $subNodes['byRef'] : false;
'byRef' => isset($subNodes['byRef']) ? $subNodes['byRef'] : false, $this->params = isset($subNodes['params']) ? $subNodes['params'] : array();
'params' => isset($subNodes['params']) ? $subNodes['params'] : array(), $this->uses = isset($subNodes['uses']) ? $subNodes['uses'] : array();
'uses' => isset($subNodes['uses']) ? $subNodes['uses'] : array(), $this->returnType = isset($subNodes['returnType']) ? $subNodes['returnType'] : null;
'stmts' => isset($subNodes['stmts']) ? $subNodes['stmts'] : array(), $this->stmts = isset($subNodes['stmts']) ? $subNodes['stmts'] : array();
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('static', 'byRef', 'params', 'uses', 'returnType', 'stmts');
}
}

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property string $var Name of variable
* @property bool $byRef Whether to use by reference
*/
class ClosureUse extends Expr class ClosureUse extends Expr
{ {
/** @var string Name of variable */
public $var;
/** @var bool Whether to use by reference */
public $byRef;
/** /**
* Constructs a closure use node. * Constructs a closure use node.
* *
@ -18,12 +19,12 @@ class ClosureUse extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($var, $byRef = false, array $attributes = array()) { public function __construct($var, $byRef = false, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->var = $var;
'var' => $var, $this->byRef = $byRef;
'byRef' => $byRef
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('var', 'byRef');
}
}

View File

@ -5,11 +5,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Name; use PhpParser\Node\Name;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Name $name Constant name
*/
class ConstFetch extends Expr class ConstFetch extends Expr
{ {
/** @var Name Constant name */
public $name;
/** /**
* Constructs a const fetch node. * Constructs a const fetch node.
* *
@ -17,11 +17,11 @@ class ConstFetch extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Name $name, array $attributes = array()) { public function __construct(Name $name, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->name = $name;
'name' => $name
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('name');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class Empty_ extends Expr class Empty_ extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs an empty() node. * Constructs an empty() node.
* *
@ -16,11 +16,11 @@ class Empty_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('expr');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class ErrorSuppress extends Expr class ErrorSuppress extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs an error suppress node. * Constructs an error suppress node.
* *
@ -16,11 +16,11 @@ class ErrorSuppress extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('expr');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class Eval_ extends Expr class Eval_ extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs an eval() node. * Constructs an eval() node.
* *
@ -16,11 +16,11 @@ class Eval_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('expr');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property null|Expr $expr Expression
*/
class Exit_ extends Expr class Exit_ extends Expr
{ {
/** @var null|Expr Expression */
public $expr;
/** /**
* Constructs an exit() node. * Constructs an exit() node.
* *
@ -16,11 +16,11 @@ class Exit_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr = null, array $attributes = array()) { public function __construct(Expr $expr = null, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('expr');
}
}

View File

@ -5,12 +5,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Node\Name|Expr $name Function name
* @property Node\Arg[] $args Arguments
*/
class FuncCall extends Expr class FuncCall extends Expr
{ {
/** @var Node\Name|Expr Function name */
public $name;
/** @var Node\Arg[] Arguments */
public $args;
/** /**
* Constructs a function call node. * Constructs a function call node.
* *
@ -19,12 +20,12 @@ class FuncCall extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($name, array $args = array(), array $attributes = array()) { public function __construct($name, array $args = array(), array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->name = $name;
'name' => $name, $this->args = $args;
'args' => $args
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('name', 'args');
}
}

View File

@ -4,10 +4,6 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
* @property int $type Type of include
*/
class Include_ extends Expr class Include_ extends Expr
{ {
const TYPE_INCLUDE = 1; const TYPE_INCLUDE = 1;
@ -15,6 +11,11 @@ class Include_ extends Expr
const TYPE_REQUIRE = 3; const TYPE_REQUIRE = 3;
const TYPE_REQUIRE_ONCE = 4; const TYPE_REQUIRE_ONCE = 4;
/** @var Expr Expression */
public $expr;
/** @var int Type of include */
public $type;
/** /**
* Constructs an include node. * Constructs an include node.
* *
@ -23,12 +24,12 @@ class Include_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, $type, array $attributes = array()) { public function __construct(Expr $expr, $type, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->expr = $expr;
'expr' => $expr, $this->type = $type;
'type' => $type
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('expr', 'type');
}
}

View File

@ -5,12 +5,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Name; use PhpParser\Node\Name;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
* @property Name|Expr $class Class name
*/
class Instanceof_ extends Expr class Instanceof_ extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** @var Name|Expr Class name */
public $class;
/** /**
* Constructs an instanceof check node. * Constructs an instanceof check node.
* *
@ -19,12 +20,12 @@ class Instanceof_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, $class, array $attributes = array()) { public function __construct(Expr $expr, $class, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->expr = $expr;
'expr' => $expr, $this->class = $class;
'class' => $class
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('expr', 'class');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr[] $vars Variables
*/
class Isset_ extends Expr class Isset_ extends Expr
{ {
/** @var Expr[] Variables */
public $vars;
/** /**
* Constructs an array node. * Constructs an array node.
* *
@ -16,11 +16,11 @@ class Isset_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $vars, array $attributes = array()) { public function __construct(array $vars, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->vars = $vars;
'vars' => $vars
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('vars');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr[] $vars List of variables to assign to
*/
class List_ extends Expr class List_ extends Expr
{ {
/** @var Expr[] List of variables to assign to */
public $vars;
/** /**
* Constructs a list() destructuring node. * Constructs a list() destructuring node.
* *
@ -16,11 +16,11 @@ class List_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $vars, array $attributes = array()) { public function __construct(array $vars, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->vars = $vars;
'vars' => $vars,
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('vars');
}
}

View File

@ -5,13 +5,15 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Arg; use PhpParser\Node\Arg;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable holding object
* @property string|Expr $name Method name
* @property Arg[] $args Arguments
*/
class MethodCall extends Expr class MethodCall extends Expr
{ {
/** @var Expr Variable holding object */
public $var;
/** @var string|Expr Method name */
public $name;
/** @var Arg[] Arguments */
public $args;
/** /**
* Constructs a function call node. * Constructs a function call node.
* *
@ -21,13 +23,13 @@ class MethodCall extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, $name, array $args = array(), array $attributes = array()) { public function __construct(Expr $var, $name, array $args = array(), array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->var = $var;
'var' => $var, $this->name = $name;
'name' => $name, $this->args = $args;
'args' => $args
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('var', 'name', 'args');
}
}

View File

@ -5,26 +5,27 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Node\Name|Expr $class Class name
* @property Node\Arg[] $args Arguments
*/
class New_ extends Expr class New_ extends Expr
{ {
/** @var Node\Name|Expr|Node\Stmt\Class_ Class name */
public $class;
/** @var Node\Arg[] Arguments */
public $args;
/** /**
* Constructs a function call node. * Constructs a function call node.
* *
* @param Node\Name|Expr $class Class name * @param Node\Name|Expr|Node\Stmt\Class_ $class Class name (or class node for anonymous classes)
* @param Node\Arg[] $args Arguments * @param Node\Arg[] $args Arguments
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($class, array $args = array(), array $attributes = array()) { public function __construct($class, array $args = array(), array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->class = $class;
'class' => $class, $this->args = $args;
'args' => $args
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('class', 'args');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable
*/
class PostDec extends Expr class PostDec extends Expr
{ {
/** @var Expr Variable */
public $var;
/** /**
* Constructs a post decrement node. * Constructs a post decrement node.
* *
@ -16,11 +16,11 @@ class PostDec extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, array $attributes = array()) { public function __construct(Expr $var, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->var = $var;
'var' => $var
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('var');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable
*/
class PostInc extends Expr class PostInc extends Expr
{ {
/** @var Expr Variable */
public $var;
/** /**
* Constructs a post increment node. * Constructs a post increment node.
* *
@ -16,11 +16,11 @@ class PostInc extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, array $attributes = array()) { public function __construct(Expr $var, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->var = $var;
'var' => $var
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('var');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable
*/
class PreDec extends Expr class PreDec extends Expr
{ {
/** @var Expr Variable */
public $var;
/** /**
* Constructs a pre decrement node. * Constructs a pre decrement node.
* *
@ -16,11 +16,11 @@ class PreDec extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, array $attributes = array()) { public function __construct(Expr $var, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->var = $var;
'var' => $var
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('var');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable
*/
class PreInc extends Expr class PreInc extends Expr
{ {
/** @var Expr Variable */
public $var;
/** /**
* Constructs a pre increment node. * Constructs a pre increment node.
* *
@ -16,11 +16,11 @@ class PreInc extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, array $attributes = array()) { public function __construct(Expr $var, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->var = $var;
'var' => $var
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('var');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class Print_ extends Expr class Print_ extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs an print() node. * Constructs an print() node.
* *
@ -16,11 +16,11 @@ class Print_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('expr');
}
}

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable holding object
* @property string|Expr $name Property Name
*/
class PropertyFetch extends Expr class PropertyFetch extends Expr
{ {
/** @var Expr Variable holding object */
public $var;
/** @var string|Expr Property name */
public $name;
/** /**
* Constructs a function call node. * Constructs a function call node.
* *
@ -18,12 +19,12 @@ class PropertyFetch extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, $name, array $attributes = array()) { public function __construct(Expr $var, $name, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->var = $var;
'var' => $var, $this->name = $name;
'name' => $name
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('var', 'name');
}
}

View File

@ -4,23 +4,23 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property array $parts Encapsed string array
*/
class ShellExec extends Expr class ShellExec extends Expr
{ {
/** @var array Encapsed string array */
public $parts;
/** /**
* Constructs a shell exec (backtick) node. * Constructs a shell exec (backtick) node.
* *
* @param array $parts Encapsed string array * @param array $parts Encapsed string array
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($parts, array $attributes = array()) { public function __construct(array $parts, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->parts = $parts;
'parts' => $parts
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('parts');
}
}

View File

@ -5,13 +5,15 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Node\Name|Expr $class Class name
* @property string|Expr $name Method name
* @property Node\Arg[] $args Arguments
*/
class StaticCall extends Expr class StaticCall extends Expr
{ {
/** @var Node\Name|Expr Class name */
public $class;
/** @var string|Expr Method name */
public $name;
/** @var Node\Arg[] Arguments */
public $args;
/** /**
* Constructs a static method call node. * Constructs a static method call node.
* *
@ -21,13 +23,13 @@ class StaticCall extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($class, $name, array $args = array(), array $attributes = array()) { public function __construct($class, $name, array $args = array(), array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->class = $class;
'class' => $class, $this->name = $name;
'name' => $name, $this->args = $args;
'args' => $args
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('class', 'name', 'args');
}
}

View File

@ -5,12 +5,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Name; use PhpParser\Node\Name;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Name|Expr $class Class name
* @property string|Expr $name Property name
*/
class StaticPropertyFetch extends Expr class StaticPropertyFetch extends Expr
{ {
/** @var Name|Expr Class name */
public $class;
/** @var string|Expr Property name */
public $name;
/** /**
* Constructs a static property fetch node. * Constructs a static property fetch node.
* *
@ -19,12 +20,12 @@ class StaticPropertyFetch extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($class, $name, array $attributes = array()) { public function __construct($class, $name, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->class = $class;
'class' => $class, $this->name = $name;
'name' => $name
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('class', 'name');
}
}

View File

@ -4,13 +4,15 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $cond Condition
* @property null|Expr $if Expression for true
* @property Expr $else Expression for false
*/
class Ternary extends Expr class Ternary extends Expr
{ {
/** @var Expr Condition */
public $cond;
/** @var null|Expr Expression for true */
public $if;
/** @var Expr Expression for false */
public $else;
/** /**
* Constructs a ternary operator node. * Constructs a ternary operator node.
* *
@ -20,13 +22,13 @@ class Ternary extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $cond, $if, Expr $else, array $attributes = array()) { public function __construct(Expr $cond, $if, Expr $else, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->cond = $cond;
'cond' => $cond, $this->if = $if;
'if' => $if, $this->else = $else;
'else' => $else
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('cond', 'if', 'else');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class UnaryMinus extends Expr class UnaryMinus extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a unary minus node. * Constructs a unary minus node.
* *
@ -16,11 +16,11 @@ class UnaryMinus extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('expr');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class UnaryPlus extends Expr class UnaryPlus extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a unary plus node. * Constructs a unary plus node.
* *
@ -16,11 +16,11 @@ class UnaryPlus extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->expr = $expr;
'expr' => $expr
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('expr');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property string|Expr $name Name
*/
class Variable extends Expr class Variable extends Expr
{ {
/** @var string|Expr Name */
public $name;
/** /**
* Constructs a variable node. * Constructs a variable node.
* *
@ -16,11 +16,11 @@ class Variable extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($name, array $attributes = array()) { public function __construct($name, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->name = $name;
'name' => $name
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('name');
}
}

View File

@ -0,0 +1,26 @@
<?php
namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr;
class YieldFrom extends Expr
{
/** @var Expr Expression to yield from */
public $expr;
/**
* Constructs an "yield from" node.
*
* @param Expr $expr Expression
* @param array $attributes Additional attributes
*/
public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct(null, $attributes);
$this->expr = $expr;
}
public function getSubNodeNames() {
return array('expr');
}
}

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property null|Expr $value Value expression
* @property null|Expr $key Key expression
*/
class Yield_ extends Expr class Yield_ extends Expr
{ {
/** @var null|Expr Key expression */
public $key;
/** @var null|Expr Value expression */
public $value;
/** /**
* Constructs a yield expression node. * Constructs a yield expression node.
* *
@ -18,12 +19,12 @@ class Yield_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $value = null, Expr $key = null, array $attributes = array()) { public function __construct(Expr $value = null, Expr $key = null, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->key = $key;
'key' => $key, $this->value = $value;
'value' => $value,
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('key', 'value');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node;
use PhpParser\NodeAbstract; use PhpParser\NodeAbstract;
/**
* @property array $parts Parts of the name
*/
class Name extends NodeAbstract class Name extends NodeAbstract
{ {
/** @var string[] Parts of the name */
public $parts;
/** /**
* Constructs a name node. * Constructs a name node.
* *
@ -20,12 +20,12 @@ class Name extends NodeAbstract
$parts = explode('\\', $parts); $parts = explode('\\', $parts);
} }
parent::__construct( parent::__construct(null, $attributes);
array( $this->parts = $parts;
'parts' => $parts, }
),
$attributes public function getSubNodeNames() {
); return array('parts');
} }
/** /**
@ -169,4 +169,4 @@ class Name extends NodeAbstract
'When changing a name you need to pass either a string, an array or a Name node' 'When changing a name you need to pass either a string, an array or a Name node'
); );
} }
} }

View File

@ -5,15 +5,19 @@ namespace PhpParser\Node;
use PhpParser\Error; use PhpParser\Error;
use PhpParser\NodeAbstract; use PhpParser\NodeAbstract;
/**
* @property null|string|Name $type Typehint
* @property bool $byRef Whether is passed by reference
* @property bool $variadic Whether this is a variadic argument
* @property string $name Name
* @property null|Expr $default Default value
*/
class Param extends NodeAbstract class Param extends NodeAbstract
{ {
/** @var null|string|Name Typehint */
public $type;
/** @var bool Whether parameter is passed by reference */
public $byRef;
/** @var bool Whether this is a variadic argument */
public $variadic;
/** @var string Name */
public $name;
/** @var null|Expr Default value */
public $default;
/** /**
* Constructs a parameter node. * Constructs a parameter node.
* *
@ -24,20 +28,20 @@ class Param extends NodeAbstract
* @param bool $variadic Whether this is a variadic argument * @param bool $variadic Whether this is a variadic argument
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($name, $default = null, $type = null, $byRef = false, $variadic = false, array $attributes = array()) { public function __construct($name, Expr $default = null, $type = null, $byRef = false, $variadic = false, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->type = $type;
'type' => $type, $this->byRef = $byRef;
'byRef' => $byRef, $this->variadic = $variadic;
'variadic' => $variadic, $this->name = $name;
'name' => $name, $this->default = $default;
'default' => $default,
),
$attributes
);
if ($variadic && null !== $default) { if ($variadic && null !== $default) {
throw new Error('Variadic parameter cannot have a default value'); throw new Error('Variadic parameter cannot have a default value', $default->getAttributes());
} }
} }
}
public function getSubNodeNames() {
return array('type', 'byRef', 'variadic', 'name', 'default');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Scalar;
use PhpParser\Node\Scalar; use PhpParser\Node\Scalar;
/**
* @property float $value Number value
*/
class DNumber extends Scalar class DNumber extends Scalar
{ {
/** @var float Number value */
public $value;
/** /**
* Constructs a float number scalar node. * Constructs a float number scalar node.
* *
@ -16,12 +16,12 @@ class DNumber extends Scalar
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($value = 0.0, array $attributes = array()) { public function __construct($value = 0.0, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->value = $value;
'value' => $value }
),
$attributes public function getSubNodeNames() {
); return array('value');
} }
/** /**
@ -61,4 +61,4 @@ class DNumber extends Scalar
// dec // dec
return (float) $str; return (float) $str;
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Scalar;
use PhpParser\Node\Scalar; use PhpParser\Node\Scalar;
/**
* @property array $parts Encaps list
*/
class Encapsed extends Scalar class Encapsed extends Scalar
{ {
/** @var array Encaps list */
public $parts;
/** /**
* Constructs an encapsed string node. * Constructs an encapsed string node.
* *
@ -16,11 +16,11 @@ class Encapsed extends Scalar
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $parts = array(), array $attributes = array()) { public function __construct(array $parts = array(), array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->parts = $parts;
'parts' => $parts
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('parts');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Scalar;
use PhpParser\Node\Scalar; use PhpParser\Node\Scalar;
/**
* @property int $value Number value
*/
class LNumber extends Scalar class LNumber extends Scalar
{ {
/** @var int Number value */
public $value;
/** /**
* Constructs an integer number scalar node. * Constructs an integer number scalar node.
* *
@ -16,12 +16,12 @@ class LNumber extends Scalar
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($value = 0, array $attributes = array()) { public function __construct($value = 0, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->value = $value;
'value' => $value }
),
$attributes public function getSubNodeNames() {
); return array('value');
} }
/** /**
@ -58,4 +58,4 @@ class LNumber extends Scalar
// dec // dec
return (int) $str; return (int) $str;
} }
} }

View File

@ -12,7 +12,11 @@ abstract class MagicConst extends Scalar
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $attributes = array()) { public function __construct(array $attributes = array()) {
parent::__construct(array(), $attributes); parent::__construct(null, $attributes);
}
public function getSubNodeNames() {
return array();
} }
/** /**
@ -21,4 +25,4 @@ abstract class MagicConst extends Scalar
* @return string Name of magic constant * @return string Name of magic constant
*/ */
abstract public function getName(); abstract public function getName();
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Scalar;
use PhpParser\Node\Scalar; use PhpParser\Node\Scalar;
/** class String_ extends Scalar
* @property string $value String value
*/
class String extends Scalar
{ {
/** @var string String value */
public $value;
protected static $replacements = array( protected static $replacements = array(
'\\' => '\\', '\\' => '\\',
'$' => '$', '$' => '$',
@ -27,12 +27,12 @@ class String extends Scalar
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($value = '', array $attributes = array()) { public function __construct($value = '', array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->value = $value;
'value' => $value }
),
$attributes public function getSubNodeNames() {
); return array('value');
} }
/** /**
@ -116,4 +116,4 @@ class String extends Scalar
return self::parseEscapeSequences($str, null); return self::parseEscapeSequences($str, null);
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Stmt;
use PhpParser\Node; use PhpParser\Node;
/**
* @property null|Node\Expr $num Number of loops to break
*/
class Break_ extends Node\Stmt class Break_ extends Node\Stmt
{ {
/** @var null|Node\Expr Number of loops to break */
public $num;
/** /**
* Constructs a break node. * Constructs a break node.
* *
@ -16,11 +16,11 @@ class Break_ extends Node\Stmt
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Node\Expr $num = null, array $attributes = array()) { public function __construct(Node\Expr $num = null, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->num = $num;
'num' => $num,
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('num');
}
}

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Stmt;
use PhpParser\Node; use PhpParser\Node;
/**
* @property null|Node\Expr $cond Condition (null for default)
* @property Node[] $stmts Statements
*/
class Case_ extends Node\Stmt class Case_ extends Node\Stmt
{ {
/** @var null|Node\Expr $cond Condition (null for default) */
public $cond;
/** @var Node[] Statements */
public $stmts;
/** /**
* Constructs a case node. * Constructs a case node.
* *
@ -18,12 +19,12 @@ class Case_ extends Node\Stmt
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($cond, array $stmts = array(), array $attributes = array()) { public function __construct($cond, array $stmts = array(), array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->cond = $cond;
'cond' => $cond, $this->stmts = $stmts;
'stmts' => $stmts,
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('cond', 'stmts');
}
}

View File

@ -4,13 +4,15 @@ namespace PhpParser\Node\Stmt;
use PhpParser\Node; use PhpParser\Node;
/**
* @property Node\Name $type Class of exception
* @property string $var Variable for exception
* @property Node[] $stmts Statements
*/
class Catch_ extends Node\Stmt class Catch_ extends Node\Stmt
{ {
/** @var Node\Name Class of exception */
public $type;
/** @var string Variable for exception */
public $var;
/** @var Node[] Statements */
public $stmts;
/** /**
* Constructs a catch node. * Constructs a catch node.
* *
@ -20,13 +22,13 @@ class Catch_ extends Node\Stmt
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Node\Name $type, $var, array $stmts = array(), array $attributes = array()) { public function __construct(Node\Name $type, $var, array $stmts = array(), array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->type = $type;
'type' => $type, $this->var = $var;
'var' => $var, $this->stmts = $stmts;
'stmts' => $stmts,
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('type', 'var', 'stmts');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Stmt;
use PhpParser\Node; use PhpParser\Node;
/**
* @property Node\Const_[] $consts Constant declarations
*/
class ClassConst extends Node\Stmt class ClassConst extends Node\Stmt
{ {
/** @var Node\Const_[] Constant declarations */
public $consts;
/** /**
* Constructs a class const list node. * Constructs a class const list node.
* *
@ -16,11 +16,11 @@ class ClassConst extends Node\Stmt
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $consts, array $attributes = array()) { public function __construct(array $consts, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->consts = $consts;
'consts' => $consts,
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('consts');
}
}

View File

@ -0,0 +1,22 @@
<?php
namespace PhpParser\Node\Stmt;
use PhpParser\Node;
abstract class ClassLike extends Node\Stmt {
/** @var string Name */
public $name;
/** @var Node[] Statements */
public $stmts;
public function getMethods() {
$methods = array();
foreach ($this->stmts as $stmt) {
if ($stmt instanceof ClassMethod) {
$methods[] = $stmt;
}
}
return $methods;
}
}

View File

@ -5,38 +5,41 @@ namespace PhpParser\Node\Stmt;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Error; use PhpParser\Error;
/**
* @property int $type Type
* @property bool $byRef Whether to return by reference
* @property string $name Name
* @property Node\Param[] $params Parameters
* @property Node[] $stmts Statements
*/
class ClassMethod extends Node\Stmt class ClassMethod extends Node\Stmt
{ {
/** @var int Type */
public $type;
/** @var bool Whether to return by reference */
public $byRef;
/** @var string Name */
public $name;
/** @var Node\Param[] Parameters */
public $params;
/** @var null|string|Node\Name[] Return type */
public $returnType;
/** @var Node[] Statements */
public $stmts;
/** /**
* Constructs a class method node. * Constructs a class method node.
* *
* @param string $name Name * @param string $name Name
* @param array $subNodes Array of the following optional subnodes: * @param array $subNodes Array of the following optional subnodes:
* 'type' => MODIFIER_PUBLIC: Type * 'type' => MODIFIER_PUBLIC: Type
* 'byRef' => false : Whether to return by reference * 'byRef' => false : Whether to return by reference
* 'params' => array() : Parameters * 'params' => array() : Parameters
* 'stmts' => array() : Statements * 'returnType' => null : Return type
* 'stmts' => array() : Statements
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($name, array $subNodes = array(), array $attributes = array()) { public function __construct($name, array $subNodes = array(), array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->type = isset($subNodes['type']) ? $subNodes['type'] : 0;
'type' => isset($subNodes['type']) ? $subNodes['type'] : Class_::MODIFIER_PUBLIC, $this->byRef = isset($subNodes['byRef']) ? $subNodes['byRef'] : false;
'byRef' => isset($subNodes['byRef']) ? $subNodes['byRef'] : false, $this->name = $name;
'name' => $name, $this->params = isset($subNodes['params']) ? $subNodes['params'] : array();
'params' => isset($subNodes['params']) ? $subNodes['params'] : array(), $this->returnType = isset($subNodes['returnType']) ? $subNodes['returnType'] : null;
'stmts' => array_key_exists('stmts', $subNodes) ? $subNodes['stmts'] : array(), $this->stmts = array_key_exists('stmts', $subNodes) ? $subNodes['stmts'] : array();
),
$attributes
);
if ($this->type & Class_::MODIFIER_STATIC) { if ($this->type & Class_::MODIFIER_STATIC) {
switch (strtolower($this->name)) { switch (strtolower($this->name)) {
@ -50,8 +53,12 @@ class ClassMethod extends Node\Stmt
} }
} }
public function getSubNodeNames() {
return array('type', 'byRef', 'name', 'params', 'returnType', 'stmts');
}
public function isPublic() { public function isPublic() {
return (bool) ($this->type & Class_::MODIFIER_PUBLIC); return ($this->type & Class_::MODIFIER_PUBLIC) !== 0 || $this->type === 0;
} }
public function isProtected() { public function isProtected() {

View File

@ -5,14 +5,7 @@ namespace PhpParser\Node\Stmt;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Error; use PhpParser\Error;
/** class Class_ extends ClassLike
* @property int $type Type
* @property string $name Name
* @property null|Node\Name $extends Name of extended class
* @property Node\Name[] $implements Names of implemented interfaces
* @property Node[] $stmts Statements
*/
class Class_ extends Node\Stmt
{ {
const MODIFIER_PUBLIC = 1; const MODIFIER_PUBLIC = 1;
const MODIFIER_PROTECTED = 2; const MODIFIER_PROTECTED = 2;
@ -21,6 +14,15 @@ class Class_ extends Node\Stmt
const MODIFIER_ABSTRACT = 16; const MODIFIER_ABSTRACT = 16;
const MODIFIER_FINAL = 32; const MODIFIER_FINAL = 32;
const VISIBILITY_MODIFER_MASK = 7; // 1 | 2 | 4
/** @var int Type */
public $type;
/** @var null|Node\Name Name of extended class */
public $extends;
/** @var Node\Name[] Names of implemented interfaces */
public $implements;
protected static $specialNames = array( protected static $specialNames = array(
'self' => true, 'self' => true,
'parent' => true, 'parent' => true,
@ -30,7 +32,7 @@ class Class_ extends Node\Stmt
/** /**
* Constructs a class node. * Constructs a class node.
* *
* @param string $name Name * @param string|null $name Name
* @param array $subNodes Array of the following optional subnodes: * @param array $subNodes Array of the following optional subnodes:
* 'type' => 0 : Type * 'type' => 0 : Type
* 'extends' => null : Name of extended class * 'extends' => null : Name of extended class
@ -39,32 +41,38 @@ class Class_ extends Node\Stmt
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($name, array $subNodes = array(), array $attributes = array()) { public function __construct($name, array $subNodes = array(), array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->type = isset($subNodes['type']) ? $subNodes['type'] : 0;
'type' => isset($subNodes['type']) ? $subNodes['type'] : 0, $this->name = $name;
'name' => $name, $this->extends = isset($subNodes['extends']) ? $subNodes['extends'] : null;
'extends' => isset($subNodes['extends']) ? $subNodes['extends'] : null, $this->implements = isset($subNodes['implements']) ? $subNodes['implements'] : array();
'implements' => isset($subNodes['implements']) ? $subNodes['implements'] : array(), $this->stmts = isset($subNodes['stmts']) ? $subNodes['stmts'] : array();
'stmts' => isset($subNodes['stmts']) ? $subNodes['stmts'] : array(),
),
$attributes
);
if (isset(self::$specialNames[(string) $this->name])) { if (null !== $this->name && isset(self::$specialNames[strtolower($this->name)])) {
throw new Error(sprintf('Cannot use \'%s\' as class name as it is reserved', $this->name)); throw new Error(sprintf('Cannot use \'%s\' as class name as it is reserved', $this->name));
} }
if (isset(self::$specialNames[(string) $this->extends])) { if (isset(self::$specialNames[strtolower($this->extends)])) {
throw new Error(sprintf('Cannot use \'%s\' as class name as it is reserved', $this->extends)); throw new Error(
sprintf('Cannot use \'%s\' as class name as it is reserved', $this->extends),
$this->extends->getAttributes()
);
} }
foreach ($this->implements as $interface) { foreach ($this->implements as $interface) {
if (isset(self::$specialNames[(string) $interface])) { if (isset(self::$specialNames[strtolower($interface)])) {
throw new Error(sprintf('Cannot use \'%s\' as interface name as it is reserved', $interface)); throw new Error(
sprintf('Cannot use \'%s\' as interface name as it is reserved', $interface),
$interface->getAttributes()
);
} }
} }
} }
public function getSubNodeNames() {
return array('type', 'name', 'extends', 'implements', 'stmts');
}
public function isAbstract() { public function isAbstract() {
return (bool) ($this->type & self::MODIFIER_ABSTRACT); return (bool) ($this->type & self::MODIFIER_ABSTRACT);
} }
@ -73,21 +81,15 @@ class Class_ extends Node\Stmt
return (bool) ($this->type & self::MODIFIER_FINAL); return (bool) ($this->type & self::MODIFIER_FINAL);
} }
public function getMethods() { public function isAnonymous() {
$methods = array(); return null === $this->name;
foreach ($this->stmts as $stmt) {
if ($stmt instanceof ClassMethod) {
$methods[] = $stmt;
}
}
return $methods;
} }
/** /**
* @internal * @internal
*/ */
public static function verifyModifier($a, $b) { public static function verifyModifier($a, $b) {
if ($a & 7 && $b & 7) { if ($a & self::VISIBILITY_MODIFER_MASK && $b & self::VISIBILITY_MODIFER_MASK) {
throw new Error('Multiple access type modifiers are not allowed'); throw new Error('Multiple access type modifiers are not allowed');
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Stmt;
use PhpParser\Node; use PhpParser\Node;
/**
* @property Node\Const_[] $consts Constant declarations
*/
class Const_ extends Node\Stmt class Const_ extends Node\Stmt
{ {
/** @var Node\Const_[] Constant declarations */
public $consts;
/** /**
* Constructs a const list node. * Constructs a const list node.
* *
@ -16,11 +16,11 @@ class Const_ extends Node\Stmt
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $consts, array $attributes = array()) { public function __construct(array $consts, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->consts = $consts;
'consts' => $consts,
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('consts');
}
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Stmt;
use PhpParser\Node; use PhpParser\Node;
/**
* @property null|Node\Expr $num Number of loops to continue
*/
class Continue_ extends Node\Stmt class Continue_ extends Node\Stmt
{ {
/** @var null|Node\Expr Number of loops to continue */
public $num;
/** /**
* Constructs a continue node. * Constructs a continue node.
* *
@ -16,11 +16,11 @@ class Continue_ extends Node\Stmt
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Node\Expr $num = null, array $attributes = array()) { public function __construct(Node\Expr $num = null, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->num = $num;
'num' => $num,
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('num');
}
}

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Stmt;
use PhpParser\Node; use PhpParser\Node;
/**
* @property string $key Key
* @property Node\Expr $value Value
*/
class DeclareDeclare extends Node\Stmt class DeclareDeclare extends Node\Stmt
{ {
/** @var string Key */
public $key;
/** @var Node\Expr Value */
public $value;
/** /**
* Constructs a declare key=>value pair node. * Constructs a declare key=>value pair node.
* *
@ -18,12 +19,12 @@ class DeclareDeclare extends Node\Stmt
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($key, Node\Expr $value, array $attributes = array()) { public function __construct($key, Node\Expr $value, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->key = $key;
'key' => $key, $this->value = $value;
'value' => $value,
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('key', 'value');
}
}

View File

@ -3,13 +3,13 @@
namespace PhpParser\Node\Stmt; namespace PhpParser\Node\Stmt;
use PhpParser\Node; use PhpParser\Node;
/**
* @property DeclareDeclare[] $declares List of declares
* @property Node[] $stmts Statements
*/
class Declare_ extends Node\Stmt class Declare_ extends Node\Stmt
{ {
/** @var DeclareDeclare[] List of declares */
public $declares;
/** @var Node[] Statements */
public $stmts;
/** /**
* Constructs a declare node. * Constructs a declare node.
* *
@ -18,12 +18,12 @@ class Declare_ extends Node\Stmt
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $declares, array $stmts, array $attributes = array()) { public function __construct(array $declares, array $stmts, array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->declares = $declares;
'declares' => $declares, $this->stmts = $stmts;
'stmts' => $stmts,
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('declares', 'stmts');
}
}

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Stmt;
use PhpParser\Node; use PhpParser\Node;
/**
* @property Node\Expr $cond Condition
* @property Node[] $stmts Statements
*/
class Do_ extends Node\Stmt class Do_ extends Node\Stmt
{ {
/** @var Node\Expr Condition */
public $cond;
/** @var Node[] Statements */
public $stmts;
/** /**
* Constructs a do while node. * Constructs a do while node.
* *
@ -18,12 +19,12 @@ class Do_ extends Node\Stmt
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Node\Expr $cond, array $stmts = array(), array $attributes = array()) { public function __construct(Node\Expr $cond, array $stmts = array(), array $attributes = array()) {
parent::__construct( parent::__construct(null, $attributes);
array( $this->cond = $cond;
'cond' => $cond, $this->stmts = $stmts;
'stmts' => $stmts,
),
$attributes
);
} }
}
public function getSubNodeNames() {
return array('cond', 'stmts');
}
}

Some files were not shown because too many files have changed in this diff Show More