This pull request incorporates changes from #139 but more importantly switches to phpdocumentor/reflection-docblock ^5.2 to address compatibility with PHPUnit ^9.5 that Silverstripe 4.10 supports. I believe this may also break compatibility with Silverstripe projects using PHPUnit 5.7 because of conflicting dependencies between the two versions.

I found this lovely piece of code in the AnnotatorPageTest.php. We moved Page and PageController to a different location (under Pages folder) in our project. Since these paths are hard coded unit tests are now failing. At least the code comments were honest about the situation.

// Why is this required?
// @todo get it to work properly
require_once(BASE_PATH . '/mysite/code/Page.php');
require_once(BASE_PATH . '/mysite/code/PageController.php');

I recommend avoiding using hard coded paths for includes if you're including stuff from project folder.

Currently methods like TextField::create(); does not 'resolve' to the TextField class but stays in Object.

Laravel as a great ide helper: https://github.com/barryvdh/laravel-ide-helper which generates a same kind of helper file.

PHPStorm documentation https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata

I looked into this, but it is not as easy as it seems.

The problem is that Object::create(); uses get_called_class(); to get the class to generate. If any has an idea to tackle this, I think this would be a great feature..

When an annotation is edited by the user, it gets destroyed. It would be nice to compare the existing, and only destroy those that are not needed anymore.

I updated to the master version yesterday, and I really appreciate how things work without needing to add the start and end tags, however it seems that unused properties are no more removed. See below - I removed ReadMoreTitle and Content, but after a db build they are still there

<?php

/**
 * ReadMoreBlock
 *
 * @author Anselm Christophersen <[email protected]>
 * @date April 2016
 * @property string $Summary
 * @property string $Content
 * @property string $ReadMoreTitle
 * @property int $ImageID
 * @method Image Image()
 * @property int $LinkID
 * @method Link Link()
 */
class ReadMoreBlock extends Block
{
    private static $singular_name = 'Read More';
    private static $plural_name = 'Read More';

    private static $db = [
        'Summary' => 'Text',
    ];

    private static $has_one = [
        'Image' => 'Image',
        'Link' => 'Link',
    ];
}

Would be nice to generate searchable documentation of the code in similar style to http://api.highcharts.com/highcharts or http://api.silverstripe.org/3.3/!

Strange one for some reason i think its unable to find files it should be able to?

dev/build completes but this error is still shown below the output

GET /dev/build?flushtoken=b0ca9d6852f5b8536f106e5d10fe3639&flush=1

Line 227 in /Users/phyzical/Sites/dasdasds/vendor/silverstripe/framework/src/Core/ClassInfo.php
Source

218         }
219 
220         $key = strtolower($nameOrObject);
221         if (!isset(static::$_cache_class_names[$key])) {
222             // Get manifest name
223             $name = ClassLoader::inst()->getManifest()->getItemName($nameOrObject);
224 
225             // Use reflection for non-manifest classes
226             if (!$name) {
227                 $reflection = new ReflectionClass($nameOrObject);
228                 $name = $reflection->getName();
229             }
230             static::$_cache_class_names[$key] = $name;
231         }
232 
233         return static::$_cache_class_names[$key];

