Download the PHP package axyr/silverstripe-ideannotator without Composer
On this page you can find all versions of the php package axyr/silverstripe-ideannotator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download axyr/silverstripe-ideannotator
More information about axyr/silverstripe-ideannotator
Files in axyr/silverstripe-ideannotator
Package silverstripe-ideannotator
Short Description Generate PHP DocBlock annotations for DataObject and DataExtension databasefields and relation methods
License BSD-3-Clause
Informations about the package silverstripe-ideannotator
silverstripe-ideannotator
This module generates @property, @method and @mixin tags for DataObjects, PageControllers and (Data)Extensions, so ide's like PHPStorm recognize the database and relations that are set in the $db, $has_one, $has_many and $many_many arrays.
The docblocks can be generated/updated with each dev/build and with a DataObjectAnnotatorTask per module or classname.
Requirements
SilverStripe Framework and possible custom code.
By default, mysite
and app
are enabled "modules".
Version ^2:
SilverStripe 3.x framework
Version ^3:
SilverStripe 4.x+
Installation
Please note, this example omitted any possible modules you require yourself!
Example result
Further information
For installation, see installation
For the Code of Conduct, see CodeOfConduct
For contributing, see Contributing
For further documentation information, see the docs
A word of caution
This module changes the content of your files and currently there is no backup functionality. PHPStorm has a Local history for files and of course you have your code version controlled... I tried to add complete UnitTests, but I can't garantuee every situation is covered.
Windows users should be aware that the PHP Docs are generated with PSR in mind and use \n for line endings rather than Window's \r\n, some editors may have a hard time with these line endings.
This module should never be installed on a production environment.
All versions of silverstripe-ideannotator with dependencies
silverstripe/framework Version ^4
phpdocumentor/reflection-docblock Version ^2.0@dev