Some checks failed
CI / PHP 8.3 / mariadb:10.6 (pull_request) Successful in 1m14s
CI / PHP 8.4 / mariadb:10.6 (pull_request) Successful in 1m12s
CI / PHP 8.4 / mariadb:11.4 (pull_request) Successful in 1m7s
CI / PHP 8.3 / mariadb:11.4 (pull_request) Successful in 1m19s
CI / PHP 8.3 / mysql:8.0 (pull_request) Successful in 1m32s
CI / PHP 8.4 / mysql:8.0 (pull_request) Successful in 1m22s
CI / PHP 8.4 / mysql:8.4 (pull_request) Successful in 1m32s
CI / PHP 8.3 / mysql:8.4 (pull_request) Successful in 1m35s
CI / Build-Artefakte aktuell (pull_request) Failing after 1m7s
- Laravel 13 mit Filament 5 (Admin), Inertia 3 + Vue 3 + Vuetify 4 (Material 3) - Anmeldung über Fortify (Login, Passwort vergessen/ändern), keine Selbstregistrierung - Profil mit Profilbild (WebP in festen Größen), Personenseiten, Header mit Avatar-Menü - Material-3-Farbschema aus der Primärfarbe, hell/dunkel/System pro Person - Basis-Branding (Portalname, Logo, Primärfarbe) im Admin unter „Erscheinungsbild“ - Benutzerverwaltung im Admin, Zugang vorläufig über is_admin - vendor/ (ohne Dev-Pakete) und Frontend-Build mitversioniert, Dev-Pakete in vendor-dev/ - PHPUnit-Tests gegen MySQL/MariaDB, Forgejo-CI-Matrix, Docker-Entwicklungsumgebung - VERSION, CHANGELOG.md und CONTRIBUTING.md mit Release-Ablauf Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
74 lines
3 KiB
Markdown
74 lines
3 KiB
Markdown
[](https://opensource.org/licenses/MIT)
|
|
[](https://github.com/phpDocumentor/ReflectionDocBlock/actions/workflows/integrate.yaml)
|
|
[](https://scrutinizer-ci.com/g/phpDocumentor/ReflectionDocBlock/?branch=master)
|
|
[](https://scrutinizer-ci.com/g/phpDocumentor/ReflectionDocBlock/?branch=master)
|
|
[](https://packagist.org/packages/phpdocumentor/reflection-docblock)
|
|
[](https://packagist.org/packages/phpdocumentor/reflection-docblock)
|
|
|
|
ReflectionDocBlock
|
|
==================
|
|
|
|
Introduction
|
|
------------
|
|
|
|
The ReflectionDocBlock component of phpDocumentor provides a DocBlock parser
|
|
that is 100% compatible with the [PHPDoc standard](http://phpdoc.org/docs/latest).
|
|
|
|
With this component, a library can provide support for annotations via DocBlocks
|
|
or otherwise retrieve information that is embedded in a DocBlock.
|
|
|
|
Installation
|
|
------------
|
|
|
|
```bash
|
|
composer require phpdocumentor/reflection-docblock
|
|
```
|
|
|
|
Usage
|
|
-----
|
|
|
|
In order to parse the DocBlock one needs a DocBlockFactory that can be
|
|
instantiated using its `createInstance` factory method like this:
|
|
|
|
```php
|
|
$factory = \phpDocumentor\Reflection\DocBlockFactory::createInstance();
|
|
```
|
|
|
|
Then we can use the `create` method of the factory to interpret the DocBlock.
|
|
Please note that it is also possible to provide a class that has the
|
|
`getDocComment()` method, such as an object of type `ReflectionClass`, the
|
|
create method will read that if it exists.
|
|
|
|
```php
|
|
$docComment = <<<DOCCOMMENT
|
|
/**
|
|
* This is an example of a summary.
|
|
*
|
|
* This is a Description. A Summary and Description are separated by either
|
|
* two subsequent newlines (thus a whiteline in between as can be seen in this
|
|
* example), or when the Summary ends with a dot (`.`) and some form of
|
|
* whitespace.
|
|
*/
|
|
DOCCOMMENT;
|
|
|
|
$docblock = $factory->create($docComment);
|
|
```
|
|
|
|
The `create` method will yield an object of type `\phpDocumentor\Reflection\DocBlock`
|
|
whose methods can be queried:
|
|
|
|
```php
|
|
// Contains the summary for this DocBlock
|
|
$summary = $docblock->getSummary();
|
|
|
|
// Contains \phpDocumentor\Reflection\DocBlock\Description object
|
|
$description = $docblock->getDescription();
|
|
|
|
// You can either cast it to string
|
|
$description = (string) $docblock->getDescription();
|
|
|
|
// Or use the render method to get a string representation of the Description.
|
|
$description = $docblock->getDescription()->render();
|
|
```
|
|
|
|
> For more examples it would be best to review the scripts in the [`/docs/examples` folder](/docs/examples).
|