ci-bonfire / Sprint

myth/Api/Server/ApiController.php

Indentation +68 added lines, -68 removed lines

@@ -1,34 +1,34 @@ 
 <?php namespace Myth\Api\Server;
 /**
- * Sprint
- *
- * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @package     Sprint
- * @author      Lonnie Ezell
- * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
- * @license     http://opensource.org/licenses/MIT  (MIT)
- * @link        http://sprintphp.com
- * @since       Version 1.0
- */
+	 * Sprint
+	 *
+	 * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
+	 *
+	 * Permission is hereby granted, free of charge, to any person obtaining a copy
+	 * of this software and associated documentation files (the "Software"), to deal
+	 * in the Software without restriction, including without limitation the rights
+	 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	 * copies of the Software, and to permit persons to whom the Software is
+	 * furnished to do so, subject to the following conditions:
+	 *
+	 * The above copyright notice and this permission notice shall be included in
+	 * all copies or substantial portions of the Software.
+	 *
+	 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+	 * THE SOFTWARE.
+	 *
+	 * @package     Sprint
+	 * @author      Lonnie Ezell
+	 * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
+	 * @license     http://opensource.org/licenses/MIT  (MIT)
+	 * @link        http://sprintphp.com
+	 * @since       Version 1.0
+	 */
 
 use Myth\Auth\AuthTrait;
 use Myth\Controllers\BaseController;
@@ -141,8 +141,8 @@ 
 	 * @var array
 	 */
 	protected $codes = array(
-        'created'                   => 201,
-        'deleted'                   => 200,
+		'created'                   => 201,
+		'deleted'                   => 200,
 		'invalid_request'           => 400,
 		'unsupported_response_type' => 400,
 		'invalid_scope'             => 400,
@@ -166,32 +166,32 @@ 
 		'not_implemented'           => 501
 	);
 
-    /**
-     * Convert common browser-sent langauge
-     * strings to a folder name in the languages folder
-     * that we want to use.
-     *
-     * Primarily used for converting to english when
-     * viewing the API in a browser.
-     *
-     * @var array
-     */
-    protected $lang_map = [
-        'en-us' => 'english',
-        'en'    => 'english',
-        'eng'   => 'english',
-        'en-au' => 'english',
-        'en-nz' => 'english',
-        'en-za' => 'english',
-        'en-tt' => 'english',
-        'en-gb' => 'english',
-        'en-ca' => 'english',
-        'en-ie' => 'english',
-        'en-jm' => 'english',
-        'en-bz' => 'english',
-    ];
-
-    /**
+	/**
+	 * Convert common browser-sent langauge
+	 * strings to a folder name in the languages folder
+	 * that we want to use.
+	 *
+	 * Primarily used for converting to english when
+	 * viewing the API in a browser.
+	 *
+	 * @var array
+	 */
+	protected $lang_map = [
+		'en-us' => 'english',
+		'en'    => 'english',
+		'eng'   => 'english',
+		'en-au' => 'english',
+		'en-nz' => 'english',
+		'en-za' => 'english',
+		'en-tt' => 'english',
+		'en-gb' => 'english',
+		'en-ca' => 'english',
+		'en-ie' => 'english',
+		'en-jm' => 'english',
+		'en-bz' => 'english',
+	];
+
+	/**
 	 * If you wish to override the default authentication
 	 * library used for authentication, set this to the
 	 * fully namespaced class name.
@@ -544,7 +544,7 @@ 
 	 */
 	public function grabVar($name)
 	{
-	    return array_key_exists($name, $this->vars) ? $this->vars[$name] : false;
+		return array_key_exists($name, $this->vars) ? $this->vars[$name] : false;
 	}
 
 	//--------------------------------------------------------------------
@@ -757,12 +757,12 @@ 
 				// Remove weight and strip space
 				list($lang) = explode(';', $lang);
 
-                $lang = strtolower(trim($lang));
+				$lang = strtolower(trim($lang));
 
-                if (array_key_exists($lang, $this->lang_map))
-                {
-                    $lang = $this->lang_map[$lang];
-                }
+				if (array_key_exists($lang, $this->lang_map))
+				{
+					$lang = $this->lang_map[$lang];
+				}
 
 				$return_langs[] = $lang;
 			}
@@ -782,10 +782,10 @@ 
 	 */
 	public function detectFields()
 	{
-	    if (! array_key_exists('fields', $_GET))
-	    {
-		    return;
-	    }
+		if (! array_key_exists('fields', $_GET))
+		{
+			return;
+		}
 
 		$fields = explode(',', $_GET['fields']);
 
@@ -814,7 +814,7 @@ 
 			return;
 		}
 
