AnyPriceRoundUpDonationModifier

Complexity

Total Complexity

49

Size/Duplication

Total Lines	367
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	getCMSFields()	0	5	1
A	i18n_singular_name()	0	4	1
A	i18n_plural_name()	0	4	1
A	runUpdate()	0	8	1
A	updateAddDonation()	0	5	2
A	updateOtherValue()	0	5	1
A	ShowForm()	0	10	1
A	ShowFormInEditableOrderTable()	0	4	3
B	getModifierForm()	0	26	1
A	ShowInTable()	0	7	2
A	CanBeRemoved()	0	4	1
A	hasDonation()	0	7	4
C	workOutRoundUpAmount()	0	23	7
A	LiveName()	0	10	3
A	LiveAddDonation()	0	4	1
A	LiveOtherValue()	0	4	1
A	LiveSubTotal()	0	9	2
C	LiveModifierTotalExcludingDonation()	0	24	7
A	LiveCalculatedTotal()	0	8	2
A	LiveTableValue()	0	4	1
A	getTableSubTitle()	0	4	1
A	onBeforeWrite()	0	4	1
A	HideInAjaxUpdate()	0	13	4

<?php

/**
 * @author Nicolaas [at] sunnysideup.co.nz
 * @package: ecommerce
 * @sub-package: ecommerce_delivery
 * @description: allows you to add a modifier at checkout where the customer is prompted to
 * add a donation rounding up to the next round number.
 *
 * The trick here is to work out the value of the donation
 * from the total without the donation and then add it to the donation
 * to get to a round numer.
 *
 */
class AnyPriceRoundUpDonationModifier extends OrderModifier

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{

// ######################################## *** model defining static variables (e.g. $db, $has_one)

    /**
     * add extra fields as you need them.
     *
     **/
    private static $db = array(

Consider using a different property name as you override a private property of the parent class.

The property $db is not used and could be removed.

        "ModifierTotalExcludingDonation" => "Currency",
        "SubTotal" => "Currency",
        "OtherValue" => "Currency",
        "AddDonation" => "Boolean"
    );

    // ######################################## *** cms variables + functions (e.g. getCMSFields, $searchableFields)

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        return $fields;
    }

    private static $singular_name = "Round Up Donation";

Consider using a different property name as you override a private property of the parent class.

The property $singular_name is not used and could be removed.

    public function i18n_singular_name()
    {
        return _t("AnyPriceRoundUpDonationModifier.ROUNDUPDONATION", "Round Up Donation");
    }

    private static $plural_name = "Round Up Donations";

Consider using a different property name as you override a private property of the parent class.

The property $plural_name is not used and could be removed.

    public function i18n_plural_name()
    {
        return _t("AnyPriceRoundUpDonationModifier.ROUNDUPDONATIONS", "Round Up Donations");
    }

    // ######################################## *** other (non) static variables (e.g. private static $special_name_for_something, protected $order)


    /**
     * Maximum Round Up
     * to which the donation should round.
     * +1 = nearest 10, e.g. 73.45 rounds to 80
     * 0 = nearest rounded integer - e.g. 73.45 rounds to 74
     * -1 = nearest 10 cents - e.g. 73.45 rounds to 73.50
     *
     * @var Int
     */
    private static $precision = 1;

The property $precision is not used and could be removed.

    /**
     * Maximum Round Up - modifier will ensure that the round up is no more
     * than the number specified here.
     * @var Int
     */
    private static $maximum_round_up = 5;

The property $maximum_round_up is not used and could be removed.

    private static $round_up_even_if_there_is_nothing_to_round = true;

