PointsOfInterestLayerExtension - Code Metrics - Inspection of "FIX: Use the extension points in MapExtension in o..." - gordonbanderson/MappablePointsOfInterest - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3.1 ( 97d1e4...fde6df )

by Gordon

created 2016-01-05 10:01 UTC

PointsOfInterestLayerExtension A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Metric	Value
wmc	11
lcom	1
cbo	5
dl	0
loc	70
ccs	12
cts	12
cp	1
rs	10

3 Methods

Rating	Name	Size	Complexity
A	updateHasGeo()	5	2
A	updateCMSFields()	14	1
C	updateBasicMap()	22	8

<?php

class PointsOfInterestLayerExtension extends DataExtension
{
    public static $many_many = array(
        'PointsOfInterestLayers' => 'PointsOfInterestLayer',
    );

    public static $belongs_many_many_extraFields = array(
        'PointsOfInterestLayers' => array(
            'SortOrder' => 'Int',
        ),
    );

    /**
     * Only set has geo to true if layers exist
     * @param  boolean &$hasGeo will be set to true if any layers
     */
    public function updateHasGeo(&$hasGeo) {

        if ($this->owner->PointsOfInterestLayers()->count() > 0) {
            $result = true;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        }
    }

    /**
     * Update cms fields - add list of POIs.
     *
     * @param FieldList $fields list of existing fields on the object
     */
    public function updateCMSFields(FieldList $fields)
    {
        $gridConfig2 = GridFieldConfig_RelationEditor::create();
        $gridConfig2->getComponentByType(
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            'GridFieldAddExistingAutocompleter')->
            setSearchFields(array('Name')
        );

        $gridConfig2->getComponentByType('GridFieldPaginator')->setItemsPerPage(100);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $gridField2 = new GridField('POI Layers', 'POI Layers:',
            $this->owner->PointsOfInterestLayers(),
            $gridConfig2
        );
        $fields->addFieldToTab('Root.MapLayers', $gridField2);
    }

    /**
     * Use extension point to add the markers
     * @param  MapAPI &$map reference to object representing the map
     * @param  $autozoom will be altered to true for autozoom, false not to
     */
    public function updateBasicMap(&$map, &$autozoom) {
        if (Object::has_extension($this->owner->ClassName, 'PointsOfInterestLayerExtension')) {
            foreach($this->owner->PointsOfInterestLayers() as $layer) {

                $layericon = $layer->DefaultIcon();
                if ($layericon->ID === 0) {
                    $layericon = null;
                }
                foreach ($layer->PointsOfInterest() as $poi) {
                    if ($poi->MapPinEdited) {
                        if ($poi->MapPinIconID == 0 && $layericon) {
                            $poi->CachedMapPinURL = $layericon->getAbsoluteURL();
                        }
                        $map->addMarkerAsObject($poi);

                        // we have a point of interest, so turn on auto zoom
                        $autozoom = true;
                    }
                }
            }
            $map->setClusterer(true);
        }
    }
}


1		<?php
2
3		class PointsOfInterestLayerExtension extends DataExtension
4		{
5		public static $many_many = array(
6		'PointsOfInterestLayers' => 'PointsOfInterestLayer',
7		);
8
9		public static $belongs_many_many_extraFields = array(
10		'PointsOfInterestLayers' => array(
11		'SortOrder' => 'Int',
12		),
13		);
14
15		/**
16		* Only set has geo to true if layers exist
17		* @param boolean &$hasGeo will be set to true if any layers
18		*/
19		public function updateHasGeo(&$hasGeo) {
		0 ignored issues – show Unused Code introduced 2016-01-05 10:15 UTC by Report Bug Copy Issue Report The parameter `$hasGeo` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
20	2	if ($this->owner->PointsOfInterestLayers()->count() > 0) {
21		$result = true;
		0 ignored issues – show Unused Code introduced 2016-01-05 10:15 UTC by Report Bug Copy Issue Report `$result` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
22	2	}
23	2	}
24	2
25	2	/**
26	2	* Update cms fields - add list of POIs.
27	2	*
28	2	* @param FieldList $fields list of existing fields on the object
29	2	*/
30		public function updateCMSFields(FieldList $fields)
31	2	{
32	2	$gridConfig2 = GridFieldConfig_RelationEditor::create();
33	2	$gridConfig2->getComponentByType(
		0 ignored issues – show Bug introduced 2015-12-27 15:16 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `GridFieldComponent` as the method `setSearchFields()` does only exist in the following implementations of said interface: `GridFieldAddExistingAutocompleter`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
34		'GridFieldAddExistingAutocompleter')->
35		setSearchFields(array('Name')
36		);
		0 ignored issues – show Coding Style introduced 2016-01-05 07:26 UTC by Report Bug Copy Issue Report It seems like the identation of this line is off (expected at least 12 spaces, but found 8). Loading history...
37		$gridConfig2->getComponentByType('GridFieldPaginator')->setItemsPerPage(100);
		0 ignored issues – show Bug introduced 2015-12-27 15:16 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `GridFieldComponent` as the method `setItemsPerPage()` does only exist in the following implementations of said interface: `GridFieldPaginator`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
38		$gridField2 = new GridField('POI Layers', 'POI Layers:',
39		$this->owner->PointsOfInterestLayers(),
40		$gridConfig2
41		);
42		$fields->addFieldToTab('Root.MapLayers', $gridField2);
43		}
44
45		/**
46		* Use extension point to add the markers
47		* @param MapAPI &$map reference to object representing the map
48		* @param $autozoom will be altered to true for autozoom, false not to
49		*/
50		public function updateBasicMap(&$map, &$autozoom) {
51		if (Object::has_extension($this->owner->ClassName, 'PointsOfInterestLayerExtension')) {
52		foreach($this->owner->PointsOfInterestLayers() as $layer) {
		0 ignored issues – show Coding Style introduced 2016-01-05 10:15 UTC by Report Bug Copy Issue Report Expected 1 space after FOREACH keyword; 0 found Loading history...
53		$layericon = $layer->DefaultIcon();
54		if ($layericon->ID === 0) {
55		$layericon = null;
56		}
57		foreach ($layer->PointsOfInterest() as $poi) {
58		if ($poi->MapPinEdited) {
59		if ($poi->MapPinIconID == 0 && $layericon) {
60		$poi->CachedMapPinURL = $layericon->getAbsoluteURL();
61		}
62		$map->addMarkerAsObject($poi);
63
64		// we have a point of interest, so turn on auto zoom
65		$autozoom = true;
66		}
67		}
68		}
69		$map->setClusterer(true);
70		}
71		}
72		}
73

gordonbanderson / MappablePointsOfInterest

Push — 3.1 ( 97d1e4...fde6df )

PointsOfInterestLayerExtension A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

3 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like