ZonedShippingMethod

Complexity

Total Complexity

9

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	calculateRate()	0	54	6
B	getCMSFields()	0	25	2
A	requiresAddress()	0	4	1

<?php
/**
 * Zoned shipping is a variant of TableShipping that regionalises using zones,
 * which are collections of regions, rather than regionalising using specific
 * locations / wildcards.
 *
 * @package silvershop-shipping
 */
class ZonedShippingMethod extends ShippingMethod
{
    private static $defaults = array(

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

        'Name' => 'Zoned Shipping',
        'Description' => 'Works out shipping from a pre-defined zone rates'
    );

    private static $has_many = array(

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

        "Rates" => "ZonedShippingRate"
    );

    public function calculateRate(ShippingPackage $package, Address $address)
    {
        $rate = null;
        $ids = Zone::get_zones_for_address($address);
        if (!$ids->exists()) {
            return $rate;
        }
        $ids = $ids->map('ID', 'ID')->toArray();
        $packageconstraints = array(
            "Weight" => 'weight',
            "Volume" => 'volume',
            "Value" => 'value',
            "Quantity" => 'quantity'
        );
        $constraintfilters = array();
        $emptyconstraint = array();
        foreach ($packageconstraints as $db => $pakval) {
            $mincol = "\"ZonedShippingRate\".\"{$db}Min\"";
            $maxcol = "\"ZonedShippingRate\".\"{$db}Max\"";
            $constraintfilters[] = "(".
                "$mincol >= 0" .
                " AND $mincol <= " . $package->{$pakval}() .
                " AND $maxcol > 0". //ignore constraints with maxvalue = 0
                " AND $maxcol >= " . $package->{$pakval}() .
                " AND $mincol < $maxcol" . //sanity check
            ")";
            //also include a special case where all constraints are empty
            $emptyconstraint[] = "($mincol = 0 AND $maxcol = 0)";
        }
        $constraintfilters[] = "(".implode(" AND ", $emptyconstraint).")";

        $filter = "(".implode(") AND (", array(
            "\"ZonedShippingMethodID\" = ".$this->ID,
            "\"ZoneID\" IN(".implode(",", $ids).")", //zone restriction
            implode(" OR ", $constraintfilters) //metrics restriction
        )).")";
        //order by zone specificity
        $orderby = "";
        if (count($ids) > 1) {
            $orderby = "CASE \"ZonedShippingRate\".\"ZoneID\"";
            $count = 1;
            foreach ($ids as $id) {
                $orderby .= " WHEN $id THEN $count ";
                $count ++;
            }
            $orderby .= "ELSE $count END ASC,";
        }
        $orderby .= "\"ZonedShippingRate\".\"Rate\" ASC";
        if ($sr = DataObject::get_one("ZonedShippingRate", $filter, true, $orderby)) {
            $rate = $sr->Rate;
        }
        $this->CalculatedRate = $rate;

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

        return $rate;
    }

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

        $displayFieldsList = array(
            "ZoneID" =>  "Zone",
            "WeightMin" => "WeightMin",
            "WeightMax" => "WeightMax",
            "VolumeMin" => "VolumeMin",
            "VolumeMax" => "VolumeMax",
            "ValueMin" => "ValueMin",
            "ValueMax" => "ValueMax",
            "QuantityMin" => "QuantityMin",
            "QuantityMax" => "QuantityMax",
            "Rate" => "Rate"
        );

        $fields->fieldByName('Root')->removeByName("Rates");
        if ($this->isInDB()) {
            $gridField = new GridField("Rates", "ZonedShippingRate", $this->Rates(), new GridFieldConfig_RelationEditor());

The method Rates does not exist on object<ZonedShippingMethod>? Since you implemented __call, maybe consider adding a @method annotation.

            $gridField->getConfig()->getComponentByType('GridFieldDataColumns')->setDisplayFields($displayFieldsList);
            $fields->addFieldToTab("Root.Main", $gridField);
        }
        return $fields;
    }

    /**
     * @return bool
     */
    public function requiresAddress()
    {
        return true;
    }
}

class ZonedShippingRate extends DataObject
{
    private static $db = array(

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

        "WeightMin" => "Decimal",
        "WeightMax" => "Decimal",
        "VolumeMin" => "Decimal",
        "VolumeMax" => "Decimal",
        "ValueMin" => "Currency",
        "ValueMax" => "Currency",
        "QuantityMin" => "Int",
        "QuantityMax" => "Int",

        "Rate" => "Currency"
    );

    private static $has_one = array(

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

        'Zone' => 'Zone',
        'ZonedShippingMethod' => 'ZonedShippingMethod'
    );

    private static $summary_fields = array(

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

        'Zone.Name' => 'Zone',
        'WeightMin',
        'WeightMax',
        'VolumeMin',
        'VolumeMax',
        'ValueMin',
        'ValueMax',
        'QuantityMin',
        'QuantityMax',
        'Rate'
    );

    private static $default_sort = "\"Rate\" ASC";

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

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->removeByName('ZonedShippingMethodID');

        return $fields;
    }
}