DonationModifier::getModifierForm() - Code Metrics - sunnysideup/silverstripe-ecommerce_anypriceproduct - Measure and Improve Code Quality continuously with Scrutinizer

DonationModifier::getModifierForm() A
last analyzed 2018-03-20 01:02 UTC

↳ Parent: DonationModifier

Complexity

Conditions	2
Paths	2

Size

Total Lines	20
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	16
nc	2
nop	2

<?php

class DonationModifier extends AnyPriceRoundUpDonationModifier
namespace YourVendor;

class YourClass { }
{
    private static $has_one = array(

        'Donation' => 'DonationOption'
    );

    public function getModifierForm(Controller $optionalController = null, Validator $optionalValidator = null)
    {
        $form = parent::getModifierForm($optionalController, $optionalValidator);
        $donations = DonationOption::get();
        $fields = $form->Fields();
        if ($donations->count()) {
            $field = $fields->fieldByName('AddDonation');
            $title = $field->Title();
            $source = $field->getSource();
            $fields->removeByName('AddDonation');
            unset($source[1]);
            $donations = $donations->map()->toArray();
            $source += $donations;
            $fields->push(new DropdownField('DonationID', $title, $source, $this->DonationID));
<?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.");
        }
    }

}
        }
        $form = new DonationModifier_Form($form->Controller(), 'DonationModifier', $fields, $form->Actions(), $form->getValidator());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        //3.0TODO: Check me for consistencies.
        $form->addExtraClass('anyPriceRoundUpDonationModifier');
        return $form;
    }

    public function updateAddDonation($donationID)
    {
        $this->AddDonation = $donationID ? true : false;
<?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.");
        }
    }

}
        $this->DonationID = $donationID;
<?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.");
        }
    }

}
        $this->write();
    }

    protected function LiveName()

    {
        if ($this->hasDonation() && $this->DonationID) {
<?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.");
        }
    }

}
            return $this->Donation()->Title;

        } else {
            return parent::LiveName();
        }
    }
}

class DonationModifier_Form extends OrderModifierForm
namespace YourVendor;

class YourClass { }
{
    public function submit(array $data, Form $form, $message = "order updated", $status = "good")

    {
        $order = ShoppingCart::current_order();
        if ($order) {
            $modifier = $order->Modifiers('DonationModifier');
            if ($modifier) {
                $modifier = $modifier->First();
                $modifier->updateAddDonation($data['DonationID']);
                $msg = $data['DonationID'] ? _t("AnyPriceRoundUpDonationModifier.UPDATED", "Round up donation added - THANK YOU.") : _t("AnyPriceRoundUpDonationModifier.UPDATED", "Round up donation removed.");
                if (isset($data['OtherValue'])) {

                    $modifier->updateOtherValue(floatval($data['OtherValue']));
                    if (floatval($data['OtherValue']) > 0) {
                        $msg .= _t("AnyPriceRoundUpDonationModifier.UPDATED", "Added donation - THANK YOU.");
                    }
                } else {
                    $modifier->updateOtherValue(0);
                }
                $modifier->write();
                return ShoppingCart::singleton()->setMessageAndReturn($msg, "good");
            }
        }
        return ShoppingCart::singleton()->setMessageAndReturn(_t("AnyPriceRoundUpDonationModifier.NOTUPDATED", "Could not update the round up donation status.", "bad"));
    }
}


1		<?php
2
3		class DonationModifier extends AnyPriceRoundUpDonationModifier
		0 ignored issues – show Coding Style Compatibility introduced 2017-04-27 09:26 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...
