axyr/silverstripe-ideannotator

Generate PHP DocBlock annotations for DataObject and DataExtension databasefields and relation methods

silverstripe-ideannotator

, _(*1)

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., _(*2)

The docblocks can be generated/updated with each dev/build and with a DataObjectAnnotatorTask per module or classname., _(*3)

Requirements

SilverStripe Framework and possible custom code., _(*4)

By default, mysite and app are enabled "modules"., _(*5)

Version ^2:

SilverStripe 3.x framework, _(*6)

Version ^3:

SilverStripe 4.x+, _(*7)

Installation

{
  "require-dev": {
    "silverleague/ideannotator": "3.x-dev"
  }
}

Please note, this example omitted any possible modules you require yourself!, _(*8)

Example result

<?php

/**
 * Class NewsItem
 *
 * @property string $Title
 * @property int $Sort
 * @property int $Version
 * @property int $AuthorID
 * @method \SilverStripe\Security\Member Author()
 * @method \SilverStripe\ORM\DataList|Category[] Categories()
 * @method \SilverStripe\ORM\ManyManyList|Tag[] Tags()
 * @mixin Versioned
 */
class NewsItem extends \SilverStripe\ORM\DataObject
{
    private static $db = array(
        'Title' => 'Varchar(255)',
        'Sort'  => 'Int'
    );

    private static $has_one = array(
        'Author' => Member::class
    );

    private static $has_many = array(
        'Categories' => Category::class
    );

    private static $many_many = array(
        'Tags' => Tag::class
    );
}

Further information

For installation, see installation, _(*9)

For the Code of Conduct, see CodeOfConduct, _(*10)

For contributing, see Contributing, _(*11)

For further documentation information, see the docs, _(*12)

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., _(*13)

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., _(*14)

This module should never be installed on a production environment., _(*15)