SubmittedForm::canCreate() - Code Metrics - Inspection of "Use precise distro for PHP 5.3 support in Travis" - silverstripe/silverstripe-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c6b309...12981b )

by Robbie

created 2017-08-11 04:24 UTC

SubmittedForm::canCreate() A

↳ Parent: SubmittedForm

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	7
Ratio	87.5 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

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

<?php
/**
 * Contents of an UserDefinedForm submission
 *
 * @package userforms
 */

class SubmittedForm extends DataObject
namespace YourVendor;

class YourClass { }
{

    private static $has_one = array(

        "SubmittedBy" => "Member",
        "Parent" => "UserDefinedForm",
    );

    private static $has_many = array(

        "Values" => "SubmittedFormField"
    );

    private static $summary_fields = array(

        'ID',
        'Created'
    );

    /**
     * Returns the value of a relation or, in the case of this form, the value
     * of a given child {@link SubmittedFormField}
     *
     * @param string
     *
     * @return mixed
     */
    public function relField($fieldName)
    {
        // default case
        if ($value = parent::relField($fieldName)) {
            return $value;
        }

        // check values for a form field with the matching name.
        $formField = SubmittedFormField::get()->filter(array(
            'ParentID' => $this->ID,
            'Name' => $fieldName
        ))->first();

        if ($formField) {
            return $formField->getFormattedValue();
        }
    }

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $self = $this;

        $this->beforeUpdateCMSFields(function ($fields) use ($self) {
            $fields->removeByName('Values');

            //check to ensure there is a Member to extract an Email from else null value
            if($self->SubmittedBy() && $self->SubmittedBy()->exists()){
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 { }
                $submitter =  $self->SubmittedBy()->Email;
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 { }
            } else {
                $submitter = null;
            }

            //replace scaffolded field with readonly submitter
            $fields->replaceField(
                'SubmittedByID',
                ReadonlyField::create(
                    'Submitter',
                    'Submitter',
                    $submitter
                )
            );

            $values = new GridField(
                'Values',
                'SubmittedFormField',
                $self->Values()->sort('Created', 'ASC')

            );

            $config = new GridFieldConfig();
            $config->addComponent(new GridFieldDataColumns());
            $config->addComponent(new GridFieldExportButton());
            $config->addComponent(new GridFieldPrintButton());
            $values->setConfig($config);

            $fields->addFieldToTab('Root.Main', $values);
        });

        $fields = parent::getCMSFields();

        return $fields;
    }

    /**
     * @param Member
     *
     * @return boolean
     */
    public function canCreate($member = null)

    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
        if ($extended !== null) {
            return $extended;
        }
        return $this->Parent()->canCreate();

    }

    /**
     * @param Member
     *
     * @return boolean
     */
    public function canView($member = null)

    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
        if ($extended !== null) {
            return $extended;
        }
        return $this->Parent()->canView();

    }

    /**
     * @param Member
     *
     * @return boolean
     */
    public function canEdit($member = null)

    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
        if ($extended !== null) {
            return $extended;
        }
        return $this->Parent()->canEdit();

    }

    /**
     * @param Member
     *
     * @return boolean
     */
    public function canDelete($member = null)

    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
        if ($extended !== null) {
            return $extended;
        }
        return $this->Parent()->canDelete();

    }

    /**
     * Before we delete this form make sure we delete all the
     * field values so that we don't leave old data round
     *
     * @return void
     */
    protected function onBeforeDelete()
    {
        if ($this->Values()) {

            foreach ($this->Values() as $value) {

                $value->delete();
            }
        }

        parent::onBeforeDelete();
    }
}


1		<?php
2		/**
3		* Contents of an UserDefinedForm submission
4		*
5		* @package userforms
6		*/
7
8		class SubmittedForm extends DataObject
		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...
