Address - Code Metrics - Inspection of "Add reverse relation for addresses (Fixes #475)" - silvershop/silvershop-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b5c256...44ef4b )

by Will

created 2016-09-28 07:11 UTC

Address A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	259
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

70.87%

Importance

Changes

Metric	Value
wmc	31
lcom	1
cbo	7
dl	0
loc	259
ccs	90
cts	127
cp	0.7087
rs	9.8
c	0
b	0
f	0

21 Methods

Rating	Name	Size	Complexity
A	getCMSFields()	12	1
B	getFrontEndFields()	26	3
A	getCountryField()	21	2
B	getRequiredFields()	21	6
A	getName()	12	1
A	toString()	15	1
A	getTitle()	4	1
A	forTemplate()	4	1
A	setProvince()	4	1
A	setTerritory()	4	1
A	setIsland()	4	1
A	setPostCode()	4	1
A	setZipCode()	4	1
A	setStreet()	4	1
A	setStreet2()	4	1
A	setAddress2()	4	1
A	setInstitution()	4	1
A	setBusiness()	4	1
A	setOrganisation()	4	1
A	setOrganization()	4	1
A	validate()	12	3

<?php

/**
 * Address model using a generic format for storing international addresses.
 *
 * Typical Address Hierarcy:
 *    Continent
 *    Country
 *    State / Province / Territory (Island?)
 *    District / Suburb / County / City
 *        Code / Zip (may cross over the above)
 *    Street / Road - name + type: eg Gandalf Cresent
 *    (Premises/Building/Unit/Suite)
 *        (Floor/Level/Side/Wing)
 *    Number / Entrance / Room
 *    Person(s), Company, Department
 *
 * Collection of international address formats:
 *
 * @see http://bitboost.com/ref/international-address-formats.html
 *      xAL address standard:
 * @see https://www.oasis-open.org/committees/ciq/ciq.html#6
 *      Universal Postal Union addressing standards:
 * @see http://www.upu.int/nc/en/activities/addressing/standards.html
 */
class Address extends DataObject
{
    private static $db              = array(

        'Country'    => 'ShopCountry',
        //level1: Country = ISO 2-character country code
        'State'      => 'Varchar(100)',
        //level2: Locality, Administrative Area, State, Province, Region, Territory, Island
        'City'       => 'Varchar(100)',
        //level3: Dependent Locality, City, Suburb, County, District
        'PostalCode' => 'Varchar(20)',
        //code: ZipCode, PostCode (could cross above levels within a country)

        'Address'      => 'Varchar(255)',
        //Number + type of thoroughfare/street. P.O. box
        'AddressLine2' => 'Varchar(255)',
        //Premises, Apartment, Building. Suite, Unit, Floor, Level, Side, Wing.

        'Company' => 'Varchar(100)',
        //Business, Organisation, Group, Institution.

        'FirstName' => 'Varchar(100)',
        //Individual, Person, Contact, Attention
        'Surname'   => 'Varchar(100)',
        'Phone'     => 'Varchar(100)',
    );

    private static $has_one         = array(

        'Member' => 'Member',
    );

    private static $has_many = array(

        'ShippingAddressOrders' => 'Order.ShippingAddress',
        'BillingAddressOrders' => 'Order.BillingAddress'
    );

    private static $casting         = array(

        'Country' => 'ShopCountry',
    );

    private static $required_fields = array(
        'Country',
        'State',
        'City',
        'Address',
    );

    private static $summary_fields  = array(

        'toString' => 'Address',
    );

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->addFieldToTab(
            "Root.Main",
            $this->getCountryField(),
            'State'
        );
        $fields->removeByName("MemberID");

