Locator

Complexity

Total Complexity

8

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	8

Test Coverage

Coverage

72.21%

Importance

Changes	19
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
B	getCMSFields()	0	33	2
A	getLocations()	0	9	1
A	getAreLocations()	0	4	1
A	getAllCategories()	0	4	1
A	getPageCategories()	0	10	3

<?php

class Locator extends Page
{
    private static $db = array(

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

        'AutoGeocode' => 'Boolean',
        'ModalWindow' => 'Boolean',
        'Unit' => 'Enum("m,km","m")',
    );

    private static $many_many = array(

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

        'Categories' => 'LocationCategory',
    );

    private static $defaults = array(

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

        'AutoGeocode' => true,
    );

    private static $singular_name = 'Locator';

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

    private static $plural_name = 'Locators';

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

    private static $description = 'Find locations on a map';

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

    public function getCMSFields()

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

    {
        $fields = parent::getCMSFields();

        // Settings
        $fields->addFieldsToTab('Root.Settings', array(
            HeaderField::create('DisplayOptions', 'Display Options', 3),
            OptionsetField::create('Unit', 'Unit of measure', array('m' => 'Miles', 'km' => 'Kilometers')),
            CheckboxField::create('AutoGeocode', 'Auto Geocode - Automatically filter map results based on user location')
                ->setDescription('Note: if any locations are set as featured, the auto geocode is automatically disabled.'),
            CheckboxField::create('ModalWindow', 'Modal Window - Show Map results in a modal window'),
        ));

        // Filter categories
        $config = GridFieldConfig_RelationEditor::create();
        if (class_exists('GridFieldAddExistingSearchButton')) {
            $config->removeComponentsByType('GridFieldAddExistingAutocompleter');
            $config->addComponent(new GridFieldAddExistingSearchButton());
        }
        $categories = $this->Categories();
        $categoriesField = GridField::create('Categories', 'Categories', $categories, $config)
            ->setDescription('only show locations from the selected category');

            // Filter
            $fields->addFieldsToTab('Root.Filter', array(
                HeaderField::create('CategoryOptionsHeader', 'Location Filtering', 3),
                $categoriesField,
            ));

        $this->extend('updateCMSFields', $fields);

        return $fields;
    }

    public static function getLocations($filter = array(), $exclude = array(), $filterAny = array())

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

    {
        $filter['ShowInLocator'] = true;
        $exclude['Lat'] = 0;

        $Locations = Location::get()->exclude($exclude)->filter($filter)->filterAny($filterAny);

        return $Locations;
    }

    public function getAreLocations()

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

    {
        return self::getLocations();
    }

    public function getAllCategories()
    {
        return LocationCategory::get();
    }

    public static function getPageCategories($id = null)

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

    {
        if ($id) {
            if ($locator = Locator::get()->byID($id)) {
                return $locator->Categories();
            }
            return false;
        }
        return false;
    }
}

class Locator_Controller extends Page_Controller

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

{
    // allowed actions
    private static $allowed_actions = array('xml');

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

    // Set Requirements based on input from CMS
    public function init()
    {
        parent::init();

        $themeDir = SSViewer::get_theme_folder();

        Requirements::javascript('framework/thirdparty/jquery/jquery.js');
        if (Locator::getLocations()) {
            Requirements::javascript('http://maps.google.com/maps/api/js?sensor=false');
            Requirements::javascript('locator/thirdparty/handlebars/handlebars-v1.3.0.js');
            Requirements::javascript('locator/thirdparty/jquery-store-locator/js/jquery.storelocator.js');
        }

        Requirements::css('locator/css/map.css');

        $featured = (Locator::getLocations(array('Featured' => 1))->count() > 0) ?
            'featuredLocations: true' :
            'featuredLocations: false';

        // map config based on user input in Settings tab
        // AutoGeocode or Full Map
        $load = ($this->data()->AutoGeocode) ?
            'autoGeocode: true, fullMapStart: false,' :
            'autoGeocode: false, fullMapStart: true, storeLimit: 1000, maxDistance: true,';

        $base = Director::baseFolder();
        $themePath = $base.'/'.$themeDir;

        $listTemplatePath = (file_exists($themePath.'/templates/location-list-description.html')) ?
            $themeDir.'/templates/location-list-description.html' :
            'locator/templates/location-list-description.html';
        $infowindowTemplatePath = (file_exists($themePath.'/templates/infowindow-description.html')) ?
            $themeDir.'/templates/infowindow-description.html' :
            'locator/templates/infowindow-description.html';

        // in page or modal
        $modal = ($this->data()->ModalWindow) ? 'modalWindow: true' : 'modalWindow: false';

        $kilometer = ($this->data()->Unit == 'km') ? 'lengthUnit: "km"' : 'lengthUnit: "m"';

        $link = $this->Link().'xml.xml';

        // init map
        if (Locator::getLocations()) {
            Requirements::customScript("
                $(function($) {
                    $('#map-container').storeLocator({
                        ".$load."
                        dataLocation: '".$link."',
                        listTemplatePath: '".$listTemplatePath."',
                        infowindowTemplatePath: '".$infowindowTemplatePath."',
                        originMarker: true,
                        ".$modal.',
                        '.$featured.",
                        slideMap: false,
                        zoomLevel: 0,
                        distanceAlert: 120,
                        formID: 'Form_LocationSearch',
                        inputID: 'Form_LocationSearch_address',
                        categoryID: 'Form_LocationSearch_category',
                        distanceAlert: -1,
                        ".$kilometer.'
                    });
                });
            ');
        }
    }

    /**
     * Find all locations for map.
     *
     * Will return a XML feed of all locations marked "show in locator".
     *
     * @return XML file
     *
     * @todo rename/refactor to allow for json/xml
     * @todo allow $filter to run off of getVars key/val pair
     */
    public function xml(SS_HTTPRequest $request)
    {
        $filter = array();
        $exclude = array();
        $filterAny = array();

        //if a category filter selected
        if ($this->Categories()->exists()) {
            $categories = $this->Categories();
            foreach ($categories as $category) {
                $filterAny['CategoryID'] = $category->ID;
            }
        }

        $Locations = Locator::getLocations($filter, $exclude, $filterAny);

        return $this->customise(array(
            'Locations' => $Locations,
        ))->renderWith('LocationXML');
    }

    /**
     * LocationSearch form.
     *
     * Search form for locations, updates map and results list via AJAX
     *
     * @return Form
     */
    public function LocationSearch()
    {
        $fields = FieldList::create(
            $address = TextField::create('address', '')
        );
        $address->setAttribute('placeholder', 'address or zip code');

        $locatorCategories = Locator::getPageCategories($this->ID);

        if (LocationCategory::get()->Count() > 0 && $locatorCategories && $locatorCategories->Count() != 1) {
            $categories = LocationCategory::get();

            if ($categories->count() > 0) {
                $fields->push(
                    DropdownField::create(
                        'category',
                        '',
                        $categories->map('Title', 'Title')
                    )->setEmptyString('Select Category'));
            }
        }

        $actions = FieldList::create(
            FormAction::create('', 'Search')
        );

        return Form::create($this, 'LocationSearch', $fields, $actions);
    }
}