route4me / route4me-php-sdk

src/Route4Me/AddressBundling.php

Indentation +26 added lines, -26 removed lines

@@ -9,31 +9,31 @@
  */
 class AddressBundling extends Common
 {
-    /**
-     * Address bundling mode
-     */
-    public $mode = AddressBundlingModes\Mode::ADDRESS;
-
-    /**
-     * Address bundling mode parameters:
-     * - If Mode=3, contains an array of the field names of the Address object;
-     * - If Mode=4, contains an array of the custom fields of the Address object.
-     */
-    public $mode_params= [];
-
-    /**
-     * Address bundling merge mode
-     */
-    public $merge_mode = AddressBundlingModes\MergeMode::KEEP_AS_SEPARATE_DESTINATIONS;
-
-    /**
-     * Service time rules of the address bundling
-     */
-    public $service_time_rules;
-
-    public function __construct()
-    {
-        $this->service_time_rules = new ServiceTimeRulesClass();
-    }
+	/**
+	 * Address bundling mode
+	 */
+	public $mode = AddressBundlingModes\Mode::ADDRESS;
+
+	/**
+	 * Address bundling mode parameters:
+	 * - If Mode=3, contains an array of the field names of the Address object;
+	 * - If Mode=4, contains an array of the custom fields of the Address object.
+	 */
+	public $mode_params= [];
+
+	/**
+	 * Address bundling merge mode
+	 */
+	public $merge_mode = AddressBundlingModes\MergeMode::KEEP_AS_SEPARATE_DESTINATIONS;
+
+	/**
+	 * Service time rules of the address bundling
+	 */
+	public $service_time_rules;
+
+	public function __construct()
+	{
+		$this->service_time_rules = new ServiceTimeRulesClass();
+	}
 
 }

src/Route4Me/AddressBookLocation.php

Indentation +673 added lines, -673 removed lines

@@ -11,677 +11,677 @@
  */
 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);
-    }
-
-    public static function fromArray(array $params)
-    {
-        $addressbooklocation = new self();
-
-        foreach ($params as $key => $value) {
-            if (property_exists($addressbooklocation, $key)) {
-                $addressbooklocation->{$key} = $value;
-            }
-        }
-
-        return $addressbooklocation;
-    }
-
-    public static function getAddressBookLocation($addressId)
-    {
-        $ablocations = Route4Me::makeRequst([
-            'url' => Endpoint::ADDRESS_BOOK_V4,
-            'method' => 'GET',
-            'query'  => [
-                'query' => $addressId,
-                'limit' => 30,
-            ],
-        ]);
-
-        return $ablocations;
-    }
-
-    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;
-    }
-
-    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;
-    }
-
-    /**
-     * @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;
-    }
-
-    public function deleteAdressBookLocation($address_ids)
-    {
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_BOOK_V4,
-            'method'    => 'DELETEARRAY',
-            'query'     => [
-                'address_ids' => $address_ids,
-            ],
-        ]);
-
-        return $result;
-    }
-
-    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);
+	}
+
+	public static function fromArray(array $params)
+	{
+		$addressbooklocation = new self();
+
+		foreach ($params as $key => $value) {
+			if (property_exists($addressbooklocation, $key)) {
+				$addressbooklocation->{$key} = $value;
+			}
+		}
+
+		return $addressbooklocation;
+	}
+
+	public static function getAddressBookLocation($addressId)
+	{
+		$ablocations = Route4Me::makeRequst([
+			'url' => Endpoint::ADDRESS_BOOK_V4,
+			'method' => 'GET',
+			'query'  => [
+				'query' => $addressId,
+				'limit' => 30,
+			],
+		]);
+
+		return $ablocations;
+	}
+
+	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;
+	}
+
+	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;
+	}
+
+	/**
+	 * @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;
+	}
+
+	public function deleteAdressBookLocation($address_ids)
+	{
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_BOOK_V4,
+			'method'    => 'DELETEARRAY',
+			'query'     => [
+				'address_ids' => $address_ids,
+			],
+		]);
+
+		return $result;
+	}
+
+	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/CustomNoteTypeResponse.php

Indentation +38 added lines, -38 removed lines

@@ -6,42 +6,42 @@
 
 class CustomNoteTypeResponse extends Common
 {
-    /**
-     * Note custom type ID
-     * @var integer
-     */
-    public $note_custom_type_id;
-
-    /**
-     * Note custom type
-     * @var CustomNoteType
-     */
-    public $note_custom_type;
-
-    /**
-     * ID of a root owner of the account
-     * @var integer
-     */
-    public $root_owner_member_id;
-
-    /**
-     * Values of the custom note type
-     * @var array
-     */
-    public $note_custom_type_values=[];
-
-    public static function fromArray(array $params)
-    {
-        $customNoteTypeResponse = new self();
-
-        foreach ($params as $key => $value) {
-            if (property_exists($customNoteTypeResponse, $key)) {
-                $customNoteTypeResponse->{$key} = $value;
-            } else {
-                throw new BadParam("Correct parameter must be provided. Wrong Parameter: $key");
-            }
-        }
-
-        return $customNoteTypeResponse;
-    }
+	/**
+	 * Note custom type ID
+	 * @var integer
+	 */
+	public $note_custom_type_id;
+
+	/**
+	 * Note custom type
+	 * @var CustomNoteType
+	 */
+	public $note_custom_type;
+
+	/**
+	 * ID of a root owner of the account
+	 * @var integer
+	 */
+	public $root_owner_member_id;
+
+	/**
+	 * Values of the custom note type
+	 * @var array
+	 */
+	public $note_custom_type_values=[];
+
+	public static function fromArray(array $params)
+	{
+		$customNoteTypeResponse = new self();
+
+		foreach ($params as $key => $value) {
+			if (property_exists($customNoteTypeResponse, $key)) {
+				$customNoteTypeResponse->{$key} = $value;
+			} else {
+				throw new BadParam("Correct parameter must be provided. Wrong Parameter: $key");
+			}
+		}
+
+		return $customNoteTypeResponse;
+	}
 }
\ No newline at end of file

src/Route4Me/GeocodingResponse.php

Indentation +48 added lines, -48 removed lines

@@ -10,52 +10,52 @@
  */
 class GeocodingResponse extends Common
 {
-    /**
-     * A geocoded address
-     * @var string
-     */
-    public $address;
-
-    /**
-     * Latitude
-     * @var double
-     */
-    public $lat;
-
-    /**
-     * Longitude
-     * @var double
-     */
-    public $lng;
-
-    /**
-     * Geocoded area level type
-     * @var string
-     */
-    public $type;
-
-    /**
-     * Confidence ("high", "medium", "low")
-     * @var string
-     */
-    public $confidence;
-
-    /**
-     * Content of the original string (an address or geopoint) sent by HTTP
-     * @var Route
-     */
-    public $original;
-
-    public static function fromArray(array $params)
-    {
-        $geocodingResponse = new self();
-
-        foreach ($params as $key => $value) {
-            if (property_exists($geocodingResponse, $key)) {
-                $geocodingResponse->{$key} = $value;
-            }
-        }
-
-        return $geocodingResponse;
-    }
+	/**
+	 * A geocoded address
+	 * @var string
+	 */
+	public $address;
+
+	/**
+	 * Latitude
+	 * @var double
+	 */
+	public $lat;
+
+	/**
+	 * Longitude
+	 * @var double
+	 */
+	public $lng;
+
+	/**
+	 * Geocoded area level type
+	 * @var string
+	 */
+	public $type;
+
+	/**
+	 * Confidence ("high", "medium", "low")
+	 * @var string
+	 */
+	public $confidence;
+
+	/**
+	 * Content of the original string (an address or geopoint) sent by HTTP
+	 * @var Route
+	 */
+	public $original;
+
+	public static function fromArray(array $params)
+	{
+		$geocodingResponse = new self();
+
+		foreach ($params as $key => $value) {
+			if (property_exists($geocodingResponse, $key)) {
+				$geocodingResponse->{$key} = $value;
+			}
+		}
+
+		return $geocodingResponse;
+	}
 }

src/Route4Me/AddressNote.php

Indentation +234 added lines, -234 removed lines

