Route - Code Metrics - Inspection of "updated for resolving scrutinizer warninigs" - route4me/route4me-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 39430a...e623a9 )

by Oleg

created 2018-11-27 12:54 UTC

Route F

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	453
Duplicated Lines	35.54 %

Coupling/Cohesion

Components	7
Dependencies	4

Importance

Changes

Metric	Value
dl	161
loc	453
rs	2
c	0
b	0
f	0
wmc	83
lcom	7
cbo	4

22 Methods

Rating	Name	Duplication	Size	Complexity
A	fromArray()	8	34	4
D	getRoutes()	0	47	11
A	getRoutePoints()	15	15	3
A	duplicateRoute()	0	14	1
A	resequenceRoute()	17	17	4
A	resequenceAllAddresses()	16	16	4
A	mergeRoutes()	0	16	3
A	shareRoute()	17	17	3
B	getRandomRouteId()	0	29	6
A	update()	17	17	4
A	updateAddress()	15	15	4
A	addAddresses()	0	14	3
A	insertAddressOptimalPosition()	17	17	4
B	addNoteFile()	0	31	11
A	delete()	21	21	1
A	GetAddressesFromRoute()	0	7	2
A	GetRandomAddressFromRoute()	0	13	2
A	getRouteId()	0	4	1
A	getOptimizationId()	0	4	1
A	GetLastLocation()	0	15	3
A	GetTrackingHistoryFromTimeRange()	18	18	6
A	GetAssetTracking()	0	14	2

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 Route 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 Route, and based on these observations, apply Extract Interface, too.

<?php

namespace Route4Me;

use Route4Me\Common;
use Route4Me\Address;
use Route4Me\Exception\BadParam;
use Route4Me\RouteParameters;
use Route4Me\Route4Me;
use GuzzleHttp\Client;

class Route extends Common
{
    static public $apiUrl = '/api.v4/route.php';
	static public $apiUrlAddress = '/api.v4/address.php';
	static public $apiUrlDuplicate='/actions/duplicate_route.php';
	static public $apiUrlDelete='/actions/delete_routes.php';
	static public $apiUrlReseq='/api.v3/route/reoptimize_2.php';
	static public $apiUrlMerge='/actions/merge_routes.php';
	static public $apiUrlShare='/actions/route/share_route.php';
	static public $apiUrlNoteFile='/actions/addRouteNotes.php';
	static public $apiUrlAsset='/api.v4/status.php';
	static public $apiUrlDeviceLocation='/api/track/get_device_location.php';
	//static public $apiUrlMove='/actions/route/move_route_destination.php';
    public $route_id;
	public $route_destination_id;
    public $optimization_problem_id;
    public $vehicle_alias;
    public $driver_alias;
    public $trip_distance;
    public $mpg;
    public $gas_price;
    public $route_duration_sec;
    public $parameters;
    public $addresses = array();
    public $links = array();
    public $directions = array();
    public $path = array();
    public $tracking_history = array();
	public $recipient_email;
	public $httpheaders;
	public $is_unrouted;
	
	public $dev_lat;
	public $dev_lng;

    public static function fromArray(array $params) 
    {
        $route = new Route();
        $route->route_id = Common::getValue($params, 'route_id');
        $route->optimization_problem_id = Common::getValue($params, 'optimization_problem_id');
        $route->vehicle_alias = Common::getValue($params, 'vehicle_alias');
        $route->driver_alias = Common::getValue($params, 'driver_alias');
        $route->trip_distance = Common::getValue($params, 'trip_distance');
        $route->mpg = Common::getValue($params, 'mpg');
        $route->gas_price = Common::getValue($params, 'gas_price');
        $route->route_duration_sec = Common::getvalue($params, 'route_duration_sec');
        $route->is_unrouted = Common::getvalue($params, 'is_unrouted');

        // Make RouteParameters
        if (isset($params['parameters'])) {
            $route->parameters = RouteParameters::fromArray($params['parameters']);
        }

        if (isset($params['addresses'])) {

            $addresses = array();
            foreach ($params['addresses'] as $address) {
                $addresses[] = Address::fromArray($address);
            }

            $route->addresses = $addresses;
        }

        $route->links = Common::getValue($params, 'links', array());
        $route->directions = Common::getValue($params, 'directions', array());
        $route->path = Common::getValue($params, 'path', array());
        $route->tracking_history = Common::getValue($params, 'tracking_history', array());

        return $route;
    }

