Route4Me\OptimizationProblem

Complexity

Total Complexity

52

Size/Duplication

Total Lines	250
Duplicated Lines	28.8 %

Coupling/Cohesion

Components	4
Dependencies	6

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	fromArray()	14	31	6
B	optimize()	0	19	5
C	get()	0	26	8
A	reoptimize()	0	8	2
A	update()	0	14	4
A	getOptimizationId()	0	4	1
A	getRoutes()	0	4	1
B	getRandomOptimizationId()	0	24	6
A	getAddresses()	0	13	2
A	getRandomAddressFromOptimization()	0	14	2
A	removeAddress()	13	13	3
A	removeOptimization()	15	15	3
A	getHybridOptimization()	13	13	3
B	addDepotsToHybrid()	17	17	5

<?php

namespace Route4Me;

use Route4Me\Address;
use Route4Me\Common;
use Route4Me\RouteParameters;
use Route4Me\OptimizationProblemParams;
use Route4Me\Route;
use Route4Me\Route4Me;
use GuzzleHttp\Client;

class OptimizationProblem extends Common
{
    static public $apiUrl = '/api.v4/optimization_problem.php';
	static public $apiUrl_addr = '/api.v4/address.php';
    static public $apiHybridUrl = '/api.v4/hybrid_date_optimization.php';
    static public $apiHybridDepotUrl = '/api/change_hybrid_optimization_depot.php';

    public $optimization_problem_id;
    public $user_errors = array();
    public $state;
    public $parameters;
    public $sent_to_background;
    public $addresses = array();
    public $routes = array();
    public $links = array();

    function __construct()

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->parameters = new RouteParameters;
    }

    public static function fromArray(array $params)
    {
        $problem = new OptimizationProblem;
        $problem->optimization_problem_id = Common::getValue($params, 'optimization_problem_id');
        $problem->user_errors = Common::getValue($params, 'user_errors', array());
        $problem->state = Common::getValue($params, 'state', array());
        $problem->sent_to_background = Common::getValue($params, 'sent_to_background', array());
        $problem->links = Common::getValue($params, 'links', array());

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

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

This code seems to be duplicated across your project.

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

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

This code seems to be duplicated across your project.

            $routes = array();
            foreach ($params['routes'] as $route) {
                $routes[] = Route::fromArray($address);

The variable $address seems to be defined by a foreach iteration on line 49. Are you sure the iterator is never empty, otherwise this variable is not defined?

            }
            $problem->routes = $routes;
        }

        return $problem;
    }

    public static function optimize(OptimizationProblemParams $params)
    {
        $optimize = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'POST',
            'query'  => array(
                'directions'             => isset($params->directions) ? $params->directions: null, 
                'format'                 => isset($params->format) ? $params->format: null,
                'route_path_output'      => isset($params->route_path_output) ? $params->route_path_output: null,
                'optimized_callback_url' => isset($params->optimized_callback_url) ? $params->optimized_callback_url: null
            ),
            'body'   => array(
                'addresses'  => $params->getAddressesArray(),
                'parameters' => $params->getParametersArray()
            )
        ));

        return OptimizationProblem::fromArray($optimize);
    }

    public static function get($params)
    {
        $optimize = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'GET',
            'query'  => array(
                'state' => isset($params['state']) ? $params['state'] : null,
                'limit' => isset($params['limit']) ? $params['limit'] : null,
                'offset' => isset($params['offset']) ? $params['offset'] : null,
                'optimization_problem_id' => isset($params['optimization_problem_id']) 
                    ? $params['optimization_problem_id'] : null,
                'wait_for_final_state' => isset($params['wait_for_final_state']) 
                    ? $params['wait_for_final_state'] : null,
            )
        ));

        if (isset($optimize['optimizations'])) {
            $problems = array();
            foreach($optimize['optimizations'] as $problem) {
                $problems[] = OptimizationProblem::fromArray($problem);
            }
            return $problems;
        } else {
            return OptimizationProblem::fromArray($optimize);
        }
    }

    public static function reoptimize($params)
    {
        $param = new OptimizationProblemParams;
        $param->optimization_problem_id = isset($params['optimization_problem_id']) ? $params['optimization_problem_id'] : null;
        $param->reoptimize = 1;

        return self::update((array)$param);
    }

    public static function update($params)
    {
		$optimize = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'PUT',
            'query'  => array(
                'optimization_problem_id' => isset($params['optimization_problem_id']) ? $params['optimization_problem_id'] : null,
                'addresses' => isset($params['addresses']) ? $params['addresses'] : null,
                'reoptimize' => isset($params['reoptimize']) ? $params['reoptimize'] : null,
            )
        ));
		
		return $optimize;
    }

    public function getOptimizationId()
    {
        return $this->optimization_problem_id;
    }

    public function getRoutes()
    {
        return $this->routes;
    }
	
	public function getRandomOptimizationId($offset,$limit)

