dynamic / silverstripe-locator

tests/objects/LocationTest.php

Spacing +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
     public function testGetCoords()
     {
         $location = $this->objFromFixture(Location::class, '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());
     }
 

Indentation +202 added lines, -202 removed lines

@@ -18,206 +18,206 @@
  */
 class LocationTest extends SapphireTest
 {
-    /**
-     * @var string
-     */
-    protected static $fixture_file = '../fixtures.yml';
-
-    /**
-     * @var array
-     */
-    protected static $extra_dataobjects = [
-        ExtendedLocation::class,
-    ];
-
-    /**
-     * @var array
-     */
-    protected static $required_extensions = [
-        ExtendedLocation::class => [
-            LocationExtension::class,
-        ],
-    ];
-
-    /**
-     *
-     */
-    public function testGetCoords()
-    {
-        $location = $this->objFromFixture(Location::class, 'dynamic');
-        $coords = ((int)$location->Lat != 0 && (int)$location->Lng != 0) ? 'true' : 'false';
-        $this->assertEquals($coords, $location->getCoords());
-    }
-
-    /**
-     *
-     */
-    public function testFieldLabels()
-    {
-        $this->markTestSkipped();
-        // Link and File tracking display as "Tracking" in SS 4.2 & 4.3, "Tracking" in 4.4
-        $location = $this->objFromFixture(Location::class, 'dynamic');
-        $labels = $location->FieldLabels();
-        $expected = [
-            'Title' => 'Name',
-            'Featured' => 'Featured',
-            'Website' => 'Website',
-            'Phone' => 'Phone',
-            'Email' => 'Email',
-            'Fax' => 'Fax',
-            'Address' => 'Address',
-            'City' => 'City',
-            'State' => 'State',
-            'PostalCode' => 'Postal Code',
-            'Country' => 'Country',
-            'Lat' => 'Lat',
-            'Lng' => 'Lng',
-            'Categories' => 'Categories',
-            'Category.Name' => 'Category',
-            'Category.ID' => 'Category',
-            'Featured.NiceAsBoolean' => 'Featured',
-            'Import_ID' => 'Import_ID',
-            'Version' => 'Version',
-            'Versions' => 'Versions',
-            'Address2' => 'Address2',
-            'LinkTracking' => 'Link tracking',
-            'FileTracking' => 'File tracking',
-        ];
-        $this->assertEquals($expected, $labels);
-    }
-
-    /**
-     *
-     */
-    public function testGetCMSFields()
-    {
-        $object = new Location();
-        $fieldset = $object->getCMSFields();
-        $this->assertinstanceOf(FieldList::class, $fieldset);
-    }
-
-    /**
-     *
-     */
-    public function testCanView()
-    {
-        $object = $this->objFromFixture(Location::class, 'dynamic');
-        $object->write();
-
-        $this->assertTrue($object->canView());
-
-        $nullMember = Member::create();
-        $nullMember->write();
-
-        $this->assertTrue($object->canView($nullMember));
-
-        $nullMember->delete();
-    }
-
-    /**
-     *
-     */
-    public function testCanEdit()
-    {
-        $object = $this->objFromFixture(Location::class, 'dynamic');
-        $object->write();
-
-        $objectID = $object->ID;
-
-        //test permissions per permission setting
-        $create = $this->objFromFixture(Member::class, 'locationcreate');
-        $edit = $this->objFromFixture(Member::class, 'locationedit');
-        $delete = $this->objFromFixture(Member::class, 'locationdelete');
-
-        $originalTitle = $object->Title;
-        $this->assertEquals($originalTitle, 'Dynamic, Inc.');
-
-        $this->assertTrue($object->canEdit($edit));
-        $this->assertFalse($object->canEdit($create));
-        $this->assertFalse($object->canEdit($delete));
-
-        $object->Title = 'Changed Title';
-        $object->write();
-
-        $testEdit = Location::get()->byID($objectID);
-        $this->assertEquals($testEdit->Title, 'Changed Title');
-    }
-
-    /**
-     *
-     */
-    public function testCanDelete()
-    {
-        $object = $this->objFromFixture(Location::class, 'dynamic');
-        $object->write();
-
-        //test permissions per permission setting
-        $create = $this->objFromFixture(Member::class, 'locationcreate');
-        $edit = $this->objFromFixture(Member::class, 'locationedit');
-        $delete = $this->objFromFixture(Member::class, 'locationdelete');
-
-        $this->assertTrue($object->canDelete($delete));
-        $this->assertFalse($object->canDelete($create));
-        $this->assertFalse($object->canDelete($edit));
-
-        $checkObject = $object;
-        $object->delete();
-
-        $this->assertEquals($checkObject->ID, 0);
-    }
-
-    /**
-     *
-     */
-    public function testCanCreate()
-    {
-        $object = singleton(Location::class);
-
-        //test permissions per permission setting
-        $create = $this->objFromFixture(Member::class, 'locationcreate');
-        $edit = $this->objFromFixture(Member::class, 'locationedit');
-        $delete = $this->objFromFixture(Member::class, 'locationdelete');
-
-        $this->assertTrue($object->canCreate($create));
-        $this->assertFalse($object->canCreate($edit));
-        $this->assertFalse($object->canCreate($delete));
-
-        $nullMember = Member::create();
-        $nullMember->write();
-        $this->assertFalse($object->canCreate($nullMember));
-
-        $nullMember->delete();
-    }
-
-    /**
-     *
-     */
-    public function testProvidePermissions()
-    {
-        $object = Location::create();
-        $expected = [
-            'Location_EDIT' => 'Edit a Location',
-            'Location_DELETE' => 'Delete a Location',
-            'Location_CREATE' => 'Create a Location',
-        ];
-        $this->assertEquals($expected, $object->providePermissions());
-    }
-
-    /**
-     *
-     */
-    public function testUpdateWebsiteURL()
-    {
-        $location = $this->objFromFixture(Location::class, 'dynamic');
-
-        // Create unsaved raw duplicate
-        $map = $location->toMap();
-        unset($map['Created']);
-        /** @var static $clone */
-        $clone = Injector::inst()->create(ExtendedLocation::class, $map);
-        $clone->ID = 0;
-
-        $this->assertEquals('http://www.dynamicagency.com', $location->getWebsiteURL());
-        $this->assertEquals('foo', $clone->getWebsiteURL());
-    }
+	/**
+	 * @var string
+	 */
+	protected static $fixture_file = '../fixtures.yml';
+
+	/**
+	 * @var array
+	 */
+	protected static $extra_dataobjects = [
+		ExtendedLocation::class,
+	];
+
+	/**
+	 * @var array
+	 */
+	protected static $required_extensions = [
+		ExtendedLocation::class => [
+			LocationExtension::class,
+		],
+	];
+
+	/**
+	 *
+	 */
+	public function testGetCoords()
+	{
+		$location = $this->objFromFixture(Location::class, 'dynamic');
+		$coords = ((int)$location->Lat != 0 && (int)$location->Lng != 0) ? 'true' : 'false';
+		$this->assertEquals($coords, $location->getCoords());
+	}
+
+	/**
+	 *
+	 */
+	public function testFieldLabels()
+	{
+		$this->markTestSkipped();
+		// Link and File tracking display as "Tracking" in SS 4.2 & 4.3, "Tracking" in 4.4
+		$location = $this->objFromFixture(Location::class, 'dynamic');
+		$labels = $location->FieldLabels();
+		$expected = [
+			'Title' => 'Name',
+			'Featured' => 'Featured',
+			'Website' => 'Website',
+			'Phone' => 'Phone',
+			'Email' => 'Email',
+			'Fax' => 'Fax',
+			'Address' => 'Address',
+			'City' => 'City',
+			'State' => 'State',
+			'PostalCode' => 'Postal Code',
+			'Country' => 'Country',
+			'Lat' => 'Lat',
+			'Lng' => 'Lng',
+			'Categories' => 'Categories',
+			'Category.Name' => 'Category',
+			'Category.ID' => 'Category',
+			'Featured.NiceAsBoolean' => 'Featured',
+			'Import_ID' => 'Import_ID',
+			'Version' => 'Version',
+			'Versions' => 'Versions',
+			'Address2' => 'Address2',
+			'LinkTracking' => 'Link tracking',
+			'FileTracking' => 'File tracking',
+		];
+		$this->assertEquals($expected, $labels);
+	}
+
+	/**
+	 *
+	 */
+	public function testGetCMSFields()
+	{
+		$object = new Location();
+		$fieldset = $object->getCMSFields();
+		$this->assertinstanceOf(FieldList::class, $fieldset);
+	}
+
+	/**
+	 *
+	 */
+	public function testCanView()
+	{
+		$object = $this->objFromFixture(Location::class, 'dynamic');
+		$object->write();
+
+		$this->assertTrue($object->canView());
+
+		$nullMember = Member::create();
+		$nullMember->write();
+
+		$this->assertTrue($object->canView($nullMember));
+
+		$nullMember->delete();
+	}
+
+	/**
+	 *
+	 */
+	public function testCanEdit()
+	{
+		$object = $this->objFromFixture(Location::class, 'dynamic');
+		$object->write();
+
+		$objectID = $object->ID;
+
+		//test permissions per permission setting
+		$create = $this->objFromFixture(Member::class, 'locationcreate');
+		$edit = $this->objFromFixture(Member::class, 'locationedit');
+		$delete = $this->objFromFixture(Member::class, 'locationdelete');
+
+		$originalTitle = $object->Title;
+		$this->assertEquals($originalTitle, 'Dynamic, Inc.');
+
+		$this->assertTrue($object->canEdit($edit));
+		$this->assertFalse($object->canEdit($create));
+		$this->assertFalse($object->canEdit($delete));
+
+		$object->Title = 'Changed Title';
+		$object->write();
+
+		$testEdit = Location::get()->byID($objectID);
+		$this->assertEquals($testEdit->Title, 'Changed Title');
+	}
+
+	/**
+	 *
+	 */
+	public function testCanDelete()
+	{
+		$object = $this->objFromFixture(Location::class, 'dynamic');
+		$object->write();
+
+		//test permissions per permission setting
+		$create = $this->objFromFixture(Member::class, 'locationcreate');
+		$edit = $this->objFromFixture(Member::class, 'locationedit');
+		$delete = $this->objFromFixture(Member::class, 'locationdelete');
+
+		$this->assertTrue($object->canDelete($delete));
+		$this->assertFalse($object->canDelete($create));
+		$this->assertFalse($object->canDelete($edit));
+
+		$checkObject = $object;
+		$object->delete();
+
+		$this->assertEquals($checkObject->ID, 0);
+	}
+
+	/**
+	 *
+	 */
+	public function testCanCreate()
+	{
+		$object = singleton(Location::class);
+
+		//test permissions per permission setting
+		$create = $this->objFromFixture(Member::class, 'locationcreate');
+		$edit = $this->objFromFixture(Member::class, 'locationedit');
+		$delete = $this->objFromFixture(Member::class, 'locationdelete');
+
+		$this->assertTrue($object->canCreate($create));
+		$this->assertFalse($object->canCreate($edit));
+		$this->assertFalse($object->canCreate($delete));
+
+		$nullMember = Member::create();
+		$nullMember->write();
+		$this->assertFalse($object->canCreate($nullMember));
+
+		$nullMember->delete();
+	}
+
+	/**
+	 *
+	 */
+	public function testProvidePermissions()
+	{
+		$object = Location::create();
+		$expected = [
+			'Location_EDIT' => 'Edit a Location',
+			'Location_DELETE' => 'Delete a Location',
+			'Location_CREATE' => 'Create a Location',
+		];
+		$this->assertEquals($expected, $object->providePermissions());
+	}
+
+	/**
+	 *
+	 */
+	public function testUpdateWebsiteURL()
+	{
+		$location = $this->objFromFixture(Location::class, 'dynamic');
+
+		// Create unsaved raw duplicate
+		$map = $location->toMap();
+		unset($map['Created']);
+		/** @var static $clone */
+		$clone = Injector::inst()->create(ExtendedLocation::class, $map);
+		$clone->ID = 0;
+
+		$this->assertEquals('http://www.dynamicagency.com', $location->getWebsiteURL());
+		$this->assertEquals('foo', $clone->getWebsiteURL());
+	}
 }

tests/objects/LocationCategoryTest.php

Indentation +54 added lines, -54 removed lines

@@ -14,69 +14,69 @@
  */
 class LocationCategoryTest extends SapphireTest
 {
-    /**
-     * @var string
-     */
-    protected static $fixture_file = '../fixtures.yml';
+	/**
+	 * @var string
+	 */
+	protected static $fixture_file = '../fixtures.yml';
 
-    /**
-     *
-     */
-    public function testGetCMSFields()
-    {
-        $object = $this->objFromFixture(LocationCategory::class, 'service');
-        $fieldset = $object->getCMSFields();
-        $this->assertInstanceOf(FieldList::class, $fieldset);
-    }
+	/**
+	 *
+	 */
+	public function testGetCMSFields()
+	{
+		$object = $this->objFromFixture(LocationCategory::class, 'service');
+		$fieldset = $object->getCMSFields();
+		$this->assertInstanceOf(FieldList::class, $fieldset);
+	}
 
-    /**
-     *
-     */
-    public function testCanView()
-    {
-        $object = $this->objFromFixture(LocationCategory::class, 'service');
-        $this->assertTrue($object->canView());
-    }
+	/**
+	 *
+	 */
+	public function testCanView()
+	{
+		$object = $this->objFromFixture(LocationCategory::class, 'service');
+		$this->assertTrue($object->canView());
+	}
 
-    /**
-     *
-     */
-    public function testCanEdit()
-    {
-        $object = $this->objFromFixture(LocationCategory::class, 'service');
+	/**
+	 *
+	 */
+	public function testCanEdit()
+	{
+		$object = $this->objFromFixture(LocationCategory::class, 'service');
 
-        $admin = $this->objFromFixture(Member::class, 'locationedit');
-        $this->assertTrue($object->canEdit($admin));
+		$admin = $this->objFromFixture(Member::class, 'locationedit');
+		$this->assertTrue($object->canEdit($admin));
 
-        $member = $this->objFromFixture(Member::class, 'default');
-        $this->assertFalse($object->canEdit($member));
-    }
+		$member = $this->objFromFixture(Member::class, 'default');
+		$this->assertFalse($object->canEdit($member));
+	}
 
-    /**
-     *
-     */
-    public function testCanDelete()
-    {
-        $object = $this->objFromFixture(LocationCategory::class, 'service');
+	/**
+	 *
+	 */
+	public function testCanDelete()
+	{
+		$object = $this->objFromFixture(LocationCategory::class, 'service');
 
-        $admin = $this->objFromFixture(Member::class, 'locationdelete');
-        $this->assertTrue($object->canDelete($admin));
+		$admin = $this->objFromFixture(Member::class, 'locationdelete');
+		$this->assertTrue($object->canDelete($admin));
 
-        $member = $this->objFromFixture(Member::class, 'default');
-        $this->assertFalse($object->canDelete($member));
-    }
+		$member = $this->objFromFixture(Member::class, 'default');
+		$this->assertFalse($object->canDelete($member));
+	}
 
-    /**
-     *
-     */
-    public function testCanCreate()
-    {
-        $object = $this->objFromFixture(LocationCategory::class, 'service');
+	/**
+	 *
+	 */
+	public function testCanCreate()
+	{
+		$object = $this->objFromFixture(LocationCategory::class, 'service');
 
-        $admin = $this->objFromFixture(Member::class, 'locationcreate');
-        $this->assertTrue($object->canCreate($admin));
+		$admin = $this->objFromFixture(Member::class, 'locationcreate');
+		$this->assertTrue($object->canCreate($admin));
 
-        $member = $this->objFromFixture(Member::class, 'default');
-        $this->assertFalse($object->canCreate($member));
-    }
+		$member = $this->objFromFixture(Member::class, 'default');
+		$this->assertFalse($object->canCreate($member));
+	}
 }

src/objects/LocationCategory.php

Spacing +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
      */
     public function getCMSFields()
     {
-        $this->beforeUpdateCMSFields(function ($fields) {
+        $this->beforeUpdateCMSFields(function($fields) {
             $fields->removeByName([
                 'Locations',
                 'LocationSet',

Indentation +121 added lines, -121 removed lines

@@ -20,125 +20,125 @@
  */
 class LocationCategory extends DataObject
 {
-    /**
-     * @var string
-     */
-    private static $singular_name = 'Category';
-
-    /**
-     * @var string
-     */
-    private static $plural_name = 'Categories';
-
-    /**
-     * @var array
-     */
-    private static $db = array(
-        'Name' => 'Varchar(100)',
-    );
-
-    /**
-     * @var array
-     */
-    private static $belongs_many_many = array(
-        'Locators' => Locator::class,
-        'LocationSet' => Location::class,
-    );
-
-    /**
-     * @var string
-     */
-    private static $table_name = 'LocationCategory';
-
-    /**
-     * @var string
-     */
-    private static $default_sort = 'Name';
-
-    /**
-     * @return \SilverStripe\Forms\FieldList
-     */
-    public function getCMSFields()
-    {
-        $this->beforeUpdateCMSFields(function ($fields) {
-            $fields->removeByName([
-                'Locations',
-                'LocationSet',
-                'Locators',
-                'LinkTracking',
-                'FileTracking',
-            ]);
-
-            if ($this->ID) {
-                // Locations
-                $config = GridFieldConfig_RelationEditor::create();
-                $config->removeComponentsByType([
-                    GridFieldAddExistingAutocompleter::class,
-                    GridFieldAddNewButton::class
-                ])
-                    ->addComponents([
-                        new GridFieldAddExistingSearchButton(),
-                    ]);
-                $locations = $this->Locations();
-                $locationField = GridField::create('Locations', 'Locations', $locations, $config);
-
-                $fields->addFieldsToTab('Root.Main', array(
-                    $locationField,
-                ));
-            }
-        });
-
-        $fields = parent::getCMSFields();
-
-        return $fields;
-    }
-
-    /**
-     * For backwards compatability
-     * @return Locations|ManyManyList
-     */
-    public function Locations()
-    {
-        return $this->LocationSet();
-    }
-
-    /**
-     * @param null $member
-     * @param array $context
-     * @return bool
-     */
-    public function canView($member = null, $context = [])
-    {
-        return true;
-    }
-
-    /**
-     * @param null $member
-     * @param array $context
-     * @return bool|int
-     */
-    public function canEdit($member = null, $context = [])
-    {
-        return Permission::check('Location_EDIT', 'any', $member);
-    }
-
-    /**
-     * @param null $member
-     * @param array $context
-     * @return bool|int
-     */
-    public function canDelete($member = null, $context = [])
-    {
-        return Permission::check('Location_DELETE', 'any', $member);
-    }
-
-    /**
-     * @param null $member
-     * @param array $context
-     * @return bool|int
-     */
-    public function canCreate($member = null, $context = [])
-    {
-        return Permission::check('Location_CREATE', 'any', $member);
-    }
+	/**
+	 * @var string
+	 */
+	private static $singular_name = 'Category';
+
+	/**
+	 * @var string
+	 */
+	private static $plural_name = 'Categories';
+
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		'Name' => 'Varchar(100)',
+	);
+
+	/**
+	 * @var array
+	 */
+	private static $belongs_many_many = array(
+		'Locators' => Locator::class,
+		'LocationSet' => Location::class,
+	);
+
+	/**
+	 * @var string
+	 */
+	private static $table_name = 'LocationCategory';
+
+	/**
+	 * @var string
+	 */
+	private static $default_sort = 'Name';
+
+	/**
+	 * @return \SilverStripe\Forms\FieldList
+	 */
+	public function getCMSFields()
+	{
+		$this->beforeUpdateCMSFields(function ($fields) {
+			$fields->removeByName([
+				'Locations',
+				'LocationSet',
+				'Locators',
+				'LinkTracking',
+				'FileTracking',
+			]);
+
+			if ($this->ID) {
+				// Locations
+				$config = GridFieldConfig_RelationEditor::create();
+				$config->removeComponentsByType([
+					GridFieldAddExistingAutocompleter::class,
+					GridFieldAddNewButton::class
+				])
+					->addComponents([
+						new GridFieldAddExistingSearchButton(),
+					]);
+				$locations = $this->Locations();
+				$locationField = GridField::create('Locations', 'Locations', $locations, $config);
+
+				$fields->addFieldsToTab('Root.Main', array(
+					$locationField,
+				));
+			}
+		});
+
+		$fields = parent::getCMSFields();
+
+		return $fields;
+	}
+
+	/**
+	 * For backwards compatability
+	 * @return Locations|ManyManyList
+	 */
+	public function Locations()
+	{
+		return $this->LocationSet();
+	}
+
+	/**
+	 * @param null $member
+	 * @param array $context
+	 * @return bool
+	 */
+	public function canView($member = null, $context = [])
+	{
+		return true;
+	}
+
+	/**
+	 * @param null $member
+	 * @param array $context
+	 * @return bool|int
+	 */
+	public function canEdit($member = null, $context = [])
+	{
+		return Permission::check('Location_EDIT', 'any', $member);
+	}
+
+	/**
+	 * @param null $member
+	 * @param array $context
+	 * @return bool|int
+	 */
+	public function canDelete($member = null, $context = [])
+	{
+		return Permission::check('Location_DELETE', 'any', $member);
+	}
+
+	/**
+	 * @param null $member
+	 * @param array $context
+	 * @return bool|int
+	 */
+	public function canCreate($member = null, $context = [])
+	{
+		return Permission::check('Location_CREATE', 'any', $member);
+	}
 }

src/pages/Locator.php

Spacing +1 added lines, -1 removed lines

@@ -70,7 +70,7 @@
      */
     public function getCMSFields()
     {
-        $this->beforeUpdateCMSFields(function ($fields) {
+        $this->beforeUpdateCMSFields(function($fields) {
             // Settings
             $fields->addFieldsToTab('Root.Settings', array(
                 HeaderField::create('DisplayOptions', 'Display Options', 3),

Indentation +242 added lines, -242 removed lines

@@ -26,246 +26,246 @@
  */
 class Locator extends \Page
 {
-    /**
-     * @var string
-     */
-    private static $singular_name = 'Locator';
-
-    /**
-     * @var string
-     */
-    private static $plural_name = 'Locators';
-
-    /**
-     * @var string
-     */
-    private static $description = 'Display locations on a map';
-
-    /**
-     * @var array
-     */
-    private static $db = array(
-        'Unit' => 'Enum("m,km","m")',
-    );
-
-    /**
-     * @var array
-     */
-    private static $many_many = array(
-        'Categories' => LocationCategory::class,
-    );
-
-    /**
-     * @var string
-     */
-    private static $table_name = 'Locator';
-
-    /**
-     * @var string
-     */
-    private static $location_class = Location::class;
-
-    /**
-     * @return FieldList
-     */
-    public function getCMSFields()
-    {
-        $this->beforeUpdateCMSFields(function ($fields) {
-            // Settings
-            $fields->addFieldsToTab('Root.Settings', array(
-                HeaderField::create('DisplayOptions', 'Display Options', 3),
-                OptionsetField::create('Unit', 'Unit of measure', array('m' => 'Miles', 'km' => 'Kilometers')),
-            ));
-
-            // Filter categories
-            $config = GridFieldConfig_RelationEditor::create();
-            $config->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
-            $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,
-            ));
-        });
-
-        return parent::getCMSFields();
-    }
-
-    /**
-     * @param array $filter
-     * @param array $filterAny
-     * @param array $exclude
-     * @param null|callable $callback
-     *
-     * @return DataList|ArrayList
-     */
-    public static function get_locations(
-        $filter = [],
-        $filterAny = [],
-        $exclude = [],
-        $callback = null
-    ) {
-        $locationClass = Config::inst()->get(Locator::class, 'location_class');
-        $locations = $locationClass::get()->filter($filter)->exclude($exclude);
-
-        if (!empty($filterAny)) {
-            $locations = $locations->filterAny($filterAny);
-        }
-        if (!empty($exclude)) {
-            $locations = $locations->exclude($exclude);
-        }
-
-        if ($callback !== null && is_callable($callback)) {
-            $locations->filterByCallback($callback);
-        }
-
-        return $locations;
-    }
-
-    /**
-     * @return DataList
-     */
-    public static function get_all_categories()
-    {
-        return LocationCategory::get();
-    }
-
-    /**
-     * @return bool
-     */
-    public function getPageCategories()
-    {
-        return self::locator_categories_by_locator($this->ID);
-    }
-
-    /**
-     * @param int $id
-     *
-     * @return bool|
-     */
-    public static function locator_categories_by_locator($id = 0)
-    {
-        if ($id == 0) {
-            return false;
-        }
-
-        return Locator::get()->byID($id)->getUsedCategories();
-    }
-
-    /**
-     * Gets the list of radii
-     *
-     * @return ArrayList
-     */
-    public function getRadii()
-    {
-        $radii = [
-            '0' => '25',
-            '1' => '50',
-            '2' => '75',
-            '3' => '100',
-        ];
-        $config_radii = $this->config()->get('radii');
-        if ($config_radii) {
-            $radii = $config_radii;
-        }
-
-        return $radii;
-    }
-
-    public function getRadiiArrayList()
-    {
-        $list = [];
-
-        foreach ($this->getRadii() as $radius) {
-            $list[] = new ArrayData(array(
-                'Radius' => $radius,
-            ));
-        }
-
-        return new ArrayList($list);
-    }
-
-    /**
-     * Gets the limit of locations
-     * @return mixed
-     */
-    public function getLimit()
-    {
-        return $this->config()->get('limit');
-    }
-
-    /**
-     * Gets if the radius drop down should be shown
-     * @return mixed
-     */
-    public function getShowRadius()
-    {
-        return $this->config()->get('show_radius');
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getUsedCategories()
-    {
-        return $this->Categories()->filter([
-            'LocationSet.ID:GreaterThan' => 0,
-        ]);
-    }
-
-    /**
-     * Gets the path of the info window template
-     *
-     * @return string
-     */
-    public function getInfoWindowTemplate()
-    {
-        return ModuleResourceLoader::singleton()->resolveURL(
-            Config::inst()->get(
-                Locator::class,
-                'infoWindowTemplate'
-            )
-        );
-    }
-
-    /**
-     * Gets the path of the list template
-     *
-     * @return string
-     */
-    public function getListTemplate()
-    {
-        return ModuleResourceLoader::singleton()->resolveURL(
-            Config::inst()->get(
-                Locator::class,
-                'listTemplate'
-            )
-        );
-    }
-
-    /**
-     * @return null|string
-     */
-    public function getMapStyle()
-    {
-        return AddressDataExtension::getMapStyleJSON();
-    }
-
-    public function getMapStyleJSONPath()
-    {
-        return AddressDataExtension::getMapStyleJSONPath();
-    }
-
-    /**
-     * @return null|string
-     */
-    public function getMarkerIcon()
-    {
-        return AddressDataExtension::getIconImage();
-    }
+	/**
+	 * @var string
+	 */
+	private static $singular_name = 'Locator';
+
+	/**
+	 * @var string
+	 */
+	private static $plural_name = 'Locators';
+
+	/**
+	 * @var string
+	 */
+	private static $description = 'Display locations on a map';
+
+	/**
+	 * @var array
+	 */
+	private static $db = array(
+		'Unit' => 'Enum("m,km","m")',
+	);
+
+	/**
+	 * @var array
+	 */
+	private static $many_many = array(
+		'Categories' => LocationCategory::class,
+	);
+
+	/**
+	 * @var string
+	 */
+	private static $table_name = 'Locator';
+
+	/**
+	 * @var string
+	 */
+	private static $location_class = Location::class;
+
+	/**
+	 * @return FieldList
+	 */
+	public function getCMSFields()
+	{
+		$this->beforeUpdateCMSFields(function ($fields) {
+			// Settings
+			$fields->addFieldsToTab('Root.Settings', array(
+				HeaderField::create('DisplayOptions', 'Display Options', 3),
+				OptionsetField::create('Unit', 'Unit of measure', array('m' => 'Miles', 'km' => 'Kilometers')),
+			));
+
+			// Filter categories
+			$config = GridFieldConfig_RelationEditor::create();
+			$config->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
+			$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,
+			));
+		});
+
+		return parent::getCMSFields();
+	}
+
+	/**
+	 * @param array $filter
+	 * @param array $filterAny
+	 * @param array $exclude
+	 * @param null|callable $callback
+	 *
+	 * @return DataList|ArrayList
+	 */
+	public static function get_locations(
+		$filter = [],
+		$filterAny = [],
+		$exclude = [],
+		$callback = null
+	) {
+		$locationClass = Config::inst()->get(Locator::class, 'location_class');
+		$locations = $locationClass::get()->filter($filter)->exclude($exclude);
+
+		if (!empty($filterAny)) {
+			$locations = $locations->filterAny($filterAny);
+		}
+		if (!empty($exclude)) {
+			$locations = $locations->exclude($exclude);
+		}
+
+		if ($callback !== null && is_callable($callback)) {
+			$locations->filterByCallback($callback);
+		}
+
+		return $locations;
+	}
+
+	/**
+	 * @return DataList
+	 */
+	public static function get_all_categories()
+	{
+		return LocationCategory::get();
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function getPageCategories()
+	{
+		return self::locator_categories_by_locator($this->ID);
+	}
+
+	/**
+	 * @param int $id
+	 *
+	 * @return bool|
+	 */
+	public static function locator_categories_by_locator($id = 0)
+	{
+		if ($id == 0) {
+			return false;
+		}
+
+		return Locator::get()->byID($id)->getUsedCategories();
+	}
+
+	/**
+	 * Gets the list of radii
+	 *
+	 * @return ArrayList
+	 */
+	public function getRadii()
+	{
+		$radii = [
+			'0' => '25',
+			'1' => '50',
+			'2' => '75',
+			'3' => '100',
+		];
+		$config_radii = $this->config()->get('radii');
+		if ($config_radii) {
+			$radii = $config_radii;
+		}
+
+		return $radii;
+	}
+
+	public function getRadiiArrayList()
+	{
+		$list = [];
+
+		foreach ($this->getRadii() as $radius) {
+			$list[] = new ArrayData(array(
+				'Radius' => $radius,
+			));
+		}
+
+		return new ArrayList($list);
+	}
+
+	/**
+	 * Gets the limit of locations
+	 * @return mixed
+	 */
+	public function getLimit()
+	{
+		return $this->config()->get('limit');
+	}
+
+	/**
+	 * Gets if the radius drop down should be shown
+	 * @return mixed
+	 */
+	public function getShowRadius()
+	{
+		return $this->config()->get('show_radius');
+	}
+
+	/**
+	 * @return mixed
+	 */
+	public function getUsedCategories()
+	{
+		return $this->Categories()->filter([
+			'LocationSet.ID:GreaterThan' => 0,
+		]);
+	}
+
+	/**
+	 * Gets the path of the info window template
+	 *
+	 * @return string
+	 */
+	public function getInfoWindowTemplate()
+	{
+		return ModuleResourceLoader::singleton()->resolveURL(
+			Config::inst()->get(
+				Locator::class,
+				'infoWindowTemplate'
+			)
+		);
+	}
+
+	/**
+	 * Gets the path of the list template
+	 *
+	 * @return string
+	 */
+	public function getListTemplate()
+	{
+		return ModuleResourceLoader::singleton()->resolveURL(
+			Config::inst()->get(
+				Locator::class,
+				'listTemplate'
+			)
+		);
+	}
+
+	/**
+	 * @return null|string
+	 */
+	public function getMapStyle()
+	{
+		return AddressDataExtension::getMapStyleJSON();
+	}
+
+	public function getMapStyleJSONPath()
+	{
+		return AddressDataExtension::getMapStyleJSONPath();
+	}
+
+	/**
+	 * @return null|string
+	 */
+	public function getMarkerIcon()
+	{
+		return AddressDataExtension::getIconImage();
+	}
 }

tests/pages/LocatorControllerTest.php

Indentation +63 added lines, -63 removed lines

@@ -18,78 +18,78 @@
 class LocatorControllerTest extends FunctionalTest
 {
 
-    /**
-     * @var string
-     */
-    protected static $fixture_file = '../fixtures.yml';
+	/**
+	 * @var string
+	 */
+	protected static $fixture_file = '../fixtures.yml';
 
-    /**
-     * @var bool
-     */
-    protected static $use_draft_site = true;
+	/**
+	 * @var bool
+	 */
+	protected static $use_draft_site = true;
 
-    /**
-     *
-     */
-    public function testIndex()
-    {
-        $locator = $this->objFromFixture(Locator::class, 'locator1');
-        $controller = LocatorController::create($locator);
-        $this->assertInstanceOf(ViewableData::class, $controller->index($controller->getRequest()));
-    }
+	/**
+	 *
+	 */
+	public function testIndex()
+	{
+		$locator = $this->objFromFixture(Locator::class, 'locator1');
+		$controller = LocatorController::create($locator);
+		$this->assertInstanceOf(ViewableData::class, $controller->index($controller->getRequest()));
+	}
 
-    /**
-     *
-     */
-    public function testXml()
-    {
-        /** @var Locator $locator */
-        $locator = $this->objFromFixture(Locator::class, 'locator1');
-        $page = $this->get($locator->Link('xml'));
+	/**
+	 *
+	 */
+	public function testXml()
+	{
+		/** @var Locator $locator */
+		$locator = $this->objFromFixture(Locator::class, 'locator1');
+		$page = $this->get($locator->Link('xml'));
 
-        $this->assertEquals(200, $page->getStatusCode());
-        $this->assertEquals('application/xml', $page->getHeader('content-type'));
+		$this->assertEquals(200, $page->getStatusCode());
+		$this->assertEquals('application/xml', $page->getHeader('content-type'));
 
-        $dom = new DOMDocument();
-        // true if it loads, false if it doesn't
-        $valid = $dom->loadXML($page->getBody());
-        $this->assertTrue($valid);
-    }
+		$dom = new DOMDocument();
+		// true if it loads, false if it doesn't
+		$valid = $dom->loadXML($page->getBody());
+		$this->assertTrue($valid);
+	}
 
-    /**
-     *
-     */
-    public function testJson()
-    {
-        /** @var Locator $locator */
-        $locator = $this->objFromFixture(Locator::class, 'locator1');
-        $page = $this->get($locator->Link('json'));
+	/**
+	 *
+	 */
+	public function testJson()
+	{
+		/** @var Locator $locator */
+		$locator = $this->objFromFixture(Locator::class, 'locator1');
+		$page = $this->get($locator->Link('json'));
 
-        $this->assertEquals(200, $page->getStatusCode());
-        $this->assertEquals('application/json', $page->getHeader('content-type'));
+		$this->assertEquals(200, $page->getStatusCode());
+		$this->assertEquals('application/json', $page->getHeader('content-type'));
 
-        $json = json_decode($page->getBody());
-        // if it is null its not valid
-        $this->assertNotNull($json);
-    }
+		$json = json_decode($page->getBody());
+		// if it is null its not valid
+		$this->assertNotNull($json);
+	}
 
-    /**
-     *
-     */
-    public function testLocationSearch()
-    {
-        $locator = $this->objFromFixture(Locator::class, 'locator1');
-        $object = LocatorController::create($locator);
-        $form = $object->LocationSearch();
-        $this->assertInstanceOf(Form::class, $form);
+	/**
+	 *
+	 */
+	public function testLocationSearch()
+	{
+		$locator = $this->objFromFixture(Locator::class, 'locator1');
+		$object = LocatorController::create($locator);
+		$form = $object->LocationSearch();
+		$this->assertInstanceOf(Form::class, $form);
 
-        $category = $this->objFromFixture(LocationCategory::class, 'service');
-        $category2 = $this->objFromFixture(LocationCategory::class, 'manufacturing');
-        $locator->Categories()->add($category);
-        $locator->Categories()->add($category2);
+		$category = $this->objFromFixture(LocationCategory::class, 'service');
+		$category2 = $this->objFromFixture(LocationCategory::class, 'manufacturing');
+		$locator->Categories()->add($category);
+		$locator->Categories()->add($category2);
 
-        $form = $object->LocationSearch();
-        $fields = $form->Fields();
-        $this->assertInstanceOf(FieldList::class, $fields);
-    }
+		$form = $object->LocationSearch();
+		$fields = $form->Fields();
+		$this->assertInstanceOf(FieldList::class, $fields);
+	}
 }

tests/pages/LocatorTest.php

Indentation +154 added lines, -154 removed lines

@@ -21,158 +21,158 @@
  */
 class LocatorTest extends FunctionalTest
 {
-    /**
-     * @var string
-     */
-    protected static $fixture_file = '../fixtures.yml';
-
-    /**
-     *
-     */
-    public function testGetCMSFields()
-    {
-        /** @var Locator $locator */
-        $locator = Injector::inst()->create(Locator::class);
-        $this->assertInstanceOf(FieldList::class, $locator->getCMSFields());
-    }
-
-    /**
-     *
-     */
-    public function testLocations()
-    {
-        $filter = Config::inst()->get(LocatorController::class, 'base_filter');
-        $filterAny = Config::inst()->get(LocatorController::class, 'base_filter_any');
-        $exclude = Config::inst()->get(LocatorController::class, 'base_exclude');
-        $locations = Locator::get_locations($filter, $filterAny, $exclude);
-        $locations2 = Location::get()->filter($filter)->filterAny($filterAny)->exclude($exclude);
-        $this->assertEquals($locations->count(), $locations2->count());
-    }
-
-    /**
-     *
-     */
-    public function testGetAllCategories()
-    {
-        $this->assertEquals(Locator::get_all_categories()->count(), 4);
-    }
-
-    /**
-     *
-     */
-    public function testGetPageCategories()
-    {
-        $locator = $this->objFromFixture(Locator::class, 'locator1');
-        $this->assertEquals($locator->getPageCategories()->count(), 1);
-    }
-
-    /**
-     *
-     */
-    public function testLocator_categories_by_locator()
-    {
-        $categories = Locator::locator_categories_by_locator(0);
-        $this->assertFalse($categories);
-    }
-
-    /**
-     *
-     */
-    public function testLocatorCategoriesByLocator()
-    {
-
-        $locator = $this->objFromFixture(Locator::class, 'locator1');
-        $this->assertEquals(Locator::locator_categories_by_locator($locator->ID)->count(), 1);
-
-        $newLocator = Locator::create();
-        $newLocator->Title = 'Locator 2';
-        $newLocator->write();
-
-        $this->assertEquals(Locator::locator_categories_by_locator($newLocator->ID)->count(), 0);
-    }
-
-    /**
-     *
-     */
-    public function testGetRadii()
-    {
-        /** @var Locator $locator */
-        $locator = Injector::inst()->create(Locator::class);
-        $radii = [
-            '0' => '5',
-            '1' => '10',
-            '2' => '15',
-            '3' => '100',
-        ];
-        Config::modify()->set(Locator::class, 'radii', $radii);
-        $this->assertEquals($radii, $locator->getRadii());
-    }
-
-    /**
-     *
-     */
-    public function testGetRadiiArrayList()
-    {
-        /** @var Locator $locator */
-        $locator = Injector::inst()->create(Locator::class);
-        $this->assertInstanceOf(ArrayList::class, $locator->getRadiiArrayList());
-    }
-
-    /**
-     *
-     */
-    public function testGetLimit()
-    {
-        /** @var Locator $locator */
-        $locator = Injector::inst()->create(Locator::class);
-        $this->assertEquals(50, $locator->getLimit());
-    }
-
-    /**
-     *
-     */
-    public function testGetShowRadius()
-    {
-        /** @var Locator $locator */
-        $locator = Injector::inst()->create(Locator::class);
-        $this->assertTrue($locator->getShowRadius());
-    }
-
-    /**
-     *
-     */
-    public function testGetUsedCategories()
-    {
-        /** @var Locator $locator */
-        $locator = $this->objFromFixture(Locator::class, 'locator1');
-
-        $categories = $locator->getUsedCategories()->toArray();
-        $this->assertEquals(1, count($categories));
-    }
-
-    /**
-     *
-     */
-    public function testGetInfoWindowTemplate()
-    {
-        /** @var Locator $object */
-        $object = Injector::inst()->create(Locator::class);
-        $template = $object->getInfoWindowTemplate();
-        // get rid of cache ending
-        $template = preg_replace('/\?.*$/', '', $template);
-        $this->assertStringEndsWith('client/infowindow-description.html', $template);
-    }
-
-    /**
-     *
-     */
-    public function testGetListTemplate()
-    {
-        /** @var Locator $object */
-        $object = Injector::inst()->create(Locator::class);
-        $template = $object->getListTemplate();
-        // get rid of cache ending
-        $template = preg_replace('/\?.*$/', '', $template);
-        $this->assertStringEndsWith('client/location-list-description.html', $template);
-    }
+	/**
+	 * @var string
+	 */
+	protected static $fixture_file = '../fixtures.yml';
+
+	/**
+	 *
+	 */
+	public function testGetCMSFields()
+	{
+		/** @var Locator $locator */
+		$locator = Injector::inst()->create(Locator::class);
+		$this->assertInstanceOf(FieldList::class, $locator->getCMSFields());
+	}
+
+	/**
+	 *
+	 */
+	public function testLocations()
+	{
+		$filter = Config::inst()->get(LocatorController::class, 'base_filter');
+		$filterAny = Config::inst()->get(LocatorController::class, 'base_filter_any');
+		$exclude = Config::inst()->get(LocatorController::class, 'base_exclude');
+		$locations = Locator::get_locations($filter, $filterAny, $exclude);
+		$locations2 = Location::get()->filter($filter)->filterAny($filterAny)->exclude($exclude);
+		$this->assertEquals($locations->count(), $locations2->count());
+	}
+
+	/**
+	 *
+	 */
+	public function testGetAllCategories()
+	{
+		$this->assertEquals(Locator::get_all_categories()->count(), 4);
+	}
+
+	/**
+	 *
+	 */
+	public function testGetPageCategories()
+	{
+		$locator = $this->objFromFixture(Locator::class, 'locator1');
+		$this->assertEquals($locator->getPageCategories()->count(), 1);
+	}
+
+	/**
+	 *
+	 */
+	public function testLocator_categories_by_locator()
+	{
+		$categories = Locator::locator_categories_by_locator(0);
+		$this->assertFalse($categories);
+	}
+
+	/**
+	 *
+	 */
+	public function testLocatorCategoriesByLocator()
+	{
+
+		$locator = $this->objFromFixture(Locator::class, 'locator1');
+		$this->assertEquals(Locator::locator_categories_by_locator($locator->ID)->count(), 1);
+
+		$newLocator = Locator::create();
+		$newLocator->Title = 'Locator 2';
+		$newLocator->write();
+
+		$this->assertEquals(Locator::locator_categories_by_locator($newLocator->ID)->count(), 0);
+	}
+
+	/**
+	 *
+	 */
+	public function testGetRadii()
+	{
+		/** @var Locator $locator */
+		$locator = Injector::inst()->create(Locator::class);
+		$radii = [
+			'0' => '5',
+			'1' => '10',
+			'2' => '15',
+			'3' => '100',
+		];
+		Config::modify()->set(Locator::class, 'radii', $radii);
+		$this->assertEquals($radii, $locator->getRadii());
+	}
+
+	/**
+	 *
+	 */
+	public function testGetRadiiArrayList()
+	{
+		/** @var Locator $locator */
+		$locator = Injector::inst()->create(Locator::class);
+		$this->assertInstanceOf(ArrayList::class, $locator->getRadiiArrayList());
+	}
+
+	/**
+	 *
+	 */
+	public function testGetLimit()
+	{
+		/** @var Locator $locator */
+		$locator = Injector::inst()->create(Locator::class);
+		$this->assertEquals(50, $locator->getLimit());
+	}
+
+	/**
+	 *
+	 */
+	public function testGetShowRadius()
+	{
+		/** @var Locator $locator */
+		$locator = Injector::inst()->create(Locator::class);
+		$this->assertTrue($locator->getShowRadius());
+	}
+
+	/**
+	 *
+	 */
+	public function testGetUsedCategories()
+	{
+		/** @var Locator $locator */
+		$locator = $this->objFromFixture(Locator::class, 'locator1');
+
+		$categories = $locator->getUsedCategories()->toArray();
+		$this->assertEquals(1, count($categories));
+	}
+
+	/**
+	 *
+	 */
+	public function testGetInfoWindowTemplate()
+	{
+		/** @var Locator $object */
+		$object = Injector::inst()->create(Locator::class);
+		$template = $object->getInfoWindowTemplate();
+		// get rid of cache ending
+		$template = preg_replace('/\?.*$/', '', $template);
+		$this->assertStringEndsWith('client/infowindow-description.html', $template);
+	}
+
+	/**
+	 *
+	 */
+	public function testGetListTemplate()
+	{
+		/** @var Locator $object */
+		$object = Injector::inst()->create(Locator::class);
+		$template = $object->getListTemplate();
+		// get rid of cache ending
+		$template = preg_replace('/\?.*$/', '', $template);
+		$this->assertStringEndsWith('client/location-list-description.html', $template);
+	}
 }

src/pages/LocatorController.php

Indentation +315 added lines, -315 removed lines

@@ -18,131 +18,131 @@ 
  */
 class LocatorController extends \PageController
 {
-    /**
-     * @var array
-     */
-    private static $allowed_actions = [
-        'xml',
-        'json',
-    ];
-
-    /**
-     * @var array
-     */
-    private static $base_filter = [];
-
-    /**
-     * @var array
-     */
-    private static $base_exclude = [
-        'Lat' => 0,
-        'Lng' => 0,
-    ];
-
-    /**
-     * @var array
-     */
-    private static $base_filter_any = [];
-
-    /**
-     * @var bool
-     */
-    private static $bootstrapify = true;
-
-    /**
-     * ID of map container
-     *
-     * @var string
-     */
-    private static $map_container = 'map';
-
-    /**
-     * class of location list container
-     *
-     * @var string
-     */
-    private static $list_container = 'loc-list';
-
-    /**
-     * GET variable which, if isset, will trigger storeLocator init and return XML
-     *
-     * @var string
-     */
-    private static $query_trigger = 'action_doFilterLocations';
-
-    /**
-     * @var DataList|ArrayList
-     */
-    protected $locations;
-
-    /**
-     * Set Requirements based on input from CMS
-     */
-    public function init()
-    {
-        parent::init();
-        // google maps api key
-        $key = Config::inst()->get(GoogleGeocoder::class, 'map_api_key');
-        Requirements::javascript('https://maps.google.com/maps/api/js?key=' . $key);
-
-        // prevent init of map if no query
-        $request = Controller::curr()->getRequest();
-
-        if ($this->getTrigger($request)) {
-            $locations = $this->getLocations();
-
-            if ($locations) {
-                $featuredInList = ($locations->filter('Featured', true)->count() > 0);
-                $defaultCoords = $this->getAddressSearchCoords() ?
-                    $this->getAddressSearchCoords() :
-                    new ArrayData([
-                        "Lat" => 0,
-                        "Lng" => 0,
-                    ]);
-
-                $featured = $featuredInList
-                    ? 'featuredLocations: true'
-                    : 'featuredLocations: false';
-
-                // map config based on user input in Settings tab
-                $limit = Config::inst()->get(LocatorController::class, 'limit');
-                if ($limit < 1) {
-                    $limit = -1;
-                }
-                $load = 'fullMapStart: true, storeLimit: ' . $limit . ', maxDistance: true,';
-
-                $listTemplatePath = $this->getListTemplate();
-                $infowindowTemplatePath = $this->getInfoWindowTemplate();
-
-                $kilometer = ($this->data()->Unit == 'km') ? "lengthUnit: 'km'" : "lengthUnit: 'm'";
-
-                // pass GET variables to xml action
-                $vars = $this->request->getVars();
-                unset($vars['url']);
-                $url = '';
-                if (count($vars)) {
-                    $url .= '?' . http_build_query($vars);
-                }
-                $link = Controller::join_links($this->Link(), 'xml.xml', $url);
-
-                // containers
-                $map_id = Config::inst()->get(LocatorController::class, 'map_container');
-                $list_class = Config::inst()->get(LocatorController::class, 'list_container');
-
-                $mapStyle = '';
-                if ($stylePath = $this->getMapStyleJSONPath()) {
-                    if ($style = file_get_contents($stylePath)) {
-                        $mapStyle = "styles: {$style},";
-                    }
-                };
-
-                $markerImage = '';
-                if ($imagePath = $this->getMarkerIcon()) {
-                    $markerImage = "markerImg: '{$imagePath}',";
-                }
-
-                // init map
-                Requirements::customScript("
+	/**
+	 * @var array
+	 */
+	private static $allowed_actions = [
+		'xml',
+		'json',
+	];
+
+	/**
+	 * @var array
+	 */
+	private static $base_filter = [];
+
+	/**
+	 * @var array
+	 */
+	private static $base_exclude = [
+		'Lat' => 0,
+		'Lng' => 0,
+	];
+
+	/**
+	 * @var array
+	 */
+	private static $base_filter_any = [];
+
+	/**
+	 * @var bool
+	 */
+	private static $bootstrapify = true;
+
+	/**
+	 * ID of map container
+	 *
+	 * @var string
+	 */
+	private static $map_container = 'map';
+
+	/**
+	 * class of location list container
+	 *
+	 * @var string
+	 */
+	private static $list_container = 'loc-list';
+
+	/**
+	 * GET variable which, if isset, will trigger storeLocator init and return XML
+	 *
+	 * @var string
+	 */
+	private static $query_trigger = 'action_doFilterLocations';
+
+	/**
+	 * @var DataList|ArrayList
+	 */
+	protected $locations;
+
+	/**
+	 * Set Requirements based on input from CMS
+	 */
+	public function init()
+	{
+		parent::init();
+		// google maps api key
+		$key = Config::inst()->get(GoogleGeocoder::class, 'map_api_key');
+		Requirements::javascript('https://maps.google.com/maps/api/js?key=' . $key);
+
+		// prevent init of map if no query
+		$request = Controller::curr()->getRequest();
+
+		if ($this->getTrigger($request)) {
+			$locations = $this->getLocations();
+
+			if ($locations) {
+				$featuredInList = ($locations->filter('Featured', true)->count() > 0);
+				$defaultCoords = $this->getAddressSearchCoords() ?
+					$this->getAddressSearchCoords() :
+					new ArrayData([
+						"Lat" => 0,
+						"Lng" => 0,
+					]);
+
+				$featured = $featuredInList
+					? 'featuredLocations: true'
+					: 'featuredLocations: false';
+
+				// map config based on user input in Settings tab
+				$limit = Config::inst()->get(LocatorController::class, 'limit');
+				if ($limit < 1) {
+					$limit = -1;
+				}
+				$load = 'fullMapStart: true, storeLimit: ' . $limit . ', maxDistance: true,';
+
+				$listTemplatePath = $this->getListTemplate();
+				$infowindowTemplatePath = $this->getInfoWindowTemplate();
+
+				$kilometer = ($this->data()->Unit == 'km') ? "lengthUnit: 'km'" : "lengthUnit: 'm'";
+
+				// pass GET variables to xml action
+				$vars = $this->request->getVars();
+				unset($vars['url']);
+				$url = '';
+				if (count($vars)) {
+					$url .= '?' . http_build_query($vars);
+				}
+				$link = Controller::join_links($this->Link(), 'xml.xml', $url);
+
+				// containers
+				$map_id = Config::inst()->get(LocatorController::class, 'map_container');
+				$list_class = Config::inst()->get(LocatorController::class, 'list_container');
+
+				$mapStyle = '';
+				if ($stylePath = $this->getMapStyleJSONPath()) {
+					if ($style = file_get_contents($stylePath)) {
+						$mapStyle = "styles: {$style},";
+					}
+				};
+
+				$markerImage = '';
+				if ($imagePath = $this->getMarkerIcon()) {
+					$markerImage = "markerImg: '{$imagePath}',";
+				}
+
+				// init map
+				Requirements::customScript("
                 $(function(){
                     $('#map-container').storeLocator({
                         {$load}
@@ -171,194 +171,194 @@ 
                     });
                 });
             ", 'jquery-locator');
-            }
-        }
-    }
-
-    /**
-     * @param HTTPRequest $request
-     *
-     * @return bool
-     */
-    public function getTrigger(HTTPRequest $request = null)
-    {
-        if ($request === null) {
-            $request = $this->getRequest();
-        }
-        $trigger = $request->getVar(Config::inst()->get(LocatorController::class, 'query_trigger'));
-
-        return isset($trigger);
-    }
-
-    /**
-     * @return ArrayList|DataList
-     */
-    public function getLocations()
-    {
-        if (!$this->locations) {
-            $this->setLocations($this->request);
-        }
-
-        return $this->locations;
-    }
-
-    /**
-     * @param HTTPRequest|null $request
-     *
-     * @return $this
-     */
-    public function setLocations(HTTPRequest $request = null)
-    {
-
-        if ($request === null) {
-            $request = $this->request;
-        }
-        $filter = $this->config()->get('base_filter');
-
-        $categoryVar = Config::inst()->get(Locator::class, 'category_var');
-        if ($request->getVar($categoryVar)) {
-            $filter['Categories.ID'] = $request->getVar($categoryVar);
-        } else {
-            if ($this->getPageCategories()->exists()) {
-                foreach ($this->getPageCategories() as $category) {
-                    $filter['Categories.ID'][] = $category->ID;
-                }
-            }
-        }
-
-        $this->extend('updateLocatorFilter', $filter, $request);
-
-        $filterAny = $this->config()->get('base_filter_any');
-        $this->extend('updateLocatorFilterAny', $filterAny, $request);
-
-        $exclude = $this->config()->get('base_exclude');
-        $this->extend('updateLocatorExclude', $exclude, $request);
-
-        $locations = Locator::get_locations($filter, $filterAny, $exclude);
-        $locations = DataToArrayListHelper::to_array_list($locations);
-
-        //allow for adjusting list post possible distance calculation
-        $this->extend('updateLocationList', $locations);
-
-        if ($locations->canSortBy('Distance')) {
-            $locations = $locations->sort('Distance');
-        }
-
-        if ($this->getShowRadius()) {
-            $radiusVar = Config::inst()->get(Locator::class, 'radius_var');
-
-            if ($radius = (int)$request->getVar($radiusVar)) {
-                $locations = $locations->filterByCallback(function ($location) use (&$radius) {
-                    return $location->Distance <= $radius;
-                });
-            }
-        }
-
-        //allow for returning list to be set as
-        $this->extend('updateListType', $locations);
-
-        $limit = $this->getLimit();
-        if ($limit > 0) {
-            $locations = $locations->limit($limit);
-        }
-
-        $this->locations = $locations;
-
-        return $this;
-    }
-
-    /**
-     * @return ArrayData|boolean
-     */
-    public function getAddressSearchCoords()
-    {
-        $addressVar = Config::inst()->get(DistanceDataExtension::class, 'address_var');
-        if (!$this->request->getVar($addressVar)) {
-            return false;
-        }
-        if (class_exists(GoogleGeocoder::class)) {
-            $geocoder = new GoogleGeocoder($this->request->getVar($addressVar));
-            $response = $geocoder->getResult();
-            $lat = $response->getLatitude();
-            $lng = $response->getLongitude();
-
-            return new ArrayData([
-                "Lat" => $lat,
-                "Lng" => $lng,
-            ]);
-        }
-    }
-
-    /**
-     * @param HTTPRequest $request
-     *
-     * @return \SilverStripe\View\ViewableData_Customised
-     */
-    public function index(HTTPRequest $request)
-    {
-        if ($this->getTrigger($request)) {
-            $locations = $this->getLocations();
-        } else {
-            $locations = ArrayList::create();
-        }
-
-        return $this->customise(array(
-            'Locations' => $locations,
-        ));
-    }
-
-    /**
-     * Renders locations in xml format
-     *
-     * @return \SilverStripe\ORM\FieldType\DBHTMLText
-     */
-    public function xml()
-    {
-        $this->getResponse()->addHeader("Content-Type", "application/xml");
-        $data = new ArrayData(array(
-            "Locations" => $this->getLocations(),
-            "AddressCoords" => $this->getAddressSearchCoords(),
-        ));
-
-        return $data->renderWith('Dynamic/Locator/Data/XML');
-    }
-
-    /**
-     * Renders locations in json format
-     *
-     * @return \SilverStripe\ORM\FieldType\DBHTMLText
-     */
-    public function json()
-    {
-        $this->getResponse()->addHeader("Content-Type", "application/json");
-        $data = new ArrayData(array(
-            "Locations" => $this->getLocations(),
-            "AddressCoords" => $this->getAddressSearchCoords(),
-        ));
-
-        return $data->renderWith('Dynamic/Locator/Data/JSON');
-    }
-
-    /**
-     * LocationSearch form.
-     *
-     * Search form for locations, updates map and results list via AJAX
-     *
-     * @return \SilverStripe\Forms\Form
-     */
-    public function LocationSearch()
-    {
-
-        $form = LocatorForm::create($this, 'LocationSearch');
-        if (class_exists(BootstrapForm::class) && $this->config()->get('bootstrapify')) {
-            $form->Fields()->bootstrapify();
-            $form->Actions()->bootstrapify();
-        }
-
-        return $form
-            ->setFormMethod('GET')
-            ->setFormAction($this->Link())
-            ->disableSecurityToken()
-            ->loadDataFrom($this->request->getVars());
-    }
+			}
+		}
+	}
+
+	/**
+	 * @param HTTPRequest $request
+	 *
+	 * @return bool
+	 */
+	public function getTrigger(HTTPRequest $request = null)
+	{
+		if ($request === null) {
+			$request = $this->getRequest();
+		}
+		$trigger = $request->getVar(Config::inst()->get(LocatorController::class, 'query_trigger'));
+
+		return isset($trigger);
+	}
+
+	/**
+	 * @return ArrayList|DataList
+	 */
+	public function getLocations()
+	{
+		if (!$this->locations) {
+			$this->setLocations($this->request);
+		}
+
+		return $this->locations;
+	}
+
+	/**
+	 * @param HTTPRequest|null $request
+	 *
+	 * @return $this
+	 */
+	public function setLocations(HTTPRequest $request = null)
+	{
+
+		if ($request === null) {
+			$request = $this->request;
+		}
+		$filter = $this->config()->get('base_filter');
+
+		$categoryVar = Config::inst()->get(Locator::class, 'category_var');
+		if ($request->getVar($categoryVar)) {
+			$filter['Categories.ID'] = $request->getVar($categoryVar);
+		} else {
+			if ($this->getPageCategories()->exists()) {
+				foreach ($this->getPageCategories() as $category) {
+					$filter['Categories.ID'][] = $category->ID;
+				}
+			}
+		}
+
+		$this->extend('updateLocatorFilter', $filter, $request);
+
+		$filterAny = $this->config()->get('base_filter_any');
+		$this->extend('updateLocatorFilterAny', $filterAny, $request);
+
+		$exclude = $this->config()->get('base_exclude');
+		$this->extend('updateLocatorExclude', $exclude, $request);
+
+		$locations = Locator::get_locations($filter, $filterAny, $exclude);
+		$locations = DataToArrayListHelper::to_array_list($locations);
+
+		//allow for adjusting list post possible distance calculation
+		$this->extend('updateLocationList', $locations);
+
+		if ($locations->canSortBy('Distance')) {
+			$locations = $locations->sort('Distance');
+		}
+
+		if ($this->getShowRadius()) {
+			$radiusVar = Config::inst()->get(Locator::class, 'radius_var');
+
+			if ($radius = (int)$request->getVar($radiusVar)) {
+				$locations = $locations->filterByCallback(function ($location) use (&$radius) {
+					return $location->Distance <= $radius;
+				});
+			}
+		}
+
+		//allow for returning list to be set as
+		$this->extend('updateListType', $locations);
+
+		$limit = $this->getLimit();
+		if ($limit > 0) {
+			$locations = $locations->limit($limit);
+		}
+
+		$this->locations = $locations;
+
+		return $this;
+	}
+
+	/**
+	 * @return ArrayData|boolean
+	 */
+	public function getAddressSearchCoords()
+	{
+		$addressVar = Config::inst()->get(DistanceDataExtension::class, 'address_var');
+		if (!$this->request->getVar($addressVar)) {
+			return false;
+		}
+		if (class_exists(GoogleGeocoder::class)) {
+			$geocoder = new GoogleGeocoder($this->request->getVar($addressVar));
+			$response = $geocoder->getResult();
+			$lat = $response->getLatitude();
+			$lng = $response->getLongitude();
+
+			return new ArrayData([
+				"Lat" => $lat,
+				"Lng" => $lng,
+			]);
+		}
+	}
+
+	/**
+	 * @param HTTPRequest $request
+	 *
+	 * @return \SilverStripe\View\ViewableData_Customised
+	 */
+	public function index(HTTPRequest $request)
+	{
+		if ($this->getTrigger($request)) {
+			$locations = $this->getLocations();
+		} else {
+			$locations = ArrayList::create();
+		}
+
+		return $this->customise(array(
+			'Locations' => $locations,
+		));
+	}
+
+	/**
+	 * Renders locations in xml format
+	 *
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
+	 */
+	public function xml()
+	{
+		$this->getResponse()->addHeader("Content-Type", "application/xml");
+		$data = new ArrayData(array(
+			"Locations" => $this->getLocations(),
+			"AddressCoords" => $this->getAddressSearchCoords(),
+		));
+
+		return $data->renderWith('Dynamic/Locator/Data/XML');
+	}
+
+	/**
+	 * Renders locations in json format
+	 *
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
+	 */
+	public function json()
+	{
+		$this->getResponse()->addHeader("Content-Type", "application/json");
+		$data = new ArrayData(array(
+			"Locations" => $this->getLocations(),
+			"AddressCoords" => $this->getAddressSearchCoords(),
+		));
+
+		return $data->renderWith('Dynamic/Locator/Data/JSON');
+	}
+
+	/**
+	 * LocationSearch form.
+	 *
+	 * Search form for locations, updates map and results list via AJAX
+	 *
+	 * @return \SilverStripe\Forms\Form
+	 */
+	public function LocationSearch()
+	{
+
+		$form = LocatorForm::create($this, 'LocationSearch');
+		if (class_exists(BootstrapForm::class) && $this->config()->get('bootstrapify')) {
+			$form->Fields()->bootstrapify();
+			$form->Actions()->bootstrapify();
+		}
+
+		return $form
+			->setFormMethod('GET')
+			->setFormAction($this->Link())
+			->disableSecurityToken()
+			->loadDataFrom($this->request->getVars());
+	}
 }

Spacing +6 added lines, -7 removed lines

@@ -83,7 +83,7 @@ 
         parent::init();
         // google maps api key
         $key = Config::inst()->get(GoogleGeocoder::class, 'map_api_key');
-        Requirements::javascript('https://maps.google.com/maps/api/js?key=' . $key);
+        Requirements::javascript('https://maps.google.com/maps/api/js?key='.$key);
 
         // prevent init of map if no query
         $request = Controller::curr()->getRequest();
@@ -94,8 +94,7 @@ 
             if ($locations) {
                 $featuredInList = ($locations->filter('Featured', true)->count() > 0);
                 $defaultCoords = $this->getAddressSearchCoords() ?
-                    $this->getAddressSearchCoords() :
-                    new ArrayData([
+                    $this->getAddressSearchCoords() : new ArrayData([
                         "Lat" => 0,
                         "Lng" => 0,
                     ]);
@@ -109,7 +108,7 @@ 
                 if ($limit < 1) {
                     $limit = -1;
                 }
-                $load = 'fullMapStart: true, storeLimit: ' . $limit . ', maxDistance: true,';
+                $load = 'fullMapStart: true, storeLimit: '.$limit.', maxDistance: true,';
 
                 $listTemplatePath = $this->getListTemplate();
                 $infowindowTemplatePath = $this->getInfoWindowTemplate();
@@ -121,7 +120,7 @@ 
                 unset($vars['url']);
                 $url = '';
                 if (count($vars)) {
-                    $url .= '?' . http_build_query($vars);
+                    $url .= '?'.http_build_query($vars);
                 }
                 $link = Controller::join_links($this->Link(), 'xml.xml', $url);
 
@@ -247,8 +246,8 @@ 
         if ($this->getShowRadius()) {
             $radiusVar = Config::inst()->get(Locator::class, 'radius_var');
 
-            if ($radius = (int)$request->getVar($radiusVar)) {
-                $locations = $locations->filterByCallback(function ($location) use (&$radius) {
+            if ($radius = (int) $request->getVar($radiusVar)) {
+                $locations = $locations->filterByCallback(function($location) use (&$radius) {
                     return $location->Distance <= $radius;
                 });
             }

src/form/LocatorForm.php

Indentation +74 added lines, -74 removed lines

@@ -19,88 +19,88 @@
 class LocatorForm extends Form
 {
 
-    /**
-     * LocatorForm constructor.
-     * @param Controller $controller
-     * @param string $name
-     */
-    public function __construct(Controller $controller, $name)
-    {
+	/**
+	 * LocatorForm constructor.
+	 * @param Controller $controller
+	 * @param string $name
+	 */
+	public function __construct(Controller $controller, $name)
+	{
 
-        $fields = FieldList::create(
-            TextField::create('Address')
-                ->setTitle('')
-                ->setAttribute('placeholder', 'address or zip code')
-        );
+		$fields = FieldList::create(
+			TextField::create('Address')
+				->setTitle('')
+				->setAttribute('placeholder', 'address or zip code')
+		);
 
-        $pageCategories = Locator::locator_categories_by_locator($controller->data()->ID);
-        if ($pageCategories && $pageCategories->count() > 0) {
-            $categories = false;
-        } else {
-            $categories = Locator::get_all_categories();
-            if ($categories->count() < 1) {
-                $categories = false;
-            }
-        }
+		$pageCategories = Locator::locator_categories_by_locator($controller->data()->ID);
+		if ($pageCategories && $pageCategories->count() > 0) {
+			$categories = false;
+		} else {
+			$categories = Locator::get_all_categories();
+			if ($categories->count() < 1) {
+				$categories = false;
+			}
+		}
 
-        if ($categories) {
-            $categoriesField = DropdownField::create('CategoryID')
-                ->setTitle('')
-                ->setEmptyString('all categories')
-                ->setSource($categories->map());
-            $fields->push($categoriesField);
-        }
+		if ($categories) {
+			$categoriesField = DropdownField::create('CategoryID')
+				->setTitle('')
+				->setEmptyString('all categories')
+				->setSource($categories->map());
+			$fields->push($categoriesField);
+		}
 
-        if ($controller->getShowRadius()) {
-            $radiusArray = array_values($controller->getRadii());
-            $this->extend('overrideRadiusArray', $radiusArray);
-            $fields->push(DropdownField::create('Radius', '', ArrayLib::valuekey($radiusArray))
-                ->setEmptyString('radius'));
-        }
+		if ($controller->getShowRadius()) {
+			$radiusArray = array_values($controller->getRadii());
+			$this->extend('overrideRadiusArray', $radiusArray);
+			$fields->push(DropdownField::create('Radius', '', ArrayLib::valuekey($radiusArray))
+				->setEmptyString('radius'));
+		}
 
-        $actions = FieldList::create(
-            FormAction::create('doFilterLocations')
-                ->setTitle('Search')
-        );
+		$actions = FieldList::create(
+			FormAction::create('doFilterLocations')
+				->setTitle('Search')
+		);
 
-        $validator = $this->getValidator();
+		$validator = $this->getValidator();
 
-        parent::__construct($controller, $name, $fields, $actions, $validator);
-    }
+		parent::__construct($controller, $name, $fields, $actions, $validator);
+	}
 
-    /**
-     * @return null|RequiredFields|\SilverStripe\Forms\Validator
-     */
-    public function getValidator()
-    {
-        $validator = parent::getValidator();
-        if (empty($validator)) {
-            if (!$this->validator instanceof RequiredFields) {
-                $this->setValidator(RequiredFields::create('Address'));
-            }
-            $validator = $this->validator;
-        }
-        $this->extend('updateRequiredFields', $validator);
-        return $validator;
-    }
+	/**
+	 * @return null|RequiredFields|\SilverStripe\Forms\Validator
+	 */
+	public function getValidator()
+	{
+		$validator = parent::getValidator();
+		if (empty($validator)) {
+			if (!$this->validator instanceof RequiredFields) {
+				$this->setValidator(RequiredFields::create('Address'));
+			}
+			$validator = $this->validator;
+		}
+		$this->extend('updateRequiredFields', $validator);
+		return $validator;
+	}
 
-    /**
-     * @return FieldList
-     */
-    public function Fields()
-    {
-        $fields = parent::Fields();
-        $this->extend('updateLocatorFormFields', $fields);
-        return $fields;
-    }
+	/**
+	 * @return FieldList
+	 */
+	public function Fields()
+	{
+		$fields = parent::Fields();
+		$this->extend('updateLocatorFormFields', $fields);
+		return $fields;
+	}
 
-    /**
-     * @return \SilverStripe\Forms\FieldList
-     */
-    public function Actions()
-    {
-        $actions = parent::Actions();
-        $this->extend('updateLocatorActions', $actions);
-        return $actions;
-    }
+	/**
+	 * @return \SilverStripe\Forms\FieldList
+	 */
+	public function Actions()
+	{
+		$actions = parent::Actions();
+		$this->extend('updateLocatorActions', $actions);
+		return $actions;
+	}
 }

tests/form/LocatorFormTest.php

Indentation +43 added lines, -43 removed lines

@@ -11,47 +11,47 @@
 
 class LocatorFormTest extends FunctionalTest
 {
-    /**
-     * @var string
-     */
-    protected static $fixture_file = '../fixtures.yml';
-
-    /**
-     *
-     */
-    public function testLocatorFormBase()
-    {
-        $form = LocatorForm::create(LocatorController::create(Locator::get()->first()), 'LocatorForm');
-
-        $this->assertInstanceOf(FieldList::class, $form->Fields());
-        $this->assertInstanceOf(RequiredFields::class, $form->getValidator());
-    }
-
-    /**
-     *
-     */
-    public function testUpdateRequiredFields()
-    {
-        $form = LocatorForm::create(LocatorController::create(Locator::get()->first()), 'LocatorForm');
-        $validator = $form->getValidator();
-
-        $validator->removeRequiredField('Address');
-        $validator->addRequiredField('Foo');
-
-        $this->assertEquals(['Foo'], $form->getValidator()->getRequired());
-    }
-
-
-    public function testFields()
-    {
-        $form = LocatorForm::create(LocatorController::create(Locator::get()->first()), 'LocatorForm');
-        $this->assertInstanceOf(FieldList::class, $form->Fields());
-    }
-
-
-    public function testActions()
-    {
-        $form = LocatorForm::create(LocatorController::create(Locator::get()->first()), 'LocatorForm');
-        $this->assertInstanceOf(FieldList::class, $form->Actions());
-    }
+	/**
+	 * @var string
+	 */
+	protected static $fixture_file = '../fixtures.yml';
+
+	/**
+	 *
+	 */
+	public function testLocatorFormBase()
+	{
+		$form = LocatorForm::create(LocatorController::create(Locator::get()->first()), 'LocatorForm');
+
+		$this->assertInstanceOf(FieldList::class, $form->Fields());
+		$this->assertInstanceOf(RequiredFields::class, $form->getValidator());
+	}
+
+	/**
+	 *
+	 */
+	public function testUpdateRequiredFields()
+	{
+		$form = LocatorForm::create(LocatorController::create(Locator::get()->first()), 'LocatorForm');
+		$validator = $form->getValidator();
+
+		$validator->removeRequiredField('Address');
+		$validator->addRequiredField('Foo');
+
+		$this->assertEquals(['Foo'], $form->getValidator()->getRequired());
+	}
+
+
+	public function testFields()
+	{
+		$form = LocatorForm::create(LocatorController::create(Locator::get()->first()), 'LocatorForm');
+		$this->assertInstanceOf(FieldList::class, $form->Fields());
+	}
+
+
+	public function testActions()
+	{
+		$form = LocatorForm::create(LocatorController::create(Locator::get()->first()), 'LocatorForm');
+		$this->assertInstanceOf(FieldList::class, $form->Actions());
+	}
 }