route4me / route4me-php-sdk

src/Route4Me/TelematicsGateway/TelematicsConnection.php

Indentation +231 added lines, -231 removed lines

@@ -11,279 +11,279 @@
  */
 class TelematicsConnection extends \Route4Me\Common
 {
-    /**
-     * Telematics connection access account_id
-     * @var string
-     */
-    public $account_id;
+	/**
+	 * Telematics connection access account_id
+	 * @var string
+	 */
+	public $account_id;
     
-    /**
-     * Telematics connection access username
-     * @var string
-     */
-    public $username;
+	/**
+	 * Telematics connection access username
+	 * @var string
+	 */
+	public $username;
     
-    /**
-     * Telematics connection access password
-     * @var string
-     */
-    public $password;
+	/**
+	 * Telematics connection access password
+	 * @var string
+	 */
+	public $password;
     
-    /**
-     * Telematics connection access host
-     * @var string
-     */
-    public $host;
+	/**
+	 * Telematics connection access host
+	 * @var string
+	 */
+	public $host;
     
-    /**
-     * Telematics connection access api_key
-     * @var string
-     */
-    public $api_key;
+	/**
+	 * Telematics connection access api_key
+	 * @var string
+	 */
+	public $api_key;
     
-    /**
-     * Telemetics connection type ID
-     * @var integer
-     */
-    public $vendor_id;
+	/**
+	 * Telemetics connection type ID
+	 * @var integer
+	 */
+	public $vendor_id;
     
-    /**
-     * Telemetics connection name
-     * @var string
-     */
-    public $name;
+	/**
+	 * Telemetics connection name
+	 * @var string
+	 */
+	public $name;
     
-    /**
-     * Vehicle tracking interval in seconds.
-     * @var integer
-     */
-    public $vehicle_position_refresh_rate;
+	/**
+	 * Vehicle tracking interval in seconds.
+	 * @var integer
+	 */
+	public $vehicle_position_refresh_rate;
     
-    /**
-     * Maximum idle time
-     * @var integer
-     */
-    public $max_idle_time;
+	/**
+	 * Maximum idle time
+	 * @var integer
+	 */
+	public $max_idle_time;
     
-    /**
-     * Disable/enable vehicle tracking
-     * @var integer
-     */
-    public $is_enabled;
+	/**
+	 * Disable/enable vehicle tracking
+	 * @var integer
+	 */
+	public $is_enabled;
     
-    /**
-     * The last timestamp, when the vehicles reloaded.
-     * @var integer
-     */
-    public $last_vehicles_reload;
+	/**
+	 * The last timestamp, when the vehicles reloaded.
+	 * @var integer
+	 */
+	public $last_vehicles_reload;
     
-    /**
-     * The last timestamp, when the addresses reloaded.
-     * @var integer
-     */
-    public $last_addresses_reload;
+	/**
+	 * The last timestamp, when the addresses reloaded.
+	 * @var integer
+	 */
+	public $last_addresses_reload;
     
-    /**
-     * The last timestamp, when the positions reloaded.
-     * @var integer
-     */
-    public $last_position_reload;
+	/**
+	 * The last timestamp, when the positions reloaded.
+	 * @var integer
+	 */
+	public $last_position_reload;
     
-    /**
-     * Telematics connection access token
-     * @var string
-     */
-    public $connection_token;
+	/**
+	 * Telematics connection access token
+	 * @var string
+	 */
+	public $connection_token;
     
-    /**
-     * Connection user ID
-     * @var integer
-     */
-    public $user_id;
+	/**
+	 * Connection user ID
+	 * @var integer
+	 */
+	public $user_id;
     
-    /**
-     * When the connection updated
-     * @var string
-     */
-    public $updated_at;
+	/**
+	 * When the connection updated
+	 * @var string
+	 */
+	public $updated_at;
     
-    /**
-     * When the connection created
-     * @var string
-     */
-    public $created_at;
+	/**
+	 * When the connection created
+	 * @var string
+	 */
+	public $created_at;
     
-    /**
-     * Telemetics connection ID
-     * @var integer
-     */
-    public $id;
+	/**
+	 * Telemetics connection ID
+	 * @var integer
+	 */
+	public $id;
     
-    /**
-     * Metadata, custom key-value storage.
-     * @var array
-     */
-    public $metadata;
+	/**
+	 * Metadata, custom key-value storage.
+	 * @var array
+	 */
+	public $metadata;
     
-    /**
-     * Total vehicles number
-     * @var integer
-     */
-    public $total_vehicles_count;
+	/**
+	 * Total vehicles number
+	 * @var integer
+	 */
+	public $total_vehicles_count;
     
-    /**
-     * Total addresses number
-     * @var integer
-     */
-    public $total_addresses_count;
+	/**
+	 * Total addresses number
+	 * @var integer
+	 */
+	public $total_addresses_count;
     
-    /**
-     * Synchronized vehicles number
-     * @var integer
-     */
-    public $synced_vehicles_count;
+	/**
+	 * Synchronized vehicles number
+	 * @var integer
+	 */
+	public $synced_vehicles_count;
     
-    /**
-     * Telemetics connection vendor
-     * @var string
-     */
-    public $vendor;
+	/**
+	 * Telemetics connection vendor
+	 * @var string
+	 */
+	public $vendor;
 
-    /**
-     * Validate connections credentials.<br>
-     * If true, the connection validated.
-     * @var Boolean
-     */
-    public $validate_remote_credentials;
+	/**
+	 * Validate connections credentials.<br>
+	 * If true, the connection validated.
+	 * @var Boolean
+	 */
+	public $validate_remote_credentials;
     
-    public static function fromArray(array $params)
-    {
-        $thisParams = new self();
+	public static function fromArray(array $params)
+	{
+		$thisParams = new self();
 
-        foreach ($params as $key => $value) {
-            if (property_exists($thisParams, $key)) {
-                $thisParams->{$key} = $value;
-            }
-        }
+		foreach ($params as $key => $value) {
+			if (property_exists($thisParams, $key)) {
+				$thisParams->{$key} = $value;
+			}
+		}
 
-        return $thisParams;
-    }
+		return $thisParams;
+	}
 
-    /**
-     * Create a telematics connection.
-     * @param $apiToken string : API token
-     * @param $params TelematicsConnectionParameters : Telematics connection parameters
-     * @return array Array from a TelematicsConnection type object
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function createTelematicsConnection($apiToken, $params)
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	/**
+	 * Create a telematics connection.
+	 * @param $apiToken string : API token
+	 * @param $params TelematicsConnectionParameters : Telematics connection parameters
+	 * @return array Array from a TelematicsConnection type object
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function createTelematicsConnection($apiToken, $params)
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
 
-        $excludeFields = ['id', 'connection_token'];
+		$excludeFields = ['id', 'connection_token'];
 
-        $allBodyFields = Route4Me::getObjectProperties(new TelematicsConnectionParameters(), $excludeFields);
+		$allBodyFields = Route4Me::getObjectProperties(new TelematicsConnectionParameters(), $excludeFields);
 
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::TELEMATICS_CONNECTION,
-            'method' => 'POST',
-            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
-            'query'  => ['api_token' => $apiToken],
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data',
-        ]);
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::TELEMATICS_CONNECTION,
+			'method' => 'POST',
+			'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
+			'query'  => ['api_token' => $apiToken],
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data',
+		]);
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Delete a telematics connection.
-     * @param $apiToken string : API token
-     * @param $connectionToken string : connection token
-     * @return array Array from a TelematicsConnection type object
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function deleteTelematicsConnection($apiToken, $connectionToken)
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	/**
+	 * Delete a telematics connection.
+	 * @param $apiToken string : API token
+	 * @param $connectionToken string : connection token
+	 * @return array Array from a TelematicsConnection type object
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function deleteTelematicsConnection($apiToken, $connectionToken)
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
 
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::TELEMATICS_CONNECTION,
-            'method' => 'DELETE',
-            'query'  => [
-                    'api_token'         => $apiToken,
-                    'connection_token'  => $connectionToken
-                ],
-        ]);
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::TELEMATICS_CONNECTION,
+			'method' => 'DELETE',
+			'query'  => [
+					'api_token'         => $apiToken,
+					'connection_token'  => $connectionToken
+				],
+		]);
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Get all telematics connections.
-     * @param $apiToken string : API token
-     * @return array Array of the TelematicsConnection type objects
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function getTelematicsConnections($apiToken)
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	/**
+	 * Get all telematics connections.
+	 * @param $apiToken string : API token
+	 * @return array Array of the TelematicsConnection type objects
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function getTelematicsConnections($apiToken)
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
 
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::TELEMATICS_CONNECTION,
-            'method' => 'GET',
-            'query'  => [
-                'api_token' => $apiToken
-            ],
-        ]);
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::TELEMATICS_CONNECTION,
+			'method' => 'GET',
+			'query'  => [
+				'api_token' => $apiToken
+			],
+		]);
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Get a telematics connection
-     * @param $apiToken string : API token
-     * @param $connectionToken string : connection token
-     * @return array Array from a TelematicsConnection type object
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function getTelematicsConnection($apiToken, $connectionToken)
-    {
-        Route4Me::setBaseUrl(Endpoint::BASE_URL);
+	/**
+	 * Get a telematics connection
+	 * @param $apiToken string : API token
+	 * @param $connectionToken string : connection token
+	 * @return array Array from a TelematicsConnection type object
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function getTelematicsConnection($apiToken, $connectionToken)
+	{
+		Route4Me::setBaseUrl(Endpoint::BASE_URL);
 
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::TELEMATICS_CONNECTION,
-            'method' => 'GET',
-            'query'  => [
-                'api_token'         => $apiToken,
-                'connection_token'  => $connectionToken
-            ],
-        ]);
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::TELEMATICS_CONNECTION,
+			'method' => 'GET',
+			'query'  => [
+				'api_token'         => $apiToken,
+				'connection_token'  => $connectionToken
+			],
+		]);
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * Update telematics connection
-     * @param $apiToken string : API token
-     * @param $connectionToken string : connection token
-     * @param $teleConParams TelematicsConnectionParameters : Telematics connection parameters
-     * @return array Array from a TelematicsConnection type object
-     * @throws \Route4Me\Exception\ApiError
-     */
-    public function updateTelematicsConnection($apiToken, $connectionToken, $teleConParams)
-    {
-        $excludeFields = ['id', 'connection_token'];
+	/**
+	 * Update telematics connection
+	 * @param $apiToken string : API token
+	 * @param $connectionToken string : connection token
+	 * @param $teleConParams TelematicsConnectionParameters : Telematics connection parameters
+	 * @return array Array from a TelematicsConnection type object
+	 * @throws \Route4Me\Exception\ApiError
+	 */
+	public function updateTelematicsConnection($apiToken, $connectionToken, $teleConParams)
+	{
+		$excludeFields = ['id', 'connection_token'];
 
-        $allBodyFields = Route4Me::getObjectProperties(new TelematicsConnectionParameters(), $excludeFields);
+		$allBodyFields = Route4Me::getObjectProperties(new TelematicsConnectionParameters(), $excludeFields);
 
-        $result = Route4Me::makeRequst([
-            'url'    => Endpoint::TELEMATICS_CONNECTION,
-            'method' => 'PUT',
-            'body'   => Route4Me::generateRequestParameters($allBodyFields, $teleConParams),
-            'query'  => ['api_token' => $apiToken, 'connection_token' => $connectionToken],
-            'HTTPHEADER'    => 'Content-Type: multipart/form-data',
-        ]);
+		$result = Route4Me::makeRequst([
+			'url'    => Endpoint::TELEMATICS_CONNECTION,
+			'method' => 'PUT',
+			'body'   => Route4Me::generateRequestParameters($allBodyFields, $teleConParams),
+			'query'  => ['api_token' => $apiToken, 'connection_token' => $connectionToken],
+			'HTTPHEADER'    => 'Content-Type: multipart/form-data',
+		]);
 
-        return $result;
-    }
+		return $result;
+	}
 }

