allejo / PhpSoda

src/Utilities/UrlQuery.php

Doc Comments +3 added lines, -3 removed lines

@@ -307,7 +307,7 @@ 
      *
      * @throws \allejo\Socrata\Exceptions\CurlException If cURL is misconfigured or encounters an error
      *
-     * @return mixed
+     * @return string
      */
     private function executeCurl ()
     {
@@ -332,7 +332,7 @@ 
      * @throws \allejo\Socrata\Exceptions\HttpException If the $body returned was not a JSON object
      * @throws \allejo\Socrata\Exceptions\SodaException The returned JSON object in the $body was a SODA API error
      *
-     * @return mixed An associative array of the decoded JSON response
+     * @return string An associative array of the decoded JSON response
      */
     private function handleResponseBody ($body, $result)
     {
@@ -386,7 +386,7 @@ 
      * Build a URL with GET parameters formatted into the URL
      *
      * @param string  $url    The base URL
-     * @param array   $params The GET parameters that need to be appended to the base URL
+     * @param string[]   $params The GET parameters that need to be appended to the base URL
      *
      * @since 0.1.0
      *

Indentation +4 added lines, -4 removed lines

@@ -90,10 +90,10 @@
 
         // Build up the headers we'll need to pass
         $this->headers = array(
-                             'Accept: application/json',
-                             'Content-type: application/json',
-                             'X-App-Token: ' . $this->token
-                         );
+                                'Accept: application/json',
+                                'Content-type: application/json',
+                                'X-App-Token: ' . $this->token
+                            );
 
         $this->configureCurl($email, $password);
     }

Upper-Lower-Casing +6 added lines, -6 removed lines

@@ -137,7 +137,7 @@ 
      *
      * @return mixed  An associative array matching the returned JSON result or an StdClass object
      */