        return $fields;
    }

    public function getFrontEndFields($params = null)
    {
        $fields = new FieldList(
            $this->getCountryField(),
            $addressfield = TextField::create('Address', _t('Address.db_Address', 'Address')),
            $address2field =
                TextField::create('AddressLine2', _t('Address.db_AddressLine2', 'Address Line 2 (optional)')),
            $cityfield = TextField::create('City', _t('Address.db_City', 'City')),
            $statefield = TextField::create('State', _t('Address.db_State', 'State')),
            $postcodefield = TextField::create('PostalCode', _t('Address.db_PostalCode', 'Postal Code')),
            $phonefield = TextField::create('Phone', _t('Address.db_Phone', 'Phone Number'))
        );
        if (isset($params['addfielddescriptions']) && !empty($params['addfielddescriptions'])) {
            $addressfield->setDescription(
                _t("Address.AddressHint", "street / thoroughfare number, name, and type or P.O. Box")
            );
            $address2field->setDescription(
                _t("Address.AddressLine2Hint", "premises, building, apartment, unit, floor")
            );
            $cityfield->setDescription(_t("Address.CityHint", "or suburb, county, district"));
            $statefield->setDescription(_t("Address.StateHint", "or province, territory, island"));
        }

        $this->extend('updateFormFields', $fields);
        return $fields;
    }

    public function getCountryField()
    {
        $countries = SiteConfig::current_site_config()->getCountriesList();
        if (count($countries) == 1) {
            //field name is Country_readonly so it's value doesn't get updated
            return ReadonlyField::create(
                "Country_readonly",
                _t('Address.db_Country', 'Country'),
                array_pop($countries)
            );
        }
        $field = DropdownField::create(
            "Country",
            _t('Address.db_Country', 'Country'),
            $countries
        )->setHasEmptyDefault(true);

        $this->extend('updateCountryField', $field);

        return $field;
    }

    /**
     * Get an array of data fields that must be populated for model to be valid.
     * Required fields can be customised via self::$required_fields
     */
    public function getRequiredFields()
    {
        $fields = self::config()->required_fields;
        //hack to allow overriding arrays in ss config
        if (self::$required_fields != $fields) {
            foreach (self::$required_fields as $requirement) {
                if (($key = array_search($requirement, $fields)) !== false) {
                    unset($fields[$key]);
                }
            }
        }
        //set nicer keys for easier processing
        $fields = array_combine($fields, $fields);
        $this->extend('updateRequiredFields', $fields);
        //don't require country if shop config only specifies a single country
        if (isset($fields['Country']) && SiteConfig::current_site_config()->getSingleCountry()) {
            unset($fields['Country']);
        }

        return $fields;
    }

    /**
     * Get full name associated with this Address
     */
    public function getName()
    {
        return implode(
            ' ',
            array_filter(
                array(
                    $this->FirstName,
<?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->Surname,
<?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.");
        }
    }

}
                )
            )
        );
    }

    /**
     * Convert address to a single string.
     */
    public function toString($separator = ", ")
    {
        $fields = array(
            $this->Company,
<?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->getName(),
            $this->Address,
<?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->AddressLine2,
<?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->City,
<?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->State,
<?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->PostalCode,
<?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->Country
<?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->extend('updateToString', $fields);
        return implode($separator, array_filter($fields));
    }

    public function getTitle()
    {
        return $this->toString();
    }

    public function forTemplate()
    {
        return $this->renderWith('Address');
    }

    /**
     * Add alias setters for fields which are synonymous
     */
    public function setProvince($val)
    {
        $this->State = $val;
<?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.");
        }
    }

}
    }

    public function setTerritory($val)
    {
        $this->State = $val;
<?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.");
        }
    }

}
    }

    public function setIsland($val)
    {
        $this->State = $val;
<?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.");
        }
    }

}
    }

    public function setPostCode($val)
    {
        $this->PostalCode = $val;
<?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.");
        }
    }

}
    }

    public function setZipCode($val)
    {
        $this->PostalCode = $val;
<?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.");
        }
    }

}
    }

    public function setStreet($val)
    {
        $this->Address = $val;
<?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.");
        }
    }

}
    }

    public function setStreet2($val)
    {
        $this->AddressLine2 = $val;
<?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.");
        }
    }

}
    }

    public function setAddress2($val)
    {
        $this->AddressLine2 = $val;
<?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.");
        }
    }

}
    }

    public function setInstitution($val)
    {
        $this->Company = $val;
<?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.");
        }
    }

}
    }

    public function setBusiness($val)
    {
        $this->Company = $val;
<?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.");
        }
    }

}
    }

    public function setOrganisation($val)
    {
        $this->Company = $val;
<?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.");
        }
    }

}
    }

    public function setOrganization($val)
    {
        $this->Company = $val;
<?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.");
        }
    }

}
    }

    function validate()

    {
        $result = parent::validate();

        foreach ($this->getRequiredFields() as $requirement) {
            if (empty($this->$requirement)) {
                $result->error("Address Model validate function - missing required field: $requirement");
            }
        }

        return $result;
    }
}


1			<?php
2
3			/**
4			* Address model using a generic format for storing international addresses.
5			*
6			* Typical Address Hierarcy:
7			* Continent
8			* Country
9			* State / Province / Territory (Island?)
10			* District / Suburb / County / City
11			* Code / Zip (may cross over the above)
12			* Street / Road - name + type: eg Gandalf Cresent
13			* (Premises/Building/Unit/Suite)
14			* (Floor/Level/Side/Wing)
15			* Number / Entrance / Room
16			* Person(s), Company, Department
17			*
18			* Collection of international address formats:
19			*
20			* @see http://bitboost.com/ref/international-address-formats.html
21			* xAL address standard:
22			* @see https://www.oasis-open.org/committees/ciq/ciq.html#6
23			* Universal Postal Union addressing standards:
24			* @see http://www.upu.int/nc/en/activities/addressing/standards.html
25			*/
26			class Address extends DataObject
27			{
28			private static $db = array(
			0 ignored issues – show Comprehensibility introduced 2016-02-23 23:20 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...
29			'Country' => 'ShopCountry',
30			//level1: Country = ISO 2-character country code
31			'State' => 'Varchar(100)',
32			//level2: Locality, Administrative Area, State, Province, Region, Territory, Island
33			'City' => 'Varchar(100)',
34			//level3: Dependent Locality, City, Suburb, County, District
35			'PostalCode' => 'Varchar(20)',
36			//code: ZipCode, PostCode (could cross above levels within a country)
37
38			'Address' => 'Varchar(255)',
39			//Number + type of thoroughfare/street. P.O. box

silvershop / silvershop-core

Push — master ( b5c256...44ef4b )

Address A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

21 Methods

Duplication Side-by-Side

Filter issues like