The property $round_up_even_if_there_is_nothing_to_round is not used and could be removed.

    private static $include_form_in_order_table = true;

    // ######################################## *** CRUD functions (e.g. canEdit)
    // ######################################## *** init and update functions

    /**
     * For all modifers with their own database fields, we need to include this...
     * It will update each of the fields.
     * With this, we also need to create the methods
     * Live{functionName}
     * e.g LiveMyField() and LiveMyReduction() in this case...
     * @param Bool $force - run it, even if it has run already
     */
    public function runUpdate($force = false)
    {
        $this->checkField("AddDonation");
        $this->checkField("OtherValue");
        $this->checkField("SubTotal");
        $this->checkField("ModifierTotalExcludingDonation");
        parent::runUpdate($force);
    }

    /**
     * allows you to save a new value AddDonation
     * @param Boolean $b
     */
    public function updateAddDonation($b)
    {
        $this->AddDonation = $b ? 1 : 0;

The property AddDonation does not exist on object<AnyPriceRoundUpDonationModifier>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->write();
    }

    /**
     * allows you to save a new value OtherValue
     * @param float
     */
    public function updateOtherValue($f)
    {
        $this->OtherValue = $f;

The property OtherValue does not exist on object<AnyPriceRoundUpDonationModifier>. Since you implemented __set, maybe consider adding a @property annotation.

        $this->write();
    }


    // ######################################## *** form functions (e. g. Showform and getform)

    /**
     * standard OrderModifier Method
     * Should we show a form in the checkout page for this modifier?
     */
    public function ShowForm()

