route4me / route4me-php-sdk

src/Route4Me/SearchResponse.php

Indentation +38 added lines, -38 removed lines

@@ -10,42 +10,42 @@
  */
 class SearchResponse
 {
-    /**
-     * An array of the AddressBookContact type objects.
-     * @var AddressBookLocation[]
-     */
-    public $results=[];
-
-    /**
-     * Total number of the returned contacts
-     * @var integer
-     */
-    public $total;
-
-    /**
-     * An array of the field names to be shown
-     * @var string[]
-     */
-    public $fields=[];
-
-    /**
-     * The contacts query in the JSON format
-     * @var string
-     */
-    public $index_query;
-
-    public static function fromArray(array $params)
-    {
-        $searchResponse = new self();
-
-        foreach ($params as $key => $value) {
-            if (property_exists($searchResponse, $key)) {
-                $searchResponse->{$key} = $value;
-            } else {
-                throw new BadParam("Correct parameter must be provided. Wrong Parameter: $key");
-            }
-        }
-
-        return $searchResponse;
-    }
+	/**
+	 * An array of the AddressBookContact type objects.
+	 * @var AddressBookLocation[]
+	 */
+	public $results=[];
+
+	/**
+	 * Total number of the returned contacts
+	 * @var integer
+	 */
+	public $total;
+
+	/**
+	 * An array of the field names to be shown
+	 * @var string[]
+	 */
+	public $fields=[];
+
+	/**
+	 * The contacts query in the JSON format
+	 * @var string
+	 */
+	public $index_query;
+
+	public static function fromArray(array $params)
+	{
+		$searchResponse = new self();
+
+		foreach ($params as $key => $value) {
+			if (property_exists($searchResponse, $key)) {
+				$searchResponse->{$key} = $value;
+			} else {
+				throw new BadParam("Correct parameter must be provided. Wrong Parameter: $key");
+			}
+		}
+
+		return $searchResponse;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -14,7 +14,7 @@ 
      * An array of the AddressBookContact type objects.
      * @var AddressBookLocation[]
      */
-    public $results=[];
+    public $results = [];
 
     /**
      * Total number of the returned contacts
@@ -26,7 +26,7 @@ 
      * An array of the field names to be shown
      * @var string[]
      */
-    public $fields=[];
+    public $fields = [];
 
     /**
      * The contacts query in the JSON format

src/Route4Me/AddressBookGroup.php

Indentation +149 added lines, -149 removed lines

@@ -6,157 +6,157 @@
 
 class AddressBookGroup extends Common
 {
-    public $group_id;
-    public $group_name;
-    public $group_color;
-    public $group_icon;
-    public $member_id;
-    public $filter;
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-    }
-
-    public static function fromArray(array $params)
-    {
-        $addressBookGroup = new self();
-
-        foreach ($params as $key => $value) {
-            if (property_exists($addressBookGroup, $key)) {
-                $addressBookGroup->{$key} = $value;
-            }
-        }
-
-        return $addressBookGroup;
-    }
-
-    public static function getAddressBookGroup(array $params)
-    {
-        $abGroup = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_BOOK_GROUP,
-            'method'    => 'GET',
-            'query'     => [
-                'group_id' => isset($params['group_id']) ?  $params['group_id'] : null,
-            ],
-        ]);
-
-        return $abGroup;
-    }
-
-    public static function updateAddressBookGroup(array $params)
-    {
-        $allBodyFields = ['group_id', 'group_color', 'group_icon', 'filter'];
-
-        $abGroup = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_BOOK_GROUP,
-            'method'    => 'PUT',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $abGroup;
-    }
-
-    public static function removeAddressBookGroup(array $params)
-    {
-        $allBodyFields = ['group_id'];
-
-        $abGroup = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_BOOK_GROUP,
-            'method'    => 'DELETE',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $abGroup;
-    }
-
-    public static function createAddressBookGroup(array $params)
-    {
-        $allBodyFields = ['group_name', 'group_color', 'group_icon', 'filter'];
-
-        $abGroup = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_BOOK_GROUP,
-            'method'    => 'POST',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $abGroup;
-    }
-
-    public static function  searchAddressBookGroups(array $params)
-    {
-        $allBodyFields = ['fields', 'offset', 'limit', 'filter'];
-
-        $abGroups = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_BOOK_V4,
-            'method'    => 'POST',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $abGroups;
-    }
-
-    public static function getAddressBookContactsByGroup(array $params)
-    {
-        $allBodyFields = ['fields', 'group_id'];
-
-        $abGroups = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_BOOK_SEARCH,
-            'method'    => 'POST',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $abGroups;
-    }
-
-    public static function getAddressBookGroups(array $params)
-    {
-        $abGroup = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_BOOK_GROUP,
-            'method'    => 'GET',
-            'query'     => [
-                'offset'    => isset($params['offset']) ? $params['offset'] : null,
-                'limit'     => isset($params['limit']) ?  $params['limit'] : null,
-            ],
-        ]);
-
-        return $abGroup;
-    }
-
-    public static function getRandomAddressBookGroup(array $params)
-    {
-        $abGroups = self::getAddressBookGroups($params);
-
-        if (isset($abGroups) && sizeof($abGroups>1)) {
-            $groupsSize = sizeof($abGroups);
-
-                $randomGroupIndex = rand(0, $groupsSize - 1);
-
-                return $abGroups[$randomGroupIndex];
-        }
-
-        return null;
-    }
-
-    /*
+	public $group_id;
+	public $group_name;
+	public $group_color;
+	public $group_icon;
+	public $member_id;
+	public $filter;
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	}
+
+	public static function fromArray(array $params)
+	{
+		$addressBookGroup = new self();
+
+		foreach ($params as $key => $value) {
+			if (property_exists($addressBookGroup, $key)) {
+				$addressBookGroup->{$key} = $value;
+			}
+		}
+
+		return $addressBookGroup;
+	}
+
+	public static function getAddressBookGroup(array $params)
+	{
+		$abGroup = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_BOOK_GROUP,
+			'method'    => 'GET',
+			'query'     => [
+				'group_id' => isset($params['group_id']) ?  $params['group_id'] : null,
+			],
+		]);
+
+		return $abGroup;
+	}
+
+	public static function updateAddressBookGroup(array $params)
+	{
+		$allBodyFields = ['group_id', 'group_color', 'group_icon', 'filter'];
+
+		$abGroup = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_BOOK_GROUP,
+			'method'    => 'PUT',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $abGroup;
+	}
+
+	public static function removeAddressBookGroup(array $params)
+	{
+		$allBodyFields = ['group_id'];
+
+		$abGroup = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_BOOK_GROUP,
+			'method'    => 'DELETE',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $abGroup;
+	}
+
+	public static function createAddressBookGroup(array $params)
+	{
+		$allBodyFields = ['group_name', 'group_color', 'group_icon', 'filter'];
+
+		$abGroup = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_BOOK_GROUP,
+			'method'    => 'POST',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $abGroup;
+	}
+
+	public static function  searchAddressBookGroups(array $params)
+	{
+		$allBodyFields = ['fields', 'offset', 'limit', 'filter'];
+
+		$abGroups = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_BOOK_V4,
+			'method'    => 'POST',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $abGroups;
+	}
+
+	public static function getAddressBookContactsByGroup(array $params)
+	{
+		$allBodyFields = ['fields', 'group_id'];
+
+		$abGroups = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_BOOK_SEARCH,
+			'method'    => 'POST',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $abGroups;
+	}
+
+	public static function getAddressBookGroups(array $params)
+	{
+		$abGroup = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_BOOK_GROUP,
+			'method'    => 'GET',
+			'query'     => [
+				'offset'    => isset($params['offset']) ? $params['offset'] : null,
+				'limit'     => isset($params['limit']) ?  $params['limit'] : null,
+			],
+		]);
+
+		return $abGroup;
+	}
+
+	public static function getRandomAddressBookGroup(array $params)
+	{
+		$abGroups = self::getAddressBookGroups($params);
+
+		if (isset($abGroups) && sizeof($abGroups>1)) {
+			$groupsSize = sizeof($abGroups);
+
+				$randomGroupIndex = rand(0, $groupsSize - 1);
+
+				return $abGroups[$randomGroupIndex];
+		}
+
+		return null;
+	}
+
+	/*
      * Gets an array of the address book contact groups with a specified name.
      * @param string $name
      *        Address book contact group name
      */
-    public static function getAddressBookGroupIdByName($name)
-    {
-        $abGroups = self::getAddressBookGroups(['offset'=>0,'limit'=>100]);
-
-        $abGroupId = [];
-
-        foreach ($abGroups as $abg) {
-            if (isset($abg['group_name'])) {
-                if ($abg['group_name']==$name) {
-                    $abGroupId[] = $abg['group_id'];
-                }
-            }
-        }
-
-        return $abGroupId;
-    }
+	public static function getAddressBookGroupIdByName($name)
+	{
+		$abGroups = self::getAddressBookGroups(['offset'=>0,'limit'=>100]);
+
+		$abGroupId = [];
+
+		foreach ($abGroups as $abg) {
+			if (isset($abg['group_name'])) {
+				if ($abg['group_name']==$name) {
+					$abGroupId[] = $abg['group_id'];
+				}
+			}
+		}
+
+		return $abGroupId;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -37,7 +37,7 @@ 
             'url'       => Endpoint::ADDRESS_BOOK_GROUP,
             'method'    => 'GET',
             'query'     => [
-                'group_id' => isset($params['group_id']) ?  $params['group_id'] : null,
+                'group_id' => isset($params['group_id']) ? $params['group_id'] : null,
             ],
         ]);
 
@@ -116,7 +116,7 @@ 
             'method'    => 'GET',
             'query'     => [
                 'offset'    => isset($params['offset']) ? $params['offset'] : null,
-                'limit'     => isset($params['limit']) ?  $params['limit'] : null,
+                'limit'     => isset($params['limit']) ? $params['limit'] : null,
             ],
         ]);
 
