@@ -9,162 +9,162 @@ |
||
9 | 9 | */ |
10 | 10 | class RouteParametersQuery extends Common |
11 | 11 | { |
12 | - /** |
|
13 | - * Route unique identifier |
|
14 | - * @var string |
|
15 | - */ |
|
16 | - public $route_id; |
|
17 | - |
|
18 | - /** |
|
19 | - * Pass True to return directions and the route path. |
|
20 | - * @var boolean |
|
21 | - */ |
|
22 | - public $directions; |
|
23 | - |
|
24 | - /** |
|
25 | - * Available values: |
|
26 | - * - 'None' - no path output. |
|
27 | - * - 'Points' - points path output |
|
28 | - * @var string |
|
29 | - */ |
|
30 | - public $route_path_output; |
|
31 | - |
|
32 | - /** |
|
33 | - * Output route tracking data in response. |
|
34 | - * @var boolean |
|
35 | - */ |
|
36 | - public $device_tracking_history; |
|
37 | - |
|
38 | - /** |
|
39 | - * The number of existing routes that should be returned per response |
|
40 | - * when looking at a list of all the routes. |
|
41 | - * @var integer |
|
42 | - */ |
|
43 | - public $limit; |
|
44 | - |
|
45 | - /** |
|
46 | - * The page number for route listing pagination.<br> |
|
47 | - * Increment the offset by the limit number to move to the next page. |
|
48 | - * @var integer |
|
49 | - */ |
|
50 | - public $offset; |
|
51 | - |
|
52 | - /** |
|
53 | - * Start date to filter |
|
54 | - * @var string |
|
55 | - */ |
|
56 | - public $start_date; |
|
57 | - |
|
58 | - /** |
|
59 | - * End date to filter |
|
60 | - * @var string |
|
61 | - */ |
|
62 | - public $end_date; |
|
63 | - |
|
64 | - /** |
|
65 | - * Output addresses and directions in the original optimization request sequence.<br> |
|
66 | - * This is to allow us to compare routes before & after optimization. |
|
67 | - * @var boolean |
|
68 | - */ |
|
69 | - public $original; |
|
70 | - |
|
71 | - /** |
|
72 | - * Output route and stop-specific notes. The notes will have timestamps, |
|
73 | - * note types, and geospatial information if available. |
|
74 | - * @var boolean |
|
75 | - */ |
|
76 | - public $notes; |
|
77 | - |
|
78 | - /** |
|
79 | - * If true, the order inventory info included in the response. |
|
80 | - * @var boolean |
|
81 | - */ |
|
82 | - public $order_inventory; |
|
83 | - |
|
84 | - /** |
|
85 | - * If true, not visited destinations of an active route re-optimized (re-sequenced). |
|
86 | - * @var boolean |
|
87 | - */ |
|
88 | - public $remaining; |
|
89 | - |
|
90 | - /** |
|
91 | - * Search query |
|
92 | - * @var string |
|
93 | - */ |
|
94 | - public $query; |
|
95 | - |
|
96 | - /** |
|
97 | - * Updating a route supports the reoptimize=1 parameter, |
|
98 | - * which reoptimizes only that route.<br> |
|
99 | - * Also supports the parameters from GET. |
|
100 | - * @var boolean |
|
101 | - */ |
|
102 | - public $reoptimize; |
|
103 | - |
|
104 | - /** |
|
105 | - * Whether disable or not a route optimization.<br> |
|
106 | - * Available values: |
|
107 | - * - true - disable a route optimization; |
|
108 | - * - false - not disable a route optimization. |
|
109 | - * @var boolean |
|
110 | - */ |
|
111 | - public $disable_optimization; |
|
112 | - |
|
113 | - /** |
|
114 | - * The driving directions will be generated biased for this selection. |
|
115 | - * This has no impact on route sequencing.<br> |
|
116 | - * Available values: |
|
117 | - * - 'Distance'; |
|
118 | - * - 'Time'; |
|
119 | - * - 'timeWithTraffic'. |
|
120 | - * @var boolean |
|
121 | - */ |
|
122 | - public $optimize; |
|
123 | - |
|
124 | - /** |
|
125 | - * By sending recompute_directions=1 we request that the route directions |
|
126 | - * be recomputed (note that this does happen automatically if certain properties |
|
127 | - * of the route are updated, such as stop sequence_no changes or round-tripness) |
|
128 | - * @var boolean |
|
129 | - */ |
|
130 | - public $recompute_directions; |
|
131 | - |
|
132 | - /** |
|
133 | - * Response format('json', 'csv', 'xml') |
|
134 | - * @var string |
|
135 | - */ |
|
136 | - public $response_format; |
|
137 | - |
|
138 | - /** |
|
139 | - * Identifier of a route destination. |
|
140 | - * @var integer |
|
141 | - */ |
|
142 | - public $route_destination_id; |
|
143 | - |
|
144 | - /** |
|
145 | - * If true, will be redirected |
|
146 | - * @var boolean |
|
147 | - */ |
|
148 | - public $redirect; |
|
149 | - |
|
150 | - /** |
|
151 | - * If true, the address bundling info is included into route response. |
|
152 | - * @var boolean |
|
153 | - */ |
|
154 | - public $bundling_items; |
|
155 | - |
|
156 | - public $device_type; |
|
157 | - |
|
158 | - public static function fromArray(array $params) |
|
159 | - { |
|
160 | - $routeQueryParams = new self(); |
|
161 | - foreach ($params as $key => $value) { |
|
162 | - if (property_exists($routeQueryParams, $key)) { |
|
163 | - $routeQueryParams->{$key} = $value; |
|
164 | - } |
|
165 | - } |
|
166 | - |
|
167 | - return $routeQueryParams; |
|
168 | - } |
|
12 | + /** |
|
13 | + * Route unique identifier |
|
14 | + * @var string |
|
15 | + */ |
|
16 | + public $route_id; |
|
17 | + |
|
18 | + /** |
|
19 | + * Pass True to return directions and the route path. |
|
20 | + * @var boolean |
|
21 | + */ |
|
22 | + public $directions; |
|
23 | + |
|
24 | + /** |
|
25 | + * Available values: |
|
26 | + * - 'None' - no path output. |
|
27 | + * - 'Points' - points path output |
|
28 | + * @var string |
|
29 | + */ |
|
30 | + public $route_path_output; |
|
31 | + |
|
32 | + /** |
|
33 | + * Output route tracking data in response. |
|
34 | + * @var boolean |
|
35 | + */ |
|
36 | + public $device_tracking_history; |
|
37 | + |
|
38 | + /** |
|
39 | + * The number of existing routes that should be returned per response |
|
40 | + * when looking at a list of all the routes. |
|
41 | + * @var integer |
|
42 | + */ |
|
43 | + public $limit; |
|
44 | + |
|
45 | + /** |
|
46 | + * The page number for route listing pagination.<br> |
|
47 | + * Increment the offset by the limit number to move to the next page. |
|
48 | + * @var integer |
|
49 | + */ |
|
50 | + public $offset; |
|
51 | + |
|
52 | + /** |
|
53 | + * Start date to filter |
|
54 | + * @var string |
|
55 | + */ |
|
56 | + public $start_date; |
|
57 | + |
|
58 | + /** |
|
59 | + * End date to filter |
|
60 | + * @var string |
|
61 | + */ |
|
62 | + public $end_date; |
|
63 | + |
|
64 | + /** |
|
65 | + * Output addresses and directions in the original optimization request sequence.<br> |
|
66 | + * This is to allow us to compare routes before & after optimization. |
|
67 | + * @var boolean |
|
68 | + */ |
|
69 | + public $original; |
|
70 | + |
|
71 | + /** |
|
72 | + * Output route and stop-specific notes. The notes will have timestamps, |
|
73 | + * note types, and geospatial information if available. |
|
74 | + * @var boolean |
|
75 | + */ |
|
76 | + public $notes; |
|
77 | + |
|
78 | + /** |
|
79 | + * If true, the order inventory info included in the response. |
|
80 | + * @var boolean |
|
81 | + */ |
|
82 | + public $order_inventory; |
|
83 | + |
|
84 | + /** |
|
85 | + * If true, not visited destinations of an active route re-optimized (re-sequenced). |
|
86 | + * @var boolean |
|
87 | + */ |
|
88 | + public $remaining; |
|
89 | + |
|
90 | + /** |
|
91 | + * Search query |
|
92 | + * @var string |
|
93 | + */ |
|
94 | + public $query; |
|
95 | + |
|
96 | + /** |
|
97 | + * Updating a route supports the reoptimize=1 parameter, |
|
98 | + * which reoptimizes only that route.<br> |
|
99 | + * Also supports the parameters from GET. |
|
100 | + * @var boolean |
|
101 | + */ |
|
102 | + public $reoptimize; |
|
103 | + |
|
104 | + /** |
|
105 | + * Whether disable or not a route optimization.<br> |
|
106 | + * Available values: |
|
107 | + * - true - disable a route optimization; |
|
108 | + * - false - not disable a route optimization. |
|
109 | + * @var boolean |
|
110 | + */ |
|
111 | + public $disable_optimization; |
|
112 | + |
|
113 | + /** |
|
114 | + * The driving directions will be generated biased for this selection. |
|
115 | + * This has no impact on route sequencing.<br> |
|
116 | + * Available values: |
|
117 | + * - 'Distance'; |
|
118 | + * - 'Time'; |
|
119 | + * - 'timeWithTraffic'. |
|
120 | + * @var boolean |
|
121 | + */ |
|
122 | + public $optimize; |
|
123 | + |
|
124 | + /** |
|
125 | + * By sending recompute_directions=1 we request that the route directions |
|
126 | + * be recomputed (note that this does happen automatically if certain properties |
|
127 | + * of the route are updated, such as stop sequence_no changes or round-tripness) |
|
128 | + * @var boolean |
|
129 | + */ |
|
130 | + public $recompute_directions; |
|
131 | + |
|
132 | + /** |
|
133 | + * Response format('json', 'csv', 'xml') |
|
134 | + * @var string |
|
135 | + */ |
|
136 | + public $response_format; |
|
137 | + |
|
138 | + /** |
|
139 | + * Identifier of a route destination. |
|
140 | + * @var integer |
|
141 | + */ |
|
142 | + public $route_destination_id; |
|
143 | + |
|
144 | + /** |
|
145 | + * If true, will be redirected |
|
146 | + * @var boolean |
|
147 | + */ |
|
148 | + public $redirect; |
|
149 | + |
|
150 | + /** |
|
151 | + * If true, the address bundling info is included into route response. |
|
152 | + * @var boolean |
|
153 | + */ |
|
154 | + public $bundling_items; |
|
155 | + |
|
156 | + public $device_type; |
|
157 | + |
|
158 | + public static function fromArray(array $params) |
|
159 | + { |
|
160 | + $routeQueryParams = new self(); |
|
161 | + foreach ($params as $key => $value) { |
|
162 | + if (property_exists($routeQueryParams, $key)) { |
|
163 | + $routeQueryParams->{$key} = $value; |
|
164 | + } |
|
165 | + } |
|
166 | + |
|
167 | + return $routeQueryParams; |
|
168 | + } |
|
169 | 169 | |
170 | 170 | } |
171 | 171 | \ No newline at end of file |
@@ -7,15 +7,15 @@ |
||
7 | 7 | */ |
8 | 8 | class TelematicsVendorsTypes |
9 | 9 | { |
10 | - const TOMTOM = 'tomtom'; |
|
10 | + const TOMTOM = 'tomtom'; |
|
11 | 11 | |
12 | - const TELETRAC = 'teletrac'; |
|
12 | + const TELETRAC = 'teletrac'; |
|
13 | 13 | |
14 | - const AZUGA = 'azuga'; |
|
14 | + const AZUGA = 'azuga'; |
|
15 | 15 | |
16 | - const GEOTAB = 'geotab'; |
|
16 | + const GEOTAB = 'geotab'; |
|
17 | 17 | |
18 | - const SILENT_PASSENGER = 'silentpassenger'; |
|
18 | + const SILENT_PASSENGER = 'silentpassenger'; |
|
19 | 19 | |
20 | - const NEW_TELETRAC = 'new_teletrac'; |
|
20 | + const NEW_TELETRAC = 'new_teletrac'; |
|
21 | 21 | } |
@@ -4,13 +4,13 @@ |
||
4 | 4 | |
5 | 5 | class AdditionalItemsMode |
6 | 6 | { |
7 | - /* |
|
7 | + /* |
|
8 | 8 | * Enumeration of the service time additional items mode: |
9 | 9 | * KEEP_ORIGINAL = 1, preserve original address service time (default); |
10 | 10 | * CUSTOM_TIME = 2, set custom times; |
11 | 11 | * INHERIT_FROM_PRIMARY = 3, don't add service times. |
12 | 12 | */ |
13 | - const KEEP_ORIGINAL = 1; |
|
14 | - const CUSTOM_TIME = 2; |
|
15 | - const INHERIT_FROM_PRIMARY = 3; |
|
13 | + const KEEP_ORIGINAL = 1; |
|
14 | + const CUSTOM_TIME = 2; |
|
15 | + const INHERIT_FROM_PRIMARY = 3; |
|
16 | 16 | } |
17 | 17 | \ No newline at end of file |
@@ -9,6 +9,6 @@ |
||
9 | 9 | */ |
10 | 10 | class FirstItemMode |
11 | 11 | { |
12 | - const KEEP_ORIGINAL = 1; |
|
13 | - const CUSTOM_TIME = 2; |
|
12 | + const KEEP_ORIGINAL = 1; |
|
13 | + const CUSTOM_TIME = 2; |
|
14 | 14 | } |
@@ -9,6 +9,6 @@ |
||
9 | 9 | */ |
10 | 10 | class MergeMode |
11 | 11 | { |
12 | - const KEEP_AS_SEPARATE_DESTINATIONS = 1; |
|
13 | - const MERGE_INTO_SINGLE_DESTINATION = 2; |
|
12 | + const KEEP_AS_SEPARATE_DESTINATIONS = 1; |
|
13 | + const MERGE_INTO_SINGLE_DESTINATION = 2; |
|
14 | 14 | } |
@@ -11,8 +11,8 @@ |
||
11 | 11 | */ |
12 | 12 | class Mode |
13 | 13 | { |
14 | - const ADDRESS = 1; |
|
15 | - const COORDINATES = 2; |
|
16 | - const ADDRESS_ID = 3; |
|
17 | - const ADDRESS_CUSTOM_FIELD = 4; |
|
14 | + const ADDRESS = 1; |
|
15 | + const COORDINATES = 2; |
|
16 | + const ADDRESS_ID = 3; |
|
17 | + const ADDRESS_CUSTOM_FIELD = 4; |
|
18 | 18 | } |
@@ -4,15 +4,15 @@ |
||
4 | 4 | |
5 | 5 | class AlgorithmType |
6 | 6 | { |
7 | - const STATE_NEW = 0; |
|
8 | - const TSP = 1; |
|
9 | - const VRP = 2; |
|
10 | - const CVRP_TW_SD = 3; |
|
11 | - const CVRP_TW_MD = 4; |
|
12 | - const TSP_TW = 5; |
|
13 | - const TSP_TW_CR = 6; |
|
14 | - const OPTIMIZATION_STATE_IN_QUEUE = 7; |
|
15 | - const ADVANCED_CVRP_TW = 9; |
|
16 | - const ALG_NONE = 100; |
|
17 | - const ALG_LEGACY_DISTRIBUTED = 101; |
|
7 | + const STATE_NEW = 0; |
|
8 | + const TSP = 1; |
|
9 | + const VRP = 2; |
|
10 | + const CVRP_TW_SD = 3; |
|
11 | + const CVRP_TW_MD = 4; |
|
12 | + const TSP_TW = 5; |
|
13 | + const TSP_TW_CR = 6; |
|
14 | + const OPTIMIZATION_STATE_IN_QUEUE = 7; |
|
15 | + const ADVANCED_CVRP_TW = 9; |
|
16 | + const ALG_NONE = 100; |
|
17 | + const ALG_LEGACY_DISTRIBUTED = 101; |
|
18 | 18 | } |
@@ -4,9 +4,9 @@ |
||
4 | 4 | |
5 | 5 | class Metric |
6 | 6 | { |
7 | - const EUCLIDEAN = 1; //measures point to point distance as a straight line |
|
8 | - const MANHATTAN = 2; //measures point to point distance as taxicab geometry line |
|
9 | - const GEODESIC = 3; //measures point to point distance approximating curvature of the earth |
|
10 | - const MATRIX = 4; //measures point to point distance by traversing the actual road network |
|
11 | - const EXACT_2D = 5; //measures point to point distance using 2d rectilinear distance |
|
7 | + const EUCLIDEAN = 1; //measures point to point distance as a straight line |
|
8 | + const MANHATTAN = 2; //measures point to point distance as taxicab geometry line |
|
9 | + const GEODESIC = 3; //measures point to point distance approximating curvature of the earth |
|
10 | + const MATRIX = 4; //measures point to point distance by traversing the actual road network |
|
11 | + const EXACT_2D = 5; //measures point to point distance using 2d rectilinear distance |
|
12 | 12 | } |
@@ -4,7 +4,7 @@ |
||
4 | 4 | |
5 | 5 | class TerritoryTypes |
6 | 6 | { |
7 | - const CIRCLE = 'circle'; |
|
8 | - const POLY = 'poly'; |
|
9 | - const RECT = 'rect'; |
|
7 | + const CIRCLE = 'circle'; |
|
8 | + const POLY = 'poly'; |
|
9 | + const RECT = 'rect'; |
|
10 | 10 | } |