The return type could not be reliably inferred; please add a @return annotation.

    {
        /*$ajaxObject = $this->AJAXDefinitions();

50% of this comment could be valid code. Did you maybe forget this after debugging?

        //TableValue is a database value
        $tableID = $ajaxObject->TableID();
        if(!$this->hasDonation()) {
            Requirements::customScript("jQuery(document).ready(function() {jQuery(\"#".$tableID."\").hide();});", "hide$tableID");
        }*/
        return $this->Order()->Items();
    }

    /**
     * Should the form be included in the editable form
     * on the checkout page?
     * @return Boolean
     */
    public function ShowFormInEditableOrderTable()
    {
        return ($this->ShowForm() && self::$include_form_in_order_table) ? true : false;
    }

    /**
     * standard OrderModifier Method
     * This method returns the form for the checkout page.
     * @param Object $controller = Controller object for form

There is no parameter named $controller. Did you maybe mean $optionalController?

     * @return Object - AnyPriceRoundUpDonationModifier
     */
    public function getModifierForm(Controller $optionalController = null, Validator $optionalValidator = null)
    {
        $fields = new FieldList();
        $fields->push($this->headingField());
        $fields->push($this->descriptionField());
        $maxRoundUpObject = DBField::create_field('Currency', Config::inst()->get("AnyPriceRoundUpDonationModifier", 'maximum_round_up'));
        $checkFieldTitle = sprintf(
            _t("AnyPriceRoundUpDonationModifier.ADDDONATION", "Add round up donation (maximum added %s)?"),
            $maxRoundUpObject->Nice()
        );
        $checkField = new DropdownField(
            'AddDonation',
            $checkFieldTitle,
            array(
                _t("AnyPriceRoundUpDonationModifier.NO", 'No'),
                _t("AnyPriceRoundUpDonationModifier.YES", 'Yes')
            ),
            $this->AddDonation

The property AddDonation does not exist on object<AnyPriceRoundUpDonationModifier>. Since you implemented __get, maybe consider adding a @property annotation.

        );
        $fields->push($checkField);
        $fields->push(new NumericFIeld('OtherValue', _t("AnyPriceRoundUpDonationModifier.OTHERVALUE", "Other Value"), $this->OtherValue));

The property OtherValue does not exist on object<AnyPriceRoundUpDonationModifier>. Since you implemented __get, maybe consider adding a @property annotation.

        $actions = new FieldList(
            new FormAction('submit', 'Update Order')
        );
        return new AnyPriceRoundUpDonationModifier_Form($optionalController, 'AnyPriceRoundUpDonationModifier', $fields, $actions, $optionalValidator);
    }

    // ######################################## *** template functions (e.g. ShowInTable, TableTitle, etc...) ... USES DB VALUES


    /**
     * This has to be set to true, because it can be added by form using AJAX.
     * @return Boolean
     */
    public function ShowInTable()
    {
        if ($this->Order()->IsSubmitted()) {
            return $this->TableValue > 0;

The property TableValue does not exist on object<AnyPriceRoundUpDonationModifier>. Since you implemented __get, maybe consider adding a @property annotation.

        }
        return true;
    }

    /**
     * Removed via form instead.
     * @return Boolean
     */
    public function CanBeRemoved()
    {
        return false;
    }

    // ######################################## ***  inner calculations.... USES CALCULATED VALUES


    /**
     * Works out if there is a donation at all.
     *
     *@return Boolean
     */
    protected function hasDonation()
    {
        if (($this->LiveAddDonation() && Config::inst()->get("AnyPriceRoundUpDonationModifier", 'maximum_round_up') > 0) || $this->OtherValue > 0) {

The property OtherValue does not exist on object<AnyPriceRoundUpDonationModifier>. Since you implemented __get, maybe consider adding a @property annotation.

This if statement, and the following return statement can be replaced with return $this->LiveAddDonation() && \Config::inst()->get('AnyPriceRoundUpDonationModifier', 'maximum_round_up') > 0 || $this->OtherValue > 0;.

            return true;
        }
        return false;
    }
    /**
     * Works out the total round up amount, using both the
     * sub-total and the modifier total.
     *
     *@return Float
     */
    protected function workOutRoundUpAmount()
    {
        if ($this->hasDonation()) {
            if ($this->OtherValue > 0) {

The property OtherValue does not exist on object<AnyPriceRoundUpDonationModifier>. Since you implemented __get, maybe consider adding a @property annotation.

                $actualAdditionToTotal = $this->OtherValue;

The property OtherValue does not exist on object<AnyPriceRoundUpDonationModifier>. Since you implemented __set, maybe consider adding a @property annotation.

            } else {
                $totalExcludingDonation = $this->LiveSubTotal() + $this->LiveModifierTotalExcludingDonation();
                $precisionMultiplier = pow(10, Config::inst()->get('AnyPriceRoundUpDonationModifier', 'precision'));
                $totalMultipliedByPrecision = $totalExcludingDonation / $precisionMultiplier;
                $roundedTotalMultipliedByPrecision = ceil($totalMultipliedByPrecision);
                $actualAdditionToTotal = ($roundedTotalMultipliedByPrecision * $precisionMultiplier) - $totalExcludingDonation;
                while ($actualAdditionToTotal > Config::inst()->get("AnyPriceRoundUpDonationModifier", 'maximum_round_up') && $actualAdditionToTotal > 0) {
                    $actualAdditionToTotal = $actualAdditionToTotal - Config::inst()->get("AnyPriceRoundUpDonationModifier", 'maximum_round_up');
                }
                if (Config::inst()->get('AnyPriceRoundUpDonationModifier', 'round_up_even_if_there_is_nothing_to_round') && $actualAdditionToTotal == 0) {
                    $actualAdditionToTotal = Config::inst()->get("AnyPriceRoundUpDonationModifier", 'maximum_round_up');
                }
            }
        } else {
            $actualAdditionToTotal = 0;
        }
        return $actualAdditionToTotal;
    }


    // ######################################## *** calculate database fields: protected function Live[field name]  ... USES CALCULATED VALUES

    /**
     * if we want to change the default value for the Name field
     * (defined in the OrderModifer class) then we can do this
     * as shown in the method below.
     * You may choose to return an empty string or just a standard message.
     *
     *
     **/
    protected function LiveName()
    {
        if ($this->OtherValue > 0) {

The property OtherValue does not exist on object<AnyPriceRoundUpDonationModifier>. Since you implemented __get, maybe consider adding a @property annotation.

            return _t("AnyPriceRoundUpDonationModifier.DONATION", "Donation");
        } elseif ($this->hasDonation()) {
            return _t("AnyPriceRoundUpDonationModifier.ROUNDUPDONATION", "Round up donation");
        } else {
            return _t("AnyPriceRoundUpDonationModifier.NOROUNDUPDONATION", "No round up donation added");
        }
    }

    /**
     *
     * @return Boolean
     **/
    protected function LiveAddDonation()
    {
        return $this->AddDonation;

The property AddDonation does not exist on object<AnyPriceRoundUpDonationModifier>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     *
     * @return Float
     **/
    protected function LiveOtherValue()
    {
        return $this->OtherValue;

The property OtherValue does not exist on object<AnyPriceRoundUpDonationModifier>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Work out sub total amount for order
     * @return float
     **/
    protected function LiveSubTotal()
    {
        if ($this->hasDonation()) {
            $order = $this->Order();
            return $order->SubTotal();
        } else {
            return 0;
        }
    }

    /**
     * Work out modifier total excluding donation
     * @return float

Should the return type not be double|integer?

     **/
    protected function LiveModifierTotalExcludingDonation()
    {
        if ($this->hasDonation()) {
            $modifiersTotal = 0;
            $order = $this->Order();
            if ($order) {
                if ($modifiers = $order->Modifiers()) {
                    foreach ($modifiers as $modifier) {
                        if (!$modifier->IsRemoved()) { //we just doubledouble-check this...
                            if ($modifier instanceof $this->ClassName) {
                                $totalForModifier = 0;
                            } else {
                                $totalForModifier = $modifier->CalculationTotal();
                            }
                            $modifiersTotal += floatval($totalForModifier);
                        }
                    }
                }
            }
            return $modifiersTotal;
        } else {
            return 0;
        }
    }

    protected function LiveCalculatedTotal()
    {
        if ($this->hasDonation()) {
            return $this->workOutRoundUpAmount();
        } else {
            return 0;
        }
    }

    public function LiveTableValue()
    {
        return $this->LiveCalculatedTotal();
    }


    // ######################################## *** Type Functions (IsChargeable, IsDeductable, IsNoChange, IsRemoved)

    private static $table_sub_title;

The property $table_sub_title is not used and could be removed.

    public function getTableSubTitle()
    {
        return _t('AnyPriceRoundUpDonationModifier.TABLESUBTITLE', $this->stat('table_sub_title'));
    }

    // ######################################## *** standard database related functions (e.g. onBeforeWrite, onAfterWrite, etc...)

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
    }


    // ######################################## *** AJAX related functions
    /**
    * some modifiers can be hidden after an ajax update (e.g. if someone enters a discount coupon and it does not exist).
    * There might be instances where ShowInTable (the starting point) is TRUE and HideInAjaxUpdate return false.
    *@return Boolean
    **/
    public function HideInAjaxUpdate()
    {
        //we check if the parent wants to hide it...
        //we need to do this first in case it is being removed.
        if (parent::HideInAjaxUpdate()) {
            return true;
        }
        // we do NOT hide it if values have been entered
        if ($this->hasDonation() || $this->ShowFormInEditableOrderTable()) {

This if statement, and the following return statement can be replaced with return !($this->hasDonation() || $this->ShowFormInEditableOrderTable());.

            return false;
        }
        return true;
    }
    // ######################################## *** debug functions
}

