route4me / route4me-php-sdk

src/Route4Me/CustomNoteType.php

Indentation +24 added lines, -24 removed lines

@@ -9,32 +9,32 @@
  */
 class CustomNoteType extends Common
 {
-    /**
-     * Note custom entry ID
-     * @var integer
-     */
-    public $note_custom_entry_id;
+	/**
+	 * Note custom entry ID
+	 * @var integer
+	 */
+	public $note_custom_entry_id;
 
-    /**
-     * Note ID
-     * @var integer
-     */
-    public $note_id;
+	/**
+	 * Note ID
+	 * @var integer
+	 */
+	public $note_id;
 
-    /**
-     * Note custom type ID
-     * @var integer
-     */
-    public $note_custom_type_id;
+	/**
+	 * Note custom type ID
+	 * @var integer
+	 */
+	public $note_custom_type_id;
 
-    /**
-     * The value of a note custom type
-     * @var string
-     */
-    public $note_custom_value;
+	/**
+	 * The value of a note custom type
+	 * @var string
+	 */
+	public $note_custom_value;
 
-    /**
-     * Note custom type
-     */
-    public $note_custom_type;
+	/**
+	 * Note custom type
+	 */
+	public $note_custom_type;
 }

src/Route4Me/DirectionStep.php

Indentation +51 added lines, -51 removed lines

@@ -11,63 +11,63 @@
  */
 class DirectionStep extends Common
 {
-    /**
-     * Name (detailed)
-     * @var string
-     */
-    public $direction;
+	/**
+	 * Name (detailed)
+	 * @var string
+	 */
+	public $direction;
 
-    /**
-     * Name (brief)
-     * @var strng
-     */
-    public $directions;
+	/**
+	 * Name (brief)
+	 * @var strng
+	 */
+	public $directions;
 
-    /**
-     * Distance
-     * @var double
-     */
-    public $distance;
+	/**
+	 * Distance
+	 * @var double
+	 */
+	public $distance;
 
-    /**
-     * Distance unit
-     * @var string
-     */
-    public $distance_unit;
+	/**
+	 * Distance unit
+	 * @var string
+	 */
+	public $distance_unit;
 
-    /**
-     * Maneuver Type. Available values:
-     * - Head,Go Straight,Turn Left,Turn Right,Turn Slight Left,
-     * - Turn Slight Right,Turn Sharp Left,Turn Sharp Right,
-     * - Roundabout Left,Roundabout Right,Uturn Left,Uturn Right,
-     * - Ramp Left,Ramp Right,Fork Left,Fork Right,Keep Left,
-     * - Keep Right,Ferry,Ferry Train,Merge,Reached Your Destination.
-     * @var string
-     */
-    public $maneuverType;
+	/**
+	 * Maneuver Type. Available values:
+	 * - Head,Go Straight,Turn Left,Turn Right,Turn Slight Left,
+	 * - Turn Slight Right,Turn Sharp Left,Turn Sharp Right,
+	 * - Roundabout Left,Roundabout Right,Uturn Left,Uturn Right,
+	 * - Ramp Left,Ramp Right,Fork Left,Fork Right,Keep Left,
+	 * - Keep Right,Ferry,Ferry Train,Merge,Reached Your Destination.
+	 * @var string
+	 */
+	public $maneuverType;
 
-    /**
-     * Compass Direction. Available values:<br>
-     *  N, S, W, E, NW, NE, SW, SE
-     * @var string
-     */
-    public $compass_direction;
+	/**
+	 * Compass Direction. Available values:<br>
+	 *  N, S, W, E, NW, NE, SW, SE
+	 * @var string
+	 */
+	public $compass_direction;
 
-    /**
-     * UDU Distance (UDU: User Distance Unit).
-     * @var double
-     */
-    public $udu_distance;
+	/**
+	 * UDU Distance (UDU: User Distance Unit).
+	 * @var double
+	 */
+	public $udu_distance;
 
-    /**
-     * Direction step duration(seconds)
-     * @var integer
-     */
-    public $duration_sec;
+	/**
+	 * Direction step duration(seconds)
+	 * @var integer
+	 */
+	public $duration_sec;
 
-    /**
-     * Maneuver Point
-     * @var GeoPoint
-     */
-    public $maneuverPoint;
+	/**
+	 * Maneuver Point
+	 * @var GeoPoint
+	 */
+	public $maneuverPoint;
 }

src/Route4Me/GeoPoint.php

Indentation +10 added lines, -10 removed lines

@@ -11,15 +11,15 @@
  */
 class GeoPoint extends Common
 {
-    /**
-     * Latitude
-     * @var double
-     */
-    public $lat;
+	/**
+	 * Latitude
+	 * @var double
+	 */
+	public $lat;
 
-    /**
-     * Longitude
-     * @var double
-     */
-    public $lng;
+	/**
+	 * Longitude
+	 * @var double
+	 */
+	public $lng;
 }

src/Route4Me/Geocoding.php

Indentation +68 added lines, -68 removed lines

