route4me / route4me-php-sdk

examples/Order/NewOrderWithCustomType.php

Indentation +7 added lines, -7 removed lines

@@ -14,13 +14,13 @@
 Route4Me::setApiKey(Constants::API_KEY);
 
 $orderParameters = Order::fromArray([
-    'address_1' => '1358 E Luzerne St, Philadelphia, PA 19124, US',
-    'cached_lat' => 48.335991,
-    'cached_lng' => 31.18287,
-    'address_alias' => 'Auto test address',
-    'address_city' => 'Philadelphia',
-    'day_scheduled_for_YYMMDD' => date('Y-m-d'),
-    'address_stop_type' => AddressType::VISIT,
+	'address_1' => '1358 E Luzerne St, Philadelphia, PA 19124, US',
+	'cached_lat' => 48.335991,
+	'cached_lng' => 31.18287,
+	'address_alias' => 'Auto test address',
+	'address_city' => 'Philadelphia',
+	'day_scheduled_for_YYMMDD' => date('Y-m-d'),
+	'address_stop_type' => AddressType::VISIT,
 ]);
 
 $order = new Order();

Spacing +2 added lines, -2 removed lines

@@ -4,8 +4,8 @@
 
 use Route4Me\Enum\AddressType;
 
-$root = realpath(dirname(__FILE__) . '/../../');
-require $root . '/vendor/autoload.php';
+$root = realpath(dirname(__FILE__).'/../../');
+require $root.'/vendor/autoload.php';
 
 // Example refers to creating a new Order.
 

src/Route4Me/Enum/AddressType.php

Indentation +7 added lines, -7 removed lines

@@ -4,11 +4,11 @@
 
 class AddressType
 {
-    const PICKUP = 'PICKUP';
-    const DELIVERY = 'DELIVERY';
-    const BREAK = 'BREAK';
-    const MEETUP = 'MEETUP';
-    const VISIT = 'VISIT';
-    const SERVICE = 'SERVICE';
-    const DRIVEBY = 'DRIVEBY';
+	const PICKUP = 'PICKUP';
+	const DELIVERY = 'DELIVERY';
+	const BREAK = 'BREAK';
+	const MEETUP = 'MEETUP';
+	const VISIT = 'VISIT';
+	const SERVICE = 'SERVICE';
+	const DRIVEBY = 'DRIVEBY';
 }
\ No newline at end of file

src/Route4Me/Order.php

Indentation +343 added lines, -343 removed lines