src/Route4Me/V5/Routes/RouteAdvancedConstraints.php

Indentation +52 added lines, -52 removed lines

@@ -9,66 +9,66 @@
  */
 class RouteAdvancedConstraints extends \Route4Me\Common
 {
-    /** Maximum cargo volume per route
-     * @var double $max_cargo_volume
-     */
-    public $max_cargo_volume;
+	/** Maximum cargo volume per route
+	 * @var double $max_cargo_volume
+	 */
+	public $max_cargo_volume;
 
-    /** Vehicle capacity.
-     * <para>How much total cargo can be transported per route (units, e.g. cubic meters)</para>
-     * @var integer $max_capacity
-     */
-    public $max_capacity;
+	/** Vehicle capacity.
+	 * <para>How much total cargo can be transported per route (units, e.g. cubic meters)</para>
+	 * @var integer $max_capacity
+	 */
+	public $max_capacity;
 
-    /** Legacy feature which permits a user to request an example number of optimized routes.
-     * @var integer $members_count
-     */
-    public $members_count;
+	/** Legacy feature which permits a user to request an example number of optimized routes.
+	 * @var integer $members_count
+	 */
+	public $members_count;
 
-    /** An array of the available time windows (e.g. [ [25200, 75000 ] )
-     * @var Array $available_time_windows
-     */
-    public $available_time_windows;
+	/** An array of the available time windows (e.g. [ [25200, 75000 ] )
+	 * @var Array $available_time_windows
+	 */
+	public $available_time_windows;
 
-    /** The driver tags specified in a team member's custom data.
-     * (e.g. "driver skills":
-     * ["Class A CDL", "Class B CDL", "Forklift", "Skid Steer Loader", "Independent Contractor"]
-     * @var string[] $tags
-     */
-    public $tags;
+	/** The driver tags specified in a team member's custom data.
+	 * (e.g. "driver skills":
+	 * ["Class A CDL", "Class B CDL", "Forklift", "Skid Steer Loader", "Independent Contractor"]
+	 * @var string[] $tags
+	 */
+	public $tags;
 
-    /** An array of the skilled driver IDs.
-     * @var integer[] $route4me_members_id
-     */
-    public $route4me_members_id;
+	/** An array of the skilled driver IDs.
+	 * @var integer[] $route4me_members_id
+	 */
+	public $route4me_members_id;
 
-    /**
-     * A depot address.
-     * @var Address
-     */
-    public $depot_address;
+	/**
+	 * A depot address.
+	 * @var Address
+	 */
+	public $depot_address;
 
-    /**
-     * An array of locations.
-     * @var object[]
-     */
-    public $location_sequence_pattern;
+	/**
+	 * An array of locations.
+	 * @var object[]
+	 */
+	public $location_sequence_pattern;
 
-    /**
-     * Group name of the advanced constraints.
-     * @var string
-     */
-    public $group;
+	/**
+	 * Group name of the advanced constraints.
+	 * @var string
+	 */
+	public $group;
 
-    public static function fromArray(array $params)
-    {
-        $routeParams = new self();
-        foreach ($params as $key => $value) {
-            if (property_exists($routeParams, $key)) {
-                $routeParams->{$key} = $value;
-            }
-        }
+	public static function fromArray(array $params)
+	{
+		$routeParams = new self();
+		foreach ($params as $key => $value) {
+			if (property_exists($routeParams, $key)) {
+				$routeParams->{$key} = $value;
+			}
+		}
 
-        return $routeParams;
-    }
+		return $routeParams;
+	}
 }

