route4me / route4me-php-sdk

src/Route4Me/Route4Me.php

Doc Comments +3 added lines

@@ -207,6 +207,7 @@ 
 
     /**
      * @param $object: JSON object
+     * @param \SimpleXMLElement $object
      */
     public static function object2array($object)
     {
@@ -304,6 +305,7 @@ 
      * Returns an array of the object properties
      * @param $object: An object.
      * @param $exclude: array of the object parameters to be excluded from the returned array.
+     * @param string[] $exclude
      */
     public static function getObjectProperties($object, $exclude)
     {
@@ -324,6 +326,7 @@ 
      * Returns url path generated from the array of the fields and parameters.
      * @param $allFields; array of the paossible fields (parameter names).
      * @param $params: input parameters (array or object).
+     * @param string[] $allFields
      */
     public static function generateUrlPath($allFields, $params)
     {

Indentation +247 added lines, -247 removed lines

@@ -7,289 +7,289 @@
 
 class Route4Me
 {
-    static public $apiKey;
-    static public $baseUrl = Endpoint::BASE_URL;
+	static public $apiKey;
+	static public $baseUrl = Endpoint::BASE_URL;
 
-    public static function setApiKey($apiKey)
-    {
-        self::$apiKey = $apiKey;
-    }
+	public static function setApiKey($apiKey)
+	{
+		self::$apiKey = $apiKey;
+	}
 
-    public static function getApiKey()
-    {
-        return self::$apiKey;
-    }
+	public static function getApiKey()
+	{
+		return self::$apiKey;
+	}
 
-    public static function setBaseUrl($baseUrl)
-    {
-        self::$baseUrl = $baseUrl;
-    }
+	public static function setBaseUrl($baseUrl)
+	{
+		self::$baseUrl = $baseUrl;
+	}
 
-    public static function getBaseUrl()
-    {
-        return self::$baseUrl;
-    }
+	public static function getBaseUrl()
+	{
+		return self::$baseUrl;
+	}
     
-    public static function makeRequst($options) {
-        $errorHandler = new myErrorHandler();
+	public static function makeRequst($options) {
+		$errorHandler = new myErrorHandler();
 
-        $method = isset($options['method']) ? $options['method'] : 'GET';
-        $query = isset($options['query']) ? array_filter($options['query'], function($x) { return !is_null($x); } ) : array();
+		$method = isset($options['method']) ? $options['method'] : 'GET';
+		$query = isset($options['query']) ? array_filter($options['query'], function($x) { return !is_null($x); } ) : array();
 
-        $body = isset($options['body']) ? $options['body'] : null;
-        $file = isset($options['FILE']) ? $options['FILE'] : null;
-        $headers = array(
-            "User-Agent: Route4Me php-sdk"
-        );
+		$body = isset($options['body']) ? $options['body'] : null;
+		$file = isset($options['FILE']) ? $options['FILE'] : null;
+		$headers = array(
+			"User-Agent: Route4Me php-sdk"
+		);
 
-        if (isset($options['HTTPHEADER'])) {
-            $headers[] = $options['HTTPHEADER'];
-        }
+		if (isset($options['HTTPHEADER'])) {
+			$headers[] = $options['HTTPHEADER'];
+		}
 
-        if (isset($options['HTTPHEADERS'])) {
-            foreach ($options['HTTPHEADERS'] As $header) {
-                $headers[] = $header;
-            } 
-        }
+		if (isset($options['HTTPHEADERS'])) {
+			foreach ($options['HTTPHEADERS'] As $header) {
+				$headers[] = $header;
+			} 
+		}
 
-        $ch = curl_init();
+		$ch = curl_init();
 
-        $url = isset($options['url']) ? $options['url'].'?'.http_build_query(array_merge(
-            $query, array('api_key' => self::getApiKey())
-        )) : "";
+		$url = isset($options['url']) ? $options['url'].'?'.http_build_query(array_merge(
+			$query, array('api_key' => self::getApiKey())
+		)) : "";
 
-        $baseUrl = self::getBaseUrl();
+		$baseUrl = self::getBaseUrl();
  
-        $curlOpts = array(
-            CURLOPT_URL            => $baseUrl.$url,
-            CURLOPT_RETURNTRANSFER => true,
-            CURLOPT_TIMEOUT        => 80,
-            CURLOPT_FOLLOWLOCATION => true,
-            CURLOPT_SSL_VERIFYHOST => FALSE,
-            CURLOPT_SSL_VERIFYPEER => FALSE,
-            CURLOPT_HTTPHEADER     => $headers
-        );
+		$curlOpts = array(
+			CURLOPT_URL            => $baseUrl.$url,
+			CURLOPT_RETURNTRANSFER => true,
+			CURLOPT_TIMEOUT        => 80,
+			CURLOPT_FOLLOWLOCATION => true,
+			CURLOPT_SSL_VERIFYHOST => FALSE,
+			CURLOPT_SSL_VERIFYPEER => FALSE,
+			CURLOPT_HTTPHEADER     => $headers
+		);
         
-        curl_setopt_array($ch, $curlOpts);
+		curl_setopt_array($ch, $curlOpts);
         
-        if ($file!=null) {
-            curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 0);
-            $fp = fopen($file, 'r');
-            curl_setopt($ch, CURLOPT_INFILE, $fp);
-            curl_setopt($ch, CURLOPT_INFILESIZE, filesize($file));
-        }
+		if ($file!=null) {
+			curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 0);
+			$fp = fopen($file, 'r');
+			curl_setopt($ch, CURLOPT_INFILE, $fp);
+			curl_setopt($ch, CURLOPT_INFILESIZE, filesize($file));
+		}
 
-        switch ($method) {
-        case 'DELETE':
-            curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE"); 
-            break;
-        case 'DELETEARRAY':
-            curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE"); 
-            curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($query));
-            break;
-        case 'PUT':
-            curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
-            break;
-        case 'POST':
-           if (isset($body)) {
-                $bodyData = json_encode($body);
-               if (isset($options['HTTPHEADER'])) {
-                  if (strpos($options['HTTPHEADER'], "multipart/form-data")>0) {
-                      $bodyData = $body;
-                  }
-               }
+		switch ($method) {
+		case 'DELETE':
+			curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE"); 
+			break;
+		case 'DELETEARRAY':
+			curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE"); 
+			curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($query));
+			break;
+		case 'PUT':
+			curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
+			break;
+		case 'POST':
+		   if (isset($body)) {
+				$bodyData = json_encode($body);
+			   if (isset($options['HTTPHEADER'])) {
+				  if (strpos($options['HTTPHEADER'], "multipart/form-data")>0) {
+					  $bodyData = $body;
+				  }
+			   }
                
-               curl_setopt($ch, CURLOPT_POSTFIELDS, $bodyData); 
-            } 
-            break;
-        case 'ADD':
-            curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($query)); break;
-        }
+			   curl_setopt($ch, CURLOPT_POSTFIELDS, $bodyData); 
+			} 
+			break;
+		case 'ADD':
+			curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($query)); break;
+		}
 