Trace

    ReflectionClass->__construct(silverstripe\filesystem\storage\dbfile)
    ClassInfo.php:227
    SilverStripe\Core\ClassInfo::class_name(silverstripe\filesystem\storage\dbfile)
    DataObjectAnnotator.php:127
    SilverLeague\IDEAnnotator\DataObjectAnnotator->setupExtensionClasses()
    DataObjectAnnotator.php:89
    SilverLeague\IDEAnnotator\DataObjectAnnotator->__construct()
    ReflectionClass->newInstance()
    InjectionCreator.php:26
    SilverStripe\Core\Injector\InjectionCreator->create(SilverLeague\IDEAnnotator\DataObjectAnnotator, Array)
    Injector.php:585
    SilverStripe\Core\Injector\Injector->instantiate(Array, SilverLeague\IDEAnnotator\DataObjectAnnotator, singleton)
    Injector.php:993
    SilverStripe\Core\Injector\Injector->getNamedService(SilverLeague\IDEAnnotator\DataObjectAnnotator, 1, Array)
    Injector.php:946
    SilverStripe\Core\Injector\Injector->get(SilverLeague\IDEAnnotator\DataObjectAnnotator)
    Annotatable.php:81
    SilverLeague\IDEAnnotator\Extensions\Annotatable->setUp()
    Annotatable.php:56
    SilverLeague\IDEAnnotator\Extensions\Annotatable->afterCallActionHandler(SilverStripe\Control\HTTPRequest, build, HTTP/1.1 200 OK content-type: text/html; charset=utf-8 , , , , )
    Extensible.php:464
    SilverStripe\View\ViewableData->extend(afterCallActionHandler, SilverStripe\Control\HTTPRequest, build, HTTP/1.1 200 OK content-type: text/html; charset=utf-8 )
    RequestHandler.php:322
    SilverStripe\Control\RequestHandler->handleAction(SilverStripe\Control\HTTPRequest, build)
    Controller.php:284
    SilverStripe\Control\Controller->handleAction(SilverStripe\Control\HTTPRequest, build)
    RequestHandler.php:202
    SilverStripe\Control\RequestHandler->handleRequest(SilverStripe\Control\HTTPRequest)
    Controller.php:212
    SilverStripe\Control\Controller->handleRequest(SilverStripe\Control\HTTPRequest)
    RequestHandler.php:226
    SilverStripe\Control\RequestHandler->handleRequest(SilverStripe\Control\HTTPRequest)
    Controller.php:212
    SilverStripe\Control\Controller->handleRequest(SilverStripe\Control\HTTPRequest)
    Director.php:361
    SilverStripe\Control\Director->SilverStripe\Control\{closure}(SilverStripe\Control\HTTPRequest)
    VersionedHTTPMiddleware.php:40
    SilverStripe\Versioned\VersionedHTTPMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    BasicAuthMiddleware.php:68
    SilverStripe\Security\BasicAuthMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    AuthenticationMiddleware.php:61
    SilverStripe\Security\AuthenticationMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    AkismetMiddleware.php:22
    SilverStripe\Akismet\Config\AkismetMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    CanonicalURLMiddleware.php:188
    SilverStripe\Control\Middleware\CanonicalURLMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    HTTPCacheControlMiddleware.php:42
    SilverStripe\Control\Middleware\HTTPCacheControlMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    ChangeDetectionMiddleware.php:27
    SilverStripe\Control\Middleware\ChangeDetectionMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    FlushMiddleware.php:29
    SilverStripe\Control\Middleware\FlushMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    RequestProcessor.php:66
    SilverStripe\Control\RequestProcessor->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    SessionMiddleware.php:20
    SilverStripe\Control\Middleware\SessionMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    AllowedHostsMiddleware.php:60
    SilverStripe\Control\Middleware\AllowedHostsMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    TrustedProxyMiddleware.php:176
    SilverStripe\Control\Middleware\TrustedProxyMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\Director->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    HTTPMiddlewareAware.php:65
    SilverStripe\Control\Director->callMiddleware(SilverStripe\Control\HTTPRequest, Closure)
    Director.php:370
    SilverStripe\Control\Director->handleRequest(SilverStripe\Control\HTTPRequest)
    HTTPApplication.php:48
    SilverStripe\Control\HTTPApplication->SilverStripe\Control\{closure}(SilverStripe\Control\HTTPRequest)
    call_user_func(Closure, SilverStripe\Control\HTTPRequest)
    HTTPApplication.php:66
    SilverStripe\Control\HTTPApplication->SilverStripe\Control\{closure}(SilverStripe\Control\HTTPRequest)
    call_user_func(Closure, SilverStripe\Control\HTTPRequest)
    ErrorControlChainMiddleware.php:56
    SilverStripe\Core\Startup\ErrorControlChainMiddleware->SilverStripe\Core\Startup\{closure}(SilverStripe\Core\Startup\ErrorControlChain)
    call_user_func(Closure, SilverStripe\Core\Startup\ErrorControlChain)
    ErrorControlChain.php:236
    SilverStripe\Core\Startup\ErrorControlChain->step()
    ErrorControlChain.php:226
    SilverStripe\Core\Startup\ErrorControlChain->execute()
    ErrorControlChainMiddleware.php:69
    SilverStripe\Core\Startup\ErrorControlChainMiddleware->process(SilverStripe\Control\HTTPRequest, Closure)
    HTTPMiddlewareAware.php:62
    SilverStripe\Control\HTTPApplication->SilverStripe\Control\Middleware\{closure}(SilverStripe\Control\HTTPRequest)
    HTTPMiddlewareAware.php:65
    SilverStripe\Control\HTTPApplication->callMiddleware(SilverStripe\Control\HTTPRequest, Closure)
    HTTPApplication.php:67
    SilverStripe\Control\HTTPApplication->execute(SilverStripe\Control\HTTPRequest, Closure, 1)
    HTTPApplication.php:49
    SilverStripe\Control\HTTPApplication->handle(SilverStripe\Control\HTTPRequest)
    index.php:26

