Locator_Controller - Code Metrics - Inspection of "Update composer.json" - dynamic/silverstripe-locator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.0 (#167)

by Jason

created 2017-06-21 03:02 UTC

Locator_Controller A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	319
Duplicated Lines	7.52 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	30
lcom	1
cbo	9
dl	24
loc	319
ccs	0
cts	126
cp	0
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getLocations()	0	7	2
B	setLocations()	0	56	9
A	getAddressSearchCoords()	0	12	2
C	init()	0	80	8
A	index()	12	12	2
A	xml()	12	12	2
A	getTrigger()	0	8	2
A	LocationSearch()	0	15	3

How to fix Duplicated Code

<?php

/**
 * Class Locator
 *
 * @property bool $AutoGeocode
 * @property bool $ModalWindow
 * @property string $Unit
 * @method Categories|ManyManyList $Categories
 */
class Locator extends Page
{

    /**
     * @var array
     */
    private static $db = array(
        'Unit' => 'Enum("m,km","m")',
    );

    /**
     * @var array
     */
    private static $many_many = array(
        'Categories' => 'LocationCategory',
    );

    /**
     * @var string
     */
    private static $singular_name = 'Locator';
    /**
     * @var string
     */
    private static $plural_name = 'Locators';
    /**
     * @var string
     */
    private static $description = 'Find locations on a map';

    /**
     * @var string
     */
    private static $location_class = 'Location';


    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        // Settings
        $fields->addFieldsToTab('Root.Settings', array(
            HeaderField::create('DisplayOptions', 'Display Options', 3),
            OptionsetField::create('Unit', 'Unit of measure', array('m' => 'Miles', 'km' => 'Kilometers')),
        ));

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

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

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

        return $fields;
    }

    /**
     * @param array $filter
     * @param array $filterAny
     * @param array $exclude
     * @param null|callable $callback
     * @return DataList|ArrayList
     */
    public static function get_locations(
        $filter = [],
        $filterAny = [],
        $exclude = [],
        $callback = null
    )
    {
        $locationClass = Config::inst()->get('Locator', '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)->Categories();
    }


}

/**
 * Class Locator_Controller
 */
class Locator_Controller extends Page_Controller

{
    /**
     * @var array
     */
    private static $allowed_actions = array(
        'xml',
    );

    /**
     * @var array
     */
    private static $base_filter = [];


    /**
     * @var array
     */
    private static $base_exclude = [

        'Lat' => 0,
        'Lng' => 0,
    ];

    /**
     * @var array
     */
    private static $base_filter_any = [];


    /**
     * @var string
     */
    private static $list_template_path = 'locator/templates/location-list-description.html';


    /**
     * @var string
     */
    private static $info_window_template_path = 'locator/templates/infowindow-description.html';


    /**
     * @var bool
     */
    private static $bootstrapify = true;


    /**
     * @var int
     */
    private static $limit = 50;


    /**
     * 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();

        // prevent init of map if no query
        $request = Controller::curr()->getRequest();
        if ($this->getTrigger($request)) {
            // google maps api key
            $key = Config::inst()->get('GoogleGeocoding', 'google_api_key');

            $locations = $this->getLocations();

            if ($locations) {

                Requirements::css('locator/css/map.css');
                Requirements::javascript('framework/thirdparty/jquery/jquery.js');
                Requirements::javascript('https://maps.google.com/maps/api/js?key=' . $key);
                Requirements::javascript('locator/thirdparty/jquery-store-locator-plugin/assets/js/libs/handlebars.min.js');
                Requirements::javascript('locator/thirdparty/jquery-store-locator-plugin/assets/js/plugins/storeLocator/jquery.storelocator.js');

                $featuredInList = ($locations->filter('Featured', true)->count() > 0);
                $defaultCoords = $this->getAddressSearchCoords() ? $this->getAddressSearchCoords() : '';

                $featured = $featuredInList
                    ? 'featuredLocations: true'
                    : 'featuredLocations: false';

                // map config based on user input in Settings tab
                $limit = Config::inst()->get('Locator_Controller', 'limit');
                if ($limit < 1) $limit = -1;
                $load = 'fullMapStart: true, storeLimit: ' . $limit . ', maxDistance: true,';

                $listTemplatePath = Config::inst()->get('Locator_Controller', 'list_template_path');
                $infowindowTemplatePath = Config::inst()->get('Locator_Controller', 'info_window_template_path');

                $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('Locator_Controller', 'map_container');
                $list_class = Config::inst()->get('Locator_Controller', 'list_container');

                // init map
                Requirements::customScript("
                $(function(){
                    $('#map-container').storeLocator({
                        " . $load . "
                        dataLocation: '" . $link . "',
                        listTemplatePath: '" . $listTemplatePath . "',
                        infowindowTemplatePath: '" . $infowindowTemplatePath . "',
                        originMarker: true,
                        " . $featured . ",
                        slideMap: false,
                        distanceAlert: -1,
                        " . $kilometer . ",
                        " . $defaultCoords . "
                        mapID: '" . $map_id . "',
                        locationList: '" . $list_class . "',
                        mapSettings: {
							zoom: 12,
							mapTypeId: google.maps.MapTypeId.ROADMAP,
							disableDoubleClickZoom: true,
							scrollwheel: false,
							navigationControl: false,
							draggable: false
						}
                    });
                });
            ", "locator_map_init_script");
            }
        }
    }

    /**
     * @param SS_HTTPRequest $request
     *
     * @return ViewableData_Customised
     */
    public function index(SS_HTTPRequest $request)

    {
        if ($this->getTrigger($request)) {
            $locations = $this->getLocations();
        } else {
            $locations = ArrayList::create();
        }

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

    /**
     * Return a XML feed of all locations marked "show in locator"
     *
     * @param SS_HTTPRequest $request
     * @return HTMLText
     */
    public function xml(SS_HTTPRequest $request)

    {
        if ($this->getTrigger($request)) {
            $locations = $this->getLocations();
        } else {
            $locations = ArrayList::create();
        }

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

    /**
     * @return ArrayList|DataList
     */
    public function getLocations()
    {
        if (!$this->locations) {
            $this->setLocations($this->request);
        }
        return $this->locations;
    }

    /**
     * @param SS_HTTPRequest|null $request
     * @return $this
     */
    public function setLocations(SS_HTTPRequest $request = null)
    {

        if ($request === null) {
            $request = $this->request;
        }
        $filter = $this->config()->get('base_filter');

        if ($request->getVar('CategoryID')) {
            $filter['CategoryID'] = $request->getVar('CategoryID');
        } else {
            if ($this->getPageCategories()->exists()) {
                foreach ($this->getPageCategories() as $category) {
                    $filter['CategoryID'][] = $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);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        //allow for adjusting list post possible distance calculation
        $this->extend('updateLocationList', $locations);

        if ($locations->canSortBy('distance')) {
            $locations = $locations->sort('distance');
        }

        if (Config::inst()->get('LocatorForm', 'show_radius')) {
            if ($radius = (int)$request->getVar('Radius')) {
$x = 1;
$callable = function() use ($x) {
    $x = 2; // Not visible in outer scope. If you would like this, how
            // about using a different variable name than $x?
};

$callable();
var_dump($x); // integer(1)
                $locations = $locations->filterByCallback(function ($location) use (&$radius) {
                    return $location->distance <= $radius;
                });
            }
        }

        //allow for returning list to be set as
        $this->extend('updateListType', $locations);

        $limit = Config::inst()->get('Locator_Controller', 'limit');
        if ($limit > 0) {
            $locations = $locations->limit($limit);
        }

        $this->locations = $locations;
        return $this;

    }

    /**
     * @param SS_HTTPRequest $request
     * @return bool
     */
    public function getTrigger(SS_HTTPRequest $request = null)
    {
        if ($request === null) {
            $request = $this->getRequest();
        }
        $trigger = $request->getVar(Config::inst()->get('Locator_Controller', 'query_trigger'));
        return isset($trigger);
    }

    /**
     * @return bool|string
     */
    public function getAddressSearchCoords()
    {
        if (!$this->request->getVar('Address')) {
            return false;
        }
        $coords = GoogleGeocoding::address_to_point(Controller::curr()->getRequest()->getVar('Address'));

        $lat = $coords['lat'];
        $lng = $coords['lng'];

        return "defaultLat: {$lat}, defaultLng: {$lng},";
    }

    /**
     * LocationSearch form.
     *
     * Search form for locations, updates map and results list via AJAX
     *
     * @return Form
     */
    public function LocationSearch()
    {

        $form = LocatorForm::create($this, 'LocationSearch');
        if (class_exists('BootstrapForm') && $this->config()->get('bootstrapify')) {
            $form->Fields()->bootstrapify();
            $form->Actions()->bootstrapify();
        }

        return $form
            ->setFormMethod('GET')
            ->setFormAction($this->Link())
            ->disableSecurityToken()
            ->loadDataFrom($this->request->getVars());
    }

}


Pull Request — 2.0 (#167)

Locator_Controller A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

8 Methods

How to fix Duplicated Code

Duplicated Code

Change not visible in outer-scope

Change visible in outer-scope

1		<?php
2
3		/**
4		* Class Locator
5		*
6		* @property bool $AutoGeocode
7		* @property bool $ModalWindow
8		* @property string $Unit
9		* @method Categories\|ManyManyList $Categories
10		*/
11		class Locator extends Page
12		{
13
14		/**
15		* @var array
16		*/
17		private static $db = array(
18		'Unit' => 'Enum("m,km","m")',
19		);
20
21		/**
22		* @var array
23		*/
24		private static $many_many = array(
25		'Categories' => 'LocationCategory',
26		);
27
28		/**
29		* @var string
30		*/
31		private static $singular_name = 'Locator';
32		/**
33		* @var string
34		*/
35		private static $plural_name = 'Locators';
36		/**
37		* @var string
38		*/
39		private static $description = 'Find locations on a map';
40
41		/**
42		* @var string
43		*/
44		private static $location_class = 'Location';
		0 ignored issues – show Unused Code introduced 2016-10-13 15:59 UTC by Report Bug Copy Issue Report The property `$location_class` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
45
46		/**
47		* @return FieldList
48		*/
49		public function getCMSFields()
50		{
51		$fields = parent::getCMSFields();
52
53		// Settings
54		$fields->addFieldsToTab('Root.Settings', array(
55		HeaderField::create('DisplayOptions', 'Display Options', 3),
56		OptionsetField::create('Unit', 'Unit of measure', array('m' => 'Miles', 'km' => 'Kilometers')),
57		));
58
59		// Filter categories
60		$config = GridFieldConfig_RelationEditor::create();
61		if (class_exists('GridFieldAddExistingSearchButton')) {
62		$config->removeComponentsByType('GridFieldAddExistingAutocompleter');
63		$config->addComponent(new GridFieldAddExistingSearchButton());
64		}
65		$categories = $this->Categories();
66		$categoriesField = GridField::create('Categories', 'Categories', $categories, $config)
67		->setDescription('only show locations from the selected category');
68
69		// Filter
70		$fields->addFieldsToTab('Root.Filter', array(
71		HeaderField::create('CategoryOptionsHeader', 'Location Filtering', 3),
72		$categoriesField,
73		));
74
75		$this->extend('updateCMSFields', $fields);
76
77		return $fields;
78		}
79
80		/**
81		* @param array $filter
82		* @param array $filterAny
83		* @param array $exclude
84		* @param null\|callable $callback
85		* @return DataList\|ArrayList
86		*/
87		public static function get_locations(
88		$filter = [],
89		$filterAny = [],
90		$exclude = [],
91		$callback = null
92		)
93		{
94		$locationClass = Config::inst()->get('Locator', 'location_class');
95		$locations = $locationClass::get()->filter($filter)->exclude($exclude);
96
97		if (!empty($filterAny)) {
98		$locations = $locations->filterAny($filterAny);
99		}
100		if (!empty($exclude)) {
101		$locations = $locations->exclude($exclude);
102		}
103
104		if ($callback !== null && is_callable($callback)) {
105		$locations->filterByCallback($callback);
106		}
107
108		return $locations;
109		}
110
111		/**
112		* @return DataList
113		*/
114		public static function get_all_categories()
115		{
116		return LocationCategory::get();
117		}
118
119		/**
120		* @return bool
121		*/
122		public function getPageCategories()
123		{
124		return self::locator_categories_by_locator($this->ID);
125		}
126
127		/**
128		* @param int $id
129		* @return bool\|
130		*/
131		public static function locator_categories_by_locator($id = 0)
132		{
133		if ($id == 0) {
134		return false;
135		}
136
137		return Locator::get()->byID($id)->Categories();
138		}
139
140
141		}
142
143		/**
144		* Class Locator_Controller
145		*/
146		class Locator_Controller extends Page_Controller
		0 ignored issues – show Coding Style Compatibility introduced 2016-03-15 20:52 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
147		{
148		/**
149		* @var array
150		*/
151		private static $allowed_actions = array(
152		'xml',
153		);
154
155		/**
156		* @var array
157		*/
158		private static $base_filter = [];
		0 ignored issues – show Unused Code introduced 2016-08-01 16:34 UTC by Report Bug Copy Issue Report The property `$base_filter` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
159
160		/**
161		* @var array
162		*/
163		private static $base_exclude = [
		0 ignored issues – show Unused Code introduced 2016-08-01 16:34 UTC by Report Bug Copy Issue Report The property `$base_exclude` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
164		'Lat' => 0,
165		'Lng' => 0,
166		];
167
168		/**
169		* @var array
170		*/
171		private static $base_filter_any = [];
		0 ignored issues – show Unused Code introduced 2016-08-01 16:34 UTC by Report Bug Copy Issue Report The property `$base_filter_any` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
172
173		/**
174		* @var string
175		*/
176		private static $list_template_path = 'locator/templates/location-list-description.html';
		0 ignored issues – show Unused Code introduced 2016-08-03 21:32 UTC by Report Bug Copy Issue Report The property `$list_template_path` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
177
178		/**
179		* @var string
180		*/
181		private static $info_window_template_path = 'locator/templates/infowindow-description.html';
		0 ignored issues – show Unused Code introduced 2016-08-03 21:32 UTC by Report Bug Copy Issue Report The property `$info_window_template_path` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
182
183		/**
184		* @var bool
185		*/
186		private static $bootstrapify = true;
		0 ignored issues – show Unused Code introduced 2016-08-12 19:39 UTC by Report Bug Copy Issue Report The property `$bootstrapify` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
187
188		/**
189		* @var int
190		*/
191		private static $limit = 50;
		0 ignored issues – show Unused Code introduced 2017-03-17 20:00 UTC by Report Bug Copy Issue Report The property `$limit` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
192
193		/**
194		* ID of map container
195		*
196		* @var string
197		*/
198		private static $map_container = 'map';
		0 ignored issues – show Unused Code introduced 2017-03-17 20:00 UTC by Report Bug Copy Issue Report The property `$map_container` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
199
200		/**
201		* class of location list container
202		*
203		* @var string
204		*/
205		private static $list_container = 'loc-list';
		0 ignored issues – show Unused Code introduced 2017-03-17 20:00 UTC by Report Bug Copy Issue Report The property `$list_container` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
206
207		/**
208		* GET variable which, if isset, will trigger storeLocator init and return XML
209		*
210		* @var string
211		*/
212		private static $query_trigger = 'action_doFilterLocations';
		0 ignored issues – show Unused Code introduced 2017-03-17 20:00 UTC by Report Bug Copy Issue Report The property `$query_trigger` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
213
214		/**
215		* @var DataList\|ArrayList
216		*/
217		protected $locations;
218
219		/**
220		* Set Requirements based on input from CMS
221		*/
222		public function init()
223		{
224		parent::init();
225
226		// prevent init of map if no query
227		$request = Controller::curr()->getRequest();
228		if ($this->getTrigger($request)) {
229		// google maps api key
230		$key = Config::inst()->get('GoogleGeocoding', 'google_api_key');
231
232		$locations = $this->getLocations();
233
234		if ($locations) {
235
236		Requirements::css('locator/css/map.css');
237		Requirements::javascript('framework/thirdparty/jquery/jquery.js');
238		Requirements::javascript('https://maps.google.com/maps/api/js?key=' . $key);
239		Requirements::javascript('locator/thirdparty/jquery-store-locator-plugin/assets/js/libs/handlebars.min.js');
240		Requirements::javascript('locator/thirdparty/jquery-store-locator-plugin/assets/js/plugins/storeLocator/jquery.storelocator.js');
241
242		$featuredInList = ($locations->filter('Featured', true)->count() > 0);
243		$defaultCoords = $this->getAddressSearchCoords() ? $this->getAddressSearchCoords() : '';
244
245		$featured = $featuredInList
246		? 'featuredLocations: true'
247		: 'featuredLocations: false';
248
249		// map config based on user input in Settings tab
250		$limit = Config::inst()->get('Locator_Controller', 'limit');
251		if ($limit < 1) $limit = -1;
252		$load = 'fullMapStart: true, storeLimit: ' . $limit . ', maxDistance: true,';
253
254		$listTemplatePath = Config::inst()->get('Locator_Controller', 'list_template_path');
255		$infowindowTemplatePath = Config::inst()->get('Locator_Controller', 'info_window_template_path');
256
257		$kilometer = ($this->data()->Unit == 'km') ? "lengthUnit: 'km'" : "lengthUnit: 'm'";
258
259		// pass GET variables to xml action
260		$vars = $this->request->getVars();
261		unset($vars['url']);
262		$url = '';
263		if (count($vars)) {
264		$url .= '?' . http_build_query($vars);
265		}
266		$link = Controller::join_links($this->Link(), 'xml.xml', $url);
267
268		// containers
269		$map_id = Config::inst()->get('Locator_Controller', 'map_container');
270		$list_class = Config::inst()->get('Locator_Controller', 'list_container');
271
272		// init map
273		Requirements::customScript("
274		$(function(){
275		$('#map-container').storeLocator({
276		" . $load . "
277		dataLocation: '" . $link . "',
278		listTemplatePath: '" . $listTemplatePath . "',
279		infowindowTemplatePath: '" . $infowindowTemplatePath . "',
280		originMarker: true,
281		" . $featured . ",
282		slideMap: false,
283		distanceAlert: -1,
284		" . $kilometer . ",
285		" . $defaultCoords . "
286		mapID: '" . $map_id . "',
287		locationList: '" . $list_class . "',
288		mapSettings: {
289		zoom: 12,
290		mapTypeId: google.maps.MapTypeId.ROADMAP,
291		disableDoubleClickZoom: true,
292		scrollwheel: false,
293		navigationControl: false,
294		draggable: false
295		}
296		});
297		});
298		", "locator_map_init_script");
299		}
300		}
301		}
302
303		/**
304		* @param SS_HTTPRequest $request
305		*
306		* @return ViewableData_Customised
307		*/
308	View Code Duplication	public function index(SS_HTTPRequest $request)
		0 ignored issues – show Duplication introduced 2016-08-03 21:32 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
309		{
310		if ($this->getTrigger($request)) {
311		$locations = $this->getLocations();
312		} else {
313		$locations = ArrayList::create();
314		}
315
316		return $this->customise(array(
317		'Locations' => $locations,
318		));
319		}
320
321		/**
322		* Return a XML feed of all locations marked "show in locator"
323		*
324		* @param SS_HTTPRequest $request
325		* @return HTMLText
326		*/
327	View Code Duplication	public function xml(SS_HTTPRequest $request)
		0 ignored issues – show Duplication introduced 2016-08-03 21:32 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
328		{
329		if ($this->getTrigger($request)) {
330		$locations = $this->getLocations();
331		} else {
332		$locations = ArrayList::create();
333		}
334
335		return $this->customise(array(
336		'Locations' => $locations,
337		))->renderWith('LocationXML');
338		}
339
340		/**
341		* @return ArrayList\|DataList
342		*/
343		public function getLocations()
344		{
345		if (!$this->locations) {
346		$this->setLocations($this->request);
347		}
348		return $this->locations;
349		}
350
351		/**
352		* @param SS_HTTPRequest\|null $request
353		* @return $this
354		*/
355		public function setLocations(SS_HTTPRequest $request = null)
356		{
357
358		if ($request === null) {
359		$request = $this->request;
360		}
361		$filter = $this->config()->get('base_filter');
362
363		if ($request->getVar('CategoryID')) {
364		$filter['CategoryID'] = $request->getVar('CategoryID');
365		} else {
366		if ($this->getPageCategories()->exists()) {
367		foreach ($this->getPageCategories() as $category) {
368		$filter['CategoryID'][] = $category->ID;
369		}
370		}
371		}
372
373		$this->extend('updateLocatorFilter', $filter, $request);
374
375		$filterAny = $this->config()->get('base_filter_any');
376		$this->extend('updateLocatorFilterAny', $filterAny, $request);
377
378		$exclude = $this->config()->get('base_exclude');
379		$this->extend('updateLocatorExclude', $exclude, $request);
380
381		$locations = Locator::get_locations($filter, $filterAny, $exclude);
382		$locations = DataToArrayListHelper::to_array_list($locations);
		0 ignored issues – show Bug introduced 2016-08-03 21:38 UTC by Report Bug Copy Issue Report It seems like `$locations` defined by `\DataToArrayListHelper::to_array_list($locations)` on line `382` can also be of type `object<ArrayList>`; however, `DataToArrayListHelper::to_array_list()` does only seem to accept `object<DataList>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
383
384		//allow for adjusting list post possible distance calculation
385		$this->extend('updateLocationList', $locations);
386
387		if ($locations->canSortBy('distance')) {
388		$locations = $locations->sort('distance');
389		}
390
391		if (Config::inst()->get('LocatorForm', 'show_radius')) {
392		if ($radius = (int)$request->getVar('Radius')) {
		0 ignored issues – show Bug introduced 2017-03-17 20:00 UTC by Report Bug Copy Issue Report Consider using a different name than the imported variable `$radius`, or did you forget to import by reference? It seems like you are assigning to a variable which was imported through a `use` statement which was not imported by reference. For clarity, we suggest to use a different name or import by reference depending on whether you would like to have the change visibile in outer-scope. Change not visible in outer-scope $x = 1; $callable = function() use ($x) { $x = 2; // Not visible in outer scope. If you would like this, how // about using a different variable name than $x? }; $callable(); var_dump($x); // integer(1) Change visible in outer-scope $x = 1; $callable = function() use (&$x) { $x = 2; }; $callable(); var_dump($x); // integer(2) Loading history...
393		$locations = $locations->filterByCallback(function ($location) use (&$radius) {
394		return $location->distance <= $radius;
395		});
396		}
397		}
398
399		//allow for returning list to be set as
400		$this->extend('updateListType', $locations);
401
402		$limit = Config::inst()->get('Locator_Controller', 'limit');
403		if ($limit > 0) {
404		$locations = $locations->limit($limit);
405		}
406
407		$this->locations = $locations;
408		return $this;
409
410		}
411
412		/**
413		* @param SS_HTTPRequest $request
414		* @return bool
415		*/
416		public function getTrigger(SS_HTTPRequest $request = null)
417		{
418		if ($request === null) {
419		$request = $this->getRequest();
420		}
421		$trigger = $request->getVar(Config::inst()->get('Locator_Controller', 'query_trigger'));
422		return isset($trigger);
423		}
424
425		/**
426		* @return bool\|string
427		*/
428		public function getAddressSearchCoords()
429		{
430		if (!$this->request->getVar('Address')) {
431		return false;
432		}
433		$coords = GoogleGeocoding::address_to_point(Controller::curr()->getRequest()->getVar('Address'));
434
435		$lat = $coords['lat'];
436		$lng = $coords['lng'];
437
438		return "defaultLat: {$lat}, defaultLng: {$lng},";
439		}
440
441		/**
442		* LocationSearch form.
443		*
444		* Search form for locations, updates map and results list via AJAX
445		*
446		* @return Form
447		*/
448		public function LocationSearch()
449		{
450
451		$form = LocatorForm::create($this, 'LocationSearch');
452		if (class_exists('BootstrapForm') && $this->config()->get('bootstrapify')) {
453		$form->Fields()->bootstrapify();
454		$form->Actions()->bootstrapify();
455		}
456
457		return $form
458		->setFormMethod('GET')
459		->setFormAction($this->Link())
460		->disableSecurityToken()
461		->loadDataFrom($this->request->getVars());
462		}
463
464		}
465

dynamic / silverstripe-locator

Pull Request — 2.0 (#167)

Locator_Controller A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

8 Methods

How to fix Duplicated Code

Duplicated Code

Change not visible in outer-scope

Change visible in outer-scope

Duplication Side-by-Side

Filter issues like