Code smell, PHP Doc problems, Index methods, and global exception handler (chriskacerguis#726)

* 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

Author: AmitMY

.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
-vendor
+vendor
+.idea

CHANGELOG.md

@@ -1,6 +1,10 @@
 Changelog:
 ===========
 
+### UNRELEASED
+* Added support for CodeIgniter controller's index methods (index_GET, index_POST...)
+* Added exceptions handling when the method could not be found
+
 ### 2.7.2
 
 * Added $this->query() in which query parameters can now be obtained regardless of whether a GET request is sent or not

application/controllers/api/Example.php

@@ -3,6 +3,7 @@
 defined('BASEPATH') OR exit('No direct script access allowed');
 
 // This can be removed if you use __autoload() in config.php OR use Modular Extensions
+/** @noinspection PhpIncludeInspection */
 require APPPATH . '/libraries/REST_Controller.php';
 
 /**

application/controllers/api/Key.php

@@ -3,6 +3,7 @@
 defined('BASEPATH') OR exit('No direct script access allowed');
 
 // This can be removed if you use __autoload() in config.php OR use Modular Extensions
+/** @noinspection PhpIncludeInspection */
 require APPPATH . '/libraries/REST_Controller.php';
 
 /**

application/libraries/Format.php

@@ -461,8 +461,8 @@ public function to_php($data = NULL)
     // INTERNAL FUNCTIONS
 
     /**
-     * @param $data XML string
-     * @return SimpleXMLElement XML element object; otherwise, empty array
+     * @param string $data XML string
+     * @return array XML element object; otherwise, empty array
      */
     protected function _from_xml($data)
     {
@@ -496,7 +496,7 @@ protected function _from_csv($data, $delimiter = ',', $enclosure = '"')
     }
 
     /**
-     * @param $data Encoded json string
+     * @param string $data Encoded json string
      * @return mixed Decoded json string with leading and trailing whitespace removed
      */
     protected function _from_json($data)
@@ -505,7 +505,7 @@ protected function _from_json($data)
     }
 
     /**
-     * @param string Data to unserialized
+     * @param string $data Data to unserialize
      * @return mixed Unserialized data
      */
     protected function _from_serialize($data)
@@ -514,7 +514,7 @@ protected function _from_serialize($data)
     }
 
     /**
-     * @param $data Data to trim leading and trailing whitespace
+     * @param string $data Data to trim leading and trailing whitespace
      * @return string Data with leading and trailing whitespace removed
      */
     protected function _from_php($data)

application/libraries/REST_Controller.php

@@ -375,7 +375,6 @@ protected function early_checks()
      * @access public
      * @param string $config Configuration filename minus the file extension
      * e.g: my_rest.php is passed as 'my_rest'
-     * @return void
      */
     public function __construct($config = 'rest')
     {
@@ -590,7 +589,7 @@ public function __destruct()
      * Checks to see if we have everything we need to run this library.
      *
      * @access protected
-     * @return Exception
+     * @@throws Exception
      */
     protected function preflight_checks()
     {
@@ -632,6 +631,11 @@ public function _remap($object_called, $arguments = [])
         $object_called = preg_replace('/^(.*)\.(?:'.implode('|', array_keys($this->_supported_formats)).')$/', '$1', $object_called);
 
         $controller_method = $object_called.'_'.$this->request->method;
+	    // Does this method exist? If not, try executing an index method
+	    if (!method_exists($this, $controller_method)) {
+		    $controller_method = "index_" . $this->request->method;
+		    array_unshift($arguments, $object_called);
+	    }
 
         // Do we want to log this method (if allowed by config)?
         $log_method = ! (isset($this->methods[$controller_method]['log']) && $this->methods[$controller_method]['log'] === FALSE);
@@ -725,13 +729,8 @@ public function _remap($object_called, $arguments = [])
         catch (Exception $ex)
         {
             // If the method doesn't exist, then the error will be caught and an error response shown
-            $this->response([
-                    $this->config->item('rest_status_field_name') => FALSE,
-                    $this->config->item('rest_message_field_name') => [
-                        'classname' => get_class($ex),
-                        'message' => $ex->getMessage()
-                    ]
-                ], self::HTTP_INTERNAL_SERVER_ERROR);
+	        $_error = &load_class('Exceptions', 'core');
+	        $_error->show_exception($ex);
         }
     }