-	    $model = new LogModel();
+		$model = new LogModel();
 
 		$data = [
 			'duration' => microtime(true) - $this->start_time,

Spacing +38 added lines, -38 removed lines

@@ -222,7 +222,7 @@ 
 		$this->request->lang    = $this->detectLanguage();
 
 		// Load our language, requested.
-		if (! empty($this->request->lang))
+		if ( ! empty($this->request->lang))
 		{
 			$file = ! empty($this->language_file) ? $this->language_file : 'application';
 
@@ -241,20 +241,20 @@ 
 		$this->config->load('api');
 
 		// Gather config defaults when a value isn't set for this controller
-		if ( empty($this->enable_logging) ) $this->enable_logging = config_item('api.enable_logging');
-		if ( empty($this->enable_rate_limits) ) $this->enable_rate_limits = config_item('api.enable_rate_limits');
-		if ( empty($this->rate_limits) ) $this->rate_limits = config_item('api.rate_limits');
+		if (empty($this->enable_logging)) $this->enable_logging = config_item('api.enable_logging');
+		if (empty($this->enable_rate_limits)) $this->enable_rate_limits = config_item('api.enable_rate_limits');
+		if (empty($this->rate_limits)) $this->rate_limits = config_item('api.rate_limits');
 
 		// Should we restrict to SSL requests?
 		if (config_item('api.require_ssl') === true && ! $this->request->ssl)
 		{
-			$this->failForbidden( lang('api.ssl_required') );
+			$this->failForbidden(lang('api.ssl_required'));
 		}
 
 		// Should we restrict to only allow AJAX requests?
-		if (config_item('api.ajax_only') === true && ! $this->input->is_ajax_request() )
+		if (config_item('api.ajax_only') === true && ! $this->input->is_ajax_request())
 		{
-			$this->failForbidden( lang('api.ajax_required') );
+			$this->failForbidden(lang('api.ajax_required'));
 		}
 
 		$this->detectPage();
@@ -266,17 +266,17 @@ 
 			// in a single codebase.
 			get_instance()->config->set_item('api.authenticate_lib', $this->authenticate_class);
 
-			if (! $this->restrict(null, true) )
+			if ( ! $this->restrict(null, true))
 			{
 				$this->logTime();
-				$this->failUnauthorized( lang('api.unauthorized') );
+				$this->failUnauthorized(lang('api.unauthorized'));
 			}
 		}
 
 		// Has the user hit rate limits for this hour?
 		if ($this->enable_rate_limits && ! $this->isWithinLimits())
 		{
-			$this->failTooManyRequests( sprintf( lang('api.too_many_requests'), $this->rate_limits) );
+			$this->failTooManyRequests(sprintf(lang('api.too_many_requests'), $this->rate_limits));
 		}
 
 		// NEVER allow profiling via API.
@@ -310,7 +310,7 @@ 
 		}
 		else
 		{
-			return $this->fail( lang('api.unknown_endpoint'), 'not_implemented');
+			return $this->fail(lang('api.unknown_endpoint'), 'not_implemented');
 		}
 	}
 
@@ -331,7 +331,7 @@ 
 	 *
 	 * @return mixed
 	 */
-	public function respond ($data = null, $status_code = 200)
+	public function respond($data = null, $status_code = 200)
 	{
 		// If data is null and not code provide, error and bail
 		if ($data === null && $status_code === null)
@@ -357,7 +357,7 @@ 
 
 		set_status_header($status_code);
 
-		header('Content-Length: ' . strlen($output));
+		header('Content-Length: '.strlen($output));
 
 		exit($output);
 	}
@@ -374,7 +374,7 @@ 
 	 *
 	 * @return mixed
 	 */