-        if (is_numeric(array_search($method, array('DELETE', 'PUT')))) {
-            if (isset($body)) {
-                curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body)); 
-            } 
-        }
+		if (is_numeric(array_search($method, array('DELETE', 'PUT')))) {
+			if (isset($body)) {
+				curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body)); 
+			} 
+		}
 
-        $result = curl_exec($ch);
+		$result = curl_exec($ch);
 
-        $isxml = FALSE;
-        $jxml = "";
-        if (strpos($result, '<?xml')>-1) {
-            $xml = simplexml_load_string($result);
-            //$jxml = json_encode($xml);
-            $jxml = self::object2array($xml);
-            $isxml = TRUE;
-        }
+		$isxml = FALSE;
+		$jxml = "";
+		if (strpos($result, '<?xml')>-1) {
+			$xml = simplexml_load_string($result);
+			//$jxml = json_encode($xml);
+			$jxml = self::object2array($xml);
+			$isxml = TRUE;
+		}
         
-        $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
-        curl_close($ch);
+		$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
+		curl_close($ch);
         
-        if (200==$code) {
-            if ($isxml) {
-                $json = $jxml;
-            } else {
-                $json = json_decode($result, true);
-            }
+		if (200==$code) {
+			if ($isxml) {
+				$json = $jxml;
+			} else {
+				$json = json_decode($result, true);
+			}
             
-            if (isset($json['errors'])) {
-                throw new ApiError(implode(', ', $json['errors']));
-            } else {
-                return $json;
-            }
-        } elseif (409==$code) {
-            throw new ApiError('Wrong API key');
-        } else {
-            throw new ApiError('Something wrong');
-        }
-    }
+			if (isset($json['errors'])) {
+				throw new ApiError(implode(', ', $json['errors']));
+			} else {
+				return $json;
+			}
+		} elseif (409==$code) {
+			throw new ApiError('Wrong API key');
+		} else {
+			throw new ApiError('Something wrong');
+		}
+	}
 
-    /**
-     * @param $object: JSON object
-     */
-    public static function object2array($object)
-    {
-        return @json_decode(@json_encode($object), 1);
-    }
+	/**
+	 * @param $object: JSON object
+	 */
+	public static function object2array($object)
+	{
+		return @json_decode(@json_encode($object), 1);
+	}
 
     
-    /**
-     * Prints on the screen main keys and values of the array 
-     * @param $results: object to be printed on the screen.
-     * @param $deepPrinting: if true, object will be printed recursively.
-     */
-    public static function simplePrint($results, $deepPrinting = null)
-    {
-        if (isset($results)) {
-            if (is_array($results)) {
-                foreach ($results as $key=>$result) {
-                    if (is_array($result)) {
-                        foreach ($result as $key1=>$result1) {
-                            if (is_array($result1)) {
-                                  if ($deepPrinting) {
-                                      echo "<br>$key1 ------><br>";
-                                      Route4Me::simplePrint($result1, true);
-                                      echo "------<br>";
-                                  } else {
-                                      echo $key1." --> "."Array() <br>";
-                                  } 
-                            } else {
-                                if (is_object($result1)) {
-                                    if ($deepPrinting) {
-                                        echo "<br>$key1 ------><br>";
-                                        $oarray = (array)$result1;
-                                        Route4Me::simplePrint($oarray, true);
-                                        echo "------<br>";
-                                    } else {
-                                        echo $key1." --> "."Object <br>";
-                                    } 
-                                } else {
-                                    if (!is_null($result1)) {
-                                        echo $key1." --> ".$result1."<br>"; 
-                                    }   
-                                }
-                            }
-                        }
-                    } else {
-                        if (is_object($result)) {
-                            if ($deepPrinting) {
-                                echo "<br>$key ------><br>";
-                                $oarray = (array)$result;
-                                Route4Me::simplePrint($oarray, true);
-                                echo "------<br>";
-                            } else {
-                                echo $key." --> "."Object <br>";
-                            } 
-                        } else {
-                            if (!is_null($result)) {
-                                echo $key." --> ".$result."<br>";
-                            }
-                        }
+	/**
+	 * Prints on the screen main keys and values of the array 
+	 * @param $results: object to be printed on the screen.
+	 * @param $deepPrinting: if true, object will be printed recursively.
+	 */
+	public static function simplePrint($results, $deepPrinting = null)
+	{
+		if (isset($results)) {
+			if (is_array($results)) {
+				foreach ($results as $key=>$result) {
+					if (is_array($result)) {
+						foreach ($result as $key1=>$result1) {
+							if (is_array($result1)) {
+								  if ($deepPrinting) {
+									  echo "<br>$key1 ------><br>";
+									  Route4Me::simplePrint($result1, true);
+									  echo "------<br>";
+								  } else {
+									  echo $key1." --> "."Array() <br>";
+								  } 
+							} else {
+								if (is_object($result1)) {
+									if ($deepPrinting) {
+										echo "<br>$key1 ------><br>";
+										$oarray = (array)$result1;
+										Route4Me::simplePrint($oarray, true);
+										echo "------<br>";
+									} else {
+										echo $key1." --> "."Object <br>";
+									} 
+								} else {
+									if (!is_null($result1)) {
+										echo $key1." --> ".$result1."<br>"; 
+									}   
+								}
+							}
+						}
+					} else {
+						if (is_object($result)) {
+							if ($deepPrinting) {
+								echo "<br>$key ------><br>";
+								$oarray = (array)$result;
+								Route4Me::simplePrint($oarray, true);
+								echo "------<br>";
+							} else {
+								echo $key." --> "."Object <br>";
+							} 
+						} else {
+							if (!is_null($result)) {
+								echo $key." --> ".$result."<br>";
+							}
+						}
                         
-                    }
-                    //echo "<br>";
-                }
-            } 
-        }
-    }
+					}
+					//echo "<br>";
+				}
+			} 
+		}
+	}
 
