route4me / route4me-php-sdk

src/Route4Me/Route4Me.php

Doc Comments +6 added lines

@@ -207,12 +207,16 @@ 
 
     /**
      * @param $object: JSON object
+     * @param \SimpleXMLElement $object
      */
     public static function object2array($object)
     {
         return @json_decode(@json_encode($object), 1);
     }
 
+    /**
+     * @param string $url
+     */
     public static function makeUrlRequst($url, $options) {
         $method = isset($options['method']) ? $options['method'] : 'GET';
         $query = isset($options['query']) ?
@@ -377,6 +381,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)
     {
@@ -397,6 +402,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)
     {

examples/AddressBook/AddressBookLocationSearch.php

Spacing +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 namespace Route4Me;
 
-$root = realpath(dirname(__FILE__) . '/../../');
-require $root . '/vendor/autoload.php';
+$root = realpath(dirname(__FILE__).'/../../');
+require $root.'/vendor/autoload.php';
 
 use Route4Me\Route4Me;
 
@@ -22,6 +22,6 @@ 
 
 $abcResult = $ablocation->searchAddressBookLocations($params);
 
-$results = $ablocation->getValue($abcResult,"results");
+$results = $ablocation->getValue($abcResult, "results");
 
 Route4Me::simplePrint($results);

examples/Order/UpdateOrder.php

Spacing +3 added lines, -3 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 namespace Route4Me;
 
-$root=realpath(dirname(__FILE__).'/../../');
+$root = realpath(dirname(__FILE__).'/../../');
 require $root.'/vendor/autoload.php';
 
 use Route4Me\Route4Me;
@@ -24,8 +24,8 @@ 
 assert(!is_null($randomOrder), "Can't retrieve a random order");
 
 // Update the order
-$randomOrder['address_2']="Lviv";
-$randomOrder['EXT_FIELD_phone']="032268593";
+$randomOrder['address_2'] = "Lviv";
+$randomOrder['EXT_FIELD_phone'] = "032268593";
 $randomOrder['EXT_FIELD_custom_data'] = array(
             0 => array(
                "customer_no" => "11"

examples/Order/OrderSearchScheduledDate.php

Spacing +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 Route4Me::setApiKey('11111111111111111111111111111111');
 
 $orderParameters = Order::fromArray(array(
-    "scheduled_for_YYMMDD" => date("Y-m-d", strtotime( '-1 days' )),
+    "scheduled_for_YYMMDD" => date("Y-m-d", strtotime('-1 days')),
     "offset"               => 0,
     "limit"                => 5
 ));

examples/Order/OrderSearchInsertedDate.php

Spacing +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 Route4Me::setApiKey('11111111111111111111111111111111');
 
 $orderParameters = Order::fromArray(array(
-    "day_added_YYMMDD"  => date("Y-m-d", strtotime( '-1 days' )),
+    "day_added_YYMMDD"  => date("Y-m-d", strtotime('-1 days')),
     "offset"            => 0,
     "limit"             => 5
 ));

examples/get_route_tracking.php

Spacing +2 added lines, -2 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 namespace Route4Me;
 
-$root=realpath(dirname(__FILE__).'/../');
+$root = realpath(dirname(__FILE__).'/../');
 require $root.'/vendor/autoload.php';
 
 use Route4Me\Route4Me;
@@ -15,7 +15,7 @@ 
 $route = new Route();
 
 // Get a random route ID
-$route_id=$route->getRandomRouteId(0, 10);
+$route_id = $route->getRandomRouteId(0, 10);
 assert(!is_null($route_id), "Can't retrieve a random route ID");
 
 $params = array(

examples/Routes/SearchRoute.php

Spacing +3 added lines, -3 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 namespace Route4Me;
 
-$root=realpath(dirname(__FILE__).'/../../');
+$root = realpath(dirname(__FILE__).'/../../');
 require $root.'/vendor/autoload.php';
 
 use Route4Me\Route4Me;
@@ -24,9 +24,9 @@ 
 {
     $results = (array)$routeResult;
     
-    if (isset($results['route_id'])) echo "Route ID - > " . $results['route_id'] . "<br>";
+    if (isset($results['route_id'])) echo "Route ID - > ".$results['route_id']."<br>";
     
-    if (isset($results['parameters']->route_name)) echo "Route name - > " . $results['parameters']->route_name . "<br>";
+    if (isset($results['parameters']->route_name)) echo "Route name - > ".$results['parameters']->route_name."<br>";
 
     echo "<br>";
 }

examples/Routes/DeleteRoutes.php

Spacing +2 added lines, -2 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 namespace Route4Me;
 
-$root=realpath(dirname(__FILE__).'/../../');
+$root = realpath(dirname(__FILE__).'/../../');
 require $root.'/vendor/autoload.php';
 
 use Route4Me\Route4Me;
@@ -25,7 +25,7 @@ 
 echo "Random route ID 1 -> $randomRouteID1 <br>  Random route ID 2 -> $randomRouteID2 <br>";
 
 // Remove selected routes
-$route_ids = join(',',array($randomRouteID1,$randomRouteID2));
+$route_ids = join(',', array($randomRouteID1, $randomRouteID2));
 
 $result = $route->deleteRoutes($route_ids);
 

src/Route4Me/Order.php

Spacing +3 added lines, -3 removed lines

@@ -215,7 +215,7 @@ 
     
     public static function searchOrder($params)
     {
-        $allQueryFields = array('fields', 'day_added_YYMMDD', 'scheduled_for_YYMMDD', 'query', 'offset', 'limit' );
+        $allQueryFields = array('fields', 'day_added_YYMMDD', 'scheduled_for_YYMMDD', 'query', 'offset', 'limit');
         
         $response = Route4Me::makeRequst(array(
             'url'    => Endpoint::ORDER_V4,
@@ -269,11 +269,11 @@ 
         $allOrderFields = Route4Me::getObjectProperties(new Order(), $excludeFields);
         
         if (!empty($columns)) {
-             array_push($results['fail'],'Empty CSV table');
+             array_push($results['fail'], 'Empty CSV table');
              return ($results);
         }
                  
-        $iRow=1;
+        $iRow = 1;
         
         while (($rows = fgetcsv($csvFileHandle, $max_line_length, $delemietr))!==false) {
             if ($rows[$ordersFieldsMapping['cached_lat']] && $rows[$ordersFieldsMapping['cached_lng']] && $rows[$ordersFieldsMapping['address_1']] && array(null)!==$rows) {