examples/AdvancedConstraints/PersistentLocation.php

Indentation +41 added lines, -41 removed lines

@@ -23,25 +23,25 @@ 
 //**********************************************************************
 // General Route Parameters
 $parameters = RouteParameters::fromArray([
-    'rt' => false,
-    'algorithm_type' => Algorithmtype::ADVANCED_CVRP_TW,
-    'route_name' => 'Persistent Location - Single Depot - Multiple Driver '.date('Y-m-d H:i:s', time()),
-    'route_time' => 25200,
-    'distance_unit' => DistanceUnit::MILES,
-    'device_type' => DeviceType::WEB,
-    'optimize' => OptimizationType::DISTANCE,
-    'travel_mode' => TravelMode::DRIVING,
-    'advanced_constraints' => [] 
+	'rt' => false,
+	'algorithm_type' => Algorithmtype::ADVANCED_CVRP_TW,
+	'route_name' => 'Persistent Location - Single Depot - Multiple Driver '.date('Y-m-d H:i:s', time()),
+	'route_time' => 25200,
+	'distance_unit' => DistanceUnit::MILES,
+	'device_type' => DeviceType::WEB,
+	'optimize' => OptimizationType::DISTANCE,
+	'travel_mode' => TravelMode::DRIVING,
+	'advanced_constraints' => [] 
 ]);
 
 //**********************************************************************
 // Persistent Location
 $persistent_location = [
-    'alias' =>  'DEPOT END LOCATION',
-    'address' =>  '4738 BELLEVUE AVE, Louisville, KY, 40215',
-    'lat' =>  38.179806,
-    'lng' =>  -85.775558,
-    'time' =>  300
+	'alias' =>  'DEPOT END LOCATION',
+	'address' =>  '4738 BELLEVUE AVE, Louisville, KY, 40215',
+	'lat' =>  38.179806,
+	'lng' =>  -85.775558,
+	'time' =>  300
 ];
 
 //**********************************************************************
