dynamic / silverstripe-locator

src/Page/LocatorController.php

Indentation +371 added lines, -371 removed lines

@@ -21,379 +21,379 @@
  */
 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';
-
-    /**
-     * The zoom level of the map
-     * @var int
-     */
-    private static $zoom = 12;
-
-    /**
-     * The minimum zoom level the map can have
-     * @var int
-     */
-    private static $min_zoom = 6;
-
-    /**
-     * The maximum zoom level the map can have
-     * @var int
-     */
-    private static $max_zoom = 18;
-
-    /**
-     * If double clicking the map should not zoom
-     * @var bool
-     */
-    private static $disable_double_click_zoom = true;
-
-    /**
-     * If the map should disable zoom by scrollwheel
-     * @var bool
-     */
-    private static $scrollwheel = false;
-
-    /**
-     * If the map should show naviagtion controls
-     * @var bool
-     */
-    private static $navigation_control = false;
-
-    /**
-     * @var bool
-     */
-    private static $draggable = false;
-
-    /**
-     * @var DataList|ArrayList
-     */
-    protected $locations;
-
-    /**
-     * Set Requirements based on input from CMS
-     */
-    public function init()
-    {
-        parent::init();
-
-        // prevent init of map if no query
-        $request = Controller::curr()->getRequest();
-        if (!$this->getTrigger($request)) {
-            return;
-        }
-
-        $locations = $this->getLocations();
-
-        // prevent init of map if there are no locations
-        if (!$locations) {
-            return;
-        }
-
-        // google maps api key
-        $key = Config::inst()->get(GoogleGeocoder::class, 'map_api_key');
-        Requirements::javascript('https://maps.google.com/maps/api/js?key=' . $key);
-
-        $mapSettings = [
-            'fullMapStart' => true,
-            'maxDistance' => true,
-            'storeLimit' => -1,
-            'originMarker' => true,
-            'slideMap' => false,
-            'distanceAlert' => -1,
-            'featuredLocations' => false,
-            'defaultLat' => 0,
-            'defaultLng' => 0,
-            'mapSettings' => [
-                'zoom' => Config::inst()->get(LocatorController::class, 'zoom'),
-                'minZoom' => Config::inst()->get(LocatorController::class, 'min_zoom'),
-                'maxZoom' => Config::inst()->get(LocatorController::class, 'max_zoom'),
-                'mapTypeId' => 'google.maps.MapTypeId.ROADMAP',
-                'disableDoubleClickZoom' => Config::inst()->get(LocatorController::class, 'disable_double_click_zoom'),
-                'scrollwheel' => Config::inst()->get(LocatorController::class, 'scrollwheel'),
-                'navigationControl' => Config::inst()->get(LocatorController::class, 'navigation_control'),
-                'draggable' => Config::inst()->get(LocatorController::class, 'draggable'),
-            ],
-        ];
-
-        $mapSettings['listTemplatePath'] = $this->getListTemplate();
-        $mapSettings['infowindowTemplatePath'] = $this->getInfoWindowTemplate();
-        $mapSettings['lengthUnit'] = $this->data()->Unit == 'km' ? 'km' : 'm';
-        $mapSettings['mapID'] = Config::inst()->get(LocatorController::class, 'map_container');
-        $mapSettings['locationList'] = Config::inst()->get(LocatorController::class, 'list_container');
-
-        if ($locations->filter('Featured', true)->count() > 0) {
-            $mapSettings['featuredLocations'] = true;
-        }
-
-        // map config based on user input in Settings tab
-        $limit = Config::inst()->get(LocatorController::class, 'limit');
-        if (0 < $limit) {
-            $mapSettings['storeLimit'] = $limit;
-        }
-
-        if ($coords = $this->getAddressSearchCoords()) {
-            $mapSettings['defaultLat'] = $coords->getField("Lat");
-            $mapSettings['defaultLat'] = $coords->getField("Lng");
-        }
-
-        // pass GET variables to xml action
-        $vars = $this->request->getVars();
-        unset($vars['url']);
-        $url = '';
-        if (count($vars)) {
-            $url .= '?' . http_build_query($vars);
-        }
-        $mapSettings['dataLocation'] = Controller::join_links($this->Link(), 'xml.xml', $url);
-
-        if ($stylePath = $this->getMapStyleJSONPath()) {
-            if ($style = file_get_contents($stylePath)) {
-                $mapSettings['mapSettings']['styles'] = json_decode($style);
-            }
-        }
-
-        if ($imagePath = $this->getMarkerIcon()) {
-            $mapSettings['markerImg'] = $imagePath;
-        }
-
-        $this->extend('modifyMapSettings', $mapSettings);
-
-        $encoded = json_encode($mapSettings, JSON_UNESCAPED_SLASHES);
-        // mapTypeId is a javascript object
-        $encoded = preg_replace('/("mapTypeId"\s*:\s*)"(.+?)"/i', '$1$2', $encoded);
-
-        $this->extend('modifyMapSettingsEncoded', $encoded);
-        // 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';
+
+	/**
+	 * The zoom level of the map
+	 * @var int
+	 */
+	private static $zoom = 12;
+
+	/**
+	 * The minimum zoom level the map can have
+	 * @var int
+	 */
+	private static $min_zoom = 6;
+
+	/**
+	 * The maximum zoom level the map can have
+	 * @var int
+	 */
+	private static $max_zoom = 18;
+
+	/**
+	 * If double clicking the map should not zoom
+	 * @var bool
+	 */
+	private static $disable_double_click_zoom = true;
+
+	/**
+	 * If the map should disable zoom by scrollwheel
+	 * @var bool
+	 */
+	private static $scrollwheel = false;
+
+	/**
+	 * If the map should show naviagtion controls
+	 * @var bool
+	 */
+	private static $navigation_control = false;
+
+	/**
+	 * @var bool
+	 */
+	private static $draggable = false;
+
+	/**
+	 * @var DataList|ArrayList
+	 */
+	protected $locations;
+
+	/**
+	 * Set Requirements based on input from CMS
+	 */
+	public function init()
+	{
+		parent::init();
+
+		// prevent init of map if no query
+		$request = Controller::curr()->getRequest();
+		if (!$this->getTrigger($request)) {
+			return;
+		}
+
+		$locations = $this->getLocations();
+
+		// prevent init of map if there are no locations
+		if (!$locations) {
+			return;
+		}
+
+		// google maps api key
+		$key = Config::inst()->get(GoogleGeocoder::class, 'map_api_key');
+		Requirements::javascript('https://maps.google.com/maps/api/js?key=' . $key);
+
+		$mapSettings = [
+			'fullMapStart' => true,
+			'maxDistance' => true,
+			'storeLimit' => -1,
+			'originMarker' => true,
+			'slideMap' => false,
+			'distanceAlert' => -1,
+			'featuredLocations' => false,
+			'defaultLat' => 0,
+			'defaultLng' => 0,
+			'mapSettings' => [
+				'zoom' => Config::inst()->get(LocatorController::class, 'zoom'),
+				'minZoom' => Config::inst()->get(LocatorController::class, 'min_zoom'),
+				'maxZoom' => Config::inst()->get(LocatorController::class, 'max_zoom'),
+				'mapTypeId' => 'google.maps.MapTypeId.ROADMAP',
+				'disableDoubleClickZoom' => Config::inst()->get(LocatorController::class, 'disable_double_click_zoom'),
+				'scrollwheel' => Config::inst()->get(LocatorController::class, 'scrollwheel'),
+				'navigationControl' => Config::inst()->get(LocatorController::class, 'navigation_control'),
+				'draggable' => Config::inst()->get(LocatorController::class, 'draggable'),
+			],
+		];
+
+		$mapSettings['listTemplatePath'] = $this->getListTemplate();
+		$mapSettings['infowindowTemplatePath'] = $this->getInfoWindowTemplate();
+		$mapSettings['lengthUnit'] = $this->data()->Unit == 'km' ? 'km' : 'm';
+		$mapSettings['mapID'] = Config::inst()->get(LocatorController::class, 'map_container');
+		$mapSettings['locationList'] = Config::inst()->get(LocatorController::class, 'list_container');
+
+		if ($locations->filter('Featured', true)->count() > 0) {
+			$mapSettings['featuredLocations'] = true;
+		}
+
+		// map config based on user input in Settings tab
+		$limit = Config::inst()->get(LocatorController::class, 'limit');
+		if (0 < $limit) {
+			$mapSettings['storeLimit'] = $limit;
+		}
+
+		if ($coords = $this->getAddressSearchCoords()) {
+			$mapSettings['defaultLat'] = $coords->getField("Lat");
+			$mapSettings['defaultLat'] = $coords->getField("Lng");
+		}
+
+		// pass GET variables to xml action
+		$vars = $this->request->getVars();
+		unset($vars['url']);
+		$url = '';
+		if (count($vars)) {
+			$url .= '?' . http_build_query($vars);
+		}
+		$mapSettings['dataLocation'] = Controller::join_links($this->Link(), 'xml.xml', $url);
+
+		if ($stylePath = $this->getMapStyleJSONPath()) {
+			if ($style = file_get_contents($stylePath)) {
+				$mapSettings['mapSettings']['styles'] = json_decode($style);
+			}
+		}
+
+		if ($imagePath = $this->getMarkerIcon()) {
+			$mapSettings['markerImg'] = $imagePath;
+		}
+
+		$this->extend('modifyMapSettings', $mapSettings);
+
+		$encoded = json_encode($mapSettings, JSON_UNESCAPED_SLASHES);
+		// mapTypeId is a javascript object
+		$encoded = preg_replace('/("mapTypeId"\s*:\s*)"(.+?)"/i', '$1$2', $encoded);
+
+		$this->extend('modifyMapSettingsEncoded', $encoded);
+		// init map
+		Requirements::customScript("
                 $(function(){
                     $('#map-container').storeLocator({$encoded});
                 });
             ", 'jquery-locator');
-    }
-
-    /**
-     * @param HTTPRequest $request
-     *
-     * @return bool
-     */
-    public function getTrigger(HTTPRequest $request = null)
-    {
-        if ($request === null) {
-            $request = $this->getRequest();
-        }
-        return !empty($this->getRequest()->getVars()) || $this->data()->ResultsOnLoad;
-    }
-
-    /**
-     * @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 = $this->data()->config()->get('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);
-
-        $class = $this->data()->ClassName;
-        $locations = $class::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 = $this->data()->config()->get('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([
-            '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([
-            "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([
-            "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');
-
-        $this->extend('updateLocationSearch', $form);
-
-        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();
+		}
+		return !empty($this->getRequest()->getVars()) || $this->data()->ResultsOnLoad;
+	}
+
+	/**
+	 * @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 = $this->data()->config()->get('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);
+
+		$class = $this->data()->ClassName;
+		$locations = $class::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 = $this->data()->config()->get('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([
+			'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([
+			"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([
+			"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');
+
+		$this->extend('updateLocationSearch', $form);
+
+		return $form
+			->setFormMethod('GET')
+			->setFormAction($this->Link())
+			->disableSecurityToken()
+			->loadDataFrom($this->request->getVars());
+	}
 }