EditableCheckbox::getCMSFields() - Code Metrics - Inspection of "Removed unneeded list markup from EditableRadioFie..." - silverstripe/silverstripe-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#636)

by Franco

created 2017-07-11 04:46 UTC

EditableCheckbox::getCMSFields() A

↳ Parent: EditableCheckbox

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	0
cts	7
cp	0
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	0
crap	2

<?php
/**
 * EditableCheckbox
 *
 * A user modifiable checkbox on a UserDefinedForm
 *
 * @package userforms
 */

class EditableCheckbox extends EditableFormField
namespace YourVendor;

class YourClass { }
{

    private static $singular_name = 'Checkbox Field';


    private static $plural_name = 'Checkboxes';


    protected $jsEventHandler = 'click';

    private static $db = array(

        'CheckedDefault' => 'Boolean' // from CustomSettings
    );

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

        $fields->replaceField('Default', CheckboxField::create(
            "CheckedDefault",
            _t('EditableFormField.CHECKEDBYDEFAULT', 'Checked by Default?')
        ));

        return $fields;
    }

    public function getFormField()
    {
        $field = CheckboxField::create($this->Name, $this->EscapedTitle, $this->CheckedDefault)
<?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.");
        }
    }

}
            ->setFieldHolderTemplate('UserFormsCheckboxField_holder')
            ->setTemplate('UserFormsCheckboxField');

        $this->doUpdateFormField($field);

        return $field;
    }

    public function getValueFromData($data)
    {
        $value = (isset($data[$this->Name])) ? $data[$this->Name] : false;

        return ($value) ? _t('EditableFormField.YES', 'Yes') : _t('EditableFormField.NO', 'No');
    }

    public function migrateSettings($data)
    {
        // Migrate 'Default' setting to 'CheckedDefault'
        if (isset($data['Default'])) {
            $this->CheckedDefault = (bool)$data['Default'];

            unset($data['Default']);
        }

        parent::migrateSettings($data);
    }

	public function isCheckBoxField() {
		return true;
	}
}


1		<?php
2		/**
3		* EditableCheckbox
4		*
5		* A user modifiable checkbox on a UserDefinedForm
6		*
7		* @package userforms
8		*/
9
10		class EditableCheckbox extends EditableFormField
		0 ignored issues – show Coding Style Compatibility introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
11		{
12
13		private static $singular_name = 'Checkbox Field';
		0 ignored issues – show Comprehensibility introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `$singular_name` 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...
14
15		private static $plural_name = 'Checkboxes';
		0 ignored issues – show Comprehensibility introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `$plural_name` 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...
16
17		protected $jsEventHandler = 'click';
18
19		private static $db = array(
		0 ignored issues – show Comprehensibility introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `$db` 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...
20		'CheckedDefault' => 'Boolean' // from CustomSettings
21		);
22
23		/**
24		* @return FieldList
25		*/
26		public function getCMSFields()
27		{
28		$fields = parent::getCMSFields();
29
30		$fields->replaceField('Default', CheckboxField::create(
31		"CheckedDefault",
32		_t('EditableFormField.CHECKEDBYDEFAULT', 'Checked by Default?')
33		));
34
35		return $fields;
36		}
37
38		public function getFormField()
39		{
40		$field = CheckboxField::create($this->Name, $this->EscapedTitle, $this->CheckedDefault)
		0 ignored issues – show Documentation introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The property `EscapedTitle` does not exist on `object<EditableCheckbox>`. 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... Bug introduced 2015-12-11 05:10 UTC by Report Bug Copy Issue Report The property `CheckedDefault` does not seem to exist. Did you mean `Default`? 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		->setFieldHolderTemplate('UserFormsCheckboxField_holder')
42		->setTemplate('UserFormsCheckboxField');
43
44		$this->doUpdateFormField($field);
45
46		return $field;
47		}
48
49		public function getValueFromData($data)
50		{
51		$value = (isset($data[$this->Name])) ? $data[$this->Name] : false;
52
53		return ($value) ? _t('EditableFormField.YES', 'Yes') : _t('EditableFormField.NO', 'No');
54		}
55
56	2	public function migrateSettings($data)
57		{
58		// Migrate 'Default' setting to 'CheckedDefault'
59	2	if (isset($data['Default'])) {
60	2	$this->CheckedDefault = (bool)$data['Default'];
		0 ignored issues – show Bug introduced 2015-12-11 05:10 UTC by Report Bug Copy Issue Report The property `CheckedDefault` does not seem to exist. Did you mean `Default`? 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...
61	2	unset($data['Default']);
62	2	}
63
64	2	parent::migrateSettings($data);
65	2	}
66
67		public function isCheckBoxField() {
68		return true;
69		}
70		}
71

silverstripe / silverstripe-userforms

Pull Request — master (#636)

EditableCheckbox::getCMSFields() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like