Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nette/reflection
[DISCONTINUED] Docblock annotations parser and common reflection classes
https://github.com/nette/reflection
annotations doc-comments nette nette-framework php phpdoc reflection
Last synced: 19 days ago
JSON representation
[DISCONTINUED] Docblock annotations parser and common reflection classes
- Host: GitHub
- URL: https://github.com/nette/reflection
- Owner: nette
- License: other
- Archived: true
- Created: 2014-03-13T03:46:53.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2019-02-20T20:40:33.000Z (almost 6 years ago)
- Last Synced: 2024-12-16T16:03:04.438Z (about 2 months ago)
- Topics: annotations, doc-comments, nette, nette-framework, php, phpdoc, reflection
- Language: PHP
- Homepage: https://nette.org
- Size: 198 KB
- Stars: 90
- Watchers: 33
- Forks: 27
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
- License: license.md
Awesome Lists containing this project
README
Nette PHP Reflection
====================
[](https://packagist.org/packages/nette/reflection)
[](https://travis-ci.org/nette/reflection)
[](https://coveralls.io/github/nette/reflection?branch=master)
[](https://github.com/nette/reflection/releases)
[](https://github.com/nette/reflection/blob/master/license.md)
Install it using Composer:
```
composer require nette/reflection
```
The last stable release requires PHP version 5.6 or newer (is compatible with PHP 7.0 and 7.1).
If you like Nette, **[please make a donation now](https://nette.org/donate)**. Thank you!
If you need to find every information about any class, reflection is the right tool to do it. You can easily find out which methods does any class have, what parameters do those methods accept, etc.
```php
// getting PDO class reflection
$classReflection = new Nette\Reflection\ClassType('PDO');
// getting PDO::query method reflection
$methodReflection = new Nette\Reflection\Method('PDO', 'query');
```
Annotations
-----------
Reflection has really a lot to do with annotations. The annotations are written into phpDoc comments (two opening asterisks are mandatory!) and start with `@`. You can annotate classes, variables and methods:
```php
/**
* @author John Doe
* @author Tomas Marny
* @secured
*/
class FooClass
{
/** @Persistent */
public $foo;
/** @User(loggedIn, role=Admin) */
public function bar() {}
}
```
In the code there are these annotations:
- `@author John Doe` - string, contains text value `'John Doe'`
- `@Persistent` - boolean, its presence means `true`
- `@User(loggedIn, role=Admin)` - contains associative `array('loggedIn', 'role' => 'Admin')`
The existence of a class annotation can be checked via `hasAnnotation()` method:
```php
$fooReflection = new Nette\Reflection\ClassType('FooClass');
$fooReflection->hasAnnotation('author'); // returns true
$fooReflection->hasAnnotation('copyright'); // returns false
```
Values can be acquired with `getAnnotation()`:
```php
$fooReflection->getAnnotation('author'); // returns string 'Tomas Marny'
$fooReflection->getMethod('bar')->getAnnotation('User');
// returns array('loggedIn', 'role' => 'Admin')
```
.[caution]
Previous definitions are overwritten with the latter ones, sou you will always get the last one.
All annotations can be obtained with `getAnnotations()`:
```
array(3) {
"author" => array(2) {
0 => string(8) "John Doe"
1 => string(11) "Tomas Marny"
}
"secured" => array(1) {
0 => bool(true)
}
}
```