PhotoGalleryBlock::getCMSFields() - Code Metrics - Inspection of "SilverStripe 4 upgrade" - dynamic/dynamic-blocks - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#62)

by Jason

created 2017-07-06 04:21 UTC

PhotoGalleryBlock::getCMSFields() A

↳ Parent: PhotoGalleryBlock

Complexity

Conditions	2
Paths	2

Size

Total Lines	22
Code Lines	13

Duplication

Lines	22
Ratio	100 %

Code Coverage

Tests	15
CRAP Score	2

Importance

Changes

Metric	Value
dl	22
loc	22
ccs	15
cts	15
cp	1
rs	9.2
c	0
b	0
f	0
cc	2
eloc	13
nc	2
nop	0
crap	2

<?php

namespace Dynamic\DynamicBlocks\Block;

use Dynamic\DynamicBlocks\Model\PhotoGalleryBlockImage;
use SheaDawson\Blocks\Controllers\BlockController;
use SheaDawson\Blocks\Model\Block;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor;
use SilverStripe\Forms\GridField\GridFieldDeleteAction;
use SilverStripe\View\Requirements;
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;

class PhotoGalleryBlock extends Block

{
    /**
     * @return string
     */
    public function singular_name()
    {
        return _t('PhotoGalleryBlock.SINGULARNAME', 'Photo Gallery Block');
    }

    /**
     * @return string
     */
    public function plural_name()
    {
        return _t('PhotoGalleryBlock.PLURALNAME', 'Photo Gallery Blocks');
    }

    /**
     * @var array
     */
    private static $has_many = array(
        'Images' => PhotoGalleryBlockImage::class
    );

    /**
     * @return \SilverStripe\Forms\FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $fields->removeByName([
            'Images',
        ]);

        if ($this->owner->ID) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $config = GridFieldConfig_RecordEditor::create();
            $config->addComponent(new GridFieldOrderableRows('SortOrder'));
            $config->removeComponentsByType('GridFieldAddExistingAutocompleter');
            $config->removeComponentsByType('GridFieldDeleteAction');
            $config->addComponent(new GridFieldDeleteAction(false));
            $imagesField = GridField::create('Images', 'Images', $this->Images()->sort('SortOrder'), $config);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

            $fields->addFieldToTab('Root.Photos', $imagesField);

        }

        return $fields;
    }
}

class PhotoGalleryBlock_Controller extends BlockController

{
    /**
     *
     */
    public function init()
    {
        Requirements::css('dynamic-blocks/thirdparty/lightbox/lightbox.css');
        Requirements::javascript('dynamic-blocks/thirdparty/lightbox/lightbox.min.js');
    }
}

1			<?php
2
3			namespace Dynamic\DynamicBlocks\Block;
4
5			use Dynamic\DynamicBlocks\Model\PhotoGalleryBlockImage;
6			use SheaDawson\Blocks\Controllers\BlockController;
7			use SheaDawson\Blocks\Model\Block;
8	12		use SilverStripe\Forms\GridField\GridField;
9			use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor;
10	12		use SilverStripe\Forms\GridField\GridFieldDeleteAction;
11			use SilverStripe\View\Requirements;
12			use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
13
14		View Code Duplication	class PhotoGalleryBlock extends Block
			0 ignored issues – show Duplication introduced 2017-02-05 20:30 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
15			{
16	1		/**
17			* @return string
18	1		*/
19			public function singular_name()
20			{
21			return _t('PhotoGalleryBlock.SINGULARNAME', 'Photo Gallery Block');
22			}
23
24			/**
25			* @return string
26			*/
27			public function plural_name()
28			{
29			return _t('PhotoGalleryBlock.PLURALNAME', 'Photo Gallery Blocks');
30			}
31	1
32			/**
33	1		* @var array
34			*/
35	1		private static $has_many = array(
36	1		'Images' => PhotoGalleryBlockImage::class
37	1		);
38
39	1		/**
40	1		* @return \SilverStripe\Forms\FieldList
41	1		*/
42	1		public function getCMSFields()
43	1		{
44	1		$fields = parent::getCMSFields();
45	1
46			$fields->removeByName([
47	1		'Images',
48			]);
49	1
50			if ($this->owner->ID) {
			0 ignored issues – show Documentation introduced 2017-07-06 04:36 UTC by Report Bug Copy Issue Report The property `owner` does not exist on `object<Dynamic\DynamicBl...lock\PhotoGalleryBlock>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
51	1		$config = GridFieldConfig_RecordEditor::create();
52			$config->addComponent(new GridFieldOrderableRows('SortOrder'));
53			$config->removeComponentsByType('GridFieldAddExistingAutocompleter');
54			$config->removeComponentsByType('GridFieldDeleteAction');
55			$config->addComponent(new GridFieldDeleteAction(false));
56			$imagesField = GridField::create('Images', 'Images', $this->Images()->sort('SortOrder'), $config);
			0 ignored issues – show Documentation Bug introduced 2017-07-06 04:36 UTC by Report Bug Copy Issue Report The method `Images` does not exist on `object<Dynamic\DynamicBl...lock\PhotoGalleryBlock>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
57
58			$fields->addFieldToTab('Root.Photos', $imagesField);
59
60			}
61
62			return $fields;
63			}
64			}
65
66	1		class PhotoGalleryBlock_Controller extends BlockController
			0 ignored issues – show Coding Style Compatibility introduced 2017-02-05 20:30 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
67			{
68			/**
69			*
70			*/
71			public function init()
72			{
73			Requirements::css('dynamic-blocks/thirdparty/lightbox/lightbox.css');
74			Requirements::javascript('dynamic-blocks/thirdparty/lightbox/lightbox.min.js');
75			}
76			}

dynamic / dynamic-blocks

Pull Request — master (#62)

PhotoGalleryBlock::getCMSFields() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like