SubmittedForm::getCMSFields() - Code Metrics - Inspection of "FIX submissions export values" - silverstripe/silverstripe-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#627)

by Franco

created 2017-06-26 23:06 UTC

SubmittedForm::getCMSFields() A

↳ Parent: SubmittedForm

Complexity

Conditions	3
Paths	1

Size

Total Lines	48
Code Lines	29

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	48
ccs	0
cts	24
cp	0
rs	9.125
c	0
b	0
f	0
cc	3
eloc	29
nc	1
nop	0
crap	12

<?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')

            );

            $exportColumns = array(
                'Title' => 'Title',
                'ExportValue' => 'Value'
            );

            $config = new GridFieldConfig();
            $config->addComponent(new GridFieldDataColumns());
            $config->addComponent(new GridFieldExportButton('after', $exportColumns));
            $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			$exportColumns = array(
85			'Title' => 'Title',
86			'ExportValue' => 'Value'
87			);
88
89			$config = new GridFieldConfig();
90			$config->addComponent(new GridFieldDataColumns());
91			$config->addComponent(new GridFieldExportButton('after', $exportColumns));
92			$config->addComponent(new GridFieldPrintButton());
93			$values->setConfig($config);
94
95			$fields->addFieldToTab('Root.Main', $values);
96			});
97
98			$fields = parent::getCMSFields();
99
100			return $fields;
101			}
102
103			/**
104			* @param Member
105			*
106			* @return boolean
107			*/
108		View Code Duplication	public function canCreate($member = null)
			0 ignored issues – show Duplication introduced 2016-04-18 06:25 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...
109			{
110			$extended = $this->extendedCan(__FUNCTION__, $member);
111			if ($extended !== null) {
112			return $extended;
113			}
114			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...
115			}
116
117			/**
118			* @param Member
119			*
120			* @return boolean
121			*/
122		View Code Duplication	public function canView($member = null)
			0 ignored issues – show Duplication introduced 2016-04-18 06:25 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...
123			{
124			$extended = $this->extendedCan(__FUNCTION__, $member);
125			if ($extended !== null) {
126			return $extended;
127			}
128			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...
129			}
130
131			/**
132			* @param Member
133			*
134			* @return boolean
135			*/
136		View Code Duplication	public function canEdit($member = null)
			0 ignored issues – show Duplication introduced 2016-04-18 06:25 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...
137			{
138			$extended = $this->extendedCan(__FUNCTION__, $member);
139			if ($extended !== null) {
140			return $extended;
141			}
142			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...
143			}
144
145			/**
146			* @param Member
147			*
148			* @return boolean
149			*/
150		View Code Duplication	public function canDelete($member = null)
			0 ignored issues – show Duplication introduced 2016-04-18 06:25 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...
151			{
152			$extended = $this->extendedCan(__FUNCTION__, $member);
153			if ($extended !== null) {
154			return $extended;
155	1		}
156			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...
157			}
158
159			/**
160			* Before we delete this form make sure we delete all the
161			* field values so that we don't leave old data round
162			*
163			* @return void
164			*/
165			protected function onBeforeDelete()
166			{
167			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...
168			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...
169			$value->delete();
170			}
171			}
172
173			parent::onBeforeDelete();
174			}
175			}
176

silverstripe / silverstripe-userforms

Pull Request — master (#627)

SubmittedForm::getCMSFields() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like