| Server IP : 199.250.214.225 / Your IP : 3.14.244.27 Web Server : Apache System : Linux vps64074.inmotionhosting.com 3.10.0-1160.105.1.vz7.214.3 #1 SMP Tue Jan 9 19:45:01 MSK 2024 x86_64 User : nicngo5 ( 1001) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : OFF Directory : /home/nicngo5/nicnAdmin/vendor/phpdocumentor/reflection-docblock/ |
Upload File : |
The ReflectionDocBlock Component [](https://travis-ci.org/phpDocumentor/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. > **Note**: *this is a core component of phpDocumentor and is constantly being > optimized for performance.* Installation ------------ You can install the component in the following ways: * Use the official Github repository (https://github.com/phpDocumentor/ReflectionDocBlock) * Via Composer (http://packagist.org/packages/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 as shown in the following example. ```php // Should contain the summary for this DocBlock $summary = $docblock->getSummary(); // Contains an object of type \phpDocumentor\Reflection\DocBlock\Description; // you can either cast it to string or use the render method to get a string // representation of the Description. $description = $docblock->getDescription(); ``` > For more examples it would be best to review the scripts in the `/examples` > folder.