Moo_EditableFieldDate::getFieldConfiguration() - Code Metrics - Inspection of "Bug: replace GridFieldEditableManyManyExtraColumns..." - satrun77/silverstripe-editablefield - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2bc3ae...eaf16e )

by Mohamed

created 2016-10-28 09:33 UTC

Moo_EditableFieldDate::getFieldConfiguration() A

↳ Parent: Moo_EditableFieldDate

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	0
cts	5
cp	0
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	0
crap	6

<?php

/**
 * Moo_EditableFieldDate is an object representing date field created by CMS admin.
 *
 * @package editablefield
 *
 * @author  Mohamed Alsharaf <[email protected]>
 */
class Moo_EditableFieldDate extends Moo_EditableField
{
    private static $singular_name   = 'Date Field';
    private static $plural_name     = 'Date Fields';
    protected $customSettingsFields = [
        'DefaultToToday',
    ];
    public function getFieldConfiguration()
    {
        $default = ($this->getSetting('DefaultToToday')) ? $this->getSetting('DefaultToToday') : false;
        $label   = _t('Moo_EditableField.DEFAULTTOTODAY', 'Default to Today?');

        return [
            new CheckboxField($this->getSettingName('DefaultToToday'), $label, $default),
        ];
    }

    public function populateFromPostData($data)
    {
        $fieldPrefix = 'Default-';

        if (empty($data['Default']) && !empty($data[$fieldPrefix . 'Year']) && !empty($data[$fieldPrefix . 'Month']) && !empty($data[$fieldPrefix . 'Day'])) {
            $data['Default'] = $data['Year'] . '-' . $data['Month'] . '-' . $data['Day'];
        }

        parent::populateFromPostData($data);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    protected function initFormField()
    {
        $defaultValue = ($this->getSetting('DefaultToToday')) ? date('Y-m-d') : $this->Default;

        $field        = new DateField($this->Name, $this->Title, $defaultValue);
        $field->setConfig('showcalendar', true);

        return $field;
    }
}


1			<?php
2
3			/**
4			* Moo_EditableFieldDate is an object representing date field created by CMS admin.
5			*
6			* @package editablefield
7			*
8			* @author Mohamed Alsharaf <[email protected]>
9			*/
10			class Moo_EditableFieldDate extends Moo_EditableField
11			{
12			private static $singular_name = 'Date Field';
13			private static $plural_name = 'Date Fields';
14			protected $customSettingsFields = [
15			'DefaultToToday',
16			];
17			public function getFieldConfiguration()
18			{
19			$default = ($this->getSetting('DefaultToToday')) ? $this->getSetting('DefaultToToday') : false;
20			$label = _t('Moo_EditableField.DEFAULTTOTODAY', 'Default to Today?');
21
22			return [
23			new CheckboxField($this->getSettingName('DefaultToToday'), $label, $default),
24			];
25			}
26
27			public function populateFromPostData($data)
28			{
29			$fieldPrefix = 'Default-';
30
31			if (empty($data['Default']) && !empty($data[$fieldPrefix . 'Year']) && !empty($data[$fieldPrefix . 'Month']) && !empty($data[$fieldPrefix . 'Day'])) {
32			$data['Default'] = $data['Year'] . '-' . $data['Month'] . '-' . $data['Day'];
33			}
34
35			parent::populateFromPostData($data);
			0 ignored issues – show Bug introduced 2016-10-28 09:38 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Moo_EditableField` as the method `populateFromPostData()` does only exist in the following sub-classes of `Moo_EditableField`: `Moo_EditableFieldDate`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
36			}
37
38			protected function initFormField()
39			{
40			$defaultValue = ($this->getSetting('DefaultToToday')) ? date('Y-m-d') : $this->Default;
			0 ignored issues – show Bug introduced 2016-10-28 09:38 UTC by Report Bug Copy Issue Report The property `Default` does not seem to exist. Did you mean `default_cast`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
41			$field = new DateField($this->Name, $this->Title, $defaultValue);
42			$field->setConfig('showcalendar', true);
43
44			return $field;
45			}
46			}
47

satrun77 / silverstripe-editablefield

Push — master ( 2bc3ae...eaf16e )

Moo_EditableFieldDate::getFieldConfiguration() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like