the offending lines seem to be located in DataObjectAnnotator.php setupExtensionClasses() line 115 $extendableClasses had 814 items for me but i assume this is normal as it filters items out. All the classes are lowercase which i thought was strange but is probably normal also.

 $extendableClasses = Config::inst()->getAll();
        // We need to check all config to see if the class is extensible
        // @todo change this to a proper php array_walk or something method?
        foreach ($extendableClasses as $key => $configClass) {
            // If the class doesn't already exist in the extension classes
            // And the 'extensions' key is set in the config class
            // And the 'extensions' key actually contains values
            // Add it.
            if (!in_array(self::$extension_classes, $configClass, true) &&
                isset($configClass['extensions']) &&
                count($configClass['extensions']) > 0
            ) {
                $extension_classes[] = ClassInfo::class_name($key);
            }
        }

my composer.json as follows

    "name": "dsaasd",
    "license": "proprietary",
    "require": {
        "php": ">=5.6.0",
        "silverstripe/recipe-plugin": "1.3.0",
        "silverstripe/recipe-cms": "4.2.1",
        "symbiote/silverstripe-addressable": "^4.0.1"
    },
    "require-dev": {
        "squizlabs/php_codesniffer": "3.2.3",
        "phpunit/phpunit": "^5.7",
        "silverleague/ideannotator": "3.x-dev"
    },
    "extra": {
        "project-files": [
            "mysite/_config/*",
            ".env.example"
        ],
        "public-files": [
            "assets/*",
            "favicon.ico"
        ],
        "branch-alias": {
            "4.x-dev": "4.2.x-dev",
            "dev-master": "5.x-dev"
        },
        "project-files-installed": [
            "app/.htaccess",
            "app/_config.php",
            "app/_config/mysite.yml",
            "app/src/Page.php",
            "app/src/PageController.php",
            "mysite/.htaccess",
            "mysite/_config.php",
            "mysite/_config/mysite.yml",
            "mysite/code/Page.php",
            "mysite/code/PageController.php"
        ],
        "public-files-installed": [
            ".htaccess",
            "index.php",
            "install-frameworkmissing.html",
            "install.php",
            "web.config"
        ]
    },
    "config": {
        "process-timeout": 600
    },
    "prefer-stable": true,
    "minimum-stability": "dev"

hopefully you can replicate

let me know if you need any more info

I have spent the better part of the night porting this module to SilverStripe 4 and would like to tag a new release now. According to the mailing list both the SilverStripe community and the composer guys suggest solving multiple framework versions with multiple major releases. Therefore I would like to propose to make this release "3.0", so we would maintain "2.x" for SilverStripe 3 and "4.x" for SilverStripe 4.

Is that alright with you guys @axyr @Firesphere?

And, how to we manage branches. Following the example of SilverStripe we should make master the branch for version 3 (SilverStripe 4) and create a new branch for version 2. Can I go ahead and re-arrange the branches?

I am keen to run this from the command line on a vendor module, rather than app/mysite.

Would it be OK to have something like this:

if(Director::isCli()) {
    Config::inst()->update(DataObjectAnnotator::class, 'enabled_modules', [$this->request->getVar('module')]);
}