@@ -11,238 +11,238 @@
  */
 class AddressNote extends Common
 {
-    /**
-     * An unique ID of a note
-     * @var integer
-     */
-    public $note_id;
-
-    /**
-     * The route ID
-     * @var string
-     */
-    public $route_id;
-
-    /**
-     * The route destination ID
-     * @var integer
-     */
-    public $route_destination_id;
-
-    /**
-     * An unique ID of an uploaded file
-     * @var string
-     */
-    public $upload_id;
-
-    /**
-     * When the note was added
-     * @var integer
-     */
-    public $ts_added;
-
-    /**
-     * The position latitude where the address note was added
-     * @var double
-     */
-    public $lat;
-
-    /**
-     * The position longitude where the address note was added
-     * @var double
-     */
-    public $lng;
-
-    /**
-     * The activity type
-     * @var string
-     */
-    public $activity_type;
-
-    /**
-     * The note text contents
-     * @var string
-     */
-    public $contents;
-
-    /**
-     * An upload type of the note
-     * @var string
-     */
-    public $upload_type;
-
-    /**
-     * An upload url - where a file-note was uploaded.
-     * @var string
-     */
-    public $upload_url;
-
-    /**
-     * An extension of the uploaded file.
-     * @var string
-     */
-    public $upload_extension;
-
-    /**
-     * The device a note was uploaded from.
-     * @var string
-     */
-    public $device_type;
-
-    /**
-     * Array of the custom type notes.
-     * @var CustomNoteType[]
-     */
-    public $custom_types;
-
-    public function __construct()
-    {
-
-    }
-
-    public static function fromArray(array $params)
-    {
-        $addressNote = new self();
-
-        foreach ($params as $key => $value) {
-            if (property_exists($addressNote, $key)) {
-                $addressNote->{$key} = $value;
-            } else {
-                throw new BadParam("Correct parameter must be provided. Wrong Parameter: $key");
-            }
-        }
-
-        return $addressNote;
-    }
-
-    /**
-     * Get notes from the specified route destination.<br>
-     * Returns an address object with notes, if an address exists, otherwise - return null.
-     */
-    public static function GetAddressesNotes($noteParams)
-    {
-        $address = Route4Me::makeRequst([
-            'url'       => Endpoint::ADDRESS_V4,
-            'method'    => 'GET',
-            'query'     => [
-                'route_id'              => isset($noteParams['route_id']) ? $noteParams['route_id'] : null,
-                'route_destination_id'  => isset($noteParams['route_destination_id'])
-                    ? $noteParams['route_destination_id'] : null,
-                'notes' => 1,
-            ],
-        ]);
-
-        return $address;
-    }
-
-    public function createCustomNoteType($params)
-    {
-        $allBodyFields = ['type', 'values'];
-
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
-            'method'    => 'POST',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $result;
-    }
-
-    public function removeCustomNoteType($params)
-    {
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
-            'method'    => 'DELETE',
-            'body'      => [
-                'id' => isset($params['id']) ? $params['id'] : null,
-            ],
-        ]);
-
-        return $result;
-    }
-
-    public function getAllCustomNoteTypes()
-    {
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
-            'method'    => 'GET',
-        ]);
-
-        return $result;
-    }
-
-    public function getCustomNoteTypeByKey($params)
-    {
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
-            'method'    => 'GET',
-        ]);
-
-        if (is_null($result) || !is_array($result)) return null;
-
-        foreach ($result as $custNoteType) {
-            if (isset($custNoteType["note_custom_type"]) && $custNoteType["note_custom_type"] == $params) {
-                return $custNoteType;
-            }
-        }
-    }
-
-    public function AddAddressNote($params)
-    {
-        $allQueryFields = ['route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type'];
-        $allBodyFields = ['strNoteContents', 'strUpdateType'];
-
-        $result = Route4Me::makeRequst([
-            'url'           => Endpoint::ROUTE_NOTES_ADD,
-            'method'        => 'POST',
-            'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data',
-        ]);
-
-        return $result;
-    }
-
-    public function AddNoteFile($params)
-    {
-        $fname = isset($params['strFilename']) ? $params['strFilename'] : null;
-
-        $allQueryFields = ['route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type'];
-        $allBodyFields = ['strFilename', 'strUpdateType', 'strNoteContents'];
-
-        $result = Route4Me::makeRequst([
-            'url'           => Endpoint::ROUTE_NOTES_ADD,
-            'method'        => 'POST',
-            'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'FILE'          => $fname,
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data'
-        ]);
-
-        return $result;
-    }
-
-    public function addCustomNoteToRoute($params)
-    {
-        $customArray = [];
-
-        foreach ($params as $key => $value) {
-            if (false !== strpos($key, 'custom_note_type')) {
-                $customArray[$key] = $value;
-            }
-        }
-
-        $allQueryFields = ['route_id', 'address_id', 'format', 'dev_lat', 'dev_lng'];
-        $allBodyFields = ['strUpdateType', 'strUpdateType', 'strNoteContents'];
-
-        $result = Route4Me::makeRequst([
-            'url'           => Endpoint::ROUTE_NOTES_ADD,
-            'method'        => 'POST',
-            'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'          => array_merge(Route4Me::generateRequestParameters($allBodyFields, $params), $customArray),
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data',
-        ]);
-
-        return $result;
-    }
+	/**
+	 * An unique ID of a note
+	 * @var integer
+	 */
+	public $note_id;
+
+	/**
+	 * The route ID
+	 * @var string
+	 */
+	public $route_id;
+
+	/**
+	 * The route destination ID
+	 * @var integer
+	 */
+	public $route_destination_id;
+
+	/**
+	 * An unique ID of an uploaded file
+	 * @var string
+	 */
+	public $upload_id;
+
+	/**
+	 * When the note was added
+	 * @var integer
+	 */
+	public $ts_added;
+
+	/**
+	 * The position latitude where the address note was added
+	 * @var double
+	 */
+	public $lat;
+
+	/**
+	 * The position longitude where the address note was added
+	 * @var double
+	 */
+	public $lng;
+
+	/**
+	 * The activity type
+	 * @var string
+	 */
+	public $activity_type;
+
+	/**
+	 * The note text contents
+	 * @var string
+	 */
+	public $contents;
+
+	/**
+	 * An upload type of the note
+	 * @var string
+	 */
+	public $upload_type;
+
+	/**
+	 * An upload url - where a file-note was uploaded.
+	 * @var string
+	 */
+	public $upload_url;
+
+	/**
+	 * An extension of the uploaded file.
+	 * @var string
+	 */
+	public $upload_extension;
+
+	/**
+	 * The device a note was uploaded from.
+	 * @var string
+	 */
+	public $device_type;
+
+	/**
+	 * Array of the custom type notes.
+	 * @var CustomNoteType[]
+	 */
+	public $custom_types;
+
+	public function __construct()
+	{
+
+	}
+
+	public static function fromArray(array $params)
+	{
+		$addressNote = new self();
+
+		foreach ($params as $key => $value) {
+			if (property_exists($addressNote, $key)) {
+				$addressNote->{$key} = $value;
+			} else {
+				throw new BadParam("Correct parameter must be provided. Wrong Parameter: $key");
+			}
+		}
+
+		return $addressNote;
+	}
+
+	/**
+	 * Get notes from the specified route destination.<br>
+	 * Returns an address object with notes, if an address exists, otherwise - return null.
+	 */
+	public static function GetAddressesNotes($noteParams)
+	{
+		$address = Route4Me::makeRequst([
+			'url'       => Endpoint::ADDRESS_V4,
+			'method'    => 'GET',
+			'query'     => [
+				'route_id'              => isset($noteParams['route_id']) ? $noteParams['route_id'] : null,
+				'route_destination_id'  => isset($noteParams['route_destination_id'])
+					? $noteParams['route_destination_id'] : null,
+				'notes' => 1,
+			],
+		]);
+
+		return $address;
+	}
+
+	public function createCustomNoteType($params)
+	{
+		$allBodyFields = ['type', 'values'];
+
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
+			'method'    => 'POST',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $result;
+	}
+
+	public function removeCustomNoteType($params)
+	{
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
+			'method'    => 'DELETE',
+			'body'      => [
+				'id' => isset($params['id']) ? $params['id'] : null,
+			],
+		]);
+
+		return $result;
+	}
+
+	public function getAllCustomNoteTypes()
+	{
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
+			'method'    => 'GET',
+		]);
+
+		return $result;
+	}
+
+	public function getCustomNoteTypeByKey($params)
+	{
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::NOTE_CUSTOM_TYPES_V4,
+			'method'    => 'GET',
+		]);
+
+		if (is_null($result) || !is_array($result)) return null;
+
+		foreach ($result as $custNoteType) {
+			if (isset($custNoteType["note_custom_type"]) && $custNoteType["note_custom_type"] == $params) {
+				return $custNoteType;
+			}
+		}
+	}
+
+	public function AddAddressNote($params)
+	{
+		$allQueryFields = ['route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type'];
+		$allBodyFields = ['strNoteContents', 'strUpdateType'];
+
+		$result = Route4Me::makeRequst([
+			'url'           => Endpoint::ROUTE_NOTES_ADD,
+			'method'        => 'POST',
+			'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data',
+		]);
+
+		return $result;
+	}
+
+	public function AddNoteFile($params)
+	{
+		$fname = isset($params['strFilename']) ? $params['strFilename'] : null;
+
+		$allQueryFields = ['route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type'];
+		$allBodyFields = ['strFilename', 'strUpdateType', 'strNoteContents'];
+
+		$result = Route4Me::makeRequst([
+			'url'           => Endpoint::ROUTE_NOTES_ADD,
+			'method'        => 'POST',
+			'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'          => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'FILE'          => $fname,
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data'
+		]);
+
+		return $result;
+	}
+
+	public function addCustomNoteToRoute($params)
+	{
+		$customArray = [];
+
+		foreach ($params as $key => $value) {
+			if (false !== strpos($key, 'custom_note_type')) {
+				$customArray[$key] = $value;
+			}
+		}
+
+		$allQueryFields = ['route_id', 'address_id', 'format', 'dev_lat', 'dev_lng'];
+		$allBodyFields = ['strUpdateType', 'strUpdateType', 'strNoteContents'];
+
+		$result = Route4Me::makeRequst([
+			'url'           => Endpoint::ROUTE_NOTES_ADD,
+			'method'        => 'POST',
+			'query'         => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'          => array_merge(Route4Me::generateRequestParameters($allBodyFields, $params), $customArray),
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data',
+		]);
+
+		return $result;
+	}
 }

