EcommerceCustomDeliveryModifier

Complexity

Total Complexity

33

Size/Duplication

Total Lines	260
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

18 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	7	1
A	ShowForm()	0	4	1
A	ShowFormInEditableOrderTable()	0	4	1
A	ShowFormOutsideEditableOrderTable()	0	4	1
A	ShowInTable()	0	4	2
A	CanBeRemoved()	0	4	1
A	LiveName()	0	16	4
A	LiveCalculatedTotal()	0	12	2
A	onBeforeWrite()	0	4	1
A	LiveNonSpecialProductCount()	0	4	1
A	LiveSpecialProductCount()	0	4	1
C	ProductCountForTotal()	0	23	7
A	LivePostalCode()	0	17	4
A	SelectedProductsArray()	0	5	1
A	MyPostalCodeObject()	0	12	2

<?php

/**
 * @author Nicolaas [at] sunnysideup.co.nz
 * @package: ecommerce
 * @sub-package: examples
 * @description: This is an example modifier that developers can use
 * as a starting point for writing their own modifiers.
 *
 **/
class EcommerceCustomDeliveryModifier 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.
     *
     **/
    public static $db = array(
        "PostalCode" => "Varchar(10)",
        "SpecialProductCount" => "Int",
        "NonSpecialProductCount" => "Int"
    );


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

    /**
     * standard SS method
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        return $fields;
    }

    public static $singular_name = "Delivery Charge";
    public function i18n_singular_name()
    {
        return self::$singular_name;
    }

    public static $plural_name = "Delivery Charges";
    public function i18n_plural_name()
    {
        return self::$plural_name;
    }

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


// ######################################## *** 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.
     * Within this method, we need to create the methods
     * Live{functionName}
     * e.g LiveMyField() and LiveMyReduction() in this case...
     * The OrderModifier already updates the basic database fields.
     * @param Bool $force - run it, even if it has run already
     */
    public function runUpdate($force = false)
    {
        $this->checkField("PostalCode");
        $this->checkField("SpecialProductCount");
        $this->checkField("NonSpecialProductCount");
        parent::runUpdate($force);
    }


// ######################################## *** 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()
    {
        return false;
    }

    /**
     * Should the form be included in the editable form
     * on the checkout page?
     * @return Boolean
     */
    public function ShowFormInEditableOrderTable()
    {
        return false;
    }

    /**
     * Should the form be included in the editable form
     * on the checkout page?
     * @return Boolean
     */
    public function ShowFormOutsideEditableOrderTable()
    {
        return false;
    }

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

    /**
     * standard OrderModifer Method
     * Tells us if the modifier should take up a row in the table on the checkout page.
     * @return Boolean
     */
    public function ShowInTable()
    {
        return $this->PostalCode ? true : false;

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

    }

    /**
     * standard OrderModifer Method
     * Tells us if the modifier can be removed (hidden / turned off) from the order.
     * @return Boolean
     */
    public function CanBeRemoved()
    {
        return false;
    }

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



// ######################################## *** 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()

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

    {
        if ($obj = $this->MyPostalCodeObject()) {
            $title = $obj->Title;

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

        } else {
            $title = EcommerceDBConfig::current_ecommerce_db_config()->DeliveryChargeTitle;
        }
        if ($postalCode = $this->LivePostalCode()) {
            if ($postalCodeLabel = _t("EcommerceCustomDeliveryModifier.POSTAL_CODE", "postal code")) {
                $title .= " (".$postalCodeLabel.": ".$postalCode.")";
            }
        } else {

This else statement is empty and can be removed.

            //do nothing...
        }
        return $title;
    }

    protected function LiveCalculatedTotal()
    {
        $nonSpecialCount =  $this->LiveNonSpecialProductCount();
        $postalCodeObject =  $this->MyPostalCodeObject();
        if (!$postalCodeObject) {
            $postalCodeObject = EcommerceDBConfig::current_ecommerce_db_config();
        }
        $specialCount =  $this->LiveSpecialProductCount();
        return
            ($postalCodeObject->PriceWithoutApplicableProducts * $nonSpecialCount) +
            ($postalCodeObject->PriceWithApplicableProducts * $specialCount);
    }



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



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

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

// ######################################## *** debug functions

    public function LiveNonSpecialProductCount()
    {
        return $this->ProductCountForTotal(false);
    }

    public function LiveSpecialProductCount()
    {
        return $this->ProductCountForTotal(true);
    }

    /**
     * @return int
     */
    protected function ProductCountForTotal($special = false)
    {
        $specialCount = 0;
        $nonSpecialCount = 0;
        $applicableProducts = $this->SelectedProductsArray();
        if (count($applicableProducts)) {
            $order = $this->Order();
            if ($order) {
                foreach ($order->OrderItems() as $item) {
                    if ($special && in_array($item->Product()->ID, $applicableProducts)) {
                        $specialCount += $item->Quantity;
                    } else {
                        $nonSpecialCount += $item->Quantity;
                    }
                }
            }
        }
        if ($special) {
            return $specialCount;
        } else {
            return $nonSpecialCount;
        }
    }

    /**
     *
     * @return String
     */
    public function LivePostalCode()
    {
        $postalCode = "";
        $order = $this->Order();
        if ($order) {
            $shippingAddress = $order->CreateOrReturnExistingAddress("ShippingAddress");
            $postalCode = $shippingAddress->ShippingPostalCode;
            if (!$postalCode) {
                $billingAddress = $order->CreateOrReturnExistingAddress("BillingAddress");
                $postalCode = $billingAddress->PostalCode;
            }
        }
        if (intval($postalCode) > 0) {
            return $postalCode;
        }
        return "";
    }


    /**
     *
     * @array
     */
    private function SelectedProductsArray()

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

    {
        $ecommerceConfig = EcommerceDBConfig::current_ecommerce_db_config();
        return $ecommerceConfig->DeliverySpecialChargedProducts()->map("ID", "ID")->toArray();
    }

    /**
     *
     * @return EcommerceCustomDeliveryPostalCode | null
     */
    private function MyPostalCodeObject()
    {
        $ecommerceConfig = EcommerceDBConfig::current_ecommerce_db_config();
        $postalCode = intval($this->LivePostalCode());
        if ($postalCode) {
            return $ecommerceConfig->SpecialPricePostalCodes()
                ->where(
                    "$postalCode >= \"PostalCodeLowestNumber\" AND $postalCode <= \"PostalCodeHighestNumber\" "
                )->First();
        }
        return null;
    }
}