dynamic / silverstripe-locator

code/Location.php

Indentation +169 added lines, -169 removed lines

@@ -2,173 +2,173 @@
 
 class Location extends DataObject implements PermissionProvider
 {
-    private static $db = array(
-        'Title' => 'Varchar(255)',
-        'Featured' => 'Boolean',
-        'Website' => 'Varchar(255)',
-        'Phone' => 'Varchar(40)',
-        'Email' => 'Varchar(255)',
-        'EmailAddress' => 'Varchar(255)',
-        'ShowInLocator' => 'Boolean',
-    );
-
-    private static $has_one = array(
-        'Category' => 'LocationCategory',
-    );
-
-    private static $casting = array(
-        'distance' => 'Int',
-    );
-
-    private static $default_sort = 'Title';
-
-    private static $defaults = array(
-        'ShowInLocator' => true,
-    );
-
-    private static $singular_name = 'Location';
-    private static $plural_name = 'Locations';
-
-    // api access via Restful Server module
-    private static $api_access = true;
-
-    // search fields for Model Admin
-    private static $searchable_fields = array(
-        'Title',
-        'Address',
-        'Suburb',
-        'State',
-        'Postcode',
-        'Country',
-        'Website',
-        'Phone',
-        'Email',
-        'Category.ID',
-        'ShowInLocator',
-        'Featured',
-    );
-
-    // columns for grid field
-    private static $summary_fields = array(
-        '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';
-    }
-
-    // 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()
-    {
-        $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()
-    {
-        Deprecation::notice('3.0', 'Use "$Email" instead.');
-        if ($this->Email) {
-            return $this->Email;
-        } elseif ($this->EmailAddress) {
-            return $this->EmailAddress;
-        }
-
-        return false;
-    }
-
-    /**
-     * @param Member $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',
-        );
-    }
+	private static $db = array(
+		'Title' => 'Varchar(255)',
+		'Featured' => 'Boolean',
+		'Website' => 'Varchar(255)',
+		'Phone' => 'Varchar(40)',
+		'Email' => 'Varchar(255)',
+		'EmailAddress' => 'Varchar(255)',
+		'ShowInLocator' => 'Boolean',
+	);
+
+	private static $has_one = array(
+		'Category' => 'LocationCategory',
+	);
+
+	private static $casting = array(
+		'distance' => 'Int',
+	);
+
+	private static $default_sort = 'Title';
+
+	private static $defaults = array(
+		'ShowInLocator' => true,
+	);
+
+	private static $singular_name = 'Location';
+	private static $plural_name = 'Locations';
+
+	// api access via Restful Server module
+	private static $api_access = true;
+
+	// search fields for Model Admin
+	private static $searchable_fields = array(
+		'Title',
+		'Address',
+		'Suburb',
+		'State',
+		'Postcode',
+		'Country',
+		'Website',
+		'Phone',
+		'Email',
+		'Category.ID',
+		'ShowInLocator',
+		'Featured',
+	);
+
+	// columns for grid field
+	private static $summary_fields = array(
+		'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';
+	}
+
+	// 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()
+	{
+		$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()
+	{
+		Deprecation::notice('3.0', 'Use "$Email" instead.');
+		if ($this->Email) {
+			return $this->Email;
+		} elseif ($this->EmailAddress) {
+			return $this->EmailAddress;
+		}
+
+		return false;
+	}
+
+	/**
+	 * @param Member $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',
+		);
+	}
 }

tests/LocatorTest.php

Indentation +70 added lines, -70 removed lines

@@ -2,88 +2,88 @@
 
 class LocatorTest extends Locator_Test
 {
-    public function testGetCMSFields()
-    {
-        $object = new Locator();
-        $fieldset = $object->getCMSFields();
-        $this->assertTrue(is_a($fieldset, 'FieldList'));
-    }
+	public function testGetCMSFields()
+	{
+		$object = new Locator();
+		$fieldset = $object->getCMSFields();
+		$this->assertTrue(is_a($fieldset, 'FieldList'));
+	}
 
-    public function testLocations()
-    {
-        $filter = array('ShowInLocator' => 1);
-        $filterAny = array('Suburb' => 'Sheboygan');
-        $exclude = array('Suburb' => 'Milwaukee');
-        $locations = Locator::locations($filter, $filterAny, $exclude);
-        $locations2 = Location::get()->filter($filter)->filterAny($filterAny)->exclude($exclude);
-        $this->assertEquals($locations->Count(), $locations2->Count());
-    }
+	public function testLocations()
+	{
+		$filter = array('ShowInLocator' => 1);
+		$filterAny = array('Suburb' => 'Sheboygan');
+		$exclude = array('Suburb' => 'Milwaukee');
+		$locations = Locator::locations($filter, $filterAny, $exclude);
+		$locations2 = Location::get()->filter($filter)->filterAny($filterAny)->exclude($exclude);
+		$this->assertEquals($locations->Count(), $locations2->Count());
+	}
 
-    public function testGetAllCategories()
-    {
-        $locator = singleton('Locator');
-        $count = LocationCategory::get();
-        $this->assertEquals($locator->getAllCategories(), $count);
-    }
+	public function testGetAllCategories()
+	{
+		$locator = singleton('Locator');
+		$count = LocationCategory::get();
+		$this->assertEquals($locator->getAllCategories(), $count);
+	}
 
-    public function testGetPageCategories()
-    {
-        $locator = Locator::create();
-        $this->assertFalse($locator->getPageCategories());
+	public function testGetPageCategories()
+	{
+		$locator = Locator::create();
+		$this->assertFalse($locator->getPageCategories());
 
-        $this->assertFalse($locator->getPageCategories(500));
+		$this->assertFalse($locator->getPageCategories(500));
 
-        $locator->write();
-        $category = $this->objFromFixture('LocationCategory', 'service');
-        $locator->Categories()->add($category);
-        $this->assertEquals($locator->getPageCategories($locator->ID), $locator->Categories());
-    }
+		$locator->write();
+		$category = $this->objFromFixture('LocationCategory', 'service');
+		$locator->Categories()->add($category);
+		$this->assertEquals($locator->getPageCategories($locator->ID), $locator->Categories());
+	}
 
-    public function testInit()
-    {
-    }
+	public function testInit()
+	{
+	}
 
-    public function testIndex()
-    {
-        $locator = $this->objFromFixture('Locator', 'locator1');
-        $controller = Locator_Controller::create($locator);
-        $this->assertInstanceOf('ViewableData', $controller->index($controller->request));
-    }
+	public function testIndex()
+	{
+		$locator = $this->objFromFixture('Locator', 'locator1');
+		$controller = Locator_Controller::create($locator);
+		$this->assertInstanceOf('ViewableData', $controller->index($controller->request));
+	}
 
-    public function testXml()
-    {
-        $locator = $this->objFromFixture('Locator', 'locator1');
-        $controller = Locator_Controller::create($locator);
-        $this->assertInstanceOf('HTMLText', $controller->xml($controller->request));
-    }
+	public function testXml()
+	{
+		$locator = $this->objFromFixture('Locator', 'locator1');
+		$controller = Locator_Controller::create($locator);
+		$this->assertInstanceOf('HTMLText', $controller->xml($controller->request));
+	}
 
-    public function testItems()
-    {
-        $locator = $this->objFromFixture('Locator', 'locator1');
-        $controller = Locator_Controller::create($locator);
+	public function testItems()
+	{
+		$locator = $this->objFromFixture('Locator', 'locator1');
+		$controller = Locator_Controller::create($locator);
 
-        $filter = array('ShowInLocator' => 1);
-        $exclude = ['Lat' => 0.00000, 'Lng' => 0.00000];
+		$filter = array('ShowInLocator' => 1);
+		$exclude = ['Lat' => 0.00000, 'Lng' => 0.00000];
 
-        $locations = $controller->Items($controller->request);
-        $locations2 = Location::get()->filter($filter)->exclude($exclude);
-        $this->assertEquals($locations->count(), $locations2->count());
-    }
+		$locations = $controller->Items($controller->request);
+		$locations2 = Location::get()->filter($filter)->exclude($exclude);
+		$this->assertEquals($locations->count(), $locations2->count());
+	}
 
-    public function testLocationSearch()
-    {
-        $locator = $this->objFromFixture('Locator', 'locator1');
-        $object = Locator_Controller::create($locator);
-        $form = $object->LocationSearch();
-        $this->assertTrue(is_a($form, 'Form'));
+	public function testLocationSearch()
+	{
+		$locator = $this->objFromFixture('Locator', 'locator1');
+		$object = Locator_Controller::create($locator);
+		$form = $object->LocationSearch();
+		$this->assertTrue(is_a($form, 'Form'));
 
-        $category = $this->objFromFixture('LocationCategory', 'service');
-        $category2 = $this->objFromFixture('LocationCategory', 'manufacturing');
-        $locator->Categories()->add($category);
-        $locator->Categories()->add($category2);
+		$category = $this->objFromFixture('LocationCategory', 'service');
+		$category2 = $this->objFromFixture('LocationCategory', 'manufacturing');
+		$locator->Categories()->add($category);
+		$locator->Categories()->add($category2);
 
-        $form = $object->LocationSearch();
-        $fields = $form->Fields();
-        $this->assertNotNull($fields->fieldByName('CategoryID'));
-    }
+		$form = $object->LocationSearch();
+		$fields = $form->Fields();
+		$this->assertNotNull($fields->fieldByName('CategoryID'));
+	}
 }

tests/LocationTest.php

Indentation +104 added lines, -104 removed lines

@@ -2,119 +2,119 @@
 
 class LocationTest extends Locator_Test
 {
-    public function testGetCoords()
-    {
-        $location = $this->objFromFixture('Location', 'dynamic');
+	public function testGetCoords()
+	{
+		$location = $this->objFromFixture('Location', 'dynamic');
 
-        $coords = ((int)$location->Lat != 0 && (int)$location->Lng != 0) ? 'true' : 'false';
+		$coords = ((int)$location->Lat != 0 && (int)$location->Lng != 0) ? 'true' : 'false';
 
-        $this->assertEquals($coords, $location->getCoords());
-    }
+		$this->assertEquals($coords, $location->getCoords());
+	}
 
-    public function testFieldLabels()
-    {
-        $location = $this->objFromFixture('Location', 'dynamic');
-        $labels = $location->FieldLabels();
-        $expected = array(
-            'Title' => 'Name',
-            'Featured' => 'Featured',
-            'Website' => 'Website',
-            'Phone' => 'Phone',
-            'Email' => 'Email',
-            'EmailAddress' => 'Email Address',
-            'ShowInLocator' => 'Show',
-            'Address' => 'Address',
-            'Suburb' => 'City',
-            'State' => 'State',
-            'Postcode' => 'Postal Code',
-            'Country' => 'Country',
-            'Lat' => 'Lat',
-            'Lng' => 'Lng',
-            'Category' => 'Category',
-            'ShowInLocator.NiceAsBoolean' => 'Show',
-            'Category.Name' => 'Category',
-            'Category.ID' => 'Category',
-            'Featured.NiceAsBoolean' => 'Featured',
-            'Coords' => 'Coords',
-        );
-        $this->assertEquals($expected, $labels);
-    }
+	public function testFieldLabels()
+	{
+		$location = $this->objFromFixture('Location', 'dynamic');
+		$labels = $location->FieldLabels();
+		$expected = array(
+			'Title' => 'Name',
+			'Featured' => 'Featured',
+			'Website' => 'Website',
+			'Phone' => 'Phone',
+			'Email' => 'Email',
+			'EmailAddress' => 'Email Address',
+			'ShowInLocator' => 'Show',
+			'Address' => 'Address',
+			'Suburb' => 'City',
+			'State' => 'State',
+			'Postcode' => 'Postal Code',
+			'Country' => 'Country',
+			'Lat' => 'Lat',
+			'Lng' => 'Lng',
+			'Category' => 'Category',
+			'ShowInLocator.NiceAsBoolean' => 'Show',
+			'Category.Name' => 'Category',
+			'Category.ID' => 'Category',
+			'Featured.NiceAsBoolean' => 'Featured',
+			'Coords' => 'Coords',
+		);
+		$this->assertEquals($expected, $labels);
+	}
 
-    public function testGetCMSFields()
-    {
-        $object = new Location();
-        $fieldset = $object->getCMSFields();
-        $this->assertTrue(is_a($fieldset, 'FieldList'));
-    }
+	public function testGetCMSFields()
+	{
+		$object = new Location();
+		$fieldset = $object->getCMSFields();
+		$this->assertTrue(is_a($fieldset, 'FieldList'));
+	}
 
-    public function testValidate()
-    {
-    }
+	public function testValidate()
+	{
+	}
 
-    public function testEmailAddress()
-    {
-    }
+	public function testEmailAddress()
+	{
+	}
 
-    public function testCanView()
-    {
-        $object = $this->objFromFixture('Location', 'dynamic');
-        $object->write();
-        $this->logInWithPermission('ADMIN');
-        $this->assertTrue($object->canView());
-        $this->logOut();
-        $nullMember = Member::create();
-        $nullMember->write();
-        $this->assertTrue($object->canView($nullMember));
-        $nullMember->delete();
-    }
+	public function testCanView()
+	{
+		$object = $this->objFromFixture('Location', 'dynamic');
+		$object->write();
+		$this->logInWithPermission('ADMIN');
+		$this->assertTrue($object->canView());
+		$this->logOut();
+		$nullMember = Member::create();
+		$nullMember->write();
+		$this->assertTrue($object->canView($nullMember));
+		$nullMember->delete();
+	}
 
-    public function testCanEdit()
-    {
-        $object = $this->objFromFixture('Location', 'dynamic');
-        $object->write();
-        $objectID = $object->ID;
-        $this->logInWithPermission('Location_EDIT');
-        $originalTitle = $object->Title;
-        $this->assertEquals($originalTitle, 'Dynamic, Inc.');
-        $this->assertTrue($object->canEdit());
-        $object->Title = 'Changed Title';
-        $object->write();
-        $testEdit = Location::get()->byID($objectID);
-        $this->assertEquals($testEdit->Title, 'Changed Title');
-        $this->logOut();
-    }
+	public function testCanEdit()
+	{
+		$object = $this->objFromFixture('Location', 'dynamic');
+		$object->write();
+		$objectID = $object->ID;
+		$this->logInWithPermission('Location_EDIT');
+		$originalTitle = $object->Title;
+		$this->assertEquals($originalTitle, 'Dynamic, Inc.');
+		$this->assertTrue($object->canEdit());
+		$object->Title = 'Changed Title';
+		$object->write();
+		$testEdit = Location::get()->byID($objectID);
+		$this->assertEquals($testEdit->Title, 'Changed Title');
+		$this->logOut();
+	}
 
-    public function testCanDelete()
-    {
-        $object = $this->objFromFixture('Location', 'dynamic');
-        $object->write();
-        $this->logInWithPermission('Location_DELETE');
-        $this->assertTrue($object->canDelete());
-        $checkObject = $object;
-        $object->delete();
-        $this->assertEquals($checkObject->ID, 0);
-    }
+	public function testCanDelete()
+	{
+		$object = $this->objFromFixture('Location', 'dynamic');
+		$object->write();
+		$this->logInWithPermission('Location_DELETE');
+		$this->assertTrue($object->canDelete());
+		$checkObject = $object;
+		$object->delete();
+		$this->assertEquals($checkObject->ID, 0);
+	}
 
-    public function testCanCreate()
-    {
-        $object = singleton('Location');
-        $this->logInWithPermission('Location_CREATE');
-        $this->assertTrue($object->canCreate());
-        $this->logOut();
-        $nullMember = Member::create();
-        $nullMember->write();
-        $this->assertFalse($object->canCreate($nullMember));
-        $nullMember->delete();
-    }
+	public function testCanCreate()
+	{
+		$object = singleton('Location');
+		$this->logInWithPermission('Location_CREATE');
+		$this->assertTrue($object->canCreate());
+		$this->logOut();
+		$nullMember = Member::create();
+		$nullMember->write();
+		$this->assertFalse($object->canCreate($nullMember));
+		$nullMember->delete();
+	}
 
-    public function testProvidePermissions()
-    {
-        $object = Location::create();
-        $expected = array(
-            'Location_EDIT' => 'Edit a Location',
-            'Location_DELETE' => 'Delete a Location',
-            'Location_CREATE' => 'Create a Location',
-        );
-        $this->assertEquals($expected, $object->providePermissions());
-    }
+	public function testProvidePermissions()
+	{
+		$object = Location::create();
+		$expected = array(
+			'Location_EDIT' => 'Edit a Location',
+			'Location_DELETE' => 'Delete a Location',
+			'Location_CREATE' => 'Create a Location',
+		);
+		$this->assertEquals($expected, $object->providePermissions());
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -6,7 +6,7 @@
     {
         $location = $this->objFromFixture('Location', 'dynamic');
 
-        $coords = ((int)$location->Lat != 0 && (int)$location->Lng != 0) ? 'true' : 'false';
+        $coords = ((int) $location->Lat != 0 && (int) $location->Lng != 0) ? 'true' : 'false';
 
         $this->assertEquals($coords, $location->getCoords());
     }

code/Locator.php

Indentation +324 added lines, -324 removed lines

@@ -2,208 +2,208 @@ 
 
 class Locator extends Page
 {
-    private static $db = array(
-        'AutoGeocode' => 'Boolean',
-        'ModalWindow' => 'Boolean',
-        'Unit' => 'Enum("m,km","m")',
-    );
-
-    private static $many_many = array(
-        'Categories' => 'LocationCategory',
-    );
-
-    private static $defaults = array(
-        'AutoGeocode' => true,
-    );
-
-    private static $singular_name = 'Locator';
-    private static $plural_name = 'Locators';
-    private static $description = 'Find locations on a map';
-
-    /**
-     * @return FieldList
-     */
-    public function getCMSFields()
-    {
-        $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;
-    }
-
-    /**
-     * @param array $filter
-     * @param array $filterAny
-     * @param array $exclude
-     * @param null $filterByCallback
-     * @return ArrayList
-     */
-    public static function locations(
-        $filter = array(),
-        $filterAny = array(),
-        $exclude = array(),
-        $filterByCallback = null
-    )
-    {
-        $locationsList = ArrayList::create();
-
-        // filter by ShowInLocator
-        $filter['ShowInLocator'] = 1;
-
-        $locations = Location::get()->filter($filter);
-
-        if (!empty($filterAny)) {
-            $locations = $locations->filterAny($filterAny);
-        }
-        if (!empty($exclude)) {
-            $locations = $locations->exclude($exclude);
-        }
-
-        if ($filterByCallback !== null && is_callable($filterByCallback)) {
-            $locations = $locations->filterByCallback($filterByCallback);
-        }
-
-        if ($locations->exists()) {
-            $locationsList->merge($locations);
-        }
-
-        return $locationsList;
-    }
-
-    /**
-     * @return DataList
-     */
-    public static function getAllCategories()
-    {
-        return LocationCategory::get();
-    }
-
-    /**
-     * @param null $id
-     * @return bool
-     */
-    public static function getPageCategories($id = null)
-    {
-        if ($id) {
-            if ($locator = self::get()->byID($id)) {
-                return $locator->Categories();
-            }
-
-            return false;
-        }
-
-        return false;
-    }
+	private static $db = array(
+		'AutoGeocode' => 'Boolean',
+		'ModalWindow' => 'Boolean',
+		'Unit' => 'Enum("m,km","m")',
+	);
+
+	private static $many_many = array(
+		'Categories' => 'LocationCategory',
+	);
+
+	private static $defaults = array(
+		'AutoGeocode' => true,
+	);
+
+	private static $singular_name = 'Locator';
+	private static $plural_name = 'Locators';
+	private static $description = 'Find locations on a map';
+
+	/**
+	 * @return FieldList
+	 */
+	public function getCMSFields()
+	{
+		$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;
+	}
+
+	/**
+	 * @param array $filter
+	 * @param array $filterAny
+	 * @param array $exclude
+	 * @param null $filterByCallback
+	 * @return ArrayList
+	 */
+	public static function locations(
+		$filter = array(),
+		$filterAny = array(),
+		$exclude = array(),
+		$filterByCallback = null
+	)
+	{
+		$locationsList = ArrayList::create();
+
+		// filter by ShowInLocator
+		$filter['ShowInLocator'] = 1;
+
+		$locations = Location::get()->filter($filter);
+
+		if (!empty($filterAny)) {
+			$locations = $locations->filterAny($filterAny);
+		}
+		if (!empty($exclude)) {
+			$locations = $locations->exclude($exclude);
+		}
+
+		if ($filterByCallback !== null && is_callable($filterByCallback)) {
+			$locations = $locations->filterByCallback($filterByCallback);
+		}
+
+		if ($locations->exists()) {
+			$locationsList->merge($locations);
+		}
+
+		return $locationsList;
+	}
+
+	/**
+	 * @return DataList
+	 */
+	public static function getAllCategories()
+	{
+		return LocationCategory::get();
+	}
+
+	/**
+	 * @param null $id
+	 * @return bool
+	 */
+	public static function getPageCategories($id = null)
+	{
+		if ($id) {
+			if ($locator = self::get()->byID($id)) {
+				return $locator->Categories();
+			}
+
+			return false;
+		}
+
+		return false;
+	}
 
 
 }
 
 class Locator_Controller extends Page_Controller
 {
-    /**
-     * @var array
-     */
-    private static $allowed_actions = array(
-        'xml',
-    );
-
-    /**
-     * Set Requirements based on input from CMS
-     */
-    public function init()
-    {
-        parent::init();
-
-        $themeDir = SSViewer::get_theme_folder();
-
-        // google maps api key
-        $key = Config::inst()->get('GoogleGeocoding', 'google_api_key');
-
-        $locations = $this->Items($this->request);
-
-        Requirements::javascript('framework/thirdparty/jquery/jquery.js');
-        if ($locations) {
-            Requirements::javascript('http://maps.google.com/maps/api/js?key=' . $key);
-            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');
-
-        $featuredInList = ($locations->filter('Featured', true)->count() > 0);
-
-        $featured = $featuredInList
-            ? 'featuredLocations: true'
-            : 'featuredLocations: false';
-
-        // map config based on user input in Settings tab
-        // AutoGeocode or Full Map
-        if ($this->data()->AutoGeocode) {
-            $load = $featuredInList
-                ? 'autoGeocode: false, fullMapStart: true, storeLimit: 1000, maxDistance: true,'
-                : 'autoGeocode: true, fullMapStart: false,';
-        } else {
-            $load = 'autoGeocode: false, fullMapStart: true, storeLimit: 1000, maxDistance: true,';
-        }
-
-        /*$load = ($this->data()->AutoGeocode) ?
+	/**
+	 * @var array
+	 */
+	private static $allowed_actions = array(
+		'xml',
+	);
+
+	/**
+	 * Set Requirements based on input from CMS
+	 */
+	public function init()
+	{
+		parent::init();
+
+		$themeDir = SSViewer::get_theme_folder();
+
+		// google maps api key
+		$key = Config::inst()->get('GoogleGeocoding', 'google_api_key');
+
+		$locations = $this->Items($this->request);
+
+		Requirements::javascript('framework/thirdparty/jquery/jquery.js');
+		if ($locations) {
+			Requirements::javascript('http://maps.google.com/maps/api/js?key=' . $key);
+			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');
+
+		$featuredInList = ($locations->filter('Featured', true)->count() > 0);
+
+		$featured = $featuredInList
+			? 'featuredLocations: true'
+			: 'featuredLocations: false';
+
+		// map config based on user input in Settings tab
+		// AutoGeocode or Full Map
+		if ($this->data()->AutoGeocode) {
+			$load = $featuredInList
+				? 'autoGeocode: false, fullMapStart: true, storeLimit: 1000, maxDistance: true,'
+				: 'autoGeocode: true, fullMapStart: false,';
+		} else {
+			$load = 'autoGeocode: false, fullMapStart: true, storeLimit: 1000, maxDistance: true,';
+		}
+
+		/*$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"';
-
-        // pass GET variables to xml action
-        $vars = $this->request->getVars();
-        unset($vars['url']);
-        unset($vars['action_index']);
-        $url = '';
-        if (count($vars)) {
-            $url .= '?' . http_build_query($vars);
-        }
-        $link = $this->Link() . 'xml.xml' . $url;
-
-        // init map
-        if ($locations) {
-            Requirements::customScript("
+		$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"';
+
+		// pass GET variables to xml action
+		$vars = $this->request->getVars();
+		unset($vars['url']);
+		unset($vars['action_index']);
+		$url = '';
+		if (count($vars)) {
+			$url .= '?' . http_build_query($vars);
+		}
+		$link = $this->Link() . 'xml.xml' . $url;
+
+		// init map
+		if ($locations) {
+			Requirements::customScript("
                 $(function($) {
                     $('#map-container').storeLocator({
                         " . $load . "
@@ -224,135 +224,135 @@ 
                     });
                 });
             ');
-        }
-    }
-
-    /**
-     * @param SS_HTTPRequest $request
-     *
-     * @return ViewableData_Customised
-     */
-    public function index(SS_HTTPRequest $request)
-    {
-        $locations = $this->Items($request);
-
-        return $this->customise(array(
-            'Locations' => $locations,
-        ));
-    }
-
-    /**
-     * Return a XML feed of all locations marked "show in locator"
-     *
-     * @param SS_HTTPRequest $request
-     * @return HTMLText
-     */
-    public function xml(SS_HTTPRequest $request)
-    {
-        $locations = $this->Items($request);
-
-        return $this->customise(array(
-            'Locations' => $locations,
-        ))->renderWith('LocationXML');
-    }
-
-    /**
-     * @param SS_HTTPRequest $request
-     *
-     * @return ArrayList
-     */
-    public function Items(SS_HTTPRequest $request)
-    {
-        $request = ($request) ? $request : $this->request;
-
-        $filter = array();
-        $filterAny = array();
-        $exclude = ['Lat' => 0.00000, 'Lng' => 0.00000];
-
-        // only show locations marked as ShowInLocator
-        $filter['ShowInLocator'] = 1;
-
-        // search across all address related fields
-        $address = ($request->getVar('Address')) ? $request->getVar('Address') : false;
-        if ($address && $this->data()->AutoGeocode == 0) {
-            $filterAny['Address:PartialMatch'] = $address;
-            $filterAny['Suburb:PartialMatch'] = $address;
-            $filterAny['State:PartialMatch'] = $address;
-            $filterAny['Postcode:PartialMatch'] = $address;
-            $filterAny['Country:PartialMatch'] = $address;
-        } else {
-            unset($filter['Address']);
-        }
-
-        // search for category from form, else categories from Locator
-        $category = ($request->getVar('CategoryID')) ? $request->getVar('CategoryID') : false;
-        if ($category) {
-            $filter['CategoryID:ExactMatch'] = $category;
-        } elseif ($this->Categories()->exists()) {
-            $categories = $this->Categories();
-            $categoryArray = array();
-            foreach ($categories as $category) {
-                array_push($categoryArray, $category->ID);
-            }
-            $filter['CategoryID'] = $categoryArray;
-        }
-
-        $locations = Locator::locations($filter, $filterAny, $exclude);
-
-        return $locations;
-    }
-
-    /**
-     * 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', '')
-                ->setAttribute('placeholder', 'address or zip code')
-        );
-
-        $filterCategories = Locator::getPageCategories($this->ID);
-        $allCategories = Locator::getAllCategories();
-
-        if ($allCategories->Count() > 0) {
-            $categories = ArrayList::create();
-            if ($filterCategories->Count() > 0) {
-                if ($filterCategories->Count() != 1) {
-                    $categories = $filterCategories;
-                }
-            } else {
-                $categories = $allCategories;
-            }
-
-            if ($categories->count() > 0) {
-                $fields->push(
-                    DropdownField::create(
-                        'CategoryID',
-                        '',
-                        $categories->map()
-                    )->setEmptyString('All Categories'));
-            }
-        }
-
-        $actions = FieldList::create(
-            FormAction::create('index', 'Search')
-        );
-
-        if (class_exists('BootstrapForm')) {
-            $form = BootstrapForm::create($this, 'LocationSearch', $fields, $actions);
-        } else {
-            $form = Form::create($this, 'LocationSearch', $fields, $actions);
-        }
-
-        return $form
-            ->setFormMethod('GET')
-            ->setFormAction($this->Link())
-            ->disableSecurityToken()
-            ->loadDataFrom($this->request->getVars());
-    }
+		}
+	}
+
+	/**
+	 * @param SS_HTTPRequest $request
+	 *
+	 * @return ViewableData_Customised
+	 */
+	public function index(SS_HTTPRequest $request)
+	{
+		$locations = $this->Items($request);
+
+		return $this->customise(array(
+			'Locations' => $locations,
+		));
+	}
+
+	/**
+	 * Return a XML feed of all locations marked "show in locator"
+	 *
+	 * @param SS_HTTPRequest $request
+	 * @return HTMLText
+	 */
+	public function xml(SS_HTTPRequest $request)
+	{
+		$locations = $this->Items($request);
+
+		return $this->customise(array(
+			'Locations' => $locations,
+		))->renderWith('LocationXML');
+	}
+
+	/**
+	 * @param SS_HTTPRequest $request
+	 *
+	 * @return ArrayList
+	 */
+	public function Items(SS_HTTPRequest $request)
+	{
+		$request = ($request) ? $request : $this->request;
+
+		$filter = array();
+		$filterAny = array();
+		$exclude = ['Lat' => 0.00000, 'Lng' => 0.00000];
+
+		// only show locations marked as ShowInLocator
+		$filter['ShowInLocator'] = 1;
+
+		// search across all address related fields
+		$address = ($request->getVar('Address')) ? $request->getVar('Address') : false;
+		if ($address && $this->data()->AutoGeocode == 0) {
+			$filterAny['Address:PartialMatch'] = $address;
+			$filterAny['Suburb:PartialMatch'] = $address;
+			$filterAny['State:PartialMatch'] = $address;
+			$filterAny['Postcode:PartialMatch'] = $address;
+			$filterAny['Country:PartialMatch'] = $address;
+		} else {
+			unset($filter['Address']);
+		}
+
+		// search for category from form, else categories from Locator
+		$category = ($request->getVar('CategoryID')) ? $request->getVar('CategoryID') : false;
+		if ($category) {
+			$filter['CategoryID:ExactMatch'] = $category;
+		} elseif ($this->Categories()->exists()) {
+			$categories = $this->Categories();
+			$categoryArray = array();
+			foreach ($categories as $category) {
+				array_push($categoryArray, $category->ID);
+			}
+			$filter['CategoryID'] = $categoryArray;
+		}
+
+		$locations = Locator::locations($filter, $filterAny, $exclude);
+
+		return $locations;
+	}
+
+	/**
+	 * 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', '')
+				->setAttribute('placeholder', 'address or zip code')
+		);
+
+		$filterCategories = Locator::getPageCategories($this->ID);
+		$allCategories = Locator::getAllCategories();
+
+		if ($allCategories->Count() > 0) {
+			$categories = ArrayList::create();
+			if ($filterCategories->Count() > 0) {
+				if ($filterCategories->Count() != 1) {
+					$categories = $filterCategories;
+				}
+			} else {
+				$categories = $allCategories;
+			}
+
+			if ($categories->count() > 0) {
+				$fields->push(
+					DropdownField::create(
+						'CategoryID',
+						'',
+						$categories->map()
+					)->setEmptyString('All Categories'));
+			}
+		}
+
+		$actions = FieldList::create(
+			FormAction::create('index', 'Search')
+		);
+
+		if (class_exists('BootstrapForm')) {
+			$form = BootstrapForm::create($this, 'LocationSearch', $fields, $actions);
+		} else {
+			$form = Form::create($this, 'LocationSearch', $fields, $actions);
+		}
+
+		return $form
+			->setFormMethod('GET')
+			->setFormAction($this->Link())
+			->disableSecurityToken()
+			->loadDataFrom($this->request->getVars());
+	}
 }

Spacing +15 added lines, -17 removed lines

@@ -149,7 +149,7 @@ 
 
         Requirements::javascript('framework/thirdparty/jquery/jquery.js');
         if ($locations) {
-            Requirements::javascript('http://maps.google.com/maps/api/js?key=' . $key);
+            Requirements::javascript('http://maps.google.com/maps/api/js?key='.$key);
             Requirements::javascript('locator/thirdparty/handlebars/handlebars-v1.3.0.js');
             Requirements::javascript('locator/thirdparty/jquery-store-locator/js/jquery.storelocator.js');
         }
@@ -177,14 +177,12 @@ 
             'autoGeocode: false, fullMapStart: true, storeLimit: 1000, maxDistance: true,';*/
 
         $base = Director::baseFolder();
-        $themePath = $base . '/' . $themeDir;
+        $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';
+        $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';
@@ -197,22 +195,22 @@ 
         unset($vars['action_index']);
         $url = '';
         if (count($vars)) {
-            $url .= '?' . http_build_query($vars);
+            $url .= '?'.http_build_query($vars);
         }
-        $link = $this->Link() . 'xml.xml' . $url;
+        $link = $this->Link().'xml.xml'.$url;
 
         // init map
         if ($locations) {
             Requirements::customScript("
                 $(function($) {
                     $('#map-container').storeLocator({
-                        " . $load . "
-                        dataLocation: '" . $link . "',
-                        listTemplatePath: '" . $listTemplatePath . "',
-                        infowindowTemplatePath: '" . $infowindowTemplatePath . "',
+                        " . $load."
+                        dataLocation: '" . $link."',
+                        listTemplatePath: '" . $listTemplatePath."',
+                        infowindowTemplatePath: '" . $infowindowTemplatePath."',
                         originMarker: true,
-                        " . $modal . ',
-                        ' . $featured . ",
+                        " . $modal.',
+                        ' . $featured.",
                         slideMap: false,
                         zoomLevel: 0,
                         noForm: true,
@@ -220,7 +218,7 @@ 
                         inputID: 'Form_LocationSearch_Address',
                         categoryID: 'Form_LocationSearch_category',
                         distanceAlert: -1,
-                        " . $kilometer . '
+                        " . $kilometer.'
                     });
                 });
             ');