@@ -6,351 +6,351 @@
 
 class Order extends Common
 {
-    public $address_1;
-    public $address_2;
-    public $cached_lat;
-    public $cached_lng;
-    public $curbside_lat;
-    public $curbside_lng;
-    public $address_alias;
-    public $address_city;
-    public $EXT_FIELD_first_name;
-    public $EXT_FIELD_last_name;
-    public $EXT_FIELD_email;
-    public $EXT_FIELD_phone;
-    public $EXT_FIELD_custom_data;
-
-    public $color;
-    public $order_icon;
-    public $local_time_window_start;
-    public $local_time_window_end;
-    public $local_time_window_start_2;
-    public $local_time_window_end_2;
-    public $service_time;
-
-    public $day_scheduled_for_YYMMDD;
-
-    public $route_id;
-    public $redirect;
-    public $optimization_problem_id;
-    public $order_id;
-    public $order_uuid;
-    public $order_ids;
-
-    public $day_added_YYMMDD;
-    public $scheduled_for_YYMMDD;
-    public $fields;
-    public $offset;
-    public $limit;
-    public $query;
-
-    public $created_timestamp;
-    public $order_status_id;
-    public $member_id;
-    public $address_state_id;
-    public $address_country_id;
-    public $address_zip;
-    public $in_route_count;
-    public $last_visited_timestamp;
-    public $last_routed_timestamp;
-    public $local_timezone_string;
-    public $is_validated;
-    public $is_pending;
-    public $is_accepted;
-    public $is_started;
-    public $is_completed;
-    public $custom_user_fields;
-
-    public $address_stop_type = \Route4Me\Enum\AddressType::DELIVERY;
-
-    public $addresses = [];
-
-    /**
-     * Weight of the order.
-     * @since 1.2.11
-     */
-    public $EXT_FIELD_weight;
-
-    /**
-     * Cost of the order.
-     * @since 1.2.11
-     */
-    public $EXT_FIELD_cost;
-
-    /**
-     * The total revenue for the order.
-     * @since 1.2.11
-     */
-    public $EXT_FIELD_revenue;
-
-    /**
-     * The cubic volume of the cargo.
-     * @since 1.2.11
-     */
-    public $EXT_FIELD_cube;
-
-    /**
-     *The item quantity of the cargo.
-     * @since 1.2.11
-     */
-    public $EXT_FIELD_pieces;
-
-    public function __construct()
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
-    }
-
-    /**
-     * @param Order $params
-     */
-    public static function addOrder($params)
-    {
-        $excludeFields = ['route_id', 'redirect', 'optimization_problem_id', 'order_id',
-            'order_ids', 'fields', 'offset', 'limit', 'query', 'created_timestamp', 'order_uuid'];
-
-        $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ORDER_V4,
-            'method'    => 'POST',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function addOrder2Route($params)
-    {
-        $allQueryFields = ['route_id', 'redirect'];
-        $allBodyFields = ['addresses'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ROUTE_V4,
-            'method'    => 'PUT',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function addOrder2Optimization($params)
-    {
-        $allQueryFields = ['optimization_problem_id', 'redirect', 'device_type'];
-        $allBodyFields  = ['addresses'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::OPTIMIZATION_PROBLEM,
-            'method'    => 'PUT',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function getOrder($params)
-    {
-        $allQueryFields = ['order_id', 'fields', 'day_added_YYMMDD', 'scheduled_for_YYMMDD', 'query',
-            'offset', 'limit'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ORDER_V4,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function getOrders($params)
-    {
-        $allQueryFields = ['offset', 'limit'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ORDER_V4,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public function getRandomOrderId($offset, $limit)
-    {
-        $randomOrder = $this->getRandomOrder($offset, $limit);
-
-        if (is_null($randomOrder) || !isset($randomOrder)) {
-            return null;
-        }
-
-        return $randomOrder['order_id'];
-    }
-
-    public function getRandomOrder($offset, $limit)
-    {
-        $params = ['offset' => $offset, 'limit' => $limit];
-
-        $orders = self::getOrders($params);
-
-        if (is_null($orders) || !isset($orders['results'])) {
-            return null;
-        }
-
-        $randomIndex = rand(0, sizeof($orders['results']) - 1);
-
-        $order = $orders['results'][$randomIndex];
-
-        return $order;
-    }
-
-    public static function removeOrder($params)
-    {
-        $allBodyFields = ['order_ids'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ORDER_V4,
-            'method'    => 'DELETE',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function updateOrder($params)
-    {
-        $excludeFields = ['route_id', 'redirect', 'optimization_problem_id', 'order_ids',
-            'fields', 'offset', 'limit', 'query', 'created_timestamp', 'route_uuid'];
-
-        $allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ORDER_V4,
-            'method'    => 'PUT',
-            'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
-        ]);
-
-        return $response;
-    }
-
-    public static function searchOrder($params)
-    {
-        $allQueryFields = ['fields', 'day_added_YYMMDD', 'scheduled_for_YYMMDD', 'query', 'offset', 'limit'];
-
-        $response = Route4Me::makeRequst([
-            'url'       => Endpoint::ORDER_V4,
-            'method'    => 'GET',
-            'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
-        ]);
-
-        return $response;
-    }
+	public $address_1;
+	public $address_2;
+	public $cached_lat;
+	public $cached_lng;
+	public $curbside_lat;
+	public $curbside_lng;
+	public $address_alias;
+	public $address_city;
+	public $EXT_FIELD_first_name;
+	public $EXT_FIELD_last_name;
+	public $EXT_FIELD_email;
+	public $EXT_FIELD_phone;
+	public $EXT_FIELD_custom_data;
+
+	public $color;
+	public $order_icon;
+	public $local_time_window_start;
+	public $local_time_window_end;
+	public $local_time_window_start_2;
+	public $local_time_window_end_2;
+	public $service_time;
+
+	public $day_scheduled_for_YYMMDD;
+
+	public $route_id;
+	public $redirect;
+	public $optimization_problem_id;
+	public $order_id;
+	public $order_uuid;
+	public $order_ids;
+
+	public $day_added_YYMMDD;
+	public $scheduled_for_YYMMDD;
+	public $fields;
+	public $offset;
+	public $limit;
+	public $query;
+
+	public $created_timestamp;
+	public $order_status_id;
+	public $member_id;
+	public $address_state_id;
+	public $address_country_id;
+	public $address_zip;
+	public $in_route_count;
+	public $last_visited_timestamp;
+	public $last_routed_timestamp;
+	public $local_timezone_string;
+	public $is_validated;
+	public $is_pending;
+	public $is_accepted;
+	public $is_started;
+	public $is_completed;
+	public $custom_user_fields;
+
+	public $address_stop_type = \Route4Me\Enum\AddressType::DELIVERY;
+
+	public $addresses = [];
+
+	/**
+	 * Weight of the order.
+	 * @since 1.2.11
+	 */
+	public $EXT_FIELD_weight;
+
+	/**
+	 * Cost of the order.
+	 * @since 1.2.11
+	 */
+	public $EXT_FIELD_cost;
+
+	/**
+	 * The total revenue for the order.
+	 * @since 1.2.11
+	 */
+	public $EXT_FIELD_revenue;
+
+	/**
+	 * The cubic volume of the cargo.
+	 * @since 1.2.11
+	 */
+	public $EXT_FIELD_cube;
+
+	/**
+	 *The item quantity of the cargo.
+	 * @since 1.2.11
+	 */
+	public $EXT_FIELD_pieces;
+
+	public function __construct()
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	}
+
+	/**
+	 * @param Order $params
+	 */
+	public static function addOrder($params)
+	{
+		$excludeFields = ['route_id', 'redirect', 'optimization_problem_id', 'order_id',
+			'order_ids', 'fields', 'offset', 'limit', 'query', 'created_timestamp', 'order_uuid'];
+
+		$allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ORDER_V4,
+			'method'    => 'POST',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function addOrder2Route($params)
+	{
+		$allQueryFields = ['route_id', 'redirect'];
+		$allBodyFields = ['addresses'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ROUTE_V4,
+			'method'    => 'PUT',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function addOrder2Optimization($params)
+	{
+		$allQueryFields = ['optimization_problem_id', 'redirect', 'device_type'];
+		$allBodyFields  = ['addresses'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::OPTIMIZATION_PROBLEM,
+			'method'    => 'PUT',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function getOrder($params)
+	{
+		$allQueryFields = ['order_id', 'fields', 'day_added_YYMMDD', 'scheduled_for_YYMMDD', 'query',
+			'offset', 'limit'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ORDER_V4,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function getOrders($params)
+	{
+		$allQueryFields = ['offset', 'limit'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ORDER_V4,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public function getRandomOrderId($offset, $limit)
+	{
+		$randomOrder = $this->getRandomOrder($offset, $limit);
+
+		if (is_null($randomOrder) || !isset($randomOrder)) {
+			return null;
+		}
+
+		return $randomOrder['order_id'];
+	}
+
+	public function getRandomOrder($offset, $limit)
+	{
+		$params = ['offset' => $offset, 'limit' => $limit];
+
+		$orders = self::getOrders($params);
+
+		if (is_null($orders) || !isset($orders['results'])) {
+			return null;
+		}
+
+		$randomIndex = rand(0, sizeof($orders['results']) - 1);
+
+		$order = $orders['results'][$randomIndex];
+
+		return $order;
+	}
+
+	public static function removeOrder($params)
+	{
+		$allBodyFields = ['order_ids'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ORDER_V4,
+			'method'    => 'DELETE',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function updateOrder($params)
+	{
+		$excludeFields = ['route_id', 'redirect', 'optimization_problem_id', 'order_ids',
+			'fields', 'offset', 'limit', 'query', 'created_timestamp', 'route_uuid'];
+
+		$allBodyFields = Route4Me::getObjectProperties(new self(), $excludeFields);
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ORDER_V4,
+			'method'    => 'PUT',
+			'body'      => Route4Me::generateRequestParameters($allBodyFields, $params),
+		]);
+
+		return $response;
+	}
+
+	public static function searchOrder($params)
+	{
+		$allQueryFields = ['fields', 'day_added_YYMMDD', 'scheduled_for_YYMMDD', 'query', 'offset', 'limit'];
+
+		$response = Route4Me::makeRequst([
+			'url'       => Endpoint::ORDER_V4,
+			'method'    => 'GET',
+			'query'     => Route4Me::generateRequestParameters($allQueryFields, $params),
+		]);
+
+		return $response;
+	}
 
-    public static function validateCoordinate($coord)
-    {
-        $key = key($coord);
-
-        if (!is_numeric($coord[$key])) {
-            return false;
-        }
-
-        switch ($key) {
-            case 'cached_lat':
-            case 'curbside_lat':
-                if ($coord[$key] > 90 || $coord[$key] < -90) {
-                    return false;
-                }
-                break;
-            case 'cached_lng':
-            case 'curbside_lng':
-                if ($coord[$key] > 180 || $coord[$key] < -180) {
-                    return false;
-                }
-                break;
-        }
-
-        return true;
-    }
+	public static function validateCoordinate($coord)
+	{
+		$key = key($coord);
+
+		if (!is_numeric($coord[$key])) {
+			return false;
+		}
+
+		switch ($key) {
+			case 'cached_lat':
+			case 'curbside_lat':
+				if ($coord[$key] > 90 || $coord[$key] < -90) {
+					return false;
+				}
+				break;
+			case 'cached_lng':
+			case 'curbside_lng':
+				if ($coord[$key] > 180 || $coord[$key] < -180) {
+					return false;
+				}
+				break;
+		}
+
+		return true;
+	}
 
-    public function addOrdersFromCsvFile($csvFileHandle, $ordersFieldsMapping)
-    {
-        $max_line_length = 512;
-        $delemietr = ',';
-
-        $results = [];
-        $results['fail'] = [];
-        $results['success'] = [];
-
-        $columns = fgetcsv($csvFileHandle, $max_line_length, $delemietr);
+	public function addOrdersFromCsvFile($csvFileHandle, $ordersFieldsMapping)
+	{
+		$max_line_length = 512;
+		$delemietr = ',';
+
+		$results = [];
+		$results['fail'] = [];
+		$results['success'] = [];
+
+		$columns = fgetcsv($csvFileHandle, $max_line_length, $delemietr);
 
-        $excludeFields = ['route_id', 'redirect', 'optimization_problem_id', 'order_id', 'order_ids',
-            'fields', 'offset', 'limit', 'query', 'created_timestamp', 'order_uuid'];
-
-        $allOrderFields = Route4Me::getObjectProperties(new self(), $excludeFields);
-
-        if (!empty($columns)) {
-            array_push($results['fail'], 'Empty CSV table');
+		$excludeFields = ['route_id', 'redirect', 'optimization_problem_id', 'order_id', 'order_ids',
+			'fields', 'offset', 'limit', 'query', 'created_timestamp', 'order_uuid'];
+
+		$allOrderFields = Route4Me::getObjectProperties(new self(), $excludeFields);
+
+		if (!empty($columns)) {
+			array_push($results['fail'], 'Empty CSV table');
 
-            return $results;
-        }
-
-        $iRow = 1;
-
-        while (false !== ($rows = fgetcsv($csvFileHandle, $max_line_length, $delemietr))) {
-            if ($rows[$ordersFieldsMapping['cached_lat']] && $rows[$ordersFieldsMapping['cached_lng']] && $rows[$ordersFieldsMapping['address_1']] && [null] !== $rows) {
-                $cached_lat = 0.000;
-                $cached_lng = 0.000;
-
-                foreach (['cached_lat', 'cached_lng', 'curbside_lat', 'curbside_lng'] as $coord) {
-                    if (!$this->validateCoordinate([$coord => $rows[$ordersFieldsMapping[$coord]]])) {
-                        array_push($results['fail'], "$iRow --> Wrong " + $coord);
-                        ++$iRow;
-                        continue;
-                    } else {
-                        switch ($coord) {
-                            case 'cached_lat':
-                                $cached_lat = doubleval($rows[$ordersFieldsMapping[$coord]]);
-                                break;
-                            case 'cached_lng':
-                                $cached_lng = doubleval($rows[$ordersFieldsMapping[$coord]]);
-                                break;
-                        }
-                    }
-                }
-
-                $address = $rows[$ordersFieldsMapping['address_1']];
-
-                foreach (['order_city', 'order_state_id', 'order_zip_code', 'order_country_id'] as $addressPart) {
-                    if (isset($ordersFieldsMapping[$addressPart])) {
-                        $address .= ', '.$rows[$ordersFieldsMapping[$addressPart]];
-                    }
-                }
-
-                echo "$iRow --> ".$ordersFieldsMapping['day_scheduled_for_YYMMDD'].', '.$rows[$ordersFieldsMapping['day_scheduled_for_YYMMDD']].'<br>';
-
-                $parametersArray = [];
-
-                $parametersArray['cached_lat'] = $cached_lat;
-                $parametersArray['cached_lng'] = $cached_lng;
-
-                foreach ($allOrderFields as $orderField) {
-                    if (isset($ordersFieldsMapping[$orderField])) {
-                        $parametersArray[$orderField] = $rows[$ordersFieldsMapping[$orderField]];
-                    }
-                }
-
-                $orderParameters = self::fromArray($parametersArray);
-
-                $order = new self();
-
-                $orderResults = $order->addOrder($orderParameters);
-
-                array_push($results['success'], 'The order with order_id = '.strval($orderResults['order_id']).' added successfuly.');
-            } else {
-                array_push($results['fail'], "$iRow --> one of the parameters cached_lat, cached_lng, address_1 is not set");
-            }
-
-            ++$iRow;
-        }
-    }
+			return $results;
+		}
+
+		$iRow = 1;
+
+		while (false !== ($rows = fgetcsv($csvFileHandle, $max_line_length, $delemietr))) {
+			if ($rows[$ordersFieldsMapping['cached_lat']] && $rows[$ordersFieldsMapping['cached_lng']] && $rows[$ordersFieldsMapping['address_1']] && [null] !== $rows) {
+				$cached_lat = 0.000;
+				$cached_lng = 0.000;
+
+				foreach (['cached_lat', 'cached_lng', 'curbside_lat', 'curbside_lng'] as $coord) {
+					if (!$this->validateCoordinate([$coord => $rows[$ordersFieldsMapping[$coord]]])) {
+						array_push($results['fail'], "$iRow --> Wrong " + $coord);
+						++$iRow;
+						continue;
+					} else {
+						switch ($coord) {
+							case 'cached_lat':
+								$cached_lat = doubleval($rows[$ordersFieldsMapping[$coord]]);
+								break;
+							case 'cached_lng':
+								$cached_lng = doubleval($rows[$ordersFieldsMapping[$coord]]);
+								break;
+						}
+					}
+				}
+
+				$address = $rows[$ordersFieldsMapping['address_1']];
+
+				foreach (['order_city', 'order_state_id', 'order_zip_code', 'order_country_id'] as $addressPart) {
+					if (isset($ordersFieldsMapping[$addressPart])) {
+						$address .= ', '.$rows[$ordersFieldsMapping[$addressPart]];
+					}
+				}
+
+				echo "$iRow --> ".$ordersFieldsMapping['day_scheduled_for_YYMMDD'].', '.$rows[$ordersFieldsMapping['day_scheduled_for_YYMMDD']].'<br>';
+
+				$parametersArray = [];
+
+				$parametersArray['cached_lat'] = $cached_lat;
+				$parametersArray['cached_lng'] = $cached_lng;
+
+				foreach ($allOrderFields as $orderField) {
+					if (isset($ordersFieldsMapping[$orderField])) {
+						$parametersArray[$orderField] = $rows[$ordersFieldsMapping[$orderField]];
+					}
+				}
+
+				$orderParameters = self::fromArray($parametersArray);
+
+				$order = new self();
+
+				$orderResults = $order->addOrder($orderParameters);
+
+				array_push($results['success'], 'The order with order_id = '.strval($orderResults['order_id']).' added successfuly.');
+			} else {
+				array_push($results['fail'], "$iRow --> one of the parameters cached_lat, cached_lng, address_1 is not set");
+			}
+
+			++$iRow;
+		}
+	}
 }