The parameter $offset is not used and could be removed.

The parameter $limit is not used and could be removed.

	{
		$query['limit'] = isset($params['limit']) ? $params['limit'] : 30;

$query was never initialized. Although not strictly required by PHP, it is generally a good practice to add $query = array(); before regardless.

The variable $params seems to never exist, and therefore isset should always return false. Did you maybe rename this variable?

        $query['offset'] = isset($params['offset']) ? $params['offset'] : 0;
			
		$json = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'GET',
            'query'  => $query
        ));
		
		$optimizations = array();
            foreach($json as $optimization) {
				if (gettype($optimization)!="array") continue;
				foreach ($optimization as $otp1) {
					$optimizations[] = $otp1;
				}
            }
			
			$num=rand(0,sizeof($optimizations)-1);
			//echo "num=$num.<br>".sizeof($optimizations)."<br>";

64% of this comment could be valid code. Did you maybe forget this after debugging?

			$rOptimization=$optimizations[$num];
			return $rOptimization;
	}
	
	public function getAddresses($opt_id)
	{
		if ($opt_id==null) return null;
		
		$params = array( "optimization_problem_id" => $opt_id );
		
		$optimization = (array)$this->get($params);
		
		$addresses = $optimization["addresses"];
		
		return $addresses;
		
	}
	
	public function getRandomAddressFromOptimization($opt_id)
	{
		$addresses = (array)$this->getAddresses($opt_id);
		
		if ($addresses == null) {
			echo "There are no addresses in this optimization!.. Try again.";
			return null;
		}
		
		$num=rand(0,sizeof($addresses)-1);
		$rAddress=$addresses[$num];
		
		return $rAddress;
	}
	
	public function removeAddress($params)

This method seems to be duplicated in your project.

	{
		$response = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl_addr,
            'method' => 'DELETE',
            'query'  => array(
                'optimization_problem_id' => isset($params['optimization_problem_id']) ? $params['optimization_problem_id'] : null,
                'route_destination_id' => isset($params['route_destination_id']) ? $params['route_destination_id'] : null,
            )
        ));
		
		return $response;
	}
	
	public function removeOptimization($params)

This method seems to be duplicated in your project.

	{
		$response = Route4Me::makeRequst(array(
            'url'    => self::$apiUrl,
            'method' => 'DELETE',
            'query'  => array(
                'redirect' => isset($params['redirect']) ? $params['redirect'] : null,
            ),
            'body'  => array(
				'optimization_problem_ids' => isset($params['optimization_problem_ids']) ? $params['optimization_problem_ids'] : null,
			)
        ));
		
		return $response;
	}
    
    public function getHybridOptimization($params)

This method seems to be duplicated in your project.

    {
        $optimize = Route4Me::makeRequst(array(
            'url'    => self::$apiHybridUrl,
            'method' => 'GET',
            'query'  => array(
                'target_date_string' => isset($params['target_date_string']) ? $params['target_date_string'] : null,
                'timezone_offset_minutes' => isset($params['timezone_offset_minutes']) ? $params['timezone_offset_minutes'] : null
            )
        ));

        return $optimize;
    }
    
    Public function addDepotsToHybrid($params)

This method seems to be duplicated in your project.

    {
        $depots = Route4Me::makeRequst(array( 
            'url'    => self::$apiHybridDepotUrl,
            'method' => 'POST',
            'query'  => array(
                'optimization_problem_id' => isset($params['optimization_problem_id']) ? $params['optimization_problem_id'] : null,
                ),
            'body'  => array(
                'optimization_problem_id' => isset($params['optimization_problem_id']) ? $params['optimization_problem_id'] : null,
                'delete_old_depots' => isset($params['delete_old_depots']) ? $params['delete_old_depots'] : null,
                'new_depots' => isset($params['new_depots']) ? $params['new_depots'] : null,
            )
        ));
        
        return $depots;
    }
}