@@ -50,22 +50,22 @@ 
 // Time Window Start:  2:00 am EST
 // Time Window End:   15:50 am EST
 $parameters->advanced_constraints[] = RouteAdvancedConstraints::fromArray([
-    'max_cargo_volume' => 0.0,
-    'max_capacity' => 200,
-    'members_count' => 10,
-    'available_time_windows' => [[25200, 75000]],
-    'location_sequence_pattern' => ['', $persistent_location]
+	'max_cargo_volume' => 0.0,
+	'max_capacity' => 200,
+	'members_count' => 10,
+	'available_time_windows' => [[25200, 75000]],
+	'location_sequence_pattern' => ['', $persistent_location]
 ]);
 
 // Schedule 2
 // Time Window Start:  7:33 am EST
 // Time Window End:   21:23 am EST
 $parameters->advanced_constraints[] = RouteAdvancedConstraints::fromArray([
-    'max_cargo_volume' => 0.0,
-    'max_capacity' => 200,
-    'members_count' => 10,
-    'available_time_windows' => [[45200, 95000]],
-    'location_sequence_pattern' => ['', $persistent_location]
+	'max_cargo_volume' => 0.0,
+	'max_capacity' => 200,
+	'members_count' => 10,
+	'available_time_windows' => [[45200, 95000]],
+	'location_sequence_pattern' => ['', $persistent_location]
 ]);
 
 //**********************************************************************