-    public function sendGet ($params, $associativeArray, &$headers = NULL)
+    public function sendGet ($params, $associativeArray, &$headers = null)
     {
         if (is_array($params))
         {
@@ -172,7 +172,7 @@ 
      *
      * @return mixed  An associative array matching the returned JSON result or an StdClass object
      */
-    public function sendPost ($dataAsJson, $associativeArray, &$headers = NULL)
+    public function sendPost ($dataAsJson, $associativeArray, &$headers = null)
     {
         $this->setPostFields($dataAsJson);
 
@@ -198,7 +198,7 @@ 
      *
      * @return mixed  An associative array matching the returned JSON result or an StdClass object
      */
-    public function sendPut ($dataAsJson, $associativeArray, &$headers = NULL)
+    public function sendPut ($dataAsJson, $associativeArray, &$headers = null)
     {
         $this->setPostFields($dataAsJson);
 
@@ -220,7 +220,7 @@ 
      *
      * @return mixed  An associative array matching the returned JSON result or an StdClass object
      */
-    public function sendDelete ($associativeArray, &$headers = NULL)
+    public function sendDelete ($associativeArray, &$headers = null)
     {
         curl_setopt($this->cURL, CURLOPT_CUSTOMREQUEST, "DELETE");
 
@@ -266,7 +266,7 @@ 
 
         if ($ignoreReturn)
         {
-            return NULL;
+            return null;
         }
 
         $resultArray = $this->handleResponseBody($body, $result);
@@ -365,7 +365,7 @@ 
      */
     private function saveHeaders ($header, &$headers)
     {
-        if ($headers === NULL)
+        if ($headers === null)
         {
             return;
         }

Spacing +6 added lines, -6 removed lines

@@ -92,7 +92,7 @@ 
         $this->headers = array(
                              'Accept: application/json',
                              'Content-type: application/json',
-                             'X-App-Token: ' . $this->token
+                             'X-App-Token: '.$this->token
                          );
 
         $this->configureCurl($email, $password);
@@ -119,7 +119,7 @@ 
         if (!StringUtilities::isNullOrEmpty($token))
         {
             $this->oAuth2Token = $token;
-            $this->headers[]   = "Authorization: OAuth " . $this->oAuth2Token;
+            $this->headers[]   = "Authorization: OAuth ".$this->oAuth2Token;
         }
     }
 
@@ -146,7 +146,7 @@ 
         }
         else if (!empty($params))
         {
-            $full_url = $this->url . "?" . $params;
+            $full_url = $this->url."?".$params;
         }
         else
         {
@@ -295,7 +295,7 @@ 
         {
             curl_setopt_array($this->cURL, array(
                 CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
-                CURLOPT_USERPWD => $email . ":" . $password
+                CURLOPT_USERPWD => $email.":".$password
             ));
         }
     }
@@ -398,7 +398,7 @@ 
 
         if (count($params) > 0)
         {
-            $full_url .= "?" . implode("&", $params);
+            $full_url .= "?".implode("&", $params);
         }
 
         return $full_url;
@@ -435,7 +435,7 @@ 
 
         foreach ($params as $key => $value)
         {
-            $parameters[] = rawurlencode($key) . "=" . rawurlencode($value);
+            $parameters[] = rawurlencode($key)."=".rawurlencode($value);
         }
 
         return $parameters;

examples/911calls.php

Indentation +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
     // Build a SoqlQuery with functions
     $soql = new SoqlQuery();
     $soql->where("within_circle(incident_location, {$_POST['latitude']}, {$_POST['longitude']}, {$_POST['range']})")
-         ->limit(20);
+            ->limit(20);
 
     // Get the dataset. $results is now an associative array in the same format as the JSON object
     $results = $ds->getDataset($soql);

Spacing +1 added lines, -1 removed lines

@@ -67,7 +67,7 @@
                 </tr>
 
                 <?php // Loop through all of the results from the dataset ?>
-                <?php foreach($results as $row) { ?>
+                <?php foreach ($results as $row) { ?>
                     <tr>
                         <?php $timestamp = new DateTime($row["event_clearance_date"]); ?>
                         <td><?= $timestamp->format('Y-m-d h:ia') ?></td>

Braces +10 added lines, -3 removed lines

@@ -37,7 +37,9 @@ 
     <body>
         <h1>Seattle Police Department 911 Incident Response</h1>
 
-        <?php if (!$postBack) { ?>
+        <?php if (!$postBack)
+{
+?>
             <form method="POST">
                 <p>Query for all of the Seattle Fire 911 Calls calls within 500 meters of the Socrata offices in Seattle:</p>
                 <p>Try 47.59815, -122.334540 with a range of 500 meters</p>
@@ -56,7 +58,10 @@ 
 
                 <input type="submit" value="Submit"/>
             </form>
-        <?php } else { ?>
+        <?php }
+else
+{
+?>
             <h2>Results</h2>
 
             <?php // Create a table for our actual data ?>
@@ -67,7 +72,9 @@ 
                 </tr>
 
                 <?php // Loop through all of the results from the dataset ?>
-                <?php foreach($results as $row) { ?>
+                <?php foreach($results as $row)
+{
+?>
                     <tr>
                         <?php $timestamp = new DateTime($row["event_clearance_date"]); ?>
                         <td><?= $timestamp->format('Y-m-d h:ia') ?></td>

src/SodaDataset.php

Upper-Lower-Casing +2 added lines, -2 removed lines

@@ -272,9 +272,9 @@
      *
      * @return string The API URL
      */
-    private function buildApiUrl ($location, $identifier = NULL)
+    private function buildApiUrl ($location, $identifier = null)
     {
-        if ($identifier === NULL)
+        if ($identifier === null)
         {
             $identifier = $this->resourceId;
         }

Doc Comments +2 added lines, -2 removed lines

@@ -90,7 +90,7 @@ 
      *
      * @since  0.1.0
      *
-     * @return double The API version number
+     * @return integer The API version number
      */
     public function getApiVersion ()
     {
@@ -136,7 +136,7 @@ 
     /**
      * Fetch a dataset based on a resource ID.
      *
-     * @param  string|SoqlQuery $filterOrSoqlQuery A simple filter or a SoqlQuery to filter the results
+     * @param  SoqlQuery $filterOrSoqlQuery A simple filter or a SoqlQuery to filter the results
      *
      * @see    SodaClient::enableAssociativeArrays()
      * @see    SodaClient::disableAssociativeArrays()

Spacing +1 added lines, -1 removed lines

@@ -340,7 +340,7 @@
         $headers = array();
 
         // For a single row, the format is the `resourceID/rowID.json`, so we'll use that as the "location" of the Api URL
-        $apiEndPoint = $this->buildApiUrl("resource", $this->resourceId . "/" . $rowID);
+        $apiEndPoint = $this->buildApiUrl("resource", $this->resourceId."/".$rowID);
 
         $urlQuery = new UrlQuery($apiEndPoint, $this->sodaClient->getToken(), $this->sodaClient->getEmail(), $this->sodaClient->getPassword());
         $urlQuery->setOAuth2Token($this->sodaClient->getOAuth2Token());

src/SoqlOrderDirection.php

Spacing +1 added lines, -1 removed lines

@@ -20,7 +20,7 @@
     /**
      * The ascending clause Socrata expects
      */
-    const ASC  = 'ASC';
+    const ASC = 'ASC';
 
     /**
      * The descending clause Socrata expects

src/SoqlQuery.php

Spacing +1 added lines, -1 removed lines

@@ -236,7 +236,7 @@
      */
     public function order ($column, $direction = self::DEFAULT_ORDER_DIRECTION)
     {
-        $this->queryElements[self::ORDER_KEY][] = rawurlencode($column . " " . $direction);
+        $this->queryElements[self::ORDER_KEY][] = rawurlencode($column." ".$direction);
 
         return $this;
     }

Braces +3 added lines, -1 removed lines

@@ -87,7 +87,9 @@
      *
      * @since 0.1.0
      */
-    public function __construct () {}
+    public function __construct ()
+    {
+}
 
     /**
      * Convert the current information into a URL encoded query that can be appended to the domain

src/Exceptions/FileNotFoundException.php

Spacing +1 added lines, -1 removed lines

@@ -26,6 +26,6 @@
      */
     public function __construct ($filename)
     {
-        $this->message = "The following file could not be found or opened: " . $filename;
+        $this->message = "The following file could not be found or opened: ".$filename;
     }
 }