All around cleaning (chriskacerguis#734)

* Fixed throws statement

* Removed unnecessary return doc

* Fixed wrong return value

* Fixed parameter types in PHP DOC

* Removed paths inspection in the project

* Added index methods support! Finally

* Handle all exceptions showings in one place. not 2

* Added changes to the change log

* Fixed properties PHPDoc

* English spelling fixes

Author: AmitMY

CHANGELOG.md

@@ -38,7 +38,7 @@ Changelog:
 * Log Table support for IPv6 & NULL parameters
 * Abstract out the processes of firing a controller method within _remap() to an separate method
 * Moved GET, POST, PUT, and DELETE parsing to separate methods, allowing them to be overridden as needed
-* Small bugfix for a PHP 5.3 strlen error
+* Small bug-fix for a PHP 5.3 strlen error
 * Fixed some PHP 5.4 warnings
 * Fix for bug in Format.php's to_html() which failed to detect if $data was really a multidimensional array.
 * Fix for empty node on XML output format, for false = 0, true = 1.
@@ -55,11 +55,11 @@ Changelog:
 * Support for Backbone.emulateHTTP improved.
 * Combine both URI segment and GET params instead of using one or the other
 * Separate each piece of the WWW-Authenticate header for digest requests with a comma.
-* Added IP whitelist option.
+* Added IP white-list option.
 
 ### 2.5
 
-* Instead of just seeing item, item, item, the singular version of the basenode will be used if possible. [Example](http://d.pr/RS46).
+* Instead of just seeing item, item, item, the singular version of the base-node will be used if possible. [Example](http://d.pr/RS46).
 * Re-factored to use the Format library, which will soon be merged with CodeIgniter.
 * Fixed Limit bug (limit of 5 would allow 6 requests).
 * Added logging for invalid API key requests.

README.md

@@ -150,9 +150,9 @@ Enabling digest auth is similarly easy. Configure your desired logins in the con
 
 If you're tying this library into an AJAX endpoint where clients authenticate using PHP sessions then you may not like either of the digest nor basic authentication methods. In that case, you can tell the REST Library what PHP session variable to check for. If the variable exists, then the user is authorized. It will be up to your application to set that variable. You can define the variable in ``$config['auth_source']``.  Then tell the library to use a php session variable by setting ``$config['rest_auth']`` to ``session``.
 
-All three methods of authentication can be secured further by using an IP whitelist. If you enable `$config['rest_ip_whitelist_enabled']` in your config file, you can then set a list of allowed IPs.
+All three methods of authentication can be secured further by using an IP white-list. If you enable `$config['rest_ip_whitelist_enabled']` in your config file, you can then set a list of allowed IPs.
 
-Any client connecting to your API will be checked against the whitelisted IP array. If they're on the list, they'll be allowed access. If not, sorry, no can do hombre. The whitelist is a comma-separated string:
+Any client connecting to your API will be checked against the white-listed IP array. If they're on the list, they'll be allowed access. If not, sorry, no can do hombre. The whitelist is a comma-separated string:
 
 ```php
 $config['rest_ip_whitelist'] = '123.456.789.0, 987.654.32.1';
@@ -196,7 +196,7 @@ $ curl -X POST -H "X-API-KEY: some_key_here" http://example.com/books
 ## Contributions
 
 This project was originally written by Phil Sturgeon, however his involvement has shifted
-as he is no longer using it.  As of 2013/11/20 further developement and support will be done by Chris Kacerguis.
+as he is no longer using it.  As of 2013/11/20 further development and support will be done by Chris Kacerguis.
 
 Pull Requests are the best way to fix bugs or add features. I know loads of you use this, so please
 contribute if you have improvements to be made and I'll keep releasing versions over time.

application/config/rest.php

@@ -104,8 +104,8 @@
 | Set to specify the REST API requires to be logged in
 |
 | FALSE     No login required
-| 'basic'   Unsecure login
-| 'digest'  More secure login
+| 'basic'   Unsecured login
+| 'digest'  More secured login
 | 'session' Check for a PHP session variable. See 'auth_source' to set the
 |           authorization key
 |
@@ -189,7 +189,7 @@
 
 /*
 |--------------------------------------------------------------------------
-| Override auth types for specfic 'class/method/HTTP method'
+| Override auth types for specific 'class/method/HTTP method'
 |--------------------------------------------------------------------------
 |
 | example:
@@ -214,24 +214,24 @@
 
 /*
 |--------------------------------------------------------------------------
-| Global IP Whitelisting
+| Global IP White-listing
 |--------------------------------------------------------------------------
 |
-| Limit connections to your REST server to whitelisted IP addresses
+| Limit connections to your REST server to White-listed IP addresses
 |
 | Usage:
 | 1. Set to TRUE and select an auth option for extreme security (client's IP
-|    address must be in whitelist and they must also log in)
-| 2. Set to TRUE with auth set to FALSE to allow whitelisted IPs access with no login
-| 3. Set to FALSE but set 'auth_override_class_method' to 'whitelist' to
-|    restrict certain methods to IPs in your whitelist
+|    address must be in white-list and they must also log in)
+| 2. Set to TRUE with auth set to FALSE to allow White-listed IPs access with no login
+| 3. Set to FALSE but set 'auth_override_class_method' to 'white-list' to
+|    restrict certain methods to IPs in your white-list
 |
 */
 $config['rest_ip_whitelist_enabled'] = FALSE;
 
 /*
 |--------------------------------------------------------------------------
-| REST IP Whitelist
+| REST IP White-list
 |--------------------------------------------------------------------------
 |
 | Limit connections to your REST server with a comma separated

application/controllers/api/Example.php

@@ -73,7 +73,7 @@ public function users_get()
             $this->response(NULL, REST_Controller::HTTP_BAD_REQUEST); // BAD_REQUEST (400) being the HTTP response code
         }
 
-        // Get the user from the array, using the id as key for retreival.
+        // Get the user from the array, using the id as key for retrieval.
         // Usually a model is to be used for this.
 
         $user = NULL;

application/libraries/REST_Controller.php

@@ -285,16 +285,16 @@ abstract class REST_Controller extends CI_Controller {
     /**
      * The start of the response time from the server
      *
-     * @var string
+     * @var number
      */
-    protected $_start_rtime = '';
+    protected $_start_rtime;
 
     /**
      * The end of the response time from the server
      *
-     * @var string
+     * @var number
      */
-    protected $_end_rtime = '';
+    protected $_end_rtime;
 
     /**
      * List all supported methods, the first will be the default format
@@ -567,7 +567,7 @@ public function __construct($config = 'rest')
     }
 
     /**
-     * Deconstructor
+     * De-constructor
      *
      * @author Chris Kacerguis
      * @access public
@@ -778,7 +778,7 @@ public function response($data = NULL, $http_code = NULL, $continue = FALSE)
                 $output = $this->format->factory($data)->{'to_' . $this->response->format}();
 
                 // An array must be parsed as a string, so as not to cause an array to string error
-                // Json is the most appropriate form for such a datatype
+                // Json is the most appropriate form for such a data type
                 if ($this->response->format === 'array')
                 {
                     $output = $this->format->factory($output)->{'to_json'}();
@@ -1473,7 +1473,7 @@ protected function _parse_put()
         }
         else if ($this->input->method() === 'put')
         {
-           // If no filetype is provided, then there are probably just arguments
+           // If no file type is provided, then there are probably just arguments
            $this->_put_args = $this->input->input_stream();
         }
     }
@@ -1523,7 +1523,7 @@ protected function _parse_patch()
         }
         else if ($this->input->method() === 'patch')
         {
-            // If no filetype is provided, then there are probably just arguments
+            // If no file type is provided, then there are probably just arguments
             $this->_patch_args = $this->input->input_stream();
         }
     }
@@ -1941,7 +1941,7 @@ protected function _check_php_session()
         // Get the auth_source config item
         $key = $this->config->item('auth_source');
 
-        // If falsy, then the user isn't logged in
+        // If false, then the user isn't logged in
         if ( ! $this->session->userdata($key))
         {
             // Display an error response