DataObjectAnnotatorTask::__construct() - Code Metrics - silverleague/silverstripe-ideannotator - Measure and Improve Code Quality continuously with Scrutinizer

DataObjectAnnotatorTask::__construct() A
last analyzed 2025-04-22 15:41 UTC

↳ Parent: DataObjectAnnotatorTask

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	6
nc	1
nop	0
dl	0
loc	9
rs	10
c	0
b	0
f	0

<?php

namespace SilverLeague\IDEAnnotator\Tasks;

use Psr\Container\NotFoundExceptionInterface;
use ReflectionException;
use SilverLeague\IDEAnnotator\DataObjectAnnotator;
use SilverLeague\IDEAnnotator\Helpers\AnnotatePermissionChecker;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\BuildTask;

/**
 * Class DataObjectAnnotatorTask
 *
 * Task to add or remove annotations from a module or dataobject.
 *
 * @package IDEAnnotator/Tasks
 */
class DataObjectAnnotatorTask extends BuildTask
{

    /**
     * DataObjectAnnotatorTask constructor.
     * Setup default values. In this case title and description.
     */
    public function __construct()
    {
        parent::__construct();
        $this->title = 'DataObject annotations for specific DataObjects, Extensions or Controllers';

        $this->description = 'DataObject Annotator annotates your DO\'s if possible,' .
            ' helping you write better code.' .
            '<br />Usage: add the module or DataObject as parameter to the URL,' .
            ' e.g. ?module=mysite';
    }

    /**
     * @param HTTPRequest $request
     * @return bool
     * @throws ReflectionException
     * @throws NotFoundExceptionInterface
     */
    public function run($request)
    {
        /* @var $permissionChecker AnnotatePermissionChecker */
        $permissionChecker = Injector::inst()->get(AnnotatePermissionChecker::class);

        if (!$permissionChecker->environmentIsAllowed()) {
            return false;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
        }

        /* @var $annotator DataObjectAnnotator */
        $annotator = DataObjectAnnotator::create();

        $annotator->annotateObject($request->getVar('object'));

        $annotator->annotateModule($request->getVar('module'));

        return true;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }
}


1			<?php
2
3			namespace SilverLeague\IDEAnnotator\Tasks;
4
5			use Psr\Container\NotFoundExceptionInterface;
6			use ReflectionException;
7			use SilverLeague\IDEAnnotator\DataObjectAnnotator;
8			use SilverLeague\IDEAnnotator\Helpers\AnnotatePermissionChecker;
9			use SilverStripe\Control\HTTPRequest;
10			use SilverStripe\Core\Injector\Injector;
11			use SilverStripe\Dev\BuildTask;
12
13			/**
14			* Class DataObjectAnnotatorTask
15			*
16			* Task to add or remove annotations from a module or dataobject.
17			*
18			* @package IDEAnnotator/Tasks
19			*/
20			class DataObjectAnnotatorTask extends BuildTask
21			{
22
23			/**
24			* DataObjectAnnotatorTask constructor.
25			* Setup default values. In this case title and description.
26			*/
27			public function __construct()
28			{
29			parent::__construct();
30			$this->title = 'DataObject annotations for specific DataObjects, Extensions or Controllers';
31
32			$this->description = 'DataObject Annotator annotates your DO\'s if possible,' .
33			' helping you write better code.' .
34			'<br />Usage: add the module or DataObject as parameter to the URL,' .
35			' e.g. ?module=mysite';
36			}
37
38			/**
39			* @param HTTPRequest $request
40			* @return bool
41			* @throws ReflectionException
42			* @throws NotFoundExceptionInterface
43			*/
44			public function run($request)
45			{
46			/* @var $permissionChecker AnnotatePermissionChecker */
47			$permissionChecker = Injector::inst()->get(AnnotatePermissionChecker::class);
48
49			if (!$permissionChecker->environmentIsAllowed()) {
50			return false;
			0 ignored issues – show Bug Best Practice introduced 2023-05-04 23:31 UTC by Report Bug Copy Issue Report The expression `return false` returns the type `false` which is incompatible with the return type mandated by `SilverStripe\Dev\BuildTask::run()` of `void`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
51			}
52
53			/* @var $annotator DataObjectAnnotator */
54			$annotator = DataObjectAnnotator::create();
55
56			$annotator->annotateObject($request->getVar('object'));
57
58			$annotator->annotateModule($request->getVar('module'));
59
60			return true;
			0 ignored issues – show Bug Best Practice introduced 2023-05-04 23:31 UTC by Report Bug Copy Issue Report The expression `return true` returns the type `true` which is incompatible with the return type mandated by `SilverStripe\Dev\BuildTask::run()` of `void`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
61			}
62			}
63

silverleague / silverstripe-ideannotator

DataObjectAnnotatorTask::__construct() A last analyzed 2025-04-22 15:41 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

DataObjectAnnotatorTask::__construct() A
last analyzed 2025-04-22 15:41 UTC