@@ -145,7 +145,7 @@ 
      */
     public static function getAddressBookGroupIdByName($name)
     {
-        $abGroups = self::getAddressBookGroups(['offset'=>0,'limit'=>100]);
+        $abGroups = self::getAddressBookGroups(['offset'=>0, 'limit'=>100]);
 
         $abGroupId = [];
 

src/Route4Me/RouteParametersQuery.php

Indentation +157 added lines, -157 removed lines

@@ -9,162 +9,162 @@
  */
 class RouteParametersQuery extends Common
 {
-    /**
-     * Route unique identifier
-     * @var string
-     */
-    public $route_id;
-
-    /**
-     * Pass True to return directions and the route path.
-     * @var boolean
-     */
-    public $directions;
-
-    /**
-     * Available values:
-     * - 'None' - no path output.
-     * - 'Points' - points path output
-     * @var string
-     */
-    public $route_path_output;
-
-    /**
-     * Output route tracking data in response.
-     * @var boolean
-     */
-    public $device_tracking_history;
-
-    /**
-     * The number of existing routes that should be returned per response
-     * when looking at a list of all the routes.
-     * @var integer
-     */
-    public $limit;
-
-    /**
-     * The page number for route listing pagination.<br>
-     * Increment the offset by the limit number to move to the next page.
-     * @var integer
-     */
-    public $offset;
-
-    /**
-     * Start date to filter
-     * @var string
-     */
-    public $start_date;
-
-    /**
-     * End date to filter
-     * @var string
-     */
-    public $end_date;
-
-    /**
-     * Output addresses and directions in the original optimization request sequence.<br>
-     * This is to allow us to compare routes before & after optimization.
-     * @var boolean
-     */
-    public $original;
-
-    /**
-     * Output route and stop-specific notes. The notes will have timestamps,
-     * note types, and geospatial information if available.
-     * @var boolean
-     */
-    public $notes;
-
-    /**
-     * If true, the order inventory info included in the response.
-     * @var boolean
-     */
-    public $order_inventory;
-
-    /**
-     * If true, not visited destinations of an active route re-optimized (re-sequenced).
-     * @var boolean
-     */
-    public $remaining;
-
-    /**
-     * Search query
-     * @var string
-     */
-    public $query;
-
-    /**
-     * Updating a route supports the reoptimize=1 parameter,
-     * which reoptimizes only that route.<br>
-     * Also supports the parameters from GET.
-     * @var boolean
-     */
-    public $reoptimize;
-
-    /**
-     * Whether disable or not a route optimization.<br>
-     * Available values:
-     * - true - disable a route optimization;
-     * - false - not disable a route optimization.
-     * @var boolean
-     */
-    public $disable_optimization;
-
-    /**
-     * The driving directions will be generated biased for this selection.
-     * This has no impact on route sequencing.<br>
-     * Available values:
-     * - 'Distance';
-     * - 'Time';
-     * - 'timeWithTraffic'.
-     * @var boolean
-     */
-    public $optimize;
-
-    /**
-     * By sending recompute_directions=1 we request that the route directions
-     * be recomputed (note that this does happen automatically if certain properties
-     * of the route are updated, such as stop sequence_no changes or round-tripness)
-     * @var boolean
-     */
-    public $recompute_directions;
-
-    /**
-     * Response format('json', 'csv', 'xml')
-     * @var string
-     */
-    public $response_format;
-
-    /**
-     * Identifier of a route destination.
-     * @var integer
-     */
-    public $route_destination_id;
-
-    /**
-     * If true, will be redirected
-     * @var boolean
-     */
-    public $redirect;
-
-    /**
-     * If true, the address bundling info is included into route response.
-     * @var boolean
-     */
-    public $bundling_items;
-
-    public $device_type;
-
-    public static function fromArray(array $params)
-    {
-        $routeQueryParams = new self();
-        foreach ($params as $key => $value) {
-            if (property_exists($routeQueryParams, $key)) {
-                $routeQueryParams->{$key} = $value;
-            }
-        }
-
-        return $routeQueryParams;
-    }
+	/**
+	 * Route unique identifier
+	 * @var string
+	 */
+	public $route_id;
+
+	/**
+	 * Pass True to return directions and the route path.
+	 * @var boolean
+	 */
+	public $directions;
+
+	/**
+	 * Available values:
+	 * - 'None' - no path output.
+	 * - 'Points' - points path output
+	 * @var string
+	 */
+	public $route_path_output;
+
+	/**
+	 * Output route tracking data in response.
+	 * @var boolean
+	 */
+	public $device_tracking_history;
+
+	/**
+	 * The number of existing routes that should be returned per response
+	 * when looking at a list of all the routes.
+	 * @var integer
+	 */
+	public $limit;
+
+	/**
+	 * The page number for route listing pagination.<br>
+	 * Increment the offset by the limit number to move to the next page.
+	 * @var integer
+	 */
+	public $offset;
+
+	/**
+	 * Start date to filter
+	 * @var string
+	 */
+	public $start_date;
+
+	/**
+	 * End date to filter
+	 * @var string
+	 */
+	public $end_date;
+
+	/**
+	 * Output addresses and directions in the original optimization request sequence.<br>
+	 * This is to allow us to compare routes before & after optimization.
+	 * @var boolean
+	 */
+	public $original;
+
+	/**
+	 * Output route and stop-specific notes. The notes will have timestamps,
+	 * note types, and geospatial information if available.
+	 * @var boolean
+	 */
+	public $notes;
+
+	/**
+	 * If true, the order inventory info included in the response.
+	 * @var boolean
+	 */
+	public $order_inventory;
+
+	/**
+	 * If true, not visited destinations of an active route re-optimized (re-sequenced).
+	 * @var boolean
+	 */
+	public $remaining;
+
+	/**
+	 * Search query
+	 * @var string
+	 */
+	public $query;
+
+	/**
+	 * Updating a route supports the reoptimize=1 parameter,
+	 * which reoptimizes only that route.<br>
+	 * Also supports the parameters from GET.
+	 * @var boolean
+	 */
+	public $reoptimize;
+
+	/**
+	 * Whether disable or not a route optimization.<br>
+	 * Available values:
+	 * - true - disable a route optimization;
+	 * - false - not disable a route optimization.
+	 * @var boolean
+	 */
+	public $disable_optimization;
+
+	/**
+	 * The driving directions will be generated biased for this selection.
+	 * This has no impact on route sequencing.<br>
+	 * Available values:
+	 * - 'Distance';
+	 * - 'Time';
+	 * - 'timeWithTraffic'.
+	 * @var boolean
+	 */
+	public $optimize;
+
+	/**
+	 * By sending recompute_directions=1 we request that the route directions
+	 * be recomputed (note that this does happen automatically if certain properties
+	 * of the route are updated, such as stop sequence_no changes or round-tripness)
+	 * @var boolean
+	 */
+	public $recompute_directions;
+
+	/**
+	 * Response format('json', 'csv', 'xml')
+	 * @var string
+	 */
+	public $response_format;
+
+	/**
+	 * Identifier of a route destination.
+	 * @var integer
+	 */
+	public $route_destination_id;
+
+	/**
+	 * If true, will be redirected
+	 * @var boolean
+	 */
+	public $redirect;
+
+	/**
+	 * If true, the address bundling info is included into route response.
+	 * @var boolean
+	 */
+	public $bundling_items;
+
+	public $device_type;
+
+	public static function fromArray(array $params)
+	{
+		$routeQueryParams = new self();
+		foreach ($params as $key => $value) {
+			if (property_exists($routeQueryParams, $key)) {
+				$routeQueryParams->{$key} = $value;
+			}
+		}
+
+		return $routeQueryParams;
+	}
 
 }
\ No newline at end of file

src/Route4Me/Enum/TelematicsVendorsTypes.php

Indentation +6 added lines, -6 removed lines

@@ -7,15 +7,15 @@
  */
 class TelematicsVendorsTypes 
 {
-    const TOMTOM = 'tomtom';
+	const TOMTOM = 'tomtom';
     
-    const TELETRAC = 'teletrac';
+	const TELETRAC = 'teletrac';
     
-    const AZUGA = 'azuga';
+	const AZUGA = 'azuga';
     
-    const GEOTAB = 'geotab';
+	const GEOTAB = 'geotab';
     
-    const SILENT_PASSENGER = 'silentpassenger';
+	const SILENT_PASSENGER = 'silentpassenger';
     
-    const NEW_TELETRAC = 'new_teletrac';
+	const NEW_TELETRAC = 'new_teletrac';
 }

src/Route4Me/Enum/AddressBundlingModes/AdditionalItemsMode.php

Indentation +4 added lines, -4 removed lines

@@ -4,13 +4,13 @@
 
 class AdditionalItemsMode
 {
-    /*
+	/*
      * Enumeration of the service time additional items mode:
      * KEEP_ORIGINAL = 1, preserve original address service time (default);
      * CUSTOM_TIME = 2, set custom times;
      * INHERIT_FROM_PRIMARY = 3, don't add service times.
      */
-    const KEEP_ORIGINAL = 1;
-    const CUSTOM_TIME = 2;
-    const INHERIT_FROM_PRIMARY = 3;
+	const KEEP_ORIGINAL = 1;
+	const CUSTOM_TIME = 2;
+	const INHERIT_FROM_PRIMARY = 3;
 }
\ No newline at end of file

src/Route4Me/Enum/AddressBundlingModes/FirstItemMode.php

Indentation +2 added lines, -2 removed lines

@@ -9,6 +9,6 @@
  */
 class FirstItemMode
 {
-    const KEEP_ORIGINAL = 1;
-    const CUSTOM_TIME = 2;
+	const KEEP_ORIGINAL = 1;
+	const CUSTOM_TIME = 2;
 }

src/Route4Me/Enum/AddressBundlingModes/MergeMode.php

Indentation +2 added lines, -2 removed lines

@@ -9,6 +9,6 @@
  */
 class MergeMode
 {
-    const  KEEP_AS_SEPARATE_DESTINATIONS = 1;
-    const  MERGE_INTO_SINGLE_DESTINATION = 2;
+	const  KEEP_AS_SEPARATE_DESTINATIONS = 1;
+	const  MERGE_INTO_SINGLE_DESTINATION = 2;
 }

src/Route4Me/Enum/AddressBundlingModes/Mode.php

Indentation +4 added lines, -4 removed lines

@@ -11,8 +11,8 @@
  */
 class Mode
 {
-    const ADDRESS = 1;
-    const COORDINATES = 2;
-    const ADDRESS_ID = 3;
-    const ADDRESS_CUSTOM_FIELD = 4;
+	const ADDRESS = 1;
+	const COORDINATES = 2;
+	const ADDRESS_ID = 3;
+	const ADDRESS_CUSTOM_FIELD = 4;
 }

src/Route4Me/Enum/AlgorithmType.php

Indentation +11 added lines, -11 removed lines

@@ -4,15 +4,15 @@
 
 class AlgorithmType
 {
-    const STATE_NEW = 0;
-    const TSP = 1;
-    const VRP = 2;
-    const CVRP_TW_SD = 3;
-    const CVRP_TW_MD = 4;
-    const TSP_TW = 5;
-    const TSP_TW_CR = 6;
-    const OPTIMIZATION_STATE_IN_QUEUE = 7;
-    const ADVANCED_CVRP_TW = 9;
-    const ALG_NONE = 100;
-    const ALG_LEGACY_DISTRIBUTED = 101;
+	const STATE_NEW = 0;
+	const TSP = 1;
+	const VRP = 2;
+	const CVRP_TW_SD = 3;
+	const CVRP_TW_MD = 4;
+	const TSP_TW = 5;
+	const TSP_TW_CR = 6;
+	const OPTIMIZATION_STATE_IN_QUEUE = 7;
+	const ADVANCED_CVRP_TW = 9;
+	const ALG_NONE = 100;
+	const ALG_LEGACY_DISTRIBUTED = 101;
 }