route4me / route4me-php-sdk

src/Route4Me/TelematicsGateway/TelematicsVendor.php

Indentation +144 added lines, -144 removed lines

@@ -11,158 +11,158 @@
  */
 class TelematicsVendor extends Common
 {
-    /**
-     * Unique ID of a telematics vendor.
-     * @var string
-     */
-    public $id;
+	/**
+	 * Unique ID of a telematics vendor.
+	 * @var string
+	 */
+	public $id;
     
-    /**
-     * Vendor name
-     * @var string
-     */
-    public $name;
+	/**
+	 * Vendor name
+	 * @var string
+	 */
+	public $name;
     
-    /**
-     * Vendor slug
-     * @var string
-     */
-    public $slug;
+	/**
+	 * Vendor slug
+	 * @var string
+	 */
+	public $slug;
     
-    /**
-     * Vendor description
-     * @var string
-     */
-    public $description;
+	/**
+	 * Vendor description
+	 * @var string
+	 */
+	public $description;
     
-    /**
-     * URL to the telematics vendor's logo.
-     * @var string
-     */
-    public $logo_url;
+	/**
+	 * URL to the telematics vendor's logo.
+	 * @var string
+	 */
+	public $logo_url;
     
-    /**
-     * Website URL of a telematics vendor.
-     * @var string
-     */
-    public $website_url;
+	/**
+	 * Website URL of a telematics vendor.
+	 * @var string
+	 */
+	public $website_url;
     
-    /**
-     * API URL of a telematics vendor.
-     * @var string
-     */
-    public $api_docs_url;
+	/**
+	 * API URL of a telematics vendor.
+	 * @var string
+	 */
+	public $api_docs_url;
     
-    /**
-     * If 1, the vendor is integrated in Route4Me
-     * @var string
-     */
-    public $is_integrated;
+	/**
+	 * If 1, the vendor is integrated in Route4Me
+	 * @var string
+	 */
+	public $is_integrated;
     
-    /**
-     * Vendors size.
-     * <para>Accepted values:</para>
-     * <para>global, regional, local. </para>
-     * @var string
-     */
-    public $size;
+	/**
+	 * Vendors size.
+	 * <para>Accepted values:</para>
+	 * <para>global, regional, local. </para>
+	 * @var string
+	 */
+	public $size;
     
-    /**
-     * An array of the countries, the vendor is operating.
-     * @var Country[]
-     */
-    public $countries = [];
+	/**
+	 * An array of the countries, the vendor is operating.
+	 * @var Country[]
+	 */
+	public $countries = [];
     
-    /**
-     * An array the vendor features
-     * @var TelematicsVendorFeature[]
-     */
-    public $features = [];
-
-    /**
-     * Get vendor(s), search for vendors, compare vendors.
-     * @param TelematicsVendorParameters $params
-     * @return TelematicsVendorResponse or TelematicsVendorsResponse.
-     */
-    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;
-    }
-
-    /**
-     * Returns a random telematics vendor (for tests).
-     * @param $offset integer
-     * @param $limit integer
-     * @return Telematics vendor
-     */
-    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'];
-    }
-
-    /**
-     * Register telematics member
-     * @param TelematicsVendorParameters $params contains:
-     * @param integer member_id : member ID
-     * @param string api_key    : API key
-     * @return array from a TelematicsRegisterMemberResponse type object
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public static function RegisterTelematicsMember($params)
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-
-        $allQueryFields = ['member_id', 'api_key'];
-
-        $vendors = Route4Me::makeRequst([
-            'url'       => Endpoint::TELEMATICS_REGISTER_MEMBER,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $vendors;
-    }
-
-    /**
-     * Get a vendor by ID
-     * @param string $vendorId
-     * @return TelematicsVendor type object
-     */
-    public static function getVendorById($vendorId)
-    {
-        if ($vendorId!=null) {
-            return self::GetTelematicsVendors($vendorId);
-        } else {
-            return null;
-        }
-    }
+	/**
+	 * An array the vendor features
+	 * @var TelematicsVendorFeature[]
+	 */
+	public $features = [];
+
+	/**
+	 * Get vendor(s), search for vendors, compare vendors.
+	 * @param TelematicsVendorParameters $params
+	 * @return TelematicsVendorResponse or TelematicsVendorsResponse.
+	 */
+	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;
+	}
+
+	/**
+	 * Returns a random telematics vendor (for tests).
+	 * @param $offset integer
+	 * @param $limit integer
+	 * @return Telematics vendor
+	 */
+	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'];
+	}
+
+	/**
+	 * Register telematics member
+	 * @param TelematicsVendorParameters $params contains:
+	 * @param integer member_id : member ID
+	 * @param string api_key    : API key
+	 * @return array from a TelematicsRegisterMemberResponse type object
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public static function RegisterTelematicsMember($params)
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+
+		$allQueryFields = ['member_id', 'api_key'];
+
+		$vendors = Route4Me::makeRequst([
+			'url'       => Endpoint::TELEMATICS_REGISTER_MEMBER,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $vendors;
+	}
+
+	/**
+	 * Get a vendor by ID
+	 * @param string $vendorId
+	 * @return TelematicsVendor type object
+	 */
+	public static function getVendorById($vendorId)
+	{
+		if ($vendorId!=null) {
+			return self::GetTelematicsVendors($vendorId);
+		} else {
+			return null;
+		}
+	}
 }

