BrowseCitiesPage - Code Metrics - sunnysideup/silverstripe-geobrowser - Measure and Improve Code Quality continuously with Scrutinizer

BrowseCitiesPage B
last analyzed 2018-03-20 01:16 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	281
Duplicated Lines	14.23 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

Metric	Value
wmc	44
lcom	1
cbo	10
dl	40
loc	281
rs	8.3396
c	0
b	0
f	0

7 Methods

Rating	Name	Duplication	Size	Complexity
D	get_clostest_city_page()	0	57	15
A	radiusDefinitionOtherTable()	0	5	2
A	GeoLevelName()	0	4	1
A	GeoLevelNumber()	0	4	1
C	create_city_and_parents()	40	84	12
B	requireDefaultRecords()	0	17	6
C	CreateCity()	0	40	7

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like BrowseCitiesPage often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use BrowseCitiesPage, and based on these observations, apply Extract Interface, too.

<?php

class BrowseCitiesPage extends BrowseAbstractPage
namespace YourVendor;

class YourClass { }
{

    /**
     * Standard SS static
     **/
    public static $icon = "geobrowser/images/treeicons/BrowseCitiesPage";

    /**
     * Standard SS static
     **/
    public static $default_parent = "BrowseRegionsPage";

    /**
     * Standard SS static
     **/
    public static $can_be_root = false;

    /**
     * Standard SS static
     **/
    public static $db = array(
        "Latitude" => "Double",
        "Longitude" => "Double",
        "TimeZone"=> "Varchar(10)",
        "County" => "Varchar(25)",
        "Code" => "Varchar(4)",
    );

    /**
     * Standard SS Static
     **/
    public static $defaults = array(
        "ShowInMenus" => false
    );
    