    public static function getRoutes($routeId=null, $params=null)
    {
        $query = array(
            'api_key' => Route4Me::getApiKey()
        );

        if ($routeId) {
            $query['route_id'] = implode(',', (array) $routeId);
        }

        if ($params) {
            if (isset($params['directions'])) {
                $query['directions'] = $params['directions'];
            }

            if (isset($params['route_path_output'])) {
                $query['route_path_output'] = $params['route_path_output'];
            }

            if (isset($params['device_tracking_history'])) {
                $query['device_tracking_history'] = $params['device_tracking_history'];
            }
			
			if (isset($params['query'])) {
                $query['query'] = $params['query'];
            }

            $query['limit'] = isset($params['limit']) ? $params['limit'] : 30;
            $query['offset'] = isset($params['offset']) ? $params['offset'] : 0;
        }

        $json = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'GET',
            'query'  => $query
        ));

        if ($routeId) {
            return Route::fromArray($json); die("");
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        } else {
            $routes = array();
            foreach($json as $route) {
                $routes[] = Route::fromArray($route);
            }
            return $routes;
        }
    }

	public function getRoutePoints($routeId, $params)

	{
		$result = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'GET',
            'query'  => array(
            	'api_key' => Route4Me::getApiKey(),
                'route_id' => $routeId,
                'route_path_output' => isset($params['route_path_output']) ? $params['route_path_output'] : null,
                'directions' => isset($params['directions']) ? $params['directions'] : null,
            )
        ));

		return $result;
	}

	public function duplicateRoute($route_id)
	{
		$result = Route4Me::makeRequst(array(
            'url'    => self::$apiUrlDuplicate,
            'method' => 'GET',
            'query'  => array(
            	'api_key' => Route4Me::getApiKey(),
                'route_id' => $route_id,
                'to' => 'none',
            )
        ));
		
		return $result;
	}
	
	public function resequenceRoute($params)

	{
		$result = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'PUT',
            'query'  => array(
            	'api_key' => Route4Me::getApiKey(),
                'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
                'route_destination_id' => isset($params['route_destination_id']) ? $params['route_destination_id'] : null,
            ),
            'body'  => array(
				'addresses' => isset($params['addresses']) ? $params['addresses'] : null,
			)
        ));
		
		return $result;
	}
	
	public function resequenceAllAddresses($params)

	{
		$result = Route4Me::makeRequst(array(
            'url'    => self::$apiUrlReseq,
            'method' => 'GET',
            'query'  => array(
            	'api_key' => Route4Me::getApiKey(),
                'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
                'disable_optimization' => isset($params['disable_optimization']) ? $params['disable_optimization'] : null,
                'optimize' => isset($params['optimize']) ? $params['optimize'] : null,
            )
        ));
		
		return $result;
		
	}

	public function mergeRoutes($params)
	{
		$result = Route4Me::makeRequst(array(
            'url'    => self::$apiUrlMerge,
            'method' => 'POST',
            'query'  => array(
            	'api_key' => Route4Me::getApiKey(),
            ),
            'body'  => array(
				'route_ids' => isset($params['route_ids']) ? $params['route_ids'] : null,
			),
			'HTTPHEADER'  => isset($this->httpheaders) ? $this->httpheaders : null,
        ));
		
		return $result;
	}
	
	public function shareRoute($params)

	{
		$result = Route4Me::makeRequst(array(
            'url'    => self::$apiUrlShare,
            'method' => 'POST',
            'query'  => array(
            	'api_key' => Route4Me::getApiKey(),
            	'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
            ),
            'body'  => array(
				'recipient_email' => isset($params['recipient_email']) ? $params['recipient_email'] : null,
			),
			'Content-Type' => 'multipart/form-data'
        ));
		
		return $result;
	}
	
	// Getting random route_id from existing routes between $offset and $offset+$limit
	public function getRandomRouteId($offset,$limit)

	{
		$query['limit'] = isset($params['limit']) ? $params['limit'] : 30;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $query['offset'] = isset($params['offset']) ? $params['offset'] : 0;
			
		$json = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'GET',
            'query'  => $query
        ));
        
        if (sizeof($json)>0) {
            $routes = array();
            foreach($json as $route) {
                $routes[] = Route::fromArray($route);
            }
            
            $num=rand(0,sizeof($routes)-1);
            $rRoute=(array)$routes[$num];
            
            if (is_array($rRoute)) 
            {
                return $rRoute["route_id"];
            }
            else return null;
        } else return null;
		
		
	}

    public function update()

    {
        $route = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'PUT',
            'query'  => array(
                'route_id' => isset($this->route_id) ? $this->route_id : null,
                'route_destination_id' => isset($this->route_destination_id) ? $this->route_destination_id : null,
            ),
            'body' => array (
            	'parameters' => $this->parameters,
            	),
            'HTTPHEADER'  => isset($this->httpheaders) ? $this->httpheaders : null,
        ));

        return Route::fromArray($route);
    }
	
	public function updateAddress()

    {
        $result = Route4Me::makeRequst(array(
            'url'    => self::$apiUrlAddress,
            'method' => 'PUT',
            'query'  => array(
                'route_id' => isset($this->route_id) ? $this->route_id : null,
                'route_destination_id' => isset($this->route_destination_id) ? $this->route_destination_id : null,
            ),
            'body' => get_object_vars($this->parameters),
            'HTTPHEADER'  => isset($this->httpheaders) ? $this->httpheaders : null,
        ));

        return $result;
    }

    public function addAddresses(array $params)
    {
        $route = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'PUT',
            'query'  => array(
            	'api_key' => Route4Me::getApiKey(),
                'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
                'addresses' => isset($params['addresses']) ? $params['addresses'] : null
            )
        ));

        return Route::fromArray($route);
    }
	
	public function insertAddressOptimalPosition(array $params)

	{
		$route = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'PUT',
            'query'  => array(
            	'api_key' => Route4Me::getApiKey(),
                'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
            ),
            'body'  => array(
				'addresses' => isset($params['addresses']) ? $params['addresses'] : null,
				'optimal_position' => isset($params['optimal_position']) ? $params['optimal_position'] : null,
			)
        ));

        return Route::fromArray($route);
	}
	
	public function addNoteFile($params)
	{
		$fname = isset($params['strFilename']) ? $params['strFilename'] : null;
		$rpath = realpath($fname);
		//echo $rpath;die("");
		$result= Route4Me::makeRequst(array(
            'url'    => self::$apiUrlNoteFile,
            'method' => 'POST',
            'query'  => array(
            	'api_key' => Route4Me::getApiKey(),
                'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
                'address_id' => isset($params['address_id']) ? $params['address_id'] : null,
                'dev_lat' => isset($params['dev_lat']) ? $params['dev_lat'] : null,
                'dev_lng' => isset($params['dev_lng']) ? $params['dev_lng'] : null,
                'device_type' => isset($params['device_type']) ? $params['device_type'] : null,
                'dev_lng' => isset($params['dev_lng']) ? $params['dev_lng'] : null,
            ),
            'body'  => array(
				'strUpdateType' => isset($params['strUpdateType']) ? $params['strUpdateType'] : null,
				'strFilename' => isset($params['strFilename']) ? $params['strFilename'] : null,
				'strNoteContents' => isset($params['strNoteContents']) ? $params['strNoteContents'] : null,
			),
			'FILE' => $rpath,

			'HTTPHEADER' => array(
				'Content-Type: application/x-www-form-urlencoded'
			)
        ));

        return $result;
	}

    public function delete($route_id)

    {
        $result = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'DELETE',
            'query'  => array( 'route_id' => $route_id )
        ));
		
		// The code below doesn't work, altough this method is described as workable in REST API 
		/*
		$result = Route4Me::makeRequst(array(
            'url'    => self::$apiUrlDelete,
            'method' => 'GET',
            'query'  => array(
            	'api_key' => Route4Me::getApiKey(),
                'route_id' => $route_id,
            )
        ));
		*/
        return $result;
    }
	
	public function GetAddressesFromRoute($route_id)
	{
		$route1=Route::getRoutes($route_id,null);
		if (isset($route1)) {
			return $route1->addresses();

		} else { return null;}
	}
	
	public function GetRandomAddressFromRoute($route_id)
	{
		$route1=Route::getRoutes($route_id,null);
		
		if (isset($route1)) {
			$addresses=$route1->addresses;
			
			$rnd=rand(0,sizeof($addresses)-1);
			
			return $addresses[$rnd];
			
		} else { return null;}
	}

    public function getRouteId()
    {
        return $this->route_id;
    }

    public function getOptimizationId()
    {
        return $this->optimization_problem_id;
    }
	
	public function GetLastLocation(array $params)
	{
		$route = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'GET',
            'query'  => array(
            	'api_key' => Route4Me::getApiKey(),
                'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
                'device_tracking_history' => isset($params['device_tracking_history']) ? $params['device_tracking_history'] : null
            )
        ));

        return Route::fromArray($route);
		
	}
	
	public function GetTrackingHistoryFromTimeRange(array $params)

	{
		$route = Route4Me::makeRequst(array(
            'url'    => self::$apiUrlDeviceLocation,
            'method' => 'GET',
            'query'  => array(
            	'api_key' => Route4Me::getApiKey(),
                'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
                'format' => isset($params['format']) ? $params['format'] : null,
                'time_period' => isset($params['time_period']) ? $params['time_period'] : null,
                'start_date' => isset($params['start_date']) ? $params['start_date'] : null,
                'end_date' => isset($params['end_date']) ? $params['end_date'] : null
                )
        ));

        return $route;
		
	}
	
	public function GetAssetTracking(array $params)
	{
		$route = Route4Me::makeRequst(array(
            'url'    => self::$apiUrlAsset,
            'method' => 'GET',
            'query'  => array(
            	'api_key' => Route4Me::getApiKey(),
                'tracking' => isset($params['tracking']) ? $params['tracking'] : null
                )
        ));

        return $route;
		
	}
}


route4me / route4me-php-sdk

GitHub Access Token became invalid