4		{
5		private static $has_one = array(
		0 ignored issues – show Comprehensibility introduced 2017-04-27 09:26 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 2017-04-27 09:26 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...
6		'Donation' => 'DonationOption'
7		);
8
9		public function getModifierForm(Controller $optionalController = null, Validator $optionalValidator = null)
10		{
11		$form = parent::getModifierForm($optionalController, $optionalValidator);
12		$donations = DonationOption::get();
13		$fields = $form->Fields();
14		if ($donations->count()) {
15		$field = $fields->fieldByName('AddDonation');
16		$title = $field->Title();
17		$source = $field->getSource();
18		$fields->removeByName('AddDonation');
19		unset($source[1]);
20		$donations = $donations->map()->toArray();
21		$source += $donations;
22		$fields->push(new DropdownField('DonationID', $title, $source, $this->DonationID));
		0 ignored issues – show Documentation introduced 2017-04-27 09:26 UTC by Report Bug Copy Issue Report The property `DonationID` does not exist on `object<DonationModifier>`. 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...
23		}
24		$form = new DonationModifier_Form($form->Controller(), 'DonationModifier', $fields, $form->Actions(), $form->getValidator());
		0 ignored issues – show Bug introduced 2017-04-27 09:26 UTC by Report Bug Copy Issue Report It seems like `$fields` defined by `$form->Fields()` on line `13` can be `null`; however, `OrderModifierForm::__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null / function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history... Bug introduced 2017-04-27 09:26 UTC by Report Bug Copy Issue Report It seems like `$form->Actions()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /* @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history... Deprecated Code introduced 2017-04-27 09:26 UTC by Report Bug Copy Issue Report The method `Form::Controller()` has been deprecated with message: 4.0 This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
25		//3.0TODO: Check me for consistencies.
26		$form->addExtraClass('anyPriceRoundUpDonationModifier');
27		return $form;
28		}
29
30		public function updateAddDonation($donationID)
31		{
32		$this->AddDonation = $donationID ? true : false;
		0 ignored issues – show Documentation introduced 2017-04-27 09:26 UTC by Report Bug Copy Issue Report The property `AddDonation` does not exist on `object<DonationModifier>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
33		$this->DonationID = $donationID;
		0 ignored issues – show Documentation introduced 2017-04-27 09:26 UTC by Report Bug Copy Issue Report The property `DonationID` does not exist on `object<DonationModifier>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
34		$this->write();
35		}
36
37		protected function LiveName()
		0 ignored issues – show Documentation introduced 2018-02-01 09:09 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
38		{
39		if ($this->hasDonation() && $this->DonationID) {
		0 ignored issues – show Documentation introduced 2017-04-27 09:26 UTC by Report Bug Copy Issue Report The property `DonationID` does not exist on `object<DonationModifier>`. 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...
40		return $this->Donation()->Title;
		0 ignored issues – show Bug introduced 2017-04-27 09:26 UTC by Report Bug Copy Issue Report The method `Donation()` does not exist on `DonationModifier`. Did you maybe mean `updateAddDonation()`? 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...
41		} else {
42		return parent::LiveName();
43		}
44		}
45		}
46
47		class DonationModifier_Form extends OrderModifierForm
		0 ignored issues – show Coding Style Compatibility introduced 2017-04-27 09:26 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history... Coding Style Compatibility introduced 2017-04-27 09:26 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...
48		{
49		public function submit(array $data, Form $form, $message = "order updated", $status = "good")
		0 ignored issues – show Documentation introduced 2018-02-01 09:09 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
50		{
51		$order = ShoppingCart::current_order();
52		if ($order) {
53		$modifier = $order->Modifiers('DonationModifier');
54		if ($modifier) {
55		$modifier = $modifier->First();
56		$modifier->updateAddDonation($data['DonationID']);
57		$msg = $data['DonationID'] ? _t("AnyPriceRoundUpDonationModifier.UPDATED", "Round up donation added - THANK YOU.") : _t("AnyPriceRoundUpDonationModifier.UPDATED", "Round up donation removed.");
58	View Code Duplication	if (isset($data['OtherValue'])) {
		0 ignored issues – show Duplication introduced 2017-04-27 09:26 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
59		$modifier->updateOtherValue(floatval($data['OtherValue']));
60		if (floatval($data['OtherValue']) > 0) {
61		$msg .= _t("AnyPriceRoundUpDonationModifier.UPDATED", "Added donation - THANK YOU.");
62		}
63		} else {
64		$modifier->updateOtherValue(0);
65		}
66		$modifier->write();
67		return ShoppingCart::singleton()->setMessageAndReturn($msg, "good");
68		}
69		}
70		return ShoppingCart::singleton()->setMessageAndReturn(_t("AnyPriceRoundUpDonationModifier.NOTUPDATED", "Could not update the round up donation status.", "bad"));
71		}
72		}
73

sunnysideup / silverstripe-ecommerce_anypriceproduct

DonationModifier::getModifierForm() A last analyzed 2018-03-20 01:02 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

DonationModifier::getModifierForm() A
last analyzed 2018-03-20 01:02 UTC