-    /**
-     * Generates query or body parameters.
-     * @param $allFields: all known fields could be used for parameters generation.
-     * @param $params: input parameters (array or object)
-     */
-    public static function generateRequestParameters($allFields, $params)
-    {
-        $generatedParams = array();
+	/**
+	 * Generates query or body parameters.
+	 * @param $allFields: all known fields could be used for parameters generation.
+	 * @param $params: input parameters (array or object)
+	 */
+	public static function generateRequestParameters($allFields, $params)
+	{
+		$generatedParams = array();
         
-        if (is_array($params)) {
-            foreach ($allFields as $field) {
-                if (isset($params[$field])) {
-                    $generatedParams[$field] = $params[$field];
-                }
-            }
-        } elseif (is_object($params)) {
-            foreach ($allFields as $field) {
-                if (isset($params->{$field})) {
-                    $generatedParams[$field] = $params->{$field};
-                }
-            }
-        }
+		if (is_array($params)) {
+			foreach ($allFields as $field) {
+				if (isset($params[$field])) {
+					$generatedParams[$field] = $params[$field];
+				}
+			}
+		} elseif (is_object($params)) {
+			foreach ($allFields as $field) {
+				if (isset($params->{$field})) {
+					$generatedParams[$field] = $params->{$field};
+				}
+			}
+		}
 
-        return $generatedParams;
-    }
+		return $generatedParams;
+	}
     
-    /**
-     * Returns an array of the object properties
-     * @param $object: An object.
-     * @param $exclude: array of the object parameters to be excluded from the returned array.
-     */
-    public static function getObjectProperties($object, $exclude)
-    {
-        $objectParameters = array();
+	/**
+	 * Returns an array of the object properties
+	 * @param $object: An object.
+	 * @param $exclude: array of the object parameters to be excluded from the returned array.
+	 */
+	public static function getObjectProperties($object, $exclude)
+	{
+		$objectParameters = array();
         
-        foreach (get_object_vars($object) as $key => $value) {
-            if (property_exists($object, $key)) {
-                if (!is_numeric(array_search($key, $exclude))) {
-                    array_push($objectParameters, $key);
-                }
-            }
-        }
+		foreach (get_object_vars($object) as $key => $value) {
+			if (property_exists($object, $key)) {
+				if (!is_numeric(array_search($key, $exclude))) {
+					array_push($objectParameters, $key);
+				}
+			}
+		}
         
-        return $objectParameters;
-    }
+		return $objectParameters;
+	}
     
-    /**
-     * Returns url path generated from the array of the fields and parameters.
-     * @param $allFields; array of the paossible fields (parameter names).
-     * @param $params: input parameters (array or object).
-     */
-    public static function generateUrlPath($allFields, $params)
-    {
-        $generatedPath = "";
+	/**
+	 * Returns url path generated from the array of the fields and parameters.
+	 * @param $allFields; array of the paossible fields (parameter names).
+	 * @param $params: input parameters (array or object).
+	 */
+	public static function generateUrlPath($allFields, $params)
+	{
+		$generatedPath = "";
 
-        if (is_array($params)) {
-            foreach ($allFields as $field) {
-                if (isset($params[$field])) {
-                    $generatedPath .= $params[$field].'/';
-                }
-            }
-        } elseif (is_object($params)) {
-            foreach ($allFields as $field) {
-                if (isset($params->{$field})) {
-                    $generatedPath .= $params->{$field}.'/';
-                }
-            }
-        }
+		if (is_array($params)) {
+			foreach ($allFields as $field) {
+				if (isset($params[$field])) {
+					$generatedPath .= $params[$field].'/';
+				}
+			}
+		} elseif (is_object($params)) {
+			foreach ($allFields as $field) {
+				if (isset($params->{$field})) {
+					$generatedPath .= $params->{$field}.'/';
+				}
+			}
+		}
         
-        return $generatedPath;
-    }
+		return $generatedPath;
+	}
     
