Merge pull request chriskacerguis#577 from ivantcholakov/master

Configurable supported formats, a PR about chriskacerguis#573.

Author: chriskacerguis

application/config/rest.php

@@ -14,7 +14,7 @@
 
 /*
 |--------------------------------------------------------------------------
-| REST Format
+| REST Output Format
 |--------------------------------------------------------------------------
 |
 | The default format of the response
@@ -31,6 +31,29 @@
 */
 $config['rest_default_format'] = 'json';
 
+/*
+|--------------------------------------------------------------------------
+| REST Supported Output Formats
+|--------------------------------------------------------------------------
+|
+| The following setting contains a list of the supported/allowed formats.
+| You may remove those formats that you don't want to use.
+| If the default format $config['rest_default_format'] is missing within
+| $config['rest_supported_formats'], it will be added silently during
+| REST_Controller initialization.
+|
+*/
+$config['rest_supported_formats'] = [
+    'json',
+    'array',
+    'csv',
+    'html',
+    'jsonp',
+    'php',
+    'serialized',
+    'xml',
+];
+
 /*
 |--------------------------------------------------------------------------
 | REST Status Field Name

application/libraries/REST_Controller.php

@@ -406,6 +406,30 @@ public function __construct($config = 'rest')
         // At present the library is bundled with REST_Controller 2.5+, but will eventually be part of CodeIgniter (no citation)
         $this->load->library('format');
 
+        // Determine supported output formats from configiguration.
+        $supported_formats = $this->config->item('rest_supported_formats');
+
+        // Validate the configuration setting output formats
+        if (empty($supported_formats))
+        {
+            $supported_formats = [];
+        }
+
+        if (!is_array($supported_formats))
+        {
+            $supported_formats = [$supported_formats];
+        }
+
+        // Add silently the default output format if it is missing.
+        $default_format = $this->_get_default_output_format();
+        if (!in_array($default_format, $supported_formats))
+        {
+            $supported_formats[] = $default_format;
+        }
+
+        // Now update $this->_supported_formats
+        $this->_supported_formats = array_intersect_key($this->_supported_formats, array_flip($supported_formats));
+
         // Get the language
         $language = $this->config->item('rest_language');
         if ($language === NULL)
@@ -808,6 +832,20 @@ protected function _detect_input_format()
         return NULL;
     }
 
+    /**
+     * Gets the default format from the configuration. Fallbacks to 'json'.
+     * if the corresponding configuration option $config['rest_default_format']
+     * is missing or is empty.
+     *
+     * @access protected
+     * @return string The default supported input format
+     */
+    protected function _get_default_output_format()
+    {
+        $default_format = (string) $this->config->item('rest_default_format');
+        return $default_format === '' ? 'json' : $default_format;
+    }
+
     /**
      * Detect which format should be used to output the data
      *
@@ -876,7 +914,7 @@ protected function _detect_output_format()
         }
 
         // Obtain the default format from the configuration
-        return $this->config->item('rest_default_format');
+        return $this->_get_default_output_format();
     }
 
     /**