Adding support for short classnames and updating the docs accordingly. This works via a config, that gets the short classname to prevent IDE's from mentioning "Unnecessary FQN"

Included is a fix for a whitespace trim introduced in rc-1 Resolves #108 , SQN instead of FQN

I get this error: Could not find string 'class Firesphere\YubiAuth\SiteConfigExtension'. Please check casing and whitespace.

This is wrong, as it should look for class SiteConfigExtension, since the NameSpacing is not in the Class declaration but in the Namespace declaration.

It looks like the owner property is now missing from the annotations in 3.2.2 this appears to have been introduced after 3.2.0 as in that version the owner annotation is present.

In projects using the Versioned::class . '.versioned' variant (versions without staging, see docs), the annotator throws:

ERROR [UNKNOWN TYPE, ERRNO -1]: Uncaught ReflectionException: Class "SilverStripe\Versioned\Versioned.versioned" does not exist

Hiya,

Sorry for the issue a tad on the question side.

I've been using silverstripe-ideannotator and really enjoying it. Unfortunately I've encountered an issue when playing around with psalm.

Whilst parsing the docblocks specifically ( psalm is unhappy with annotations like the following @mixin \SilverStripe\Versioned\Versioned("Stage","Live")

Here is the question part 😄 . I've been doing some digging around and cannot find anything indicating this sort of syntax. Is this a valid syntax, a bug or is it just a sort of code comment / nicety?

Would PR to either fix this or make it configurable be accepted?

Having an extension that extends SilverStripe\Control\Controller appears to cut off classes.

An example docblock that gets generated is: @property \SilverStripe\Admin\SecurityAdmin|\SilverStripe\GraphQL\Controller|\SilverStripe\TestSession\TestSessionController|\SilverShop\Comparison\Pagetypes\ProductComparisonPageController|\SilverShop\Admin\ProductCatalogAdmin|\SilverShop\Cart\ShoppingCartController|\SilverShop\Page\AccountPageController|\SilverShop\Page\CheckoutPageController|\SilverShop\Page\ProductCategoryController|\SilverShop\Page\ProductController|\SilverShop\Discounts\Admin\DiscountModelAdmin|\SilverStripe\CMS\Controllers\CMSMain|\SilverStripe\CMS\Controllers\CMSPageSettingsController|\SilverStripe\CMS\Controllers\ContentController|\SilverStripe\CMS\Controllers\ModelAsController|\SilverStripe\Control\Controller|\SilverStripe\Dev\DevBuildController|\App\Extensions\ControllerExtension $owner

I would have expected either one of two things to happen:

• Only the direct extended class gets added as $owner (e.g. @property SilverStripe\Control\Controller|App\Extensions\ControllerExtension $owner)
• Every single sub-class of Controller gets added (there are a lot more than what's listed here).

I'm not sure which option is better, but this seems to be the worst of both worlds? I haven't had a chance to investigate yet, but is there thought on which solution is better?

Alternatively, maybe I'm just confused how this works, but e.g. PageController isn't there, so there are entire hierarchies missing.

The current mock data uses this

Array
(
    [SubTeams] => SilverLeague\IDEAnnotator\Tests\SubTeam
    [Comments] => SilverLeague\IDEAnnotator\Tests\TeamComment
    [Supporters] => Array
        (
            [through] => SilverLeague\IDEAnnotator\Tests\TeamSupporter
            [from] => Team
            [to] => Supporter
        )

)

However, it's not supported in the framework (that runs a preg_replace when calling hasMany()) causing array to string conversion notices. I don't see anywhere in the docs that it's possible to use that notation for has_many, only for many_many.

Therefore, should I report a bug to the framework (hasMany should supported nested array => some mapping needs to be done before running preg_replace) or is this module using invalid features?

Example model:

namespace Foo;
class Foo extends \SilverStripe\ORM\DataObject
{
    private static $has_many = [
        'Bars' => Bar::class,
    ];
}

namespace Bar;
class Bar extends \SilverStripe\ORM\DataObject {}

When running dev/build you'll get this in the Foo docblock:

* @method DataList|Bar[] Bars()

It's missing use SilverStripe\ORM\DataList; imported - this is a bug