-	protected function fail ($description, $status_code, $error_code = 'invalid_request')
+	protected function fail($description, $status_code, $error_code = 'invalid_request')
 	{
 		if (is_string($status_code))
 		{
@@ -585,26 +585,26 @@ 
 
 		$params['page'] = ($this->page > 1 ? $this->page + 1 : 2);
 
-		if (! $clean_get)
+		if ( ! $clean_get)
 		{
-			if ( ! isset($_GET) || ! is_array($_GET) )
+			if ( ! isset($_GET) || ! is_array($_GET))
 			{
 				$_GET = [];
 			}
 
-			foreach ( $_GET as $key => $value )
+			foreach ($_GET as $key => $value)
 			{
-				$params[ $key ] = $value;
+				$params[$key] = $value;
 			}
 
 			// Ensure we get a correct per_page value
-			if (! array_key_exists('per_page', $params))
+			if ( ! array_key_exists('per_page', $params))
 			{
 				$params['per_page'] = $this->per_page;
 			}
 		}
 
-		return site_url($path) .'?'. http_build_query($params);
+		return site_url($path).'?'.http_build_query($params);
 	}
 
 	//--------------------------------------------------------------------
@@ -625,7 +625,7 @@ 
 	 *
 	 * @return string
 	 */
-	public function prevURL ($path, $clean_get = false)
+	public function prevURL($path, $clean_get = false)
 	{
 		// If paging is turned off, get out of here
 		if ($this->per_page == 0)
@@ -637,26 +637,26 @@ 
 
 		$params['page'] = ($this->page > 1 ? $this->page - 1 : 1);
 
-		if (! $clean_get)
+		if ( ! $clean_get)
 		{
-			if ( ! isset($_GET) || ! is_array($_GET) )
+			if ( ! isset($_GET) || ! is_array($_GET))
 			{
 				$_GET = [];
 			}
 
-			foreach ( $_GET as $key => $value )
+			foreach ($_GET as $key => $value)
 			{
 				$params[$key] = $value;
 			}
 
 			// Ensure we get a correct per_page value
-			if (! array_key_exists('per_page', $params))
+			if ( ! array_key_exists('per_page', $params))
 			{
 				$params['per_page'] = $this->per_page;
 			}
 		}
 
-		return site_url($path) .'?'. http_build_query($params);
+		return site_url($path).'?'.http_build_query($params);
 	}
 
 	//--------------------------------------------------------------------
@@ -675,11 +675,11 @@ 
 	protected function detectPage( )
 	{
 		// Is a per-page limit being set?
-		$this->per_page = isset($_GET['per_page']) ? (int)$_GET['per_page'] : $this->per_page;
+		$this->per_page = isset($_GET['per_page']) ? (int) $_GET['per_page'] : $this->per_page;
 
-		$page = (int)$this->input->get('page');
+		$page = (int) $this->input->get('page');
 
-		if (! $page || $page == 1)
+		if ( ! $page || $page == 1)
 		{
 			$offset = 0;
 		}
@@ -693,7 +693,7 @@ 
 
 		// If they've specifically passed in page=0, then we need
 		// to ignore paging...
-		if ((int)$this->input->get('page') === 0 && ! is_null($this->input->get('page')) )
+		if ((int) $this->input->get('page') === 0 && ! is_null($this->input->get('page')))
 		{
 			$this->per_page = 0;
 		}
@@ -715,7 +715,7 @@ 
 		$method = strtolower($this->input->server('REQUEST_METHOD'));
 
 		// If it's not an allowed method, let's default to a GET
-		if (! in_array($method, $this->allowed_http_methods))
+		if ( ! in_array($method, $this->allowed_http_methods))
 		{
 			$method = 'get';
 		}
@@ -775,7 +775,7 @@ 
 				// We must check to see if the folder exists
 				// here since CI's lang->load will throw
 				// an error if the language doesn't exist.
-				if (is_dir(APPPATH .'language/'. $lang))
+				if (is_dir(APPPATH.'language/'.$lang))
 				{
 					$return_langs[] = $lang;
 				}
@@ -783,7 +783,7 @@ 
 
 			// If no languages were added, let the script
 			// send the default language back instead.
-			if (! empty($return_langs))
+			if ( ! empty($return_langs))
 			{
 				return $return_langs;
 			}
@@ -801,14 +801,14 @@ 
 	 */
 	public function detectFields()
 	{
-	    if (! array_key_exists('fields', $_GET))
+	    if ( ! array_key_exists('fields', $_GET))
 	    {
 		    return;
 	    }
 
 		$fields = explode(',', $_GET['fields']);
 
-		if (! is_array($fields))
+		if ( ! is_array($fields))
 		{
 			return;
 		}
@@ -828,7 +828,7 @@ 
 	 */
 	public function logTime()
 	{
-		if (! $this->enable_logging)
+		if ( ! $this->enable_logging)
 		{
 			return;
 		}
@@ -839,7 +839,7 @@ 
 			'duration' => microtime(true) - $this->start_time,
 			'user_id'  => $this->authenticate->id(),
 			'ip_address' => $this->input->ip_address(),
-			'request'  => $this->uri->uri_string() .'?'. $_SERVER['QUERY_STRING'],
+			'request'  => $this->uri->uri_string().'?'.$_SERVER['QUERY_STRING'],
 			'method'   => $this->request->method
 		];
 
@@ -860,7 +860,7 @@ 
 	{
 		$model = new LogModel();
 
-		if ($model->requestsThisHourForUser( $this->authenticate->id() ) > $this->rate_limits)
+		if ($model->requestsThisHourForUser($this->authenticate->id()) > $this->rate_limits)
 		{
 			return false;
 		}