route4me / route4me-php-sdk

src/Route4Me/Route.php

Indentation +805 added lines, -805 removed lines

@@ -12,809 +12,809 @@
  */
 class Route extends Common
 {
-    /**
-     * The route ID
-     * @var string
-     */
-    public $route_id;
-
-    /**
-     * Member ID of a route owner
-     * @var integer
-     */
-    public $member_id;
-
-    /**
-     * Optimization problem ID
-     * @var string
-     */
-    public $optimization_problem_id;
-
-    /**
-     * Vehicle alias
-     * @var string
-     */
-    public $vehicle_alias;
-
-    /**
-     * Driver alias
-     * @var string
-     */
-    public $driver_alias;
-
-    /**
-     * Total route's trip distance
-     * @var double
-     */
-    public $trip_distance;
-
-    /**
-     * The UDU distance measurement unit for the route.<br>
-     * @note km or mi, the route4me api will convert all distance measurements into these units.
-     * @var string
-     */
-    public $udu_distance_unit;
-
-    /**
-     * Total route's UDU trip distance
-     * @var double
-     */
-    public $udu_trip_distance;
-
-    /** Miles per gallon
-     * @var double
-     */
-    public $mpg;
-
-    /**
-     * Gas price
-     * @var double
-     */
-    public $gas_price;
-
-    /**
-     * Total route duration (seconds)
-     * @var integer
-     */
-    public $route_duration_sec;
-
-    /**
-     * Number of the destinations in the route.
-     * @var integer
-     */
-    public $destination_count;
-
-    /**
-     * Notes count in the route.
-     * @var integer
-     */
-    public $notes_count;
-
-    /**
-     * Route parameters
-     * @var RouteParameters
-     */
-    public $parameters;
-
-    /**
-     * An array of the route addresses
-     * @var Address[]
-     */
-    public $addresses = [];
-
-    /**
-     * An array of the links
-     * @var string[]
-     */
-    public $links = [];
-
-    /**
-     * Edge by edge turn-by-turn directions.
-     * @var Direction[]
-     */
-    public $directions = [];
-
-    /**
-     * Edge-wise path to be drawn on the map.
-     * @var GeoPoint[]
-     */
-    public $path = [];
-
-    /**
-     * A collection of device tracking data with coordinates, speed, and timestamps.
-     * @var Tracking\TrackingHistory[]
-     */
-    public $tracking_history = [];
-
-    /**
-     * HTTP headers
-     * @var string
-     */
-    public $httpheaders;
-
-    /**
-     * If true, the route is unrouted.
-     * @var Boolean
-     */
-    public $is_unrouted;
-
-    /**
-     * User route rating [0, 5]. A null value means no rating was given.<br>
-     * Users can rate routes so that future optimizations take these ratings into account.
-     * @var integer
-     */
-    public $user_route_rating;
-
-    /**
-     * The member's email
-     * @var string
-     */
-    public $member_email;
-
-    /**
-     * URL to a member picture
-     * @var string
-     */
-    public $member_picture;
-
-    /**
-     * Member tracking subheadline.
-     * @var string
-     */
-    public $member_tracking_subheadline;
-
-    /**
-     * If true, the order is approved for execution.
-     * @var Boolean
-     */
-    public $approved_for_execution;
-
-    /**
-     * Counter of the approved revisions.
-     * @var integer
-     */
-    public $approved_revisions_counter;
-
-    /**
-     * The member's first name.
-     * @var string
-     */
-    public $member_first_name;
-
-    /**
-     * The member's last name.
-     * @var string
-     */
-    public $member_last_name;
-
-    /**
-     * Channel name
-     * @var string
-     */
-    public $channel_name;
-
-    /**
-     * Total cost of the route.
-     * @var double
-     */
-    public $route_cost;
-
-    /**
-     * Total route revenue
-     * @var double
-     */
-    public $route_revenue;
-
-    /**
-     * Net revenue per distance unit.
-     * @var double
-     */
-    public $net_revenue_per_distance_unit;
-
-    /**
-     * When route created (UNIX format timestamp).
-     * @var integer
-     */
-    public $created_timestamp;
-
-    /**
-     * Planned total route duration (seconds).
-     * @var integer
-     */
-    public $planned_total_route_duration;
-
-    /**
-     * Total wait time (seconds).
-     * @var integer
-     */
-    public $total_wait_time;
-
-    /**
-     * UDU Actual travel distance.
-     * @var double
-     */
-    public $udu_actual_travel_distance;
-
-    /**
-     * Actual travel distance.
-     * @var double
-     */
-    public $actual_travel_distance;
-
-    /**
-     * Actual travel time (seconds).
-     * @var integer
-     */
-    public $actual_travel_time;
-
-    /**
-     * Actual footsteps.
-     * @var integer
-     */
-    public $actual_footsteps;
-
-    /**
-     * Working time.
-     * @var integer
-     */
-    public $working_time;
-
-    /**
-     * Driving time.
-     * @var integer
-     */
-    public $driving_time;
-
-    /**
-     * Idling time.
-     * @var integer
-     */
-    public $idling_time;
-
-    /**
-     * Paying miles
-     * @var double
-     */
-    public $paying_miles;
-
-    /**
-     * Geofence polygon type.<br>
-     * enum: ["circle", "poly", "rect"]
-     * @var string
-     */
-    public $geofence_polygon_type;
-
-    /**
-     * Geofence polygon size.
-     * @var integer
-     */
-    public $geofence_polygon_size;
-
-    /**
-     * Route notes
-     * @var AddressNote[]
-     */
-    public $notes=[];
-
-    /**
-     * A vehicle assigned to the route.
-     * @var Vehicles\VehicleResponseV4
-     */
-    public $vehicle=[];
-
-    /**
-     * Member config key-value pairs.
-     * @var array
-     */
-    public $member_config_storage;
-
-    /**
-     * Original route
-     * @var Route
-     */
-    public $original_route;
-
-    /**
-     * If true, the route will be unlinked from the master optimization.
-     * @var Boolean
-     */
-    public $unlink_from_master_optimization;
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-    }
-
-    public static function fromArray(array $params)
-    {
-        $route = new self();
-        $route->route_id = Common::getValue($params, 'route_id');
-        $route->member_id = Common::getValue($params, 'member_id');
-        $route->member_email = Common::getValue($params, 'member_email');
-        $route->member_picture = Common::getValue($params, 'member_picture');
-        $route->member_tracking_subheadline = Common::getValue($params, 'member_tracking_subheadline');
-        $route->approved_for_execution = Common::getValue($params, 'approved_for_execution');
-        $route->approved_revisions_counter = Common::getValue($params, 'approved_revisions_counter');
-        $route->member_first_name = Common::getValue($params, 'member_first_name');
-        $route->member_last_name = Common::getValue($params, 'member_last_name');
-        $route->channel_name = Common::getValue($params, 'channel_name');
-        $route->optimization_problem_id = Common::getValue($params, 'optimization_problem_id');
-        $route->user_route_rating = Common::getValue($params, 'user_route_rating');
-        $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->udu_distance_unit = Common::getValue($params, 'udu_distance_unit');
-        $route->udu_trip_distance = Common::getValue($params, 'udu_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->planned_total_route_duration = Common::getvalue($params, 'planned_total_route_duration');
-        $route->total_wait_time = Common::getvalue($params, 'total_wait_time');
-        $route->udu_actual_travel_distance = Common::getvalue($params, 'udu_actual_travel_distance');
-        $route->actual_travel_distance = Common::getvalue($params, 'actual_travel_distance');
-        $route->actual_travel_time = Common::getvalue($params, 'actual_travel_time');
-        $route->actual_footsteps = Common::getvalue($params, 'actual_footsteps');
-        $route->working_time = Common::getvalue($params, 'working_time');
-        $route->driving_time = Common::getvalue($params, 'driving_time');
-        $route->idling_time = Common::getvalue($params, 'idling_time');
-        $route->paying_miles = Common::getvalue($params, 'paying_miles');
-        $route->geofence_polygon_type = Common::getvalue($params, 'geofence_polygon_type');
-        $route->geofence_polygon_size = Common::getvalue($params, 'geofence_polygon_size');
-        $route->destination_count = Common::getvalue($params, 'destination_count');
-        $route->notes_count = Common::getvalue($params, 'notes_count');
-        $route->is_unrouted = Common::getvalue($params, 'is_unrouted');
-        $route->route_cost = Common::getvalue($params, 'route_cost');
-        $route->route_revenue = Common::getvalue($params, 'route_revenue');
-        $route->net_revenue_per_distance_unit = Common::getvalue($params, 'net_revenue_per_distance_unit');
-        $route->created_timestamp = Common::getvalue($params, 'created_timestamp');
-
-        if (isset($params['vehicle'])) {
-            $route->vehicle = new Vehicle();
-            $route->vehicle = Vehicle::fromArray($params['vehicle']);
-            Route4Me::setBaseUrl(Endpoint::BASE_URL);
-        };
-
-        $route->member_config_storage = Common::getvalue($params, 'member_config_storage');
-
-        // Make RouteParameters
-        if (isset($params['parameters'])) {
-            $route->parameters = new RouteParameters();
-            $route->parameters = RouteParameters::fromArray($params['parameters']);
-            Route4Me::setBaseUrl(Endpoint::BASE_URL);
-        }
-
-        if (isset($params['addresses'])) {
-            $addresses = [];
-
-            foreach ($params['addresses'] as $address) {
-                $addresses[] = Address::fromArray($address);
-            }
-
-            $route->addresses = $addresses;
-        }
-
-        $route->links = Common::getValue($params, 'links', []);
-        $route->notes = Common::getValue($params, 'notes', []);
-        $route->directions = Common::getValue($params, 'directions', []);
-        $route->path = Common::getValue($params, 'path', []);
-        $route->tracking_history = Common::getValue($params, 'tracking_history', []);
-
-        if (isset($params['original_route'])) {
-            $route->original_route = Route::fromArray($params['original_route']);
-        };
-
-        return $route;
-    }
-
-    /**
-     * @param RouteParametersQuery $params
-     * @return An array of the routes
-     * @throws Exception\ApiError
-     */
-    public static function getRoutes($params = null)
-    {
-        $allQueryFields = ['route_id', 'original', 'route_path_output', 'query', 'directions', 'device_tracking_history', 'limit', 'offset','start_date','end_date'];
-
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::ROUTE_V4,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        if (isset($params['route_id'])) {
-            if (strlen($params['route_id'])==32) {
-                return self::fromArray($result);
-            } else {
-                return $result;
-            }
-        } else {
-            $routes = [];
-            foreach ($result as $route) {
-                $routes[] = self::fromArray($route);
-            }
-
-            return $routes;
-        }
-    }
-
-    public function getRoutePoints($params)
-    {
-        $allQueryFields = ['route_id', 'route_path_output', 'compress_path_points', 'directions'];
-
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::ROUTE_V4,
-            'method' => 'GET',
-            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $result;
-    }
-
-    public function duplicateRoute($routeIDs)
-    {
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::ROUTE_V4,
-            'method' => 'POST',
-            'body'   => [
-                'duplicate_routes_id' => $routeIDs
-            ],
-        ]);
-
-        return $result;
-    }
-
-    public function resequenceRoute($params)
-    {
-        $allQueryFields = ['route_id', 'route_destination_id'];
-        $allBodyFields = ['addresses'];
-
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::ROUTE_V4,
-            'method'    => 'PUT',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $result;
-    }
-
-    /**
-     * @deprecated 'The method is obsolete, use the method ReoptimizeRoute instead.'
-     * @param $params
-     * @return mixed|string
-     */
-    public function resequenceAllAddresses($params)
-    {
-        $allQueryFields = ['route_id', 'disable_optimization', 'optimize'];
-
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::REOPTIMIZE_V3_2,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $result;
-    }
-
-    /**
-     * Reoptimize a route
-     * @param $params type Route
-     * @return mixed|string
-     * @throws Exception\ApiError
-     */
-    public function reoptimizeRoute($params)
-    {
-        $allQueryFields = ['route_id', 'reoptimize', 'remaining', 'device_type'];
-
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::ROUTE_V4,
-            'method'    => 'PUT',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $result;
-    }
-
-    /**
-     * Merges the routes
-     * @param $params array contains:
-     * @param route_ids IDs of the routes to be merged.
-     * @param depot_address a depot address of the merged route.
-     * @param remove_origin if true, the origin routes will be removed.
-     * @param depot_lat the depot's latitude
-     * @param depot_lng the depot's longitude
-     * @return Status response
-     * @throws Exception\ApiError
-     */
-    public function mergeRoutes($params)
-    {
-        $allBodyFields = ['route_ids', 'depot_address', 'remove_origin', 'depot_lat',  'depot_lng'];
-
-        $result = Route4Me::makeRequst([
-            'url'           => Endpoint::ROUTES_MERGE,
-            'method'        => 'POST',
-            'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data',
-        ]);
-
-        return $result;
-    }
-
-    /**
-     * Share a route by an email
-     * @param $params RouteParametersQuery contains:
-     * @param route_id a route ID to be shared.
-     * @param response_format the response format.
-     * @param recipient_email Recipient email.
-     * @return Status response
-     * @throws Exception\ApiError
-     */
-    public function shareRoute($params)
-    {
-        $allQueryFields = ['route_id', 'response_format'];
-        $allBodyFields = ['recipient_email'];
-
-        $result = Route4Me::makeRequst([
-            'url'           => Endpoint::ROUTE_SHARE,
-            'method'        => 'POST',
-            'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data',
-        ]);
-
-        return $result;
-    }
-
-    /**
-     * Returns random route_id from existing routes between $offset and $offset+$limit
-     * @param $offset integer The page number for route listing pagination.
-     * @param $limit integer The maximum number of the returned routes.
-     * @return string random route ID
-     * @throws Exception\ApiError
-     */
-    public function getRandomRouteId($offset, $limit)
-    {
-        $params = [
-            'offset'    => !is_null($offset) ? $offset : 0,
-            'limit'     => !is_null($limit) ? $limit : 30,
-        ];
-
-        $route = new self();
-        $routes = $route->getRoutes($params);
-
-        if (is_null($routes) || sizeof($routes) < 1) {
-            echo '<br> There are no routes in the account. Please, create the routes first. <br>';
-
-            return null;
-        }
-
-        $randomIndex = rand(0, sizeof($routes) - 1);
-
-        return $routes[$randomIndex]->route_id;
-    }
-
-    /**
-     * Update a route
-     * @param $params array contains:
-     * @param route_id string : route ID
-     * @param reoptimize int : if equal to 1 the route re-optimized.
-     * @param route_destination_id int : route destination ID
-     * @param addresses Address[] : an array of a route addresses.
-     * @param parameters RouteParameters : route parameters.
-     * @param unlink_from_master_optimization  Boolean : if true, the route will be unlinked from optimization.
-     * @return Route updated route
-     * @throws Exception\ApiError
-     */
-    public function updateRoute($params)
-    {
-        $allQueryFields = ['route_id', 'reoptimize','route_destination_id'];
-        $allBodyFields = ['addresses', 'parameters', 'unlink_from_master_optimization'];
-
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::ROUTE_V4,
-            'method'    => 'PUT',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'      => (isset($params['addresses']) || isset($params['parameters']) || isset($params['unlink_from_master_optimization']))
-                            ? Route4Me::generateRequestParameters($allBodyFields, $params)
-                            : null,
-        ]);
-
-        return $result;
-    }
-
-    public function update()
-    {
-        $route = Route4Me::makeRequst([
-            'url'    => Endpoint::ROUTE_V4,
-            'method' => 'PUT',
-            'query'  => [
-                'route_id' => isset($this->route_id) ? $this->route_id : null,
-            ],
-            'body'   => [
-                'parameters' => $this->parameters,
-                ],
-            'HTTPHEADER' => isset($this->httpheaders) ? $this->httpheaders : null,
-        ]);
-
-        return self::fromArray($route);
-    }
-
-    public function updateAddress($address = null)
-    {
-        $body = sizeof($this->addresses) < 1 ? get_object_vars($this->parameters)
-            : (isset($this->addresses[0]) ? $this->addresses[0] : get_object_vars($this->parameters));
-
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::ADDRESS_V4,
-            'method' => 'PUT',
-            'query'  => [
-                'route_id' => isset($this->route_id) ? $this->route_id : null,
-                'route_destination_id' => isset($this->route_destination_id) ? $this->route_destination_id : null,
-            ],
-            'body'   => $body,
-            'HTTPHEADER' => isset($this->httpheaders) ? $this->httpheaders : null,
-        ]);
-
-        return $result;
-    }
-
-    public function updateRouteAddress()
-    {
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::ADDRESS_V4,
-            'method' => 'PUT',
-            'query'  => [
-                'route_id' => isset($this->route_id) ? $this->route_id : null,
-                'route_destination_id' => isset($this->route_destination_id) ? $this->route_destination_id : null,
-            ],
-            'body'   => [
-                'parameters' => isset($this->parameters) ? get_object_vars($this->parameters) : null,
-                'addresses' => isset($this->addresses) ? $this->addresses : null,
-            ],
-            'HTTPHEADER' => isset($this->httpheaders) ? $this->httpheaders : null,
-        ]);
-
-        return $result;
-    }
-
-    public function addAddresses($params)
-    {
-        $allQueryFields = ['route_id'];
-        $allBodyFields = ['addresses'];
-
-        $route = Route4Me::makeRequst([
-            'url'           => Endpoint::ROUTE_V4,
-            'method'        => 'PUT',
-            'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER'    => isset($this->httpheaders) ? $this->httpheaders : null,
-        ]);
-
-        return self::fromArray($route);
-    }
-
-    public function insertAddressOptimalPosition(array $params)
-    {
-        $allQueryFields = ['route_id'];
-        $allBodyFields = ['addresses', 'optimal_position'];
-
-        $route = Route4Me::makeRequst([
-            'url'    => Endpoint::ROUTE_V4,
-            'method' => 'PUT',
-            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return self::fromArray($route);
-    }
-
-    public function addNoteFile($params)
-    {
-        $fname = isset($params['strFilename']) ? $params['strFilename'] : null;
-        $rpath = realpath($fname);
-
-        $allQueryFields = ['route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type'];
-        $allBodyFields = ['strUpdateType', 'strFilename', 'strNoteContents'];
-
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::ROUTE_NOTES_ADD,
-            'method' => 'POST',
-            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'FILE'   => $rpath,
-            'HTTPHEADER' => [
-                'Content-Type: application/x-www-form-urlencoded',
-            ],
-        ]);
-
-        return $result;
-    }
-
-    public function deleteRoutes($route_id)
-    {
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::ROUTE_V4,
-            'method' => 'DELETE',
-            'query'  => [
-                'route_id' => $route_id,
-            ],
-        ]);
-
-        return $result;
-    }
-
-    public function GetAddressesFromRoute($route_id)
-    {
-        $route1 = self::getRoutes(['route_id' => $route_id]);
-
-        if (isset($route1)) {
-            return $route1->addresses;
-        } else {
-            return null;
-        }
-    }
-
-    public function GetRandomAddressFromRoute($route_id)
-    {
-        $route1 = self::getRoutes(['route_id' => $route_id]);
-
-        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)
-    {
-        $allQueryFields = ['route_id', 'device_tracking_history'];
-
-        $route = Route4Me::makeRequst([
-            'url'    => Endpoint::ROUTE_V4,
-            'method' => 'GET',
-            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return self::fromArray($route);
-    }
-
-    public function GetTrackingHistoryFromTimeRange(array $params)
-    {
-        $allQueryFields = ['route_id', 'format', 'time_period', 'start_date', 'end_date'];
-
-        $route = Route4Me::makeRequst([
-            'url'    => Endpoint::GET_DEVICE_LOCATION,
-            'method' => 'GET',
-            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $route;
-    }
-
-    public function GetAssetTracking(array $params)
-    {
-        $allQueryFields = ['tracking'];
-
-        $assetResponse = Route4Me::makeRequst([
-            'url'    => Endpoint::STATUS_V4,
-            'method' => 'GET',
-            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $assetResponse;
-    }
+	/**
+	 * The route ID
+	 * @var string
+	 */
+	public $route_id;
+
+	/**
+	 * Member ID of a route owner
+	 * @var integer
+	 */
+	public $member_id;
+
+	/**
+	 * Optimization problem ID
+	 * @var string
+	 */
+	public $optimization_problem_id;
+
+	/**
+	 * Vehicle alias
+	 * @var string
+	 */
+	public $vehicle_alias;
+
+	/**
+	 * Driver alias
+	 * @var string
+	 */
+	public $driver_alias;
+
+	/**
+	 * Total route's trip distance
+	 * @var double
+	 */
+	public $trip_distance;
+
+	/**
+	 * The UDU distance measurement unit for the route.<br>
+	 * @note km or mi, the route4me api will convert all distance measurements into these units.
+	 * @var string
+	 */
+	public $udu_distance_unit;
+
+	/**
+	 * Total route's UDU trip distance
+	 * @var double
+	 */
+	public $udu_trip_distance;
+
+	/** Miles per gallon
+	 * @var double
+	 */
+	public $mpg;
+
+	/**
+	 * Gas price
+	 * @var double
+	 */
+	public $gas_price;
+
+	/**
+	 * Total route duration (seconds)
+	 * @var integer
+	 */
+	public $route_duration_sec;
+
+	/**
+	 * Number of the destinations in the route.
+	 * @var integer
+	 */
+	public $destination_count;
+
+	/**
+	 * Notes count in the route.
+	 * @var integer
+	 */
+	public $notes_count;
+
+	/**
+	 * Route parameters
+	 * @var RouteParameters
+	 */
+	public $parameters;
+
+	/**
+	 * An array of the route addresses
+	 * @var Address[]
+	 */
+	public $addresses = [];
+
+	/**
+	 * An array of the links
+	 * @var string[]
+	 */
+	public $links = [];
+
+	/**
+	 * Edge by edge turn-by-turn directions.
+	 * @var Direction[]
+	 */
+	public $directions = [];
+
+	/**
+	 * Edge-wise path to be drawn on the map.
+	 * @var GeoPoint[]
+	 */
+	public $path = [];
+
+	/**
+	 * A collection of device tracking data with coordinates, speed, and timestamps.
+	 * @var Tracking\TrackingHistory[]
+	 */
+	public $tracking_history = [];
+
+	/**
+	 * HTTP headers
+	 * @var string
+	 */
+	public $httpheaders;
+
+	/**
+	 * If true, the route is unrouted.
+	 * @var Boolean
+	 */
+	public $is_unrouted;
+
+	/**
+	 * User route rating [0, 5]. A null value means no rating was given.<br>
+	 * Users can rate routes so that future optimizations take these ratings into account.
+	 * @var integer
+	 */
+	public $user_route_rating;
+
+	/**
+	 * The member's email
+	 * @var string
+	 */
+	public $member_email;
+
+	/**
+	 * URL to a member picture
+	 * @var string
+	 */
+	public $member_picture;
+
+	/**
+	 * Member tracking subheadline.
+	 * @var string
+	 */
+	public $member_tracking_subheadline;
+
+	/**
+	 * If true, the order is approved for execution.
+	 * @var Boolean
+	 */
+	public $approved_for_execution;
+
+	/**
+	 * Counter of the approved revisions.
+	 * @var integer
+	 */
+	public $approved_revisions_counter;
+
+	/**
+	 * The member's first name.
+	 * @var string
+	 */
+	public $member_first_name;
+
+	/**
+	 * The member's last name.
+	 * @var string
+	 */
+	public $member_last_name;
+
+	/**
+	 * Channel name
+	 * @var string
+	 */
+	public $channel_name;
+
+	/**
+	 * Total cost of the route.
+	 * @var double
+	 */
+	public $route_cost;
+
+	/**
+	 * Total route revenue
+	 * @var double
+	 */
+	public $route_revenue;
+
+	/**
+	 * Net revenue per distance unit.
+	 * @var double
+	 */
+	public $net_revenue_per_distance_unit;
+
+	/**
+	 * When route created (UNIX format timestamp).
+	 * @var integer
+	 */
+	public $created_timestamp;
+
+	/**
+	 * Planned total route duration (seconds).
+	 * @var integer
+	 */
+	public $planned_total_route_duration;
+
+	/**
+	 * Total wait time (seconds).
+	 * @var integer
+	 */
+	public $total_wait_time;
+
+	/**
+	 * UDU Actual travel distance.
+	 * @var double
+	 */
+	public $udu_actual_travel_distance;
+
+	/**
+	 * Actual travel distance.
+	 * @var double
+	 */
+	public $actual_travel_distance;
+
+	/**
+	 * Actual travel time (seconds).
+	 * @var integer
+	 */
+	public $actual_travel_time;
+
+	/**
+	 * Actual footsteps.
+	 * @var integer
+	 */
+	public $actual_footsteps;
+
+	/**
+	 * Working time.
+	 * @var integer
+	 */
+	public $working_time;
+
+	/**
+	 * Driving time.
+	 * @var integer
+	 */
+	public $driving_time;
+
+	/**
+	 * Idling time.
+	 * @var integer
+	 */
+	public $idling_time;
+
+	/**
+	 * Paying miles
+	 * @var double
+	 */
+	public $paying_miles;
+
+	/**
+	 * Geofence polygon type.<br>
+	 * enum: ["circle", "poly", "rect"]
+	 * @var string
+	 */
+	public $geofence_polygon_type;
+
+	/**
+	 * Geofence polygon size.
+	 * @var integer
+	 */
+	public $geofence_polygon_size;
+
+	/**
+	 * Route notes
+	 * @var AddressNote[]
+	 */
+	public $notes=[];
+
+	/**
+	 * A vehicle assigned to the route.
+	 * @var Vehicles\VehicleResponseV4
+	 */
+	public $vehicle=[];
+
+	/**
+	 * Member config key-value pairs.
+	 * @var array
+	 */
+	public $member_config_storage;
+
+	/**
+	 * Original route
+	 * @var Route
+	 */
+	public $original_route;
+
+	/**
+	 * If true, the route will be unlinked from the master optimization.
+	 * @var Boolean
+	 */
+	public $unlink_from_master_optimization;
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	}
+
+	public static function fromArray(array $params)
+	{
+		$route = new self();
+		$route->route_id = Common::getValue($params, 'route_id');
+		$route->member_id = Common::getValue($params, 'member_id');
+		$route->member_email = Common::getValue($params, 'member_email');
+		$route->member_picture = Common::getValue($params, 'member_picture');
+		$route->member_tracking_subheadline = Common::getValue($params, 'member_tracking_subheadline');
+		$route->approved_for_execution = Common::getValue($params, 'approved_for_execution');
+		$route->approved_revisions_counter = Common::getValue($params, 'approved_revisions_counter');
+		$route->member_first_name = Common::getValue($params, 'member_first_name');
+		$route->member_last_name = Common::getValue($params, 'member_last_name');
+		$route->channel_name = Common::getValue($params, 'channel_name');
+		$route->optimization_problem_id = Common::getValue($params, 'optimization_problem_id');
+		$route->user_route_rating = Common::getValue($params, 'user_route_rating');
+		$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->udu_distance_unit = Common::getValue($params, 'udu_distance_unit');
+		$route->udu_trip_distance = Common::getValue($params, 'udu_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->planned_total_route_duration = Common::getvalue($params, 'planned_total_route_duration');
+		$route->total_wait_time = Common::getvalue($params, 'total_wait_time');
+		$route->udu_actual_travel_distance = Common::getvalue($params, 'udu_actual_travel_distance');
+		$route->actual_travel_distance = Common::getvalue($params, 'actual_travel_distance');
+		$route->actual_travel_time = Common::getvalue($params, 'actual_travel_time');
+		$route->actual_footsteps = Common::getvalue($params, 'actual_footsteps');
+		$route->working_time = Common::getvalue($params, 'working_time');
+		$route->driving_time = Common::getvalue($params, 'driving_time');
+		$route->idling_time = Common::getvalue($params, 'idling_time');
+		$route->paying_miles = Common::getvalue($params, 'paying_miles');
+		$route->geofence_polygon_type = Common::getvalue($params, 'geofence_polygon_type');
+		$route->geofence_polygon_size = Common::getvalue($params, 'geofence_polygon_size');
+		$route->destination_count = Common::getvalue($params, 'destination_count');
+		$route->notes_count = Common::getvalue($params, 'notes_count');
+		$route->is_unrouted = Common::getvalue($params, 'is_unrouted');
+		$route->route_cost = Common::getvalue($params, 'route_cost');
+		$route->route_revenue = Common::getvalue($params, 'route_revenue');
+		$route->net_revenue_per_distance_unit = Common::getvalue($params, 'net_revenue_per_distance_unit');
+		$route->created_timestamp = Common::getvalue($params, 'created_timestamp');
+
+		if (isset($params['vehicle'])) {
+			$route->vehicle = new Vehicle();
+			$route->vehicle = Vehicle::fromArray($params['vehicle']);
+			Route4Me::setBaseUrl(Endpoint::BASE_URL);
+		};
+
+		$route->member_config_storage = Common::getvalue($params, 'member_config_storage');
+
+		// Make RouteParameters
+		if (isset($params['parameters'])) {
+			$route->parameters = new RouteParameters();
+			$route->parameters = RouteParameters::fromArray($params['parameters']);
+			Route4Me::setBaseUrl(Endpoint::BASE_URL);
+		}
+
+		if (isset($params['addresses'])) {
+			$addresses = [];
+
+			foreach ($params['addresses'] as $address) {
+				$addresses[] = Address::fromArray($address);
+			}
+
+			$route->addresses = $addresses;
+		}
+
+		$route->links = Common::getValue($params, 'links', []);
+		$route->notes = Common::getValue($params, 'notes', []);
+		$route->directions = Common::getValue($params, 'directions', []);
+		$route->path = Common::getValue($params, 'path', []);
+		$route->tracking_history = Common::getValue($params, 'tracking_history', []);
+
+		if (isset($params['original_route'])) {
+			$route->original_route = Route::fromArray($params['original_route']);
+		};
+
+		return $route;
+	}
+
+	/**
+	 * @param RouteParametersQuery $params
+	 * @return An array of the routes
+	 * @throws Exception\ApiError
+	 */
+	public static function getRoutes($params = null)
+	{
+		$allQueryFields = ['route_id', 'original', 'route_path_output', 'query', 'directions', 'device_tracking_history', 'limit', 'offset','start_date','end_date'];
+
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::ROUTE_V4,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		if (isset($params['route_id'])) {
+			if (strlen($params['route_id'])==32) {
+				return self::fromArray($result);
+			} else {
+				return $result;
+			}
+		} else {
+			$routes = [];
+			foreach ($result as $route) {
+				$routes[] = self::fromArray($route);
+			}
+
+			return $routes;
+		}
+	}
+
+	public function getRoutePoints($params)
+	{
+		$allQueryFields = ['route_id', 'route_path_output', 'compress_path_points', 'directions'];
+
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::ROUTE_V4,
+			'method' => 'GET',
+			'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $result;
+	}
+
+	public function duplicateRoute($routeIDs)
+	{
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::ROUTE_V4,
+			'method' => 'POST',
+			'body'   => [
+				'duplicate_routes_id' => $routeIDs
+			],
+		]);
+
+		return $result;
+	}
+
+	public function resequenceRoute($params)
+	{
+		$allQueryFields = ['route_id', 'route_destination_id'];
+		$allBodyFields = ['addresses'];
+
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::ROUTE_V4,
+			'method'    => 'PUT',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $result;
+	}
+
+	/**
+	 * @deprecated 'The method is obsolete, use the method ReoptimizeRoute instead.'
+	 * @param $params
+	 * @return mixed|string
+	 */
+	public function resequenceAllAddresses($params)
+	{
+		$allQueryFields = ['route_id', 'disable_optimization', 'optimize'];
+
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::REOPTIMIZE_V3_2,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $result;
+	}
+
+	/**
+	 * Reoptimize a route
+	 * @param $params type Route
+	 * @return mixed|string
+	 * @throws Exception\ApiError
+	 */
+	public function reoptimizeRoute($params)
+	{
+		$allQueryFields = ['route_id', 'reoptimize', 'remaining', 'device_type'];
+
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::ROUTE_V4,
+			'method'    => 'PUT',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $result;
+	}
+
+	/**
+	 * Merges the routes
+	 * @param $params array contains:
+	 * @param route_ids IDs of the routes to be merged.
+	 * @param depot_address a depot address of the merged route.
+	 * @param remove_origin if true, the origin routes will be removed.
+	 * @param depot_lat the depot's latitude
+	 * @param depot_lng the depot's longitude
+	 * @return Status response
+	 * @throws Exception\ApiError
+	 */
+	public function mergeRoutes($params)
+	{
+		$allBodyFields = ['route_ids', 'depot_address', 'remove_origin', 'depot_lat',  'depot_lng'];
+
+		$result = Route4Me::makeRequst([
+			'url'           => Endpoint::ROUTES_MERGE,
+			'method'        => 'POST',
+			'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data',
+		]);
+
+		return $result;
+	}
+
+	/**
+	 * Share a route by an email
+	 * @param $params RouteParametersQuery contains:
+	 * @param route_id a route ID to be shared.
+	 * @param response_format the response format.
+	 * @param recipient_email Recipient email.
+	 * @return Status response
+	 * @throws Exception\ApiError
+	 */
+	public function shareRoute($params)
+	{
+		$allQueryFields = ['route_id', 'response_format'];
+		$allBodyFields = ['recipient_email'];
+
+		$result = Route4Me::makeRequst([
+			'url'           => Endpoint::ROUTE_SHARE,
+			'method'        => 'POST',
+			'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data',
+		]);
+
+		return $result;
+	}
+
+	/**
+	 * Returns random route_id from existing routes between $offset and $offset+$limit
+	 * @param $offset integer The page number for route listing pagination.
+	 * @param $limit integer The maximum number of the returned routes.
+	 * @return string random route ID
+	 * @throws Exception\ApiError
+	 */
+	public function getRandomRouteId($offset, $limit)
+	{
+		$params = [
+			'offset'    => !is_null($offset) ? $offset : 0,
+			'limit'     => !is_null($limit) ? $limit : 30,
+		];
+
+		$route = new self();
+		$routes = $route->getRoutes($params);
+
+		if (is_null($routes) || sizeof($routes) < 1) {
+			echo '<br> There are no routes in the account. Please, create the routes first. <br>';
+
+			return null;
+		}
+
+		$randomIndex = rand(0, sizeof($routes) - 1);
+
+		return $routes[$randomIndex]->route_id;
+	}
+
+	/**
+	 * Update a route
+	 * @param $params array contains:
+	 * @param route_id string : route ID
+	 * @param reoptimize int : if equal to 1 the route re-optimized.
+	 * @param route_destination_id int : route destination ID
+	 * @param addresses Address[] : an array of a route addresses.
+	 * @param parameters RouteParameters : route parameters.
+	 * @param unlink_from_master_optimization  Boolean : if true, the route will be unlinked from optimization.
+	 * @return Route updated route
+	 * @throws Exception\ApiError
+	 */
+	public function updateRoute($params)
+	{
+		$allQueryFields = ['route_id', 'reoptimize','route_destination_id'];
+		$allBodyFields = ['addresses', 'parameters', 'unlink_from_master_optimization'];
+
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::ROUTE_V4,
+			'method'    => 'PUT',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'      => (isset($params['addresses']) || isset($params['parameters']) || isset($params['unlink_from_master_optimization']))
+							? Route4Me::generateRequestParameters($allBodyFields, $params)
+							: null,
+		]);
+
+		return $result;
+	}
+
+	public function update()
+	{
+		$route = Route4Me::makeRequst([
+			'url'    => Endpoint::ROUTE_V4,
+			'method' => 'PUT',
+			'query'  => [
+				'route_id' => isset($this->route_id) ? $this->route_id : null,
+			],
+			'body'   => [
+				'parameters' => $this->parameters,
+				],
+			'HTTPHEADER' => isset($this->httpheaders) ? $this->httpheaders : null,
+		]);
+
+		return self::fromArray($route);
+	}
+
+	public function updateAddress($address = null)
+	{
+		$body = sizeof($this->addresses) < 1 ? get_object_vars($this->parameters)
+			: (isset($this->addresses[0]) ? $this->addresses[0] : get_object_vars($this->parameters));
+
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::ADDRESS_V4,
+			'method' => 'PUT',
+			'query'  => [
+				'route_id' => isset($this->route_id) ? $this->route_id : null,
+				'route_destination_id' => isset($this->route_destination_id) ? $this->route_destination_id : null,
+			],
+			'body'   => $body,
+			'HTTPHEADER' => isset($this->httpheaders) ? $this->httpheaders : null,
+		]);
+
+		return $result;
+	}
+
+	public function updateRouteAddress()
+	{
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::ADDRESS_V4,
+			'method' => 'PUT',
+			'query'  => [
+				'route_id' => isset($this->route_id) ? $this->route_id : null,
+				'route_destination_id' => isset($this->route_destination_id) ? $this->route_destination_id : null,
+			],
+			'body'   => [
+				'parameters' => isset($this->parameters) ? get_object_vars($this->parameters) : null,
+				'addresses' => isset($this->addresses) ? $this->addresses : null,
+			],
+			'HTTPHEADER' => isset($this->httpheaders) ? $this->httpheaders : null,
+		]);
+
+		return $result;
+	}
+
+	public function addAddresses($params)
+	{
+		$allQueryFields = ['route_id'];
+		$allBodyFields = ['addresses'];
+
+		$route = Route4Me::makeRequst([
+			'url'           => Endpoint::ROUTE_V4,
+			'method'        => 'PUT',
+			'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER'    => isset($this->httpheaders) ? $this->httpheaders : null,
+		]);
+
+		return self::fromArray($route);
+	}
+
+	public function insertAddressOptimalPosition(array $params)
+	{
+		$allQueryFields = ['route_id'];
+		$allBodyFields = ['addresses', 'optimal_position'];
+
+		$route = Route4Me::makeRequst([
+			'url'    => Endpoint::ROUTE_V4,
+			'method' => 'PUT',
+			'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return self::fromArray($route);
+	}
+
+	public function addNoteFile($params)
+	{
+		$fname = isset($params['strFilename']) ? $params['strFilename'] : null;
+		$rpath = realpath($fname);
+
+		$allQueryFields = ['route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type'];
+		$allBodyFields = ['strUpdateType', 'strFilename', 'strNoteContents'];
+
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::ROUTE_NOTES_ADD,
+			'method' => 'POST',
+			'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'FILE'   => $rpath,
+			'HTTPHEADER' => [
+				'Content-Type: application/x-www-form-urlencoded',
+			],
+		]);
+
+		return $result;
+	}
+
+	public function deleteRoutes($route_id)
+	{
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::ROUTE_V4,
+			'method' => 'DELETE',
+			'query'  => [
+				'route_id' => $route_id,
+			],
+		]);
+
+		return $result;
+	}
+
+	public function GetAddressesFromRoute($route_id)
+	{
+		$route1 = self::getRoutes(['route_id' => $route_id]);
+
+		if (isset($route1)) {
+			return $route1->addresses;
+		} else {
+			return null;
+		}
+	}
+
+	public function GetRandomAddressFromRoute($route_id)
+	{
+		$route1 = self::getRoutes(['route_id' => $route_id]);
+
+		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)
+	{
+		$allQueryFields = ['route_id', 'device_tracking_history'];
+
+		$route = Route4Me::makeRequst([
+			'url'    => Endpoint::ROUTE_V4,
+			'method' => 'GET',
+			'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return self::fromArray($route);
+	}
+
+	public function GetTrackingHistoryFromTimeRange(array $params)
+	{
+		$allQueryFields = ['route_id', 'format', 'time_period', 'start_date', 'end_date'];
+
+		$route = Route4Me::makeRequst([
+			'url'    => Endpoint::GET_DEVICE_LOCATION,
+			'method' => 'GET',
+			'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $route;
+	}
+
+	public function GetAssetTracking(array $params)
+	{
+		$allQueryFields = ['tracking'];
+
+		$assetResponse = Route4Me::makeRequst([
+			'url'    => Endpoint::STATUS_V4,
+			'method' => 'GET',
+			'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $assetResponse;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -294,13 +294,13 @@ 
      * Route notes
      * @var AddressNote[]
      */
-    public $notes=[];
+    public $notes = [];
 
     /**
      * A vehicle assigned to the route.
      * @var Vehicles\VehicleResponseV4
      */
-    public $vehicle=[];
+    public $vehicle = [];
 
     /**
      * Member config key-value pairs.
@@ -413,7 +413,7 @@ 
      */
     public static function getRoutes($params = null)
     {
-        $allQueryFields = ['route_id', 'original', 'route_path_output', 'query', 'directions', 'device_tracking_history', 'limit', 'offset','start_date','end_date'];
+        $allQueryFields = ['route_id', 'original', 'route_path_output', 'query', 'directions', 'device_tracking_history', 'limit', 'offset', 'start_date', 'end_date'];
 
         $result = Route4Me::makeRequst([
             'url'       => Endpoint::ROUTE_V4,
@@ -528,7 +528,7 @@ 
      */
     public function mergeRoutes($params)
     {
-        $allBodyFields = ['route_ids', 'depot_address', 'remove_origin', 'depot_lat',  'depot_lng'];
+        $allBodyFields = ['route_ids', 'depot_address', 'remove_origin', 'depot_lat', 'depot_lng'];
 
         $result = Route4Me::makeRequst([
             'url'           => Endpoint::ROUTES_MERGE,
@@ -582,7 +582,7 @@ 
         $route = new self();
         $routes = $route->getRoutes($params);
 
-        if (is_null($routes) || sizeof($routes) < 1) {
+        if (is_null($routes) || sizeof($routes)<1) {
             echo '<br> There are no routes in the account. Please, create the routes first. <br>';
 
             return null;
@@ -607,7 +607,7 @@ 
      */
     public function updateRoute($params)
     {
-        $allQueryFields = ['route_id', 'reoptimize','route_destination_id'];
+        $allQueryFields = ['route_id', 'reoptimize', 'route_destination_id'];
         $allBodyFields = ['addresses', 'parameters', 'unlink_from_master_optimization'];
 
         $result = Route4Me::makeRequst([
@@ -641,7 +641,7 @@ 
 
     public function updateAddress($address = null)
     {
-        $body = sizeof($this->addresses) < 1 ? get_object_vars($this->parameters)
+        $body = sizeof($this->addresses)<1 ? get_object_vars($this->parameters)
             : (isset($this->addresses[0]) ? $this->addresses[0] : get_object_vars($this->parameters));
 
         $result = Route4Me::makeRequst([

src/Route4Me/Order.php

Indentation +320 added lines, -320 removed lines

@@ -6,329 +6,329 @@
 
 class Order extends Common
 {
-    public $address_1;
-    public $address_2;
-    public $cached_lat;
-    public $cached_lng;
-    public $curbside_lat;
-    public $curbside_lng;
-    public $address_alias;
-    public $address_city;
-    public $EXT_FIELD_first_name;
-    public $EXT_FIELD_last_name;
-    public $EXT_FIELD_email;
-    public $EXT_FIELD_phone;
-    public $EXT_FIELD_custom_data;
-
-    public $color;
-    public $order_icon;
-    public $local_time_window_start;
-    public $local_time_window_end;
-    public $local_time_window_start_2;
-    public $local_time_window_end_2;
-    public $service_time;
-
-    public $day_scheduled_for_YYMMDD;
-
-    public $route_id;
-    public $redirect;
-    public $optimization_problem_id;
-    public $order_id;
-    public $order_ids;
-
-    public $day_added_YYMMDD;
-    public $scheduled_for_YYMMDD;
-    public $fields;
-    public $offset;
-    public $limit;
-    public $query;
-
-    public $created_timestamp;
-    public $order_status_id;
-    public $member_id;
-    public $address_state_id;
-    public $address_country_id;
-    public $address_zip;
-    public $in_route_count;
-    public $last_visited_timestamp;
-    public $last_routed_timestamp;
-    public $local_timezone_string;
-    public $is_validated;
-    public $is_pending;
-    public $is_accepted;
-    public $is_started;
-    public $is_completed;
-    public $custom_user_fields;
-
-    public $addresses = [];
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-    }
-
-    public static function fromArray(array $params)
-    {
-        $order = new self();
-        foreach ($params as $key => $value) {
-            if (property_exists($order, $key)) {
-                $order->{$key} = $value;
-            }
-        }
-
-        return $order;
-    }
-
-    /**
-     * @param Order $params
-     */
-    public static function addOrder($params)
-    {
-        $excludeFields = ['route_id', 'redirect', 'optimization_problem_id', 'order_id',
-        'order_ids', 'fields', 'offset', 'limit', 'query', 'created_timestamp', ];
-
-        $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ORDER_V4,
-            'method'    => 'POST',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function addOrder2Route($params)
-    {
-        $allQueryFields = ['route_id', 'redirect'];
-        $allBodyFields = ['addresses'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ROUTE_V4,
-            'method'    => 'PUT',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function addOrder2Optimization($params)
-    {
-        $allQueryFields = ['optimization_problem_id', 'redirect', 'device_type'];
-        $allBodyFields  = ['addresses'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::OPTIMIZATION_PROBLEM,
-            'method'    => 'PUT',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function getOrder($params)
-    {
-        $allQueryFields = ['order_id', 'fields', 'day_added_YYMMDD', 'scheduled_for_YYMMDD', 'query', 'offset', 'limit'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ORDER_V4,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function getOrders($params)
-    {
-        $allQueryFields = ['offset', 'limit'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ORDER_V4,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public function getRandomOrderId($offset, $limit)
-    {
-        $randomOrder = $this->getRandomOrder($offset, $limit);
-
-        if (is_null($randomOrder) || !isset($randomOrder)) {
-            return null;
-        }
-
-        return $randomOrder['order_id'];
-    }
-
-    public function getRandomOrder($offset, $limit)
-    {
-        $params = ['offset' => $offset, 'limit' => $limit];
-
-        $orders = self::getOrders($params);
-
-        if (is_null($orders) || !isset($orders['results'])) {
-            return null;
-        }
-
-        $randomIndex = rand(0, sizeof($orders['results']) - 1);
-
-        $order = $orders['results'][$randomIndex];
-
-        return $order;
-    }
-
-    public static function removeOrder($params)
-    {
-        $allBodyFields = ['order_ids'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ORDER_V4,
-            'method'    => 'DELETE',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function updateOrder($params)
-    {
-        $excludeFields = ['route_id', 'redirect', 'optimization_problem_id',
-        'order_ids', 'fields', 'offset', 'limit', 'query', 'created_timestamp', ];
-
-        $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ORDER_V4,
-            'method'    => 'PUT',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function searchOrder($params)
-    {
-        $allQueryFields = ['fields', 'day_added_YYMMDD', 'scheduled_for_YYMMDD', 'query', 'offset', 'limit'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ORDER_V4,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
+	public $address_1;
+	public $address_2;
+	public $cached_lat;
+	public $cached_lng;
+	public $curbside_lat;
+	public $curbside_lng;
+	public $address_alias;
+	public $address_city;
+	public $EXT_FIELD_first_name;
+	public $EXT_FIELD_last_name;
+	public $EXT_FIELD_email;
+	public $EXT_FIELD_phone;
+	public $EXT_FIELD_custom_data;
+
+	public $color;
+	public $order_icon;
+	public $local_time_window_start;
+	public $local_time_window_end;
+	public $local_time_window_start_2;
+	public $local_time_window_end_2;
+	public $service_time;
+
+	public $day_scheduled_for_YYMMDD;
+
+	public $route_id;
+	public $redirect;
+	public $optimization_problem_id;
+	public $order_id;
+	public $order_ids;
+
+	public $day_added_YYMMDD;
+	public $scheduled_for_YYMMDD;
+	public $fields;
+	public $offset;
+	public $limit;
+	public $query;
+
+	public $created_timestamp;
+	public $order_status_id;
+	public $member_id;
+	public $address_state_id;
+	public $address_country_id;
+	public $address_zip;
+	public $in_route_count;
+	public $last_visited_timestamp;
+	public $last_routed_timestamp;
+	public $local_timezone_string;
+	public $is_validated;
+	public $is_pending;
+	public $is_accepted;
+	public $is_started;
+	public $is_completed;
+	public $custom_user_fields;
+
+	public $addresses = [];
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	}
+
+	public static function fromArray(array $params)
+	{
+		$order = new self();
+		foreach ($params as $key => $value) {
+			if (property_exists($order, $key)) {
+				$order->{$key} = $value;
+			}
+		}
+
+		return $order;
+	}
+
+	/**
+	 * @param Order $params
+	 */
+	public static function addOrder($params)
+	{
+		$excludeFields = ['route_id', 'redirect', 'optimization_problem_id', 'order_id',
+		'order_ids', 'fields', 'offset', 'limit', 'query', 'created_timestamp', ];
+
+		$allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ORDER_V4,
+			'method'    => 'POST',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function addOrder2Route($params)
+	{
+		$allQueryFields = ['route_id', 'redirect'];
+		$allBodyFields = ['addresses'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ROUTE_V4,
+			'method'    => 'PUT',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function addOrder2Optimization($params)
+	{
+		$allQueryFields = ['optimization_problem_id', 'redirect', 'device_type'];
+		$allBodyFields  = ['addresses'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::OPTIMIZATION_PROBLEM,
+			'method'    => 'PUT',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function getOrder($params)
+	{
+		$allQueryFields = ['order_id', 'fields', 'day_added_YYMMDD', 'scheduled_for_YYMMDD', 'query', 'offset', 'limit'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ORDER_V4,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function getOrders($params)
+	{
+		$allQueryFields = ['offset', 'limit'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ORDER_V4,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public function getRandomOrderId($offset, $limit)
+	{
+		$randomOrder = $this->getRandomOrder($offset, $limit);
+
+		if (is_null($randomOrder) || !isset($randomOrder)) {
+			return null;
+		}
+
+		return $randomOrder['order_id'];
+	}
+
+	public function getRandomOrder($offset, $limit)
+	{
+		$params = ['offset' => $offset, 'limit' => $limit];
+
+		$orders = self::getOrders($params);
+
+		if (is_null($orders) || !isset($orders['results'])) {
+			return null;
+		}
+
+		$randomIndex = rand(0, sizeof($orders['results']) - 1);
+
+		$order = $orders['results'][$randomIndex];
+
+		return $order;
+	}
+
+	public static function removeOrder($params)
+	{
+		$allBodyFields = ['order_ids'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ORDER_V4,
+			'method'    => 'DELETE',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function updateOrder($params)
+	{
+		$excludeFields = ['route_id', 'redirect', 'optimization_problem_id',
+		'order_ids', 'fields', 'offset', 'limit', 'query', 'created_timestamp', ];
+
+		$allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ORDER_V4,
+			'method'    => 'PUT',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function searchOrder($params)
+	{
+		$allQueryFields = ['fields', 'day_added_YYMMDD', 'scheduled_for_YYMMDD', 'query', 'offset', 'limit'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ORDER_V4,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
 
-    public static function validateCoordinate($coord)
-    {
-        $key = key($coord);
+	public static function validateCoordinate($coord)
+	{
+		$key = key($coord);
 
-        if (!is_numeric($coord[$key])) {
-            return false;
-        }
-
-        switch ($key) {
-        case 'cached_lat':
-        case 'curbside_lat':
-            if ($coord[$key] > 90 || $coord[$key] < -90) {
-                return false;
-            }
-            break;
-        case 'cached_lng':
-        case 'curbside_lng':
-            if ($coord[$key] > 180 || $coord[$key] < -180) {
-                return false;
-            }
-            break;
-        }
-
-        return true;
-    }
+		if (!is_numeric($coord[$key])) {
+			return false;
+		}
+
+		switch ($key) {
+		case 'cached_lat':
+		case 'curbside_lat':
+			if ($coord[$key] > 90 || $coord[$key] < -90) {
+				return false;
+			}
+			break;
+		case 'cached_lng':
+		case 'curbside_lng':
+			if ($coord[$key] > 180 || $coord[$key] < -180) {
+				return false;
+			}
+			break;
+		}
+
+		return true;
+	}
 
-    public function addOrdersFromCsvFile($csvFileHandle, $ordersFieldsMapping)
-    {
-        $max_line_length = 512;
-        $delemietr = ',';
-
-        $results = [];
-        $results['fail'] = [];
-        $results['success'] = [];
-
-        $columns = fgetcsv($csvFileHandle, $max_line_length, $delemietr);
+	public function addOrdersFromCsvFile($csvFileHandle, $ordersFieldsMapping)
+	{
+		$max_line_length = 512;
+		$delemietr = ',';
+
+		$results = [];
+		$results['fail'] = [];
+		$results['success'] = [];
+
+		$columns = fgetcsv($csvFileHandle, $max_line_length, $delemietr);
 
-        $excludeFields = ['route_id', 'redirect', 'optimization_problem_id', 'order_id',
-        'order_ids', 'fields', 'offset', 'limit', 'query', 'created_timestamp', ];
-
-        $allOrderFields = Route4Me::getObjectProperties(new self(), $excludeFields);
-
-        if (!empty($columns)) {
-            array_push($results['fail'], 'Empty CSV table');
+		$excludeFields = ['route_id', 'redirect', 'optimization_problem_id', 'order_id',
+		'order_ids', 'fields', 'offset', 'limit', 'query', 'created_timestamp', ];
+
+		$allOrderFields = Route4Me::getObjectProperties(new self(), $excludeFields);
+
+		if (!empty($columns)) {
+			array_push($results['fail'], 'Empty CSV table');
 
-            return $results;
-        }
-
-        $iRow = 1;
-
-        while (false !== ($rows = fgetcsv($csvFileHandle, $max_line_length, $delemietr))) {
-            if ($rows[$ordersFieldsMapping['cached_lat']] && $rows[$ordersFieldsMapping['cached_lng']] && $rows[$ordersFieldsMapping['address_1']] && [null] !== $rows) {
-                $cached_lat = 0.000;
-                $cached_lng = 0.000;
-
-                foreach (['cached_lat', 'cached_lng', 'curbside_lat', 'curbside_lng'] as $coord) {
-                    if (!$this->validateCoordinate([$coord => $rows[$ordersFieldsMapping[$coord]]])) {
-                        array_push($results['fail'], "$iRow --> Wrong " + $coord);
-                        ++$iRow;
-                        continue;
-                    } else {
-                        switch ($coord) {
-                        case 'cached_lat':
-                            $cached_lat = doubleval($rows[$ordersFieldsMapping[$coord]]);
-                            break;
-                        case 'cached_lng':
-                            $cached_lng = doubleval($rows[$ordersFieldsMapping[$coord]]);
-                            break;
-                        }
-                    }
-                }
-
-                $address = $rows[$ordersFieldsMapping['address_1']];
-
-                foreach (['order_city', 'order_state_id', 'order_zip_code', 'order_country_id'] as $addressPart) {
-                    if (isset($ordersFieldsMapping[$addressPart])) {
-                        $address .= ', '.$rows[$ordersFieldsMapping[$addressPart]];
-                    }
-                }
-
-                echo "$iRow --> ".$ordersFieldsMapping['day_scheduled_for_YYMMDD'].', '.$rows[$ordersFieldsMapping['day_scheduled_for_YYMMDD']].'<br>';
-
-                $parametersArray = [];
-
-                $parametersArray['cached_lat'] = $cached_lat;
-                $parametersArray['cached_lng'] = $cached_lng;
-
-                foreach ($allOrderFields as $orderField) {
-                    if (isset($ordersFieldsMapping[$orderField])) {
-                        $parametersArray[$orderField] = $rows[$ordersFieldsMapping[$orderField]];
-                    }
-                }
-
-                $orderParameters = self::fromArray($parametersArray);
-
-                $order = new self();
-
-                $orderResults = $order->addOrder($orderParameters);
-
-                array_push($results['success'], 'The order with order_id = '.strval($orderResults['order_id']).' added successfuly.');
-            } else {
-                array_push($results['fail'], "$iRow --> one of the parameters cached_lat, cached_lng, address_1 is not set");
-            }
-
-            ++$iRow;
-        }
-    }
+			return $results;
+		}
+
+		$iRow = 1;
+
+		while (false !== ($rows = fgetcsv($csvFileHandle, $max_line_length, $delemietr))) {
+			if ($rows[$ordersFieldsMapping['cached_lat']] && $rows[$ordersFieldsMapping['cached_lng']] && $rows[$ordersFieldsMapping['address_1']] && [null] !== $rows) {
+				$cached_lat = 0.000;
+				$cached_lng = 0.000;
+
+				foreach (['cached_lat', 'cached_lng', 'curbside_lat', 'curbside_lng'] as $coord) {
+					if (!$this->validateCoordinate([$coord => $rows[$ordersFieldsMapping[$coord]]])) {
+						array_push($results['fail'], "$iRow --> Wrong " + $coord);
+						++$iRow;
+						continue;
+					} else {
+						switch ($coord) {
+						case 'cached_lat':
+							$cached_lat = doubleval($rows[$ordersFieldsMapping[$coord]]);
+							break;
+						case 'cached_lng':
+							$cached_lng = doubleval($rows[$ordersFieldsMapping[$coord]]);
+							break;
+						}
+					}
+				}
+
+				$address = $rows[$ordersFieldsMapping['address_1']];
+
+				foreach (['order_city', 'order_state_id', 'order_zip_code', 'order_country_id'] as $addressPart) {
+					if (isset($ordersFieldsMapping[$addressPart])) {
+						$address .= ', '.$rows[$ordersFieldsMapping[$addressPart]];
+					}
+				}
+
+				echo "$iRow --> ".$ordersFieldsMapping['day_scheduled_for_YYMMDD'].', '.$rows[$ordersFieldsMapping['day_scheduled_for_YYMMDD']].'<br>';
+
+				$parametersArray = [];
+
+				$parametersArray['cached_lat'] = $cached_lat;
+				$parametersArray['cached_lng'] = $cached_lng;
+
+				foreach ($allOrderFields as $orderField) {
+					if (isset($ordersFieldsMapping[$orderField])) {
+						$parametersArray[$orderField] = $rows[$ordersFieldsMapping[$orderField]];
+					}
+				}
+
+				$orderParameters = self::fromArray($parametersArray);
+
+				$order = new self();
+
+				$orderResults = $order->addOrder($orderParameters);
+
+				array_push($results['success'], 'The order with order_id = '.strval($orderResults['order_id']).' added successfuly.');
+			} else {
+				array_push($results['fail'], "$iRow --> one of the parameters cached_lat, cached_lng, address_1 is not set");
+			}
+
+			++$iRow;
+		}
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -235,13 +235,13 @@ 
         switch ($key) {
         case 'cached_lat':
         case 'curbside_lat':
-            if ($coord[$key] > 90 || $coord[$key] < -90) {
+            if ($coord[$key]>90 || $coord[$key]<-90) {
                 return false;
             }
             break;
         case 'cached_lng':
         case 'curbside_lng':
-            if ($coord[$key] > 180 || $coord[$key] < -180) {
+            if ($coord[$key]>180 || $coord[$key]<-180) {
                 return false;
             }
             break;
@@ -274,14 +274,14 @@ 
 
         $iRow = 1;
 
-        while (false !== ($rows = fgetcsv($csvFileHandle, $max_line_length, $delemietr))) {
-            if ($rows[$ordersFieldsMapping['cached_lat']] && $rows[$ordersFieldsMapping['cached_lng']] && $rows[$ordersFieldsMapping['address_1']] && [null] !== $rows) {
+        while (false!==($rows = fgetcsv($csvFileHandle, $max_line_length, $delemietr))) {
+            if ($rows[$ordersFieldsMapping['cached_lat']] && $rows[$ordersFieldsMapping['cached_lng']] && $rows[$ordersFieldsMapping['address_1']] && [null]!==$rows) {
                 $cached_lat = 0.000;
                 $cached_lng = 0.000;
 
                 foreach (['cached_lat', 'cached_lng', 'curbside_lat', 'curbside_lng'] as $coord) {
                     if (!$this->validateCoordinate([$coord => $rows[$ordersFieldsMapping[$coord]]])) {
-                        array_push($results['fail'], "$iRow --> Wrong " + $coord);
+                        array_push($results['fail'], "$iRow --> Wrong " +$coord);
                         ++$iRow;
                         continue;
                     } else {

src/Route4Me/AvoidanceZone.php

Indentation +112 added lines, -112 removed lines

@@ -7,116 +7,116 @@
 
 class AvoidanceZone extends Common
 {
-    public $territory_id; // Avoidance zone id
-    public $territory_name;
-    public $territory_color;
-    public $orders;
-    public $member_id;
-    public $territory; // Territory parameters
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-    }
-
-    public static function fromArray(array $params)
-    {
-        if (!isset($params['territory_name'])) {
-            throw new BadParam('Territory name must be provided');
-        }
-
-        if (!isset($params['territory_color'])) {
-            throw new BadParam('Territory color must be provided');
-        }
-
-        if (!isset($params['territory'])) {
-            throw new BadParam('Territory must be provided');
-        }
-
-        $avoidanceZoneParameters = new self();
-
-        foreach ($params as $key => $value) {
-            if (property_exists($avoidanceZoneParameters, $key)) {
-                $avoidanceZoneParameters->{$key} = $value;
-            }
-        }
-
-        return $avoidanceZoneParameters;
-    }
-
-    public static function getAvoidanceZone($territory_id)
-    {
-        $avoidanceZone = Route4Me::makeRequst([
-            'url'       => Endpoint::AVOIDANCE_ZONE,
-            'method'    => 'GET',
-            'query'     => [
-                'territory_id' => $territory_id,
-            ],
-        ]);
-
-        return $avoidanceZone;
-    }
-
-    public static function getAvoidanceZones($params)
-    {
-        $avoidanceZones = Route4Me::makeRequst([
-            'url'       => Endpoint::AVOIDANCE_ZONE,
-            'method'    => 'GET',
-            'query'     => [
-                'offset' => isset($params->offset) ? $params->offset : null,
-                'limit'  => isset($params->limit) ? $params->limit : null,
-            ],
-        ]);
-
-        return $avoidanceZones;
-    }
-
-    public static function addAvoidanceZone($params)
-    {
-        $terParams = [];
-
-        if (isset($params->territory['type'])) {
-            $terParams['type'] = $params->territory['type'];
-        }
-
-        if (isset($params->territory['data'])) {
-            $terParams['data'] = $params->territory['data'];
-        }
-
-        $abContacts = Route4Me::makeRequst([
-            'url'       => Endpoint::AVOIDANCE_ZONE,
-            'method'    => 'POST',
-            'body'      => [
-                'territory_name'    => isset($params->territory_name) ? $params->territory_name : null,
-                'territory_color'   => isset($params->territory_color) ? $params->territory_color : null,
-                'territory'         => $terParams,
-            ],
-        ]);
-
-        return $abContacts;
-    }
-
-    public function deleteAvoidanceZone($territory_id)
-    {
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::AVOIDANCE_ZONE,
-            'method'    => 'DELETEARRAY',
-            'query'     => [
-                'territory_id' => $territory_id,
-            ],
-        ]);
-
-        return $result;
-    }
-
-    public function updateAvoidanceZone($params)
-    {
-        $avoidanceZone = Route4Me::makeRequst([
-            'url'       => Endpoint::AVOIDANCE_ZONE,
-            'method'    => 'PUT',
-            'body'      => $params,
-        ]);
-
-        return $avoidanceZone;
-    }
+	public $territory_id; // Avoidance zone id
+	public $territory_name;
+	public $territory_color;
+	public $orders;
+	public $member_id;
+	public $territory; // Territory parameters
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	}
+
+	public static function fromArray(array $params)
+	{
+		if (!isset($params['territory_name'])) {
+			throw new BadParam('Territory name must be provided');
+		}
+
+		if (!isset($params['territory_color'])) {
+			throw new BadParam('Territory color must be provided');
+		}
+
+		if (!isset($params['territory'])) {
+			throw new BadParam('Territory must be provided');
+		}
+
+		$avoidanceZoneParameters = new self();
+
+		foreach ($params as $key => $value) {
+			if (property_exists($avoidanceZoneParameters, $key)) {
+				$avoidanceZoneParameters->{$key} = $value;
+			}
+		}
+
+		return $avoidanceZoneParameters;
+	}
+
+	public static function getAvoidanceZone($territory_id)
+	{
+		$avoidanceZone = Route4Me::makeRequst([
+			'url'       => Endpoint::AVOIDANCE_ZONE,
+			'method'    => 'GET',
+			'query'     => [
+				'territory_id' => $territory_id,
+			],
+		]);
+
+		return $avoidanceZone;
+	}
+
+	public static function getAvoidanceZones($params)
+	{
+		$avoidanceZones = Route4Me::makeRequst([
+			'url'       => Endpoint::AVOIDANCE_ZONE,
+			'method'    => 'GET',
+			'query'     => [
+				'offset' => isset($params->offset) ? $params->offset : null,
+				'limit'  => isset($params->limit) ? $params->limit : null,
+			],
+		]);
+
+		return $avoidanceZones;
+	}
+
+	public static function addAvoidanceZone($params)
+	{
+		$terParams = [];
+
+		if (isset($params->territory['type'])) {
+			$terParams['type'] = $params->territory['type'];
+		}
+
+		if (isset($params->territory['data'])) {
+			$terParams['data'] = $params->territory['data'];
+		}
+
+		$abContacts = Route4Me::makeRequst([
+			'url'       => Endpoint::AVOIDANCE_ZONE,
+			'method'    => 'POST',
+			'body'      => [
+				'territory_name'    => isset($params->territory_name) ? $params->territory_name : null,
+				'territory_color'   => isset($params->territory_color) ? $params->territory_color : null,
+				'territory'         => $terParams,
+			],
+		]);
+
+		return $abContacts;
+	}
+
+	public function deleteAvoidanceZone($territory_id)
+	{
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::AVOIDANCE_ZONE,
+			'method'    => 'DELETEARRAY',
+			'query'     => [
+				'territory_id' => $territory_id,
+			],
+		]);
+
+		return $result;
+	}
+
+	public function updateAvoidanceZone($params)
+	{
+		$avoidanceZone = Route4Me::makeRequst([
+			'url'       => Endpoint::AVOIDANCE_ZONE,
+			'method'    => 'PUT',
+			'body'      => $params,
+		]);
+
+		return $avoidanceZone;
+	}
 }

src/Route4Me/ActivityParameters.php

Indentation +76 added lines, -76 removed lines

@@ -6,92 +6,92 @@
 
 class ActivityParameters extends Common
 {
-    public $route_id;
-    public $device_id;
-    public $member_id;
-    public $team;
-    public $limit;
-    public $offset;
-    public $start;
-    public $end;
-    public $activity_type;
-    public $activity_message;
-
-    public $activity_id;
-    public $activity_timestamp;
-    public $route_destination_id;
-    public $note_id;
-    public $member;
-    public $note_type;
-    public $note_contents;
-    public $route_name;
-    public $note_file;
-    public $destination_name;
-    public $destination_alias;
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-    }
-
-    public static function fromArray(array $params)
-    {
-        $activityparameters = new self();
-
-        foreach ($params as $key => $value) {
-            if (property_exists($activityparameters, $key)) {
-                $activityparameters->{$key} = $value;
-            }
-        }
-
-        return $activityparameters;
-    }
-
-    /*
+	public $route_id;
+	public $device_id;
+	public $member_id;
+	public $team;
+	public $limit;
+	public $offset;
+	public $start;
+	public $end;
+	public $activity_type;
+	public $activity_message;
+
+	public $activity_id;
+	public $activity_timestamp;
+	public $route_destination_id;
+	public $note_id;
+	public $member;
+	public $note_type;
+	public $note_contents;
+	public $route_name;
+	public $note_file;
+	public $destination_name;
+	public $destination_alias;
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	}
+
+	public static function fromArray(array $params)
+	{
+		$activityparameters = new self();
+
+		foreach ($params as $key => $value) {
+			if (property_exists($activityparameters, $key)) {
+				$activityparameters->{$key} = $value;
+			}
+		}
+
+		return $activityparameters;
+	}
+
+	/*
      * Get all the activities limited by query parameters.
      */
-    public static function getActivities($params)
-    {
-        $allQueryFields = ['route_id', 'team', 'limit', 'offset', 'start', 'member_id'];
+	public static function getActivities($params)
+	{
+		$allQueryFields = ['route_id', 'team', 'limit', 'offset', 'start', 'member_id'];
 
-        $activity = Route4Me::makeRequst([
-            'url'       => Endpoint::GET_ACTIVITIES,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
+		$activity = Route4Me::makeRequst([
+			'url'       => Endpoint::GET_ACTIVITIES,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
 
-        return $activity;
-    }
+		return $activity;
+	}
 
-    /*
+	/*
      * Returns the activity feed.
      */
-    public static function searchActivities($params)
-    {
-        $allQueryFields = ['route_id', 'limit', 'offset', 'activity_type'];
+	public static function searchActivities($params)
+	{
+		$allQueryFields = ['route_id', 'limit', 'offset', 'activity_type'];
 
-        $activity = Route4Me::makeRequst([
-            'url'       => Endpoint::GET_ACTIVITIES,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
+		$activity = Route4Me::makeRequst([
+			'url'       => Endpoint::GET_ACTIVITIES,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
 
-        return $activity;
-    }
+		return $activity;
+	}
 
-    /*
+	/*
      * Creates a user's activity by sending a custom message to the activity stream.
      */
-    public static function sendUserMessage($params)
-    {
-        $allBodyFields = ['activity_type', 'activity_message', 'route_id'];
-
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::ACTIVITY_FEED,
-            'method'    => 'POST',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $result;
-    }
+	public static function sendUserMessage($params)
+	{
+		$allBodyFields = ['activity_type', 'activity_message', 'route_id'];
+
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::ACTIVITY_FEED,
+			'method'    => 'POST',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $result;
+	}
 }

src/Route4Me/OptimizationProblem.php

Indentation +322 added lines, -322 removed lines

@@ -6,185 +6,185 @@ 
 
 class OptimizationProblem extends Common
 {
-    /**
-     * Optimization problem ID
-     * @var string
-     */
-    public $optimization_problem_id;
-
-    /**
-     * Smart Optimization Problem ID
-     * @var string
-     */
-    public $smart_optimization_id;
-
-    /**
-     * An array of the user errors.
-     * @var string[]
-     */
-    public $user_errors = [];
-
-    /**
-     * An optimization problem state.<br>
-     * Available values:
-     * - OptimizationStateNew = 0,
-     * - Initial = 1,
-     * - MatrixProcessing = 2,
-     * - Optimizing = 3,
-     * - Optimized = 4,
-     * - Error = 5,
-     * - ComputingDirections = 6,
-     * - OptimizationStateInQueue = 7
-     * @var int
-     */
-    public $state;
-
-    /**
-     * An array of the optimization errors.
-     * @var string[]
-     */
-    public $optimization_errors = [];
-
-    /**
-     * Route Parameters.
-     * @var RouteParameters
-     */
-    public $parameters;
-
-    /**
-     * If true it means the solution was not returned (it is being computed in the background).
-     * @var boolean
-     */
-    public $sent_to_background;
-
-    /**
-     * When the optimization problem was created.
-     * @var long
-     */
-    public $created_timestamp;
-
-    /**
-     * An Unix Timestamp the Optimization Problem was scheduled for.
-     * @var long
-     */
-    public $scheduled_for;
-
-    /**
-     * When the optimization completed.
-     * @var long
-     */
-    public $optimization_completed_timestamp;
-
-    /**
-     * An array ot the Address type objects.
-     * @var Address[]
-     */
-    public $addresses = [];
-
-    /**
-     * An array ot the DataObjectRoute type objects.<br>
-     * The routes included in the optimization problem.
-     * @var Route[]
-     */
-    public $routes = [];
-
-    /** @var string[] $links
-     * The links to the GET operations for the optimization problem.
-     */
-    public $links = [];
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-        $this->parameters = new RouteParameters();
-    }
-
-    public static function fromArray(array $params)
-    {
-        $problem = new self();
-        $problem->optimization_problem_id = Common::getValue($params, 'optimization_problem_id');
-        $problem->user_errors = Common::getValue($params, 'user_errors', []);
-        $problem->state = Common::getValue($params, 'state', []);
-        $problem->sent_to_background = Common::getValue($params, 'sent_to_background', []);
-        $problem->links = Common::getValue($params, 'links', []);
-
-        if (isset($params['parameters'])) {
-            $problem->parameters = RouteParameters::fromArray($params['parameters']);
-        }
-
-        if (isset($params['addresses'])) {
-            $addresses = [];
-
-            foreach ($params['addresses'] as $address) {
-                $addresses[] = Address::fromArray($address);
-            }
-
-            $problem->addresses = $addresses;
-        }
-
-        if (isset($params['routes'])) {
-            $routes = [];
-
-            foreach ($params['routes'] as $route) {
-                $routes[] = Route::fromArray($route);
-            }
-
-            $problem->routes = $routes;
-        }
-
-        return $problem;
-    }
-
-    public static function optimize(OptimizationProblemParams $params)
-    {
-        $allQueryFields = ['redirect', 'directions', 'format', 'route_path_output', 'optimized_callback_url'];
-
-        $optimize = Route4Me::makeRequst([
-            'url'       => Endpoint::OPTIMIZATION_PROBLEM,
-            'method'    => 'POST',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'      => [
-                'addresses'     => $params->getAddressesArray(),
-                'depots'        => $params->getDepotsArray(),
-                'parameters'    => $params->getParametersArray(),
-            ],
-        ]);
-
-        return self::fromArray($optimize);
-    }
-
-    public static function get($params)
-    {
-        $allQueryFields = ['state', 'limit', 'format', 'offset',
-        'optimization_problem_id', 'wait_for_final_state','start_date','end_date', ];
-
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::OPTIMIZATION_PROBLEM,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        if (isset($result['optimizations'])) {
-            $problems = [];
-
-            foreach ($result['optimizations'] as $problem) {
-                $problems[] = self::fromArray($problem);
-            }
-
-            return $problems;
-        } else {
-            return self::fromArray($result);
-        }
-    }
-
-    public function reoptimize($params)
-    {
-        $param['reoptimize'] = 1;
-
-        return self::update($params);
-    }
-
-    /*
+	/**
+	 * Optimization problem ID
+	 * @var string
+	 */
+	public $optimization_problem_id;
+
+	/**
+	 * Smart Optimization Problem ID
+	 * @var string
+	 */
+	public $smart_optimization_id;
+
+	/**
+	 * An array of the user errors.
+	 * @var string[]
+	 */
+	public $user_errors = [];
+
+	/**
+	 * An optimization problem state.<br>
+	 * Available values:
+	 * - OptimizationStateNew = 0,
+	 * - Initial = 1,
+	 * - MatrixProcessing = 2,
+	 * - Optimizing = 3,
+	 * - Optimized = 4,
+	 * - Error = 5,
+	 * - ComputingDirections = 6,
+	 * - OptimizationStateInQueue = 7
+	 * @var int
+	 */
+	public $state;
+
+	/**
+	 * An array of the optimization errors.
+	 * @var string[]
+	 */
+	public $optimization_errors = [];
+
+	/**
+	 * Route Parameters.
+	 * @var RouteParameters
+	 */
+	public $parameters;
+
+	/**
+	 * If true it means the solution was not returned (it is being computed in the background).
+	 * @var boolean
+	 */
+	public $sent_to_background;
+
+	/**
+	 * When the optimization problem was created.
+	 * @var long
+	 */
+	public $created_timestamp;
+
+	/**
+	 * An Unix Timestamp the Optimization Problem was scheduled for.
+	 * @var long
+	 */
+	public $scheduled_for;
+
+	/**
+	 * When the optimization completed.
+	 * @var long
+	 */
+	public $optimization_completed_timestamp;
+
+	/**
+	 * An array ot the Address type objects.
+	 * @var Address[]
+	 */
+	public $addresses = [];
+
+	/**
+	 * An array ot the DataObjectRoute type objects.<br>
+	 * The routes included in the optimization problem.
+	 * @var Route[]
+	 */
+	public $routes = [];
+
+	/** @var string[] $links
+	 * The links to the GET operations for the optimization problem.
+	 */
+	public $links = [];
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+		$this->parameters = new RouteParameters();
+	}
+
+	public static function fromArray(array $params)
+	{
+		$problem = new self();
+		$problem->optimization_problem_id = Common::getValue($params, 'optimization_problem_id');
+		$problem->user_errors = Common::getValue($params, 'user_errors', []);
+		$problem->state = Common::getValue($params, 'state', []);
+		$problem->sent_to_background = Common::getValue($params, 'sent_to_background', []);
+		$problem->links = Common::getValue($params, 'links', []);
+
+		if (isset($params['parameters'])) {
+			$problem->parameters = RouteParameters::fromArray($params['parameters']);
+		}
+
+		if (isset($params['addresses'])) {
+			$addresses = [];
+
+			foreach ($params['addresses'] as $address) {
+				$addresses[] = Address::fromArray($address);
+			}
+
+			$problem->addresses = $addresses;
+		}
+
+		if (isset($params['routes'])) {
+			$routes = [];
+
+			foreach ($params['routes'] as $route) {
+				$routes[] = Route::fromArray($route);
+			}
+
+			$problem->routes = $routes;
+		}
+
+		return $problem;
+	}
+
+	public static function optimize(OptimizationProblemParams $params)
+	{
+		$allQueryFields = ['redirect', 'directions', 'format', 'route_path_output', 'optimized_callback_url'];
+
+		$optimize = Route4Me::makeRequst([
+			'url'       => Endpoint::OPTIMIZATION_PROBLEM,
+			'method'    => 'POST',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'      => [
+				'addresses'     => $params->getAddressesArray(),
+				'depots'        => $params->getDepotsArray(),
+				'parameters'    => $params->getParametersArray(),
+			],
+		]);
+
+		return self::fromArray($optimize);
+	}
+
+	public static function get($params)
+	{
+		$allQueryFields = ['state', 'limit', 'format', 'offset',
+		'optimization_problem_id', 'wait_for_final_state','start_date','end_date', ];
+
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::OPTIMIZATION_PROBLEM,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		if (isset($result['optimizations'])) {
+			$problems = [];
+
+			foreach ($result['optimizations'] as $problem) {
+				$problems[] = self::fromArray($problem);
+			}
+
+			return $problems;
+		} else {
+			return self::fromArray($result);
+		}
+	}
+
+	public function reoptimize($params)
+	{
+		$param['reoptimize'] = 1;
+
+		return self::update($params);
+	}
+
+	/*
      * Updates an existing optimization problem.<br>
      * @param array $params with items:
      * - optimization_problem_id   : query parameter. ID of an updated optimization;
@@ -193,151 +193,151 @@ 
      * - parameters                : body parameter. Modified route parameters;
      * @return Optimization problem
      */
-    public static function update($params)
-    {
-        $allQueryFields = ['optimization_problem_id', 'reoptimize'];
-        $allBodyFields = ['addresses', 'parameters'];
-
-        $query = is_array($params)
-                    ? (isset($params['optimization_problem_id']) || isset($params['parameters']))
-                        ? Route4Me::generateRequestParameters($allQueryFields, $params)
-                        : null
-                    : (isset($params->optimization_problem_id) || isset($params->parameters))
-                        ? Route4Me::generateRequestParameters($allQueryFields, $params)
-                        : null;
-
-        $body = is_array($params)
-            ? (isset($params['addresses']) && sizeof($params['addresses'])>0) ||
-            (isset($params['parameters']) && sizeof($params['parameters'])>0)
-                ? Route4Me::generateRequestParameters($allBodyFields, $params)
-                : null
-            : (isset($params->addresses) && sizeof($params->addresses)>0) ||
-                (isset($params->parameters) && sizeof($params->parameters)>0)
-                    ? Route4Me::generateRequestParameters($allBodyFields, $params)
-                    : null;
-
-        $optimize = Route4Me::makeRequst([
-            'url'       => Endpoint::OPTIMIZATION_PROBLEM,
-            'method'    => 'PUT',
-            'query'     => $query,
-            'body'      => $body,
-        ]);
-
-        return $optimize;
-    }
-
-    public function getOptimizationId()
-    {
-        return $this->optimization_problem_id;
-    }
-
-    public function getRoutes()
-    {
-        return $this->routes;
-    }
-
-    public function getRandomOptimizationId($offset, $limit)
-    {
-        $optimizations = self::get(['offset' => $offset, 'limit' => $limit]);
-
-        $rOptimization = $optimizations[rand(0, sizeof($optimizations) - 1)];
-
-        if (!isset($rOptimization->optimization_problem_id)) {
-            if (sizeof($optimizations) > 9) {
-                $this->getRandomOptimizationId($offset, $limit);
-            } else {
-                return null;
-            }
-        }
-
-        return $rOptimization->optimization_problem_id;
-    }
-
-    public function getAddresses($opt_id)
-    {
-        if (null == $opt_id) {
-            return null;
-        }
-
-        $params = ['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 (null == $addresses) {
-            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)
-    {
-        $allQueryFields = ['optimization_problem_id', 'route_destination_id'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_V4,
-            'method'    => 'DELETE',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public function removeOptimization($params)
-    {
-        $allQueryFields = ['redirect'];
-        $allBodyFields = ['optimization_problem_ids'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::OPTIMIZATION_PROBLEM,
-            'method'    => 'DELETE',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public function getHybridOptimization($params)
-    {
-        $allQueryFields = ['target_date_string', 'timezone_offset_minutes'];
-
-        $optimize = Route4Me::makeRequst([
-            'url'       => Endpoint::HYBRID_DATE_OPTIMIZATION,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
+	public static function update($params)
+	{
+		$allQueryFields = ['optimization_problem_id', 'reoptimize'];
+		$allBodyFields = ['addresses', 'parameters'];
+
+		$query = is_array($params)
+					? (isset($params['optimization_problem_id']) || isset($params['parameters']))
+						? Route4Me::generateRequestParameters($allQueryFields, $params)
+						: null
+					: (isset($params->optimization_problem_id) || isset($params->parameters))
+						? Route4Me::generateRequestParameters($allQueryFields, $params)
+						: null;
+
+		$body = is_array($params)
+			? (isset($params['addresses']) && sizeof($params['addresses'])>0) ||
+			(isset($params['parameters']) && sizeof($params['parameters'])>0)
+				? Route4Me::generateRequestParameters($allBodyFields, $params)
+				: null
+			: (isset($params->addresses) && sizeof($params->addresses)>0) ||
+				(isset($params->parameters) && sizeof($params->parameters)>0)
+					? Route4Me::generateRequestParameters($allBodyFields, $params)
+					: null;
+
+		$optimize = Route4Me::makeRequst([
+			'url'       => Endpoint::OPTIMIZATION_PROBLEM,
+			'method'    => 'PUT',
+			'query'     => $query,
+			'body'      => $body,
+		]);
+
+		return $optimize;
+	}
+
+	public function getOptimizationId()
+	{
+		return $this->optimization_problem_id;
+	}
+
+	public function getRoutes()
+	{
+		return $this->routes;
+	}
+
+	public function getRandomOptimizationId($offset, $limit)
+	{
+		$optimizations = self::get(['offset' => $offset, 'limit' => $limit]);
+
+		$rOptimization = $optimizations[rand(0, sizeof($optimizations) - 1)];
+
+		if (!isset($rOptimization->optimization_problem_id)) {
+			if (sizeof($optimizations) > 9) {
+				$this->getRandomOptimizationId($offset, $limit);
+			} else {
+				return null;
+			}
+		}
+
+		return $rOptimization->optimization_problem_id;
+	}
+
+	public function getAddresses($opt_id)
+	{
+		if (null == $opt_id) {
+			return null;
+		}
+
+		$params = ['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 (null == $addresses) {
+			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)
+	{
+		$allQueryFields = ['optimization_problem_id', 'route_destination_id'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_V4,
+			'method'    => 'DELETE',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public function removeOptimization($params)
+	{
+		$allQueryFields = ['redirect'];
+		$allBodyFields = ['optimization_problem_ids'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::OPTIMIZATION_PROBLEM,
+			'method'    => 'DELETE',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public function getHybridOptimization($params)
+	{
+		$allQueryFields = ['target_date_string', 'timezone_offset_minutes'];
+
+		$optimize = Route4Me::makeRequst([
+			'url'       => Endpoint::HYBRID_DATE_OPTIMIZATION,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
 
-        return $optimize;
-    }
+		return $optimize;
+	}
 
-    public function addDepotsToHybrid($params)
-    {
-        $allQueryFields = ['optimization_problem_id'];
-        $allBodyFields = ['optimization_problem_id', 'delete_old_depots', 'new_depots'];
+	public function addDepotsToHybrid($params)
+	{
+		$allQueryFields = ['optimization_problem_id'];
+		$allBodyFields = ['optimization_problem_id', 'delete_old_depots', 'new_depots'];
 
-        $depots = Route4Me::makeRequst([
-            'url'       => Endpoint::CHANGE_HYBRID_OPTIMIZATION_DEPOT,
-            'method'    => 'POST',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
+		$depots = Route4Me::makeRequst([
+			'url'       => Endpoint::CHANGE_HYBRID_OPTIMIZATION_DEPOT,
+			'method'    => 'POST',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
 
-        return $depots;
-    }
+		return $depots;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -156,7 +156,7 @@ 
     public static function get($params)
     {
         $allQueryFields = ['state', 'limit', 'format', 'offset',
-        'optimization_problem_id', 'wait_for_final_state','start_date','end_date', ];
+        'optimization_problem_id', 'wait_for_final_state', 'start_date', 'end_date', ];
 
         $result = Route4Me::makeRequst([
             'url'       => Endpoint::OPTIMIZATION_PROBLEM,
@@ -243,7 +243,7 @@ 
         $rOptimization = $optimizations[rand(0, sizeof($optimizations) - 1)];
 
         if (!isset($rOptimization->optimization_problem_id)) {
-            if (sizeof($optimizations) > 9) {
+            if (sizeof($optimizations)>9) {
                 $this->getRandomOptimizationId($offset, $limit);
             } else {
                 return null;
@@ -255,13 +255,13 @@ 
 
     public function getAddresses($opt_id)
     {
-        if (null == $opt_id) {
+        if (null==$opt_id) {
             return null;
         }
 
         $params = ['optimization_problem_id' => $opt_id];
 
-        $optimization = (array) $this->get($params);
+        $optimization = (array)$this->get($params);
 
         $addresses = $optimization['addresses'];
 
@@ -270,9 +270,9 @@ 
 
     public function getRandomAddressFromOptimization($opt_id)
     {
-        $addresses = (array) $this->getAddresses($opt_id);
+        $addresses = (array)$this->getAddresses($opt_id);
 
-        if (null == $addresses) {
+        if (null==$addresses) {
             echo 'There are no addresses in this optimization!.. Try again.';
 
             return null;

src/Route4Me/TelematicsGateway/TelematicsVendorsResponse.php

Indentation +5 added lines, -5 removed lines

@@ -9,9 +9,9 @@
  */
 class TelematicsVendorsResponse 
 {
-    /**
-     * An array of the telematics vendors.
-     * @var type TelematicsVendors[]
-     */
-    public $vendors = [];
+	/**
+	 * An array of the telematics vendors.
+	 * @var type TelematicsVendors[]
+	 */
+	public $vendors = [];
 }

src/Route4Me/TelematicsGateway/TelematicsConnectionParameters.php

Indentation +70 added lines, -70 removed lines

@@ -9,88 +9,88 @@
  */
 class TelematicsConnectionParameters extends Common
 {
-    /**
-     * Account ID
-     * @var type string
-     */
-    public $account_id;
+	/**
+	 * Account ID
+	 * @var type string
+	 */
+	public $account_id;
     
-    /**
-     * User name
-     * @var type string
-     */
-    public $username;
+	/**
+	 * User name
+	 * @var type string
+	 */
+	public $username;
     
-    /**
-     * Password
-     * @var type string
-     */
-    public $password;
+	/**
+	 * Password
+	 * @var type string
+	 */
+	public $password;
     
-    /**
-     * Connection host
-     * @var type string
-     */
-    public $host;
+	/**
+	 * Connection host
+	 * @var type string
+	 */
+	public $host;
     
-    /**
-     * An unique ID of a telematics vendor.
-     * @var type integer
-     */
-    public $vendor_id;
+	/**
+	 * An unique ID of a telematics vendor.
+	 * @var type integer
+	 */
+	public $vendor_id;
     
-    /**
-     * Telematics connection name
-     * @var type string
-     */
-    public $name;
+	/**
+	 * Telematics connection name
+	 * @var type string
+	 */
+	public $name;
     
-    /**
-     * Vehicle tracking interval in seconds
-     * @var type integer
-     */
-    public $vehicle_position_refresh_rate;
+	/**
+	 * Vehicle tracking interval in seconds
+	 * @var type integer
+	 */
+	public $vehicle_position_refresh_rate;
     
-    /**
-     * Connection token
-     * @var type string
-     */
-    public $connection_token;
+	/**
+	 * Connection token
+	 * @var type string
+	 */
+	public $connection_token;
     
-    /**
-     * Connection user ID
-     * @var type integer
-     */
-    public $user_id;
+	/**
+	 * Connection user ID
+	 * @var type integer
+	 */
+	public $user_id;
     
-    /**
-     * Connection ID
-     * @var type integer
-     */
-    public $id;
+	/**
+	 * Connection ID
+	 * @var type integer
+	 */
+	public $id;
     
-    /**
-     * Telemetics connection type
-     * @var type string
-     */
-    public $vendor;
+	/**
+	 * Telemetics connection type
+	 * @var type string
+	 */
+	public $vendor;
     
-    /**
-     * Validate connections credentials.
-     * @var type Boolean
-     */
-    public $validate_remote_credentials;
+	/**
+	 * Validate connections credentials.
+	 * @var type Boolean
+	 */
+	public $validate_remote_credentials;
 
-    public static function fromArray(array $params)
-    {
-        $thisParams = new self();
+	public static function fromArray(array $params)
+	{
+		$thisParams = new self();
 
-        foreach ($params as $key => $value) {
-            if (property_exists($thisParams, $key)) {
-                $thisParams->{$key} = $value;
-            }
-        }
+		foreach ($params as $key => $value) {
+			if (property_exists($thisParams, $key)) {
+				$thisParams->{$key} = $value;
+			}
+		}
 
-        return $thisParams;
-    }
+		return $thisParams;
+	}
 }

src/Route4Me/TelematicsGateway/TelematicsConnection.php

Indentation +231 added lines, -231 removed lines

@@ -11,279 +11,279 @@
  */
 class TelematicsConnection extends \Route4Me\Common
 {
-    /**
-     * Telematics connection access account_id
-     * @var string
-     */
-    public $account_id;
+	/**
+	 * Telematics connection access account_id
+	 * @var string
+	 */
+	public $account_id;
     
-    /**
-     * Telematics connection access username
-     * @var string
-     */
-    public $username;
+	/**
+	 * Telematics connection access username
+	 * @var string
+	 */
+	public $username;
     
-    /**
-     * Telematics connection access password
-     * @var string
-     */
-    public $password;
+	/**
+	 * Telematics connection access password
+	 * @var string
+	 */
+	public $password;
     
-    /**
-     * Telematics connection access host
-     * @var string
-     */
-    public $host;
+	/**
+	 * Telematics connection access host
+	 * @var string
+	 */
+	public $host;
     
-    /**
-     * Telematics connection access api_key
-     * @var string
-     */
-    public $api_key;
+	/**
+	 * Telematics connection access api_key
+	 * @var string
+	 */
+	public $api_key;
     
-    /**
-     * Telemetics connection type ID
-     * @var integer
-     */
-    public $vendor_id;
+	/**
+	 * Telemetics connection type ID
+	 * @var integer
+	 */
+	public $vendor_id;
     
-    /**
-     * Telemetics connection name
-     * @var string
-     */
-    public $name;
+	/**
+	 * Telemetics connection name
+	 * @var string
+	 */
+	public $name;
     
-    /**
-     * Vehicle tracking interval in seconds.
-     * @var integer
-     */
-    public $vehicle_position_refresh_rate;
+	/**
+	 * Vehicle tracking interval in seconds.
+	 * @var integer
+	 */
+	public $vehicle_position_refresh_rate;
     
-    /**
-     * Maximum idle time
-     * @var integer
-     */
-    public $max_idle_time;
+	/**
+	 * Maximum idle time
+	 * @var integer
+	 */
+	public $max_idle_time;
     
-    /**
-     * Disable/enable vehicle tracking
-     * @var integer
-     */
-    public $is_enabled;
+	/**
+	 * Disable/enable vehicle tracking
+	 * @var integer
+	 */
+	public $is_enabled;
     
-    /**
-     * The last timestamp, when the vehicles reloaded.
-     * @var integer
-     */
-    public $last_vehicles_reload;
+	/**
+	 * The last timestamp, when the vehicles reloaded.
+	 * @var integer
+	 */
+	public $last_vehicles_reload;
     
-    /**
-     * The last timestamp, when the addresses reloaded.
-     * @var integer
-     */
-    public $last_addresses_reload;
+	/**
+	 * The last timestamp, when the addresses reloaded.
+	 * @var integer
+	 */
+	public $last_addresses_reload;
     
-    /**
-     * The last timestamp, when the positions reloaded.
-     * @var integer
-     */
-    public $last_position_reload;
+	/**
+	 * The last timestamp, when the positions reloaded.
+	 * @var integer
+	 */
+	public $last_position_reload;
     
-    /**
-     * Telematics connection access token
-     * @var string
-     */
-    public $connection_token;
+	/**
+	 * Telematics connection access token
+	 * @var string
+	 */
+	public $connection_token;
     
-    /**
-     * Connection user ID
-     * @var integer
-     */
-    public $user_id;
+	/**
+	 * Connection user ID
+	 * @var integer
+	 */
+	public $user_id;
     
-    /**
-     * When the connection updated
-     * @var string
-     */
-    public $updated_at;
+	/**
+	 * When the connection updated
+	 * @var string
+	 */
+	public $updated_at;
     
-    /**
-     * When the connection created
-     * @var string
-     */
-    public $created_at;
+	/**
+	 * When the connection created
+	 * @var string
+	 */
+	public $created_at;
     
-    /**
-     * Telemetics connection ID
-     * @var integer
-     */
-    public $id;
+	/**
+	 * Telemetics connection ID
+	 * @var integer
+	 */
+	public $id;
     
-    /**
-     * Metadata, custom key-value storage.
-     * @var array
-     */
-    public $metadata;
+	/**
+	 * Metadata, custom key-value storage.
+	 * @var array
+	 */
+	public $metadata;
     
-    /**
-     * Total vehicles number
-     * @var integer
-     */
-    public $total_vehicles_count;
+	/**
+	 * Total vehicles number
+	 * @var integer
+	 */
+	public $total_vehicles_count;
     
-    /**
-     * Total addresses number
-     * @var integer
-     */
-    public $total_addresses_count;
+	/**
+	 * Total addresses number
+	 * @var integer
+	 */
+	public $total_addresses_count;
     
-    /**
-     * Synchronized vehicles number
-     * @var integer
-     */
-    public $synced_vehicles_count;
+	/**
+	 * Synchronized vehicles number
+	 * @var integer
+	 */
+	public $synced_vehicles_count;
     
-    /**
-     * Telemetics connection vendor
-     * @var string
-     */
-    public $vendor;
+	/**
+	 * Telemetics connection vendor
+	 * @var string
+	 */
+	public $vendor;
 
-    /**
-     * Validate connections credentials.<br>
-     * If true, the connection validated.
-     * @var Boolean
-     */
-    public $validate_remote_credentials;
+	/**
+	 * Validate connections credentials.<br>
+	 * If true, the connection validated.
+	 * @var Boolean
+	 */
+	public $validate_remote_credentials;
     
-    public static function fromArray(array $params)
-    {
-        $thisParams = new self();
+	public static function fromArray(array $params)
+	{
+		$thisParams = new self();
 
-        foreach ($params as $key => $value) {
-            if (property_exists($thisParams, $key)) {
-                $thisParams->{$key} = $value;
-            }
-        }
+		foreach ($params as $key => $value) {
+			if (property_exists($thisParams, $key)) {
+				$thisParams->{$key} = $value;
+			}
+		}
 
-        return $thisParams;
-    }
+		return $thisParams;
+	}
 
-    /**
-     * Create a telematics connection.
-     * @param $apiToken string : API token
-     * @param $params TelematicsConnectionParameters : Telematics connection parameters
-     * @return array Array from a TelematicsConnection type object
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function createTelematicsConnection($apiToken, $params)
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	/**
+	 * Create a telematics connection.
+	 * @param $apiToken string : API token
+	 * @param $params TelematicsConnectionParameters : Telematics connection parameters
+	 * @return array Array from a TelematicsConnection type object
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function createTelematicsConnection($apiToken, $params)
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
 
-        $excludeFields = ['id', 'connection_token'];
+		$excludeFields = ['id', 'connection_token'];
 
-        $allBodyFields = Route4Me::getObjectProperties(new TelematicsConnectionParameters(), $excludeFields);
+		$allBodyFields = Route4Me::getObjectProperties(new TelematicsConnectionParameters(), $excludeFields);
 
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::TELEMATICS_CONNECTION,
-            'method' => 'POST',
-            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'query'  => ['api_token' => $apiToken],
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data',
-        ]);
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::TELEMATICS_CONNECTION,
+			'method' => 'POST',
+			'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'query'  => ['api_token' => $apiToken],
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data',
+		]);
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Delete a telematics connection.
-     * @param $apiToken string : API token
-     * @param $connectionToken string : connection token
-     * @return array Array from a TelematicsConnection type object
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function deleteTelematicsConnection($apiToken, $connectionToken)
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	/**
+	 * Delete a telematics connection.
+	 * @param $apiToken string : API token
+	 * @param $connectionToken string : connection token
+	 * @return array Array from a TelematicsConnection type object
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function deleteTelematicsConnection($apiToken, $connectionToken)
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
 
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::TELEMATICS_CONNECTION,
-            'method' => 'DELETE',
-            'query'  => [
-                    'api_token'         => $apiToken,
-                    'connection_token'  => $connectionToken
-                ],
-        ]);
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::TELEMATICS_CONNECTION,
+			'method' => 'DELETE',
+			'query'  => [
+					'api_token'         => $apiToken,
+					'connection_token'  => $connectionToken
+				],
+		]);
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Get all telematics connections.
-     * @param $apiToken string : API token
-     * @return array Array of the TelematicsConnection type objects
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function getTelematicsConnections($apiToken)
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	/**
+	 * Get all telematics connections.
+	 * @param $apiToken string : API token
+	 * @return array Array of the TelematicsConnection type objects
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function getTelematicsConnections($apiToken)
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
 
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::TELEMATICS_CONNECTION,
-            'method' => 'GET',
-            'query'  => [
-                'api_token' => $apiToken
-            ],
-        ]);
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::TELEMATICS_CONNECTION,
+			'method' => 'GET',
+			'query'  => [
+				'api_token' => $apiToken
+			],
+		]);
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Get a telematics connection
-     * @param $apiToken string : API token
-     * @param $connectionToken string : connection token
-     * @return array Array from a TelematicsConnection type object
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function getTelematicsConnection($apiToken, $connectionToken)
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	/**
+	 * Get a telematics connection
+	 * @param $apiToken string : API token
+	 * @param $connectionToken string : connection token
+	 * @return array Array from a TelematicsConnection type object
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function getTelematicsConnection($apiToken, $connectionToken)
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
 
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::TELEMATICS_CONNECTION,
-            'method' => 'GE',
-            'query'  => [
-                'api_token'         => $apiToken,
-                'connection_token'  => $connectionToken
-            ],
-        ]);
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::TELEMATICS_CONNECTION,
+			'method' => 'GE',
+			'query'  => [
+				'api_token'         => $apiToken,
+				'connection_token'  => $connectionToken
+			],
+		]);
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Update telematics connection
-     * @param $apiToken string : API token
-     * @param $connectionToken string : connection token
-     * @param $teleConParams TelematicsConnectionParameters : Telematics connection parameters
-     * @return array Array from a TelematicsConnection type object
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function updateTelematicsConnection($apiToken, $connectionToken, $teleConParams)
-    {
-        $excludeFields = ['id', 'connection_token'];
+	/**
+	 * Update telematics connection
+	 * @param $apiToken string : API token
+	 * @param $connectionToken string : connection token
+	 * @param $teleConParams TelematicsConnectionParameters : Telematics connection parameters
+	 * @return array Array from a TelematicsConnection type object
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function updateTelematicsConnection($apiToken, $connectionToken, $teleConParams)
+	{
+		$excludeFields = ['id', 'connection_token'];
 
-        $allBodyFields = Route4Me::getObjectProperties(new TelematicsConnectionParameters(), $excludeFields);
+		$allBodyFields = Route4Me::getObjectProperties(new TelematicsConnectionParameters(), $excludeFields);
 
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::TELEMATICS_CONNECTION,
-            'method' => 'PUT',
-            'body'   => Route4Me::generateRequestParameters($allBodyFields, $teleConParams),
-            'query'  => ['api_token' => $apiToken, 'connection_token' => $connectionToken],
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data',
-        ]);
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::TELEMATICS_CONNECTION,
+			'method' => 'PUT',
+			'body'   => Route4Me::generateRequestParameters($allBodyFields, $teleConParams),
+			'query'  => ['api_token' => $apiToken, 'connection_token' => $connectionToken],
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data',
+		]);
 
-        return $result;
-    }
+		return $result;
+	}
 }

src/Route4Me/TelematicsGateway/TelematicsVendorResponse.php

Indentation +5 added lines, -5 removed lines

@@ -8,9 +8,9 @@
  */
 class TelematicsVendorResponse extends Common
 {
-    /**
-     * Telematics Vendor
-     * @var type TelematicsVendor
-     */
-    public $vendor;
+	/**
+	 * Telematics Vendor
+	 * @var type TelematicsVendor
+	 */
+	public $vendor;
 }