9		{
10
11		private static $has_one = 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 `$has_one` 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...
12		"SubmittedBy" => "Member",
13		"Parent" => "UserDefinedForm",
14		);
15
16		private static $has_many = 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 `$has_many` 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...
17		"Values" => "SubmittedFormField"
18		);
19
20		private static $summary_fields = 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 `$summary_fields` 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...
21		'ID',
22		'Created'
23		);
24
25		/**
26		* Returns the value of a relation or, in the case of this form, the value
27		* of a given child {@link SubmittedFormField}
28		*
29		* @param string
30		*
31		* @return mixed
32		*/
33		public function relField($fieldName)
34		{
35		// default case
36		if ($value = parent::relField($fieldName)) {
37		return $value;
38		}
39
40		// check values for a form field with the matching name.
41		$formField = SubmittedFormField::get()->filter(array(
42		'ParentID' => $this->ID,
43		'Name' => $fieldName
44		))->first();
45
46		if ($formField) {
47		return $formField->getFormattedValue();
48		}
49		}
50
51		/**
52		* @return FieldList
53		*/
54		public function getCMSFields()
55		{
56		$self = $this;
57
58		$this->beforeUpdateCMSFields(function ($fields) use ($self) {
59		$fields->removeByName('Values');
60
61		//check to ensure there is a Member to extract an Email from else null value
62		if($self->SubmittedBy() && $self->SubmittedBy()->exists()){
		0 ignored issues – show Documentation Bug introduced 2017-06-19 00:34 UTC by Report Bug Copy Issue Report The method `SubmittedBy` does not exist on `object<SubmittedForm>`? 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...
63		$submitter = $self->SubmittedBy()->Email;
		0 ignored issues – show Documentation Bug introduced 2017-06-19 00:34 UTC by Report Bug Copy Issue Report The method `SubmittedBy` does not exist on `object<SubmittedForm>`? 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...
64		} else {
65		$submitter = null;
66		}
67
68		//replace scaffolded field with readonly submitter
69		$fields->replaceField(
70		'SubmittedByID',
71		ReadonlyField::create(
72		'Submitter',
73		'Submitter',
74		$submitter
75		)
76		);
77
78		$values = new GridField(
79		'Values',
80		'SubmittedFormField',
81		$self->Values()->sort('Created', 'ASC')
		0 ignored issues – show Bug introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The method `Values()` does not exist on `SubmittedForm`. Did you maybe mean `getXMLValues()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
82		);
83
84		$config = new GridFieldConfig();
85		$config->addComponent(new GridFieldDataColumns());
86		$config->addComponent(new GridFieldExportButton());
87		$config->addComponent(new GridFieldPrintButton());
88		$values->setConfig($config);
89
90		$fields->addFieldToTab('Root.Main', $values);
91		});
92
93		$fields = parent::getCMSFields();
94
95		return $fields;
96		}
97
98		/**
99		* @param Member
100		*
101		* @return boolean
102		*/
103	View Code Duplication	public function canCreate($member = null)
		0 ignored issues – show Duplication introduced 2017-08-11 04:49 UTC by Report Bug Copy Issue Report This method 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...
104		{
105		$extended = $this->extendedCan(__FUNCTION__, $member);
106		if ($extended !== null) {
107		return $extended;
108		}
109		return $this->Parent()->canCreate();
		0 ignored issues – show Bug introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The method `Parent()` does not exist on `SubmittedForm`. Did you maybe mean `parentClass()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
110		}
111
112		/**
113		* @param Member
114		*
115		* @return boolean
116		*/
117	View Code Duplication	public function canView($member = null)
		0 ignored issues – show Duplication introduced 2017-08-11 04:49 UTC by Report Bug Copy Issue Report This method 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...
118		{
119		$extended = $this->extendedCan(__FUNCTION__, $member);
120		if ($extended !== null) {
121		return $extended;
122		}
123		return $this->Parent()->canView();
		0 ignored issues – show Bug introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The method `Parent()` does not exist on `SubmittedForm`. Did you maybe mean `parentClass()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
124		}
125
126		/**
127		* @param Member
128		*
129		* @return boolean
130		*/
131	View Code Duplication	public function canEdit($member = null)
		0 ignored issues – show Duplication introduced 2017-08-11 04:49 UTC by Report Bug Copy Issue Report This method 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...
132		{
133		$extended = $this->extendedCan(__FUNCTION__, $member);
134		if ($extended !== null) {
135		return $extended;
136		}
137		return $this->Parent()->canEdit();
		0 ignored issues – show Bug introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The method `Parent()` does not exist on `SubmittedForm`. Did you maybe mean `parentClass()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
138		}
139
140		/**
141		* @param Member
142		*
143		* @return boolean
144		*/
145	View Code Duplication	public function canDelete($member = null)
		0 ignored issues – show Duplication introduced 2017-08-11 04:49 UTC by Report Bug Copy Issue Report This method 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...
146		{
147		$extended = $this->extendedCan(__FUNCTION__, $member);
148		if ($extended !== null) {
149		return $extended;
150		}
151		return $this->Parent()->canDelete();
		0 ignored issues – show Bug introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The method `Parent()` does not exist on `SubmittedForm`. Did you maybe mean `parentClass()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
152		}
153
154		/**
155		* Before we delete this form make sure we delete all the
156		* field values so that we don't leave old data round
157		*
158		* @return void
159		*/
160		protected function onBeforeDelete()
161		{
162		if ($this->Values()) {
		0 ignored issues – show Bug introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The method `Values()` does not exist on `SubmittedForm`. Did you maybe mean `getXMLValues()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
163		foreach ($this->Values() as $value) {
		0 ignored issues – show Bug introduced 2015-11-21 07:02 UTC by Report Bug Copy Issue Report The method `Values()` does not exist on `SubmittedForm`. Did you maybe mean `getXMLValues()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
164		$value->delete();
165		}
166		}
167
168		parent::onBeforeDelete();
169		}
170		}
171

silverstripe / silverstripe-userforms

Push — master ( c6b309...12981b )

SubmittedForm::canCreate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like