    /**
     * @param Array - $googleMapAddressArray: an array of geographic data provided by google maps
     * @param Int - $maxRadius: maximum number of kilometers (as the bird flies) between search point defined in $googleMapAddressArray and city found.
     * @return Object | false : returns a BrowseCitiesPage or false if nothing was found

     **/
    public static function get_clostest_city_page($googleMapAddressArray, $maxRadius = 500)
    {
        $cityPage = null;
        $suburbPage    = null;
        $bt = defined('DB::USE_ANSI_SQL') ? "\"" : "`";
        $existingDistance = $maxRadius+1;
        $newDistance = $maxRadius+1;
        $existingPage = null;
        $newPage = null;
        $radiusSelectionSQL = self::radiusDefinitionOtherTable($googleMapAddressArray[0], $googleMapAddressArray[1], "BrowseCitiesPage", "Latitude", "Longitude");
        $sqlQuery = new SQLQuery();

        $sqlQuery->select = array("{$bt}BrowseCitiesPage{$bt}.{$bt}ID{$bt}, ". $radiusSelectionSQL." as distance");
        $sqlQuery->from[] = "{$bt}BrowseCitiesPage{$bt}";
        $sqlQuery->where[] = $radiusSelectionSQL . " < ".$maxRadius;
        $sqlQuery->orderby = " distance ";
        $sqlQuery->limit = "1";

        $result = $sqlQuery->execute();
        $page = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        foreach ($result as $row) {
            $existingDistance = $row["distance"];
            $existingPage = DataObject::get_by_id("BrowseCitiesPage", $row["ID"]);
        }
        $radiusSelectionSQL = self::radiusDefinitionOtherTable($googleMapAddressArray[0], $googleMapAddressArray[1], "cities", "Latitude", "Longitude");
        $sqlQuery = new SQLQuery();

        $sqlQuery->select = array("cities.CityID", $radiusSelectionSQL." as distance");
        $sqlQuery->from[] = "{$bt}cities{$bt}";
        $sqlQuery->where[] = $radiusSelectionSQL . " < ".$maxRadius;
        $sqlQuery->orderby = " distance ";
        $sqlQuery->limit = "1";
        $result = $sqlQuery->execute();
        foreach ($result as $row) {
            $sameOne = false;
            if ($existingPage) {
                if ($row["CityID"] == $existingPage->HiddenDataID) {
                    $sameOne = true;
                }
            }
            if (!$sameOne) {
                $newPage = self::create_city_and_parents($row["CityID"]);
                $newDistance = $row["distance"];
            }
        }
        if (($newPage) && ($newDistance < $existingDistance) &&  ($newDistance < $maxRadius)) {
            $cityPage = $newPage;
        } elseif ($existingPage && $existingDistance < $maxRadius) {
            $cityPage = $existingPage;
        }
        if ($cityPage) {
            if ($cityPage->allowBrowseChildren()) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                $suburbPage = BrowseSuburbPage::create_suburb($googleMapAddressArray, $cityPage);
            }
        }
        if ($suburbPage) {
            return $suburbPage;
        }
        return $cityPage;
    }

    /**
     * formulae for working out distance
     **/
    protected static function radiusDefinitionOtherTable($lon, $lat, $table, $latitudeField, $longitudeField)
    {
        $bt = defined('DB::USE_ANSI_SQL') ? "\"" : "`";
        return "(6378.137 * ACOS( ( SIN( PI( ) * ".$lat." /180 ) * SIN( PI( ) * {$bt}".$table."{$bt}.{$bt}".$latitudeField."{$bt} /180 ) ) + ( COS( PI( ) * ".$lat." /180 ) * cos( PI( ) * {$bt}".$table."{$bt}.{$bt}".$latitudeField."{$bt} /180 ) * COS( (PI( ) * {$bt}".$table."{$bt}.{$bt}".$longitudeField."{$bt} /180 ) - ( PI( ) *".$lon." /180 ) ) ) ) ) ";
    }

    /**
     * name for page level.
     **/
    public function GeoLevelName()
    {
        return "Cities";
    }
    
    /**
     * number for page level.
     **/
    public function GeoLevelNumber()
    {
        return 3;
    }
    
    /**
     * This static method creates a city page and all the required parent pages...
     *@param Int - $CityID: the ID for the city to create
     **/
    public static function create_city_and_parents($CityID)
    {
        $cityPage = null;
        //check if the city exists at all
        $sql = '
			SELECT cities.RegionID, regions.CountryID, countries.ContinentID From cities, regions, countries, continents
			WHERE
				cities.RegionID = regions.RegionID AND
				regions.CountryID = countries.CountryID AND
				countries.ContinentID = continents.ContinentID AND
				cities.CityID = '.$CityID.'
			LIMIT 1;';
        $result = DB::query($sql);

        foreach ($result as $row) {
            break;
        }
        $abstractHelpPage = new BrowseAbstractPage();
        if ($row) {

            //1 check if world exists
            if ($worldPage = DataObject::get_one("BrowseWorldPage")) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
                //do nothing
            } else {
                $worldPage = new BrowseWorldPage();
                $name = "Find";
                $worldPage->Title = $name;
                $worldPage->MetaTitle = $name;
                $worldPage->MenuTitle = $name;
                $worldPage->writeToStage('Stage');
                $worldPage->publish('Stage', 'Live');
                $worldPage->flushCache();
            }

            //2 check if continent exists
            $ContinentID = $row["ContinentID"];
foreach ($a as $b) {
}

// $b is defined here only if $a has elements, for example if $a is array()
// then $b would not be defined here. To avoid that, we recommend to set a
// default value for $b.


// Better
$b = 0; // or whatever default makes sense in your context
foreach ($a as $b) {
}

// $b is now guaranteed to be defined here.
            if ($continentPage = DataObject::get_one("BrowseContinentsPage", 'HiddenDataID = '.$ContinentID)) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
                //debug::show("continent exists");

            } else {
                //create continent
                $continents = $abstractHelpPage->getDataFromTable("continents", "ContinentID = ".$ContinentID, null);
                foreach ($continents as $continentData) {
                    $continentPage = new BrowseContinentsPage();
                    $continentPage->CreateContinent($continentData, $worldPage);
                }
            }

            //3 check if country exists
            $CountryID = $row["CountryID"];
            if ($countryPage = DataObject::get_one("BrowseCountriesPage", 'HiddenDataID = '.$CountryID)) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
                //debug::show("country exists");

            } else {
                //create Country
                $countries = $abstractHelpPage->getDataFromTable("countries", "CountryID = ".$CountryID, null);
                foreach ($countries as $countryData) {
                    $countryPage = new BrowseCountriesPage();
                    $countryPage->CreateCountry($countryData, $continentPage);
                }
            }

            //4 check if region exists
            $RegionID = $row["RegionID"];
            if ($regionPage = DataObject::get_one("BrowseRegionsPage", 'HiddenDataID = '.$RegionID)) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
                //debug::show("region exists");

            } else {
                //create region
                $regions = $abstractHelpPage->getDataFromTable("regions", "RegionID = ".$RegionID, null);
                foreach ($regions as $regionData) {
                    $regionPage = new BrowseRegionsPage();
                    $regionPage->CreateRegion($regionData, $countryPage);
                }
            }
            if ($cityPage = DataObject::get_one("BrowseCitiesPage", 'HiddenDataID = '.$CityID)) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
                //debug::show("city exists");

            } else {
                //create region
                $cities = $abstractHelpPage->getDataFromTable("cities", "CityID = ".$CityID, null);
                foreach ($cities as $city) {
                    $cityPage = new BrowseCitiesPage();
                    $cityPage->CreateCity($city, $regionPage);
                }
            }
        }
        return $cityPage;
    }

    /**
     * fix URLS
     * NOTE: you must set get variables: urls, from and to....
     **/
    public function requireDefaultRecords()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        parent::requireDefaultRecords();
        if (isset($_GET["urls"]) && isset($_GET["from"]) && isset($_GET["to"])) {
            $dos = DataObject::get("SiteTree", null, null, null, $_GET["from"].','.$_GET["to"]);
            foreach ($dos as $page) {
                if (isset($page)) {
                    echo "<li>fixing ".$page->Title."</li>";
                    $page->URLSegment = $this->generateURLSegment($page->Title);
                    $page->writeToStage('Stage');
                    $page->publish('Stage', 'Live');
                    $page->flushCache();
                    $page->detroy();
                }
            }
        }
    }

    /**
     * Create a page
     * @param Array - $city: the data for the city
     * @param Object $parent: BrowseRegionsPage
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     **/
    public function CreateCity(array $city, BrowseRegionsPage $parent)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if ($parent && isset($city["City"])) {
            $name = htmlentities($city["City"]);
            if (isset($name)) {
                if (isset($_GET["geobuild"])) {
                    echo "<li>creating ".$name."</li>";
                }
                $this->ParentID = $parent->ID;
                $this->Title = $name;
                $this->MetaTitle = $name;
                $this->MenuTitle = $name;
                $this->HiddenDataID = $city["CityID"];

                $this->Code = $city["Code"];
                $this->Latitude = $city["Latitude"];
                $this->Longitude = $city["Longitude"];
                $this->TimeZone = $city["TimeZone"];
                $this->County = htmlentities($city["County"]);
                $this->Code = $city["Code"];

                $this->CreateChildren = $parent->CreateAllChildren;
                $this->CreateAllChildren = $parent->CreateAllChildren;

                $this->URLSegment = $this->generateURLSegment($this->Title);

                $this->writeToStage('Stage');
                $this->publish('Stage', 'Live');
                $this->flushCache();
            } else {
                if (isset($_GET["geobuild"])) {
                    debug::show("No name can be found");
                }
            }
        } else {
            if (isset($_GET["geobuild"])) {
                debug::show("Parent does not exist");
            }
        }
    }
}

class BrowseCitiesPage_Controller extends BrowseAbstractPage_Controller
namespace YourVendor;

class YourClass { }
{
}


sunnysideup / silverstripe-geobrowser

BrowseCitiesPage B last analyzed 2018-03-20 01:16 UTC