src/Route4Me/Territory.php

Indentation +106 added lines, -106 removed lines

@@ -7,110 +7,110 @@
 
 class Territory extends Common
 {
-    /**
-     * @var
-     */
-    public $territory_id; // Territory id
-    public $territory_name;
-    public $territory_color;
-    public $addresses;
-    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');
-        }
-
-        $territoryparameters = new self();
-
-        foreach ($params as $key => $value) {
-            if (property_exists($territoryparameters, $key)) {
-                $territoryparameters->{$key} = $value;
-            }
-        }
-
-        return $territoryparameters;
-    }
-
-    public static function getTerritory($params)
-    {
-        $allQueryFields = ['territory_id', 'addresses'];
-
-        $territory = Route4Me::makeRequst([
-            'url'       => Endpoint::TERRITORY_V4,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $territory;
-    }
-
-    public static function getTerritories($params)
-    {
-        $allQueryFields = ['offset', 'limit', 'addresses'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::TERRITORY_V4,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function addTerritory($params)
-    {
-        $allBodyFields = ['territory_name', 'member_id', 'territory_color', 'territory'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::TERRITORY_V4,
-            'method'    => 'POST',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public function deleteTerritory($territory_id)
-    {
-        $result = Route4Me::makeRequst([
-            'url'       => Endpoint::TERRITORY_V4,
-            'method'    => 'DELETE',
-            'query'     => [
-                'territory_id' => $territory_id,
-            ],
-        ]);
-
-        return $result;
-    }
-
-    public function updateTerritory($params)
-    {
-        $allQueryFields = ['territory_id'];
-        $allBodyFields = ['territory_name', 'member_id', 'territory_color', 'territory'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::TERRITORY_V4,
-            'method'    => 'PUT',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
+	/**
+	 * @var
+	 */
+	public $territory_id; // Territory id
+	public $territory_name;
+	public $territory_color;
+	public $addresses;
+	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');
+		}
+
+		$territoryparameters = new self();
+
+		foreach ($params as $key => $value) {
+			if (property_exists($territoryparameters, $key)) {
+				$territoryparameters->{$key} = $value;
+			}
+		}
+
+		return $territoryparameters;
+	}
+
+	public static function getTerritory($params)
+	{
+		$allQueryFields = ['territory_id', 'addresses'];
+
+		$territory = Route4Me::makeRequst([
+			'url'       => Endpoint::TERRITORY_V4,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $territory;
+	}
+
+	public static function getTerritories($params)
+	{
+		$allQueryFields = ['offset', 'limit', 'addresses'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::TERRITORY_V4,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function addTerritory($params)
+	{
+		$allBodyFields = ['territory_name', 'member_id', 'territory_color', 'territory'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::TERRITORY_V4,
+			'method'    => 'POST',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public function deleteTerritory($territory_id)
+	{
+		$result = Route4Me::makeRequst([
+			'url'       => Endpoint::TERRITORY_V4,
+			'method'    => 'DELETE',
+			'query'     => [
+				'territory_id' => $territory_id,
+			],
+		]);
+
+		return $result;
+	}
+
+	public function updateTerritory($params)
+	{
+		$allQueryFields = ['territory_id'];
+		$allBodyFields = ['territory_name', 'member_id', 'territory_color', 'territory'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::TERRITORY_V4,
+			'method'    => 'PUT',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
 }

src/Route4Me/MyQ.php

Indentation +210 added lines, -210 removed lines

@@ -13,214 +13,214 @@
 
 class MyQ
 {
-    /** @var string|null $username contains the username used to authenticate with the MyQ API */
-    protected $username = null;
-    /** @var string|null $password contains the password used to authenticate with the MyQ API */
-    protected $password = null;
-    /** @var string|null $appId is the application ID used to register with the MyQ API */
-    protected $appId = 'NWknvuBd7LoFHfXmKNMBcgajXtZEgKUh4V7WNzMidrpUUluDpVYVZx+xT4PCM5Kx';
-    //protected $appId = 'Vj8pQggXLhLy0WHahglCD4N1nAkkXQtGYpq2HrHD7H1nvmbT55KqtN6RSF4ILB%2fi';
-    /** @var string|null $securityToken is the auth token returned after a successful login */
-    protected $securityToken = null;
-    /** @var string|null $userAgent is the User-Agent header value sent with each API request */
-    protected $userAgent = 'Chamberlain/3.4.1';
-    /** @var string|null $culture is the API culture code for the API */
-    protected $culture = 'en';
-    /** @var string|null $contentType is the content type used for all cURL requests */
-    protected $contentType = 'application/json';
-    /** @var array $headers contain HTTP headers for cURL requests */
-    protected $_headers = [];
-    protected $_deviceId = null;
-    protected $_locationName = null;
-    protected $_doorName = null;
-    protected $_loginUrl = 'https://myqexternal.myqdevice.com/api/v4/User/Validate';
-    protected $_getDeviceDetailUrl = 'https://myqexternal.myqdevice.com/api/v4/userdevicedetails/get?&filterOn=true';
-    protected $_putDeviceStateUrl = '/api/v4/DeviceAttribute/PutDeviceAttribute';
-    /** @var resource|null $_conn is the web connection to the MyQ API */
-    protected $_conn = null;
-
-    /**
-     * Initializes class. Optionally allows user to override variables.
-     *
-     * @param array $params A associative array for overwriting class variables
-     *
-     * @return MyQ
-     */
-    public function __construct($params = [])
-    {
-        // Overwrite class variables
-        foreach ($params as $k => $v) {
-            $this->$k = $v;
-        }
-
-        // Initialize cURL request headers
-        if (0 == sizeof($this->_headers)) {
-            $this->_headers = [
-                'MyQApplicationId' => $this->appId,
-                'Culture' => $this->culture,
-                'Content-Type' => $this->contentType,
-                'User-Agent' => $this->userAgent,
-            ];
-        }
-
-        // Initialize cURL connection
-        $this->_init();
-
-        return $this;
-    }
-
-    /**
-     * Perform a login request.
-     *
-     * @param string|null $username Username to use when logging in
-     * @param string|null $password Password to use for logging in
-     *
-     * @return MyQ
-     */
-    public function login($username = null, $password = null)
-    {
-        // Set username/password if not null
-        if (!is_null($username)) {
-            $this->username = $username;
-        }
-
-        if (!is_null($password)) {
-            $this->password = $password;
-        }
-
-        // confirm that we have a valid username/password
-        $error = [];
-        if (is_null($this->username)) {
-            $error[] = 'username';
-        }
-
-        if (is_null($this->password)) {
-            $error[] = 'password';
-        }
-
-        if (sizeof($error) > 0) {
-            throw new MyQException('Missing required auth credential: '.implode(',', $error));
-        }
-
-        $this->_login();
-    }
-
-    public function getState()
-    {
-        $this->_getDetails();
-        $timeInState = time() - $this->_doorStateTime;
-        echo implode(',', [
-            $this->_locationName,
-            $this->_doorName,
-            $this->_doorState,
-            (int) $timeInState,
-        ]);
-    }
-
-    public function getDetails()
-    {
-        return $this->_getDetails();
-    }
-
-    private function _init()
-    {
-        if (!isset($this->_conn)) {
-            $this->_conn = curl_init();
-
-            curl_setopt_array($this->_conn, [
-                CURLOPT_RETURNTRANSFER => true,
-                CURLOPT_ENCODING => '',
-                CURLOPT_MAXREDIRS => 10,
-                CURLOPT_TIMEOUT => 30,
-                CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
-                CURLOPT_FAILONERROR => true,
-                CURLOPT_FOLLOWLOCATION => true,
-                CURLOPT_FRESH_CONNECT => true,
-                CURLOPT_FORBID_REUSE => true,
-                CURLOPT_USERAGENT => $this->userAgent,
-            ]);
-        }
-
-        $this->_setHeaders();
-    }
-
-    private function _setHeaders()
-    {
-        $headers = [];
-
-        foreach ($this->_headers as $k => $v) {
-            $headers[] = "$k: $v";
-        }
-
-        curl_setopt($this->_conn, CURLOPT_HTTPHEADER, $headers);
-    }
-
-    private function _login()
-    {
-        $this->_init();
-
-        curl_setopt($this->_conn, CURLOPT_CUSTOMREQUEST, 'POST');
-        curl_setopt($this->_conn, CURLOPT_URL, $this->_loginUrl);
-
-        $post = json_encode(['username' => $this->username, 'password' => $this->password]);
-
-        curl_setopt($this->_conn, CURLOPT_POSTFIELDS, $post);
-
-        $output = curl_exec($this->_conn);
-
-        $data = json_decode($output);
-
-        if (false == $data || !isset($data->SecurityToken)) {
-            throw new MyQException("Error processing login request: $output");
-        }
-
-        $this->_headers['SecurityToken'] = $data->SecurityToken;
-
-        return $this;
-    }
-
-    private function _getDetails()
-    {
-        $this->_init();
-
-        curl_setopt($this->_conn, CURLOPT_CUSTOMREQUEST, 'GET');
-        curl_setopt($this->_conn, CURLOPT_URL, $this->_getDeviceDetailUrl);
-
-        $output = curl_exec($this->_conn);
-
-        $data = json_decode($output);
-
-        if (false == $data || !isset($data->Devices)) {
-            throw new MyQException("Error fetching device details: $output");
-        }
-
-        // Find our door device ID
-        foreach ($data->Devices as $device) {
-            if (false !== stripos($device->MyQDeviceTypeName, 'Gateway')) {
-                // Find location name
-                foreach ($device->Attributes as $attr) {
-                    if ('desc' == $attr->AttributeDisplayName) {
-                        $this->_locationName = $attr->Value;
-                    }
-                }
-            }
-
-            $this->_deviceId = $device->MyQDeviceId;
-
-            foreach ($device->Attributes as $attr) {
-                switch ($attr->AttributeDisplayName) {
-                    case 'desc':
-                        $this->_doorName = $attr->Value;
-                        break;
-                    case 'doorstate':
-                        $this->_doorState = $attr->Value;
-                        // UpdatedTime is a timestamp in ms, so we truncate
-                        $this->_doorStateTime = (int) $attr->UpdatedTime / 1000;
-                        break;
-                    default:
-                        continue;
-                }
-            }
-        }
-    }
+	/** @var string|null $username contains the username used to authenticate with the MyQ API */
+	protected $username = null;
+	/** @var string|null $password contains the password used to authenticate with the MyQ API */
+	protected $password = null;
+	/** @var string|null $appId is the application ID used to register with the MyQ API */
+	protected $appId = 'NWknvuBd7LoFHfXmKNMBcgajXtZEgKUh4V7WNzMidrpUUluDpVYVZx+xT4PCM5Kx';
+	//protected $appId = 'Vj8pQggXLhLy0WHahglCD4N1nAkkXQtGYpq2HrHD7H1nvmbT55KqtN6RSF4ILB%2fi';
+	/** @var string|null $securityToken is the auth token returned after a successful login */
+	protected $securityToken = null;
+	/** @var string|null $userAgent is the User-Agent header value sent with each API request */
+	protected $userAgent = 'Chamberlain/3.4.1';
+	/** @var string|null $culture is the API culture code for the API */
+	protected $culture = 'en';
+	/** @var string|null $contentType is the content type used for all cURL requests */
+	protected $contentType = 'application/json';
+	/** @var array $headers contain HTTP headers for cURL requests */
+	protected $_headers = [];
+	protected $_deviceId = null;
+	protected $_locationName = null;
+	protected $_doorName = null;
+	protected $_loginUrl = 'https://myqexternal.myqdevice.com/api/v4/User/Validate';
+	protected $_getDeviceDetailUrl = 'https://myqexternal.myqdevice.com/api/v4/userdevicedetails/get?&filterOn=true';
+	protected $_putDeviceStateUrl = '/api/v4/DeviceAttribute/PutDeviceAttribute';
+	/** @var resource|null $_conn is the web connection to the MyQ API */
+	protected $_conn = null;
+
+	/**
+	 * Initializes class. Optionally allows user to override variables.
+	 *
+	 * @param array $params A associative array for overwriting class variables
+	 *
+	 * @return MyQ
+	 */
+	public function __construct($params = [])
+	{
+		// Overwrite class variables
+		foreach ($params as $k => $v) {
+			$this->$k = $v;
+		}
+
+		// Initialize cURL request headers
+		if (0 == sizeof($this->_headers)) {
+			$this->_headers = [
+				'MyQApplicationId' => $this->appId,
+				'Culture' => $this->culture,
+				'Content-Type' => $this->contentType,
+				'User-Agent' => $this->userAgent,
+			];
+		}
+
+		// Initialize cURL connection
+		$this->_init();
+
+		return $this;
+	}
+
+	/**
+	 * Perform a login request.
+	 *
+	 * @param string|null $username Username to use when logging in
+	 * @param string|null $password Password to use for logging in
+	 *
+	 * @return MyQ
+	 */
+	public function login($username = null, $password = null)
+	{
+		// Set username/password if not null
+		if (!is_null($username)) {
+			$this->username = $username;
+		}
+
+		if (!is_null($password)) {
+			$this->password = $password;
+		}
+
+		// confirm that we have a valid username/password
+		$error = [];
+		if (is_null($this->username)) {
+			$error[] = 'username';
+		}
+
+		if (is_null($this->password)) {
+			$error[] = 'password';
+		}
+
+		if (sizeof($error) > 0) {
+			throw new MyQException('Missing required auth credential: '.implode(',', $error));
+		}
+
+		$this->_login();
+	}
+
+	public function getState()
+	{
+		$this->_getDetails();
+		$timeInState = time() - $this->_doorStateTime;
+		echo implode(',', [
+			$this->_locationName,
+			$this->_doorName,
+			$this->_doorState,
+			(int) $timeInState,
+		]);
+	}
+
+	public function getDetails()
+	{
+		return $this->_getDetails();
+	}
+
+	private function _init()
+	{
+		if (!isset($this->_conn)) {
+			$this->_conn = curl_init();
+
+			curl_setopt_array($this->_conn, [
+				CURLOPT_RETURNTRANSFER => true,
+				CURLOPT_ENCODING => '',
+				CURLOPT_MAXREDIRS => 10,
+				CURLOPT_TIMEOUT => 30,
+				CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
+				CURLOPT_FAILONERROR => true,
+				CURLOPT_FOLLOWLOCATION => true,
+				CURLOPT_FRESH_CONNECT => true,
+				CURLOPT_FORBID_REUSE => true,
+				CURLOPT_USERAGENT => $this->userAgent,
+			]);
+		}
+
+		$this->_setHeaders();
+	}
+
+	private function _setHeaders()
+	{
+		$headers = [];
+
+		foreach ($this->_headers as $k => $v) {
+			$headers[] = "$k: $v";
+		}
+
+		curl_setopt($this->_conn, CURLOPT_HTTPHEADER, $headers);
+	}
+
+	private function _login()
+	{
+		$this->_init();
+
+		curl_setopt($this->_conn, CURLOPT_CUSTOMREQUEST, 'POST');
+		curl_setopt($this->_conn, CURLOPT_URL, $this->_loginUrl);
+
+		$post = json_encode(['username' => $this->username, 'password' => $this->password]);
+
+		curl_setopt($this->_conn, CURLOPT_POSTFIELDS, $post);
+
+		$output = curl_exec($this->_conn);
+
+		$data = json_decode($output);
+
+		if (false == $data || !isset($data->SecurityToken)) {
+			throw new MyQException("Error processing login request: $output");
+		}
+
+		$this->_headers['SecurityToken'] = $data->SecurityToken;
+
+		return $this;
+	}
+
+	private function _getDetails()
+	{
+		$this->_init();
+
+		curl_setopt($this->_conn, CURLOPT_CUSTOMREQUEST, 'GET');
+		curl_setopt($this->_conn, CURLOPT_URL, $this->_getDeviceDetailUrl);
+
+		$output = curl_exec($this->_conn);
+
+		$data = json_decode($output);
+
+		if (false == $data || !isset($data->Devices)) {
+			throw new MyQException("Error fetching device details: $output");
+		}
+
+		// Find our door device ID
+		foreach ($data->Devices as $device) {
+			if (false !== stripos($device->MyQDeviceTypeName, 'Gateway')) {
+				// Find location name
+				foreach ($device->Attributes as $attr) {
+					if ('desc' == $attr->AttributeDisplayName) {
+						$this->_locationName = $attr->Value;
+					}
+				}
+			}
+
+			$this->_deviceId = $device->MyQDeviceId;
+
+			foreach ($device->Attributes as $attr) {
+				switch ($attr->AttributeDisplayName) {
+					case 'desc':
+						$this->_doorName = $attr->Value;
+						break;
+					case 'doorstate':
+						$this->_doorState = $attr->Value;
+						// UpdatedTime is a timestamp in ms, so we truncate
+						$this->_doorStateTime = (int) $attr->UpdatedTime / 1000;
+						break;
+					default:
+						continue;
+				}
+			}
+		}
+	}
 }

src/Route4Me/CurlHttpClient.php

Indentation +419 added lines, -419 removed lines

@@ -4,380 +4,380 @@ 
 
 class CurlHttpClient
 {
-    public $ch;
-    public $debug = false;
-    public $error_msg;
-
-    public function CurlHttpClient($debug = false)
-    {
-        $this->debug = $debug;
-        $this->init();
-    }
-
-    public function init()
-    {
-        // initialize curl handle
-        $this->ch = curl_init();
-        //set various options
-        //set error in case http return code bigger than 300
-        curl_setopt($this->ch, CURLOPT_FAILONERROR, true);
-        // use gzip if possible
-        curl_setopt($this->ch, CURLOPT_ENCODING, 'gzip, deflate');
-        // do not veryfy ssl
-        // this is important for windows
-        // as well for being able to access pages with non valid cert
-        curl_setopt($this->ch, CURLOPT_SSL_VERIFYPEER, 0);
-    }
-
-    /**
-     * Set username/pass for basic http auth.
-     *
-     * @param string user
-     * @param string pass
-     */
-    public function setCredentials($username, $password)
-    {
-        curl_setopt($this->ch, CURLOPT_USERPWD, "$username:$password");
-    }
-
-    /**
-     * Set referrer.
-     *
-     * @param string referrer url
-     */
-    public function setReferrer($referrer_url)
-    {
-        curl_setopt($this->ch, CURLOPT_REFERER, $referrer_url);
-    }
-
-    /**
-     * Set client's userAgent.
-     *
-     * @param string user agent
-     */
-    public function setUserAgent($userAgent)
-    {
-        curl_setopt($this->ch, CURLOPT_USERAGENT, $userAgent);
-    }
-
-    /**
-     * Set to receive output headers in all output functions.
-     *
-     * @param bool true to include all response headers with output, false otherwise
-     */
-    public function includeResponseHeaders($value)
-    {
-        curl_setopt($this->ch, CURLOPT_HEADER, $value);
-    }
-
-    /**
-     * Set proxy to use for each curl request.
-     *
-     * @param string proxy
-     */
-    public function setProxy($proxy)
-    {
-        curl_setopt($this->ch, CURLOPT_PROXY, $proxy);
-    }
-
-    /**
-     * Send post data to target URL
-     * return data returned from url or false if error occured.
-     *
-     * @param string url
-     * @param mixed post data (assoc array ie. $foo['post_var_name'] = $value or as string like var=val1&var2=val2)
-     * @param string ip address to bind (default null)
-     * @param int timeout in sec for complete curl operation (default 10)
-     *
-     * @return string data
-     */
-    public function sendPostData($url, $postdata, $ip = null, $timeout = 10)
-    {
-        //set various curl options first
-        // set url to post to
-        curl_setopt($this->ch, CURLOPT_URL, $url);
-        // return into a variable rather than displaying it
-        curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true);
-
-        //bind to specific ip address if it is sent trough arguments
-        if ($ip) {
-            if ($this->debug) {
-                echo "Binding to ip $ip\n";
-            }
-            curl_setopt($this->ch, CURLOPT_INTERFACE, $ip);
-        }
-
-        //set curl function timeout to $timeout
-        curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout);
-
-        //set method to post
-        curl_setopt($this->ch, CURLOPT_POST, true);
-        // set post string
-        curl_setopt($this->ch, CURLOPT_POSTFIELDS, $postdata);
-
-        //and finally send curl request
-        $result = curl_exec_redir($this->ch);
-        if (curl_errno($this->ch)) {
-            if ($this->debug) {
-                echo "Error Occured in Curl\n";
-                echo 'Error number: '.curl_errno($this->ch)."\n";
-                echo 'Error message: '.curl_error($this->ch)."\n";
-            }
-
-            return false;
-        } else {
-            return $result;
-        }
-    }
-
-    /**
-     * fetch data from target URL
-     * return data returned from url or false if error occured.
-     *
-     * @param string url
-     * @param string ip address to bind (default null)
-     * @param int timeout in sec for complete curl operation (default 5)
-     *
-     * @return string data
-     */
-    public function fetchUrl($url, $ip = null, $timeout = 5)
-    {
-        // set url to post to
-        curl_setopt($this->ch, CURLOPT_URL, $url);
-
-        //set method to get
-        curl_setopt($this->ch, CURLOPT_HTTPGET, true);
-        // return into a variable rather than displaying it
-        curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true);
-
-        //bind to specific ip address if it is sent trough arguments
-        if ($ip) {
-            if ($this->debug) {
-                echo "Binding to ip $ip\n";
-            }
-
-            curl_setopt($this->ch, CURLOPT_INTERFACE, $ip);
-        }
-
-        //set curl function timeout to $timeout
-        curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout);
-
-        //and finally send curl request
-        $result = curl_exec_redir($this->ch);
-        if (curl_errno($this->ch)) {
-            if ($this->debug) {
-                echo "Error Occured in Curl\n";
-                echo 'Error number: '.curl_errno($this->ch)."\n";
-                echo 'Error message: '.curl_error($this->ch)."\n";
-            }
-
-            return false;
-        } else {
-            return $result;
-        }
-    }
-
-    /**
-     * Fetch data from target URL
-     * and store it directly to file.
-     *
-     * @param string url
-     * @param resource value stream resource(ie. fopen)
-     * @param string ip address to bind (default null)
-     * @param int timeout in sec for complete curl operation (default 5)
-     *
-     * @return bool true on success false othervise
-     */
-    public function fetchIntoFile($url, $fp, $ip = null, $timeout = 5)
-    {
-        // set url to post to
-        curl_setopt($this->ch, CURLOPT_URL, $url);
-        //set method to get
-        curl_setopt($this->ch, CURLOPT_HTTPGET, true);
-        // store data into file rather than displaying it
-        curl_setopt($this->ch, CURLOPT_FILE, $fp);
-
-        //bind to specific ip address if it is sent trough arguments
-        if ($ip) {
-            if ($this->debug) {
-                echo "Binding to ip $ip\n";
-            }
-            curl_setopt($this->ch, CURLOPT_INTERFACE, $ip);
-        }
-
-        //set curl function timeout to $timeout
-        curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout);
-
-        //and finally send curl request
-        $result = curl_exec_redir($this->ch);
-        if (curl_errno($this->ch)) {
-            if ($this->debug) {
-                echo "Error Occured in Curl\n";
-                echo 'Error number: '.curl_errno($this->ch)."\n";
-                echo 'Error message: '.curl_error($this->ch)."\n";
-            }
-
-            return false;
-        } else {
-            return true;
-        }
-    }
-
-    /**
-     * Send multipart post data to the target URL
-     * return data returned from url or false if error occured
-     * (contribution by vule nikolic, vule@dinke.net).
-     *
-     * @param string url
-     * @param array assoc post data array ie. $foo['post_var_name'] = $value
-     * @param array assoc                     $file_field_array,    contains file_field name = value - path pairs
-     * @param string ip address to bind (default null)
-     * @param int timeout in sec for complete curl operation (default 30 sec)
-     *
-     * @return string data
-     */
-    public function sendMultipartPostData($url, $postdata, $file_field_array = [], $ip = null, $timeout = 30)
-    {
-        //set various curl options first
-        // set url to post to
-        curl_setopt($this->ch, CURLOPT_URL, $url);
-        // return into a variable rather than displaying it
-        curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true);
-
-        //bind to specific ip address if it is sent trough arguments
-        if ($ip) {
-            if ($this->debug) {
-                echo "Binding to ip $ip\n";
-            }
-
-            curl_setopt($this->ch, CURLOPT_INTERFACE, $ip);
-        }
-
-        //set curl function timeout to $timeout
-        curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout);
-        //set method to post
-        curl_setopt($this->ch, CURLOPT_POST, true);
-        // disable Expect header
-        // hack to make it working
-        $headers = ['Expect: '];
-        curl_setopt($this->ch, CURLOPT_HTTPHEADER, $headers);
-        // initialize result post array
-        $result_post = [];
-        //generate post string
-        $post_array = [];
-        $post_string_array = [];
-
-        if (!is_array($postdata)) {
-            return false;
-        }
-
-        foreach ($postdata as $key => $value) {
-            $post_array[$key] = $value;
-            $post_string_array[] = urlencode($key).'='.urlencode($value);
-        }
-
-        $post_string = implode('&', $post_string_array);
-        if ($this->debug) {
-            echo "Post String: $post_string\n";
-        }
-
-        // set post string
-        //curl_setopt($this->ch, CURLOPT_POSTFIELDS, $post_string);
-        // set multipart form data - file array field-value pairs
-        if (!empty($file_field_array)) {
-            foreach ($file_field_array as $var_name => $var_value) {
-                if (false !== strpos(PHP_OS, 'WIN')) {
-                    $var_value = str_replace('/', '\\', $var_value);
-                } // win hack
-                $file_field_array[$var_name] = '@'.$var_value;
-            }
-        }
-
-        // set post data
-        $result_post = array_merge($post_array, $file_field_array);
-        curl_setopt($this->ch, CURLOPT_POSTFIELDS, $result_post);
-
-        //and finally send curl request
-        $result = curl_exec_redir($this->ch);
-        if (curl_errno($this->ch)) {
-            if ($this->debug) {
-                echo "Error Occured in Curl\n";
-                echo 'Error number: '.curl_errno($this->ch)."\n";
-                echo 'Error message: '.curl_error($this->ch)."\n";
-            }
-
-            return false;
-        } else {
-            return $result;
-        }
-    }
-
-    /**
-     * Set file location where cookie data will be stored and send on each new request.
-     *
-     * @param string absolute path to cookie file (must be in writable dir)
-     */
-    public function storeCookies($cookie_file)
-    {
-        // use cookies on each request (cookies stored in $cookie_file)
-        curl_setopt($this->ch, CURLOPT_COOKIEJAR, $cookie_file);
-        curl_setopt($this->ch, CURLOPT_COOKIEFILE, $cookie_file);
-    }
-
-    /**
-     * Set custom cookie.
-     *
-     * @param string cookie
-     */
-    public function setCookie($cookie)
-    {
-        curl_setopt($this->ch, CURLOPT_COOKIE, $cookie);
-    }
-
-    /**
-     * Get last URL info
-     * usefull when original url was redirected to other location.
-     *
-     * @return string url
-     */
-    public function getEffectiveUrl()
-    {
-        return curl_getinfo($this->ch, CURLINFO_EFFECTIVE_URL);
-    }
-
-    /**
-     * Get http response code.
-     *
-     * @return int
-     */
-    public function getHttpResponseCode()
-    {
-        return curl_getinfo($this->ch, CURLINFO_HTTP_CODE);
-    }
-
-    /**
-     * Return last error message and error number.
-     *
-     * @return string error msg
-     */
-    public function getErrorMsg()
-    {
-        $err = 'Error number: '.curl_errno($this->ch)."\n";
-        $err .= 'Error message: '.curl_error($this->ch)."\n";
-
-        return $err;
-    }
-
-    /**
-     * Close curl session and free resource
-     * Usually no need to call this function directly
-     * in case you do you have to call init() to recreate curl.
-     */
-    public function close()
-    {
-        //close curl session and free up resources
-        curl_close($this->ch);
-    }
+	public $ch;
+	public $debug = false;
+	public $error_msg;
+
+	public function CurlHttpClient($debug = false)
+	{
+		$this->debug = $debug;
+		$this->init();
+	}
+
+	public function init()
+	{
+		// initialize curl handle
+		$this->ch = curl_init();
+		//set various options
+		//set error in case http return code bigger than 300
+		curl_setopt($this->ch, CURLOPT_FAILONERROR, true);
+		// use gzip if possible
+		curl_setopt($this->ch, CURLOPT_ENCODING, 'gzip, deflate');
+		// do not veryfy ssl
+		// this is important for windows
+		// as well for being able to access pages with non valid cert
+		curl_setopt($this->ch, CURLOPT_SSL_VERIFYPEER, 0);
+	}
+
+	/**
+	 * Set username/pass for basic http auth.
+	 *
+	 * @param string user
+	 * @param string pass
+	 */
+	public function setCredentials($username, $password)
+	{
+		curl_setopt($this->ch, CURLOPT_USERPWD, "$username:$password");
+	}
+
+	/**
+	 * Set referrer.
+	 *
+	 * @param string referrer url
+	 */
+	public function setReferrer($referrer_url)
+	{
+		curl_setopt($this->ch, CURLOPT_REFERER, $referrer_url);
+	}
+
+	/**
+	 * Set client's userAgent.
+	 *
+	 * @param string user agent
+	 */
+	public function setUserAgent($userAgent)
+	{
+		curl_setopt($this->ch, CURLOPT_USERAGENT, $userAgent);
+	}
+
+	/**
+	 * Set to receive output headers in all output functions.
+	 *
+	 * @param bool true to include all response headers with output, false otherwise
+	 */
+	public function includeResponseHeaders($value)
+	{
+		curl_setopt($this->ch, CURLOPT_HEADER, $value);
+	}
+
+	/**
+	 * Set proxy to use for each curl request.
+	 *
+	 * @param string proxy
+	 */
+	public function setProxy($proxy)
+	{
+		curl_setopt($this->ch, CURLOPT_PROXY, $proxy);
+	}
+
+	/**
+	 * Send post data to target URL
+	 * return data returned from url or false if error occured.
+	 *
+	 * @param string url
+	 * @param mixed post data (assoc array ie. $foo['post_var_name'] = $value or as string like var=val1&var2=val2)
+	 * @param string ip address to bind (default null)
+	 * @param int timeout in sec for complete curl operation (default 10)
+	 *
+	 * @return string data
+	 */
+	public function sendPostData($url, $postdata, $ip = null, $timeout = 10)
+	{
+		//set various curl options first
+		// set url to post to
+		curl_setopt($this->ch, CURLOPT_URL, $url);
+		// return into a variable rather than displaying it
+		curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true);
+
+		//bind to specific ip address if it is sent trough arguments
+		if ($ip) {
+			if ($this->debug) {
+				echo "Binding to ip $ip\n";
+			}
+			curl_setopt($this->ch, CURLOPT_INTERFACE, $ip);
+		}
+
+		//set curl function timeout to $timeout
+		curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout);
+
+		//set method to post
+		curl_setopt($this->ch, CURLOPT_POST, true);
+		// set post string
+		curl_setopt($this->ch, CURLOPT_POSTFIELDS, $postdata);
+
+		//and finally send curl request
+		$result = curl_exec_redir($this->ch);
+		if (curl_errno($this->ch)) {
+			if ($this->debug) {
+				echo "Error Occured in Curl\n";
+				echo 'Error number: '.curl_errno($this->ch)."\n";
+				echo 'Error message: '.curl_error($this->ch)."\n";
+			}
+
+			return false;
+		} else {
+			return $result;
+		}
+	}
+
+	/**
+	 * fetch data from target URL
+	 * return data returned from url or false if error occured.
+	 *
+	 * @param string url
+	 * @param string ip address to bind (default null)
+	 * @param int timeout in sec for complete curl operation (default 5)
+	 *
+	 * @return string data
+	 */
+	public function fetchUrl($url, $ip = null, $timeout = 5)
+	{
+		// set url to post to
+		curl_setopt($this->ch, CURLOPT_URL, $url);
+
+		//set method to get
+		curl_setopt($this->ch, CURLOPT_HTTPGET, true);
+		// return into a variable rather than displaying it
+		curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true);
+
+		//bind to specific ip address if it is sent trough arguments
+		if ($ip) {
+			if ($this->debug) {
+				echo "Binding to ip $ip\n";
+			}
+
+			curl_setopt($this->ch, CURLOPT_INTERFACE, $ip);
+		}
+
+		//set curl function timeout to $timeout
+		curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout);
+
+		//and finally send curl request
+		$result = curl_exec_redir($this->ch);
+		if (curl_errno($this->ch)) {
+			if ($this->debug) {
+				echo "Error Occured in Curl\n";
+				echo 'Error number: '.curl_errno($this->ch)."\n";
+				echo 'Error message: '.curl_error($this->ch)."\n";
+			}
+
+			return false;
+		} else {
+			return $result;
+		}
+	}
+
+	/**
+	 * Fetch data from target URL
+	 * and store it directly to file.
+	 *
+	 * @param string url
+	 * @param resource value stream resource(ie. fopen)
+	 * @param string ip address to bind (default null)
+	 * @param int timeout in sec for complete curl operation (default 5)
+	 *
+	 * @return bool true on success false othervise
+	 */
+	public function fetchIntoFile($url, $fp, $ip = null, $timeout = 5)
+	{
+		// set url to post to
+		curl_setopt($this->ch, CURLOPT_URL, $url);
+		//set method to get
+		curl_setopt($this->ch, CURLOPT_HTTPGET, true);
+		// store data into file rather than displaying it
+		curl_setopt($this->ch, CURLOPT_FILE, $fp);
+
+		//bind to specific ip address if it is sent trough arguments
+		if ($ip) {
+			if ($this->debug) {
+				echo "Binding to ip $ip\n";
+			}
+			curl_setopt($this->ch, CURLOPT_INTERFACE, $ip);
+		}
+
+		//set curl function timeout to $timeout
+		curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout);
+
+		//and finally send curl request
+		$result = curl_exec_redir($this->ch);
+		if (curl_errno($this->ch)) {
+			if ($this->debug) {
+				echo "Error Occured in Curl\n";
+				echo 'Error number: '.curl_errno($this->ch)."\n";
+				echo 'Error message: '.curl_error($this->ch)."\n";
+			}
+
+			return false;
+		} else {
+			return true;
+		}
+	}
+
+	/**
+	 * Send multipart post data to the target URL
+	 * return data returned from url or false if error occured
+	 * (contribution by vule nikolic, vule@dinke.net).
+	 *
+	 * @param string url
+	 * @param array assoc post data array ie. $foo['post_var_name'] = $value
+	 * @param array assoc                     $file_field_array,    contains file_field name = value - path pairs
+	 * @param string ip address to bind (default null)
+	 * @param int timeout in sec for complete curl operation (default 30 sec)
+	 *
+	 * @return string data
+	 */
+	public function sendMultipartPostData($url, $postdata, $file_field_array = [], $ip = null, $timeout = 30)
+	{
+		//set various curl options first
+		// set url to post to
+		curl_setopt($this->ch, CURLOPT_URL, $url);
+		// return into a variable rather than displaying it
+		curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true);
+
+		//bind to specific ip address if it is sent trough arguments
+		if ($ip) {
+			if ($this->debug) {
+				echo "Binding to ip $ip\n";
+			}
+
+			curl_setopt($this->ch, CURLOPT_INTERFACE, $ip);
+		}
+
+		//set curl function timeout to $timeout
+		curl_setopt($this->ch, CURLOPT_TIMEOUT, $timeout);
+		//set method to post
+		curl_setopt($this->ch, CURLOPT_POST, true);
+		// disable Expect header
+		// hack to make it working
+		$headers = ['Expect: '];
+		curl_setopt($this->ch, CURLOPT_HTTPHEADER, $headers);
+		// initialize result post array
+		$result_post = [];
+		//generate post string
+		$post_array = [];
+		$post_string_array = [];
+
+		if (!is_array($postdata)) {
+			return false;
+		}
+
+		foreach ($postdata as $key => $value) {
+			$post_array[$key] = $value;
+			$post_string_array[] = urlencode($key).'='.urlencode($value);
+		}
+
+		$post_string = implode('&', $post_string_array);
+		if ($this->debug) {
+			echo "Post String: $post_string\n";
+		}
+
+		// set post string
+		//curl_setopt($this->ch, CURLOPT_POSTFIELDS, $post_string);
+		// set multipart form data - file array field-value pairs
+		if (!empty($file_field_array)) {
+			foreach ($file_field_array as $var_name => $var_value) {
+				if (false !== strpos(PHP_OS, 'WIN')) {
+					$var_value = str_replace('/', '\\', $var_value);
+				} // win hack
+				$file_field_array[$var_name] = '@'.$var_value;
+			}
+		}
+
+		// set post data
+		$result_post = array_merge($post_array, $file_field_array);
+		curl_setopt($this->ch, CURLOPT_POSTFIELDS, $result_post);
+
+		//and finally send curl request
+		$result = curl_exec_redir($this->ch);
+		if (curl_errno($this->ch)) {
+			if ($this->debug) {
+				echo "Error Occured in Curl\n";
+				echo 'Error number: '.curl_errno($this->ch)."\n";
+				echo 'Error message: '.curl_error($this->ch)."\n";
+			}
+
+			return false;
+		} else {
+			return $result;
+		}
+	}
+
+	/**
+	 * Set file location where cookie data will be stored and send on each new request.
+	 *
+	 * @param string absolute path to cookie file (must be in writable dir)
+	 */
+	public function storeCookies($cookie_file)
+	{
+		// use cookies on each request (cookies stored in $cookie_file)
+		curl_setopt($this->ch, CURLOPT_COOKIEJAR, $cookie_file);
+		curl_setopt($this->ch, CURLOPT_COOKIEFILE, $cookie_file);
+	}
+
+	/**
+	 * Set custom cookie.
+	 *
+	 * @param string cookie
+	 */
+	public function setCookie($cookie)
+	{
+		curl_setopt($this->ch, CURLOPT_COOKIE, $cookie);
+	}
+
+	/**
+	 * Get last URL info
+	 * usefull when original url was redirected to other location.
+	 *
+	 * @return string url
+	 */
+	public function getEffectiveUrl()
+	{
+		return curl_getinfo($this->ch, CURLINFO_EFFECTIVE_URL);
+	}
+
+	/**
+	 * Get http response code.
+	 *
+	 * @return int
+	 */
+	public function getHttpResponseCode()
+	{
+		return curl_getinfo($this->ch, CURLINFO_HTTP_CODE);
+	}
+
+	/**
+	 * Return last error message and error number.
+	 *
+	 * @return string error msg
+	 */
+	public function getErrorMsg()
+	{
+		$err = 'Error number: '.curl_errno($this->ch)."\n";
+		$err .= 'Error message: '.curl_error($this->ch)."\n";
+
+		return $err;
+	}
+
+	/**
+	 * Close curl session and free resource
+	 * Usually no need to call this function directly
+	 * in case you do you have to call init() to recreate curl.
+	 */
+	public function close()
+	{
+		//close curl session and free up resources
+		curl_close($this->ch);
+	}
 }
 
 /**
@@ -386,63 +386,63 @@ 
  */
 function curlExecRedir($ch)
 {
-    static $curl_loops = 0;
-    static $curl_max_loops = 20;
+	static $curl_loops = 0;
+	static $curl_max_loops = 20;
 
-    if ($curl_loops++ >= $curl_max_loops) {
-        $curl_loops = 0;
+	if ($curl_loops++ >= $curl_max_loops) {
+		$curl_loops = 0;
 
-        return false;
-    }
+		return false;
+	}
 
-    curl_setopt($ch, CURLOPT_HTTPHEADER, ['Expect:']);
-    curl_setopt($ch, CURLOPT_HEADER, true);
-    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-    curl_setopt($ch, CURLOPT_VERBOSE, false);
-    $data = curl_exec($ch);
-    $data = str_replace("\r", "\n", str_replace("\r\n", "\n", $data));
-    list($header, $data) = explode("\n\n", $data, 2);
-    $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
+	curl_setopt($ch, CURLOPT_HTTPHEADER, ['Expect:']);
+	curl_setopt($ch, CURLOPT_HEADER, true);
+	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+	curl_setopt($ch, CURLOPT_VERBOSE, false);
+	$data = curl_exec($ch);
+	$data = str_replace("\r", "\n", str_replace("\r\n", "\n", $data));
+	list($header, $data) = explode("\n\n", $data, 2);
+	$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
 
-    //echo "*** Got HTTP code: $http_code ***\n";
-    //echo "**  Got headers: \n$header\n\n";
+	//echo "*** Got HTTP code: $http_code ***\n";
+	//echo "**  Got headers: \n$header\n\n";
 
-    if (301 == $http_code || 302 == $http_code) {
-        // If we're redirected, we should revert to GET
-        curl_setopt($ch, CURLOPT_HTTPGET, true);
+	if (301 == $http_code || 302 == $http_code) {
+		// If we're redirected, we should revert to GET
+		curl_setopt($ch, CURLOPT_HTTPGET, true);
 
-        $matches = [];
-        preg_match('/Location:\s*(.*?)(\n|$)/i', $header, $matches);
-        $url = @parse_url(trim($matches[1]));
+		$matches = [];
+		preg_match('/Location:\s*(.*?)(\n|$)/i', $header, $matches);
+		$url = @parse_url(trim($matches[1]));
 
-        if (!$url) {
-            //couldn't process the url to redirect to
-            $curl_loops = 0;
+		if (!$url) {
+			//couldn't process the url to redirect to
+			$curl_loops = 0;
 
-            return $data;
-        }
+			return $data;
+		}
 
-        $last_url = parse_url(curl_getinfo($ch, CURLINFO_EFFECTIVE_URL));
-        if (empty($url['scheme'])) {
-            $url['scheme'] = $last_url['scheme'];
-        }
+		$last_url = parse_url(curl_getinfo($ch, CURLINFO_EFFECTIVE_URL));
+		if (empty($url['scheme'])) {
+			$url['scheme'] = $last_url['scheme'];
+		}
 
-        if (empty($url['host'])) {
-            $url['host'] = $last_url['host'];
-        }
+		if (empty($url['host'])) {
+			$url['host'] = $last_url['host'];
+		}
 
-        if (empty($url['path'])) {
-            $url['path'] = $last_url['path'];
-        }
+		if (empty($url['path'])) {
+			$url['path'] = $last_url['path'];
+		}
 
-        $new_url = $url['scheme'].'://'.$url['host'].$url['path'].(!empty($url['query']) ? '?'.$url['query'] : '');
-        //echo "Being redirected to $new_url\n";
-        curl_setopt($ch, CURLOPT_URL, $new_url);
+		$new_url = $url['scheme'].'://'.$url['host'].$url['path'].(!empty($url['query']) ? '?'.$url['query'] : '');
+		//echo "Being redirected to $new_url\n";
+		curl_setopt($ch, CURLOPT_URL, $new_url);
 
-        return curl_exec_redir($ch);
-    } else {
-        $curl_loops = 0;
+		return curl_exec_redir($ch);
+	} else {
+		$curl_loops = 0;
 
-        return $data;
-    }
+		return $data;
+	}
 }