-    public static function getFileRealPath($fileName)
-    {
-        $rpath = function_exists('curl_file_create') ? curl_file_create(realpath($fileName)) : '@'.realpath($fileName);
+	public static function getFileRealPath($fileName)
+	{
+		$rpath = function_exists('curl_file_create') ? curl_file_create(realpath($fileName)) : '@'.realpath($fileName);
         
-        return $rpath;
-    }
+		return $rpath;
+	}
 }

examples/multiple_depot_multiple_driver.php

Indentation +11 added lines, -11 removed lines

@@ -26,20 +26,20 @@
 
 $addresses = array();
 foreach ($json as $address) {
-    $addresses[] = Address::fromArray($address);
+	$addresses[] = Address::fromArray($address);
 }
 
 $parameters = RouteParameters::fromArray(array(
-    "algorithm_type"          => AlgorithmType::CVRP_TW_SD,
-    "distance_unit"           => DistanceUnit::MILES,
-    "device_type"             => DeviceType::WEB,
-    "optimize"                => OptimizationType::DISTANCE,
-    "metric"                  => Metric::GEODESIC,
-    "route_max_duration"      => 86400 * 2,
-    "travel_mode"             => TravelMode::DRIVING,
-    "vehicle_capacity"        => 50,
-    "vehicle_max_distance_mi" => 10000,
-    "parts"                   => 50
+	"algorithm_type"          => AlgorithmType::CVRP_TW_SD,
+	"distance_unit"           => DistanceUnit::MILES,
+	"device_type"             => DeviceType::WEB,
+	"optimize"                => OptimizationType::DISTANCE,
+	"metric"                  => Metric::GEODESIC,
+	"route_max_duration"      => 86400 * 2,
+	"travel_mode"             => TravelMode::DRIVING,
+	"vehicle_capacity"        => 50,
+	"vehicle_max_distance_mi" => 10000,
+	"parts"                   => 50
 ));
 
 $optimizationParams = new OptimizationProblemParams;

examples/SingleDriverMultipleTimeWindows.php

Indentation +16 added lines, -16 removed lines

@@ -25,18 +25,18 @@ 
 
 $addresses = array();
 foreach ($json as $address) {
-    $addresses[] = Address::fromArray($address);
+	$addresses[] = Address::fromArray($address);
 }
 
 $parameters = RouteParameters::fromArray(array(
-    "algorithm_type"     => Algorithmtype::TSP,
-    "route_name"         => "Single Driver Multiple TimeWindows 12 Stops",
-    "route_date"         => time() + 24 * 60 * 60,
-    "route_time"         => 5 * 3600 + 30 * 60,
-    "distance_unit"      => DistanceUnit::MILES,
-    "device_type"        => DeviceType::WEB,
-    "optimize"           => OptimizationType::DISTANCE,
-    "metric"             => Metric::GEODESIC
+	"algorithm_type"     => Algorithmtype::TSP,
+	"route_name"         => "Single Driver Multiple TimeWindows 12 Stops",
+	"route_date"         => time() + 24 * 60 * 60,
+	"route_time"         => 5 * 3600 + 30 * 60,
+	"distance_unit"      => DistanceUnit::MILES,
+	"device_type"        => DeviceType::WEB,
+	"optimize"           => OptimizationType::DISTANCE,
+	"metric"             => Metric::GEODESIC
 ));
 
 $optimizationParams = new OptimizationProblemParams;
@@ -46,11 +46,11 @@ 
 $problem = OptimizationProblem::optimize($optimizationParams);
 
 foreach ((array)$problem as $key => $value) {
-    if (is_string($value)) {
-        echo $key." --> ".$value."<br>";
-    } else {
-        echo "************ $key ************* <br>";
-        Route4Me::simplePrint((array)$value, true);
-        echo "******************************* <br>";
-    }
+	if (is_string($value)) {
+		echo $key." --> ".$value."<br>";
+	} else {
+		echo "************ $key ************* <br>";
+		Route4Me::simplePrint((array)$value, true);
+		echo "******************************* <br>";
+	}
 }

examples/SingleDepotMultipleDriverNoTimeWindow.php

Indentation +22 added lines, -22 removed lines

@@ -26,24 +26,24 @@ 
 
 $addresses = array();
 foreach ($json as $address) {
-    $addresses[] = Address::fromArray($address);
+	$addresses[] = Address::fromArray($address);
 }
 
 $parameters = RouteParameters::fromArray(array(
-    "algorithm_type"          => Algorithmtype::CVRP_TW_SD,
-    "route_name"              => "Single Depot, Multiple Driver, No Time Window",
-    "route_date"              => time() + 24 * 60 * 60,
-    "route_time"              => 60 * 60 * 7,
-    "rt"                      => TRUE,
-    "distance_unit"           => DistanceUnit::MILES,
-    "device_type"             => DeviceType::WEB,
-    "optimize"                => OptimizationType::TIME,
-    "metric"                  => Metric::GEODESIC,
-    "route_max_duration"      => 86400,
-    "travel_mode"             => TravelMode::DRIVING,
-    "vehicle_capacity"        => 20,
-    "vehicle_max_distance_mi" => 99999,
-    "parts"                   => 4
+	"algorithm_type"          => Algorithmtype::CVRP_TW_SD,
+	"route_name"              => "Single Depot, Multiple Driver, No Time Window",
+	"route_date"              => time() + 24 * 60 * 60,
+	"route_time"              => 60 * 60 * 7,
+	"rt"                      => TRUE,
+	"distance_unit"           => DistanceUnit::MILES,
+	"device_type"             => DeviceType::WEB,
+	"optimize"                => OptimizationType::TIME,
+	"metric"                  => Metric::GEODESIC,
+	"route_max_duration"      => 86400,
+	"travel_mode"             => TravelMode::DRIVING,
+	"vehicle_capacity"        => 20,
+	"vehicle_max_distance_mi" => 99999,
+	"parts"                   => 4
 ));
 
 $optimizationParams = new OptimizationProblemParams;
