PHPDocumentor 2 and PHP 7 with opcache issues in Doctrine

php phpdoc php-7 opcache phpdocumentor2
Paul Carlton picture Paul Carlton · Jan 23, 2016 · Viewed 13.5k times · Source

Hopefully someone here knows a thing or 2 about this.

Short Question

I am running into an error using phpdoc on the command line, installed via pear on PHP 7.0.2. The error is:

#> phpdoc
PHP Fatal error:  Uncaught Doctrine\Common\Annotations\AnnotationException: 
You have to enable opcache.load_comments=1 or zend_optimizerplus.load_comments=1. 
in /usr/local/php5-7.0.2-20160108-102134/lib/php/phpDocumentor/vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/AnnotationException.php:193

How do I fix this error?

Details

Opcache is enabled and opcache.load_comments=1 is in my opcache.ini file, verified by using the commands: php -i | grep "Opcode" and php -i | grep "opcache" respectively. Within that .ini file I can verify that changes are loaded by checking enable and disable opcache via that file.

With that said, if I have opcache.load_comments=1 in my .ini file, why am I still getting this error?

Thanks!

Answer

deepdivedylan picture deepdivedylan · Jan 23, 2016

I encountered the same problem while using the PHAR version of PHPDocumentor. The PHAR includes an obsolete version of Doctrine Annotations.

The older version of Annotations is referring to the opcache.load_comments setting in php.ini, which does not exist in PHP 7:

This has been fixed upstream in Annotations:

For now, using the composer version of PHPDocumentor by executing composer require --dev phpdocumentor/phpdocumentor resolved the problem for me.

Related questions

PHPDoc type hinting for array of objects?

So, in PHPDoc one can specify @var above the member variable declaration to hint at its type. Then an IDE, for ex. PHPEd, will know what type of object it's working with and will be able to provide a code …

Read More
PHP Function Comments

Just a quick question: I've seen that some PHP functions are commented at the top, using a format that is unknown to me: /** * * Convert an object to an array * * @param object $object The object to convert * @return array * */ My IDE …

Read More
Best way to document Array options in PHPDoc?

I'm struggling to write readable and easy to understand documentation that describes the multi-tree structure for Array options that are passed to a function. Here is an example array structure. $arr = [ 'fields' => [ 'title' => [ 'name' => 'Document.title', 'format' =&…

Read More