Location

Complexity

Total Complexity

16

Size/Duplication

Total Lines	199
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	16

Test Coverage

Coverage

81.54%

Importance

Changes	25
Bugs	1	Features	5

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getCoords()	0	4	3
A	fieldLabels()	0	17	1
B	getCMSFields()	0	31	1
A	validate()	0	6	1
A	EmailAddress()	0	11	3
A	getCustomSearchContext()	0	21	1
A	canView()	0	4	1
A	canEdit()	0	4	1
A	canDelete()	0	4	1
A	canCreate()	0	4	1
A	providePermissions()	0	8	1

<?php

class Location extends DataObject implements PermissionProvider
{
    private static $db = array(

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

        'Title' => 'Varchar(255)',
        'Featured' => 'Boolean',
        'Website' => 'Varchar(255)',
        'Phone' => 'Varchar(40)',
        'Email' => 'Varchar(255)',
        'EmailAddress' => 'Varchar(255)',
        'ShowInLocator' => 'Boolean',
    );

    private static $has_one = array(

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

        'Category' => 'LocationCategory',
    );

    private static $casting = array(

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

        'distance' => 'Int',
    );

    private static $default_sort = 'Title';

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

    private static $defaults = array(

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

        'ShowInLocator' => true,
    );

    private static $singular_name = 'Location';

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

    private static $plural_name = 'Locations';

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

    // api access via Restful Server module
    private static $api_access = true;

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

    // search fields for Model Admin
    private static $searchable_fields = array(

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

        'Title',
        'Address',
        'Suburb',
        'State',
        'Postcode',
        'Country',
        'Website',
        'Phone',
        'Email',
        'Category.ID',
        'ShowInLocator',
        'Featured',
    );

    // columns for grid field
    private static $summary_fields = array(

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

        'Title',
        'Address',
        'Suburb',
        'State',
        'Postcode',
        'Country',
        'Category.Name',
        'ShowInLocator.NiceAsBoolean',
        'Featured.NiceAsBoolean',
        'Coords',
    );

    // Coords status for $summary_fields
    public function getCoords()
    {
        return ($this->Lat != 0 && $this->Lng != 0) ? 'true' : 'false';

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

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

    }

    // custom labels for fields
    public function fieldLabels($includerelations = true)
    {
        $labels = parent::fieldLabels();

        $labels['Title'] = 'Name';
        $labels['Suburb'] = 'City';
        $labels['Postcode'] = 'Postal Code';
        $labels['ShowInLocator'] = 'Show';
        $labels['ShowInLocator.NiceAsBoolean'] = 'Show';
        $labels['Category.Name'] = 'Category';
        $labels['Category.ID'] = 'Category';
        $labels['Email'] = 'Email';
        $labels['Featured.NiceAsBoolean'] = 'Featured';
        $labels['Coords'] = 'Coords';

        return $labels;
    }

    public function getCMSFields()

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

    {
        $fields = FieldList::create(
            new TabSet(
                $name = 'Root',
                new Tab(
                    $title = 'Main',
                    HeaderField::create('ContactHD', 'Contact Information'),
                    TextField::create('Title', 'Name'),
                    TextField::create('Phone'),
                    EmailField::create('Email', 'Email'),
                    TextField::create('Website')
                        ->setAttribute('placeholder', 'http://'),
                    DropDownField::create('CategoryID', 'Category', LocationCategory::get()->map('ID', 'Title'))
                        ->setEmptyString('-- select --'),
                    CheckboxField::create('ShowInLocator', 'Show in results')
                        ->setDescription('Location will be included in results list'),
                    CheckboxField::create('Featured')
                        ->setDescription('Location will show at/near the top of the results list')
                )
            )
        );

        // allow to be extended via DataExtension
        $this->extend('updateCMSFields', $fields);

        // override Suburb field name
        $fields->dataFieldByName('Suburb')->setTitle('City');

        return $fields;
    }

    public function validate()
    {
        $result = parent::validate();

        return $result;
    }

    public function EmailAddress()

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

    {
        Deprecation::notice('3.0', 'Use "$Email" instead.');
        if ($this->Email) {

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

            return $this->Email;

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

        } elseif ($this->EmailAddress) {

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

            return $this->EmailAddress;

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

        }

        return false;
    }

    public function getCustomSearchContext()
    {
        $fields = $this->scaffoldSearchFields(array(
            'restrictFields' => array('Address','Category.ID')
        ));

        $filters = array(
            'Address' => new PartialMatchFilter('Address'),
            'Suburb' => new PartialMatchFilter('Suburb'),
            'State' => new PartialMatchFilter('State'),
            'Postcode' => new PartialMatchFilter('Postcode'),
            'Country' => new PartialMatchFilter('Postcode'),
            'CategoryID' => new ExactMatchFilter('CategoryID'),
        );

        return new SearchContext(
            $this->class,
            $fields,
            $filters
        );
    }

    /**
     * @param Member $member

Should the type for parameter $member not be false|Member?

     *
     * @return bool
     */
    public function canView($member = false)
    {
        return true;
    }

    public function canEdit($member = false)
    {
        return Permission::check('Location_EDIT');
    }

    public function canDelete($member = false)
    {
        return Permission::check('Location_DELETE');
    }

    public function canCreate($member = false)
    {
        return Permission::check('Location_CREATE');
    }

    public function providePermissions()
    {
        return array(
            'Location_EDIT' => 'Edit a Location',
            'Location_DELETE' => 'Delete a Location',
            'Location_CREATE' => 'Create a Location',
        );
    }

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