@@ -53,11 +53,11 @@ 
 $problem = OptimizationProblem::optimize($optimizationParams);
 
 foreach ((array)$problem as $key => $value) {
-    if (is_string($value)) {
-        echo $key." --> ".$value."<br>";
-    } else {
-        echo "************ $key ************* <br>";
-        Route4Me::simplePrint((array)$value, true);
-        echo "******************************* <br>";
-    }
+	if (is_string($value)) {
+		echo $key." --> ".$value."<br>";
+	} else {
+		echo "************ $key ************* <br>";
+		Route4Me::simplePrint((array)$value, true);
+		echo "******************************* <br>";
+	}
 }

examples/single_driver_round_trip.php

Indentation +17 added lines, -17 removed lines

@@ -27,19 +27,19 @@ 
 $addresses = array();
 
 foreach ($json as $address) {
-    $addresses[] = Address::fromArray($address);
+	$addresses[] = Address::fromArray($address);
 }
 
 $parameters = RouteParameters::fromArray(array(
-    "algorithm_type"          => AlgorithmType::TSP,
-    "distance_unit"           => DistanceUnit::MILES,
-    "device_type"             => DeviceType::WEB,
-    "optimize"                => OptimizationType::DISTANCE,
-    "travel_mode"             => TravelMode::DRIVING,
-    "route_max_duration"      => 86400,
-    "vehicle_capacity"        => 1,
-    "vehicle_max_distance_mi" => 10000,
-    "rt"                      => true
+	"algorithm_type"          => AlgorithmType::TSP,
+	"distance_unit"           => DistanceUnit::MILES,
+	"device_type"             => DeviceType::WEB,
+	"optimize"                => OptimizationType::DISTANCE,
+	"travel_mode"             => TravelMode::DRIVING,
+	"route_max_duration"      => 86400,
+	"vehicle_capacity"        => 1,
+	"vehicle_max_distance_mi" => 10000,
+	"rt"                      => true
 ));
 
 $optimizationParams = new OptimizationProblemParams;
@@ -49,11 +49,11 @@ 
 $problems = OptimizationProblem::optimize($optimizationParams);
 
 foreach ($problems as $problem) {
-    if (is_array($problem) || is_object($problem)) {
-        foreach ($problem as $key => $value) {
-            if (!is_object($value)) {
-                echo $key." --> ".$value."<br>";
-            }
-        }
-    }
+	if (is_array($problem) || is_object($problem)) {
+		foreach ($problem as $key => $value) {
+			if (!is_object($value)) {
+				echo $key." --> ".$value."<br>";
+			}
+		}
+	}
 }

examples/Members/create_device_record.php

Indentation +3 added lines, -3 removed lines

@@ -13,9 +13,9 @@
 Route4Me::setApiKey('11111111111111111111111111111111');
 
 $recordParameters = Member::fromArray(array(
-    'device_id'   => '546546516',
-    'device_type' => 'IPAD',
-    'format'      => 'json',
+	'device_id'   => '546546516',
+	'device_type' => 'IPAD',
+	'format'      => 'json',
 ));
 
 $member = new Member();

examples/Members/purchase_user_license.php

Indentation +8 added lines, -8 removed lines

@@ -13,14 +13,14 @@
 Route4Me::setApiKey('11111111111111111111111111111111');
 
 $recordParameters = Member::fromArray(array(
-    'member_id'         => 77777,
-    'session_guid'      => '454563',
-    'device_id'         => '54564',
-    'device_type'       =>'ipad',
-    'subscription_name' =>'IPAD_MONTHLY',
-    'token'             =>'4/P7q7W91a-oMsCeLvIaQm6bTrgtp7',
-    'payload'           =>'APA91bHun4MxP5egoKMwt2KZFBaFUH-1RYqx',
-    'format'            =>'json'
+	'member_id'         => 77777,
+	'session_guid'      => '454563',
+	'device_id'         => '54564',
+	'device_type'       =>'ipad',
+	'subscription_name' =>'IPAD_MONTHLY',
+	'token'             =>'4/P7q7W91a-oMsCeLvIaQm6bTrgtp7',
+	'payload'           =>'APA91bHun4MxP5egoKMwt2KZFBaFUH-1RYqx',
+	'format'            =>'json'
 ));
 
 $member = new Member();

src/Route4Me/Address.php

Indentation +236 added lines, -236 removed lines