@@ -74,25 +74,25 @@ 
 
 // Depot
 $addresses[] = Address::fromArray([
-    'address' => '1604 PARKRIDGE PKWY, Louisville, KY, 40214',
-    'is_depot' => true,
-    'lat' => 38.141598,
-    'lng' => -85.793846,
-    'time' => 0
+	'address' => '1604 PARKRIDGE PKWY, Louisville, KY, 40214',
+	'is_depot' => true,
+	'lat' => 38.141598,
+	'lng' => -85.793846,
+	'time' => 0
 ]);
 
 // Stops
 foreach ($json as $address) {
 
-    // skip persistent
-    if($address['address'] == '4738 BELLEVUE AVE, Louisville, KY, 40215') continue;
+	// skip persistent
+	if($address['address'] == '4738 BELLEVUE AVE, Louisville, KY, 40215') continue;
 
-    $addresses[] = Address::fromArray([
-        'address' => $address['address'],
-        'lat' => $address['lat'],
-        'lng' => $address['lng'],
-        'time' => $address['time']
-    ]);
+	$addresses[] = Address::fromArray([
+		'address' => $address['address'],
+		'lat' => $address['lat'],
+		'lng' => $address['lng'],
+		'time' => $address['time']
+	]);
 }
 
 $optimizationParams = new OptimizationProblemParams();
@@ -107,9 +107,9 @@ 
 echo "Routes:" . PHP_EOL;
 foreach($problem->routes as $route)
 {
-    echo "\tID: " . $route->route_id . PHP_EOL;
-    echo "\tDistance: " . $route->trip_distance . PHP_EOL;
-    echo "\tAddresses:" . PHP_EOL;
+	echo "\tID: " . $route->route_id . PHP_EOL;
+	echo "\tDistance: " . $route->trip_distance . PHP_EOL;
+	echo "\tAddresses:" . PHP_EOL;
 
-    foreach($route->addresses as $address) echo "\t\t" . $address->address . PHP_EOL;
+	foreach($route->addresses as $address) echo "\t\t" . $address->address . PHP_EOL;
 }