src/Route4Me/Members/MemberAuthenticationResponse.php

Indentation +190 added lines, -190 removed lines

@@ -10,194 +10,194 @@
  */
 class MemberAuthenticationResponse extends \Route4Me\Common
 {
-    /** @var boolean $status
-     * True, if authentication process was finished successfuly.
-     */
-    public $status;
-
-    /** @var string $geocoding_service
-     * Geocoding service
-     */
-    public $geocoding_service;
-
-    /** @var int $session_id
-     * Session ID
-     */
-    public $session_id;
-
-    /** @var string $session_guid
-     * Session guid
-     */
-    public $session_guid;
-
-    /** @var int $member_id
-     * Member ID
-     */
-    public $member_id;
-
-    /** @var string $api_key
-     * API key of an user
-     */
-    public $api_key;
-
-    /** @var int $tracking_ttl
-     * Tracking TTL
-     */
-    public $tracking_ttl;
-
-    /** @var string $update_channel_name
-     * Update channel name
-     */
-    public $update_channel_name;
-
-    /** @var string $geofence_polygon_shape
-     * Geofence polygon shape. ENUM('circle', 'poly', 'rect').
-     */
-    public $geofence_polygon_shape ;
-
-    /** @var int $geofence_polygon_size
-     * Geofence polygon size
-     */
-    public $geofence_polygon_size;
-
-    /** @var int $geofence_time_onsite_trigger_secs
-     * Geofence time onsite trigger in seconds.
-     */
-    public $geofence_time_onsite_trigger_secs;
-
-    /** @var int $geofence_minimum_trigger_speed
-     * Geofence minimum trigger speed.
-     */
-    public $geofence_minimum_trigger_speed;
-
-    /** @var boolean $is_subscription_past_due
-     * If true, subscription is past due.
-     */
-    public $is_subscription_past_due;
-
-    /** @var string $visited_departed_enabled
-     * if true, triggering of the visited and departed activities is enabled.
-     */
-    public $visited_departed_enabled;
-
-    /** @var string $long_press_enabled
-     * if true, long press is enabled.
-     */
-    public $long_press_enabled;
-
-    /** @var string $account_type_id
-     * The account type ID
-     */
-    public $account_type_id;
-
-    /** @var string $account_type_alias
-     * Account type alias.
-     */
-    public $account_type_alias;
-
-    /** @var string $member_type
-     * A type of the member.
-     * Available values:
-     * 'PRIMARY_ACCOUNT',
-     * 'SUB_ACCOUNT_ADMIN',
-     * 'SUB_ACCOUNT_REGIONAL_MANAGER',
-     * 'SUB_ACCOUNT_DISPATCHER',
-     * 'SUB_ACCOUNT_PLANNER',
-     * 'SUB_ACCOUNT_DRIVER',
-     * 'SUB_ACCOUNT_ANALYST',
-     * 'SUB_ACCOUNT_VENDOR',
-     * 'SUB_ACCOUNT_CUSTOMER_SERVICE'
-     */
-    public $member_type;
-
-    /** @var string $max_stops_per_route
-     * Maximum stops per route.
-     */
-    public $max_stops_per_route;
-
-    /** @var string $max_routes
-     * Maximum number of the routes.
-     */
-    public $max_routes;
-
-    /** @var int $routes_planned
-     * Number of the planned routes by an user.
-     */
-    public $routes_planned;
-
-    /** @var string $preferred_units
-     * Preferred units. Enum('km', 'mi').
-     */
-    public $preferred_units;
-
-    /** @var string $preferred_language
-     * Preferred language. Enum('en', 'fr').
-     */
-    public $preferred_language;
-
-    /** @var string $HIDE_ROUTED_ADDRESSES
-     * If true, routed addresses will be hidden.
-     */
-    public $HIDE_ROUTED_ADDRESSES;
-
-    /** @var string $HIDE_VISITED_ADDRESSES
-     * If true, visited addresses will be hidden.
-     */
-    public $HIDE_VISITED_ADDRESSES;
-
-    /** @var string $HIDE_NONFUTURE_ROUTES
-     * If equal to true, nonfuture addresses will be hidden.
-     */
-    public $HIDE_NONFUTURE_ROUTES;
-
-    /** @var string $READONLY_USER
-     * If equal to true, user can only read data.
-     */
-    public $READONLY_USER;
-
-    /** @var int $auto_logout_ts
-     * Time in seconds. If a user is inactive during this period, he will be logout.
-     */
-    public $auto_logout_ts;
-
-    /** @var string $last_known_member_payment_device
-     * Last known member payment device (e.g. 'web')
-     */
-    public $last_known_member_payment_device;
-
-    /** @var int $account_expires_timestamp
-     * Account expire date
-     */
-    public $account_expires_timestamp;
-
-    /** @var boolean $account_past_due
-     * Account past due
-     */
-    public $account_past_due;
-
-    /** @var array  $licensed_modules
-     * Licensed module. e.g.:
-     * 'MODULE__ROUTE_EDITOR_CUSTOM_DATA_EDITING',
-     * 'MODULE__VOICE_NAVIGATION:TRUE',
-     * 'MODULE__VOICE_NAVIGATION'
-     */
-    public $licensed_modules;
-
-    /** @var int $last_active_timestamp
-     * Last active timestamp
-     */
-    public $last_active_timestamp;
-
-    public static function fromArray(array $params)
-    {
-        $memberAurhenticateResponse = new self();
-
-        foreach ($params as $key => $value) {
-            if (property_exists($memberAurhenticateResponse, $key)) {
-                $memberAurhenticateResponse->{$key} = $value;
-            }
-        }
-
-        return $memberAurhenticateResponse;
-    }
+	/** @var boolean $status
+	 * True, if authentication process was finished successfuly.
+	 */
+	public $status;
+
+	/** @var string $geocoding_service
+	 * Geocoding service
+	 */
+	public $geocoding_service;
+
+	/** @var int $session_id
+	 * Session ID
+	 */
+	public $session_id;
+
+	/** @var string $session_guid
+	 * Session guid
+	 */
+	public $session_guid;
+
+	/** @var int $member_id
+	 * Member ID
+	 */
+	public $member_id;
+
+	/** @var string $api_key
+	 * API key of an user
+	 */
+	public $api_key;
+
+	/** @var int $tracking_ttl
+	 * Tracking TTL
+	 */
+	public $tracking_ttl;
+
+	/** @var string $update_channel_name
+	 * Update channel name
+	 */
+	public $update_channel_name;
+
+	/** @var string $geofence_polygon_shape
+	 * Geofence polygon shape. ENUM('circle', 'poly', 'rect').
+	 */
+	public $geofence_polygon_shape ;
+
+	/** @var int $geofence_polygon_size
+	 * Geofence polygon size
+	 */
+	public $geofence_polygon_size;
+
+	/** @var int $geofence_time_onsite_trigger_secs
+	 * Geofence time onsite trigger in seconds.
+	 */
+	public $geofence_time_onsite_trigger_secs;
+
+	/** @var int $geofence_minimum_trigger_speed
+	 * Geofence minimum trigger speed.
+	 */
+	public $geofence_minimum_trigger_speed;
+
+	/** @var boolean $is_subscription_past_due
+	 * If true, subscription is past due.
+	 */
+	public $is_subscription_past_due;
+
+	/** @var string $visited_departed_enabled
+	 * if true, triggering of the visited and departed activities is enabled.
+	 */
+	public $visited_departed_enabled;
+
+	/** @var string $long_press_enabled
+	 * if true, long press is enabled.
+	 */
+	public $long_press_enabled;
+
+	/** @var string $account_type_id
+	 * The account type ID
+	 */
+	public $account_type_id;
+
+	/** @var string $account_type_alias
+	 * Account type alias.
+	 */
+	public $account_type_alias;
+
+	/** @var string $member_type
+	 * A type of the member.
+	 * Available values:
+	 * 'PRIMARY_ACCOUNT',
+	 * 'SUB_ACCOUNT_ADMIN',
+	 * 'SUB_ACCOUNT_REGIONAL_MANAGER',
+	 * 'SUB_ACCOUNT_DISPATCHER',
+	 * 'SUB_ACCOUNT_PLANNER',
+	 * 'SUB_ACCOUNT_DRIVER',
+	 * 'SUB_ACCOUNT_ANALYST',
+	 * 'SUB_ACCOUNT_VENDOR',
+	 * 'SUB_ACCOUNT_CUSTOMER_SERVICE'
+	 */
+	public $member_type;
+
+	/** @var string $max_stops_per_route
+	 * Maximum stops per route.
+	 */
+	public $max_stops_per_route;
+
+	/** @var string $max_routes
+	 * Maximum number of the routes.
+	 */
+	public $max_routes;
+
+	/** @var int $routes_planned
+	 * Number of the planned routes by an user.
+	 */
+	public $routes_planned;
+
+	/** @var string $preferred_units
+	 * Preferred units. Enum('km', 'mi').
+	 */
+	public $preferred_units;
+
+	/** @var string $preferred_language
+	 * Preferred language. Enum('en', 'fr').
+	 */
+	public $preferred_language;
+
+	/** @var string $HIDE_ROUTED_ADDRESSES
+	 * If true, routed addresses will be hidden.
+	 */
+	public $HIDE_ROUTED_ADDRESSES;
+
+	/** @var string $HIDE_VISITED_ADDRESSES
+	 * If true, visited addresses will be hidden.
+	 */
+	public $HIDE_VISITED_ADDRESSES;
+
+	/** @var string $HIDE_NONFUTURE_ROUTES
+	 * If equal to true, nonfuture addresses will be hidden.
+	 */
+	public $HIDE_NONFUTURE_ROUTES;
+
+	/** @var string $READONLY_USER
+	 * If equal to true, user can only read data.
+	 */
+	public $READONLY_USER;
+
+	/** @var int $auto_logout_ts
+	 * Time in seconds. If a user is inactive during this period, he will be logout.
+	 */
+	public $auto_logout_ts;
+
+	/** @var string $last_known_member_payment_device
+	 * Last known member payment device (e.g. 'web')
+	 */
+	public $last_known_member_payment_device;
+
+	/** @var int $account_expires_timestamp
+	 * Account expire date
+	 */
+	public $account_expires_timestamp;
+
+	/** @var boolean $account_past_due
+	 * Account past due
+	 */
+	public $account_past_due;
+
+	/** @var array  $licensed_modules
+	 * Licensed module. e.g.:
+	 * 'MODULE__ROUTE_EDITOR_CUSTOM_DATA_EDITING',
+	 * 'MODULE__VOICE_NAVIGATION:TRUE',
+	 * 'MODULE__VOICE_NAVIGATION'
+	 */
+	public $licensed_modules;
+
+	/** @var int $last_active_timestamp
+	 * Last active timestamp
+	 */
+	public $last_active_timestamp;
+
+	public static function fromArray(array $params)
+	{
+		$memberAurhenticateResponse = new self();
+
+		foreach ($params as $key => $value) {
+			if (property_exists($memberAurhenticateResponse, $key)) {
+				$memberAurhenticateResponse->{$key} = $value;
+			}
+		}
+
+		return $memberAurhenticateResponse;
+	}
 }
\ No newline at end of file