Merge pull request chriskacerguis#426 from Tjoosten/master

Add access attribute to docblocks

Author: chriskacerguis

application/libraries/REST_Controller.php

@@ -190,7 +190,8 @@ protected function early_checks()
 
     /**
      * Constructor function
-     * @todo Document more please.
+     * @todo   Document more please.
+     * @access public
      */
     public function __construct($config = 'rest')
     {
@@ -320,6 +321,8 @@ public function __construct($config = 'rest')
     /**
      * Destructor function
      * @author Chris Kacerguis
+     *
+     * @access public
      */
     public function __destruct()
     {
@@ -339,8 +342,9 @@ public function __destruct()
      * an "object". This simply maps the object and method to the correct
      * Controller method.
      *
-     * @param string $object_called
-     * @param array  $arguments     The arguments passed to the controller method.
+     * @access public
+     * @param  string $object_called
+     * @param  array  $arguments     The arguments passed to the controller method.
      */
     public function _remap($object_called, $arguments)
     {
@@ -424,8 +428,9 @@ public function _remap($object_called, $arguments)
      *
      * Fires the designated controller method with the given arguments.
      *
-     * @param array $method The controller method to fire
-     * @param array $args   The arguments to pass to the controller method
+     * @access protected
+     * @param  array $method The controller method to fire
+     * @param  array $args   The arguments to pass to the controller method
      */
     protected function _fire_method($method, $args)
     {
@@ -438,9 +443,10 @@ protected function _fire_method($method, $args)
      * Takes pure data and optionally a status code, then creates the response.
      * Set $continue to TRUE to flush the response to the client and continue running the script.
      *
-     * @param array    $data
-     * @param NULL|int $http_code
-     * @param bool $continue
+     * @access public
+     * @param  array    $data
+     * @param  NULL|int $http_code
+     * @param  bool $continue
      */
     public function response($data = NULL, $http_code = NULL, $continue = FALSE)
     {
@@ -513,10 +519,12 @@ public function response($data = NULL, $http_code = NULL, $continue = FALSE)
         }
     }
 
-    /*
+    /**
      * Detect SSL use
      *
-     * Detect whether SSL is being used or not
+     * Detect whether SSL is being used or not.
+     *
+     * @access protected
      */
     protected function _detect_ssl()
     {
@@ -526,10 +534,12 @@ protected function _detect_ssl()
     }
 
 
-    /*
+    /**
      * Detect input format
      *
      * Detect which format the HTTP Body is provided in
+     *
+     * @access protected
      */
     protected function _detect_input_format()
     {
@@ -554,6 +564,7 @@ protected function _detect_input_format()
      *
      * Detect which format should be used to output the data.
      *
+     * @access protected
      * @return string The output format.
      */
     protected function _detect_output_format()
@@ -626,6 +637,7 @@ protected function _detect_output_format()
      *
      * Detect which HTTP method is being used
      *
+     * @access protected
      * @return string
      */
     protected function _detect_method()
@@ -652,6 +664,7 @@ protected function _detect_method()
      *
      * See if the user has provided an API key
      *
+     * @access protected
      * @return boolean
      */
     protected function _detect_api_key()
@@ -719,6 +732,7 @@ protected function _detect_api_key()
      *
      * What language do they want it in?
      *
+     * @access protected
      * @return NULL|string The language code.
      */
     protected function _detect_lang()
@@ -750,6 +764,7 @@ protected function _detect_lang()
      *
      * Record the entry for awesomeness purposes
      *
+     * @access protected
      * @param  boolean $authorized
      * @return object
      */
@@ -775,6 +790,7 @@ protected function _log_request($authorized = FALSE)
      *
      * Check if the requests are coming in a tad too fast.
      *
+     * @access protected
      * @param  string  $controller_method The method being called.
      * @return boolean
      */
@@ -841,6 +857,7 @@ protected function _check_limit($controller_method)
      * Check if there is a specific auth type set for the current class/method
      * being called.
      *
+     * @access protected
      * @return boolean
      */
     protected function _auth_override_check()
@@ -922,6 +939,8 @@ protected function _auth_override_check()
 
     /**
      * Parse GET
+     *
+     * @access protected
      */
     protected function _parse_get()
     {
@@ -941,6 +960,8 @@ protected function _parse_get()
 
     /**
      * Parse POST
+     *
+     * @access protected
      */
     protected function _parse_post()
     {
@@ -951,6 +972,8 @@ protected function _parse_post()
 
     /**
      * Parse PUT
+     *
+     * @access protected
      */
     protected function _parse_put()
     {
@@ -970,6 +993,8 @@ protected function _parse_put()
 
     /**
      * Parse HEAD
+     *
+     * @access protected
      */
     protected function _parse_head()
     {
@@ -982,6 +1007,8 @@ protected function _parse_head()
 
     /**
      * Parse OPTIONS
+     *
+     * @access protected
      */
     protected function _parse_options()
     {
@@ -994,6 +1021,8 @@ protected function _parse_options()
 
     /**
      * Parse PATCH
+     *
+     * @access protected
      */
     protected function _parse_patch()
     {
@@ -1012,6 +1041,8 @@ protected function _parse_patch()
 
     /**
      * Parse DELETE
+     *
+     * @access protected
      */
     protected function _parse_delete()
     {
@@ -1026,6 +1057,7 @@ protected function _parse_delete()
     /**
      * Retrieve a value from the GET request arguments.
      *
+     * @access public
      * @param  string  $key       The key for the GET request argument to retrieve
      * @param  boolean $xss_clean Whether the value should be XSS cleaned or not.
      * @return string  The GET argument value.
@@ -1042,6 +1074,7 @@ public function get($key = NULL, $xss_clean = TRUE)
     /**
      * This function retrieves a values from the OPTIONS request arguments
      *
+     * @access public
      * @param  string  $key       The OPTIONS/GET argument key
      * @param  boolean $xss_clean Whether the value should be XSS cleaned or not
      * @return string  The OPTIONS/GET argument value
@@ -1058,6 +1091,7 @@ public function options($key = NULL, $xss_clean = TRUE)
     /**
      * This function retrieves a values from the HEAD request arguments
      *
+     * @access public
      * @param  string  $key       The HEAD/GET argument key
      * @param  boolean $xss_clean Whether the value should be XSS cleaned or not
      * @return string  The HEAD/GET argument value
@@ -1074,6 +1108,7 @@ public function head($key = NULL, $xss_clean = TRUE)
     /**
      * Retrieve a value from the POST request arguments.
      *
+     * @access public
      * @param  string  $key       The key for the POST request argument to retrieve
      * @param  boolean $xss_clean Whether the value should be XSS cleaned or not.
      * @return string  The POST argument value.
@@ -1090,6 +1125,7 @@ public function post($key = NULL, $xss_clean = TRUE)
     /**
      * Retrieve a value from the PUT request arguments.
      *
+     * @access public
      * @param  string  $key       The key for the PUT request argument to retrieve
      * @param  boolean $xss_clean Whether the value should be XSS cleaned or not.
      * @return string  The PUT argument value.
@@ -1106,6 +1142,7 @@ public function put($key = NULL, $xss_clean = TRUE)
     /**
      * Retrieve a value from the DELETE request arguments.
      *
+     * @access public
      * @param  string  $key       The key for the DELETE request argument to retrieve
      * @param  boolean $xss_clean Whether the value should be XSS cleaned or not.
      * @return string  The DELETE argument value.
@@ -1122,6 +1159,7 @@ public function delete($key = NULL, $xss_clean = TRUE)
     /**
      * Retrieve a value from the PATCH request arguments.
      *
+     * @access public
      * @param  string  $key       The key for the PATCH request argument to retrieve
      * @param  boolean $xss_clean Whether the value should be XSS cleaned or not.
      * @return string  The PATCH argument value.
@@ -1138,6 +1176,7 @@ public function patch($key = NULL, $xss_clean = TRUE)
     /**
      * Process to protect from XSS attacks.
      *
+     * @access protected
      * @param  string  $val     The input.
      * @param  boolean $process Do clean or note the input.
      * @return string
@@ -1154,6 +1193,7 @@ protected function _xss_clean($val, $process)
     /**
      * Retrieve the validation errors.
      *
+     * @access public
      * @return array
      */
     public function validation_errors()
@@ -1168,6 +1208,7 @@ public function validation_errors()
     /**
      * Perform LDAP Authentication
      *
+     * @access protected
      * @param  string  $username The username to validate
      * @param  string  $password The password to validate
      * @return boolean
@@ -1265,6 +1306,7 @@ protected function _perform_ldap_auth($username = '', $password = NULL)
     /**
      * Perform Library Authentication - Override this function to change the way the library is called
      *
+     * @access protected
      * @param  string  $username The username to validate
      * @param  string  $password The password to validate
      * @return boolean
@@ -1299,6 +1341,7 @@ protected function _perform_library_auth($username = '', $password = NULL)
     /**
      * Check if the user is logged in.
      *
+     * @access protected
      * @param  string  $username The user's name
      * @param  string  $password The user's password
      * @return boolean
@@ -1346,6 +1389,8 @@ protected function _check_login($username = '', $password = FALSE)
 
     /**
      * Check to see if the user is logged into the web app with a php session key.
+     *
+     * @access protected
      */
     protected function _check_php_session()
     {
@@ -1357,6 +1402,8 @@ protected function _check_php_session()
 
     /**
      * @todo document this.
+     *
+     * @access protected
      */
     protected function _prepare_basic_auth()
     {
@@ -1388,6 +1435,8 @@ protected function _prepare_basic_auth()
 
     /**
      * @todo Document this.
+     *
+     * @access protected
      */
     protected function _prepare_digest_auth()
     {
@@ -1435,6 +1484,8 @@ protected function _prepare_digest_auth()
 
     /**
      * Check if the client's ip is in the 'rest_ip_blacklist' config
+     *
+     * @access protected
      */
     protected function _check_blacklist_auth()
     {
@@ -1451,6 +1502,8 @@ protected function _check_blacklist_auth()
 
     /**
      * Check if the client's ip is in the 'rest_ip_whitelist' config
+     *
+     * @access protected
      */
     protected function _check_whitelist_auth()
     {
@@ -1470,7 +1523,8 @@ protected function _check_whitelist_auth()
     /**
      * @todo Document this.
      *
-     * @param string $nonce
+     * @access protected
+     * @param  string $nonce
      */
     protected function _force_login($nonce = '')
     {
@@ -1486,8 +1540,9 @@ protected function _force_login($nonce = '')
     /**
      * Force it into an array
      *
-     * @param  object|array $data
-     * @return array
+     * @access  protected
+     * @param   object|array $data
+     * @return  array
      */
     protected function _force_loopable($data)
     {
@@ -1502,6 +1557,7 @@ protected function _force_loopable($data)
     /**
      * updates the log with the access time
      *
+     * @access protected
      * @author Chris Kacerguis
      * @return boolean
      */
@@ -1516,6 +1572,7 @@ protected function _log_access_time()
     /**
      * Check to see if the API key has access to the controller and methods
      *
+     * @access protected
      * @return boolean
      */
     protected function _check_access()