PromoObject::getCMSFields() - Code Metrics - Inspection of "Merge pull request #19 from jsirish/feature/linkab..." - dynamic/dynamic-blocks - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 98ffbc...f44bfd )

by Jason

created 2017-01-26 21:37 UTC

PromoObject::getCMSFields() B

↳ Parent: PromoObject

Complexity

Conditions	1
Paths	1

Size

Total Lines	27
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	18
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	27
ccs	18
cts	18
cp	1
rs	8.8571
c	0
b	0
f	0
cc	1
eloc	16
nc	1
nop	0
crap	1

<?php

class PromoObject extends DataObject
{
    /**
     * @return string
     */
    private static $singular_name = 'Promo';

    /**
     * @return string
     */
    private static $plural_name = 'Promos';

    /**
     * @var array
     */
    private static $db = array(
        'Name' => 'Varchar(255)',
        'Title' => 'Varchar(255)',
        'Content' => 'HTMLText',
    );

    /**
     * @var array
     */
    private static $has_one = array(
        'Image' => 'Image',
        'Link' => 'Link',
    );

    /**
     * @var string
     */
    private static $default_sort = 'Name ASC';


    /**
     * @var array
     */
    private static $summary_fields = array(
        'Image.CMSThumbnail' => 'Image',
        'Name' => 'Name',
        'Title' => 'Title',
    );

    /**
     * @var array
     */
    private static $searchable_fields = array(
        'Name' => 'Name',
        'Title' => 'Title',
    );

    /**
     * @var array
     */
    private static $belongs_many_many = array(
        'PromoBlocks' => 'PromoBlock'
    );

    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function ($fields) {
            $fields->addFieldToTab(
                'Root.Main',
                LinkField::create('LinkID', 'Link'),
                'Content'
            );
        });

        $fields = parent::getCMSFields();

        $fields->removeByName(array(
            'PromoBlocks',
        ));

        $fields->dataFieldByName('Name')->setDescription('For internal reference only');

        $image = $fields->dataFieldByName('Image');
        $image->setFolderName('Uploads/Promos');
        $fields->insertBefore($image, 'Content');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $config = GridFieldConfig_RecordViewer::create();
        $fields->addFieldToTab('Root.Blocks', GridField::create('PromoBlocks', 'Blocks', $this->PromoBlocks(), $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 { }

        return $fields;
    }

    /**
     * @return ValidationResult
     */
    public function validate()
    {
        $result = parent::validate();

        if (!$this->Name) {
<?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.");
        }
    }

}
            $result->error('Name is requied before you can save');
        }

        return $result;
    }

    /**
     * Set permissions, allow all users to access by default.
     * Override in descendant classes, or use PermissionProvider.
     */

    /**
     * @param null $member
     *
     * @return bool
     */
    public function canCreate($member = null)
    {
        return true;
    }

    /**
     * @param null $member
     *
     * @return bool
     */
    public function canView($member = null)
    {
        return true;
    }

    /**
     * @param null $member
     *
     * @return bool
     */
    public function canEdit($member = null)
    {
        return true;
    }

    /**
     * @param null $member
     *
     * @return bool
     */
    public function canDelete($member = null)
    {
        return true;
    }
}

1		<?php
2
3		class PromoObject extends DataObject
4		{
5		/**
6		* @return string
7		*/
8		private static $singular_name = 'Promo';
9
10		/**
11		* @return string
12		*/
13		private static $plural_name = 'Promos';
14
15		/**
16		* @var array
17		*/
18		private static $db = array(
19		'Name' => 'Varchar(255)',
20		'Title' => 'Varchar(255)',
21		'Content' => 'HTMLText',
22		);
23
24		/**
25		* @var array
26		*/
27		private static $has_one = array(
28		'Image' => 'Image',
29		'Link' => 'Link',
30		);
31
32		/**
33		* @var string
34		*/
35		private static $default_sort = 'Name ASC';
		0 ignored issues – show Unused Code introduced 2016-09-27 04:07 UTC by Report Bug Copy Issue Report The property `$default_sort` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
36
37		/**
38		* @var array
39		*/
40		private static $summary_fields = array(
41		'Image.CMSThumbnail' => 'Image',
42		'Name' => 'Name',
43		'Title' => 'Title',
44		);
45
46		/**
47		* @var array
48		*/
49		private static $searchable_fields = array(
50		'Name' => 'Name',
51		'Title' => 'Title',
52		);
53
54		/**
55		* @var array
56		*/
57		private static $belongs_many_many = array(
58		'PromoBlocks' => 'PromoBlock'
59		);
60
61	1	public function getCMSFields()
62		{
63	1	$this->beforeUpdateCMSFields(function ($fields) {
64	1	$fields->addFieldToTab(
65	1	'Root.Main',
66	1	LinkField::create('LinkID', 'Link'),
67		'Content'
68	1	);
69	1	});
70
71	1	$fields = parent::getCMSFields();
72
73	1	$fields->removeByName(array(
74	1	'PromoBlocks',
75	1	));
76
77	1	$fields->dataFieldByName('Name')->setDescription('For internal reference only');
78
79	1	$image = $fields->dataFieldByName('Image');
80	1	$image->setFolderName('Uploads/Promos');
81	1	$fields->insertBefore($image, 'Content');
		0 ignored issues – show Documentation introduced 2016-09-27 04:07 UTC by Report Bug Copy Issue Report `'Content'` is of type `string`, but the function expects a `object<FormField>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
82
83	1	$config = GridFieldConfig_RecordViewer::create();
84	1	$fields->addFieldToTab('Root.Blocks', GridField::create('PromoBlocks', 'Blocks', $this->PromoBlocks(), $config));
		0 ignored issues – show Documentation Bug introduced 2016-09-27 04:07 UTC by Report Bug Copy Issue Report The method `PromoBlocks` does not exist on `object<PromoObject>`? 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...
85
86	1	return $fields;
87		}
88
89		/**
90		* @return ValidationResult
91		*/
92		public function validate()
93		{
94		$result = parent::validate();
95
96		if (!$this->Name) {
		0 ignored issues – show Documentation introduced 2016-09-27 04:07 UTC by Report Bug Copy Issue Report The property `Name` does not exist on `object<PromoObject>`. 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...
97		$result->error('Name is requied before you can save');
98		}
99
100		return $result;
101		}
102
103		/**
104		* Set permissions, allow all users to access by default.
105		* Override in descendant classes, or use PermissionProvider.
106		*/
107
108		/**
109		* @param null $member
110		*
111		* @return bool
112		*/
113		public function canCreate($member = null)
114		{
115		return true;
116		}
117
118		/**
119		* @param null $member
120		*
121		* @return bool
122		*/
123		public function canView($member = null)
124		{
125		return true;
126		}
127
128		/**
129		* @param null $member
130		*
131		* @return bool
132		*/
133		public function canEdit($member = null)
134		{
135		return true;
136		}
137
138		/**
139		* @param null $member
140		*
141		* @return bool
142		*/
143		public function canDelete($member = null)
144		{
145		return true;
146		}
147		}

dynamic / dynamic-blocks

Push — master ( 98ffbc...f44bfd )

PromoObject::getCMSFields() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like