@@ -11,532 +11,532 @@ |
||
| 11 | 11 | */ |
| 12 | 12 | class RouteParameters extends Common |
| 13 | 13 | { |
| 14 | - /** |
|
| 15 | - * Let the R4M API know if this SDK request is comming |
|
| 16 | - * from a file upload within your environment (for analytics). |
|
| 17 | - * @var Boolean |
|
| 18 | - */ |
|
| 19 | - public $is_upload; |
|
| 20 | - |
|
| 21 | - /** |
|
| 22 | - * The tour type of this route. rt is short for round trip, |
|
| 23 | - * the optimization engine changes its behavior for round trip |
|
| 24 | - * @var Boolean |
|
| 25 | - */ |
|
| 26 | - public $rt; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * The name of this route. this route name will be accessible in the search API, |
|
| 30 | - * and also will be displayed on the mobile device of a user. |
|
| 31 | - * @var string |
|
| 32 | - */ |
|
| 33 | - public $route_name; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * The route start date in UTC, unix timestamp seconds. |
|
| 37 | - * Used to show users when the route will begin, also used for reporting and analytics. |
|
| 38 | - * @var integer |
|
| 39 | - */ |
|
| 40 | - public $route_date; |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * Offset in seconds relative to the route start date (i.e. 9AM would be 60 * 60 * 9) |
|
| 44 | - * @var integer |
|
| 45 | - */ |
|
| 46 | - public $route_time; |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * @deprecated 'Always false' |
|
| 50 | - * @var string |
|
| 51 | - */ |
|
| 52 | - public $shared_publicly; |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * By disabling optimization, the route optimization engine |
|
| 56 | - * will not resequence the stops in your. |
|
| 57 | - * @var disable_optimization |
|
| 58 | - */ |
|
| 59 | - public $disable_optimization; |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * Gets or sets the optimize parameter.<br> |
|
| 63 | - * Availabale values: |
|
| 64 | - * - Distance, |
|
| 65 | - * - Time, |
|
| 66 | - * - timeWithTraffic |
|
| 67 | - * @var string |
|
| 68 | - */ |
|
| 69 | - public $optimize; |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * When the tour type is not round trip (rt = false), |
|
| 73 | - * enable lock last so that the final destination is fixed. |
|
| 74 | - * @var Boolean |
|
| 75 | - */ |
|
| 76 | - public $lock_last; |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * Vehicle capacity. |
|
| 80 | - * @var integer |
|
| 81 | - */ |
|
| 82 | - public $vehicle_capacity; |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * Maximum distance for a single vehicle in the route (always in miles) |
|
| 86 | - * @var integer |
|
| 87 | - */ |
|
| 88 | - public $vehicle_max_distance_mi; |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * The distance measurement unit for the route. |
|
| 92 | - * km or mi, the route4me api will convert all measurements into these units. |
|
| 93 | - * @var string |
|
| 94 | - */ |
|
| 95 | - public $distance_unit; |
|
| 96 | - |
|
| 97 | - /** |
|
| 98 | - * The mode of travel that the directions should be optimized for.<br> |
|
| 99 | - * Available values: |
|
| 100 | - * - Driving |
|
| 101 | - * - Walking |
|
| 102 | - * @var string |
|
| 103 | - */ |
|
| 104 | - public $travel_mode; |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * Options which let the user choose which road obstacles to avoid.<br> |
|
| 108 | - * This has no impact on route sequencing.<br> |
|
| 109 | - * Available values: |
|
| 110 | - * - Highways |
|
| 111 | - * - Tolls |
|
| 112 | - * - minimizeHighways |
|
| 113 | - * - minimizeTolls |
|
| 114 | - * - highways,tolls |
|
| 115 | - * - "". |
|
| 116 | - * @var string |
|
| 117 | - */ |
|
| 118 | - public $avoid; |
|
| 119 | - |
|
| 120 | - /** |
|
| 121 | - * The vehicle ID |
|
| 122 | - * @var string |
|
| 123 | - */ |
|
| 124 | - public $vehicle_id; |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * The latitude of the device making this sdk request. |
|
| 128 | - * @var double |
|
| 129 | - */ |
|
| 130 | - public $dev_lat; |
|
| 131 | - |
|
| 132 | - /** |
|
| 133 | - * The longitude of the device making this sdk request. |
|
| 134 | - * @var double |
|
| 135 | - */ |
|
| 136 | - public $dev_lng; |
|
| 137 | - |
|
| 138 | - /** |
|
| 139 | - * When using a multiple driver algorithm, this is the maximum permissible duration of a generated route.<br> |
|
| 140 | - * The optimization system will automatically create more routes when the route_max_duration is exceeded for a route.<br> |
|
| 141 | - * However it will create an 'unrouted' list of addresses if the maximum number of drivers is exceeded. |
|
| 142 | - * @var long |
|
| 143 | - */ |
|
| 144 | - public $route_max_duration; |
|
| 145 | - |
|
| 146 | - /** |
|
| 147 | - * The parameter specifies fine-tuning of an optimization process by route duration. |
|
| 148 | - * @var double |
|
| 149 | - */ |
|
| 150 | - public $target_duration; |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * The parameter specifies fine-tuning of an optimization process by route distance. |
|
| 154 | - * @var double |
|
| 155 | - */ |
|
| 156 | - public $target_distance; |
|
| 157 | - |
|
| 158 | - /** |
|
| 159 | - * The parameter specifies fine-tuning of an optimization process by waiting time. |
|
| 160 | - * @var double |
|
| 161 | - */ |
|
| 162 | - public $target_wait_by_tail_size; |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * The email address to notify upon completion of an optimization request. |
|
| 166 | - * @var string |
|
| 167 | - */ |
|
| 168 | - public $route_email; |
|
| 169 | - |
|
| 170 | - /** |
|
| 171 | - * @deprecated All routes are stored by default at this time |
|
| 172 | - * @var |
|
| 173 | - */ |
|
| 174 | - public $store_route = true; |
|
| 175 | - |
|
| 176 | - /** |
|
| 177 | - * Metric system |
|
| 178 | - * @see Enum\Metric |
|
| 179 | - * @var integer |
|
| 180 | - */ |
|
| 181 | - public $metric; |
|
| 182 | - |
|
| 183 | - /** |
|
| 184 | - * The algorithm type to use when optimizing the route. |
|
| 185 | - * @see Enum\AlgorithmType |
|
| 186 | - * @var integer |
|
| 187 | - */ |
|
| 188 | - public $algorithm_type; |
|
| 189 | - |
|
| 190 | - /** |
|
| 191 | - * The route owner's member ID.<br> |
|
| 192 | - * In order for users in your organization to have routes assigned to them, |
|
| 193 | - * you must provide their member ID within the Route4Me system.<br> |
|
| 194 | - * A list of member IDs can be retrieved with view_users API method. |
|
| 195 | - * @var integer |
|
| 196 | - */ |
|
| 197 | - public $member_id; |
|
| 198 | - |
|
| 199 | - /** |
|
| 200 | - * Specify the ip address of the remote user making this optimization request. |
|
| 201 | - * @var long |
|
| 202 | - */ |
|
| 203 | - public $ip; |
|
| 204 | - |
|
| 205 | - /** |
|
| 206 | - * The method to use when compute the distance between the points in a route.<br> |
|
| 207 | - * Available values: from 1 to 12. |
|
| 208 | - * @var integer |
|
| 209 | - */ |
|
| 210 | - public $dm; |
|
| 211 | - |
|
| 212 | - /** |
|
| 213 | - * Directions method. |
|
| 214 | - * @var integer |
|
| 215 | - */ |
|
| 216 | - public $dirm; |
|
| 217 | - |
|
| 218 | - /** |
|
| 219 | - * Legacy feature which permits a user to request an example number of optimized routes. |
|
| 220 | - * @var integer |
|
| 221 | - */ |
|
| 222 | - public $parts; |
|
| 223 | - |
|
| 224 | - /** |
|
| 225 | - * 32 Character MD5 String ID of the device that was used to plan this route. |
|
| 226 | - * @deprecated Always null |
|
| 227 | - * @var string |
|
| 228 | - */ |
|
| 229 | - public $device_id; |
|
| 230 | - |
|
| 231 | - /** |
|
| 232 | - * The type of device making this request. |
|
| 233 | - * @see Enum\DeviceType |
|
| 234 | - * @var string |
|
| 235 | - */ |
|
| 236 | - public $device_type; |
|
| 237 | - |
|
| 238 | - /** |
|
| 239 | - * If true, the vehicle has a trailer.<br> |
|
| 240 | - * For routes that have trucking directions enabled, directions generated<br> |
|
| 241 | - * will ensure compliance so that road directions generated do not take the vehicle |
|
| 242 | - * where trailers are prohibited. |
|
| 243 | - * @var Boolean |
|
| 244 | - */ |
|
| 245 | - public $has_trailer; |
|
| 246 | - |
|
| 247 | - /** |
|
| 248 | - * The vehicle's trailer weight.<br> |
|
| 249 | - * For routes that have trucking directions enabled, directions generated<br> |
|
| 250 | - * will ensure compliance so that road directions generated do not take the vehicle<br> |
|
| 251 | - * on roads where the weight of the vehicle in tons exceeds this value. |
|
| 252 | - * @var double |
|
| 253 | - */ |
|
| 254 | - public $trailer_weight_t; |
|
| 255 | - |
|
| 256 | - /** |
|
| 257 | - * If travel_mode is Trucking, specifies the truck weight. |
|
| 258 | - * @var double |
|
| 259 | - */ |
|
| 260 | - public $limited_weight_t; |
|
| 261 | - |
|
| 262 | - /** |
|
| 263 | - * The vehicle's weight per axle (tons) |
|
| 264 | - * @var double |
|
| 265 | - */ |
|
| 266 | - public $weight_per_axle_t; |
|
| 267 | - |
|
| 268 | - /** |
|
| 269 | - * Comma-delimited list of the truck hazardous goods. |
|
| 270 | - * @var string |
|
| 271 | - */ |
|
| 272 | - public $truck_hazardous_goods; |
|
| 273 | - |
|
| 274 | - /** |
|
| 275 | - * Truck axles number. |
|
| 276 | - * @var integer |
|
| 277 | - */ |
|
| 278 | - public $truck_axles; |
|
| 279 | - |
|
| 280 | - /** |
|
| 281 | - * Truck toll road usage. enum: ["YES", "NO"] |
|
| 282 | - * @var string |
|
| 283 | - */ |
|
| 284 | - public $truck_toll_road_usage; |
|
| 285 | - |
|
| 286 | - /** |
|
| 287 | - * Truck avoid ferries. enum: ["YES", "NO"] |
|
| 288 | - * @var string |
|
| 289 | - */ |
|
| 290 | - public $truck_avoid_ferries; |
|
| 291 | - |
|
| 292 | - /** |
|
| 293 | - * Truck highway only. enum: ["YES", "NO"] |
|
| 294 | - * @var string |
|
| 295 | - */ |
|
| 296 | - public $truck_hwy_only; |
|
| 297 | - |
|
| 298 | - /** |
|
| 299 | - * Truck of the type Long Combination Vehicle. enum: ["YES", "NO"] |
|
| 300 | - * @var string |
|
| 301 | - */ |
|
| 302 | - public $truck_lcv; |
|
| 303 | - |
|
| 304 | - /** |
|
| 305 | - * Avoid international borders. enum: ["YES", "NO"] |
|
| 306 | - * @var string |
|
| 307 | - */ |
|
| 308 | - public $truck_borders; |
|
| 309 | - |
|
| 310 | - /** |
|
| 311 | - * Truck side street adherence.<br> |
|
| 312 | - * enum: ["OFF", "MINIMAL","MODERATE","AVERAGE","STRICT","ADHERE","STRONGLYHERE"] |
|
| 313 | - * @var string |
|
| 314 | - */ |
|
| 315 | - public $truck_side_street_adherence; |
|
| 316 | - |
|
| 317 | - /** |
|
| 318 | - * Truck configuration. |
|
| 319 | - * enum: ["NONE","PASSENGER","28_DOUBLETRAILER","48_STRAIGHT_TRUCK", |
|
| 320 | - * "48_SEMI_TRAILER","53_SEMI_TRAILER","FULLSIZEVAN","26_STRAIGHT_TRUCK"] |
|
| 321 | - * @var string |
|
| 322 | - */ |
|
| 323 | - public $truck_config; |
|
| 324 | - |
|
| 325 | - /** |
|
| 326 | - * Truck dimension unit. enum: ["mi","km"] |
|
| 327 | - * @var string |
|
| 328 | - */ |
|
| 329 | - public $truck_dim_unit; |
|
| 330 | - |
|
| 331 | - /** |
|
| 332 | - * Truck type. |
|
| 333 | - * enum: ["suv","pickup_truck","van","18wheeler","cabin","waste_disposal", |
|
| 334 | - * "tree_cutting","bigrig","cement_mixer","livestock_carrier","dairy", "tractor_trailer"] |
|
| 335 | - * @var string |
|
| 336 | - */ |
|
| 337 | - public $truck_type; |
|
| 338 | - |
|
| 339 | - /** |
|
| 340 | - * If travel_mode = 'Trucking', specifies the truck weight (required) |
|
| 341 | - * @var double |
|
| 342 | - */ |
|
| 343 | - public $truck_weight; |
|
| 344 | - |
|
| 345 | - /** |
|
| 346 | - * Maximum cargo weight a vehicle can cary. |
|
| 347 | - * @var double |
|
| 348 | - */ |
|
| 349 | - public $vehicle_max_cargo_weight; |
|
| 350 | - |
|
| 351 | - /** |
|
| 352 | - * Maximum cargo volume a vehicle can cary. |
|
| 353 | - * @var double |
|
| 354 | - */ |
|
| 355 | - public $vehicle_max_cargo_volume; |
|
| 356 | - |
|
| 357 | - /** |
|
| 358 | - * Maximum allowed revenue from a subtour. |
|
| 359 | - * @var integer |
|
| 360 | - */ |
|
| 361 | - public $subtour_max_revenue; |
|
| 362 | - |
|
| 363 | - /** |
|
| 364 | - * An array of the Avoidance zones IDs. |
|
| 365 | - * @var string[] |
|
| 366 | - */ |
|
| 367 | - public $avoidance_zones = []; |
|
| 368 | - |
|
| 369 | - /** |
|
| 370 | - * The vehicle ID, to be assigned to the route. |
|
| 371 | - * @deprecated All new routes should be assigned to a member_id |
|
| 372 | - * @var string |
|
| 373 | - */ |
|
| 374 | - public $driver_id; |
|
| 375 | - |
|
| 376 | - /** |
|
| 377 | - * Minimum number of optimized routes. |
|
| 378 | - * @var integer |
|
| 379 | - */ |
|
| 380 | - public $parts_min; |
|
| 381 | - |
|
| 382 | - /** |
|
| 383 | - * If true, the vehicle will first drive then wait between stops. |
|
| 384 | - * @var Boolean |
|
| 385 | - */ |
|
| 386 | - public $first_drive_then_wait_between_stops; |
|
| 387 | - |
|
| 388 | - /** |
|
| 389 | - * The truck height.<br> |
|
| 390 | - * For routes that have trucking directions enabled, directions generated<br> |
|
| 391 | - * will ensure compliance of this maximum height of truck when generating |
|
| 392 | - * road network driving directions. |
|
| 393 | - * @var double |
|
| 394 | - */ |
|
| 395 | - public $truck_height; |
|
| 396 | - |
|
| 397 | - /** |
|
| 398 | - * The truck width.<br> |
|
| 399 | - * For routes that have trucking directions enabled, directions generated |
|
| 400 | - * will ensure compliance of this width of the truck when generating road network |
|
| 401 | - * driving directions. |
|
| 402 | - * @var double |
|
| 403 | - */ |
|
| 404 | - public $truck_width; |
|
| 405 | - |
|
| 406 | - /** |
|
| 407 | - * The truck length.<br> |
|
| 408 | - * For routes that have trucking directions enabled, directions generated |
|
| 409 | - * will ensure compliance of this length of the truck when generating |
|
| 410 | - * road network driving directions. |
|
| 411 | - * @var double |
|
| 412 | - */ |
|
| 413 | - public $truck_length; |
|
| 414 | - |
|
| 415 | - /** |
|
| 416 | - * The optimization quality.<br> |
|
| 417 | - * Available values: |
|
| 418 | - * - 1 - Generate Optimized Routes As Quickly as Possible; |
|
| 419 | - * - 2 - Generate Routes That Look Better On A Map; |
|
| 420 | - * - 3 - Generate The Shortest And Quickest Possible Routes. |
|
| 421 | - * @var integer |
|
| 422 | - */ |
|
| 423 | - public $optimization_quality; |
|
| 424 | - |
|
| 425 | - /** |
|
| 426 | - * The maximum number of stops permitted per created subroute. |
|
| 427 | - * @var integer |
|
| 428 | - */ |
|
| 429 | - public $max_tour_size; |
|
| 430 | - |
|
| 431 | - /** |
|
| 432 | - * The minimum number of stops permitted per created subroute. |
|
| 433 | - * @var integer |
|
| 434 | - */ |
|
| 435 | - public $min_tour_size; |
|
| 436 | - |
|
| 437 | - /** |
|
| 438 | - * If equal to 1, uturn is allowed for the vehicle. |
|
| 439 | - * @var integer |
|
| 440 | - */ |
|
| 441 | - public $uturn; |
|
| 442 | - |
|
| 443 | - /** |
|
| 444 | - * If equal to 1, leftturn is allowed for the vehicle. |
|
| 445 | - * @var integer |
|
| 446 | - */ |
|
| 447 | - public $leftturn; |
|
| 448 | - |
|
| 449 | - /** |
|
| 450 | - * If equal to 1, rightturn is allowed for the vehicle. |
|
| 451 | - * @var integer |
|
| 452 | - */ |
|
| 453 | - public $rightturn; |
|
| 454 | - |
|
| 455 | - /** |
|
| 456 | - * Route travel time slowdown (e.g. 25 (means 25% slowdown)). |
|
| 457 | - * @note the parameter is read-only and it can be set |
|
| 458 | - * with the parameter Slowdowns.TravelTime. |
|
| 459 | - * @var integer |
|
| 460 | - */ |
|
| 461 | - public $route_time_multiplier; |
|
| 462 | - |
|
| 463 | - /** |
|
| 464 | - * Route service time slowdown (e.g. 10 (means 10% slowdown)). |
|
| 465 | - * @note the parameter is read-only and it can be set |
|
| 466 | - * with the parameter Slowdowns.TravelTime. |
|
| 467 | - * @var integer |
|
| 468 | - */ |
|
| 469 | - public $route_service_time_multiplier; |
|
| 470 | - |
|
| 471 | - /** |
|
| 472 | - * Optimization engine (e.g. '1','2' etc) |
|
| 473 | - * @var string |
|
| 474 | - */ |
|
| 475 | - public $optimization_engine; |
|
| 476 | - |
|
| 477 | - /** |
|
| 478 | - * Override addresses |
|
| 479 | - * @var OverrideAddresses |
|
| 480 | - */ |
|
| 481 | - public $override_addresses; |
|
| 482 | - |
|
| 483 | - /** |
|
| 484 | - * Address bundling rules |
|
| 485 | - * @var V5\Addresses\AddressBundling |
|
| 486 | - */ |
|
| 487 | - public $bundling; |
|
| 488 | - |
|
| 489 | - /** |
|
| 490 | - * Advanced route constraints |
|
| 491 | - * @var RouteAdvancedConstraints |
|
| 492 | - */ |
|
| 493 | - public $advanced_constraints = []; |
|
| 494 | - |
|
| 495 | - /** |
|
| 496 | - * If true, the time windows ignored. |
|
| 497 | - * @var Boolean |
|
| 498 | - */ |
|
| 499 | - public $ignore_tw; |
|
| 500 | - |
|
| 501 | - /** |
|
| 502 | - * If true, the start time is dynamic. |
|
| 503 | - * @var Boolean |
|
| 504 | - */ |
|
| 505 | - public $is_dynamic_start_time; |
|
| 506 | - |
|
| 507 | - /** |
|
| 508 | - * @deprecated The parameter 'route_type' isn't included in route parameters. |
|
| 509 | - * @var string |
|
| 510 | - */ |
|
| 511 | - public $route_type; |
|
| 512 | - |
|
| 513 | - /** |
|
| 514 | - * Slowdown of the optimization parameters. |
|
| 515 | - * @note This is only query parameter. |
|
| 516 | - * @note This parameter is used in the optimization creation/generation process. |
|
| 517 | - * @var SlowdownParams |
|
| 518 | - */ |
|
| 519 | - public $slowdowns; |
|
| 520 | - |
|
| 521 | - public static function fromArray(array $params) |
|
| 522 | - { |
|
| 523 | - $routeParams = new self(); |
|
| 524 | - foreach ($params as $key => $value) { |
|
| 525 | - if (property_exists($routeParams, $key)) { |
|
| 526 | - $routeParams->{$key} = $value; |
|
| 527 | - } |
|
| 528 | - } |
|
| 529 | - |
|
| 530 | - return $routeParams; |
|
| 531 | - } |
|
| 532 | - |
|
| 533 | - public function setAddressBundle($addressBundle) |
|
| 534 | - { |
|
| 535 | - $this->bundling = $addressBundle; |
|
| 536 | - } |
|
| 537 | - |
|
| 538 | - public function getAddressBundle() |
|
| 539 | - { |
|
| 540 | - return $this->bundling; |
|
| 541 | - } |
|
| 14 | + /** |
|
| 15 | + * Let the R4M API know if this SDK request is comming |
|
| 16 | + * from a file upload within your environment (for analytics). |
|
| 17 | + * @var Boolean |
|
| 18 | + */ |
|
| 19 | + public $is_upload; |
|
| 20 | + |
|
| 21 | + /** |
|
| 22 | + * The tour type of this route. rt is short for round trip, |
|
| 23 | + * the optimization engine changes its behavior for round trip |
|
| 24 | + * @var Boolean |
|
| 25 | + */ |
|
| 26 | + public $rt; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * The name of this route. this route name will be accessible in the search API, |
|
| 30 | + * and also will be displayed on the mobile device of a user. |
|
| 31 | + * @var string |
|
| 32 | + */ |
|
| 33 | + public $route_name; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * The route start date in UTC, unix timestamp seconds. |
|
| 37 | + * Used to show users when the route will begin, also used for reporting and analytics. |
|
| 38 | + * @var integer |
|
| 39 | + */ |
|
| 40 | + public $route_date; |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * Offset in seconds relative to the route start date (i.e. 9AM would be 60 * 60 * 9) |
|
| 44 | + * @var integer |
|
| 45 | + */ |
|
| 46 | + public $route_time; |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * @deprecated 'Always false' |
|
| 50 | + * @var string |
|
| 51 | + */ |
|
| 52 | + public $shared_publicly; |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * By disabling optimization, the route optimization engine |
|
| 56 | + * will not resequence the stops in your. |
|
| 57 | + * @var disable_optimization |
|
| 58 | + */ |
|
| 59 | + public $disable_optimization; |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * Gets or sets the optimize parameter.<br> |
|
| 63 | + * Availabale values: |
|
| 64 | + * - Distance, |
|
| 65 | + * - Time, |
|
| 66 | + * - timeWithTraffic |
|
| 67 | + * @var string |
|
| 68 | + */ |
|
| 69 | + public $optimize; |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * When the tour type is not round trip (rt = false), |
|
| 73 | + * enable lock last so that the final destination is fixed. |
|
| 74 | + * @var Boolean |
|
| 75 | + */ |
|
| 76 | + public $lock_last; |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * Vehicle capacity. |
|
| 80 | + * @var integer |
|
| 81 | + */ |
|
| 82 | + public $vehicle_capacity; |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * Maximum distance for a single vehicle in the route (always in miles) |
|
| 86 | + * @var integer |
|
| 87 | + */ |
|
| 88 | + public $vehicle_max_distance_mi; |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * The distance measurement unit for the route. |
|
| 92 | + * km or mi, the route4me api will convert all measurements into these units. |
|
| 93 | + * @var string |
|
| 94 | + */ |
|
| 95 | + public $distance_unit; |
|
| 96 | + |
|
| 97 | + /** |
|
| 98 | + * The mode of travel that the directions should be optimized for.<br> |
|
| 99 | + * Available values: |
|
| 100 | + * - Driving |
|
| 101 | + * - Walking |
|
| 102 | + * @var string |
|
| 103 | + */ |
|
| 104 | + public $travel_mode; |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * Options which let the user choose which road obstacles to avoid.<br> |
|
| 108 | + * This has no impact on route sequencing.<br> |
|
| 109 | + * Available values: |
|
| 110 | + * - Highways |
|
| 111 | + * - Tolls |
|
| 112 | + * - minimizeHighways |
|
| 113 | + * - minimizeTolls |
|
| 114 | + * - highways,tolls |
|
| 115 | + * - "". |
|
| 116 | + * @var string |
|
| 117 | + */ |
|
| 118 | + public $avoid; |
|
| 119 | + |
|
| 120 | + /** |
|
| 121 | + * The vehicle ID |
|
| 122 | + * @var string |
|
| 123 | + */ |
|
| 124 | + public $vehicle_id; |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * The latitude of the device making this sdk request. |
|
| 128 | + * @var double |
|
| 129 | + */ |
|
| 130 | + public $dev_lat; |
|
| 131 | + |
|
| 132 | + /** |
|
| 133 | + * The longitude of the device making this sdk request. |
|
| 134 | + * @var double |
|
| 135 | + */ |
|
| 136 | + public $dev_lng; |
|
| 137 | + |
|
| 138 | + /** |
|
| 139 | + * When using a multiple driver algorithm, this is the maximum permissible duration of a generated route.<br> |
|
| 140 | + * The optimization system will automatically create more routes when the route_max_duration is exceeded for a route.<br> |
|
| 141 | + * However it will create an 'unrouted' list of addresses if the maximum number of drivers is exceeded. |
|
| 142 | + * @var long |
|
| 143 | + */ |
|
| 144 | + public $route_max_duration; |
|
| 145 | + |
|
| 146 | + /** |
|
| 147 | + * The parameter specifies fine-tuning of an optimization process by route duration. |
|
| 148 | + * @var double |
|
| 149 | + */ |
|
| 150 | + public $target_duration; |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * The parameter specifies fine-tuning of an optimization process by route distance. |
|
| 154 | + * @var double |
|
| 155 | + */ |
|
| 156 | + public $target_distance; |
|
| 157 | + |
|
| 158 | + /** |
|
| 159 | + * The parameter specifies fine-tuning of an optimization process by waiting time. |
|
| 160 | + * @var double |
|
| 161 | + */ |
|
| 162 | + public $target_wait_by_tail_size; |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * The email address to notify upon completion of an optimization request. |
|
| 166 | + * @var string |
|
| 167 | + */ |
|
| 168 | + public $route_email; |
|
| 169 | + |
|
| 170 | + /** |
|
| 171 | + * @deprecated All routes are stored by default at this time |
|
| 172 | + * @var |
|
| 173 | + */ |
|
| 174 | + public $store_route = true; |
|
| 175 | + |
|
| 176 | + /** |
|
| 177 | + * Metric system |
|
| 178 | + * @see Enum\Metric |
|
| 179 | + * @var integer |
|
| 180 | + */ |
|
| 181 | + public $metric; |
|
| 182 | + |
|
| 183 | + /** |
|
| 184 | + * The algorithm type to use when optimizing the route. |
|
| 185 | + * @see Enum\AlgorithmType |
|
| 186 | + * @var integer |
|
| 187 | + */ |
|
| 188 | + public $algorithm_type; |
|
| 189 | + |
|
| 190 | + /** |
|
| 191 | + * The route owner's member ID.<br> |
|
| 192 | + * In order for users in your organization to have routes assigned to them, |
|
| 193 | + * you must provide their member ID within the Route4Me system.<br> |
|
| 194 | + * A list of member IDs can be retrieved with view_users API method. |
|
| 195 | + * @var integer |
|
| 196 | + */ |
|
| 197 | + public $member_id; |
|
| 198 | + |
|
| 199 | + /** |
|
| 200 | + * Specify the ip address of the remote user making this optimization request. |
|
| 201 | + * @var long |
|
| 202 | + */ |
|
| 203 | + public $ip; |
|
| 204 | + |
|
| 205 | + /** |
|
| 206 | + * The method to use when compute the distance between the points in a route.<br> |
|
| 207 | + * Available values: from 1 to 12. |
|
| 208 | + * @var integer |
|
| 209 | + */ |
|
| 210 | + public $dm; |
|
| 211 | + |
|
| 212 | + /** |
|
| 213 | + * Directions method. |
|
| 214 | + * @var integer |
|
| 215 | + */ |
|
| 216 | + public $dirm; |
|
| 217 | + |
|
| 218 | + /** |
|
| 219 | + * Legacy feature which permits a user to request an example number of optimized routes. |
|
| 220 | + * @var integer |
|
| 221 | + */ |
|
| 222 | + public $parts; |
|
| 223 | + |
|
| 224 | + /** |
|
| 225 | + * 32 Character MD5 String ID of the device that was used to plan this route. |
|
| 226 | + * @deprecated Always null |
|
| 227 | + * @var string |
|
| 228 | + */ |
|
| 229 | + public $device_id; |
|
| 230 | + |
|
| 231 | + /** |
|
| 232 | + * The type of device making this request. |
|
| 233 | + * @see Enum\DeviceType |
|
| 234 | + * @var string |
|
| 235 | + */ |
|
| 236 | + public $device_type; |
|
| 237 | + |
|
| 238 | + /** |
|
| 239 | + * If true, the vehicle has a trailer.<br> |
|
| 240 | + * For routes that have trucking directions enabled, directions generated<br> |
|
| 241 | + * will ensure compliance so that road directions generated do not take the vehicle |
|
| 242 | + * where trailers are prohibited. |
|
| 243 | + * @var Boolean |
|
| 244 | + */ |
|
| 245 | + public $has_trailer; |
|
| 246 | + |
|
| 247 | + /** |
|
| 248 | + * The vehicle's trailer weight.<br> |
|
| 249 | + * For routes that have trucking directions enabled, directions generated<br> |
|
| 250 | + * will ensure compliance so that road directions generated do not take the vehicle<br> |
|
| 251 | + * on roads where the weight of the vehicle in tons exceeds this value. |
|
| 252 | + * @var double |
|
| 253 | + */ |
|
| 254 | + public $trailer_weight_t; |
|
| 255 | + |
|
| 256 | + /** |
|
| 257 | + * If travel_mode is Trucking, specifies the truck weight. |
|
| 258 | + * @var double |
|
| 259 | + */ |
|
| 260 | + public $limited_weight_t; |
|
| 261 | + |
|
| 262 | + /** |
|
| 263 | + * The vehicle's weight per axle (tons) |
|
| 264 | + * @var double |
|
| 265 | + */ |
|
| 266 | + public $weight_per_axle_t; |
|
| 267 | + |
|
| 268 | + /** |
|
| 269 | + * Comma-delimited list of the truck hazardous goods. |
|
| 270 | + * @var string |
|
| 271 | + */ |
|
| 272 | + public $truck_hazardous_goods; |
|
| 273 | + |
|
| 274 | + /** |
|
| 275 | + * Truck axles number. |
|
| 276 | + * @var integer |
|
| 277 | + */ |
|
| 278 | + public $truck_axles; |
|
| 279 | + |
|
| 280 | + /** |
|
| 281 | + * Truck toll road usage. enum: ["YES", "NO"] |
|
| 282 | + * @var string |
|
| 283 | + */ |
|
| 284 | + public $truck_toll_road_usage; |
|
| 285 | + |
|
| 286 | + /** |
|
| 287 | + * Truck avoid ferries. enum: ["YES", "NO"] |
|
| 288 | + * @var string |
|
| 289 | + */ |
|
| 290 | + public $truck_avoid_ferries; |
|
| 291 | + |
|
| 292 | + /** |
|
| 293 | + * Truck highway only. enum: ["YES", "NO"] |
|
| 294 | + * @var string |
|
| 295 | + */ |
|
| 296 | + public $truck_hwy_only; |
|
| 297 | + |
|
| 298 | + /** |
|
| 299 | + * Truck of the type Long Combination Vehicle. enum: ["YES", "NO"] |
|
| 300 | + * @var string |
|
| 301 | + */ |
|
| 302 | + public $truck_lcv; |
|
| 303 | + |
|
| 304 | + /** |
|
| 305 | + * Avoid international borders. enum: ["YES", "NO"] |
|
| 306 | + * @var string |
|
| 307 | + */ |
|
| 308 | + public $truck_borders; |
|
| 309 | + |
|
| 310 | + /** |
|
| 311 | + * Truck side street adherence.<br> |
|
| 312 | + * enum: ["OFF", "MINIMAL","MODERATE","AVERAGE","STRICT","ADHERE","STRONGLYHERE"] |
|
| 313 | + * @var string |
|
| 314 | + */ |
|
| 315 | + public $truck_side_street_adherence; |
|
| 316 | + |
|
| 317 | + /** |
|
| 318 | + * Truck configuration. |
|
| 319 | + * enum: ["NONE","PASSENGER","28_DOUBLETRAILER","48_STRAIGHT_TRUCK", |
|
| 320 | + * "48_SEMI_TRAILER","53_SEMI_TRAILER","FULLSIZEVAN","26_STRAIGHT_TRUCK"] |
|
| 321 | + * @var string |
|
| 322 | + */ |
|
| 323 | + public $truck_config; |
|
| 324 | + |
|
| 325 | + /** |
|
| 326 | + * Truck dimension unit. enum: ["mi","km"] |
|
| 327 | + * @var string |
|
| 328 | + */ |
|
| 329 | + public $truck_dim_unit; |
|
| 330 | + |
|
| 331 | + /** |
|
| 332 | + * Truck type. |
|
| 333 | + * enum: ["suv","pickup_truck","van","18wheeler","cabin","waste_disposal", |
|
| 334 | + * "tree_cutting","bigrig","cement_mixer","livestock_carrier","dairy", "tractor_trailer"] |
|
| 335 | + * @var string |
|
| 336 | + */ |
|
| 337 | + public $truck_type; |
|
| 338 | + |
|
| 339 | + /** |
|
| 340 | + * If travel_mode = 'Trucking', specifies the truck weight (required) |
|
| 341 | + * @var double |
|
| 342 | + */ |
|
| 343 | + public $truck_weight; |
|
| 344 | + |
|
| 345 | + /** |
|
| 346 | + * Maximum cargo weight a vehicle can cary. |
|
| 347 | + * @var double |
|
| 348 | + */ |
|
| 349 | + public $vehicle_max_cargo_weight; |
|
| 350 | + |
|
| 351 | + /** |
|
| 352 | + * Maximum cargo volume a vehicle can cary. |
|
| 353 | + * @var double |
|
| 354 | + */ |
|
| 355 | + public $vehicle_max_cargo_volume; |
|
| 356 | + |
|
| 357 | + /** |
|
| 358 | + * Maximum allowed revenue from a subtour. |
|
| 359 | + * @var integer |
|
| 360 | + */ |
|
| 361 | + public $subtour_max_revenue; |
|
| 362 | + |
|
| 363 | + /** |
|
| 364 | + * An array of the Avoidance zones IDs. |
|
| 365 | + * @var string[] |
|
| 366 | + */ |
|
| 367 | + public $avoidance_zones = []; |
|
| 368 | + |
|
| 369 | + /** |
|
| 370 | + * The vehicle ID, to be assigned to the route. |
|
| 371 | + * @deprecated All new routes should be assigned to a member_id |
|
| 372 | + * @var string |
|
| 373 | + */ |
|
| 374 | + public $driver_id; |
|
| 375 | + |
|
| 376 | + /** |
|
| 377 | + * Minimum number of optimized routes. |
|
| 378 | + * @var integer |
|
| 379 | + */ |
|
| 380 | + public $parts_min; |
|
| 381 | + |
|
| 382 | + /** |
|
| 383 | + * If true, the vehicle will first drive then wait between stops. |
|
| 384 | + * @var Boolean |
|
| 385 | + */ |
|
| 386 | + public $first_drive_then_wait_between_stops; |
|
| 387 | + |
|
| 388 | + /** |
|
| 389 | + * The truck height.<br> |
|
| 390 | + * For routes that have trucking directions enabled, directions generated<br> |
|
| 391 | + * will ensure compliance of this maximum height of truck when generating |
|
| 392 | + * road network driving directions. |
|
| 393 | + * @var double |
|
| 394 | + */ |
|
| 395 | + public $truck_height; |
|
| 396 | + |
|
| 397 | + /** |
|
| 398 | + * The truck width.<br> |
|
| 399 | + * For routes that have trucking directions enabled, directions generated |
|
| 400 | + * will ensure compliance of this width of the truck when generating road network |
|
| 401 | + * driving directions. |
|
| 402 | + * @var double |
|
| 403 | + */ |
|
| 404 | + public $truck_width; |
|
| 405 | + |
|
| 406 | + /** |
|
| 407 | + * The truck length.<br> |
|
| 408 | + * For routes that have trucking directions enabled, directions generated |
|
| 409 | + * will ensure compliance of this length of the truck when generating |
|
| 410 | + * road network driving directions. |
|
| 411 | + * @var double |
|
| 412 | + */ |
|
| 413 | + public $truck_length; |
|
| 414 | + |
|
| 415 | + /** |
|
| 416 | + * The optimization quality.<br> |
|
| 417 | + * Available values: |
|
| 418 | + * - 1 - Generate Optimized Routes As Quickly as Possible; |
|
| 419 | + * - 2 - Generate Routes That Look Better On A Map; |
|
| 420 | + * - 3 - Generate The Shortest And Quickest Possible Routes. |
|
| 421 | + * @var integer |
|
| 422 | + */ |
|
| 423 | + public $optimization_quality; |
|
| 424 | + |
|
| 425 | + /** |
|
| 426 | + * The maximum number of stops permitted per created subroute. |
|
| 427 | + * @var integer |
|
| 428 | + */ |
|
| 429 | + public $max_tour_size; |
|
| 430 | + |
|
| 431 | + /** |
|
| 432 | + * The minimum number of stops permitted per created subroute. |
|
| 433 | + * @var integer |
|
| 434 | + */ |
|
| 435 | + public $min_tour_size; |
|
| 436 | + |
|
| 437 | + /** |
|
| 438 | + * If equal to 1, uturn is allowed for the vehicle. |
|
| 439 | + * @var integer |
|
| 440 | + */ |
|
| 441 | + public $uturn; |
|
| 442 | + |
|
| 443 | + /** |
|
| 444 | + * If equal to 1, leftturn is allowed for the vehicle. |
|
| 445 | + * @var integer |
|
| 446 | + */ |
|
| 447 | + public $leftturn; |
|
| 448 | + |
|
| 449 | + /** |
|
| 450 | + * If equal to 1, rightturn is allowed for the vehicle. |
|
| 451 | + * @var integer |
|
| 452 | + */ |
|
| 453 | + public $rightturn; |
|
| 454 | + |
|
| 455 | + /** |
|
| 456 | + * Route travel time slowdown (e.g. 25 (means 25% slowdown)). |
|
| 457 | + * @note the parameter is read-only and it can be set |
|
| 458 | + * with the parameter Slowdowns.TravelTime. |
|
| 459 | + * @var integer |
|
| 460 | + */ |
|
| 461 | + public $route_time_multiplier; |
|
| 462 | + |
|
| 463 | + /** |
|
| 464 | + * Route service time slowdown (e.g. 10 (means 10% slowdown)). |
|
| 465 | + * @note the parameter is read-only and it can be set |
|
| 466 | + * with the parameter Slowdowns.TravelTime. |
|
| 467 | + * @var integer |
|
| 468 | + */ |
|
| 469 | + public $route_service_time_multiplier; |
|
| 470 | + |
|
| 471 | + /** |
|
| 472 | + * Optimization engine (e.g. '1','2' etc) |
|
| 473 | + * @var string |
|
| 474 | + */ |
|
| 475 | + public $optimization_engine; |
|
| 476 | + |
|
| 477 | + /** |
|
| 478 | + * Override addresses |
|
| 479 | + * @var OverrideAddresses |
|
| 480 | + */ |
|
| 481 | + public $override_addresses; |
|
| 482 | + |
|
| 483 | + /** |
|
| 484 | + * Address bundling rules |
|
| 485 | + * @var V5\Addresses\AddressBundling |
|
| 486 | + */ |
|
| 487 | + public $bundling; |
|
| 488 | + |
|
| 489 | + /** |
|
| 490 | + * Advanced route constraints |
|
| 491 | + * @var RouteAdvancedConstraints |
|
| 492 | + */ |
|
| 493 | + public $advanced_constraints = []; |
|
| 494 | + |
|
| 495 | + /** |
|
| 496 | + * If true, the time windows ignored. |
|
| 497 | + * @var Boolean |
|
| 498 | + */ |
|
| 499 | + public $ignore_tw; |
|
| 500 | + |
|
| 501 | + /** |
|
| 502 | + * If true, the start time is dynamic. |
|
| 503 | + * @var Boolean |
|
| 504 | + */ |
|
| 505 | + public $is_dynamic_start_time; |
|
| 506 | + |
|
| 507 | + /** |
|
| 508 | + * @deprecated The parameter 'route_type' isn't included in route parameters. |
|
| 509 | + * @var string |
|
| 510 | + */ |
|
| 511 | + public $route_type; |
|
| 512 | + |
|
| 513 | + /** |
|
| 514 | + * Slowdown of the optimization parameters. |
|
| 515 | + * @note This is only query parameter. |
|
| 516 | + * @note This parameter is used in the optimization creation/generation process. |
|
| 517 | + * @var SlowdownParams |
|
| 518 | + */ |
|
| 519 | + public $slowdowns; |
|
| 520 | + |
|
| 521 | + public static function fromArray(array $params) |
|
| 522 | + { |
|
| 523 | + $routeParams = new self(); |
|
| 524 | + foreach ($params as $key => $value) { |
|
| 525 | + if (property_exists($routeParams, $key)) { |
|
| 526 | + $routeParams->{$key} = $value; |
|
| 527 | + } |
|
| 528 | + } |
|
| 529 | + |
|
| 530 | + return $routeParams; |
|
| 531 | + } |
|
| 532 | + |
|
| 533 | + public function setAddressBundle($addressBundle) |
|
| 534 | + { |
|
| 535 | + $this->bundling = $addressBundle; |
|
| 536 | + } |
|
| 537 | + |
|
| 538 | + public function getAddressBundle() |
|
| 539 | + { |
|
| 540 | + return $this->bundling; |
|
| 541 | + } |
|
| 542 | 542 | } |
@@ -4,8 +4,8 @@ |
||
| 4 | 4 | |
| 5 | 5 | class myErrorHandler extends \Exception |
| 6 | 6 | { |
| 7 | - public function proc_error($errno, $errstr, $errfile, $errline) |
|
| 8 | - { |
|
| 9 | - echo "Error No: $errno, line: $errline --- ".$errstr.'<br>'; |
|
| 10 | - } |
|
| 7 | + public function proc_error($errno, $errstr, $errfile, $errline) |
|
| 8 | + { |
|
| 9 | + echo "Error No: $errno, line: $errline --- ".$errstr.'<br>'; |
|
| 10 | + } |
|
| 11 | 11 | } |
@@ -6,109 +6,109 @@ |
||
| 6 | 6 | |
| 7 | 7 | class Geocoding extends Common |
| 8 | 8 | { |
| 9 | - public $strExportFormat; |
|
| 10 | - public $format; |
|
| 11 | - public $addresses; |
|
| 12 | - public $pk; |
|
| 13 | - public $offset; |
|
| 14 | - public $limit; |
|
| 15 | - public $housenumber; |
|
| 16 | - public $zipcode; |
|
| 9 | + public $strExportFormat; |
|
| 10 | + public $format; |
|
| 11 | + public $addresses; |
|
| 12 | + public $pk; |
|
| 13 | + public $offset; |
|
| 14 | + public $limit; |
|
| 15 | + public $housenumber; |
|
| 16 | + public $zipcode; |
|
| 17 | 17 | |
| 18 | - public static function fromArray(array $params) |
|
| 19 | - { |
|
| 20 | - $geocoding = new self(); |
|
| 18 | + public static function fromArray(array $params) |
|
| 19 | + { |
|
| 20 | + $geocoding = new self(); |
|
| 21 | 21 | |
| 22 | - foreach ($params as $key => $value) { |
|
| 23 | - if (property_exists($geocoding, $key)) { |
|
| 24 | - $geocoding->{$key} = $value; |
|
| 25 | - } |
|
| 26 | - } |
|
| 22 | + foreach ($params as $key => $value) { |
|
| 23 | + if (property_exists($geocoding, $key)) { |
|
| 24 | + $geocoding->{$key} = $value; |
|
| 25 | + } |
|
| 26 | + } |
|
| 27 | 27 | |
| 28 | - return $geocoding; |
|
| 29 | - } |
|
| 28 | + return $geocoding; |
|
| 29 | + } |
|
| 30 | 30 | |
| 31 | - public static function forwardGeocoding($params) |
|
| 32 | - { |
|
| 33 | - $allBodyFields = ['strExportFormat', 'addresses']; |
|
| 31 | + public static function forwardGeocoding($params) |
|
| 32 | + { |
|
| 33 | + $allBodyFields = ['strExportFormat', 'addresses']; |
|
| 34 | 34 | |
| 35 | - $fgCoding = Route4Me::makeRequst([ |
|
| 36 | - 'url' => Endpoint::GEOCODER, |
|
| 37 | - 'method' => 'POST', |
|
| 38 | - 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
| 39 | - 'HTTPHEADER' => 'Content-Type: multipart/form-data', |
|
| 40 | - ]); |
|
| 35 | + $fgCoding = Route4Me::makeRequst([ |
|
| 36 | + 'url' => Endpoint::GEOCODER, |
|
| 37 | + 'method' => 'POST', |
|
| 38 | + 'body' => Route4Me::generateRequestParameters($allBodyFields, $params), |
|
| 39 | + 'HTTPHEADER' => 'Content-Type: multipart/form-data', |
|
| 40 | + ]); |
|
| 41 | 41 | |
| 42 | - return $fgCoding; |
|
| 43 | - } |
|
| 42 | + return $fgCoding; |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - public static function reverseGeocoding($params) |
|
| 46 | - { |
|
| 47 | - $allQueryFields = ['format', 'addresses', 'detailed']; |
|
| 45 | + public static function reverseGeocoding($params) |
|
| 46 | + { |
|
| 47 | + $allQueryFields = ['format', 'addresses', 'detailed']; |
|
| 48 | 48 | |
| 49 | - $fgcoding = Route4Me::makeRequst([ |
|
| 50 | - 'url' => Endpoint::GEOCODER, |
|
| 51 | - 'method' => 'POST', |
|
| 52 | - 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
| 53 | - ]); |
|
| 49 | + $fgcoding = Route4Me::makeRequst([ |
|
| 50 | + 'url' => Endpoint::GEOCODER, |
|
| 51 | + 'method' => 'POST', |
|
| 52 | + 'query' => Route4Me::generateRequestParameters($allQueryFields, $params), |
|
| 53 | + ]); |
|
| 54 | 54 | |
| 55 | - return $fgcoding; |
|
| 56 | - } |
|
| 55 | + return $fgcoding; |
|
| 56 | + } |
|
| 57 | 57 | |
| 58 | - public static function getStreetData($params) |
|
| 59 | - { |
|
| 60 | - Route4Me::setBaseUrl(Endpoint::STREET_DATA); |
|
| 58 | + public static function getStreetData($params) |
|
| 59 | + { |
|
| 60 | + Route4Me::setBaseUrl(Endpoint::STREET_DATA); |
|
| 61 | 61 | |
| 62 | - $allPathFields = ['pk', 'offset', 'limit']; |
|
| 62 | + $allPathFields = ['pk', 'offset', 'limit']; |
|
| 63 | 63 | |
| 64 | - $url_query = Route4Me::generateUrlPath($allPathFields, $params); |
|
| 64 | + $url_query = Route4Me::generateUrlPath($allPathFields, $params); |
|
| 65 | 65 | |
| 66 | - $query = []; |
|
| 66 | + $query = []; |
|
| 67 | 67 | |
| 68 | - $response = Route4Me::makeRequst([ |
|
| 69 | - 'url' => $url_query, |
|
| 70 | - 'method' => 'GET', |
|
| 71 | - 'query' => $query, |
|
| 72 | - ]); |
|
| 68 | + $response = Route4Me::makeRequst([ |
|
| 69 | + 'url' => $url_query, |
|
| 70 | + 'method' => 'GET', |
|
| 71 | + 'query' => $query, |
|
| 72 | + ]); |
|
| 73 | 73 | |
| 74 | - return $response; |
|
| 75 | - } |
|
| 74 | + return $response; |
|
| 75 | + } |
|
| 76 | 76 | |
| 77 | - public static function getZipCode($params) |
|
| 78 | - { |
|
| 79 | - Route4Me::setBaseUrl(Endpoint::STREET_DATA_ZIPCODE); |
|
| 77 | + public static function getZipCode($params) |
|
| 78 | + { |
|
| 79 | + Route4Me::setBaseUrl(Endpoint::STREET_DATA_ZIPCODE); |
|
| 80 | 80 | |
| 81 | - $allPathFields = ['zipcode', 'offset', 'limit']; |
|
| 81 | + $allPathFields = ['zipcode', 'offset', 'limit']; |
|
| 82 | 82 | |
| 83 | - $url_query = Route4Me::generateUrlPath($allPathFields, $params); |
|
| 83 | + $url_query = Route4Me::generateUrlPath($allPathFields, $params); |
|
| 84 | 84 | |
| 85 | - $query = []; |
|
| 85 | + $query = []; |
|
| 86 | 86 | |
| 87 | - $response = Route4Me::makeRequst([ |
|
| 88 | - 'url' => $url_query, |
|
| 89 | - 'method' => 'GET', |
|
| 90 | - 'query' => $query, |
|
| 91 | - ]); |
|
| 87 | + $response = Route4Me::makeRequst([ |
|
| 88 | + 'url' => $url_query, |
|
| 89 | + 'method' => 'GET', |
|
| 90 | + 'query' => $query, |
|
| 91 | + ]); |
|
| 92 | 92 | |
| 93 | - return $response; |
|
| 94 | - } |
|
| 93 | + return $response; |
|
| 94 | + } |
|
| 95 | 95 | |
| 96 | - public static function getService($params) |
|
| 97 | - { |
|
| 98 | - Route4Me::setBaseUrl(Endpoint::STREET_DATA_SERVICE); |
|
| 96 | + public static function getService($params) |
|
| 97 | + { |
|
| 98 | + Route4Me::setBaseUrl(Endpoint::STREET_DATA_SERVICE); |
|
| 99 | 99 | |
| 100 | - $allPathFields = ['zipcode', 'housenumber', 'offset', 'limit']; |
|
| 100 | + $allPathFields = ['zipcode', 'housenumber', 'offset', 'limit']; |
|
| 101 | 101 | |
| 102 | - $url_query = Route4Me::generateUrlPath($allPathFields, $params); |
|
| 102 | + $url_query = Route4Me::generateUrlPath($allPathFields, $params); |
|
| 103 | 103 | |
| 104 | - $query = []; |
|
| 104 | + $query = []; |
|
| 105 | 105 | |
| 106 | - $response = Route4Me::makeRequst([ |
|
| 107 | - 'url' => $url_query, |
|
| 108 | - 'method' => 'GET', |
|
| 109 | - 'query' => $query, |
|
| 110 | - ]); |
|
| 106 | + $response = Route4Me::makeRequst([ |
|
| 107 | + 'url' => $url_query, |
|
| 108 | + 'method' => 'GET', |
|
| 109 | + 'query' => $query, |
|
| 110 | + ]); |
|
| 111 | 111 | |
| 112 | - return $response; |
|
| 113 | - } |
|
| 112 | + return $response; |
|
| 113 | + } |
|
| 114 | 114 | } |
@@ -11,27 +11,27 @@ |
||
| 11 | 11 | */ |
| 12 | 12 | class ScheduleMonthly extends Common |
| 13 | 13 | { |
| 14 | - /** |
|
| 15 | - * Repeat every month next 'Every' days. |
|
| 16 | - * @var integer |
|
| 17 | - */ |
|
| 18 | - public $every; |
|
| 14 | + /** |
|
| 15 | + * Repeat every month next 'Every' days. |
|
| 16 | + * @var integer |
|
| 17 | + */ |
|
| 18 | + public $every; |
|
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * Monthly schedule mode |
|
| 22 | - * @var string |
|
| 23 | - */ |
|
| 24 | - public $mode; |
|
| 20 | + /** |
|
| 21 | + * Monthly schedule mode |
|
| 22 | + * @var string |
|
| 23 | + */ |
|
| 24 | + public $mode; |
|
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * An array of month days for monthly schedule if the mode 'dates' was chosen. |
|
| 28 | - * @var integer[] |
|
| 29 | - */ |
|
| 30 | - public $dates = []; |
|
| 26 | + /** |
|
| 27 | + * An array of month days for monthly schedule if the mode 'dates' was chosen. |
|
| 28 | + * @var integer[] |
|
| 29 | + */ |
|
| 30 | + public $dates = []; |
|
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * Monthly schedule option if the mode 'nth' was chosen. |
|
| 34 | - * @var ScheduleMonthlyNth |
|
| 35 | - */ |
|
| 36 | - public $nth; |
|
| 32 | + /** |
|
| 33 | + * Monthly schedule option if the mode 'nth' was chosen. |
|
| 34 | + * @var ScheduleMonthlyNth |
|
| 35 | + */ |
|
| 36 | + public $nth; |
|
| 37 | 37 | } |
| 38 | 38 | \ No newline at end of file |
@@ -12,47 +12,47 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class Schedule extends Common |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * Gets or sets a value indicating whether this is enabled. |
|
| 17 | - * @var Boolean |
|
| 18 | - */ |
|
| 19 | - public $enabled; |
|
| 20 | - |
|
| 21 | - /** |
|
| 22 | - * When schedule will be started from. |
|
| 23 | - * @var string |
|
| 24 | - */ |
|
| 25 | - public $from; |
|
| 26 | - |
|
| 27 | - /** |
|
| 28 | - * Schedule mode<br> |
|
| 29 | - * Available values:<br> |
|
| 30 | - * daily, weekly, monthly, annually |
|
| 31 | - * @var string |
|
| 32 | - */ |
|
| 33 | - public $mode; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * If schedule mode is daily, specifies daily schedule data. |
|
| 37 | - * @var ScheduleDaily |
|
| 38 | - */ |
|
| 39 | - public $daily; |
|
| 40 | - |
|
| 41 | - /** |
|
| 42 | - * If schedule mode is weekly, specifies weekly schedule data. |
|
| 43 | - * @var ScheduleWeekly |
|
| 44 | - */ |
|
| 45 | - public $weekly; |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * If schedule mode is monthly, specifies monthly schedule data. |
|
| 49 | - * @var ScheduleMonthly |
|
| 50 | - */ |
|
| 51 | - public $monthly; |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * If schedule mode is annually, specifies annually schedule data. |
|
| 55 | - * @var ScheduleAnnually |
|
| 56 | - */ |
|
| 57 | - public $annually; |
|
| 15 | + /** |
|
| 16 | + * Gets or sets a value indicating whether this is enabled. |
|
| 17 | + * @var Boolean |
|
| 18 | + */ |
|
| 19 | + public $enabled; |
|
| 20 | + |
|
| 21 | + /** |
|
| 22 | + * When schedule will be started from. |
|
| 23 | + * @var string |
|
| 24 | + */ |
|
| 25 | + public $from; |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * Schedule mode<br> |
|
| 29 | + * Available values:<br> |
|
| 30 | + * daily, weekly, monthly, annually |
|
| 31 | + * @var string |
|
| 32 | + */ |
|
| 33 | + public $mode; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * If schedule mode is daily, specifies daily schedule data. |
|
| 37 | + * @var ScheduleDaily |
|
| 38 | + */ |
|
| 39 | + public $daily; |
|
| 40 | + |
|
| 41 | + /** |
|
| 42 | + * If schedule mode is weekly, specifies weekly schedule data. |
|
| 43 | + * @var ScheduleWeekly |
|
| 44 | + */ |
|
| 45 | + public $weekly; |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * If schedule mode is monthly, specifies monthly schedule data. |
|
| 49 | + * @var ScheduleMonthly |
|
| 50 | + */ |
|
| 51 | + public $monthly; |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * If schedule mode is annually, specifies annually schedule data. |
|
| 55 | + * @var ScheduleAnnually |
|
| 56 | + */ |
|
| 57 | + public $annually; |
|
| 58 | 58 | } |
| 59 | 59 | \ No newline at end of file |
@@ -12,27 +12,27 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class ScheduleAnnually extends Common |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * Repeat every year next 'Every' months. |
|
| 17 | - * @var integer |
|
| 18 | - */ |
|
| 19 | - public $every; |
|
| 15 | + /** |
|
| 16 | + * Repeat every year next 'Every' months. |
|
| 17 | + * @var integer |
|
| 18 | + */ |
|
| 19 | + public $every; |
|
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * If true, use NTH mode. |
|
| 23 | - * @var Boolean |
|
| 24 | - */ |
|
| 25 | - public $use_nth; |
|
| 21 | + /** |
|
| 22 | + * If true, use NTH mode. |
|
| 23 | + * @var Boolean |
|
| 24 | + */ |
|
| 25 | + public $use_nth; |
|
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * An array of the month numbers. |
|
| 29 | - * @var integer[] |
|
| 30 | - */ |
|
| 31 | - public $months; |
|
| 27 | + /** |
|
| 28 | + * An array of the month numbers. |
|
| 29 | + * @var integer[] |
|
| 30 | + */ |
|
| 31 | + public $months; |
|
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * Annualy schedule option if 'UseNth' is true. |
|
| 35 | - * @var ScheduleMonthlyNth |
|
| 36 | - */ |
|
| 37 | - public $nth; |
|
| 33 | + /** |
|
| 34 | + * Annualy schedule option if 'UseNth' is true. |
|
| 35 | + * @var ScheduleMonthlyNth |
|
| 36 | + */ |
|
| 37 | + public $nth; |
|
| 38 | 38 | } |
| 39 | 39 | \ No newline at end of file |
@@ -11,15 +11,15 @@ |
||
| 11 | 11 | */ |
| 12 | 12 | class ScheduleWeekly extends Common |
| 13 | 13 | { |
| 14 | - /** |
|
| 15 | - * Repeat every week next 'Every' days. |
|
| 16 | - * @var integer |
|
| 17 | - */ |
|
| 18 | - public $every; |
|
| 14 | + /** |
|
| 15 | + * Repeat every week next 'Every' days. |
|
| 16 | + * @var integer |
|
| 17 | + */ |
|
| 18 | + public $every; |
|
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * An array of the weekday numbers. |
|
| 22 | - * @var integer[] |
|
| 23 | - */ |
|
| 24 | - public $weekdays = []; |
|
| 20 | + /** |
|
| 21 | + * An array of the weekday numbers. |
|
| 22 | + * @var integer[] |
|
| 23 | + */ |
|
| 24 | + public $weekdays = []; |
|
| 25 | 25 | } |
@@ -11,17 +11,17 @@ |
||
| 11 | 11 | */ |
| 12 | 12 | class ScheduleMonthlyNth |
| 13 | 13 | { |
| 14 | - /** |
|
| 15 | - * Which day of the time period, 1: 1st, 2: 2nd, 3: 3rd, 4: 4th, 5: 5th, -1: Last |
|
| 16 | - * @var integer |
|
| 17 | - */ |
|
| 18 | - public $n; |
|
| 14 | + /** |
|
| 15 | + * Which day of the time period, 1: 1st, 2: 2nd, 3: 3rd, 4: 4th, 5: 5th, -1: Last |
|
| 16 | + * @var integer |
|
| 17 | + */ |
|
| 18 | + public $n; |
|
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * What time. Available values:<br> |
|
| 22 | - * 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday,<br> |
|
| 23 | - * 6: Saturday, 7: Sunday, 8: Day, 9: Working Day, 10: Weekend |
|
| 24 | - * @var integer |
|
| 25 | - */ |
|
| 26 | - public $what; |
|
| 20 | + /** |
|
| 21 | + * What time. Available values:<br> |
|
| 22 | + * 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday,<br> |
|
| 23 | + * 6: Saturday, 7: Sunday, 8: Day, 9: Working Day, 10: Weekend |
|
| 24 | + * @var integer |
|
| 25 | + */ |
|
| 26 | + public $what; |
|
| 27 | 27 | } |
| 28 | 28 | \ No newline at end of file |
@@ -11,9 +11,9 @@ |
||
| 11 | 11 | */ |
| 12 | 12 | class ScheduleDaily extends Common |
| 13 | 13 | { |
| 14 | - /** |
|
| 15 | - * Repeat every next 'Every' days |
|
| 16 | - * @var integer |
|
| 17 | - */ |
|
| 18 | - public $every; |
|
| 14 | + /** |
|
| 15 | + * Repeat every next 'Every' days |
|
| 16 | + * @var integer |
|
| 17 | + */ |
|
| 18 | + public $every; |
|
| 19 | 19 | } |
| 20 | 20 | \ No newline at end of file |