src/Route4Me/AddressBookLocation.php

Indentation +683 added lines, -683 removed lines

@@ -14,687 +14,687 @@
  */
 class AddressBookLocation extends Common
 {
-    /**
-     * A territory shape name the contact belongs.
-     * @var string
-     */
-    public $address_id;
-
-    /**
-     * A group the contact belongs.
-     * @var string
-     */
-    public $address_group;
-
-    /**
-     * The contact's alias.
-     * @var string
-     */
-    public $address_alias;
-
-    /**
-     * The geographic address of the contact.
-     * @var string
-     */
-    public $address_1;
-
-    /**
-     * Second geographic address of the contact.
-     * @var string
-     */
-    public $address_2;
-
-    /**
-     * The first name of the contact person.
-     * @var string
-     */
-    public $first_name;
-
-    /**
-     * The last name of the contact person.
-     * @var string
-     */
-    public $last_name;
-
-    /**
-     * The contact's email.
-     * @var string
-     */
-    public $address_email;
-
-    /**
-     * The contact's phone number.
-     * @var string
-     */
-    public $address_phone_number;
-
-    /**
-     * A city the contact belongs.
-     * @var string
-     */
-    public $address_city;
-
-    /**
-     * The ID of the state the contact belongs.
-     * @var string
-     */
-    public $address_state_id;
-
-    /**
-     * The ID of the country the contact belongs.
-     * @var string
-     */
-    public $address_country_id;
-
-    /**
-     * The contact's ZIP code.
-     * @var string
-     */
-    public $address_zip;
-
-    /**
-     * A latitude of the contact's cached position.
-     * @var double
-     */
-    public $cached_lat;
-
-    /**
-     * A longitude of the contact's cached position.
-     * @var double
-     */
-    public $cached_lng;
-
-    /**
-     * A latitude of the contact's curbside.
-     * @var double
-     */
-    public $curbside_lat;
-
-    /**
-     * A longitude of the contact's curbside.
-     * @var double
-     */
-    public $curbside_lng;
-
-    /**
-     * The contact's color on the map.
-     * @var string
-     */
-    public $color;
-
-    /**
-     * An array of the contact's custom field-value pairs.
-     * @var array
-     */
-    public $address_custom_data;
-
-    /**
-     * An array of the contact's schedules.
-     * @var Schedule[]
-     */
-    public $schedule;
-
-    /**
-     * Time when the contact was created.
-     * @var long
-     */
-    public $created_timestamp;
-
-    /**
-     * Unique ID of the member.
-     * @var integer
-     */
-    public $member_id;
-
-    /**
-     * The list of dates that should be omitted from the schedules.
-     * @var string[]
-     */
-    public $schedule_blacklist;
-
-    /**
-     * Number of the routes containing the contact.
-     * @var integer
-     */
-    public $in_route_count;
-
-    /**
-     * When the contact was last visited.
-     * @var long
-     */
-    public $last_visited_timestamp;
-
-    /**
-     * When the contact was last routed.
-     * @var long
-     */
-    public $last_routed_timestamp;
-
-    /**
-     * Start of the contact's local time window.
-     * @var long
-     */
-    public $local_time_window_start;
-
-    /**
-     * End of the contact's local time window.
-     * @var long
-     */
-    public $local_time_window_end;
-
-    /**
-     * Start of the contact's second local time window.
-     * @var long
-     */
-    public $local_time_window_start_2;
-
-    /**
-     * End of the contact's second local time window.
-     * @var long
-     */
-    public $local_time_window_end_2;
-
-    /**
-     * The service time at the contact's address.
-     * @var integer
-     */
-    public $service_time;
-
-    /**
-     * The contact's local timezone.
-     * @var string
-     */
-    public $local_timezone_string;
-
-    /**
-     * The contact's icon on the map.
-     * @var string
-     */
-    public $address_icon;
-
-    /**
-     * The contact's stop type.
-     * @var string
-     */
-    public $address_stop_type;
-
-    /**
-     * The cubic volume of the contact's cargo.
-     * @var double
-     */
-    public $address_cube;
-
-    /**
-     * The number of pieces/pallets that this destination/order/line-item consumes/contains on a vehicle.
-     * @var integer
-     */
-    public $address_pieces;
-
-    /**
-     * The reference number of the address.
-     * @var string
-     */
-    public $address_reference_no;
-
-    /**
-     * The revenue from the contact.
-     * @var double
-     */
-    public $address_revenue;
-
-    /**
-     * The weight of the contact's cargo.
-     * @var double
-     */
-    public $address_weight;
-
-    /**
-     * If present, the priority will sequence addresses in all the optimal routes so that
-     * higher priority addresses are general at the beginning of the route sequence.<br>
-     * 1 is the highest priority, 100000 is the lowest.
-     * @var integer
-     */
-    public $address_priority;
-
-    /**
-     * The customer purchase order of the contact.
-     * @var string
-     */
-    public $address_customer_po;
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-    }
-
-    /**
-     * @deprecated 1.2.8
-     * @see \Route4Me\V5\AddressBook\AddressBook::getAddressById()
-     */
-    public static function getAddressBookLocation($addressId)
-    {
-        $ablocations = Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESS_BOOK_V4,
-            'method' => 'GET',
-            'query'  => [
-                'query' => $addressId,
-                'limit' => 30,
-            ],
-        ]);
-
-        return $ablocations;
-    }
-
-    /**
-     * @deprecated 1.2.8
-     * @see \Route4Me\V5\AddressBook\AddressBook::getAddressesByBodyPayload()
-     */
-    public static function searchAddressBookLocations($params)
-    {
-        $allQueryFields = ['display', 'query', 'fields', 'limit', 'offset'];
-
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESS_BOOK_V4,
-            'method' => 'GET',
-            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $result;
-    }
-
-    /**
-     * @deprecated 1.2.8
-     * @see \Route4Me\V5\AddressBook\AddressBook::getAddressesByIds()
-     */
-    public static function getAddressBookLocations($params)
-    {
-        $allQueryFields = ['limit', 'offset', 'address_id'];
-
-        $ablocations = Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESS_BOOK_V4,
-            'method' => 'GET',
-            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $ablocations;
-    }
-
-    public static function getRandomAddressBookLocation($params)
-    {
-        $ablocations = self::getAddressBookLocations($params);
-
-        if (isset($ablocations['results'])) {
-            $locationsSize = sizeof($ablocations['results']);
-
-            if ($locationsSize > 0) {
-                $randomLocationIndex = rand(0, $locationsSize - 1);
-
-                return $ablocations['results'][$randomLocationIndex];
-            }
-        }
-
-        return null;
-    }
-
-    /**
-     * @deprecated 1.2.8
-     * @see \Route4Me\V5\AddressBook\AddressBook::addAddress()
-     *
-     * @param AddressBookLocation $params
-     */
-    public static function addAdressBookLocation($params)
-    {
-        $allBodyFields = Route4Me::getObjectProperties(new self(), ['address_id', 'in_route_count']);
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_BOOK_V4,
-            'method'    => 'POST',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    /**
-     * @deprecated 1.2.8
-     * @see \Route4Me\V5\AddressBook\AddressBook::deleteAddressesByIds()
-     */
-    public function deleteAdressBookLocation($address_ids)
-    {
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_BOOK_V4,
-            'method'    => 'DELETEARRAY',
-            'query'     => [
-                'address_ids' => $address_ids,
-            ],
-        ]);
-
-        return $result;
-    }
-
-    /**
-     * @deprecated 1.2.8
-     * @see \Route4Me\V5\AddressBook\AddressBook::updateAddressById()
-     */
-    public function updateAddressBookLocation($params)
-    {
-        $allBodyFields = Route4Me::getObjectProperties(new self(), ['in_route_count']);
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_BOOK_V4,
-            'method'    => 'PUT',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function validateScheduleMode($scheduleMode)
-    {
-        $schedModes = ['daily', 'weekly', 'monthly', 'annually'];
-
-        if (in_array($scheduleMode, $schedModes)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-    public static function validateScheduleEnable($scheduleEnabled)
-    {
-        if (is_string($scheduleEnabled)) {
-            if (strtolower($scheduleEnabled)=="true") $scheduleEnabled = true;
-            if (strtolower($scheduleEnabled)=="false") $scheduleEnabled = false;
-        }
-
-        $schedEnables = [true, false,];
-
-        if (in_array($scheduleEnabled, $schedEnables,true)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-    public static function validateScheduleEvery($scheduleEvery)
-    {
-        if (is_numeric($scheduleEvery)) {
-            if ($scheduleEvery>0) {
-                return true;
-            } else {
-                return false;
-            }
-        } else {
-            return false;
-        }
-    }
-
-    public static function validateScheduleWeekDays($scheduleWeekDays)
-    {
-        if (is_bool($scheduleWeekDays)) return false;
-
-        $weekdays = explode(',', $scheduleWeekDays);
-        $weekdaysSize = sizeof($weekdays);
-
-        if ($weekdaysSize < 1) {
-            return false;
-        }
-
-        $isValid = true;
-
-        for ($i = 0; $i < $weekdaysSize; ++$i) {
-            if (is_bool($weekdays[$i])) {
-                $isValid = false;
-            } elseif (is_numeric($weekdays[$i])) {
-                $wday = intval($weekdays[$i]);
-                if ($wday < 1 || $wday > 7) {
-                    $isValid = false;
-                }
-            } else {
-                $isValid = false;
-            }
-        }
-
-        return $isValid;
-    }
-
-    public static function validateScheduleMonthlyMode($scheduleMonthlyMode)
-    {
-        $schedMonthlyMmodes = ['dates', 'nth'];
-
-        if (in_array($scheduleMonthlyMode, $schedMonthlyMmodes,true)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-    public static function validateScheduleMonthlyDates($scheduleMonthlyDates)
-    {
-        if (is_bool($scheduleMonthlyDates)) return false;
-
-        $monthlyDates = explode(',', $scheduleMonthlyDates);
-        $monthlyDatesSize = sizeof($monthlyDates);
-
-        if ($monthlyDatesSize < 1) {
-            return false;
-        }
-
-        $isValid = true;
-
-        for ($i = 0; $i < $monthlyDatesSize; ++$i) {
-            if (is_numeric($monthlyDates[$i])) {
-                $mday = intval($monthlyDates[$i]);
-                if ($mday < 1 || $mday > 31) {
-                    $isValid = false;
-                }
-            } else {
-                $isValid = false;
-            }
-        }
-
-        return $isValid;
-    }
-
-    public static function validateScheduleNthN($scheduleNthN)
-    {
-        if (!is_numeric($scheduleNthN)) {
-            return false;
-        }
-
-        $schedNthNs = [1, 2, 3, 4, 5, -1];
-
-        if (in_array($scheduleNthN, $schedNthNs)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-    public static function validateScheduleNthWhat($scheduleNthWhat)
-    {
-        if (!is_numeric($scheduleNthWhat)) {
-            return false;
-        }
-
-        $schedNthWhats = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
-
-        if (in_array($scheduleNthWhat, $schedNthWhats)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-    /** Function adds the locations (with/without schedule) from the CSV file.
-     * $csvFileHandle - a file handler.
-     * Returns array $results which contains two arrays: fail and succes.
-     */
-    public function addLocationsFromCsvFile($csvFileHandle, $locationsFieldsMapping)
-    {
-        $max_line_length = 512;
-        $delemietr = ',';
-
-        $results = [];
-        $results['fail'] = [];
-        $results['success'] = [];
-
-        $columns = fgetcsv($csvFileHandle, $max_line_length, $delemietr);
-
-        $addressBookFields = Route4Me::getObjectProperties(new self(), ['address_id', 'in_route_count']);
-
-        if (empty($columns)) {
-            array_push($results['fail'], 'Empty CSV table');
-
-            return $results;
-        }
-
-        $iRow = 1;
-
-        while (false !== ($rows = fgetcsv($csvFileHandle, $max_line_length, $delemietr))) {
-            if (!isset($rows[$locationsFieldsMapping['cached_lat']]) || !isset($rows[$locationsFieldsMapping['cached_lng']])
-                  || !isset($rows[$locationsFieldsMapping['address_1']]) || [null] == $rows) {
-                continue;
-            }
-
-            $curSchedule = '';
-            $mode = '';
-
-            $failCount = sizeof($results['fail']);
-
-            if (isset($rows[$locationsFieldsMapping['schedule_mode']])) {
-                if ($this->validateScheduleMode($rows[$locationsFieldsMapping['schedule_mode']])) {
-                    $curSchedule = '"mode":"'.$rows[$locationsFieldsMapping['schedule_mode']].'",';
-                    $mode = $rows[$locationsFieldsMapping['schedule_mode']];
-                } else {
-                    array_push($results['fail'], "$iRow --> Wrong schedule mode parameter");
-                }
-            } else {
-                array_push($results['fail'], "$iRow --> The schedule mode parameter is not set");
-            }
-
-            if (isset($rows[$locationsFieldsMapping['schedule_enabled']])) {
-                if ($this->validateScheduleEnable($rows[$locationsFieldsMapping['schedule_enabled']])) {
-                    $curSchedule .= '"enabled":'.$rows[$locationsFieldsMapping['schedule_enabled']].',';
-                } else {
-                    array_push($results['fail'], "$iRow --> The schedule enabled parameter is not set ");
-                }
-            }
-
-            if (isset($rows[$locationsFieldsMapping['schedule_every']])) {
-                if ($this->validateScheduleEvery($rows[$locationsFieldsMapping['schedule_every']])) {
-                    $curSchedule .= '"'.$mode.'":{'.'"every":'.$rows[$locationsFieldsMapping['schedule_every']].',';
-                    if ('daily' == $mode) {
-                        $curSchedule = trim($curSchedule, ',');
-                        $curSchedule .= '}';
-                    }
-                } else {
-                    array_push($results['fail'], "$iRow --> The parameter sched_every is not set");
-                }
-            }
-
-            if ('daily' != $mode) {
-                switch ($mode) {
-                    case 'weekly':
-                        if (isset($rows[$locationsFieldsMapping['schedule_weekdays']])) {
-                            if ($this->validateScheduleWeekDays($rows[$locationsFieldsMapping['schedule_weekdays']])) {
-                                $curSchedule .= '"weekdays":['.$rows[$locationsFieldsMapping['schedule_weekdays']].']}';
-                            } else {
-                                array_push($results['fail'], "$iRow --> Wrong weekdays");
-                            }
-                        } else {
-                            array_push($results['fail'], "$iRow --> The parameters sched_weekdays is not set");
-                        }
-                        break;
-                    case 'monthly':
-                        $monthlyMode = '';
-                        if (isset($rows[$locationsFieldsMapping['monthly_mode']])) {
-                            if ($this->validateScheduleMonthlyMode($rows[$locationsFieldsMapping['monthly_mode']])) {
-                                $monthlyMode = $rows[$locationsFieldsMapping['monthly_mode']];
-                                $curSchedule .= '"mode": "'.$rows[$locationsFieldsMapping['monthly_mode']].'",';
-                            } else {
-                                array_push($results['fail'], "$iRow --> Wrong monthly mode");
-                            }
-                        } else {
-                            array_push($results['fail'], "$iRow --> The parameter sched_monthly_mode is not set");
-                        }
-
-                        if ('' != $monthlyMode) {
-                            switch ($monthlyMode) {
-                                case 'dates':
-                                    if (isset($rows[$locationsFieldsMapping['monthly_dates']])) {
-                                        if ($this->validateScheduleMonthlyDates($rows[$locationsFieldsMapping['monthly_dates']])) {
-                                            $curSchedule .= '"dates":['.$rows[$locationsFieldsMapping['monthly_dates']].']}';
-                                        } else {
-                                            array_push($results['fail'], "$iRow --> Wrong monthly dates");
-                                        }
-                                    }
-                                    break;
-                                case 'nth':
-                                    if (isset($rows[$locationsFieldsMapping['monthly_nth_n']])) {
-                                        if ($this->validateScheduleNthN($rows[$locationsFieldsMapping['monthly_nth_n']])) {
-                                            $curSchedule .= '"nth":{"n":'.$rows[$locationsFieldsMapping['monthly_nth_n']].',';
-                                        } else {
-                                            array_push($results['fail'], "$iRow --> Wrong parameter sched_nth_n");
-                                        }
-                                    } else {
-                                        array_push($results['fail'], "$iRow --> The parameter sched_nth_n is not set");
-                                    }
-
-                                    if ('' != $curSchedule) {
-                                        if (isset($rows[$locationsFieldsMapping['monthly_nth_what']])) {
-                                            if ($this->validateScheduleNthWhat($rows[$locationsFieldsMapping['monthly_nth_what']])) {
-                                                $curSchedule .= '"what":'.$rows[$locationsFieldsMapping['monthly_nth_what']].'}}';
-                                            } else {
-                                                array_push($results['fail'], "$iRow --> Wrong parameter sched_nth_what");
-                                            }
-                                        } else {
-                                            array_push($results['fail'], "$iRow --> The parameter sched_nth_what is not set");
-                                        }
-                                    }
-                                    break;
-                            }
-                        }
-                        break;
-                    default:
-                        $curSchedule = '';
-                        break;
-                }
-            }
-
-            if (sizeof($results['fail']) > $failCount) {
-                $curSchedule = '';
-            }
-
-            if (('daily' == $mode || 'weekly' == $mode || 'monthy' == $mode) && '' == $curSchedule) {
-                ++$iRow;
-                continue;
-            }
-
-            $curSchedule = strtolower($curSchedule);
-
-            $curSchedule = '[{'.$curSchedule.'}]';
-
-            $parametersArray = [];
-
-            foreach ($addressBookFields as $addressBookField) {
-                if (isset($locationsFieldsMapping[$addressBookField])) {
-                    $parametersArray[$addressBookField] = $rows[$locationsFieldsMapping[$addressBookField]];
-                }
-            }
-
-            $AdressBookLocationParameters = self::fromArray($parametersArray);
-
-            $abContacts = new self();
-
-            $abcResults = $abContacts->addAdressBookLocation($AdressBookLocationParameters); //temporarry
-
-            array_push(
-                $results['success'],
-                'The schedule location with address_id = '.strval($abcResults['address_id']).' added successfuly.'
-            );
-        }
-
-        return $results;
-    }
+	/**
+	 * A territory shape name the contact belongs.
+	 * @var string
+	 */
+	public $address_id;
+
+	/**
+	 * A group the contact belongs.
+	 * @var string
+	 */
+	public $address_group;
+
+	/**
+	 * The contact's alias.
+	 * @var string
+	 */
+	public $address_alias;
+
+	/**
+	 * The geographic address of the contact.
+	 * @var string
+	 */
+	public $address_1;
+
+	/**
+	 * Second geographic address of the contact.
+	 * @var string
+	 */
+	public $address_2;
+
+	/**
+	 * The first name of the contact person.
+	 * @var string
+	 */
+	public $first_name;
+
+	/**
+	 * The last name of the contact person.
+	 * @var string
+	 */
+	public $last_name;
+
+	/**
+	 * The contact's email.
+	 * @var string
+	 */
+	public $address_email;
+
+	/**
+	 * The contact's phone number.
+	 * @var string
+	 */
+	public $address_phone_number;
+
+	/**
+	 * A city the contact belongs.
+	 * @var string
+	 */
+	public $address_city;
+
+	/**
+	 * The ID of the state the contact belongs.
+	 * @var string
+	 */
+	public $address_state_id;
+
+	/**
+	 * The ID of the country the contact belongs.
+	 * @var string
+	 */
+	public $address_country_id;
+
+	/**
+	 * The contact's ZIP code.
+	 * @var string
+	 */
+	public $address_zip;
+
+	/**
+	 * A latitude of the contact's cached position.
+	 * @var double
+	 */
+	public $cached_lat;
+
+	/**
+	 * A longitude of the contact's cached position.
+	 * @var double
+	 */
+	public $cached_lng;
+
+	/**
+	 * A latitude of the contact's curbside.
+	 * @var double
+	 */
+	public $curbside_lat;
+
+	/**
+	 * A longitude of the contact's curbside.
+	 * @var double
+	 */
+	public $curbside_lng;
+
+	/**
+	 * The contact's color on the map.
+	 * @var string
+	 */
+	public $color;
+
+	/**
+	 * An array of the contact's custom field-value pairs.
+	 * @var array
+	 */
+	public $address_custom_data;
+
+	/**
+	 * An array of the contact's schedules.
+	 * @var Schedule[]
+	 */
+	public $schedule;
+
+	/**
+	 * Time when the contact was created.
+	 * @var long
+	 */
+	public $created_timestamp;
+
+	/**
+	 * Unique ID of the member.
+	 * @var integer
+	 */
+	public $member_id;
+
+	/**
+	 * The list of dates that should be omitted from the schedules.
+	 * @var string[]
+	 */
+	public $schedule_blacklist;
+
+	/**
+	 * Number of the routes containing the contact.
+	 * @var integer
+	 */
+	public $in_route_count;
+
+	/**
+	 * When the contact was last visited.
+	 * @var long
+	 */
+	public $last_visited_timestamp;
+
+	/**
+	 * When the contact was last routed.
+	 * @var long
+	 */
+	public $last_routed_timestamp;
+
+	/**
+	 * Start of the contact's local time window.
+	 * @var long
+	 */
+	public $local_time_window_start;
+
+	/**
+	 * End of the contact's local time window.
+	 * @var long
+	 */
+	public $local_time_window_end;
+
+	/**
+	 * Start of the contact's second local time window.
+	 * @var long
+	 */
+	public $local_time_window_start_2;
+
+	/**
+	 * End of the contact's second local time window.
+	 * @var long
+	 */
+	public $local_time_window_end_2;
+
+	/**
+	 * The service time at the contact's address.
+	 * @var integer
+	 */
+	public $service_time;
+
+	/**
+	 * The contact's local timezone.
+	 * @var string
+	 */
+	public $local_timezone_string;
+
+	/**
+	 * The contact's icon on the map.
+	 * @var string
+	 */
+	public $address_icon;
+
+	/**
+	 * The contact's stop type.
+	 * @var string
+	 */
+	public $address_stop_type;
+
+	/**
+	 * The cubic volume of the contact's cargo.
+	 * @var double
+	 */
+	public $address_cube;
+
+	/**
+	 * The number of pieces/pallets that this destination/order/line-item consumes/contains on a vehicle.
+	 * @var integer
+	 */
+	public $address_pieces;
+
+	/**
+	 * The reference number of the address.
+	 * @var string
+	 */
+	public $address_reference_no;
+
+	/**
+	 * The revenue from the contact.
+	 * @var double
+	 */
+	public $address_revenue;
+
+	/**
+	 * The weight of the contact's cargo.
+	 * @var double
+	 */
+	public $address_weight;
+
+	/**
+	 * If present, the priority will sequence addresses in all the optimal routes so that
+	 * higher priority addresses are general at the beginning of the route sequence.<br>
+	 * 1 is the highest priority, 100000 is the lowest.
+	 * @var integer
+	 */
+	public $address_priority;
+
+	/**
+	 * The customer purchase order of the contact.
+	 * @var string
+	 */
+	public $address_customer_po;
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	}
+
+	/**
+	 * @deprecated 1.2.8
+	 * @see \Route4Me\V5\AddressBook\AddressBook::getAddressById()
+	 */
+	public static function getAddressBookLocation($addressId)
+	{
+		$ablocations = Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESS_BOOK_V4,
+			'method' => 'GET',
+			'query'  => [
+				'query' => $addressId,
+				'limit' => 30,
+			],
+		]);
+
+		return $ablocations;
+	}
+
+	/**
+	 * @deprecated 1.2.8
+	 * @see \Route4Me\V5\AddressBook\AddressBook::getAddressesByBodyPayload()
+	 */
+	public static function searchAddressBookLocations($params)
+	{
+		$allQueryFields = ['display', 'query', 'fields', 'limit', 'offset'];
+
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESS_BOOK_V4,
+			'method' => 'GET',
+			'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $result;
+	}
+
+	/**
+	 * @deprecated 1.2.8
+	 * @see \Route4Me\V5\AddressBook\AddressBook::getAddressesByIds()
+	 */
+	public static function getAddressBookLocations($params)
+	{
+		$allQueryFields = ['limit', 'offset', 'address_id'];
+
+		$ablocations = Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESS_BOOK_V4,
+			'method' => 'GET',
+			'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $ablocations;
+	}
+
+	public static function getRandomAddressBookLocation($params)
+	{
+		$ablocations = self::getAddressBookLocations($params);
+
+		if (isset($ablocations['results'])) {
+			$locationsSize = sizeof($ablocations['results']);
+
+			if ($locationsSize > 0) {
+				$randomLocationIndex = rand(0, $locationsSize - 1);
+
+				return $ablocations['results'][$randomLocationIndex];
+			}
+		}
+
+		return null;
+	}
+
+	/**
+	 * @deprecated 1.2.8
+	 * @see \Route4Me\V5\AddressBook\AddressBook::addAddress()
+	 *
+	 * @param AddressBookLocation $params
+	 */
+	public static function addAdressBookLocation($params)
+	{
+		$allBodyFields = Route4Me::getObjectProperties(new self(), ['address_id', 'in_route_count']);
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_BOOK_V4,
+			'method'    => 'POST',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	/**
+	 * @deprecated 1.2.8
+	 * @see \Route4Me\V5\AddressBook\AddressBook::deleteAddressesByIds()
+	 */
+	public function deleteAdressBookLocation($address_ids)
+	{
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_BOOK_V4,
+			'method'    => 'DELETEARRAY',
+			'query'     => [
+				'address_ids' => $address_ids,
+			],
+		]);
+
+		return $result;
+	}
+
+	/**
+	 * @deprecated 1.2.8
+	 * @see \Route4Me\V5\AddressBook\AddressBook::updateAddressById()
+	 */
+	public function updateAddressBookLocation($params)
+	{
+		$allBodyFields = Route4Me::getObjectProperties(new self(), ['in_route_count']);
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_BOOK_V4,
+			'method'    => 'PUT',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function validateScheduleMode($scheduleMode)
+	{
+		$schedModes = ['daily', 'weekly', 'monthly', 'annually'];
+
+		if (in_array($scheduleMode, $schedModes)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+	public static function validateScheduleEnable($scheduleEnabled)
+	{
+		if (is_string($scheduleEnabled)) {
+			if (strtolower($scheduleEnabled)=="true") $scheduleEnabled = true;
+			if (strtolower($scheduleEnabled)=="false") $scheduleEnabled = false;
+		}
+
+		$schedEnables = [true, false,];
+
+		if (in_array($scheduleEnabled, $schedEnables,true)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+	public static function validateScheduleEvery($scheduleEvery)
+	{
+		if (is_numeric($scheduleEvery)) {
+			if ($scheduleEvery>0) {
+				return true;
+			} else {
+				return false;
+			}
+		} else {
+			return false;
+		}
+	}
+
+	public static function validateScheduleWeekDays($scheduleWeekDays)
+	{
+		if (is_bool($scheduleWeekDays)) return false;
+
+		$weekdays = explode(',', $scheduleWeekDays);
+		$weekdaysSize = sizeof($weekdays);
+
+		if ($weekdaysSize < 1) {
+			return false;
+		}
+
+		$isValid = true;
+
+		for ($i = 0; $i < $weekdaysSize; ++$i) {
+			if (is_bool($weekdays[$i])) {
+				$isValid = false;
+			} elseif (is_numeric($weekdays[$i])) {
+				$wday = intval($weekdays[$i]);
+				if ($wday < 1 || $wday > 7) {
+					$isValid = false;
+				}
+			} else {
+				$isValid = false;
+			}
+		}
+
+		return $isValid;
+	}
+
+	public static function validateScheduleMonthlyMode($scheduleMonthlyMode)
+	{
+		$schedMonthlyMmodes = ['dates', 'nth'];
+
+		if (in_array($scheduleMonthlyMode, $schedMonthlyMmodes,true)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+	public static function validateScheduleMonthlyDates($scheduleMonthlyDates)
+	{
+		if (is_bool($scheduleMonthlyDates)) return false;
+
+		$monthlyDates = explode(',', $scheduleMonthlyDates);
+		$monthlyDatesSize = sizeof($monthlyDates);
+
+		if ($monthlyDatesSize < 1) {
+			return false;
+		}
+
+		$isValid = true;
+
+		for ($i = 0; $i < $monthlyDatesSize; ++$i) {
+			if (is_numeric($monthlyDates[$i])) {
+				$mday = intval($monthlyDates[$i]);
+				if ($mday < 1 || $mday > 31) {
+					$isValid = false;
+				}
+			} else {
+				$isValid = false;
+			}
+		}
+
+		return $isValid;
+	}
+
+	public static function validateScheduleNthN($scheduleNthN)
+	{
+		if (!is_numeric($scheduleNthN)) {
+			return false;
+		}
+
+		$schedNthNs = [1, 2, 3, 4, 5, -1];
+
+		if (in_array($scheduleNthN, $schedNthNs)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+	public static function validateScheduleNthWhat($scheduleNthWhat)
+	{
+		if (!is_numeric($scheduleNthWhat)) {
+			return false;
+		}
+
+		$schedNthWhats = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+
+		if (in_array($scheduleNthWhat, $schedNthWhats)) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+	/** Function adds the locations (with/without schedule) from the CSV file.
+	 * $csvFileHandle - a file handler.
+	 * Returns array $results which contains two arrays: fail and succes.
+	 */
+	public function addLocationsFromCsvFile($csvFileHandle, $locationsFieldsMapping)
+	{
+		$max_line_length = 512;
+		$delemietr = ',';
+
+		$results = [];
+		$results['fail'] = [];
+		$results['success'] = [];
+
+		$columns = fgetcsv($csvFileHandle, $max_line_length, $delemietr);
+
+		$addressBookFields = Route4Me::getObjectProperties(new self(), ['address_id', 'in_route_count']);
+
+		if (empty($columns)) {
+			array_push($results['fail'], 'Empty CSV table');
+
+			return $results;
+		}
+
+		$iRow = 1;
+
+		while (false !== ($rows = fgetcsv($csvFileHandle, $max_line_length, $delemietr))) {
+			if (!isset($rows[$locationsFieldsMapping['cached_lat']]) || !isset($rows[$locationsFieldsMapping['cached_lng']])
+				  || !isset($rows[$locationsFieldsMapping['address_1']]) || [null] == $rows) {
+				continue;
+			}
+
+			$curSchedule = '';
+			$mode = '';
+
+			$failCount = sizeof($results['fail']);
+
+			if (isset($rows[$locationsFieldsMapping['schedule_mode']])) {
+				if ($this->validateScheduleMode($rows[$locationsFieldsMapping['schedule_mode']])) {
+					$curSchedule = '"mode":"'.$rows[$locationsFieldsMapping['schedule_mode']].'",';
+					$mode = $rows[$locationsFieldsMapping['schedule_mode']];
+				} else {
+					array_push($results['fail'], "$iRow --> Wrong schedule mode parameter");
+				}
+			} else {
+				array_push($results['fail'], "$iRow --> The schedule mode parameter is not set");
+			}
+
+			if (isset($rows[$locationsFieldsMapping['schedule_enabled']])) {
+				if ($this->validateScheduleEnable($rows[$locationsFieldsMapping['schedule_enabled']])) {
+					$curSchedule .= '"enabled":'.$rows[$locationsFieldsMapping['schedule_enabled']].',';
+				} else {
+					array_push($results['fail'], "$iRow --> The schedule enabled parameter is not set ");
+				}
+			}
+
+			if (isset($rows[$locationsFieldsMapping['schedule_every']])) {
+				if ($this->validateScheduleEvery($rows[$locationsFieldsMapping['schedule_every']])) {
+					$curSchedule .= '"'.$mode.'":{'.'"every":'.$rows[$locationsFieldsMapping['schedule_every']].',';
+					if ('daily' == $mode) {
+						$curSchedule = trim($curSchedule, ',');
+						$curSchedule .= '}';
+					}
+				} else {
+					array_push($results['fail'], "$iRow --> The parameter sched_every is not set");
+				}
+			}
+
+			if ('daily' != $mode) {
+				switch ($mode) {
+					case 'weekly':
+						if (isset($rows[$locationsFieldsMapping['schedule_weekdays']])) {
+							if ($this->validateScheduleWeekDays($rows[$locationsFieldsMapping['schedule_weekdays']])) {
+								$curSchedule .= '"weekdays":['.$rows[$locationsFieldsMapping['schedule_weekdays']].']}';
+							} else {
+								array_push($results['fail'], "$iRow --> Wrong weekdays");
+							}
+						} else {
+							array_push($results['fail'], "$iRow --> The parameters sched_weekdays is not set");
+						}
+						break;
+					case 'monthly':
+						$monthlyMode = '';
+						if (isset($rows[$locationsFieldsMapping['monthly_mode']])) {
+							if ($this->validateScheduleMonthlyMode($rows[$locationsFieldsMapping['monthly_mode']])) {
+								$monthlyMode = $rows[$locationsFieldsMapping['monthly_mode']];
+								$curSchedule .= '"mode": "'.$rows[$locationsFieldsMapping['monthly_mode']].'",';
+							} else {
+								array_push($results['fail'], "$iRow --> Wrong monthly mode");
+							}
+						} else {
+							array_push($results['fail'], "$iRow --> The parameter sched_monthly_mode is not set");
+						}
+
+						if ('' != $monthlyMode) {
+							switch ($monthlyMode) {
+								case 'dates':
+									if (isset($rows[$locationsFieldsMapping['monthly_dates']])) {
+										if ($this->validateScheduleMonthlyDates($rows[$locationsFieldsMapping['monthly_dates']])) {
+											$curSchedule .= '"dates":['.$rows[$locationsFieldsMapping['monthly_dates']].']}';
+										} else {
+											array_push($results['fail'], "$iRow --> Wrong monthly dates");
+										}
+									}
+									break;
+								case 'nth':
+									if (isset($rows[$locationsFieldsMapping['monthly_nth_n']])) {
+										if ($this->validateScheduleNthN($rows[$locationsFieldsMapping['monthly_nth_n']])) {
+											$curSchedule .= '"nth":{"n":'.$rows[$locationsFieldsMapping['monthly_nth_n']].',';
+										} else {
+											array_push($results['fail'], "$iRow --> Wrong parameter sched_nth_n");
+										}
+									} else {
+										array_push($results['fail'], "$iRow --> The parameter sched_nth_n is not set");
+									}
+
+									if ('' != $curSchedule) {
+										if (isset($rows[$locationsFieldsMapping['monthly_nth_what']])) {
+											if ($this->validateScheduleNthWhat($rows[$locationsFieldsMapping['monthly_nth_what']])) {
+												$curSchedule .= '"what":'.$rows[$locationsFieldsMapping['monthly_nth_what']].'}}';
+											} else {
+												array_push($results['fail'], "$iRow --> Wrong parameter sched_nth_what");
+											}
+										} else {
+											array_push($results['fail'], "$iRow --> The parameter sched_nth_what is not set");
+										}
+									}
+									break;
+							}
+						}
+						break;
+					default:
+						$curSchedule = '';
+						break;
+				}
+			}
+
+			if (sizeof($results['fail']) > $failCount) {
+				$curSchedule = '';
+			}
+
+			if (('daily' == $mode || 'weekly' == $mode || 'monthy' == $mode) && '' == $curSchedule) {
+				++$iRow;
+				continue;
+			}
+
+			$curSchedule = strtolower($curSchedule);
+
+			$curSchedule = '[{'.$curSchedule.'}]';
+
+			$parametersArray = [];
+
+			foreach ($addressBookFields as $addressBookField) {
+				if (isset($locationsFieldsMapping[$addressBookField])) {
+					$parametersArray[$addressBookField] = $rows[$locationsFieldsMapping[$addressBookField]];
+				}
+			}
+
+			$AdressBookLocationParameters = self::fromArray($parametersArray);
+
+			$abContacts = new self();
+
+			$abcResults = $abContacts->addAdressBookLocation($AdressBookLocationParameters); //temporarry
+
+			array_push(
+				$results['success'],
+				'The schedule location with address_id = '.strval($abcResults['address_id']).' added successfuly.'
+			);
+		}
+
+		return $results;
+	}
 }

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;
+	}
 }