@@ -7,284 +7,284 @@
 
 class Address extends Common
 {
-    public $route_destination_id;
-    public $alias;
-    public $member_id;
-    public $address;
-    public $addressUpdate;
-    public $is_depot = false;
-    public $lat;
-    public $lng;
-    public $route_id;
-    public $original_route_id;
-    public $optimization_problem_id;
-    public $sequence_no;
-    public $geocoded;
-    public $preferred_geocoding;
-    public $failed_geocoding;
-    public $geocodings = array();
-    public $contact_id;
-    public $is_visited;
-    public $customer_po;
-    public $invoice_no;
-    public $reference_no;
-    public $order_no;
-    public $weight;
-    public $cost;
-    public $revenue;
-    public $cube;
-    public $pieces;
-    public $email;
-    public $phone;
-    public $tracking_number;
-    public $destination_note_count;
-    public $drive_time_to_next_destination;
-    public $distance_to_next_destination;
-    public $generated_time_window_start;
-    public $generated_time_window_end;
-    public $time_window_start;
-    public $time_window_end;
-    public $time;
-    public $notes;
-    public $timestamp_last_visited;
-    public $custom_fields = array();
-    public $manifest = array();
+	public $route_destination_id;
+	public $alias;
+	public $member_id;
+	public $address;
+	public $addressUpdate;
+	public $is_depot = false;
+	public $lat;
+	public $lng;
+	public $route_id;
+	public $original_route_id;
+	public $optimization_problem_id;
+	public $sequence_no;
+	public $geocoded;
+	public $preferred_geocoding;
+	public $failed_geocoding;
+	public $geocodings = array();
+	public $contact_id;
+	public $is_visited;
+	public $customer_po;
+	public $invoice_no;
+	public $reference_no;
+	public $order_no;
+	public $weight;
+	public $cost;
+	public $revenue;
+	public $cube;
+	public $pieces;
+	public $email;
+	public $phone;
+	public $tracking_number;
+	public $destination_note_count;
+	public $drive_time_to_next_destination;
+	public $distance_to_next_destination;
+	public $generated_time_window_start;
+	public $generated_time_window_end;
+	public $time_window_start;
+	public $time_window_end;
+	public $time;
+	public $notes;
+	public $timestamp_last_visited;
+	public $custom_fields = array();
+	public $manifest = array();
     
-    public $first_name;
-    public $last_name;
-    public $is_departed;
-    public $timestamp_last_departed;
-    public $order_id;
-    public $priority;
-    public $curbside_lat;
-    public $curbside_lng;
-    public $time_window_start_2;
-    public $time_window_end_2;
+	public $first_name;
+	public $last_name;
+	public $is_departed;
+	public $timestamp_last_departed;
+	public $order_id;
+	public $priority;
+	public $curbside_lat;
+	public $curbside_lng;
+	public $time_window_start_2;
+	public $time_window_end_2;
 
-    public static function fromArray(array $params)
-    {
-        $address = new Address();
-        foreach ($params as $key => $value) {
-            if (property_exists($address, $key)) {
-                $address->{$key} = $value;
-            }
-        }
+	public static function fromArray(array $params)
+	{
+		$address = new Address();
+		foreach ($params as $key => $value) {
+			if (property_exists($address, $key)) {
+				$address->{$key} = $value;
+			}
+		}
         
-        return $address;
-    }
+		return $address;
+	}
 
-    public static function getAddress($routeId, $addressId)
-    {
-        $address = Route4Me::makeRequst(array(
-            'url'    => Endpoint::ADDRESS_V4,
-            'method' => 'GET',
-            'query'  => array(
-                'route_id'             => $routeId,
-                'route_destination_id' => $addressId,
-            )
-        ));
+	public static function getAddress($routeId, $addressId)
+	{
+		$address = Route4Me::makeRequst(array(
+			'url'    => Endpoint::ADDRESS_V4,
+			'method' => 'GET',
+			'query'  => array(
+				'route_id'             => $routeId,
+				'route_destination_id' => $addressId,
+			)
+		));
     
-        return Address::fromArray($address);
-    }
+		return Address::fromArray($address);
+	}
     
-    /*Get notes from the specified route destination
+	/*Get notes from the specified route destination
      * Returns an address object with notes, if an address exists, otherwise - return null.
      */
-    public static function GetAddressesNotes($noteParams)
-    {
-        $address = Route4Me::makeRequst(array(
-            'url'    => Endpoint::ADDRESS_V4,
-            'method' => 'GET',
-            'query'  => array(
-                '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,
-            )
-        ));
+	public static function GetAddressesNotes($noteParams)
+	{
+		$address = Route4Me::makeRequst(array(
+			'url'    => Endpoint::ADDRESS_V4,
+			'method' => 'GET',
+			'query'  => array(
+				'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;
-    }
+		return $address;
+	}
 
-    public function update()
-    {
-        $addressUpdate = Route4Me::makeRequst(array(
-            'url'    => Endpoint::ADDRESS_V4,
-            'method' => 'PUT',
-            'body'   => $this->toArray(),
-            'query'  => array(
-                'route_id'             => $this->route_id,
-                'route_destination_id' => $this->route_destination_id,
-            ),
-        ));
+	public function update()
+	{
+		$addressUpdate = Route4Me::makeRequst(array(
+			'url'    => Endpoint::ADDRESS_V4,
+			'method' => 'PUT',
+			'body'   => $this->toArray(),
+			'query'  => array(
+				'route_id'             => $this->route_id,
+				'route_destination_id' => $this->route_destination_id,
+			),
+		));
     
-        return Address::fromArray($addressUpdate);
-    }
+		return Address::fromArray($addressUpdate);
+	}
     
-    public function markAddress($params)
-    {
-        $allQueryFields = array('route_id', 'route_destination_id');
-        $allBodyFields = array('is_visited', 'is_departed');
+	public function markAddress($params)
+	{
+		$allQueryFields = array('route_id', 'route_destination_id');
+		$allBodyFields = array('is_visited', 'is_departed');
         
-        $result = Route4Me::makeRequst(array(
-            'url'    => Endpoint::ADDRESS_V4,
-            'method' => 'PUT',
-            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ));
+		$result = Route4Me::makeRequst(array(
+			'url'    => Endpoint::ADDRESS_V4,
+			'method' => 'PUT',
+			'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'   => Route4Me::generateRequestParameters($allBodyFields, $params)
+		));
     
-        return $result;
-    }
+		return $result;
+	}
     
-    public function markAsDeparted($params)
-    {
-        $allQueryFields = array('route_id', 'address_id', 'is_departed', 'member_id');
+	public function markAsDeparted($params)
+	{
+		$allQueryFields = array('route_id', 'address_id', 'is_departed', 'member_id');
         
-        $address = Route4Me::makeRequst(array(
-            'url'    => Endpoint::MARK_ADDRESS_DEPARTED,
-            'method' => 'PUT',
-            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params)
-        ));
+		$address = Route4Me::makeRequst(array(
+			'url'    => Endpoint::MARK_ADDRESS_DEPARTED,
+			'method' => 'PUT',
+			'query'  => Route4Me::generateRequestParameters($allQueryFields, $params)
+		));
     
-        return $address;
-    }
+		return $address;
+	}
     
-    public function markAsVisited($params)
-    {
-        $allQueryFields = array('route_id', 'address_id', 'is_visited', 'member_id');
+	public function markAsVisited($params)
+	{
+		$allQueryFields = array('route_id', 'address_id', 'is_visited', 'member_id');
         
-        $address = Route4Me::makeRequst(array(
-            'url'    => Endpoint::UPDATE_ADDRESS_VISITED,
-            'method' => 'PUT',
-            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params)
-        ));
+		$address = Route4Me::makeRequst(array(
+			'url'    => Endpoint::UPDATE_ADDRESS_VISITED,
+			'method' => 'PUT',
+			'query'  => Route4Me::generateRequestParameters($allQueryFields, $params)
+		));
     
-        return $address;
-    }
+		return $address;
+	}
 
-    public function deleteAddress()
-    {
-        $address = Route4Me::makeRequst(array(
-            'url'    => Endpoint::ADDRESS_V4,
-            'method' => 'DELETE',
-            'query'  => array(
-                'route_id'             => $this->route_id,
-                'route_destination_id' => $this->route_destination_id,
-            )
-        ));
+	public function deleteAddress()
+	{
+		$address = Route4Me::makeRequst(array(
+			'url'    => Endpoint::ADDRESS_V4,
+			'method' => 'DELETE',
+			'query'  => array(
+				'route_id'             => $this->route_id,
+				'route_destination_id' => $this->route_destination_id,
+			)
+		));
     
-        return (bool)$address['deleted'];
-    }
+		return (bool)$address['deleted'];
+	}
     
-    public function moveDestinationToRoute($params)
-    {
-        $allBodyFields = array('to_route_id', 'route_destination_id', 'after_destination_id');
+	public function moveDestinationToRoute($params)
+	{
+		$allBodyFields = array('to_route_id', 'route_destination_id', 'after_destination_id');
         
-        $result = Route4Me::makeRequst(array(
-            'url'    => Endpoint::MOVE_ROUTE_DESTINATION,
-            'method' => 'POST',
-            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER'  => 'Content-Type: multipart/form-data'
-        ));
+		$result = Route4Me::makeRequst(array(
+			'url'    => Endpoint::MOVE_ROUTE_DESTINATION,
+			'method' => 'POST',
+			'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'HTTPHEADER'  => 'Content-Type: multipart/form-data'
+		));
 
-        return $result;
-    }
+		return $result;
+	}
     
-    public function AddAddressNote($params)
-    {
-        $allQueryFields = array('route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type');
-        $allBodyFields = array('strNoteContents', 'strUpdateType');
+	public function AddAddressNote($params)
+	{
+		$allQueryFields = array('route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type');
+		$allBodyFields = array('strNoteContents', 'strUpdateType');
         
-        $result = Route4Me::makeRequst(array(
-            'url'    => Endpoint::ROUTE_NOTES_ADD,
-            'method' => 'POST',
-            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'HTTPHEADER'  => 'Content-Type: multipart/form-data'
-        ));
+		$result = Route4Me::makeRequst(array(
+			'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;
-    }
+		return $result;
+	}
 
-    public function AddNoteFile($params)
-    {
-        $allQueryFields = array('route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type', 'strUpdateType');
+	public function AddNoteFile($params)
+	{
+		$allQueryFields = array('route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type', 'strUpdateType');
         
-        $result = Route4Me::makeRequst(array(
-            'url'    => Endpoint::ROUTE_NOTES_ADD,
-            'method' => 'POST',
-            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
-            'body'   => array(
-                'strFilename'  => isset($params['strFilename']) ? Route4Me::getFileRealPath($params['strFilename']) : "" 
-            ),
-            'HTTPHEADER'  => 'Content-Type: multipart/form-data'
-        ));
+		$result = Route4Me::makeRequst(array(
+			'url'    => Endpoint::ROUTE_NOTES_ADD,
+			'method' => 'POST',
+			'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
+			'body'   => array(
+				'strFilename'  => isset($params['strFilename']) ? Route4Me::getFileRealPath($params['strFilename']) : "" 
+			),
+			'HTTPHEADER'  => 'Content-Type: multipart/form-data'
+		));
 
-        return $result;
-    }
+		return $result;
+	}
 
-    public function createCustomNoteType($params)
-    {
-        $allBodyFields = array('type', 'values');
+	public function createCustomNoteType($params)
+	{
+		$allBodyFields = array('type', 'values');
         
-        $result = Route4Me::makeRequst(array(
-            'url'    => Endpoint::NOTE_CUSTOM_TYPES_V4,
-            'method' => 'POST',
-            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ));
+		$result = Route4Me::makeRequst(array(
+			'url'    => Endpoint::NOTE_CUSTOM_TYPES_V4,
+			'method' => 'POST',
+			'body'   => Route4Me::generateRequestParameters($allBodyFields, $params)
+		));
 
-        return $result;
-    }
+		return $result;
+	}
     
-    public function removeCustomNoteType($params)
-    {
-        $result = Route4Me::makeRequst(array(
-            'url'    => Endpoint::NOTE_CUSTOM_TYPES_V4,
-            'method' => 'DELETE',
-            'body'   => array(
-                'id' => isset($params['id']) ? $params['id'] : null
-            )
-        ));
+	public function removeCustomNoteType($params)
+	{
+		$result = Route4Me::makeRequst(array(
+			'url'    => Endpoint::NOTE_CUSTOM_TYPES_V4,
+			'method' => 'DELETE',
+			'body'   => array(
+				'id' => isset($params['id']) ? $params['id'] : null
+			)
+		));
 
-        return $result;
-    }
+		return $result;
+	}
     
-    public function getAllCustomNoteTypes()
-    {
-        $result = Route4Me::makeRequst(array(
-            'url'    => Endpoint::NOTE_CUSTOM_TYPES_V4,
-            'method' => 'GET'
-        ));
+	public function getAllCustomNoteTypes()
+	{
+		$result = Route4Me::makeRequst(array(
+			'url'    => Endpoint::NOTE_CUSTOM_TYPES_V4,
+			'method' => 'GET'
+		));
 
-        return $result;
-    }
+		return $result;
+	}
     
-    public function addCustomNoteToRoute($params)
-    {
-        $customArray = array();
+	public function addCustomNoteToRoute($params)
+	{
+		$customArray = array();
         
-        foreach ($params as $key => $value) {
-            if (strpos($key, "custom_note_type")!==false) {
-                $customArray[$key] = $value;
-            }
-        }
+		foreach ($params as $key => $value) {
+			if (strpos($key, "custom_note_type")!==false) {
+				$customArray[$key] = $value;
+			}
+		}
         
-        $allQueryFields = array('route_id', 'address_id', 'format', 'dev_lat', 'dev_lng');
-        $allBodyFields = array('strUpdateType', 'strUpdateType', 'strNoteContents');
+		$allQueryFields = array('route_id', 'address_id', 'format', 'dev_lat', 'dev_lng');
+		$allBodyFields = array('strUpdateType', 'strUpdateType', 'strNoteContents');
         
-        $result = Route4Me::makeRequst(array(
-            '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'
-        ));
+		$result = Route4Me::makeRequst(array(
+			'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;
-    }
+		return $result;
+	}
 
-    function getAddressId()
-    {
-        return $this->route_destination_id;
-    }
+	function getAddressId()
+	{
+		return $this->route_destination_id;
+	}
 }

examples/multiple_depot_with_time_window.php

Indentation +21 added lines, -21 removed lines

@@ -27,23 +27,23 @@ 
 $addresses = array();
 
 foreach ($json as $address) {
-    $addresses[] = Address::fromArray($address);
+	$addresses[] = Address::fromArray($address);
 }
 
 $parameters = RouteParameters::fromArray(array(
-    "algorithm_type"          => Algorithmtype::CVRP_TW_SD,
-    "route_name"              => "Multiple Depot, Multiple Driver, Time Window",
-    "route_date"              => time() + 24 * 60 * 60,
-    "route_time"              => 60 * 60 * 7,
-    "rt"                      => TRUE,
-    "distance_unit"           => DistanceUnit::MILES,
-    "device_type"             => DeviceType::WEB,
-    "optimize"                => OptimizationType::TIME,
-    "metric"                  => Metric::GEODESIC,
-    "route_max_duration"      => 86400 * 3,
-    "travel_mode"             => TravelMode::DRIVING,
-    "vehicle_capacity"        => 99,
-    "vehicle_max_distance_mi" => 99999
+	"algorithm_type"          => Algorithmtype::CVRP_TW_SD,
+	"route_name"              => "Multiple Depot, Multiple Driver, Time Window",
+	"route_date"              => time() + 24 * 60 * 60,
+	"route_time"              => 60 * 60 * 7,
+	"rt"                      => TRUE,
+	"distance_unit"           => DistanceUnit::MILES,
+	"device_type"             => DeviceType::WEB,
+	"optimize"                => OptimizationType::TIME,
+	"metric"                  => Metric::GEODESIC,
+	"route_max_duration"      => 86400 * 3,
+	"travel_mode"             => TravelMode::DRIVING,
+	"vehicle_capacity"        => 99,
+	"vehicle_max_distance_mi" => 99999
 ));
 
 $optimizationParams = new OptimizationProblemParams;
@@ -53,11 +53,11 @@ 
 $problem = OptimizationProblem::optimize($optimizationParams);
 
 foreach ((array)$problem as $key => $value) {
-    if (is_string($value)) {
-        echo $key." --> ".$value."<br>";
-    } else {
-        echo "************ $key ************* <br>";
-        Route4Me::simplePrint((array)$value, true);
-        echo "******************************* <br>";
-    }
+	if (is_string($value)) {
+		echo $key." --> ".$value."<br>";
+	} else {
+		echo "************ $key ************* <br>";
+		Route4Me::simplePrint((array)$value, true);
+		echo "******************************* <br>";
+	}
 }