class AnyPriceRoundUpDonationModifier_Form extends OrderModifierForm

PSR1 recommends that each class should be in its own file to aid autoloaders.

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    public function __construct($optionalController = null, $name, $fields, $actions, $optionalValidator = null)

Parameters which have default values should be placed at the end.

    {
        parent::__construct($optionalController, $name, $fields, $actions, $optionalValidator);
        Requirements::javascript("ecommerce_anypriceproduct/javascript/AnyPriceRoundUpDonationModifier.js");
    }

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

The return type could not be reliably inferred; please add a @return annotation.

    {
        $order = ShoppingCart::current_order();
        if ($order) {
            if ($modifiers = $order->Modifiers("AnyPriceRoundUpDonationModifier")) {
                $msg = "";
                foreach ($modifiers as $modifier) {
                    if (isset($data['AddDonation']) && $data['AddDonation']) {
                        $modifier->updateAddDonation(true);
                        $msg .= _t("AnyPriceRoundUpDonationModifier.UPDATED", "Round up donation added - THANK YOU.");
                    } else {
                        $modifier->updateAddDonation(false);
                        $msg .= _t("AnyPriceRoundUpDonationModifier.REMOVED", "Round up donation removed.");
                    }
                    if (isset($data['OtherValue'])) {

This code seems to be duplicated across your project.

                        $modifier->updateOtherValue(floatval($data['OtherValue']));
                        if (floatval($data['OtherValue']) > 0) {
                            //here we replace the message!
                            $msg = _t("AnyPriceRoundUpDonationModifier.UPDATED_OTHER", "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"));
    }
}