@@ -6,96 +6,96 @@
 
 class Geocoding extends Common
 {
-    public $strExportFormat;
-    public $format;
-    public $addresses;
-    public $pk;
-    public $offset;
-    public $limit;
-    public $housenumber;
-    public $zipcode;
+	public $strExportFormat;
+	public $format;
+	public $addresses;
+	public $pk;
+	public $offset;
+	public $limit;
+	public $housenumber;
+	public $zipcode;
 
-    public static function forwardGeocoding($params)
-    {
-        $allBodyFields = ['strExportFormat', 'addresses'];
+	public static function forwardGeocoding($params)
+	{
+		$allBodyFields = ['strExportFormat', 'addresses'];
 
-        $fgCoding = Route4Me::makeRequst([
-            'url'           => Endpoint::GEOCODER,
-            'method'        => 'POST',
-            'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data',
-        ]);
+		$fgCoding = Route4Me::makeRequst([
+			'url'           => Endpoint::GEOCODER,
+			'method'        => 'POST',
+			'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data',
+		]);
 
-        return $fgCoding;
-    }
+		return $fgCoding;
+	}
 
-    public static function reverseGeocoding($params)
-    {
-        $allQueryFields = ['format', 'addresses', 'detailed'];
+	public static function reverseGeocoding($params)
+	{
+		$allQueryFields = ['format', 'addresses', 'detailed'];
 
-        $fgcoding = Route4Me::makeRequst([
-            'url'       => Endpoint::GEOCODER,
-            'method'    => 'POST',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
+		$fgcoding = Route4Me::makeRequst([
+			'url'       => Endpoint::GEOCODER,
+			'method'    => 'POST',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
 
-        return $fgcoding;
-    }
+		return $fgcoding;
+	}
 
-    public static function getStreetData($params)
-    {
-        Route4Me::setBaseUrl(Endpoint::STREET_DATA);
+	public static function getStreetData($params)
+	{
+		Route4Me::setBaseUrl(Endpoint::STREET_DATA);
 
-        $allPathFields = ['pk', 'offset', 'limit'];
+		$allPathFields = ['pk', 'offset', 'limit'];
 
-        $url_query = Route4Me::generateUrlPath($allPathFields, $params);
+		$url_query = Route4Me::generateUrlPath($allPathFields, $params);
 
-        $query = [];
+		$query = [];
 
-        $response = Route4Me::makeRequst([
-            'url'       => $url_query,
-            'method'    => 'GET',
-            'query'     => $query,
-        ]);
+		$response = Route4Me::makeRequst([
+			'url'       => $url_query,
+			'method'    => 'GET',
+			'query'     => $query,
+		]);
 
-        return $response;
-    }
+		return $response;
+	}
 
-    public static function getZipCode($params)
-    {
-        Route4Me::setBaseUrl(Endpoint::STREET_DATA_ZIPCODE);
+	public static function getZipCode($params)
+	{
+		Route4Me::setBaseUrl(Endpoint::STREET_DATA_ZIPCODE);
 
-        $allPathFields = ['zipcode', 'offset', 'limit'];
+		$allPathFields = ['zipcode', 'offset', 'limit'];
 
-        $url_query = Route4Me::generateUrlPath($allPathFields, $params);
+		$url_query = Route4Me::generateUrlPath($allPathFields, $params);
 
-        $query = [];
+		$query = [];
 
-        $response = Route4Me::makeRequst([
-            'url'       => $url_query,
-            'method'    => 'GET',
-            'query'     => $query,
-        ]);
+		$response = Route4Me::makeRequst([
+			'url'       => $url_query,
+			'method'    => 'GET',
+			'query'     => $query,
+		]);
 
-        return $response;
-    }
+		return $response;
+	}
 
-    public static function getService($params)
-    {
-        Route4Me::setBaseUrl(Endpoint::STREET_DATA_SERVICE);
+	public static function getService($params)
+	{
+		Route4Me::setBaseUrl(Endpoint::STREET_DATA_SERVICE);
 
-        $allPathFields = ['zipcode', 'housenumber', 'offset', 'limit'];
+		$allPathFields = ['zipcode', 'housenumber', 'offset', 'limit'];
 
-        $url_query = Route4Me::generateUrlPath($allPathFields, $params);
+		$url_query = Route4Me::generateUrlPath($allPathFields, $params);
 
-        $query = [];
+		$query = [];
 
-        $response = Route4Me::makeRequst([
-            'url'       => $url_query,
-            'method'    => 'GET',
-            'query'     => $query,
-        ]);
+		$response = Route4Me::makeRequst([
+			'url'       => $url_query,
+			'method'    => 'GET',
+			'query'     => $query,
+		]);
 
-        return $response;
-    }
+		return $response;
+	}
 }

src/Route4Me/ScheduleCalendarParameters.php

Indentation +69 added lines, -69 removed lines

@@ -9,85 +9,85 @@
  */
 class ScheduleCalendarParameters extends Common
 {
-    /**
-     * Start date to filter the schedules in the string format<br>
-     * (e.g. 2020-10-27).
-     * @var string
-     */
-    public $date_from_string;
+	/**
+	 * Start date to filter the schedules in the string format<br>
+	 * (e.g. 2020-10-27).
+	 * @var string
+	 */
+	public $date_from_string;
 
-    /**
-     * End date to filter the schedules in the string format<br>
-     * (e.g. 2020-10-30).
-     * @var string
-     */
-    public $date_to_string;
+	/**
+	 * End date to filter the schedules in the string format<br>
+	 * (e.g. 2020-10-30).
+	 * @var string
+	 */
+	public $date_to_string;
 
-    /**
-     * Member ID
-     * @var integer
-     */
-    public $member_id;
+	/**
+	 * Member ID
+	 * @var integer
+	 */
+	public $member_id;
 
-    /**
-     * Timezone offset (in minutes)<br>
-     * (e.g. NYT: -4*60 = -480, Kiev: 3*60 = 180).
-     * @var integer
-     */
-    public $timezone_offset_minutes;
+	/**
+	 * Timezone offset (in minutes)<br>
+	 * (e.g. NYT: -4*60 = -480, Kiev: 3*60 = 180).
+	 * @var integer
+	 */
+	public $timezone_offset_minutes;
 
-    /**
-     * If true, the scheduled orders are included in the calendar.
-     * @var Boolean
-     */
-    public $orders;
+	/**
+	 * If true, the scheduled orders are included in the calendar.
+	 * @var Boolean
+	 */
+	public $orders;
 
-    /**
-     * If true, the scheduled address book contacts
-     * are included in the calendar.
-     * @var Boolean
-     */
-    public $ab;
+	/**
+	 * If true, the scheduled address book contacts
+	 * are included in the calendar.
+	 * @var Boolean
+	 */
+	public $ab;
 
-    /**
-     * If true, the scheduled routes are included in the calendar.
-     * @var Boolean
-     */
-    public $routes_count;
+	/**
+	 * If true, the scheduled routes are included in the calendar.
+	 * @var Boolean
+	 */
+	public $routes_count;
 
-    /**
-     * Class constructor.
-     * @var
-     */
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-    }
+	/**
+	 * Class constructor.
+	 * @var
+	 */
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	}
 
-    public function setTimezoneOffsetMinutes($tz)
-    {
-        $this->timezone_offset_minutes = -$tz;
-    }
+	public function setTimezoneOffsetMinutes($tz)
+	{
+		$this->timezone_offset_minutes = -$tz;
+	}
 
-    public function getTimezoneOffsetMinutes()
-    {
-        if (is_numeric($this->timezone_offset_minutes)) {
-            return -$this->timezone_offset_minutes;
-        } else {
-            return 0;
-        }
-    }
+	public function getTimezoneOffsetMinutes()
+	{
+		if (is_numeric($this->timezone_offset_minutes)) {
+			return -$this->timezone_offset_minutes;
+		} else {
+			return 0;
+		}
+	}
 
-    public function getScheduleCalendar($params)
-    {
-        $allQueryFields = ['date_from_string', 'date_to_string', 'member_id', 'timezone_offset_minutes', 'orders', 'ab', 'routes_count'];
+	public function getScheduleCalendar($params)
+	{
+		$allQueryFields = ['date_from_string', 'date_to_string', 'member_id', 'timezone_offset_minutes', 'orders', 'ab', 'routes_count'];
 
-        $schedCalendar = Route4Me::makeRequst([
-            'url'       => Endpoint::SCHEDULE_CALENDAR,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
+		$schedCalendar = Route4Me::makeRequst([
+			'url'       => Endpoint::SCHEDULE_CALENDAR,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
 
-        return $schedCalendar;
-    }
+		return $schedCalendar;
+	}
 }

src/Route4Me/RouteParameters.php

Indentation +516 added lines, -516 removed lines

@@ -11,520 +11,520 @@
  */
 class RouteParameters extends Common
 {
-    /**
-     * Let the R4M API know if this SDK request is comming
-     * from a file upload within your environment (for analytics).
-     * @var Boolean
-     */
-    public $is_upload;
-
-    /**
-     * The tour type of this route. rt is short for round trip,
-     * the optimization engine changes its behavior for round trip
-     * @var Boolean
-     */
-    public $rt;
-
-    /**
-     * The name of this route. this route name will be accessible in the search API,
-     * and also will be displayed on the mobile device of a user.
-     * @var string
-     */
-    public $route_name;
-
-    /**
-     * The route start date in UTC, unix timestamp seconds.
-     * Used to show users when the route will begin, also used for reporting and analytics.
-     * @var integer
-     */
-    public $route_date;
-
-    /**
-     * Offset in seconds relative to the route start date (i.e. 9AM would be 60 * 60 * 9)
-     * @var integer
-     */
-    public $route_time;
-
-    /**
-     * @deprecated 'Always false'
-     * @var string
-     */
-    public $shared_publicly;
-
-    /**
-     * By disabling optimization, the route optimization engine
-     * will not resequence the stops in your.
-     * @var disable_optimization
-     */
-    public $disable_optimization;
-
-    /**
-     * Gets or sets the optimize parameter.<br>
-     * Availabale values:
-     * - Distance,
-     * - Time,
-     * - timeWithTraffic
-     * @var string
-     */
-    public $optimize;
-
-    /**
-     * When the tour type is not round trip (rt = false),
-     * enable lock last so that the final destination is fixed.
-     * @var Boolean
-     */
-    public $lock_last;
-
-    /**
-     * Vehicle capacity.
-     * @var integer
-     */
-    public $vehicle_capacity;
-
-    /**
-     * Maximum distance for a single vehicle in the route (always in miles)
-     * @var integer
-     */
-    public $vehicle_max_distance_mi;
-
-    /**
-     * The distance measurement unit for the route.
-     * km or mi, the route4me api will convert all measurements into these units.
-     * @var string
-     */
-    public $distance_unit;
-
-    /**
-     * The mode of travel that the directions should be optimized for.<br>
-     *  Available values:
-     * - Driving
-     * - Walking
-     * @var string
-     */
-    public $travel_mode;
-
-    /**
-     * Options which let the user choose which road obstacles to avoid.<br>
-     * This has no impact on route sequencing.<br>
-     * Available values:
-     * - Highways
-     * - Tolls
-     * - minimizeHighways
-     * - minimizeTolls
-     * - highways,tolls
-     * - "".
-     * @var string
-     */
-    public $avoid;
-
-    /**
-     * The vehicle ID
-     * @var string
-     */
-    public $vehicle_id;
-
-    /**
-     * The latitude of the device making this sdk request.
-     * @var double
-     */
-    public $dev_lat;
-
-    /**
-     * The longitude of the device making this sdk request.
-     * @var double
-     */
-    public $dev_lng;
-
-    /**
-     * When using a multiple driver algorithm, this is the maximum permissible duration of a generated route.<br>
-     * The optimization system will automatically create more routes when the route_max_duration is exceeded for a route.<br>
-     * However it will create an 'unrouted' list of addresses if the maximum number of drivers is exceeded.
-     * @var long
-     */
-    public $route_max_duration;
-
-    /**
-     * The parameter specifies fine-tuning of an optimization process by route duration.
-     * @var double
-     */
-    public $target_duration;
-
-    /**
-     * The parameter specifies fine-tuning of an optimization process by route distance.
-     * @var double
-     */
-    public $target_distance;
-
-    /**
-     * The parameter specifies fine-tuning of an optimization process by waiting time.
-     * @var double
-     */
-    public $target_wait_by_tail_size;
-
-    /**
-     * The email address to notify upon completion of an optimization request.
-     * @var string
-     */
-    public $route_email;
-
-    /**
-     * @deprecated All routes are stored by default at this time
-     * @var
-     */
-    public $store_route = true;
-
-    /**
-     * Metric system
-     * @see Enum\Metric
-     * @var integer
-     */
-    public $metric;
-
-    /**
-     * The algorithm type to use when optimizing the route.
-     * @see Enum\AlgorithmType
-     * @var integer
-     */
-    public $algorithm_type;
-
-    /**
-     * The route owner's member ID.<br>
-     * In order for users in your organization to have routes assigned to them,
-     * you must provide their member ID within the Route4Me system.<br>
-     * A list of member IDs can be retrieved with view_users API method.
-     * @var integer
-     */
-    public $member_id;
-
-    /**
-     * Specify the ip address of the remote user making this optimization request.
-     * @var long
-     */
-    public $ip;
-
-    /**
-     * The method to use when compute the distance between the points in a route.<br>
-     * Available values: from 1 to 12.
-     * @var integer
-     */
-    public $dm;
-
-    /**
-     * Directions method.
-     * @var integer
-     */
-    public $dirm;
-
-    /**
-     * Legacy feature which permits a user to request an example number of optimized routes.
-     * @var integer
-     */
-    public $parts;
-
-    /**
-     * 32 Character MD5 String ID of the device that was used to plan this route.
-     * @deprecated Always null
-     * @var string
-     */
-    public $device_id;
-
-    /**
-     * The type of device making this request.
-     * @see Enum\DeviceType
-     * @var string
-     */
-    public $device_type;
-
-    /**
-     * If true, the vehicle has a trailer.<br>
-     * For routes that have trucking directions enabled, directions generated<br>
-     * will ensure compliance so that road directions generated do not take the vehicle
-     * where trailers are prohibited.
-     * @var Boolean
-     */
-    public $has_trailer;
-
-    /**
-     * The vehicle's trailer weight.<br>
-     * For routes that have trucking directions enabled, directions generated<br>
-     * will ensure compliance so that road directions generated do not take the vehicle<br>
-     * on roads where the weight of the vehicle in tons exceeds this value.
-     * @var double
-     */
-    public $trailer_weight_t;
-
-    /**
-     * If travel_mode is Trucking, specifies the truck weight.
-     * @var double
-     */
-    public $limited_weight_t;
-
-    /**
-     * The vehicle's weight per axle (tons)
-     * @var double
-     */
-    public $weight_per_axle_t;
-
-    /**
-     * Comma-delimited list of the truck hazardous goods.
-     * @var string
-     */
-    public $truck_hazardous_goods;
-
-    /**
-     * Truck axles number.
-     * @var integer
-     */
-    public $truck_axles;
-
-    /**
-     * Truck toll road usage. enum: ["YES", "NO"]
-     * @var string
-     */
-    public $truck_toll_road_usage;
-
-    /**
-     * Truck avoid ferries. enum: ["YES", "NO"]
-     * @var string
-     */
-    public $truck_avoid_ferries;
-
-    /**
-     * Truck highway only. enum: ["YES", "NO"]
-     * @var string
-     */
-    public $truck_hwy_only;
-
-    /**
-     * Truck of the type Long Combination Vehicle. enum: ["YES", "NO"]
-     * @var string
-     */
-    public $truck_lcv;
-
-    /**
-     * Avoid international borders. enum: ["YES", "NO"]
-     * @var string
-     */
-    public $truck_borders;
-
-    /**
-     * Truck side street adherence.<br>
-     *  enum: ["OFF", "MINIMAL","MODERATE","AVERAGE","STRICT","ADHERE","STRONGLYHERE"]
-     * @var string
-     */
-    public $truck_side_street_adherence;
-
-    /**
-     * Truck configuration.
-     * enum: ["NONE","PASSENGER","28_DOUBLETRAILER","48_STRAIGHT_TRUCK",
-     * "48_SEMI_TRAILER","53_SEMI_TRAILER","FULLSIZEVAN","26_STRAIGHT_TRUCK"]
-     * @var string
-     */
-    public $truck_config;
-
-    /**
-     * Truck dimension unit. enum: ["mi","km"]
-     * @var string
-     */
-    public $truck_dim_unit;
-
-    /**
-     * Truck type.
-     *  enum: ["suv","pickup_truck","van","18wheeler","cabin","waste_disposal",
-     * "tree_cutting","bigrig","cement_mixer","livestock_carrier","dairy", "tractor_trailer"]
-     * @var string
-     */
-    public $truck_type;
-
-    /**
-     * If travel_mode = 'Trucking', specifies the truck weight (required)
-     * @var double
-     */
-    public $truck_weight;
-
-    /**
-     * Maximum cargo weight a vehicle can cary.
-     * @var double
-     */
-    public $vehicle_max_cargo_weight;
-
-    /**
-     * Maximum cargo volume a vehicle can cary.
-     * @var double
-     */
-    public $vehicle_max_cargo_volume;
-
-    /**
-     * Maximum allowed revenue from a subtour.
-     * @var integer
-     */
-    public $subtour_max_revenue;
-
-    /**
-     * An array of the Avoidance zones IDs.
-     * @var string[]
-     */
-    public $avoidance_zones = [];
-
-    /**
-     * The vehicle ID, to be assigned to the route.
-     * @deprecated All new routes should be assigned to a member_id
-     * @var string
-     */
-    public $driver_id;
-
-    /**
-     * Minimum number of optimized routes.
-     * @var integer
-     */
-    public $parts_min;
-
-    /**
-     * If true, the vehicle will first drive then wait between stops.
-     * @var Boolean
-     */
-    public $first_drive_then_wait_between_stops;
-
-    /**
-     * The truck height.<br>
-     * For routes that have trucking directions enabled, directions generated<br>
-     * will ensure compliance of this maximum height of truck when generating
-     * road network driving directions.
-     * @var double
-     */
-    public $truck_height;
-
-    /**
-     * The truck width.<br>
-     * For routes that have trucking directions enabled, directions generated
-     * will ensure compliance of this width of the truck when generating road network
-     * driving directions.
-     * @var double
-     */
-    public $truck_width;
-
-    /**
-     * The truck length.<br>
-     * For routes that have trucking directions enabled, directions generated
-     * will ensure compliance of this length of the truck when generating
-     * road network driving directions.
-     * @var double
-     */
-    public $truck_length;
-
-    /**
-     * The optimization quality.<br>
-     * Available values:
-     * - 1 - Generate Optimized Routes As Quickly as Possible;
-     * - 2 - Generate Routes That Look Better On A Map;
-     * - 3 - Generate The Shortest And Quickest Possible Routes.
-     * @var integer
-     */
-    public $optimization_quality;
-
-    /**
-     * The maximum number of stops permitted per created subroute.
-     * @var integer
-     */
-    public $max_tour_size;
-
-    /**
-     * The minimum number of stops permitted per created subroute.
-     * @var integer
-     */
-    public $min_tour_size;
-
-    /**
-     * If equal to 1, uturn is allowed for the vehicle.
-     * @var integer
-     */
-    public $uturn;
-
-    /**
-     * If equal to 1, leftturn is allowed for the vehicle.
-     * @var integer
-     */
-    public $leftturn;
-
-    /**
-     * If equal to 1, rightturn is allowed for the vehicle.
-     * @var integer
-     */
-    public $rightturn;
-
-    /**
-     * Route travel time slowdown (e.g. 25 (means 25% slowdown)).
-     * @note the parameter is read-only and it can be set
-     * with the parameter Slowdowns.TravelTime.
-     * @var integer
-     */
-    public $route_time_multiplier;
-
-    /**
-     * Route service time slowdown (e.g. 10 (means 10% slowdown)).
-     * @note the parameter is read-only and it can be set
-     * with the parameter Slowdowns.TravelTime.
-     * @var integer
-     */
-    public $route_service_time_multiplier;
-
-    /**
-     * Optimization engine (e.g. '1','2' etc)
-     * @var string
-     */
-    public $optimization_engine;
-
-    /**
-     * Override addresses
-     * @var OverrideAddresses
-     */
-    public $override_addresses;
-
-    /**
-     * Address bundling rules
-     * @var V5\Addresses\AddressBundling
-     */
-    public $bundling;
-
-    /**
-     * Advanced route constraints
-     * @var RouteAdvancedConstraints
-     */
-    public $advanced_constraints = [];
-
-    /**
-     * If true, the time windows ignored.
-     * @var Boolean
-     */
-    public $ignore_tw;
-
-    /**
-     * If true, the start time is dynamic.
-     * @var Boolean
-     */
-    public $is_dynamic_start_time;
-
-    /**
-     * @deprecated The parameter 'route_type' isn't included in route parameters.
-     * @var string
-     */
-    public $route_type;
-
-    /**
-     * Slowdown of the optimization parameters.
-     * @note This is only query parameter.
-     * @note This parameter is used in the optimization creation/generation process.
-     * @var SlowdownParams
-     */
-    public $slowdowns;
-
-    public function setAddressBundle($addressBundle)
-    {
-        $this->bundling = $addressBundle;
-    }
-
-    public function getAddressBundle()
-    {
-        return $this->bundling;
-    }
+	/**
+	 * Let the R4M API know if this SDK request is comming
+	 * from a file upload within your environment (for analytics).
+	 * @var Boolean
+	 */
+	public $is_upload;
+
+	/**
+	 * The tour type of this route. rt is short for round trip,
+	 * the optimization engine changes its behavior for round trip
+	 * @var Boolean
+	 */
+	public $rt;
+
+	/**
+	 * The name of this route. this route name will be accessible in the search API,
+	 * and also will be displayed on the mobile device of a user.
+	 * @var string
+	 */
+	public $route_name;
+
+	/**
+	 * The route start date in UTC, unix timestamp seconds.
+	 * Used to show users when the route will begin, also used for reporting and analytics.
+	 * @var integer
+	 */
+	public $route_date;
+
+	/**
+	 * Offset in seconds relative to the route start date (i.e. 9AM would be 60 * 60 * 9)
+	 * @var integer
+	 */
+	public $route_time;
+
+	/**
+	 * @deprecated 'Always false'
+	 * @var string
+	 */
+	public $shared_publicly;
+
+	/**
+	 * By disabling optimization, the route optimization engine
+	 * will not resequence the stops in your.
+	 * @var disable_optimization
+	 */
+	public $disable_optimization;
+
+	/**
+	 * Gets or sets the optimize parameter.<br>
+	 * Availabale values:
+	 * - Distance,
+	 * - Time,
+	 * - timeWithTraffic
+	 * @var string
+	 */
+	public $optimize;
+
+	/**
+	 * When the tour type is not round trip (rt = false),
+	 * enable lock last so that the final destination is fixed.
+	 * @var Boolean
+	 */
+	public $lock_last;
+
+	/**
+	 * Vehicle capacity.
+	 * @var integer
+	 */
+	public $vehicle_capacity;
+
+	/**
+	 * Maximum distance for a single vehicle in the route (always in miles)
+	 * @var integer
+	 */
+	public $vehicle_max_distance_mi;
+
+	/**
+	 * The distance measurement unit for the route.
+	 * km or mi, the route4me api will convert all measurements into these units.
+	 * @var string
+	 */
+	public $distance_unit;
+
+	/**
+	 * The mode of travel that the directions should be optimized for.<br>
+	 *  Available values:
+	 * - Driving
+	 * - Walking
+	 * @var string
+	 */
+	public $travel_mode;
+
+	/**
+	 * Options which let the user choose which road obstacles to avoid.<br>
+	 * This has no impact on route sequencing.<br>
+	 * Available values:
+	 * - Highways
+	 * - Tolls
+	 * - minimizeHighways
+	 * - minimizeTolls
+	 * - highways,tolls
+	 * - "".
+	 * @var string
+	 */
+	public $avoid;
+
+	/**
+	 * The vehicle ID
+	 * @var string
+	 */
+	public $vehicle_id;
+
+	/**
+	 * The latitude of the device making this sdk request.
+	 * @var double
+	 */
+	public $dev_lat;
+
+	/**
+	 * The longitude of the device making this sdk request.
+	 * @var double
+	 */
+	public $dev_lng;
+
+	/**
+	 * When using a multiple driver algorithm, this is the maximum permissible duration of a generated route.<br>
+	 * The optimization system will automatically create more routes when the route_max_duration is exceeded for a route.<br>
+	 * However it will create an 'unrouted' list of addresses if the maximum number of drivers is exceeded.
+	 * @var long
+	 */
+	public $route_max_duration;
+
+	/**
+	 * The parameter specifies fine-tuning of an optimization process by route duration.
+	 * @var double
+	 */
+	public $target_duration;
+
+	/**
+	 * The parameter specifies fine-tuning of an optimization process by route distance.
+	 * @var double
+	 */
+	public $target_distance;
+
+	/**
+	 * The parameter specifies fine-tuning of an optimization process by waiting time.
+	 * @var double
+	 */
+	public $target_wait_by_tail_size;
+
+	/**
+	 * The email address to notify upon completion of an optimization request.
+	 * @var string
+	 */
+	public $route_email;
+
+	/**
+	 * @deprecated All routes are stored by default at this time
+	 * @var
+	 */
+	public $store_route = true;
+
+	/**
+	 * Metric system
+	 * @see Enum\Metric
+	 * @var integer
+	 */
+	public $metric;
+
+	/**
+	 * The algorithm type to use when optimizing the route.
+	 * @see Enum\AlgorithmType
+	 * @var integer
+	 */
+	public $algorithm_type;
+
+	/**
+	 * The route owner's member ID.<br>
+	 * In order for users in your organization to have routes assigned to them,
+	 * you must provide their member ID within the Route4Me system.<br>
+	 * A list of member IDs can be retrieved with view_users API method.
+	 * @var integer
+	 */
+	public $member_id;
+
+	/**
+	 * Specify the ip address of the remote user making this optimization request.
+	 * @var long
+	 */
+	public $ip;
+
+	/**
+	 * The method to use when compute the distance between the points in a route.<br>
+	 * Available values: from 1 to 12.
+	 * @var integer
+	 */
+	public $dm;
+
+	/**
+	 * Directions method.
+	 * @var integer
+	 */
+	public $dirm;
+
+	/**
+	 * Legacy feature which permits a user to request an example number of optimized routes.
+	 * @var integer
+	 */
+	public $parts;
+
+	/**
+	 * 32 Character MD5 String ID of the device that was used to plan this route.
+	 * @deprecated Always null
+	 * @var string
+	 */
+	public $device_id;
+
+	/**
+	 * The type of device making this request.
+	 * @see Enum\DeviceType
+	 * @var string
+	 */
+	public $device_type;
+
+	/**
+	 * If true, the vehicle has a trailer.<br>
+	 * For routes that have trucking directions enabled, directions generated<br>
+	 * will ensure compliance so that road directions generated do not take the vehicle
+	 * where trailers are prohibited.
+	 * @var Boolean
+	 */
+	public $has_trailer;
+
+	/**
+	 * The vehicle's trailer weight.<br>
+	 * For routes that have trucking directions enabled, directions generated<br>
+	 * will ensure compliance so that road directions generated do not take the vehicle<br>
+	 * on roads where the weight of the vehicle in tons exceeds this value.
+	 * @var double
+	 */
+	public $trailer_weight_t;
+
+	/**
+	 * If travel_mode is Trucking, specifies the truck weight.
+	 * @var double
+	 */
+	public $limited_weight_t;
+
+	/**
+	 * The vehicle's weight per axle (tons)
+	 * @var double
+	 */
+	public $weight_per_axle_t;
+
+	/**
+	 * Comma-delimited list of the truck hazardous goods.
+	 * @var string
+	 */
+	public $truck_hazardous_goods;
+
+	/**
+	 * Truck axles number.
+	 * @var integer
+	 */
+	public $truck_axles;
+
+	/**
+	 * Truck toll road usage. enum: ["YES", "NO"]
+	 * @var string
+	 */
+	public $truck_toll_road_usage;
+
+	/**
+	 * Truck avoid ferries. enum: ["YES", "NO"]
+	 * @var string
+	 */
+	public $truck_avoid_ferries;
+
+	/**
+	 * Truck highway only. enum: ["YES", "NO"]
+	 * @var string
+	 */
+	public $truck_hwy_only;
+
+	/**
+	 * Truck of the type Long Combination Vehicle. enum: ["YES", "NO"]
+	 * @var string
+	 */
+	public $truck_lcv;
+
+	/**
+	 * Avoid international borders. enum: ["YES", "NO"]
+	 * @var string
+	 */
+	public $truck_borders;
+
+	/**
+	 * Truck side street adherence.<br>
+	 *  enum: ["OFF", "MINIMAL","MODERATE","AVERAGE","STRICT","ADHERE","STRONGLYHERE"]
+	 * @var string
+	 */
+	public $truck_side_street_adherence;
+
+	/**
+	 * Truck configuration.
+	 * enum: ["NONE","PASSENGER","28_DOUBLETRAILER","48_STRAIGHT_TRUCK",
+	 * "48_SEMI_TRAILER","53_SEMI_TRAILER","FULLSIZEVAN","26_STRAIGHT_TRUCK"]
+	 * @var string
+	 */
+	public $truck_config;
+
+	/**
+	 * Truck dimension unit. enum: ["mi","km"]
+	 * @var string
+	 */
+	public $truck_dim_unit;
+
+	/**
+	 * Truck type.
+	 *  enum: ["suv","pickup_truck","van","18wheeler","cabin","waste_disposal",
+	 * "tree_cutting","bigrig","cement_mixer","livestock_carrier","dairy", "tractor_trailer"]
+	 * @var string
+	 */
+	public $truck_type;
+
+	/**
+	 * If travel_mode = 'Trucking', specifies the truck weight (required)
+	 * @var double
+	 */
+	public $truck_weight;
+
+	/**
+	 * Maximum cargo weight a vehicle can cary.
+	 * @var double
+	 */
+	public $vehicle_max_cargo_weight;
+
+	/**
+	 * Maximum cargo volume a vehicle can cary.
+	 * @var double
+	 */
+	public $vehicle_max_cargo_volume;
+
+	/**
+	 * Maximum allowed revenue from a subtour.
+	 * @var integer
+	 */
+	public $subtour_max_revenue;
+
+	/**
+	 * An array of the Avoidance zones IDs.
+	 * @var string[]
+	 */
+	public $avoidance_zones = [];
+
+	/**
+	 * The vehicle ID, to be assigned to the route.
+	 * @deprecated All new routes should be assigned to a member_id
+	 * @var string
+	 */
+	public $driver_id;
+
+	/**
+	 * Minimum number of optimized routes.
+	 * @var integer
+	 */
+	public $parts_min;
+
+	/**
+	 * If true, the vehicle will first drive then wait between stops.
+	 * @var Boolean
+	 */
+	public $first_drive_then_wait_between_stops;
+
+	/**
+	 * The truck height.<br>
+	 * For routes that have trucking directions enabled, directions generated<br>
+	 * will ensure compliance of this maximum height of truck when generating
+	 * road network driving directions.
+	 * @var double
+	 */
+	public $truck_height;
+
+	/**
+	 * The truck width.<br>
+	 * For routes that have trucking directions enabled, directions generated
+	 * will ensure compliance of this width of the truck when generating road network
+	 * driving directions.
+	 * @var double
+	 */
+	public $truck_width;
+
+	/**
+	 * The truck length.<br>
+	 * For routes that have trucking directions enabled, directions generated
+	 * will ensure compliance of this length of the truck when generating
+	 * road network driving directions.
+	 * @var double
+	 */
+	public $truck_length;
+
+	/**
+	 * The optimization quality.<br>
+	 * Available values:
+	 * - 1 - Generate Optimized Routes As Quickly as Possible;
+	 * - 2 - Generate Routes That Look Better On A Map;
+	 * - 3 - Generate The Shortest And Quickest Possible Routes.
+	 * @var integer
+	 */
+	public $optimization_quality;
+
+	/**
+	 * The maximum number of stops permitted per created subroute.
+	 * @var integer
+	 */
+	public $max_tour_size;
+
+	/**
+	 * The minimum number of stops permitted per created subroute.
+	 * @var integer
+	 */
+	public $min_tour_size;
+
+	/**
+	 * If equal to 1, uturn is allowed for the vehicle.
+	 * @var integer
+	 */
+	public $uturn;
+
+	/**
+	 * If equal to 1, leftturn is allowed for the vehicle.
+	 * @var integer
+	 */
+	public $leftturn;
+
+	/**
+	 * If equal to 1, rightturn is allowed for the vehicle.
+	 * @var integer
+	 */
+	public $rightturn;
+
+	/**
+	 * Route travel time slowdown (e.g. 25 (means 25% slowdown)).
+	 * @note the parameter is read-only and it can be set
+	 * with the parameter Slowdowns.TravelTime.
+	 * @var integer
+	 */
+	public $route_time_multiplier;
+
+	/**
+	 * Route service time slowdown (e.g. 10 (means 10% slowdown)).
+	 * @note the parameter is read-only and it can be set
+	 * with the parameter Slowdowns.TravelTime.
+	 * @var integer
+	 */
+	public $route_service_time_multiplier;
+
+	/**
+	 * Optimization engine (e.g. '1','2' etc)
+	 * @var string
+	 */
+	public $optimization_engine;
+
+	/**
+	 * Override addresses
+	 * @var OverrideAddresses
+	 */
+	public $override_addresses;
+
+	/**
+	 * Address bundling rules
+	 * @var V5\Addresses\AddressBundling
+	 */
+	public $bundling;
+
+	/**
+	 * Advanced route constraints
+	 * @var RouteAdvancedConstraints
+	 */
+	public $advanced_constraints = [];
+
+	/**
+	 * If true, the time windows ignored.
+	 * @var Boolean
+	 */
+	public $ignore_tw;
+
+	/**
+	 * If true, the start time is dynamic.
+	 * @var Boolean
+	 */
+	public $is_dynamic_start_time;
+
+	/**
+	 * @deprecated The parameter 'route_type' isn't included in route parameters.
+	 * @var string
+	 */
+	public $route_type;
+
+	/**
+	 * Slowdown of the optimization parameters.
+	 * @note This is only query parameter.
+	 * @note This parameter is used in the optimization creation/generation process.
+	 * @var SlowdownParams
+	 */
+	public $slowdowns;
+
+	public function setAddressBundle($addressBundle)
+	{
+		$this->bundling = $addressBundle;
+	}
+
+	public function getAddressBundle()
+	{
+		return $this->bundling;
+	}
 }

src/Route4Me/AvoidanceZone.php

Indentation +103 added lines, -103 removed lines

@@ -7,107 +7,107 @@
 
 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');
-        }
-        return parent::fromArray($params);
-    }
-
-    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');
+		}
+		return parent::fromArray($params);
+	}
+
+	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/TelematicsVendor.php

Indentation +56 added lines, -56 removed lines

@@ -6,62 +6,62 @@
 
 class TelematicsVendor extends Common
 {
-    public $id; // Telematics Vendor id
-    public $name; // Vendor name
-    public $slug; // Vendor slug
-    public $description; // Vendor description
-    public $logo_url; // Vendor's logo URL
-    public $website_url; // Vendor's website URL
-    public $api_docs_url; // API documentation URL
-    public $is_integrated; // If 1, the vendor is integrated in Route4Me
-    public $size; // Vendor size
-    public $page; // starting page
-    public $per_page; // Vendors per page in a response
-    public $countries = []; // Country Alpha 2 code
-    public $features = []; // Vendor's feature
-    public $search; // Searched text
-    public $vendors; // Comma-delimited list of the vendors IDs.
-
-    public static function GetTelematicsVendors($params)
-    {
-        Route4Me::setBaseUrl(Endpoint::TELEMATICS_VENDORS);
-
-        $allQueryFields = ['vendor_id', 'is_integrated', 'page', 'per_page', 'country', 'feature', 'search', 'vendors'];
-
-        $vendors = Route4Me::makeRequst([
-            'url'       => '',
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $vendors;
-    }
-
-    public static function GetRandomVendorID($offset, $limit)
-    {
-        $allVendors = self::GetTelematicsVendors(null);
-        $vendorsNumber = sizeof($allVendors['vendors']);
-
-        if ($vendorsNumber < $limit) {
-            if ($vendorsNumber > $offset) {
-                $limit = $vendorsNumber;
-            } else {
-                if ($vendorsNumber == $offset) {
-                    return $allVendors['vendors'][$offset]->{'vendor_id'};
-                } else {
-                    echo 'The vendors numbers are less than offset';
-
-                    return null;
-                }
-            }
-        }
-
-        $randNumber = rand($offset, $limit);
-
-        return $allVendors['vendors'][$randNumber]['id'];
-    }
-
-    /*
+	public $id; // Telematics Vendor id
+	public $name; // Vendor name
+	public $slug; // Vendor slug
+	public $description; // Vendor description
+	public $logo_url; // Vendor's logo URL
+	public $website_url; // Vendor's website URL
+	public $api_docs_url; // API documentation URL
+	public $is_integrated; // If 1, the vendor is integrated in Route4Me
+	public $size; // Vendor size
+	public $page; // starting page
+	public $per_page; // Vendors per page in a response
+	public $countries = []; // Country Alpha 2 code
+	public $features = []; // Vendor's feature
+	public $search; // Searched text
+	public $vendors; // Comma-delimited list of the vendors IDs.
+
+	public static function GetTelematicsVendors($params)
+	{
+		Route4Me::setBaseUrl(Endpoint::TELEMATICS_VENDORS);
+
+		$allQueryFields = ['vendor_id', 'is_integrated', 'page', 'per_page', 'country', 'feature', 'search', 'vendors'];
+
+		$vendors = Route4Me::makeRequst([
+			'url'       => '',
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $vendors;
+	}
+
+	public static function GetRandomVendorID($offset, $limit)
+	{
+		$allVendors = self::GetTelematicsVendors(null);
+		$vendorsNumber = sizeof($allVendors['vendors']);
+
+		if ($vendorsNumber < $limit) {
+			if ($vendorsNumber > $offset) {
+				$limit = $vendorsNumber;
+			} else {
+				if ($vendorsNumber == $offset) {
+					return $allVendors['vendors'][$offset]->{'vendor_id'};
+				} else {
+					echo 'The vendors numbers are less than offset';
+
+					return null;
+				}
+			}
+		}
+
+		$randNumber = rand($offset, $limit);
+
+		return $allVendors['vendors'][$randNumber]['id'];
+	}
+
+	/*
     public static function GetTelematicsVendor($params) {
         Route4Me::setBaseUrl(Endpoint::TELEMATICS_VENDORS);
 

UnitTestFiles/Test/AddressBookGroupUnitTests.php

Indentation +272 added lines, -272 removed lines

@@ -9,276 +9,276 @@
 
 class AddressBookGroupUnitTests extends \PHPUnit\Framework\TestCase
 {
-    public static $createdGroups = [];
-
-    public static function setUpBeforeClass()
-    {
-        Route4Me::setApiKey(Constants::API_KEY);
-
-        $abg = new AddressBookGroup();
-
-        $createParameters= [
-            'group_name'    => 'All Group',
-            'group_color'   => '92e1c0',
-            'filter'        => [
-                'condition' => 'AND',
-                'rules'     => [[
-                    'id'       => 'address_1',
-                    'field'    => 'address_1',
-                    'operator' => 'not_equal',
-                    'value'    => 'qwerty123456'
-                ]]
-            ]
-        ];
-
-        $createdAddressBookGroup = AddressBookGroup::fromArray(
-            $abg->createAddressBookGroup($createParameters)
-        );
-
-        self::$createdGroups[] = $createdAddressBookGroup;
-
-        $createParameters= [
-            'group_name'    => 'All Group',
-            'group_color'   => '92e1c0',
-            'filter'        => [
-                'condition' => 'AND',
-                'rules'     => [[
-                    'id'       => 'address_1',
-                    'field'    => 'address_1',
-                    'operator' => 'not_equal',
-                    'value'    => 'qwerty123456'
-                ]]
-            ]
-        ];
-
-        $createdAddressBookGroup = AddressBookGroup::fromArray(
-            $abg->createAddressBookGroup($createParameters)
-        );
-
-        self::$createdGroups[] = $createdAddressBookGroup;
-    }
-
-    public function testFromArray()
-    {
-        $addressBookGroup = AddressBookGroup::fromArray([
-            'group_id'      => '137F9F99544DB34C160B2B9AF8FC6A12',
-            'group_name'    => 'Ocassion example',
-            'group_color'   => '92e1c0',
-            'group_icon'    => 'emoji-pushpin',
-            'member_id'     => 444333,
-            'filter' => [
-              'condition'   => 'AND',
-              'rules'       => [
-                [
-                  'id'          => 'custom_data.occasion',
-                  'field'       => 'custom_data.occasion',
-                  'operator'    => 'equal',
-                  'value'       => '100'
-                ]]
-            ]
-        ]);
-
-        $this->assertEquals('137F9F99544DB34C160B2B9AF8FC6A12', $addressBookGroup->group_id);
-        $this->assertEquals('Ocassion example', $addressBookGroup->group_name);
-        $this->assertEquals('92e1c0', $addressBookGroup->group_color);
-        $this->assertEquals('emoji-pushpin', $addressBookGroup->group_icon);
-        $this->assertEquals(444333, $addressBookGroup->member_id);
-        $this->assertEquals([
-            'condition'   => 'AND',
-            'rules'       => [
-                [
-                    'id'          => 'custom_data.occasion',
-                    'field'       => 'custom_data.occasion',
-                    'operator'    => 'equal',
-                    'value'       => '100'
-                ]]
-        ], $addressBookGroup->filter);
-    }
-
-    public function testGetAddressBookGroup()
-    {
-        $groupId = self::$createdGroups[0]->group_id;
-
-        $abg = new AddressBookGroup();
-
-        $result = AddressBookGroup::fromArray(
-            $abg->getAddressBookGroup(['group_id' => $groupId])
-        );
-
-        $this->assertNotNull($result);
-        $this->assertContainsOnlyInstancesOf(AddressBookGroup::class, [$result]);
-    }
-
-    public function testUpdateAddressBookGroup()
-    {
-        $groupId = self::$createdGroups[0]->group_id;
-
-        $updateParameters= [
-            'group_id'      => $groupId,
-            'group_color'   => '7bd148'
-        ];
-
-        $result = AddressBookGroup::fromArray(
-            AddressBookGroup::updateAddressBookGroup($updateParameters)
-        );
-
-        $this->assertNotNull($result);
-        $this->assertContainsOnlyInstancesOf(AddressBookGroup::class, [$result]);
-        $this->assertEquals('7bd148', $result->group_color);
-    }
-
-    public function testRemoveAddressBookGroup()
-    {
-        $groupId = end(self::$createdGroups)->group_id;
-
-        $removeParameters= [
-            'group_id' => $groupId
-        ];
-
-        $result = AddressBookGroup::removeAddressBookGroup($removeParameters);
-
-        $this->assertNotNull($result);
-        $this->assertTrue(isset($result['status']));
-        $this->assertTrue($result['status']);
-
-        self::$createdGroups[] = array_pop(self::$createdGroups);
-    }
-
-    public function testCreateAddressBookGroup()
-    {
-        $createParameters= [
-            'group_name'    => 'All Group',
-            'group_color'   => '92e2cd',
-            'filter'        => [
-                'condition' => 'AND',
-                'rules'     => [[
-                    'id'       => 'address_1',
-                    'field'    => 'address_1',
-                    'operator' => 'not_equal',
-                    'value'    => 'qwerty654321'
-                ]]
-            ]
-        ];
-
-        $createdAddressBookGroup = AddressBookGroup::fromArray(
-            AddressBookGroup::createAddressBookGroup($createParameters)
-        );
-
-        $this->assertNotNull($createdAddressBookGroup);
-        $this->assertContainsOnlyInstancesOf(AddressBookGroup::class, [$createdAddressBookGroup]);
-        $this->assertEquals('92e2cd', $createdAddressBookGroup->group_color);
-
-        self::$createdGroups[] = $createdAddressBookGroup;
-    }
-
-    public function testSearchAddressBookGroups()
-    {
-        $searchParameters = [
-            'fields' => ['address_id', 'address_1', 'address_group'],
-            'limit' => 10,
-            'offset' => 0,
-            'filter' => [
-                'query' => "Louisville",
-                "display" => "all"
-            ]
-        ];
-
-        $addressBookGroups = SearchResponse::fromArray(
-            AddressBookGroup::searchAddressBookGroups($searchParameters)
-        );
-
-        $this->assertNotNull($addressBookGroups);
-        $this->assertTrue(sizeof($addressBookGroups->fields)==3);
-        $this->assertContains('address_id', $addressBookGroups->fields);
-        $this->assertContains('address_1', $addressBookGroups->fields);
-        $this->assertContains('address_group', $addressBookGroups->fields);
-
-        $this->assertNotNull($addressBookGroups->results);
-
-        if (sizeof($addressBookGroups->results)>0) {
-            $this->assertContains('Louisville', implode(", ", $addressBookGroups->results[0]));
-        }
-    }
-
-    public function testGetAddressBookContactsByGroup()
-    {
-        //$this->markTestSkipped('must be revisited.');
-
-        $groupId = self::$createdGroups[0]->group_id;
-
-        $searchParameters = [
-            'fields'    => ['address_id'],
-            'group_id'  => $groupId,
-        ];
-
-        $result = AddressBookGroup::getAddressBookContactsByGroup($searchParameters);
-
-        $this->assertNotNull($result);
-        $this->assertTrue(isset($result['total']));
-        $this->assertTrue(isset($result['results']));
-        $this->assertTrue(is_array($result['results']));
-    }
-
-    public function testGetAddressBookGroups()
-    {
-        $addressBookGroupParameters = [
-            'limit'  => 20,
-            'offset' => 0,
-        ];
-
-        $addressBookGroups = AddressBookGroup::getAddressBookGroups($addressBookGroupParameters);
-
-        $this->assertNotNull($addressBookGroups);
-
-        $firstGroup = AddressBookGroup::fromArray(
-            $addressBookGroups[0]
-        );
-
-        $this->assertTrue(sizeof($addressBookGroups)>0);
-        $this->assertContainsOnlyInstancesOf(AddressBookGroup::class, [$firstGroup]);
-    }
-
-    public function testgGetRandomAddressBookGroup()
-    {
-        $addressBookGroupParameters = [
-            'limit'  => 20,
-            'offset' => 0,
-        ];
-
-        $randomGroup = AddressBookGroup::fromArray(
-            AddressBookGroup::getRandomAddressBookGroup($addressBookGroupParameters)
-        );
-
-        $this->assertNotNull($randomGroup);
-        $this->assertContainsOnlyInstancesOf(AddressBookGroup::class, [$randomGroup]);
-    }
-
-    public function testGetAddressBookGroupIdByName()
-    {
-        $firstGroup = self::$createdGroups[0];
-
-        $groupIds = AddressBookGroup::getAddressBookGroupIdByName($firstGroup->group_name);
-
-        $this->assertNotNull($groupIds);
-        $this->assertTrue(in_array($firstGroup->group_id, $groupIds));
-    }
-
-    public static function tearDownAfterClass()
-    {
-        foreach (self::$createdGroups as $createdGroup) {
-            $groupId = $createdGroup->group_id;
-
-            $removeParameters= [
-                'group_id' => $groupId
-            ];
-
-            $result = AddressBookGroup::removeAddressBookGroup($removeParameters);
-
-            if ($result!=null && isset($result['status']) && isset($result['status'])) {
-                echo "The address book group ".$groupId." removed successfully <br>";
-            } else {
-                echo "Cannot remove the address book group ".$groupId."<br>";
-            }
-        }
-    }
+	public static $createdGroups = [];
+
+	public static function setUpBeforeClass()
+	{
+		Route4Me::setApiKey(Constants::API_KEY);
+
+		$abg = new AddressBookGroup();
+
+		$createParameters= [
+			'group_name'    => 'All Group',
+			'group_color'   => '92e1c0',
+			'filter'        => [
+				'condition' => 'AND',
+				'rules'     => [[
+					'id'       => 'address_1',
+					'field'    => 'address_1',
+					'operator' => 'not_equal',
+					'value'    => 'qwerty123456'
+				]]
+			]
+		];
+
+		$createdAddressBookGroup = AddressBookGroup::fromArray(
+			$abg->createAddressBookGroup($createParameters)
+		);
+
+		self::$createdGroups[] = $createdAddressBookGroup;
+
+		$createParameters= [
+			'group_name'    => 'All Group',
+			'group_color'   => '92e1c0',
+			'filter'        => [
+				'condition' => 'AND',
+				'rules'     => [[
+					'id'       => 'address_1',
+					'field'    => 'address_1',
+					'operator' => 'not_equal',
+					'value'    => 'qwerty123456'
+				]]
+			]
+		];
+
+		$createdAddressBookGroup = AddressBookGroup::fromArray(
+			$abg->createAddressBookGroup($createParameters)
+		);
+
+		self::$createdGroups[] = $createdAddressBookGroup;
+	}
+
+	public function testFromArray()
+	{
+		$addressBookGroup = AddressBookGroup::fromArray([
+			'group_id'      => '137F9F99544DB34C160B2B9AF8FC6A12',
+			'group_name'    => 'Ocassion example',
+			'group_color'   => '92e1c0',
+			'group_icon'    => 'emoji-pushpin',
+			'member_id'     => 444333,
+			'filter' => [
+			  'condition'   => 'AND',
+			  'rules'       => [
+				[
+				  'id'          => 'custom_data.occasion',
+				  'field'       => 'custom_data.occasion',
+				  'operator'    => 'equal',
+				  'value'       => '100'
+				]]
+			]
+		]);
+
+		$this->assertEquals('137F9F99544DB34C160B2B9AF8FC6A12', $addressBookGroup->group_id);
+		$this->assertEquals('Ocassion example', $addressBookGroup->group_name);
+		$this->assertEquals('92e1c0', $addressBookGroup->group_color);
+		$this->assertEquals('emoji-pushpin', $addressBookGroup->group_icon);
+		$this->assertEquals(444333, $addressBookGroup->member_id);
+		$this->assertEquals([
+			'condition'   => 'AND',
+			'rules'       => [
+				[
+					'id'          => 'custom_data.occasion',
+					'field'       => 'custom_data.occasion',
+					'operator'    => 'equal',
+					'value'       => '100'
+				]]
+		], $addressBookGroup->filter);
+	}
+
+	public function testGetAddressBookGroup()
+	{
+		$groupId = self::$createdGroups[0]->group_id;
+
+		$abg = new AddressBookGroup();
+
+		$result = AddressBookGroup::fromArray(
+			$abg->getAddressBookGroup(['group_id' => $groupId])
+		);
+
+		$this->assertNotNull($result);
+		$this->assertContainsOnlyInstancesOf(AddressBookGroup::class, [$result]);
+	}
+
+	public function testUpdateAddressBookGroup()
+	{
+		$groupId = self::$createdGroups[0]->group_id;
+
+		$updateParameters= [
+			'group_id'      => $groupId,
+			'group_color'   => '7bd148'
+		];
+
+		$result = AddressBookGroup::fromArray(
+			AddressBookGroup::updateAddressBookGroup($updateParameters)
+		);
+
+		$this->assertNotNull($result);
+		$this->assertContainsOnlyInstancesOf(AddressBookGroup::class, [$result]);
+		$this->assertEquals('7bd148', $result->group_color);
+	}
+
+	public function testRemoveAddressBookGroup()
+	{
+		$groupId = end(self::$createdGroups)->group_id;
+
+		$removeParameters= [
+			'group_id' => $groupId
+		];
+
+		$result = AddressBookGroup::removeAddressBookGroup($removeParameters);
+
+		$this->assertNotNull($result);
+		$this->assertTrue(isset($result['status']));
+		$this->assertTrue($result['status']);
+
+		self::$createdGroups[] = array_pop(self::$createdGroups);
+	}
+
+	public function testCreateAddressBookGroup()
+	{
+		$createParameters= [
+			'group_name'    => 'All Group',
+			'group_color'   => '92e2cd',
+			'filter'        => [
+				'condition' => 'AND',
+				'rules'     => [[
+					'id'       => 'address_1',
+					'field'    => 'address_1',
+					'operator' => 'not_equal',
+					'value'    => 'qwerty654321'
+				]]
+			]
+		];
+
+		$createdAddressBookGroup = AddressBookGroup::fromArray(
+			AddressBookGroup::createAddressBookGroup($createParameters)
+		);
+
+		$this->assertNotNull($createdAddressBookGroup);
+		$this->assertContainsOnlyInstancesOf(AddressBookGroup::class, [$createdAddressBookGroup]);
+		$this->assertEquals('92e2cd', $createdAddressBookGroup->group_color);
+
+		self::$createdGroups[] = $createdAddressBookGroup;
+	}
+
+	public function testSearchAddressBookGroups()
+	{
+		$searchParameters = [
+			'fields' => ['address_id', 'address_1', 'address_group'],
+			'limit' => 10,
+			'offset' => 0,
+			'filter' => [
+				'query' => "Louisville",
+				"display" => "all"
+			]
+		];
+
+		$addressBookGroups = SearchResponse::fromArray(
+			AddressBookGroup::searchAddressBookGroups($searchParameters)
+		);
+
+		$this->assertNotNull($addressBookGroups);
+		$this->assertTrue(sizeof($addressBookGroups->fields)==3);
+		$this->assertContains('address_id', $addressBookGroups->fields);
+		$this->assertContains('address_1', $addressBookGroups->fields);
+		$this->assertContains('address_group', $addressBookGroups->fields);
+
+		$this->assertNotNull($addressBookGroups->results);
+
+		if (sizeof($addressBookGroups->results)>0) {
+			$this->assertContains('Louisville', implode(", ", $addressBookGroups->results[0]));
+		}
+	}
+
+	public function testGetAddressBookContactsByGroup()
+	{
+		//$this->markTestSkipped('must be revisited.');
+
+		$groupId = self::$createdGroups[0]->group_id;
+
+		$searchParameters = [
+			'fields'    => ['address_id'],
+			'group_id'  => $groupId,
+		];
+
+		$result = AddressBookGroup::getAddressBookContactsByGroup($searchParameters);
+
+		$this->assertNotNull($result);
+		$this->assertTrue(isset($result['total']));
+		$this->assertTrue(isset($result['results']));
+		$this->assertTrue(is_array($result['results']));
+	}
+
+	public function testGetAddressBookGroups()
+	{
+		$addressBookGroupParameters = [
+			'limit'  => 20,
+			'offset' => 0,
+		];
+
+		$addressBookGroups = AddressBookGroup::getAddressBookGroups($addressBookGroupParameters);
+
+		$this->assertNotNull($addressBookGroups);
+
+		$firstGroup = AddressBookGroup::fromArray(
+			$addressBookGroups[0]
+		);
+
+		$this->assertTrue(sizeof($addressBookGroups)>0);
+		$this->assertContainsOnlyInstancesOf(AddressBookGroup::class, [$firstGroup]);
+	}
+
+	public function testgGetRandomAddressBookGroup()
+	{
+		$addressBookGroupParameters = [
+			'limit'  => 20,
+			'offset' => 0,
+		];
+
+		$randomGroup = AddressBookGroup::fromArray(
+			AddressBookGroup::getRandomAddressBookGroup($addressBookGroupParameters)
+		);
+
+		$this->assertNotNull($randomGroup);
+		$this->assertContainsOnlyInstancesOf(AddressBookGroup::class, [$randomGroup]);
+	}
+
+	public function testGetAddressBookGroupIdByName()
+	{
+		$firstGroup = self::$createdGroups[0];
+
+		$groupIds = AddressBookGroup::getAddressBookGroupIdByName($firstGroup->group_name);
+
+		$this->assertNotNull($groupIds);
+		$this->assertTrue(in_array($firstGroup->group_id, $groupIds));
+	}
+
+	public static function tearDownAfterClass()
+	{
+		foreach (self::$createdGroups as $createdGroup) {
+			$groupId = $createdGroup->group_id;
+
+			$removeParameters= [
+				'group_id' => $groupId
+			];
+
+			$result = AddressBookGroup::removeAddressBookGroup($removeParameters);
+
+			if ($result!=null && isset($result['status']) && isset($result['status'])) {
+				echo "The address book group ".$groupId." removed successfully <br>";
+			} else {
+				echo "Cannot remove the address book group ".$groupId."<br>";
+			}
+		}
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -17,7 +17,7 @@ 
 
         $abg = new AddressBookGroup();
 
-        $createParameters= [
+        $createParameters = [
             'group_name'    => 'All Group',
             'group_color'   => '92e1c0',
             'filter'        => [
@@ -37,7 +37,7 @@ 
 
         self::$createdGroups[] = $createdAddressBookGroup;
 
-        $createParameters= [
+        $createParameters = [
             'group_name'    => 'All Group',
             'group_color'   => '92e1c0',
             'filter'        => [
@@ -113,7 +113,7 @@ 
     {
         $groupId = self::$createdGroups[0]->group_id;
 
-        $updateParameters= [
+        $updateParameters = [
             'group_id'      => $groupId,
             'group_color'   => '7bd148'
         ];
@@ -131,7 +131,7 @@ 
     {
         $groupId = end(self::$createdGroups)->group_id;
 
-        $removeParameters= [
+        $removeParameters = [
             'group_id' => $groupId
         ];
 
@@ -146,7 +146,7 @@ 
 
     public function testCreateAddressBookGroup()
     {
-        $createParameters= [
+        $createParameters = [
             'group_name'    => 'All Group',
             'group_color'   => '92e2cd',
             'filter'        => [
@@ -268,7 +268,7 @@ 
         foreach (self::$createdGroups as $createdGroup) {
             $groupId = $createdGroup->group_id;
 
-            $removeParameters= [
+            $removeParameters = [
                 'group_id' => $groupId
             ];