ci-bonfire / Sprint

myth/Auth/AuthTrait.php

Doc Comments +3 added lines, -3 removed lines

@@ -54,7 +54,7 @@ 
 	 * @param null $uri
 	 * @param bool $return_only
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function restrict($uri=null, $return_only=false)
 	{
@@ -104,7 +104,7 @@ 
 	 * @param mixed  $groups
 	 * @param string $uri   The URI to redirect to on fail.
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function restrictToGroups($groups, $uri='')
 	{
@@ -145,7 +145,7 @@ 
 	 * @param $permissions
 	 * @param string $uri   The URI to redirect to on fail.
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function restrictWithPermissions($permissions, $uri='')
 	{

Indentation +32 added lines, -32 removed lines

@@ -1,34 +1,34 @@ 
 <?php namespace Myth\Auth;
 /**
- * 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
+	 */
 
 trait AuthTrait {
 
@@ -58,7 +58,7 @@ 
 	 */
 	public function restrict($uri=null, $return_only=false)
 	{
-	    $this->setupAuthClasses();
+		$this->setupAuthClasses();
 
 		if ($this->authenticate->isLoggedIn())
 		{
@@ -108,7 +108,7 @@ 
 	 */
 	public function restrictToGroups($groups, $uri='')
 	{
-	    $this->setupAuthClasses();
+		$this->setupAuthClasses();
 
 		if ($this->authenticate->isLoggedIn())
 		{
@@ -149,7 +149,7 @@ 
 	 */
 	public function restrictWithPermissions($permissions, $uri='')
 	{
-	    $this->setupAuthClasses();
+		$this->setupAuthClasses();
 
 		if ($this->authenticate->isLoggedIn())
 		{

Spacing +18 added lines, -18 removed lines

@@ -56,7 +56,7 @@ 
 	 *
 	 * @return bool
 	 */
-	public function restrict($uri=null, $return_only=false)
+	public function restrict($uri = null, $return_only = false)
 	{
 	    $this->setupAuthClasses();
 
@@ -67,7 +67,7 @@ 
 
 		if (method_exists($this, 'setMessage'))
 		{
-			$this->setMessage( lang('auth.not_logged_in') );
+			$this->setMessage(lang('auth.not_logged_in'));
 		}
 
 		if ($return_only)
@@ -77,7 +77,7 @@ 
 
 		if (empty($uri))
 		{
-			redirect( \Myth\Route::named('login') );
+			redirect(\Myth\Route::named('login'));
 		}
 
 		redirect($uri);
@@ -106,13 +106,13 @@ 
 	 *
 	 * @return bool
 	 */
-	public function restrictToGroups($groups, $uri='')
+	public function restrictToGroups($groups, $uri = '')
 	{
 	    $this->setupAuthClasses();
 
 		if ($this->authenticate->isLoggedIn())
 		{
-			if ($this->authorize->inGroup($groups, $this->authenticate->id() ) )
+			if ($this->authorize->inGroup($groups, $this->authenticate->id()))
 			{
 				return true;
 			}
@@ -120,15 +120,15 @@ 
 
 		if (method_exists($this, 'setMessage'))
 		{
-			$this->setMessage( lang('auth.not_enough_privilege') );
+			$this->setMessage(lang('auth.not_enough_privilege'));
 		}
 
 		if (empty($uri))
 		{
-			redirect( \Myth\Route::named('login') .'?request_uri='. current_url() );
+			redirect(\Myth\Route::named('login').'?request_uri='.current_url());
 		}
 
-		redirect($uri .'?request_uri='. current_url());
+		redirect($uri.'?request_uri='.current_url());
 	}
 
 	//--------------------------------------------------------------------
@@ -147,13 +147,13 @@ 
 	 *
 	 * @return bool
 	 */
-	public function restrictWithPermissions($permissions, $uri='')
+	public function restrictWithPermissions($permissions, $uri = '')
 	{
 	    $this->setupAuthClasses();
 
 		if ($this->authenticate->isLoggedIn())
 		{
-			if ($this->authorize->hasPermission($permissions, $this->authenticate->id() ) )
+			if ($this->authorize->hasPermission($permissions, $this->authenticate->id()))
 			{
 				return true;
 			}
@@ -161,15 +161,15 @@ 
 
 		if (method_exists($this, 'setMessage'))
 		{
-			$this->setMessage( lang('auth.not_enough_privilege') );
+			$this->setMessage(lang('auth.not_enough_privilege'));
 		}
 
 		if (empty($uri))
 		{
-			redirect( \Myth\Route::named('login') .'?request_uri='. current_url() );
+			redirect(\Myth\Route::named('login').'?request_uri='.current_url());
 		}
 
-		redirect($uri .'?request_uri='. current_url());
+		redirect($uri.'?request_uri='.current_url());
 	}
 
 	//--------------------------------------------------------------------
@@ -198,16 +198,16 @@ 
 		$auth = config_item('auth.authenticate_lib');
 
 		if (empty($auth)) {
-			throw new \RuntimeException( lang('auth.no_authenticate') );
+			throw new \RuntimeException(lang('auth.no_authenticate'));
 		}
 
-		$this->authenticate = new $auth( get_instance() );
+		$this->authenticate = new $auth(get_instance());
 
 		get_instance()->load->model('auth/user_model', 'user_model', true);
-		$this->authenticate->useModel( get_instance()->user_model );
+		$this->authenticate->useModel(get_instance()->user_model);
 
 		// Try to log us in automatically.
-		if (! $this->authenticate->isLoggedIn())
+		if ( ! $this->authenticate->isLoggedIn())
 		{
 			$this->authenticate->viaRemember();
 		}
@@ -218,7 +218,7 @@ 
 		$auth = config_item('auth.authorize_lib');
 
 		if (empty($auth)) {
-			throw new \RuntimeException( lang('auth.no_authenticate') );
+			throw new \RuntimeException(lang('auth.no_authenticate'));
 		}
 
 		$this->authorize = new $auth();

myth/Auth/FlatAuthorization.php

Doc Comments +15 added lines, -15 removed lines

@@ -68,7 +68,7 @@ 
 	 * model that should be used.
 	 *
 	 * @param $model
-	 * @return mixed
+	 * @return FlatAuthorization
 	 */
 	public function useModel($model)
 	{
@@ -92,7 +92,7 @@ 
 	 *
 	 * @param $groups
 	 *
-	 * @return bool
+	 * @return null|boolean
 	 */
 	public function inGroup( $groups, $user_id )
 	{
@@ -145,7 +145,7 @@ 
 	 * @param int|string $permission
 	 * @param int|string $user_id
 	 *
-	 * @return mixed
+	 * @return null|boolean
 	 */
 	public function hasPermission( $permission, $user_id )
 	{
@@ -185,7 +185,7 @@ 
 	 * @param $user_id
 	 * @param $group // Either ID or name
 	 *
-	 * @return bool
+	 * @return null|boolean
 	 */
 	public function addUserToGroup( $user_id, $group )
 	{
@@ -232,7 +232,7 @@ 
 	 * @param $user_id
 	 * @param $group
 	 *
-	 * @return mixed
+	 * @return null|boolean
 	 */
 	public function removeUserFromGroup( $user_id, $group )
 	{
@@ -276,10 +276,10 @@ 
 	/**
 	 * Adds a single permission to a single group.
 	 *
-	 * @param int|string $permission
-	 * @param int|string $group
+	 * @param string $permission
+	 * @param string $group
 	 *
-	 * @return mixed
+	 * @return boolean
 	 */
 	public function addPermissionToGroup( $permission, $group )
 	{
@@ -317,7 +317,7 @@ 
 	 * @param int|string $permission
 	 * @param int|string $group
 	 *
-	 * @return mixed
+	 * @return boolean
 	 */
 	public function removePermissionFromGroup( $permission, $group )
 	{
@@ -455,8 +455,8 @@ 
 	/**
 	 * Checks to see if a user has private permission assigned to it.
 	 *
-	 * @param $user_id
-	 * @param $permission
+	 * @param integer $user_id
+	 * @param integer $permission
 	 *
 	 * @return bool|null
 	 */
@@ -531,7 +531,7 @@ 
 	//--------------------------------------------------------------------
 
 	/**
-	 * @param $name
+	 * @param string $name
 	 * @param string $description
 	 *
 	 * @return mixed
@@ -585,7 +585,7 @@ 
 	 * @param $name
 	 * @param string $description
 	 *
-	 * @return mixed
+	 * @return boolean
 	 */
 	public function updateGroup( $id, $name, $description = '' )
 	{
@@ -677,7 +677,7 @@ 
 	/**
 	 * Creates a single permission.
 	 *
-	 * @param $name
+	 * @param string $name
 	 * @param string $description
 	 *
 	 * @return mixed
@@ -708,7 +708,7 @@ 
 	 *
 	 * @param $permission
 	 *
-	 * @return mixed
+	 * @return boolean
 	 */
 	public function deletePermission( $permission_id )
 	{

Spacing +83 added lines, -83 removed lines

@@ -49,7 +49,7 @@ 
 	public function __construct($groupModel = null, $permModel = null)
 	{
 		$this->groupModel      = ! empty($groupModel) ? $groupModel : new FlatGroupsModel();
-		$this->permissionModel = ! empty($permModel)  ? $permModel  : new FlatPermissionsModel();
+		$this->permissionModel = ! empty($permModel) ? $permModel : new FlatPermissionsModel();
 
 		get_instance()->load->language('auth/auth');
 	}
@@ -72,7 +72,7 @@ 
 	 */
 	public function useModel($model)
 	{
-		$this->user_model =& $model;
+		$this->user_model = & $model;
 
 		return $this;
 	}
@@ -94,11 +94,11 @@ 
 	 *
 	 * @return bool
 	 */
-	public function inGroup( $groups, $user_id )
+	public function inGroup($groups, $user_id)
 	{
-		if ( ! is_array( $groups ) )
+		if ( ! is_array($groups))
 		{
-			$groups = [ $groups ];
+			$groups = [$groups];
 		}
 
 		if (empty($user_id))
@@ -106,14 +106,14 @@ 
 			return null;
 		}
 
-		$user_groups = $this->groupModel->getGroupsForUser( (int) $user_id );
+		$user_groups = $this->groupModel->getGroupsForUser((int) $user_id);
 
-		if ( ! $user_groups )
+		if ( ! $user_groups)
 		{
 			return false;
 		}
 
-		foreach ( $groups as $group )
+		foreach ($groups as $group)
 		{
 			if (is_numeric($group))
 			{
@@ -147,9 +147,9 @@ 
 	 *
 	 * @return mixed
 	 */
-	public function hasPermission( $permission, $user_id )
+	public function hasPermission($permission, $user_id)
 	{
-		if (empty($permission) || (! is_string($permission) && ! is_numeric($permission)) )
+		if (empty($permission) || ( ! is_string($permission) && ! is_numeric($permission)))
 		{
 			return null;
 		}
@@ -162,19 +162,19 @@ 
 		// Get the Permission ID
 		$permission_id = $this->getPermissionID($permission);
 
-		if ( ! is_numeric( $permission_id ) )
+		if ( ! is_numeric($permission_id))
 		{
 			return false;
 		}
 
 		// First check the permission model. If that exists, then we're golden.
-		if ($this->permissionModel->doesUserHavePermission( (int)$user_id, (int)$permission_id ) )
+		if ($this->permissionModel->doesUserHavePermission((int) $user_id, (int) $permission_id))
 		{
 			return true;
 		}
 
 		// Still here? Then we have one last check to make - any user private permissions.
-		return $this->doesUserHavePermission( (int)$user_id, (int)$permission_id);
+		return $this->doesUserHavePermission((int) $user_id, (int) $permission_id);
 	}
 
 	//--------------------------------------------------------------------
@@ -187,19 +187,19 @@ 
 	 *
 	 * @return bool
 	 */
-	public function addUserToGroup( $user_id, $group )
+	public function addUserToGroup($user_id, $group)
 	{
 		if (empty($user_id) || ! is_numeric($user_id))
 		{
 			return null;
 		}
 
-		if (empty($group) || (! is_numeric($group) && ! is_string($group) ) )
+		if (empty($group) || ( ! is_numeric($group) && ! is_string($group)))
 		{
 			return null;
 		}
 
-		if (! Events::trigger('beforeAddUserToGroup', [$user_id, $group]))
+		if ( ! Events::trigger('beforeAddUserToGroup', [$user_id, $group]))
 		{
 			return false;
 		}
@@ -207,12 +207,12 @@ 
 		$group_id = $this->getGroupID($group);
 
 		// Group ID
-		if ( ! is_numeric( $group_id ) )
+		if ( ! is_numeric($group_id))
 		{
 			return null;
 		}
 
-		if ( ! $this->groupModel->addUserToGroup( (int)$user_id, (int)$group_id ) )
+		if ( ! $this->groupModel->addUserToGroup((int) $user_id, (int) $group_id))
 		{
 			$this->error = $this->groupModel->error();
 
@@ -234,19 +234,19 @@ 
 	 *
 	 * @return mixed
 	 */
-	public function removeUserFromGroup( $user_id, $group )
+	public function removeUserFromGroup($user_id, $group)
 	{
 		if (empty($user_id) || ! is_numeric($user_id))
 		{
 			return null;
 		}
 
-		if (empty($group) || (! is_numeric($group) && ! is_string($group) ) )
+		if (empty($group) || ( ! is_numeric($group) && ! is_string($group)))
 		{
 			return null;
 		}
 
-		if (! Events::trigger('beforeRemoveUserFromGroup', [$user_id, $group]))
+		if ( ! Events::trigger('beforeRemoveUserFromGroup', [$user_id, $group]))
 		{
 			return false;
 		}
@@ -254,12 +254,12 @@ 
 		$group_id = $this->getGroupID($group);
 
 		// Group ID
-		if ( ! is_numeric( $group_id ) )
+		if ( ! is_numeric($group_id))
 		{
 			return false;
 		}
 
-		if ( ! $this->groupModel->removeUserFromGroup( $user_id, $group_id ) )
+		if ( ! $this->groupModel->removeUserFromGroup($user_id, $group_id))
 		{
 			$this->error = $this->groupModel->error();
 
@@ -281,25 +281,25 @@ 
 	 *
 	 * @return mixed
 	 */
-	public function addPermissionToGroup( $permission, $group )
+	public function addPermissionToGroup($permission, $group)
 	{
 		$permission_id = $this->getPermissionID($permission);
 		$group_id      = $this->getGroupID($group);
 
 		// Permission ID
-		if ( ! is_numeric( $permission_id ) )
+		if ( ! is_numeric($permission_id))
 		{
 			return false;
 		}
 
 		// Group ID
-		if ( ! is_numeric( $group_id ) )
+		if ( ! is_numeric($group_id))
 		{
 			return false;
 		}
 
 		// Remove it!
-		if ( ! $this->groupModel->addPermissionToGroup( $permission_id, $group_id ) )
+		if ( ! $this->groupModel->addPermissionToGroup($permission_id, $group_id))
 		{
 			$this->error = $this->groupModel->error();
 
@@ -319,25 +319,25 @@ 
 	 *
 	 * @return mixed
 	 */
-	public function removePermissionFromGroup( $permission, $group )
+	public function removePermissionFromGroup($permission, $group)
 	{
 		$permission_id = $this->getPermissionID($permission);
 		$group_id      = $this->getGroupID($group);
 
 		// Permission ID
-		if ( ! is_numeric( $permission_id ) )
+		if ( ! is_numeric($permission_id))
 		{
 			return false;
 		}
 
 		// Group ID
-		if ( ! is_numeric( $group_id ) )
+		if ( ! is_numeric($group_id))
 		{
 			return false;
 		}
 
 		// Remove it!
-		if ( ! $this->groupModel->removePermissionFromGroup( $permission_id, $group_id ) )
+		if ( ! $this->groupModel->removePermissionFromGroup($permission_id, $group_id))
 		{
 			$this->error = $this->groupModel->error();
 
@@ -358,11 +358,11 @@ 
 	 *
 	 * @return int|bool
 	 */
-	public function addPermissionToUser( $permission, $user_id )
+	public function addPermissionToUser($permission, $user_id)
 	{
 		$permission_id = $this->getPermissionID($permission);
 
-		if (! is_numeric($permission_id) )
+		if ( ! is_numeric($permission_id))
 		{
 			return null;
 		}
@@ -372,21 +372,21 @@ 
 			return null;
 		}
 
-		$user_id = (int)$user_id;
+		$user_id = (int) $user_id;
 
-		if (! Events::trigger('beforeAddPermissionToUser', [$user_id, $permission]))
+		if ( ! Events::trigger('beforeAddPermissionToUser', [$user_id, $permission]))
 		{
 			return false;
 		}
 
-		$ci =& get_instance();
+		$ci = & get_instance();
 		$ci->load->model('User_model');
 
 		$permissions = $ci->user_model->getMetaItem($user_id, 'RBAC_permissions');
 
 		// If we already have permissions, unserialize them and add
 		// the new permission to it.
-		if (! empty($permissions))
+		if ( ! empty($permissions))
 		{
 			$permissions = unserialize($permissions);
 		}
@@ -411,11 +411,11 @@ 
 	 * @param int/string $permission
 	 * @param int        $user_id
 	 */
-	public function removePermissionFromUser( $permission, $user_id )
+	public function removePermissionFromUser($permission, $user_id)
 	{
 		$permission_id = $this->getPermissionID($permission);
 
-		if (! is_numeric($permission_id) )
+		if ( ! is_numeric($permission_id))
 		{
 			return false;
 		}
@@ -425,26 +425,26 @@ 
 			return null;
 		}
 
-		$user_id = (int)$user_id;
+		$user_id = (int) $user_id;
 
-		if (! Events::trigger('beforeRemovePermissionFromUser', [$user_id, $permission]))
+		if ( ! Events::trigger('beforeRemovePermissionFromUser', [$user_id, $permission]))
 		{
 			return false;
 		}
 
 		// Grab the existing permissions for this user, and remove
 		// the permission id from the list.
-		$ci =& get_instance();
+		$ci = & get_instance();
 		$ci->load->model('User_model');
 
 		$permissions = $ci->user_model->getMetaItem($user_id, 'RBAC_permissions');
 
-		if (! is_array($permissions))
+		if ( ! is_array($permissions))
 		{
 			$permissions = [];
 		}
 
-		unset($permissions[ array_search($permission_id, $permissions) ]);
+		unset($permissions[array_search($permission_id, $permissions)]);
 
 		// Save the updated permissions
 		return $ci->user_model->saveMetaToUser($user_id, 'RBAC_permissions', serialize($permissions));
@@ -464,7 +464,7 @@ 
 	{
 		$permission_id = $this->getPermissionID($permission);
 
-		if (! is_numeric($permission_id) )
+		if ( ! is_numeric($permission_id))
 		{
 			return false;
 		}
@@ -474,14 +474,14 @@ 
 			return null;
 		}
 
-		$user_id = (int)$user_id;
+		$user_id = (int) $user_id;
 
 		$model = $this->user_model;
 
 		if (empty($model))
 		{
-			$ci =& get_instance();
-			$ci->load->model( 'User_model' );
+			$ci = & get_instance();
+			$ci->load->model('User_model');
 
 			$model = $ci->user_model;
 		}
@@ -506,14 +506,14 @@ 
 	 *
 	 * @return object|null
 	 */
-	public function group( $group )
+	public function group($group)
 	{
-		if ( is_numeric( $group ) )
+		if (is_numeric($group))
 		{
-			return $this->groupModel->find( (int) $group );
+			return $this->groupModel->find((int) $group);
 		}
 
-		return $this->groupModel->find_by( 'name', $group );
+		return $this->groupModel->find_by('name', $group);
 	}
 
 	//--------------------------------------------------------------------
@@ -536,16 +536,16 @@ 
 	 *
 	 * @return mixed
 	 */
-	public function createGroup( $name, $description = '' )
+	public function createGroup($name, $description = '')
 	{
 		$data = [
 			'name'        => $name,
 			'description' => $description
 		];
 
-		$id = $this->groupModel->insert( $data );
+		$id = $this->groupModel->insert($data);
 
-		if ( is_numeric( $id ) )
+		if (is_numeric($id))
 		{
 			return (int) $id;
 		}
@@ -564,9 +564,9 @@ 
 	 *
 	 * @return bool
 	 */
-	public function deleteGroup( $group_id )
+	public function deleteGroup($group_id)
 	{
-		if ( ! $this->groupModel->delete( $group_id ) )
+		if ( ! $this->groupModel->delete($group_id))
 		{
 			$this->error = $this->groupModel->error();
 
@@ -587,18 +587,18 @@ 
 	 *
 	 * @return mixed
 	 */
-	public function updateGroup( $id, $name, $description = '' )
+	public function updateGroup($id, $name, $description = '')
 	{
 		$data = [
 			'name' => $name
 		];
 
-		if ( ! empty( $description ) )
+		if ( ! empty($description))
 		{
 			$data['description'] = $description;
 		}
 
-		if ( ! $this->groupModel->update( (int) $id, $data ) )
+		if ( ! $this->groupModel->update((int) $id, $data))
 		{
 			$this->error = $this->groupModel->error();
 
@@ -618,23 +618,23 @@ 
 	 *
 	 * @return int|false
 	 */
-	protected function getGroupID( $group )
+	protected function getGroupID($group)
 	{
 		if (is_numeric($group))
 		{
-			return (int)$group;
+			return (int) $group;
 		}
 
-		$g = $this->groupModel->find_by( 'name', $group );
+		$g = $this->groupModel->find_by('name', $group);
 
-		if ( ! $g )
+		if ( ! $g)
 		{
 			$this->error = lang('auth.group_not_found');
 
 			return FALSE;
 		}
 
-		return (int)$g->id;
+		return (int) $g->id;
 	}
 
 	//--------------------------------------------------------------------
@@ -650,14 +650,14 @@ 
 	 *
 	 * @return object|null
 	 */
-	public function permission( $permission )
+	public function permission($permission)
 	{
-		if ( is_numeric( $permission ) )
+		if (is_numeric($permission))
 		{
-			return $this->permissionModel->find( (int) $permission );
+			return $this->permissionModel->find((int) $permission);
 		}
 
-		return $this->permissionModel->find_by( 'LOWER(name)', strtolower( $permission ) );
+		return $this->permissionModel->find_by('LOWER(name)', strtolower($permission));
 	}
 
 	//--------------------------------------------------------------------
@@ -682,16 +682,16 @@ 
 	 *
 	 * @return mixed
 	 */
-	public function createPermission( $name, $description = '' )
+	public function createPermission($name, $description = '')
 	{
 		$data = [
 			'name'        => $name,
 			'description' => $description
 		];
 
-		$id = $this->permissionModel->insert( $data );
+		$id = $this->permissionModel->insert($data);
 
-		if ( is_numeric( $id ) )
+		if (is_numeric($id))
 		{
 			return (int) $id;
 		}
@@ -710,9 +710,9 @@ 
 	 *
 	 * @return mixed
 	 */
-	public function deletePermission( $permission_id )
+	public function deletePermission($permission_id)
 	{
-		if ( ! $this->permissionModel->delete( $permission_id ) )
+		if ( ! $this->permissionModel->delete($permission_id))
 		{
 			$this->error = $this->permissionModel->error();
 
@@ -720,7 +720,7 @@ 
 		}
 
 		// Remove the permission from all groups
-		$this->groupModel->removePermissionFromAllGroups( $permission_id );
+		$this->groupModel->removePermissionFromAllGroups($permission_id);
 
 		return TRUE;
 	}
@@ -736,18 +736,18 @@ 
 	 *
 	 * @return bool
 	 */
-	public function updatePermission( $id, $name, $description = '' )
+	public function updatePermission($id, $name, $description = '')
 	{
 		$data = [
 			'name' => $name
 		];
 
-		if ( ! empty( $description ) )
+		if ( ! empty($description))
 		{
 			$data['description'] = $description;
 		}
 
-		if ( ! $this->permissionModel->update( (int) $id, $data ) )
+		if ( ! $this->permissionModel->update((int) $id, $data))
 		{
 			$this->error = $this->permissionModel->error();
 
@@ -767,25 +767,25 @@ 
 	 *
 	 * @return int|null
 	 */
-	protected function getPermissionID( $permission )
+	protected function getPermissionID($permission)
 	{
 		// If it's a number, we're done here.
 		if (is_numeric($permission))
 		{
-			return (int)$permission;
+			return (int) $permission;
 		}
 
 		// Otherwise, pull it from the database.
-		$p = $this->permissionModel->find_by( 'name', $permission );
+		$p = $this->permissionModel->find_by('name', $permission);
 
-		if ( ! $p )
+		if ( ! $p)
 		{
 			$this->error = lang('auth.permission_not_found');
 
 			return FALSE;
 		}
 
-		return (int)$p->id;
+		return (int) $p->id;
 	}
 
 	//--------------------------------------------------------------------

Braces +2 added lines, -5 removed lines

@@ -122,9 +122,7 @@ 
 				{
 					return true;
 				}
-			}
-
-			else if (is_string($group))
+			} else if (is_string($group))
 			{
 				$ids = array_column($user_groups, 'name');
 				if (in_array($group, $ids))
@@ -389,8 +387,7 @@ 
 		if (! empty($permissions))
 		{
 			$permissions = unserialize($permissions);
-		}
-		else
+		} else
 		{
 			$permissions = [];
 		}

myth/CIModules/auth/models/Login_model.php

Doc Comments +2 added lines, -2 removed lines

@@ -195,7 +195,7 @@ 
      * string with letters and numbers.
      *
      * @param $user
-     * @return mixed
+     * @return string
      */
     public function generateRememberToken($user)
     {
@@ -278,7 +278,7 @@ 
      * Gets the timestamp of the last attempted login for this user.
      *
      * @param $email
-     * @return int|null
+     * @return integer
      */
     public function lastLoginAttemptTime($email)
     {

Spacing +8 added lines, -8 removed lines

@@ -122,7 +122,7 @@ 
      */
     public function distributedBruteForceTime()
     {
-        if (! $time = $this->cache->get('dbrutetime'))
+        if ( ! $time = $this->cache->get('dbrutetime'))
         {
             $time = 0;
 
@@ -131,7 +131,7 @@ 
 
             $query = $this->db->query("SELECT COUNT(*) / COUNT(DISTINCT DATE(`datetime`)) as num_rows FROM `auth_login_attempts` WHERE `datetime` >= ?", $avg_start_time);
 
-            if (! $query->num_rows())
+            if ( ! $query->num_rows())
             {
                 $average = 0;
             }
@@ -152,7 +152,7 @@ 
             }
 
             // Cache it for 3 hours.
-            $this->cache->save('dbrutetime', $time, 60*60*3);
+            $this->cache->save('dbrutetime', $time, 60 * 60 * 3);
         }
 
         return $time;
@@ -173,7 +173,7 @@ 
     public function recordLogin($user)
     {
         $data = [
-            'user_id'    => (int)$user['id'],
+            'user_id'    => (int) $user['id'],
             'datetime'   => date('Y-m-d H:i:s'),
             'ip_address' => $this->input->ip_address()
         ];
@@ -201,7 +201,7 @@ 
     {
         $this->load->helper('string');
 
-        return str_replace('@', '.', $user['email']) .'|' . random_string('alnum', 128);
+        return str_replace('@', '.', $user['email']).'|'.random_string('alnum', 128);
     }
 
     //--------------------------------------------------------------------
@@ -214,7 +214,7 @@ 
      */
     public function hashRememberToken($token)
     {
-        return sha1(config_item('auth.salt') . $token);
+        return sha1(config_item('auth.salt').$token);
     }
 
     //--------------------------------------------------------------------
@@ -260,7 +260,7 @@ 
      */
     public function purgeOldRememberTokens()
     {
-        if (! config_item('auth.allow_remembering'))
+        if ( ! config_item('auth.allow_remembering'))
         {
             return;
         }
@@ -287,7 +287,7 @@ 
                           ->limit(1)
                           ->get('auth_login_attempts');
 
-        if (! $query->num_rows())
+        if ( ! $query->num_rows())
         {
             return 0;
         }

Braces +1 added lines, -2 removed lines

@@ -134,8 +134,7 @@
             if (! $query->num_rows())
             {
                 $average = 0;
-            }
-            else
+            } else
             {
                 $average = $query->row()->num_rows;
             }

Indentation +298 added lines, -298 removed lines

@@ -1,34 +1,34 @@ 
 <?php
 /**
- * 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
+	 */
 
 /**
  * Class Login_model
@@ -41,274 +41,274 @@ 
  */
 class Login_model extends \Myth\Models\CIDbModel {
 
-    protected $table_name = 'auth_logins';
-
-    protected $set_created = false;
-    protected $set_modified = false;
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Login Attempts
-    //--------------------------------------------------------------------
-
-    /**
-     * Records a login attempt. This is used to implement
-     * throttling of user login attempts.
-     *
-     * @param $email
-     * @return object
-     */
-    public function recordLoginAttempt($email)
-    {
-        $data = [
-            'email' => $email,
-            'datetime' => date('Y-m-d H:i:s')
-        ];
-
-        return $this->db->insert('auth_login_attempts', $data);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Purges all login attempt records from the database.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function purgeLoginAttempts($email)
-    {
-        return $this->db->where('email', $email)
-                        ->delete('auth_login_attempts');
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Checks to see if how many login attempts have been attempted in the
-     * last 60 seconds. If over 100, it is considered to be under a
-     * brute force attempt.
-     *
-     * @param $email
-     * @return bool
-     */
-    public function isBruteForced($email)
-    {
-        $start_time = date('Y-m-d H:i:s', time() - 60);
-
-        $attempts = $this->db->where('email', $email)
-                             ->where('datetime >=', $start_time)
-                             ->count_all_results('auth_login_attempts');
-
-        return $attempts > 100;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Attempts to determine if the system is under a distributed
-     * brute force attack.
-     *
-     * To determine if we are in under a brute force attack, we first
-     * find the average number of bad logins per day that never converted to
-     * successful logins over the last 3 months. Then we compare
-     * that to the the average number of logins in the past 24 hours.
-     *
-     * If the number of attempts in the last 24 hours is more than X (see config)
-     * times the average, then institute additional throttling.
-     *
-     * @return int The time to add to any throttling.
-     */
-    public function distributedBruteForceTime()
-    {
-        if (! $time = $this->cache->get('dbrutetime'))
-        {
-            $time = 0;
-
-            // Compute our daily average over the last 3 months.
-            $avg_start_time = date('Y-m-d 00:00:00', strtotime('-3 months'));
-
-            $query = $this->db->query("SELECT COUNT(*) / COUNT(DISTINCT DATE(`datetime`)) as num_rows FROM `auth_login_attempts` WHERE `datetime` >= ?", $avg_start_time);
-
-            if (! $query->num_rows())
-            {
-                $average = 0;
-            }
-            else
-            {
-                $average = $query->row()->num_rows;
-            }
-
-            // Get the total in the last 24 hours
-            $today_start_time = date('Y-m-d H:i:s', strtotime('-24 hours'));
-
-            $attempts = $this->db->where('datetime >=', $today_start_time)
-                                 ->count_all_results('auth_login_attempts');
-
-            if ($attempts > (config_item('auth.dbrute_multiplier') * $average))
-            {
-                $time = config_item('auth.distributed_brute_add_time');
-            }
-
-            // Cache it for 3 hours.
-            $this->cache->save('dbrutetime', $time, 60*60*3);
-        }
-
-        return $time;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Logins
-    //--------------------------------------------------------------------
-
-    /**
-     * Records a successful login. This stores in a table so that a
-     * history can be pulled up later if needed for security analyses.
-     *
-     * @param $user
-     */
-    public function recordLogin($user)
-    {
-        $data = [
-            'user_id'    => (int)$user['id'],
-            'datetime'   => date('Y-m-d H:i:s'),
-            'ip_address' => $this->input->ip_address()
-        ];
-
-        return $this->db->insert('auth_logins', $data);
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Tokens
-    //--------------------------------------------------------------------
-
-    /**
-     * Generates a new token for the rememberme cookie.
-     *
-     * The token is based on the user's email address (since everyone will have one)
-     * with the '@' turned to a '.', followed by a pipe (|) and a random 128-character
-     * string with letters and numbers.
-     *
-     * @param $user
-     * @return mixed
-     */
-    public function generateRememberToken($user)
-    {
-        $this->load->helper('string');
-
-        return str_replace('@', '.', $user['email']) .'|' . random_string('alnum', 128);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Hashes the token for the Remember Me Functionality.
-     *
-     * @param $token
-     * @return string
-     */
-    public function hashRememberToken($token)
-    {
-        return sha1(config_item('auth.salt') . $token);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Deletes a single token that matches the email/token combo.
-     *
-     * @param $email
-     * @param $token
-     * @return mixed
-     */
-    public function deleteRememberToken($email, $token)
-    {
-        $where = [
-            'email' => $email,
-            'hash'  => $this->hashRememberToken($token)
-        ];
-
-        $this->db->delete('auth_tokens', $where);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Removes all persistent login tokens (RememberMe) for a single user
-     * across all devices they may have logged in with.
-     *
-     * @param $email
-     * @return mixed
-     */
-    public function purgeRememberTokens($email)
-    {
-        return $this->db->delete('auth_tokens', ['email' => $email]);
-    }
-
-    //--------------------------------------------------------------------
-
-
-    /**
-     * Purges the 'auth_tokens' table of any records that are too old
-     * to be of any use anymore. This equates to 1 week older than
-     * the remember_length set in the config file.
-     */
-    public function purgeOldRememberTokens()
-    {
-        if (! config_item('auth.allow_remembering'))
-        {
-            return;
-        }
-
-        $date = time() - config_item('auth.remember_length') - 604800; // 1 week
-        $date = date('Y-m-d 00:00:00', $date);
-
-        $this->db->where('created <=', $date)
-                 ->delete('auth_tokens');
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Gets the timestamp of the last attempted login for this user.
-     *
-     * @param $email
-     * @return int|null
-     */
-    public function lastLoginAttemptTime($email)
-    {
-        $query = $this->db->where('email', $email)
-                          ->order_by('datetime', 'desc')
-                          ->limit(1)
-                          ->get('auth_login_attempts');
-
-        if (! $query->num_rows())
-        {
-            return 0;
-        }
-
-        return strtotime($query->row()->datetime);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns the number of failed login attempts for a single email.
-     *
-     * @param $email
-     * @return int
-     */
-    public function countLoginAttempts($email)
-    {
-        return $this->db->where('email', $email)
-                        ->count_all_results('auth_login_attempts');
-    }
-
-    //--------------------------------------------------------------------
+	protected $table_name = 'auth_logins';
+
+	protected $set_created = false;
+	protected $set_modified = false;
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Login Attempts
+	//--------------------------------------------------------------------
+
+	/**
+	 * Records a login attempt. This is used to implement
+	 * throttling of user login attempts.
+	 *
+	 * @param $email
+	 * @return object
+	 */
+	public function recordLoginAttempt($email)
+	{
+		$data = [
+			'email' => $email,
+			'datetime' => date('Y-m-d H:i:s')
+		];
+
+		return $this->db->insert('auth_login_attempts', $data);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Purges all login attempt records from the database.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function purgeLoginAttempts($email)
+	{
+		return $this->db->where('email', $email)
+						->delete('auth_login_attempts');
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Checks to see if how many login attempts have been attempted in the
+	 * last 60 seconds. If over 100, it is considered to be under a
+	 * brute force attempt.
+	 *
+	 * @param $email
+	 * @return bool
+	 */
+	public function isBruteForced($email)
+	{
+		$start_time = date('Y-m-d H:i:s', time() - 60);
+
+		$attempts = $this->db->where('email', $email)
+							 ->where('datetime >=', $start_time)
+							 ->count_all_results('auth_login_attempts');
+
+		return $attempts > 100;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Attempts to determine if the system is under a distributed
+	 * brute force attack.
+	 *
+	 * To determine if we are in under a brute force attack, we first
+	 * find the average number of bad logins per day that never converted to
+	 * successful logins over the last 3 months. Then we compare
+	 * that to the the average number of logins in the past 24 hours.
+	 *
+	 * If the number of attempts in the last 24 hours is more than X (see config)
+	 * times the average, then institute additional throttling.
+	 *
+	 * @return int The time to add to any throttling.
+	 */
+	public function distributedBruteForceTime()
+	{
+		if (! $time = $this->cache->get('dbrutetime'))
+		{
+			$time = 0;
+
+			// Compute our daily average over the last 3 months.
+			$avg_start_time = date('Y-m-d 00:00:00', strtotime('-3 months'));
+
+			$query = $this->db->query("SELECT COUNT(*) / COUNT(DISTINCT DATE(`datetime`)) as num_rows FROM `auth_login_attempts` WHERE `datetime` >= ?", $avg_start_time);
+
+			if (! $query->num_rows())
+			{
+				$average = 0;
+			}
+			else
+			{
+				$average = $query->row()->num_rows;
+			}
+
+			// Get the total in the last 24 hours
+			$today_start_time = date('Y-m-d H:i:s', strtotime('-24 hours'));
+
+			$attempts = $this->db->where('datetime >=', $today_start_time)
+								 ->count_all_results('auth_login_attempts');
+
+			if ($attempts > (config_item('auth.dbrute_multiplier') * $average))
+			{
+				$time = config_item('auth.distributed_brute_add_time');
+			}
+
+			// Cache it for 3 hours.
+			$this->cache->save('dbrutetime', $time, 60*60*3);
+		}
+
+		return $time;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Logins
+	//--------------------------------------------------------------------
+
+	/**
+	 * Records a successful login. This stores in a table so that a
+	 * history can be pulled up later if needed for security analyses.
+	 *
+	 * @param $user
+	 */
+	public function recordLogin($user)
+	{
+		$data = [
+			'user_id'    => (int)$user['id'],
+			'datetime'   => date('Y-m-d H:i:s'),
+			'ip_address' => $this->input->ip_address()
+		];
+
+		return $this->db->insert('auth_logins', $data);
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Tokens
+	//--------------------------------------------------------------------
+
+	/**
+	 * Generates a new token for the rememberme cookie.
+	 *
+	 * The token is based on the user's email address (since everyone will have one)
+	 * with the '@' turned to a '.', followed by a pipe (|) and a random 128-character
+	 * string with letters and numbers.
+	 *
+	 * @param $user
+	 * @return mixed
+	 */
+	public function generateRememberToken($user)
+	{
+		$this->load->helper('string');
+
+		return str_replace('@', '.', $user['email']) .'|' . random_string('alnum', 128);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Hashes the token for the Remember Me Functionality.
+	 *
+	 * @param $token
+	 * @return string
+	 */
+	public function hashRememberToken($token)
+	{
+		return sha1(config_item('auth.salt') . $token);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Deletes a single token that matches the email/token combo.
+	 *
+	 * @param $email
+	 * @param $token
+	 * @return mixed
+	 */
+	public function deleteRememberToken($email, $token)
+	{
+		$where = [
+			'email' => $email,
+			'hash'  => $this->hashRememberToken($token)
+		];
+
+		$this->db->delete('auth_tokens', $where);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Removes all persistent login tokens (RememberMe) for a single user
+	 * across all devices they may have logged in with.
+	 *
+	 * @param $email
+	 * @return mixed
+	 */
+	public function purgeRememberTokens($email)
+	{
+		return $this->db->delete('auth_tokens', ['email' => $email]);
+	}
+
+	//--------------------------------------------------------------------
+
+
+	/**
+	 * Purges the 'auth_tokens' table of any records that are too old
+	 * to be of any use anymore. This equates to 1 week older than
+	 * the remember_length set in the config file.
+	 */
+	public function purgeOldRememberTokens()
+	{
+		if (! config_item('auth.allow_remembering'))
+		{
+			return;
+		}
+
+		$date = time() - config_item('auth.remember_length') - 604800; // 1 week
+		$date = date('Y-m-d 00:00:00', $date);
+
+		$this->db->where('created <=', $date)
+				 ->delete('auth_tokens');
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Gets the timestamp of the last attempted login for this user.
+	 *
+	 * @param $email
+	 * @return int|null
+	 */
+	public function lastLoginAttemptTime($email)
+	{
+		$query = $this->db->where('email', $email)
+						  ->order_by('datetime', 'desc')
+						  ->limit(1)
+						  ->get('auth_login_attempts');
+
+		if (! $query->num_rows())
+		{
+			return 0;
+		}
+
+		return strtotime($query->row()->datetime);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns the number of failed login attempts for a single email.
+	 *
+	 * @param $email
+	 * @return int
+	 */
+	public function countLoginAttempts($email)
+	{
+		return $this->db->where('email', $email)
+						->count_all_results('auth_login_attempts');
+	}
+
+	//--------------------------------------------------------------------
 
 }

myth/CLI.php

Doc Comments +3 added lines, -3 removed lines

@@ -142,7 +142,6 @@ 
      * Named options must be in the following formats:
      * php index.php user -v --v -name=John --name=John
      *
-     * @param	string|int	$name	the name of the option (int if unnamed)
      * @return	string
      */
     public static function input($prefix = '')
@@ -281,6 +280,7 @@ 
      * with a line break.
      *
      * @param	string|array	$text	the text to output, or array of lines
+     * @param string $foreground
      */
     public static function write($text = '', $foreground = null, $background = null)
     {
@@ -535,9 +535,9 @@ 
 	 * Checks to see if an option was passed to us on the CLI and returns
 	 * the value if so. Otherwise, returns null.
 	 *
-	 * @param $name
+	 * @param string $name
 	 *
-	 * @return null
+	 * @return string
 	 */
 	public static function option($name)
 	{

Indentation +511 added lines, -511 removed lines

@@ -1,14 +1,14 @@ 
 <?php
 /**
- * Part of the Fuel framework.
- *
- * @package    Fuel
- * @version    1.7
- * @author     Fuel Development Team
- * @license    MIT License
- * @copyright  2010 - 2013 Fuel Development Team
- * @link       http://fuelphp.com
- */
+	 * Part of the Fuel framework.
+	 *
+	 * @package    Fuel
+	 * @version    1.7
+	 * @author     Fuel Development Team
+	 * @license    MIT License
+	 * @copyright  2010 - 2013 Fuel Development Team
+	 * @link       http://fuelphp.com
+	 */
 
 /**
  * Modified to work with CodeIgniter by Lonnie Ezell.
@@ -30,506 +30,506 @@ 
  */
 class CLI {
 
-    public static $readline_support = false;
+	public static $readline_support = false;
 
-    public static $wait_msg = 'Press any key to continue...';
+	public static $wait_msg = 'Press any key to continue...';
 
-    public static $segments = [];
+	public static $segments = [];
 
 	protected static $options = [];
 
 	protected static $initialized = false;
 
-    // Used by progress bar
-    protected static $inProgress = false;
-
-    protected static $foreground_colors = array(
-        'black'			=> '0;30',
-        'dark_gray'		=> '1;30',
-        'blue'			=> '0;34',
-        'dark_blue'		=> '1;34',
-        'light_blue'	=> '1;34',
-        'green'			=> '0;32',
-        'light_green'	=> '1;32',
-        'cyan'			=> '0;36',
-        'light_cyan'	=> '1;36',
-        'red'			=> '0;31',
-        'light_red'		=> '1;31',
-        'purple'		=> '0;35',
-        'light_purple'	=> '1;35',
-        'light_yellow'	=> '0;33',
-        'yellow'		=> '1;33',
-        'light_gray'	=> '0;37',
-        'white'			=> '1;37',
-    );
-
-    protected static $background_colors = array(
-        'black'			=> '40',
-        'red'			=> '41',
-        'green'			=> '42',
-        'yellow'		=> '43',
-        'blue'			=> '44',
-        'magenta'		=> '45',
-        'cyan'			=> '46',
-        'light_gray'	=> '47',
-    );
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Static constructor.	Parses all the CLI params.
-     */
-    public static function _init()
-    {
-	    if (static::$initialized === true)
-	    {
-		    return;
-	    }
-
-        if ( ! (PHP_SAPI === 'cli' || defined('STDIN')) )
-        {
-            throw new \Exception('Cli class cannot be used outside of the command line.');
-        }
-
-	    self::parseCommand();
-
-        // Readline is an extension for PHP that makes interactive with PHP much more bash-like
-        // http://www.php.net/manual/en/readline.installation.php
-        static::$readline_support = extension_loaded('readline');
-
-	    static::$initialized = true;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Grabs an individual
-     *
-     * @param $index
-     * @return null
-     */
-    public static function segment($index)
-    {
-        if (! isset(static::$segments[$index - 1]))
-        {
-            return null;
-        }
-
-        return static::$segments[$index - 1];
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns the command string portion of the arguments. Used
-     * by the 'sprint' CLI script to grab the portion of the arguments
-     * that is used to call the CodeIgniter application.
-     *
-     * @return string
-     */
-    public static function cli_string()
-    {
-        return implode(' ', static::$segments);
-    }
-
-    //--------------------------------------------------------------------
-
-
-
-    /**
-     * Get input from the shell, using readline or the standard STDIN
-     *
-     * Named options must be in the following formats:
-     * php index.php user -v --v -name=John --name=John
-     *
-     * @param	string|int	$name	the name of the option (int if unnamed)
-     * @return	string
-     */
-    public static function input($prefix = '')
-    {
-        if (static::$readline_support)
-        {
-            return readline($prefix);
-        }
-
-        echo $prefix;
-        return fgets(STDIN);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Asks the user for input.  This can have either 1 or 2 arguments.
-     *
-     * Usage:
-     *
-     * // Waits for any key press
-     * CLI::prompt();
-     *
-     * // Takes any input
-     * $color = CLI::prompt('What is your favorite color?');
-     *
-     * // Takes any input, but offers default
-     * $color = CLI::prompt('What is your favourite color?', 'white');
-     *
-     * // Will only accept the options in the array
-     * $ready = CLI::prompt('Are you ready?', array('y','n'));
-     *
-     * @return	string	the user input
-     */
-    public static function prompt()
-    {
-        $args = func_get_args();
-
-        $options = array();
-        $output = '';
-        $default = null;
-
-        // How many we got
-        $arg_count = count($args);
-
-        // Is the last argument a boolean? True means required
-        $required = end($args) === true;
-
-        // Reduce the argument count if required was passed, we don't care about that anymore
-        $required === true and --$arg_count;
-
-        // This method can take a few crazy combinations of arguments, so lets work it out
-        switch ($arg_count)
-        {
-            case 2:
-
-                // E.g: $ready = CLI::prompt('Are you ready?', array('y','n'));
-                if (is_array($args[1]))
-                {
-                    list($output, $options)=$args;
-                }
-
-                // E.g: $color = CLI::prompt('What is your favourite color?', 'white');
-                elseif (is_string($args[1]))
-                {
-                    list($output, $default)=$args;
-                }
-
-                break;
-
-            case 1:
-
-                // No question (probably been asked already) so just show options
-                // E.g: $ready = CLI::prompt(array('y','n'));
-                if (is_array($args[0]))
-                {
-                    $options = $args[0];
-                }
-
-                // Question without options
-                // E.g: $ready = CLI::prompt('What did you do today?');
-                elseif (is_string($args[0]))
-                {
-                    $output = $args[0];
-                }
-
-                break;
-        }
-
-        // If a question has been asked with the read
-        if ($output !== '')
-        {
-            $extra_output = '';
-
-            if ($default !== null)
-            {
-                $extra_output = ' [ Default: "'.$default.'" ]';
-            }
-
-            elseif ($options !== array())
-            {
-                $extra_output = ' [ '.implode(', ', $options).' ]';
-            }
-
-            fwrite(STDOUT, $output.$extra_output.': ');
-        }
-
-        // Read the input from keyboard.
-        $input = trim(static::input()) ?: $default;
-
-        // No input provided and we require one (default will stop this being called)
-        if (empty($input) and $required === true)
-        {
-            static::write('This is required.');
-            static::new_line();
-
-            $input = forward_static_call_array(array(__CLASS__, 'prompt'), $args);
-        }
-
-        // If options are provided and the choice is not in the array, tell them to try again
-        if ( ! empty($options) and ! in_array($input, $options))
-        {
-            static::write('This is not a valid option. Please try again.');
-            static::new_line();
-
-            $input = forward_static_call_array(array(__CLASS__, 'prompt'), $args);
-        }
-
-        return $input;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Outputs a string to the cli.	 If you send an array it will implode them
-     * with a line break.
-     *
-     * @param	string|array	$text	the text to output, or array of lines
-     */
-    public static function write($text = '', $foreground = null, $background = null)
-    {
-        if (is_array($text))
-        {
-            $text = implode(PHP_EOL, $text);
-        }
-
-        if ($foreground or $background)
-        {
-            $text = static::color($text, $foreground, $background);
-        }
-
-        fwrite(STDOUT, $text.PHP_EOL);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Outputs an error to the CLI using STDERR instead of STDOUT
-     *
-     * @param	string|array	$text	the text to output, or array of errors
-     */
-    public static function error($text = '', $foreground = 'light_red', $background = null)
-    {
-        if (is_array($text))
-        {
-            $text = implode(PHP_EOL, $text);
-        }
-
-        if ($foreground OR $background)
-        {
-            $text = static::color($text, $foreground, $background);
-        }
-
-        fwrite(STDERR, $text.PHP_EOL);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Beeps a certain number of times.
-     *
-     * @param	int $num	the number of times to beep
-     */
-    public static function beep($num = 1)
-    {
-        echo str_repeat("\x07", $num);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Waits a certain number of seconds, optionally showing a wait message and
-     * waiting for a key press.
-     *
-     * @param	int		$seconds	number of seconds
-     * @param	bool	$countdown	show a countdown or not
-     */
-    public static function wait($seconds = 0, $countdown = false)
-    {
-        if ($countdown === true)
-        {
-            $time = $seconds;
-
-            while ($time > 0)
-            {
-                fwrite(STDOUT, $time.'... ');
-                sleep(1);
-                $time--;
-            }
-            static::write();
-        }
-
-        else
-        {
-            if ($seconds > 0)
-            {
-                sleep($seconds);
-            }
-            else
-            {
-                static::write(static::$wait_msg);
-                static::input();
-            }
-        }
-    }
-
-
-    //--------------------------------------------------------------------
-
-    /**
-     * if operating system === windows
-     */
-    public static function is_windows()
-    {
-        return 'win' === strtolower(substr(php_uname("s"), 0, 3));
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Enter a number of empty lines
-     *
-     * @param	integer	Number of lines to output
-     * @return	void
-     */
-    public static function new_line($num = 1)
-    {
-        // Do it once or more, write with empty string gives us a new line
-        for($i = 0; $i < $num; $i++)
-        {
-            static::write();
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Clears the screen of output
-     *
-     * @return	void
-     */
-    public static function clear_screen()
-    {
-        static::is_windows()
-
-            // Windows is a bit crap at this, but their terminal is tiny so shove this in
-            ? static::new_line(40)
-
-            // Anything with a flair of Unix will handle these magic characters
-            : fwrite(STDOUT, chr(27)."[H".chr(27)."[2J");
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns the given text with the correct color codes for a foreground and
-     * optionally a background color.
-     *
-     * @param	string	$text		the text to color
-     * @param	string	$foreground the foreground color
-     * @param	string	$background the background color
-     * @param	string	$format		other formatting to apply. Currently only 'underline' is understood
-     * @return	string	the color coded string
-     */
-    public static function color($text, $foreground, $background = null, $format=null)
-    {
-        if (static::is_windows() and ! isset($_SERVER['ANSICON']))
-        {
-            return $text;
-        }
-
-        if ( ! array_key_exists($foreground, static::$foreground_colors))
-        {
-            throw new \RuntimeException('Invalid CLI foreground color: '.$foreground);
-        }
-
-        if ( $background !== null and ! array_key_exists($background, static::$background_colors))
-        {
-            throw new \RuntimeException('Invalid CLI background color: '.$background);
-        }
-
-        $string = "\033[".static::$foreground_colors[$foreground]."m";
-
-        if ($background !== null)
-        {
-            $string .= "\033[".static::$background_colors[$background]."m";
-        }
-
-        if ($format === 'underline')
-        {
-            $string .= "\033[4m";
-        }
-
-        $string .= $text."\033[0m";
-
-        return $string;
-    }
-
-    //--------------------------------------------------------------------
-
-    public static function getWidth($default=80)
-    {
-        if (static::is_windows())
-        {
-            return $default;
-        }
-
-        return (int)shell_exec('tput cols');
-    }
+	// Used by progress bar
+	protected static $inProgress = false;
+
+	protected static $foreground_colors = array(
+		'black'			=> '0;30',
+		'dark_gray'		=> '1;30',
+		'blue'			=> '0;34',
+		'dark_blue'		=> '1;34',
+		'light_blue'	=> '1;34',
+		'green'			=> '0;32',
+		'light_green'	=> '1;32',
+		'cyan'			=> '0;36',
+		'light_cyan'	=> '1;36',
+		'red'			=> '0;31',
+		'light_red'		=> '1;31',
+		'purple'		=> '0;35',
+		'light_purple'	=> '1;35',
+		'light_yellow'	=> '0;33',
+		'yellow'		=> '1;33',
+		'light_gray'	=> '0;37',
+		'white'			=> '1;37',
+	);
+
+	protected static $background_colors = array(
+		'black'			=> '40',
+		'red'			=> '41',
+		'green'			=> '42',
+		'yellow'		=> '43',
+		'blue'			=> '44',
+		'magenta'		=> '45',
+		'cyan'			=> '46',
+		'light_gray'	=> '47',
+	);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Static constructor.	Parses all the CLI params.
+	 */
+	public static function _init()
+	{
+		if (static::$initialized === true)
+		{
+			return;
+		}
+
+		if ( ! (PHP_SAPI === 'cli' || defined('STDIN')) )
+		{
+			throw new \Exception('Cli class cannot be used outside of the command line.');
+		}
+
+		self::parseCommand();
+
+		// Readline is an extension for PHP that makes interactive with PHP much more bash-like
+		// http://www.php.net/manual/en/readline.installation.php
+		static::$readline_support = extension_loaded('readline');
+
+		static::$initialized = true;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Grabs an individual
+	 *
+	 * @param $index
+	 * @return null
+	 */
+	public static function segment($index)
+	{
+		if (! isset(static::$segments[$index - 1]))
+		{
+			return null;
+		}
+
+		return static::$segments[$index - 1];
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns the command string portion of the arguments. Used
+	 * by the 'sprint' CLI script to grab the portion of the arguments
+	 * that is used to call the CodeIgniter application.
+	 *
+	 * @return string
+	 */
+	public static function cli_string()
+	{
+		return implode(' ', static::$segments);
+	}
+
+	//--------------------------------------------------------------------
+
+
+
+	/**
+	 * Get input from the shell, using readline or the standard STDIN
+	 *
+	 * Named options must be in the following formats:
+	 * php index.php user -v --v -name=John --name=John
+	 *
+	 * @param	string|int	$name	the name of the option (int if unnamed)
+	 * @return	string
+	 */
+	public static function input($prefix = '')
+	{
+		if (static::$readline_support)
+		{
+			return readline($prefix);
+		}
+
+		echo $prefix;
+		return fgets(STDIN);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Asks the user for input.  This can have either 1 or 2 arguments.
+	 *
+	 * Usage:
+	 *
+	 * // Waits for any key press
+	 * CLI::prompt();
+	 *
+	 * // Takes any input
+	 * $color = CLI::prompt('What is your favorite color?');
+	 *
+	 * // Takes any input, but offers default
+	 * $color = CLI::prompt('What is your favourite color?', 'white');
+	 *
+	 * // Will only accept the options in the array
+	 * $ready = CLI::prompt('Are you ready?', array('y','n'));
+	 *
+	 * @return	string	the user input
+	 */
+	public static function prompt()
+	{
+		$args = func_get_args();
+
+		$options = array();
+		$output = '';
+		$default = null;
+
+		// How many we got
+		$arg_count = count($args);
+
+		// Is the last argument a boolean? True means required
+		$required = end($args) === true;
+
+		// Reduce the argument count if required was passed, we don't care about that anymore
+		$required === true and --$arg_count;
+
+		// This method can take a few crazy combinations of arguments, so lets work it out
+		switch ($arg_count)
+		{
+			case 2:
+
+				// E.g: $ready = CLI::prompt('Are you ready?', array('y','n'));
+				if (is_array($args[1]))
+				{
+					list($output, $options)=$args;
+				}
+
+				// E.g: $color = CLI::prompt('What is your favourite color?', 'white');
+				elseif (is_string($args[1]))
+				{
+					list($output, $default)=$args;
+				}
+
+				break;
+
+			case 1:
+
+				// No question (probably been asked already) so just show options
+				// E.g: $ready = CLI::prompt(array('y','n'));
+				if (is_array($args[0]))
+				{
+					$options = $args[0];
+				}
+
+				// Question without options
+				// E.g: $ready = CLI::prompt('What did you do today?');
+				elseif (is_string($args[0]))
+				{
+					$output = $args[0];
+				}
+
+				break;
+		}
+
+		// If a question has been asked with the read
+		if ($output !== '')
+		{
+			$extra_output = '';
+
+			if ($default !== null)
+			{
+				$extra_output = ' [ Default: "'.$default.'" ]';
+			}
+
+			elseif ($options !== array())
+			{
+				$extra_output = ' [ '.implode(', ', $options).' ]';
+			}
+
+			fwrite(STDOUT, $output.$extra_output.': ');
+		}
+
+		// Read the input from keyboard.
+		$input = trim(static::input()) ?: $default;
+
+		// No input provided and we require one (default will stop this being called)
+		if (empty($input) and $required === true)
+		{
+			static::write('This is required.');
+			static::new_line();
+
+			$input = forward_static_call_array(array(__CLASS__, 'prompt'), $args);
+		}
+
+		// If options are provided and the choice is not in the array, tell them to try again
+		if ( ! empty($options) and ! in_array($input, $options))
+		{
+			static::write('This is not a valid option. Please try again.');
+			static::new_line();
+
+			$input = forward_static_call_array(array(__CLASS__, 'prompt'), $args);
+		}
+
+		return $input;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Outputs a string to the cli.	 If you send an array it will implode them
+	 * with a line break.
+	 *
+	 * @param	string|array	$text	the text to output, or array of lines
+	 */
+	public static function write($text = '', $foreground = null, $background = null)
+	{
+		if (is_array($text))
+		{
+			$text = implode(PHP_EOL, $text);
+		}
+
+		if ($foreground or $background)
+		{
+			$text = static::color($text, $foreground, $background);
+		}
+
+		fwrite(STDOUT, $text.PHP_EOL);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Outputs an error to the CLI using STDERR instead of STDOUT
+	 *
+	 * @param	string|array	$text	the text to output, or array of errors
+	 */
+	public static function error($text = '', $foreground = 'light_red', $background = null)
+	{
+		if (is_array($text))
+		{
+			$text = implode(PHP_EOL, $text);
+		}
+
+		if ($foreground OR $background)
+		{
+			$text = static::color($text, $foreground, $background);
+		}
+
+		fwrite(STDERR, $text.PHP_EOL);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Beeps a certain number of times.
+	 *
+	 * @param	int $num	the number of times to beep
+	 */
+	public static function beep($num = 1)
+	{
+		echo str_repeat("\x07", $num);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Waits a certain number of seconds, optionally showing a wait message and
+	 * waiting for a key press.
+	 *
+	 * @param	int		$seconds	number of seconds
+	 * @param	bool	$countdown	show a countdown or not
+	 */
+	public static function wait($seconds = 0, $countdown = false)
+	{
+		if ($countdown === true)
+		{
+			$time = $seconds;
+
+			while ($time > 0)
+			{
+				fwrite(STDOUT, $time.'... ');
+				sleep(1);
+				$time--;
+			}
+			static::write();
+		}
+
+		else
+		{
+			if ($seconds > 0)
+			{
+				sleep($seconds);
+			}
+			else
+			{
+				static::write(static::$wait_msg);
+				static::input();
+			}
+		}
+	}
+
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * if operating system === windows
+	 */
+	public static function is_windows()
+	{
+		return 'win' === strtolower(substr(php_uname("s"), 0, 3));
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Enter a number of empty lines
+	 *
+	 * @param	integer	Number of lines to output
+	 * @return	void
+	 */
+	public static function new_line($num = 1)
+	{
+		// Do it once or more, write with empty string gives us a new line
+		for($i = 0; $i < $num; $i++)
+		{
+			static::write();
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Clears the screen of output
+	 *
+	 * @return	void
+	 */
+	public static function clear_screen()
+	{
+		static::is_windows()
+
+			// Windows is a bit crap at this, but their terminal is tiny so shove this in
+			? static::new_line(40)
+
+			// Anything with a flair of Unix will handle these magic characters
+			: fwrite(STDOUT, chr(27)."[H".chr(27)."[2J");
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns the given text with the correct color codes for a foreground and
+	 * optionally a background color.
+	 *
+	 * @param	string	$text		the text to color
+	 * @param	string	$foreground the foreground color
+	 * @param	string	$background the background color
+	 * @param	string	$format		other formatting to apply. Currently only 'underline' is understood
+	 * @return	string	the color coded string
+	 */
+	public static function color($text, $foreground, $background = null, $format=null)
+	{
+		if (static::is_windows() and ! isset($_SERVER['ANSICON']))
+		{
+			return $text;
+		}
+
+		if ( ! array_key_exists($foreground, static::$foreground_colors))
+		{
+			throw new \RuntimeException('Invalid CLI foreground color: '.$foreground);
+		}
+
+		if ( $background !== null and ! array_key_exists($background, static::$background_colors))
+		{
+			throw new \RuntimeException('Invalid CLI background color: '.$background);
+		}
+
+		$string = "\033[".static::$foreground_colors[$foreground]."m";
+
+		if ($background !== null)
+		{
+			$string .= "\033[".static::$background_colors[$background]."m";
+		}
+
+		if ($format === 'underline')
+		{
+			$string .= "\033[4m";
+		}
+
+		$string .= $text."\033[0m";
+
+		return $string;
+	}
+
+	//--------------------------------------------------------------------
+
+	public static function getWidth($default=80)
+	{
+		if (static::is_windows())
+		{
+			return $default;
+		}
+
+		return (int)shell_exec('tput cols');
+	}
     
-    //--------------------------------------------------------------------
-
-    public static function getHeight($default=32)
-    {
-        if (static::is_windows())
-        {
-            return $default;
-        }
-
-        return (int)shell_exec('tput lines');
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Displays a progress bar on the CLI. You must call it repeatedly
-     * to update it. Set $thisStep = false to erase the progress bar.
-     *
-     * @param int $thisStep
-     * @param int $totalSteps
-     */
-    public static function showProgress($thisStep=1, $totalSteps=10)
-    {
-        // The first time through, save
-        // our position so the script knows where to go
-        // back to when writing the bar, and
-        // at the end of the script.
-        if (! static::$inProgress) {
-            fwrite(STDOUT, "\0337");
-            static::$inProgress = true;
-        }
-
-        // Restore position
-        fwrite(STDERR, "\0338");
-
-        if ($thisStep !== false) {
-            // Don't allow div by zero or negative numbers....
-            $thisStep = abs($thisStep);
-            $totalSteps = $totalSteps < 1 ? 1 : $totalSteps;
-
-            $percent = intval( ($thisStep / $totalSteps) * 100 );
-            $step = (int)round($percent / 10);
-
-            // Write the progress bar
-            fwrite(STDOUT, "[\033[32m" . str_repeat('#', $step) . str_repeat('.', 10 - $step) . "\033[0m]");
-            // Textual representation...
-            fwrite(STDOUT, " {$percent}% Complete" . PHP_EOL);
-            // Move up, undo the PHP_EOL
-            fwrite(STDOUT, "\033[1A");
-        }
-        else
-        {
-            fwrite(STDERR, "\007");
-        }
-    }
-
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
+
+	public static function getHeight($default=32)
+	{
+		if (static::is_windows())
+		{
+			return $default;
+		}
+
+		return (int)shell_exec('tput lines');
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Displays a progress bar on the CLI. You must call it repeatedly
+	 * to update it. Set $thisStep = false to erase the progress bar.
+	 *
+	 * @param int $thisStep
+	 * @param int $totalSteps
+	 */
+	public static function showProgress($thisStep=1, $totalSteps=10)
+	{
+		// The first time through, save
+		// our position so the script knows where to go
+		// back to when writing the bar, and
+		// at the end of the script.
+		if (! static::$inProgress) {
+			fwrite(STDOUT, "\0337");
+			static::$inProgress = true;
+		}
+
+		// Restore position
+		fwrite(STDERR, "\0338");
+
+		if ($thisStep !== false) {
+			// Don't allow div by zero or negative numbers....
+			$thisStep = abs($thisStep);
+			$totalSteps = $totalSteps < 1 ? 1 : $totalSteps;
+
+			$percent = intval( ($thisStep / $totalSteps) * 100 );
+			$step = (int)round($percent / 10);
+
+			// Write the progress bar
+			fwrite(STDOUT, "[\033[32m" . str_repeat('#', $step) . str_repeat('.', 10 - $step) . "\033[0m]");
+			// Textual representation...
+			fwrite(STDOUT, " {$percent}% Complete" . PHP_EOL);
+			// Move up, undo the PHP_EOL
+			fwrite(STDOUT, "\033[1A");
+		}
+		else
+		{
+			fwrite(STDERR, "\007");
+		}
+	}
+
+	//--------------------------------------------------------------------
 
 	/**
 	 * Checks to see if an option was passed to us on the CLI and returns
@@ -541,11 +541,11 @@ 
 	 */
 	public static function option($name)
 	{
-	    if (array_key_exists($name, self::$options))
-	    {
-		    $val = self::$options[$name] === null ? true : self::$options[$name];
-		    return $val;
-	    }
+		if (array_key_exists($name, self::$options))
+		{
+			$val = self::$options[$name] === null ? true : self::$options[$name];
+			return $val;
+		}
 
 		return null;
 	}
@@ -559,7 +559,7 @@ 
 	 */
 	public static function getOptions()
 	{
-	    return self::$options;
+		return self::$options;
 	}
 
 	//--------------------------------------------------------------------
@@ -615,10 +615,10 @@ 
 			return '';
 		}
 
-        if ($max == 0)
-        {
-            $max = CLI::getWidth();
-        }
+		if ($max == 0)
+		{
+			$max = CLI::getWidth();
+		}
 
 		if (CLI::getWidth() < $max)
 		{

Spacing +26 added lines, -26 removed lines

@@ -86,7 +86,7 @@ 
 		    return;
 	    }
 
-        if ( ! (PHP_SAPI === 'cli' || defined('STDIN')) )
+        if ( ! (PHP_SAPI === 'cli' || defined('STDIN')))
         {
             throw new \Exception('Cli class cannot be used outside of the command line.');
         }
@@ -110,7 +110,7 @@ 
      */
     public static function segment($index)
     {
-        if (! isset(static::$segments[$index - 1]))
+        if ( ! isset(static::$segments[$index - 1]))
         {
             return null;
         }
@@ -202,13 +202,13 @@ 
                 // E.g: $ready = CLI::prompt('Are you ready?', array('y','n'));
                 if (is_array($args[1]))
                 {
-                    list($output, $options)=$args;
+                    list($output, $options) = $args;
                 }
 
                 // E.g: $color = CLI::prompt('What is your favourite color?', 'white');
                 elseif (is_string($args[1]))
                 {
-                    list($output, $default)=$args;
+                    list($output, $default) = $args;
                 }
 
                 break;
@@ -391,7 +391,7 @@ 
     public static function new_line($num = 1)
     {
         // Do it once or more, write with empty string gives us a new line
-        for($i = 0; $i < $num; $i++)
+        for ($i = 0; $i < $num; $i++)
         {
             static::write();
         }
@@ -427,7 +427,7 @@ 
      * @param	string	$format		other formatting to apply. Currently only 'underline' is understood
      * @return	string	the color coded string
      */
-    public static function color($text, $foreground, $background = null, $format=null)
+    public static function color($text, $foreground, $background = null, $format = null)
     {
         if (static::is_windows() and ! isset($_SERVER['ANSICON']))
         {
@@ -439,7 +439,7 @@ 
             throw new \RuntimeException('Invalid CLI foreground color: '.$foreground);
         }
 
-        if ( $background !== null and ! array_key_exists($background, static::$background_colors))
+        if ($background !== null and ! array_key_exists($background, static::$background_colors))
         {
             throw new \RuntimeException('Invalid CLI background color: '.$background);
         }
@@ -463,26 +463,26 @@ 
 
     //--------------------------------------------------------------------
 
-    public static function getWidth($default=80)
+    public static function getWidth($default = 80)
     {
         if (static::is_windows())
         {
             return $default;
         }
 
-        return (int)shell_exec('tput cols');
+        return (int) shell_exec('tput cols');
     }
     
     //--------------------------------------------------------------------
 
-    public static function getHeight($default=32)
+    public static function getHeight($default = 32)
     {
         if (static::is_windows())
         {
             return $default;
         }
 
-        return (int)shell_exec('tput lines');
+        return (int) shell_exec('tput lines');
     }
 
     //--------------------------------------------------------------------
@@ -494,13 +494,13 @@ 
      * @param int $thisStep
      * @param int $totalSteps
      */
-    public static function showProgress($thisStep=1, $totalSteps=10)
+    public static function showProgress($thisStep = 1, $totalSteps = 10)
     {
         // The first time through, save
         // our position so the script knows where to go
         // back to when writing the bar, and
         // at the end of the script.
-        if (! static::$inProgress) {
+        if ( ! static::$inProgress) {
             fwrite(STDOUT, "\0337");
             static::$inProgress = true;
         }
@@ -513,13 +513,13 @@ 
             $thisStep = abs($thisStep);
             $totalSteps = $totalSteps < 1 ? 1 : $totalSteps;
 
-            $percent = intval( ($thisStep / $totalSteps) * 100 );
-            $step = (int)round($percent / 10);
+            $percent = intval(($thisStep / $totalSteps) * 100);
+            $step = (int) round($percent / 10);
 
             // Write the progress bar
-            fwrite(STDOUT, "[\033[32m" . str_repeat('#', $step) . str_repeat('.', 10 - $step) . "\033[0m]");
+            fwrite(STDOUT, "[\033[32m".str_repeat('#', $step).str_repeat('.', 10 - $step)."\033[0m]");
             // Textual representation...
-            fwrite(STDOUT, " {$percent}% Complete" . PHP_EOL);
+            fwrite(STDOUT, " {$percent}% Complete".PHP_EOL);
             // Move up, undo the PHP_EOL
             fwrite(STDOUT, "\033[1A");
         }
@@ -570,7 +570,7 @@ 
 	 */
 	public static function optionString()
 	{
-		if (! count(static::$options))
+		if ( ! count(static::$options))
 		{
 			return '';
 		}
@@ -583,7 +583,7 @@ 
 			// so it will pass correctly.
 			if (strpos($value, ' ') !== false)
 			{
-				$value = '"'. $value .'"';
+				$value = '"'.$value.'"';
 			}
 			$out .= "-{$name} $value ";
 		}
@@ -608,7 +608,7 @@ 
 	 * @param int $max
 	 * @param int $pad_left
 	 */
-	public static function wrap($string=null, $max=0, $pad_left=0)
+	public static function wrap($string = null, $max = 0, $pad_left = 0)
 	{
 		if (empty($string))
 		{
@@ -630,13 +630,13 @@ 
 		$lines = wordwrap($string, $max);
 
 		if ($pad_left > 0) {
-			$lines = explode( "\n", $lines );
+			$lines = explode("\n", $lines);
 
 			$first = true;
 
-			array_walk( $lines, function ( &$line, $index ) use($max, $pad_left, &$first) {
-				if (! $first) {
-					$line = str_repeat( " ", $pad_left ) . $line;
+			array_walk($lines, function(&$line, $index) use($max, $pad_left, &$first) {
+				if ( ! $first) {
+					$line = str_repeat(" ", $pad_left).$line;
 				}
 				else
 				{
@@ -668,7 +668,7 @@ 
 		{
 			// If there's no '-' at the beginning of the argument
 			// then add it to our segments.
-			if (! $options_found && strpos($_SERVER['argv'][$i], '-') === false)
+			if ( ! $options_found && strpos($_SERVER['argv'][$i], '-') === false)
 			{
 				self::$segments[] = $_SERVER['argv'][$i];
 				continue;
@@ -685,7 +685,7 @@ 
 			$value = null;
 
 			// If the next item starts with a dash it's a value
-			if (isset($_SERVER['argv'][$i + 1]) && substr($_SERVER['argv'][$i + 1], 0, 1) != '-' )
+			if (isset($_SERVER['argv'][$i + 1]) && substr($_SERVER['argv'][$i + 1], 0, 1) != '-')
 			{
 				$value = $_SERVER['argv'][$i + 1];
 				$i++;

Braces +5 added lines, -12 removed lines

@@ -240,9 +240,7 @@ 
             if ($default !== null)
             {
                 $extra_output = ' [ Default: "'.$default.'" ]';
-            }
-
-            elseif ($options !== array())
+            } elseif ($options !== array())
             {
                 $extra_output = ' [ '.implode(', ', $options).' ]';
             }
@@ -353,15 +351,12 @@ 
                 $time--;
             }
             static::write();
-        }
-
-        else
+        } else
         {
             if ($seconds > 0)
             {
                 sleep($seconds);
-            }
-            else
+            } else
             {
                 static::write(static::$wait_msg);
                 static::input();
@@ -522,8 +517,7 @@ 
             fwrite(STDOUT, " {$percent}% Complete" . PHP_EOL);
             // Move up, undo the PHP_EOL
             fwrite(STDOUT, "\033[1A");
-        }
-        else
+        } else
         {
             fwrite(STDERR, "\007");
         }
@@ -637,8 +631,7 @@ 
 			array_walk( $lines, function ( &$line, $index ) use($max, $pad_left, &$first) {
 				if (! $first) {
 					$line = str_repeat( " ", $pad_left ) . $line;
-				}
-				else
+				} else
 				{
 					$first = false;
 				}

myth/Controllers/ThemedController.php

Doc Comments +1 added lines, -1 removed lines

@@ -368,7 +368,7 @@
     /**
      * Adds an external javascript file to the 'external_scripts' array.
      *
-     * @param [type] $filename [description]
+     * @param string $filename [description]
      */
     public function addScript($filename)
     {

Indentation +353 added lines, -353 removed lines

@@ -41,358 +41,358 @@
  */
 class ThemedController extends BaseController
 {
-    /**
-     * Stores data variables to be sent to the view.
-     * @var array
-     */
-    protected $vars = array();
-
-    /**
-     * Stores current status message.
-     * @var
-     */
-    protected $message;
-
-    /**
-     * The UIKit to make available to the template views.
-     * @var string
-     */
-    protected $uikit = '';
-
-    /**
-     * An instance of an active Themer to use.
-     * @var null
-     */
-    protected $themer = null;
-
-    /**
-     * Allows per-controller override of theme.
-     * @var null
-     */
-    protected $theme = null;
-
-    /**
-     * Per-controller override of the current layout file.
-     * @var null
-     */
-    protected $layout = null;
-
-    /**
-     * Stores an array of javascript files.
-     * @var array
-     */
-    protected $external_scripts = array();
-
-    /**
-     * Stores an array of CSS stylesheets.
-     * @var array
-     */
-    protected $stylesheets = array();
-
-    /**
-     * A MenuCollection instance
-     * @var
-     */
-    protected $meta;
-
-    /**
-     * Whether set() should escape the output...
-     * @var bool
-     */
-    protected $auto_escape = null;
-
-    /**
-     * An instance of ZendFrameworks Escaper
-     * @var null
-     */
-    protected $escaper = null;
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Constructor takes care of getting the template engine up and running
-     * and bound to our DI object, as well as any other preliminary needs,
-     * like detecting the variant to use, etc.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-
-        // Setup our Template Engine
-        $themer = config_item('active_themer');
-
-        if (empty($themer)) {
-            throw new \RuntimeException( lang('no_themer') );
-        }
-
-        $this->themer = new $themer( get_instance() );
-
-        // Register our paths with the themer
-        $paths = config_item('theme.paths');
-
-        foreach ($paths as $key => $path) {
-            $this->themer->addThemePath($key, $path);
-        }
-
-        // Set our default theme.
-        $this->themer->setDefaultTheme( config_item('theme.default_theme') );
-
-        // Register our variants with the engine.
-        $variants = config_item('theme.variants');
-
-        foreach ($variants as $key => $value) {
-            $this->themer->addVariant($key, $value);
-        }
-
-        $this->detectVariant();
-
-        // Ensure that our UIKit is loaded up if we're using one.
-        $uikit = config_item('theme.uikit');
-
-        if ($uikit)
-        {
-            $this->uikit = new $uikit();
-        }
-
-        // Load up our meta collection
-        $this->meta = new MetaCollection( get_instance() );
-
-        // Should we autoescape vars?
-        if (is_null($this->auto_escape))
-        {
-            $this->auto_escape = config_item( 'theme.auto_escape' );
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Provides a common interface with the other rendering methods to
-     * set the output of the method. Uses the current instance of $this->template.
-     * Ensures that any data we've stored through $this->setVar() are present
-     * and includes the status messages into the data.
-     *
-     * @param array $data
-     * @param int   $cache_time
-     */
-    public function render($data = array(), $cache_time=0)
-    {
-	    if ($cache_time > 0)
-	    {
-		    $this->output->cache( (int)$cache_time );
-	    }
-
-        // Determine the correct theme to use
-        $theme = ! empty($this->theme) ? $this->theme : config_item('theme.default_theme');
-        $this->themer->setTheme($theme);
-
-        // Determine the correct layout to use
-        $layout = !empty($this->layout) ? $this->layout : null;
-        $this->themer->setLayout($layout);
-
-        // Merge any saved vars into the data
-        // But first, escape the data if needed
-        if ($this->auto_escape)
-        {
-            $data = esc($data, 'html');
-        }
-        $data = array_merge($data, $this->vars);
-
-        // Make sure the MetaCollection is available in the view.
-        $data['html_meta'] = $this->meta;
-
-        // Include our UIKit so views can use it
-        if (! empty($this->uikit)) {
-            $data['uikit'] = $this->uikit;
-        }
-
-        // Build our notices from the theme's view file.
-        $data['notice'] = $this->themer->display($this->themer->theme() . ':notice', ["notice" => $this->message()]);
-
-        // Make sure any scripts/stylesheets are available to the view
-        $data['external_scripts'] = $this->external_scripts;
-        $data['stylesheets'] = $this->stylesheets;
-
-        $this->themer->set($data);
-
-        $this->output->set_content_type('html')
-                     ->set_output($this->themer->render());
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a data variable to be sent to the view during the render() method.
-     * Will auto-escape data on the way in, unless specifically told not to.
-     *
-     * Uses ZendFramework's Escaper to handle the data escaping,
-     * based on context. Valid contexts are:
-     *      - html
-     *      - htmlAttr
-     *      - js
-     *      - css
-     *      - url
-     *
-     * @param string $name
-     * @param mixed $value
-     * @param string $context
-     * @param bool $do_escape
-     */
-    public function setVar($name, $value = null, $context='html', $do_escape=null)
-    {
-        $escape = $do_escape == true ? true : $this->auto_escape;
-
-        if (is_null($this->escaper))
-        {
-            $this->escaper = new Escaper(config_item('charset'));
-        }
-
-        if (is_array($name))
-        {
-            foreach ($name as $k => $v)
-            {
-                $this->vars[$k] = $escape ? esc($v, $context, $this->escaper) : $v;
-            }
-        }
-        else
-        {
-            $this->vars[$name] = $escape ? esc($value, $context, $this->escaper) : $value;
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Status Messages
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a status message (for displaying small success/error messages).
-     * This is used in place of the session->flashdata functions since you
-     * don't always want to have to refresh the page to show the message.
-     *
-     * @param string $message The message to save.
-     * @param string $type The string to be included as the CSS class of the containing div.
-     */
-    public function setMessage($message = '', $type = 'info')
-    {
-        if (! empty($message)) {
-            if (isset($this->session)) {
-                $this->session->set_flashdata('message', $type . '::' . $message);
-            }
-
-            $this->message = array(
-                'type' => $type,
-                'message' => $message
-            );
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves the status message to display (if any).
-     *
-     * @param  string $message [description]
-     * @param  string $type [description]
-     * @return array
-     */
-    public function message($message = '', $type = 'info')
-    {
-        $return = array(
-            'message' => $message,
-            'type' => $type
-        );
-
-        // Does session data exist?
-        if (empty($message) && class_exists('CI_Session')) {
-            $message = $this->session->flashdata('message');
-
-            if (! empty($message)) {
-                // Split out our message parts
-                $temp_message = explode('::', $message);
-                $return['type'] = $temp_message[0];
-                $return['message'] = $temp_message[1];
-
-                unset($temp_message);
-            }
-        }
-
-        // If message is empty, we need to check our own storage.
-        if (empty($message)) {
-            if (empty($this->message['message'])) {
-                return '';
-            }
-
-            $return = $this->message;
-        }
-
-        // Clear our session data so we don't get extra messages on rare occasions.
-        if (class_exists('CI_Session')) {
-            $this->session->set_flashdata('message', '');
-        }
-
-        return $return;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Utility Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Detects whether the item is being displayed on a desktop, phone,
-     * or tablet device.
-     */
-    protected function detectVariant()
-    {
-        // Variant Detection and setup
-        if (config_item('autodetect_variant') === true) {
-            $detect = new \Mobile_Detect();
-
-            if ($detect->isMobile()) {
-                $this->template->setVariant('phone');
-            } else if ($detect->isTablet()) {
-                $this->template->setVariant('tablet');
-            }
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // 'Asset' functions
-    //--------------------------------------------------------------------
-
-    /**
-     * Adds an external javascript file to the 'external_scripts' array.
-     *
-     * @param [type] $filename [description]
-     */
-    public function addScript($filename)
-    {
-        if (strpos($filename, 'http') === FALSE) {
-            $filename = base_url() . 'assets/js/' . $filename;
-        }
-
-        $this->external_scripts[] = $filename;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Adds an external stylesheet file to the 'stylesheets' array.
-     */
-    public function addStyle($filename)
-    {
-        if (strpos($filename, 'http') === FALSE) {
-            $filename = base_url() . 'assets/css/' . $filename;
-        }
-
-        $this->stylesheets[] = $filename;
-    }
-
-    //--------------------------------------------------------------------
+	/**
+	 * Stores data variables to be sent to the view.
+	 * @var array
+	 */
+	protected $vars = array();
+
+	/**
+	 * Stores current status message.
+	 * @var
+	 */
+	protected $message;
+
+	/**
+	 * The UIKit to make available to the template views.
+	 * @var string
+	 */
+	protected $uikit = '';
+
+	/**
+	 * An instance of an active Themer to use.
+	 * @var null
+	 */
+	protected $themer = null;
+
+	/**
+	 * Allows per-controller override of theme.
+	 * @var null
+	 */
+	protected $theme = null;
+
+	/**
+	 * Per-controller override of the current layout file.
+	 * @var null
+	 */
+	protected $layout = null;
+
+	/**
+	 * Stores an array of javascript files.
+	 * @var array
+	 */
+	protected $external_scripts = array();
+
+	/**
+	 * Stores an array of CSS stylesheets.
+	 * @var array
+	 */
+	protected $stylesheets = array();
+
+	/**
+	 * A MenuCollection instance
+	 * @var
+	 */
+	protected $meta;
+
+	/**
+	 * Whether set() should escape the output...
+	 * @var bool
+	 */
+	protected $auto_escape = null;
+
+	/**
+	 * An instance of ZendFrameworks Escaper
+	 * @var null
+	 */
+	protected $escaper = null;
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Constructor takes care of getting the template engine up and running
+	 * and bound to our DI object, as well as any other preliminary needs,
+	 * like detecting the variant to use, etc.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+
+		// Setup our Template Engine
+		$themer = config_item('active_themer');
+
+		if (empty($themer)) {
+			throw new \RuntimeException( lang('no_themer') );
+		}
+
+		$this->themer = new $themer( get_instance() );
+
+		// Register our paths with the themer
+		$paths = config_item('theme.paths');
+
+		foreach ($paths as $key => $path) {
+			$this->themer->addThemePath($key, $path);
+		}
+
+		// Set our default theme.
+		$this->themer->setDefaultTheme( config_item('theme.default_theme') );
+
+		// Register our variants with the engine.
+		$variants = config_item('theme.variants');
+
+		foreach ($variants as $key => $value) {
+			$this->themer->addVariant($key, $value);
+		}
+
+		$this->detectVariant();
+
+		// Ensure that our UIKit is loaded up if we're using one.
+		$uikit = config_item('theme.uikit');
+
+		if ($uikit)
+		{
+			$this->uikit = new $uikit();
+		}
+
+		// Load up our meta collection
+		$this->meta = new MetaCollection( get_instance() );
+
+		// Should we autoescape vars?
+		if (is_null($this->auto_escape))
+		{
+			$this->auto_escape = config_item( 'theme.auto_escape' );
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Provides a common interface with the other rendering methods to
+	 * set the output of the method. Uses the current instance of $this->template.
+	 * Ensures that any data we've stored through $this->setVar() are present
+	 * and includes the status messages into the data.
+	 *
+	 * @param array $data
+	 * @param int   $cache_time
+	 */
+	public function render($data = array(), $cache_time=0)
+	{
+		if ($cache_time > 0)
+		{
+			$this->output->cache( (int)$cache_time );
+		}
+
+		// Determine the correct theme to use
+		$theme = ! empty($this->theme) ? $this->theme : config_item('theme.default_theme');
+		$this->themer->setTheme($theme);
+
+		// Determine the correct layout to use
+		$layout = !empty($this->layout) ? $this->layout : null;
+		$this->themer->setLayout($layout);
+
+		// Merge any saved vars into the data
+		// But first, escape the data if needed
+		if ($this->auto_escape)
+		{
+			$data = esc($data, 'html');
+		}
+		$data = array_merge($data, $this->vars);
+
+		// Make sure the MetaCollection is available in the view.
+		$data['html_meta'] = $this->meta;
+
+		// Include our UIKit so views can use it
+		if (! empty($this->uikit)) {
+			$data['uikit'] = $this->uikit;
+		}
+
+		// Build our notices from the theme's view file.
+		$data['notice'] = $this->themer->display($this->themer->theme() . ':notice', ["notice" => $this->message()]);
+
+		// Make sure any scripts/stylesheets are available to the view
+		$data['external_scripts'] = $this->external_scripts;
+		$data['stylesheets'] = $this->stylesheets;
+
+		$this->themer->set($data);
+
+		$this->output->set_content_type('html')
+					 ->set_output($this->themer->render());
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a data variable to be sent to the view during the render() method.
+	 * Will auto-escape data on the way in, unless specifically told not to.
+	 *
+	 * Uses ZendFramework's Escaper to handle the data escaping,
+	 * based on context. Valid contexts are:
+	 *      - html
+	 *      - htmlAttr
+	 *      - js
+	 *      - css
+	 *      - url
+	 *
+	 * @param string $name
+	 * @param mixed $value
+	 * @param string $context
+	 * @param bool $do_escape
+	 */
+	public function setVar($name, $value = null, $context='html', $do_escape=null)
+	{
+		$escape = $do_escape == true ? true : $this->auto_escape;
+
+		if (is_null($this->escaper))
+		{
+			$this->escaper = new Escaper(config_item('charset'));
+		}
+
+		if (is_array($name))
+		{
+			foreach ($name as $k => $v)
+			{
+				$this->vars[$k] = $escape ? esc($v, $context, $this->escaper) : $v;
+			}
+		}
+		else
+		{
+			$this->vars[$name] = $escape ? esc($value, $context, $this->escaper) : $value;
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Status Messages
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a status message (for displaying small success/error messages).
+	 * This is used in place of the session->flashdata functions since you
+	 * don't always want to have to refresh the page to show the message.
+	 *
+	 * @param string $message The message to save.
+	 * @param string $type The string to be included as the CSS class of the containing div.
+	 */
+	public function setMessage($message = '', $type = 'info')
+	{
+		if (! empty($message)) {
+			if (isset($this->session)) {
+				$this->session->set_flashdata('message', $type . '::' . $message);
+			}
+
+			$this->message = array(
+				'type' => $type,
+				'message' => $message
+			);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves the status message to display (if any).
+	 *
+	 * @param  string $message [description]
+	 * @param  string $type [description]
+	 * @return array
+	 */
+	public function message($message = '', $type = 'info')
+	{
+		$return = array(
+			'message' => $message,
+			'type' => $type
+		);
+
+		// Does session data exist?
+		if (empty($message) && class_exists('CI_Session')) {
+			$message = $this->session->flashdata('message');
+
+			if (! empty($message)) {
+				// Split out our message parts
+				$temp_message = explode('::', $message);
+				$return['type'] = $temp_message[0];
+				$return['message'] = $temp_message[1];
+
+				unset($temp_message);
+			}
+		}
+
+		// If message is empty, we need to check our own storage.
+		if (empty($message)) {
+			if (empty($this->message['message'])) {
+				return '';
+			}
+
+			$return = $this->message;
+		}
+
+		// Clear our session data so we don't get extra messages on rare occasions.
+		if (class_exists('CI_Session')) {
+			$this->session->set_flashdata('message', '');
+		}
+
+		return $return;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Utility Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Detects whether the item is being displayed on a desktop, phone,
+	 * or tablet device.
+	 */
+	protected function detectVariant()
+	{
+		// Variant Detection and setup
+		if (config_item('autodetect_variant') === true) {
+			$detect = new \Mobile_Detect();
+
+			if ($detect->isMobile()) {
+				$this->template->setVariant('phone');
+			} else if ($detect->isTablet()) {
+				$this->template->setVariant('tablet');
+			}
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// 'Asset' functions
+	//--------------------------------------------------------------------
+
+	/**
+	 * Adds an external javascript file to the 'external_scripts' array.
+	 *
+	 * @param [type] $filename [description]
+	 */
+	public function addScript($filename)
+	{
+		if (strpos($filename, 'http') === FALSE) {
+			$filename = base_url() . 'assets/js/' . $filename;
+		}
+
+		$this->external_scripts[] = $filename;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Adds an external stylesheet file to the 'stylesheets' array.
+	 */
+	public function addStyle($filename)
+	{
+		if (strpos($filename, 'http') === FALSE) {
+			$filename = base_url() . 'assets/css/' . $filename;
+		}
+
+		$this->stylesheets[] = $filename;
+	}
+
+	//--------------------------------------------------------------------
 }
 

Spacing +17 added lines, -17 removed lines

@@ -32,7 +32,7 @@ 
 use Myth\Themers\MetaCollection;
 use Zend\Escaper\Escaper;
 
-require_once dirname(__FILE__) .'/../Themers/escape.php';
+require_once dirname(__FILE__).'/../Themers/escape.php';
 
 /**
  * Class ThemedController
@@ -122,10 +122,10 @@ 
         $themer = config_item('active_themer');
 
         if (empty($themer)) {
-            throw new \RuntimeException( lang('no_themer') );
+            throw new \RuntimeException(lang('no_themer'));
         }
 
-        $this->themer = new $themer( get_instance() );
+        $this->themer = new $themer(get_instance());
 
         // Register our paths with the themer
         $paths = config_item('theme.paths');
@@ -135,7 +135,7 @@ 
         }
 
         // Set our default theme.
-        $this->themer->setDefaultTheme( config_item('theme.default_theme') );
+        $this->themer->setDefaultTheme(config_item('theme.default_theme'));
 
         // Register our variants with the engine.
         $variants = config_item('theme.variants');
@@ -155,12 +155,12 @@ 
         }
 
         // Load up our meta collection
-        $this->meta = new MetaCollection( get_instance() );
+        $this->meta = new MetaCollection(get_instance());
 
         // Should we autoescape vars?
         if (is_null($this->auto_escape))
         {
-            $this->auto_escape = config_item( 'theme.auto_escape' );
+            $this->auto_escape = config_item('theme.auto_escape');
         }
     }
 
@@ -175,11 +175,11 @@ 
      * @param array $data
      * @param int   $cache_time
      */
-    public function render($data = array(), $cache_time=0)
+    public function render($data = array(), $cache_time = 0)
     {
 	    if ($cache_time > 0)
 	    {
-		    $this->output->cache( (int)$cache_time );
+		    $this->output->cache((int) $cache_time);
 	    }
 
         // Determine the correct theme to use
@@ -187,7 +187,7 @@ 
         $this->themer->setTheme($theme);
 
         // Determine the correct layout to use
-        $layout = !empty($this->layout) ? $this->layout : null;
+        $layout = ! empty($this->layout) ? $this->layout : null;
         $this->themer->setLayout($layout);
 
         // Merge any saved vars into the data
@@ -202,12 +202,12 @@ 
         $data['html_meta'] = $this->meta;
 
         // Include our UIKit so views can use it
-        if (! empty($this->uikit)) {
+        if ( ! empty($this->uikit)) {
             $data['uikit'] = $this->uikit;
         }
 
         // Build our notices from the theme's view file.
-        $data['notice'] = $this->themer->display($this->themer->theme() . ':notice', ["notice" => $this->message()]);
+        $data['notice'] = $this->themer->display($this->themer->theme().':notice', ["notice" => $this->message()]);
 
         // Make sure any scripts/stylesheets are available to the view
         $data['external_scripts'] = $this->external_scripts;
@@ -238,7 +238,7 @@ 
      * @param string $context
      * @param bool $do_escape
      */
-    public function setVar($name, $value = null, $context='html', $do_escape=null)
+    public function setVar($name, $value = null, $context = 'html', $do_escape = null)
     {
         $escape = $do_escape == true ? true : $this->auto_escape;
 
@@ -276,9 +276,9 @@ 
      */
     public function setMessage($message = '', $type = 'info')
     {
-        if (! empty($message)) {
+        if ( ! empty($message)) {
             if (isset($this->session)) {
-                $this->session->set_flashdata('message', $type . '::' . $message);
+                $this->session->set_flashdata('message', $type.'::'.$message);
             }
 
             $this->message = array(
@@ -308,7 +308,7 @@ 
         if (empty($message) && class_exists('CI_Session')) {
             $message = $this->session->flashdata('message');
 
-            if (! empty($message)) {
+            if ( ! empty($message)) {
                 // Split out our message parts
                 $temp_message = explode('::', $message);
                 $return['type'] = $temp_message[0];
@@ -373,7 +373,7 @@ 
     public function addScript($filename)
     {
         if (strpos($filename, 'http') === FALSE) {
-            $filename = base_url() . 'assets/js/' . $filename;
+            $filename = base_url().'assets/js/'.$filename;
         }
 
         $this->external_scripts[] = $filename;
@@ -387,7 +387,7 @@ 
     public function addStyle($filename)
     {
         if (strpos($filename, 'http') === FALSE) {
-            $filename = base_url() . 'assets/css/' . $filename;
+            $filename = base_url().'assets/css/'.$filename;
         }
 
         $this->stylesheets[] = $filename;

Braces +1 added lines, -2 removed lines

@@ -253,8 +253,7 @@
             {
                 $this->vars[$k] = $escape ? esc($v, $context, $this->escaper) : $v;
             }
-        }
-        else
+        } else
         {
             $this->vars[$name] = $escape ? esc($value, $context, $this->escaper) : $value;
         }

myth/Cron/CronTask.php

Doc Comments +6 added lines, -6 removed lines

@@ -66,7 +66,7 @@ 
     /**
      * Stores our scheduled string and actual task.
      *
-     * @param $schedule
+     * @param string $schedule
      * @param callable $task
      */
     public function __construct($schedule, $task)
@@ -90,7 +90,7 @@ 
      *
      * @param int|'now' $current_time
      *
-     * @return timestamp|null
+     * @return integer|null
      */
     public function nextRunDate($current_time='now')
     {
@@ -121,7 +121,7 @@ 
      *
      * @param int|'now' $current_time
      *
-     * @return timestamp|null
+     * @return integer|null
      */
     public function previousRunDate($current_time='now')
     {
@@ -171,7 +171,7 @@ 
      * into any format available to date.
      *
      * @param $format_string
-     * @return bool|string
+     * @return string
      */
     public function format($format_string)
     {
@@ -266,8 +266,8 @@ 
      * 'every 5 minutes', every 3 days, etc.
      *
      * @param $schedule
-     * @param $type
-     * @return float|int|null
+     * @param string $type
+     * @return integer|null
      */
     public function findDateInterval($schedule, $type, $current_time='now')
     {

Indentation +291 added lines, -291 removed lines

@@ -45,301 +45,301 @@
  */
 class CronTask {
 
-    /**
-     * The original scheduled string.
-     * Any valid relative time string.
-     * http://php.net/manual/en/datetime.formats.relative.php
-     *
-     * @var
-     */
-    protected $schedule;
-
-    /**
-     * Stores the callable or library name:method to run.
-     *
-     * @var
-     */
-    protected $task;
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Stores our scheduled string and actual task.
-     *
-     * @param $schedule
-     * @param callable $task
-     */
-    public function __construct($schedule, $task)
-    {
-        $this->schedule = $schedule;
-
-        // If $task is not callable, it should be a library:method
-        // string that we can parse. But it must have the colon in the string.
-        if (! is_callable($task) && strpos($task, ':') === false)
-        {
-            throw new \RuntimeException( lang('cron.invalid_task') );
-        }
-
-        $this->task = $task;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Calculates the next date this task is supposed to run.
-     *
-     * @param int|'now' $current_time
-     *
-     * @return timestamp|null
-     */
-    public function nextRunDate($current_time='now')
-    {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
-
-        $scheduleType = $this->determineScheduleType($this->schedule);
-
-        switch ($scheduleType)
-        {
-            case 'time':
-                return $this->findDateInterval($this->schedule, 'next', $current_time);
-                break;
-            case 'ordinal':
-                return strtotime($this->schedule, $current_time);
-                break;
-            case 'increment':
-                return strtotime($this->schedule, $current_time);
-                break;
-        }
-
-        return null;
-    }
+	/**
+	 * The original scheduled string.
+	 * Any valid relative time string.
+	 * http://php.net/manual/en/datetime.formats.relative.php
+	 *
+	 * @var
+	 */
+	protected $schedule;
+
+	/**
+	 * Stores the callable or library name:method to run.
+	 *
+	 * @var
+	 */
+	protected $task;
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Stores our scheduled string and actual task.
+	 *
+	 * @param $schedule
+	 * @param callable $task
+	 */
+	public function __construct($schedule, $task)
+	{
+		$this->schedule = $schedule;
+
+		// If $task is not callable, it should be a library:method
+		// string that we can parse. But it must have the colon in the string.
+		if (! is_callable($task) && strpos($task, ':') === false)
+		{
+			throw new \RuntimeException( lang('cron.invalid_task') );
+		}
+
+		$this->task = $task;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Calculates the next date this task is supposed to run.
+	 *
+	 * @param int|'now' $current_time
+	 *
+	 * @return timestamp|null
+	 */
+	public function nextRunDate($current_time='now')
+	{
+		$current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+
+		$scheduleType = $this->determineScheduleType($this->schedule);
+
+		switch ($scheduleType)
+		{
+			case 'time':
+				return $this->findDateInterval($this->schedule, 'next', $current_time);
+				break;
+			case 'ordinal':
+				return strtotime($this->schedule, $current_time);
+				break;
+			case 'increment':
+				return strtotime($this->schedule, $current_time);
+				break;
+		}
+
+		return null;
+	}
     
-    //--------------------------------------------------------------------
-
-    /**
-     * Calculates the last time the task should have ran.
-     *
-     * @param int|'now' $current_time
-     *
-     * @return timestamp|null
-     */
-    public function previousRunDate($current_time='now')
-    {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
-
-        $scheduleType = $this->determineScheduleType($this->schedule);
-
-        switch ($scheduleType)
-        {
-            case 'time':
-                return $this->findDateInterval($this->schedule, 'prev', $current_time);
-                break;
-            case 'ordinal':
-                return $this->findPreviousOrdinal($this->schedule, $current_time);
-                break;
-            case 'increment':
-                return strtotime('-1 '. $this->schedule, $current_time);
-                break;
-        }
-
-        return null;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Determines if the task is due to be run now.
-     *
-     * @param string $current_time
-     * @internal param $ int|'now' $current_time
-     *
-     * @return bool
-     */
-    public function isDue($current_time='now')
-    {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
-
-        // For easier matching, and I can't imagine people needing cronjob
-        // accuracy to the seconds, we'll just take the current minute.
-        return date('Y-m-d H:i', $current_time) == date('Y-m-d H:i', $this->nextRunDate($current_time) );
-    }
+	//--------------------------------------------------------------------
+
+	/**
+	 * Calculates the last time the task should have ran.
+	 *
+	 * @param int|'now' $current_time
+	 *
+	 * @return timestamp|null
+	 */
+	public function previousRunDate($current_time='now')
+	{
+		$current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+
+		$scheduleType = $this->determineScheduleType($this->schedule);
+
+		switch ($scheduleType)
+		{
+			case 'time':
+				return $this->findDateInterval($this->schedule, 'prev', $current_time);
+				break;
+			case 'ordinal':
+				return $this->findPreviousOrdinal($this->schedule, $current_time);
+				break;
+			case 'increment':
+				return strtotime('-1 '. $this->schedule, $current_time);
+				break;
+		}
+
+		return null;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Determines if the task is due to be run now.
+	 *
+	 * @param string $current_time
+	 * @internal param $ int|'now' $current_time
+	 *
+	 * @return bool
+	 */
+	public function isDue($current_time='now')
+	{
+		$current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+
+		// For easier matching, and I can't imagine people needing cronjob
+		// accuracy to the seconds, we'll just take the current minute.
+		return date('Y-m-d H:i', $current_time) == date('Y-m-d H:i', $this->nextRunDate($current_time) );
+	}
     
-    //--------------------------------------------------------------------
-
-    /**
-     * Formats the timestamp produced by nextRunDate and previousRunDate
-     * into any format available to date.
-     *
-     * @param $format_string
-     * @return bool|string
-     */
-    public function format($format_string)
-    {
-        return date($format_string, strtotime($this->schedule));
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Gets the associated task.
-     *
-     * return callable|string
-     */
-    public function task()
-    {
-        return $this->task;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Gets the original schedule string.
-     */
-    public function schedule()
-    {
-        return $this->schedule;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Checks the schedule text and determines how we have to treat
-     * the schedule when determining next and previous values.
-     *
-     * Potential Types are:
-     *
-     *  - increment         Can simply add a +x/-x to the front to get the value.
-     *  - time              Something like "every 5 minutes"
-     *  - ordinal           Like "first", "second", etc.
-     *
-     * @param $schedule
-     * @return null|string
-     */
-    public function determineScheduleType($schedule)
-    {
-        $incs = ['sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sun', 'mon', 'tue',
-                'wed', 'thu', 'fri', 'sat', 'weekday', 'weekdays', 'midnight', 'noon'];
-        $bigger_incs = [ 'back of', 'front of', 'first day of', 'last day of'];
-        $ordinals = ['first', 'second', 'third', 'fourth', 'fifth', 'sixth', 'seventh', 'eighth', 'ninth', 'tenth', 'eleventh', 'twelfth'];
-        $schedule = trim( strtolower($schedule) );
-
-        $multiple_words = strpos($schedule, ' ');
-        $first_word = substr($schedule, 0, $multiple_words ? $multiple_words : strlen($schedule));
-
-        // Is the first character a number? Then it's a time
-        if ( is_numeric( $first_word ) )
-        {
-            return 'time';
-        }
-
-
-        // First, try the shorter increments. We do increments in
-        // two passes becuase this should be faster than the loop.
-        if (in_array($first_word, $incs))
-        {
-            return 'increment';
-        }
-
-        // But we have to loop before checking ordinals since
-        // ordinals may have same first word as these phrases.
-        foreach ($bigger_incs as $test)
-        {
-            if (strpos($schedule, $test) === 0)
-            {
-                return 'increment';
-            }
-        }
-
-        if (in_array($first_word, $ordinals))
-        {
-            return 'ordinal';
-        }
-
-        return null;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Determines the correct time for 'time' type intervals where
-     * the timestamp is expected to happen every 'x period', like
-     * 'every 5 minutes', every 3 days, etc.
-     *
-     * @param $schedule
-     * @param $type
-     * @return float|int|null
-     */
-    public function findDateInterval($schedule, $type, $current_time='now')
-    {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+	//--------------------------------------------------------------------
+
+	/**
+	 * Formats the timestamp produced by nextRunDate and previousRunDate
+	 * into any format available to date.
+	 *
+	 * @param $format_string
+	 * @return bool|string
+	 */
+	public function format($format_string)
+	{
+		return date($format_string, strtotime($this->schedule));
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Gets the associated task.
+	 *
+	 * return callable|string
+	 */
+	public function task()
+	{
+		return $this->task;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Gets the original schedule string.
+	 */
+	public function schedule()
+	{
+		return $this->schedule;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Checks the schedule text and determines how we have to treat
+	 * the schedule when determining next and previous values.
+	 *
+	 * Potential Types are:
+	 *
+	 *  - increment         Can simply add a +x/-x to the front to get the value.
+	 *  - time              Something like "every 5 minutes"
+	 *  - ordinal           Like "first", "second", etc.
+	 *
+	 * @param $schedule
+	 * @return null|string
+	 */
+	public function determineScheduleType($schedule)
+	{
+		$incs = ['sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sun', 'mon', 'tue',
+				'wed', 'thu', 'fri', 'sat', 'weekday', 'weekdays', 'midnight', 'noon'];
+		$bigger_incs = [ 'back of', 'front of', 'first day of', 'last day of'];
+		$ordinals = ['first', 'second', 'third', 'fourth', 'fifth', 'sixth', 'seventh', 'eighth', 'ninth', 'tenth', 'eleventh', 'twelfth'];
+		$schedule = trim( strtolower($schedule) );
+
+		$multiple_words = strpos($schedule, ' ');
+		$first_word = substr($schedule, 0, $multiple_words ? $multiple_words : strlen($schedule));
+
+		// Is the first character a number? Then it's a time
+		if ( is_numeric( $first_word ) )
+		{
+			return 'time';
+		}
+
+
+		// First, try the shorter increments. We do increments in
+		// two passes becuase this should be faster than the loop.
+		if (in_array($first_word, $incs))
+		{
+			return 'increment';
+		}
+
+		// But we have to loop before checking ordinals since
+		// ordinals may have same first word as these phrases.
+		foreach ($bigger_incs as $test)
+		{
+			if (strpos($schedule, $test) === 0)
+			{
+				return 'increment';
+			}
+		}
+
+		if (in_array($first_word, $ordinals))
+		{
+			return 'ordinal';
+		}
+
+		return null;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Determines the correct time for 'time' type intervals where
+	 * the timestamp is expected to happen every 'x period', like
+	 * 'every 5 minutes', every 3 days, etc.
+	 *
+	 * @param $schedule
+	 * @param $type
+	 * @return float|int|null
+	 */
+	public function findDateInterval($schedule, $type, $current_time='now')
+	{
+		$current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
 
 //        list($int, $period) = explode(' ', $schedule);
 
-        $diff = strtotime($schedule, $current_time) - $current_time;
-
-        $return = null;
-
-        switch ($type)
-        {
-            case 'next':
-                $next = floor($current_time / $diff) * $diff;
-
-                // Does next already match the current time?
-                if (date('Y-m-d H:i', $next) == date('Y-m-d H:i', $current_time))
-                {
-                    $return = $next;
-                }
-                else {
-                    $return = $next + $diff;
-                }
-                break;
-            case 'prev':
-                $next = ceil($current_time / $diff) * $diff;
-                $return = $next - $diff;
-                break;
-        }
-
-        if (is_numeric($return))
-        {
-            $return = (int)$return;
-        }
-
-        return $return;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Determines the timestamp of the previous ordinal-based time, like
-     * 'second Monday'.
-     *
-     * @param $schedule
-     * @param string $current_time
-     * @return int|null
-     */
-    public function findPreviousOrdinal($schedule, $current_time='now')
-    {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
-
-        if (empty($schedule)) return null;
-
-        // Loop through months in reverse, checking each one to
-        // see if the ordinal is in the past. If so - wer'e done.
-        foreach ([0, -1, -2, -3, -4, -5, -6, -7, -8, -9, -10, -11, -12] as $i)
-        {
-            $lastmonth = strtotime("last day of {$i} month", $current_time);
-
-            $test = strtotime($schedule, $lastmonth);
-
-            if ($test <= $current_time)
-            {
-                return $test;
-            }
-        }
-
-        return null;
-    }
-
-    //--------------------------------------------------------------------
+		$diff = strtotime($schedule, $current_time) - $current_time;
+
+		$return = null;
+
+		switch ($type)
+		{
+			case 'next':
+				$next = floor($current_time / $diff) * $diff;
+
+				// Does next already match the current time?
+				if (date('Y-m-d H:i', $next) == date('Y-m-d H:i', $current_time))
+				{
+					$return = $next;
+				}
+				else {
+					$return = $next + $diff;
+				}
+				break;
+			case 'prev':
+				$next = ceil($current_time / $diff) * $diff;
+				$return = $next - $diff;
+				break;
+		}
+
+		if (is_numeric($return))
+		{
+			$return = (int)$return;
+		}
+
+		return $return;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Determines the timestamp of the previous ordinal-based time, like
+	 * 'second Monday'.
+	 *
+	 * @param $schedule
+	 * @param string $current_time
+	 * @return int|null
+	 */
+	public function findPreviousOrdinal($schedule, $current_time='now')
+	{
+		$current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+
+		if (empty($schedule)) return null;
+
+		// Loop through months in reverse, checking each one to
+		// see if the ordinal is in the past. If so - wer'e done.
+		foreach ([0, -1, -2, -3, -4, -5, -6, -7, -8, -9, -10, -11, -12] as $i)
+		{
+			$lastmonth = strtotime("last day of {$i} month", $current_time);
+
+			$test = strtotime($schedule, $lastmonth);
+
+			if ($test <= $current_time)
+			{
+				return $test;
+			}
+		}
+
+		return null;
+	}
+
+	//--------------------------------------------------------------------
 
 }

Spacing +18 added lines, -18 removed lines

@@ -75,9 +75,9 @@ 
 
         // If $task is not callable, it should be a library:method
         // string that we can parse. But it must have the colon in the string.
-        if (! is_callable($task) && strpos($task, ':') === false)
+        if ( ! is_callable($task) && strpos($task, ':') === false)
         {
-            throw new \RuntimeException( lang('cron.invalid_task') );
+            throw new \RuntimeException(lang('cron.invalid_task'));
         }
 
         $this->task = $task;
@@ -92,9 +92,9 @@ 
      *
      * @return timestamp|null
      */
-    public function nextRunDate($current_time='now')
+    public function nextRunDate($current_time = 'now')
     {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+        $current_time = is_numeric($current_time) ? (int) $current_time : strtotime($current_time);
 
         $scheduleType = $this->determineScheduleType($this->schedule);
 
@@ -123,9 +123,9 @@ 
      *
      * @return timestamp|null
      */
-    public function previousRunDate($current_time='now')
+    public function previousRunDate($current_time = 'now')
     {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+        $current_time = is_numeric($current_time) ? (int) $current_time : strtotime($current_time);
 
         $scheduleType = $this->determineScheduleType($this->schedule);
 
@@ -138,7 +138,7 @@ 
                 return $this->findPreviousOrdinal($this->schedule, $current_time);
                 break;
             case 'increment':
-                return strtotime('-1 '. $this->schedule, $current_time);
+                return strtotime('-1 '.$this->schedule, $current_time);
                 break;
         }
 
@@ -155,13 +155,13 @@ 
      *
      * @return bool
      */
-    public function isDue($current_time='now')
+    public function isDue($current_time = 'now')
     {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+        $current_time = is_numeric($current_time) ? (int) $current_time : strtotime($current_time);
 
         // For easier matching, and I can't imagine people needing cronjob
         // accuracy to the seconds, we'll just take the current minute.
-        return date('Y-m-d H:i', $current_time) == date('Y-m-d H:i', $this->nextRunDate($current_time) );
+        return date('Y-m-d H:i', $current_time) == date('Y-m-d H:i', $this->nextRunDate($current_time));
     }
     
     //--------------------------------------------------------------------
@@ -219,15 +219,15 @@ 
     {
         $incs = ['sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sun', 'mon', 'tue',
                 'wed', 'thu', 'fri', 'sat', 'weekday', 'weekdays', 'midnight', 'noon'];
-        $bigger_incs = [ 'back of', 'front of', 'first day of', 'last day of'];
+        $bigger_incs = ['back of', 'front of', 'first day of', 'last day of'];
         $ordinals = ['first', 'second', 'third', 'fourth', 'fifth', 'sixth', 'seventh', 'eighth', 'ninth', 'tenth', 'eleventh', 'twelfth'];
-        $schedule = trim( strtolower($schedule) );
+        $schedule = trim(strtolower($schedule));
 
         $multiple_words = strpos($schedule, ' ');
         $first_word = substr($schedule, 0, $multiple_words ? $multiple_words : strlen($schedule));
 
         // Is the first character a number? Then it's a time
-        if ( is_numeric( $first_word ) )
+        if (is_numeric($first_word))
         {
             return 'time';
         }
@@ -269,9 +269,9 @@ 
      * @param $type
      * @return float|int|null
      */
-    public function findDateInterval($schedule, $type, $current_time='now')
+    public function findDateInterval($schedule, $type, $current_time = 'now')
     {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+        $current_time = is_numeric($current_time) ? (int) $current_time : strtotime($current_time);
 
 //        list($int, $period) = explode(' ', $schedule);
 
@@ -301,7 +301,7 @@ 
 
         if (is_numeric($return))
         {
-            $return = (int)$return;
+            $return = (int) $return;
         }
 
         return $return;
@@ -317,9 +317,9 @@ 
      * @param string $current_time
      * @return int|null
      */
-    public function findPreviousOrdinal($schedule, $current_time='now')
+    public function findPreviousOrdinal($schedule, $current_time = 'now')
     {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+        $current_time = is_numeric($current_time) ? (int) $current_time : strtotime($current_time);
 
         if (empty($schedule)) return null;
 

Braces +4 added lines, -3 removed lines

@@ -288,8 +288,7 @@ 
                 if (date('Y-m-d H:i', $next) == date('Y-m-d H:i', $current_time))
                 {
                     $return = $next;
-                }
-                else {
+                } else {
                     $return = $next + $diff;
                 }
                 break;
@@ -321,7 +320,9 @@ 
     {
         $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
 
-        if (empty($schedule)) return null;
+        if (empty($schedule)) {
+        	return null;
+        }
 
         // Loop through months in reverse, checking each one to
         // see if the ordinal is in the past. If so - wer'e done.

myth/Docs/Builder.php

Doc Comments +6 added lines, -6 removed lines

@@ -131,7 +131,7 @@ 
      * Parses the contents. Currently runs through the Markdown Extended
      * parser to convert to HTML.
      *
-     * @param $str
+     * @param string|null $str
      * @return mixed
      */
     public function parse($str)
@@ -495,7 +495,7 @@ 
      * Analyzes the passed in current url string and checks against
      * a list of groups to determine what the current group is.
      *
-     * @param $current_url
+     * @param string $current_url
      * @param $groups
      * @return string
      */
@@ -576,8 +576,8 @@ 
      * Re-formats the passed in link.
      *
      * @param $link
-     * @param $current_url
-     * @param $site_url
+     * @param string $current_url
+     * @param string $site_url
      * @return mixed
      */
     private function reformatAnchor($link, $groups, $current_url, $site_url)
@@ -659,8 +659,8 @@ 
      * Also adds named anchors into the $content so the map
      * can link to the content properly.
      *
-     * @param $content
-     * @param $xml
+     * @param string $content
+     * @param \SimpleXMLElement $xml
      * @param $map
      * @return array
      */

Indentation +718 added lines, -718 removed lines

@@ -60,725 +60,725 @@
 class Builder implements DocBuilderInterface
 {
 
-    protected $docs_ext = '.md';
-
-    protected $ignore_files = ['_404.md'];
-
-    protected $doc_folders = [];
-
-    /**
-     * Stores the current folder alias,
-     * once the file has been found.
-     *
-     * @var null
-     */
-    protected $current_folder = null;
-
-    protected $table_classes = 'table table-hover';
-
-    protected $apppath = '';
-
-    protected $formatters = [];
-
-    protected $page_title = null;
-
-    //--------------------------------------------------------------------
-
-    public function __construct($config = array())
-    {
-        $this->apppath = ! empty($config['apppath']) ? rtrim($config['apppath'], '/') . '/' : '';
-    }
-
-    //--------------------------------------------------------------------
-
-    public function pageTitle()
-    {
-        return $this->page_title;
-    }
-
-    //--------------------------------------------------------------------
-
-
-
-    /**
-     * Does the actual work of reading in and parsing the help file.
-     * If a folder Nickname (see addDocFolder() ) is passed as the second parameter,
-     * it will limit it's search to that single folder. If nothing is passed, it will
-     * search through all of the folders in the order they were given to the library,
-     * until it finds the first one.
-     *
-     * @param string $path The 'path' of the file (relative to the docs
-     *                                 folder. Usually from the URI)
-     * @param string $restrictToFolder (Optional) The folder nickname
-     *
-     * @return string
-     */
-    public function readPage($path, $restrictToFolder = null)
-    {
-        // Clean up our path
-        $path = trim($path, '/ ');
-
-        $content = $this->locateAndReadFile($path, $restrictToFolder);
-
-        $content = $this->parse($content);
-
-        return $content;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Parses the contents. Currently runs through the Markdown Extended
-     * parser to convert to HTML.
-     *
-     * @param $str
-     * @return mixed
-     */
-    public function parse($str)
-    {
-        return $this->format($str);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Perform a few housekeeping tasks on a page, like rewriting URLs to full
-     * URLs, not relative, ensuring they link correctly, etc.
-     *
-     * @param      $content
-     * @param null $site_url
-     * @param null $current_url
-     * @return string   The post-processed HTML.
-     */
-    public function postProcess($content, $site_url = null, $current_url = null)
-    {
-        if (empty($content)) {
-            return $content;
-        }
-
-        try {
-            $xml = new \SimpleXMLElement('<?xml version="1.0" standalone="yes"?><div>' . $content . '</div>');
-        } catch (\Exception $e) {
-            // SimpleXML barfed on us, so send back the un-modified content
-            return $content;
-        }
-
-        // Prepare some things and cleanup others
-        $groups = array_keys($this->doc_folders);
-        $site_url = rtrim($site_url, '/') . '/';
-        $current_url = rtrim($current_url, '#/');
-
-        // Try to determine the current_url if one isn't set.
-        if (empty($this->current_folder)) {
-            $this->current_folder = $this->detectCurrentFolder($current_url, $groups);
-        }
-
-        /*
+	protected $docs_ext = '.md';
+
+	protected $ignore_files = ['_404.md'];
+
+	protected $doc_folders = [];
+
+	/**
+	 * Stores the current folder alias,
+	 * once the file has been found.
+	 *
+	 * @var null
+	 */
+	protected $current_folder = null;
+
+	protected $table_classes = 'table table-hover';
+
+	protected $apppath = '';
+
+	protected $formatters = [];
+
+	protected $page_title = null;
+
+	//--------------------------------------------------------------------
+
+	public function __construct($config = array())
+	{
+		$this->apppath = ! empty($config['apppath']) ? rtrim($config['apppath'], '/') . '/' : '';
+	}
+
+	//--------------------------------------------------------------------
+
+	public function pageTitle()
+	{
+		return $this->page_title;
+	}
+
+	//--------------------------------------------------------------------
+
+
+
+	/**
+	 * Does the actual work of reading in and parsing the help file.
+	 * If a folder Nickname (see addDocFolder() ) is passed as the second parameter,
+	 * it will limit it's search to that single folder. If nothing is passed, it will
+	 * search through all of the folders in the order they were given to the library,
+	 * until it finds the first one.
+	 *
+	 * @param string $path The 'path' of the file (relative to the docs
+	 *                                 folder. Usually from the URI)
+	 * @param string $restrictToFolder (Optional) The folder nickname
+	 *
+	 * @return string
+	 */
+	public function readPage($path, $restrictToFolder = null)
+	{
+		// Clean up our path
+		$path = trim($path, '/ ');
+
+		$content = $this->locateAndReadFile($path, $restrictToFolder);
+
+		$content = $this->parse($content);
+
+		return $content;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Parses the contents. Currently runs through the Markdown Extended
+	 * parser to convert to HTML.
+	 *
+	 * @param $str
+	 * @return mixed
+	 */
+	public function parse($str)
+	{
+		return $this->format($str);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Perform a few housekeeping tasks on a page, like rewriting URLs to full
+	 * URLs, not relative, ensuring they link correctly, etc.
+	 *
+	 * @param      $content
+	 * @param null $site_url
+	 * @param null $current_url
+	 * @return string   The post-processed HTML.
+	 */
+	public function postProcess($content, $site_url = null, $current_url = null)
+	{
+		if (empty($content)) {
+			return $content;
+		}
+
+		try {
+			$xml = new \SimpleXMLElement('<?xml version="1.0" standalone="yes"?><div>' . $content . '</div>');
+		} catch (\Exception $e) {
+			// SimpleXML barfed on us, so send back the un-modified content
+			return $content;
+		}
+
+		// Prepare some things and cleanup others
+		$groups = array_keys($this->doc_folders);
+		$site_url = rtrim($site_url, '/') . '/';
+		$current_url = rtrim($current_url, '#/');
+
+		// Try to determine the current_url if one isn't set.
+		if (empty($this->current_folder)) {
+			$this->current_folder = $this->detectCurrentFolder($current_url, $groups);
+		}
+
+		/*
          * Rewrite the URLs
          */
-        foreach ($xml->xpath('//a') as $link) {
-            $link = $this->reformatAnchor($link, $groups, $current_url, $site_url);
-        }
-
-        $content = $xml->asXML();
-        $content = trim(str_replace('<?xml version="1.0" standalone="yes"?>', '', $content));
-
-        // Clean up and style the tables
-        $content = str_replace('<table>', '<table class="' . $this->table_classes . '">', $content);
-
-        return $content;
-    }
-    //--------------------------------------------------------------------
-
-    /**
-     * Allows users to define the classes that are attached to
-     * generated tables.
-     *
-     * @param null $classes
-     * @return $this
-     */
-    public function setTableClasses($classes = null)
-    {
-        $this->table_classes = $classes;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Given the contents to render, will build a list of links for the sidebar
-     * out of the headings in the file.
-     *
-     * Note: Will ONLY use h2 and h3 to build the links from.
-     *
-     * Note: The $content passed in WILL be modified by adding named anchors
-     * that match up with the locations.
-     *
-     * @param string $content The HTML to analyse for headings.
-     * @return string
-     */
-    public function buildDocumentMap(&$content)
-    {
-        if (empty($content)) {
-            return $content;
-        }
-
-        // If $content already has a wrapping <div> and </div> tags, remove them,
-        // since we'll replace them just below.
-        if (strpos($content, '<div>') === 0) {
-            $content = substr($content, 5);
-
-            // Trailing div also?
-            if (substr($content, -6) == '</div>') {
-                $content = substr($content, 0, -6);
-            }
-        }
-
-        try {
-            $xml = new \SimpleXMLElement('<?xml version="1.0" standalone="yes"?><div>' . $content . '</div>');
-        } catch (\Exception $e) {
-            // SimpleXML barfed on us, so send back the un-modified content
-            return [];
-        }
-
-        $map = [];
-        list($map, $content) = $this->extractDocMapAndAddAnchors($content, $xml, $map);
-
-        return $map;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Stores the name of the callback method to run to convert the source
-     * files to viewable files. By default, this should be used to register
-     * a Mardown Extended formatter with the system, but could be used to
-     * extend the
-     *
-     * @param string $callback
-     * @param bool $cascade // If FALSE the formatting of a component ends here. If TRUE, will be passed to next formatter.
-     * @return $this
-     */
-    public function registerFormatter($callback = null, $cascade = false)
-    {
-        if (empty($callback)) return;
-
-        $this->formatters[] = [
-            'callable' => $callback,
-            'cascade'  => (bool)$cascade
-        ];
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Runs the text through the registered formatters.
-     *
-     * @param $str
-     * @return mixed
-     */
-    public function format($str)
-    {
-        if (! is_array($this->formatters)) return $str;
-
-        foreach ($this->formatters as $formatter) {
-            $method = $formatter['callable'];
-            $cascade = $formatter['cascade'];
-
-            $str = call_user_func($method, $str);
-
-            if (! $cascade) return $str;
-        }
-
-        return $str;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Table of Contents methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves the list of files in a folder and preps the name and filename
-     * so it's ready for creating the HTML.
-     *
-     * @param  String $folder The path to the folder to retrieve.
-     *
-     * @return Array  An associative array @see parse_ini_file for format
-     * details.
-     */
-    public function buildTOC($folder)
-    {
-        // If the toc file exists in the folder, use it to build the links.
-        if (is_file("{$folder}/_toc.ini")) {
-            $toc = parse_ini_file("{$folder}/_toc.ini", true);
-            return $this->columnizeTOC($toc);
-        }
-
-        // If the toc file does not exist, build the links by listing the files
-        // in the directory (and any sub-directories)
-        $map = $this->directory_map($folder);
-
-        // If directory_map can not open the directory or find any files inside
-        // the directory, return an empty array.
-        if (empty($map)) {
-            return [];
-        }
-
-        // If these docs are located in the /application/docs or /bonfire/docs
-        // directory, just use $this->current_group for the root.
-        // Module docs need $this->current_group and $type.
-        $tocRoot = $this->current_folder;
-        if ($this->current_folder != strtolower($folder)) {
-            $tocRoot .= '/' . strtolower($folder);
-        }
-
-        $toc = [];
-        foreach ($map as $files) {
-            // If $files isn't an array, then make it one so that all situations
-            // may be dealt with cleanly.
-            if (! is_array($files)) {
-                $files = [$files];
-            }
-
-            foreach ($files as $file) {
-                if (in_array($file, $this->ignore_files)) {
-                    continue;
-                }
-
-                // The title for the index is the passed $type. Otherwise,
-                // build the title from the file's name.
-                if (strpos($file, 'index') === false) {
-                    $title = str_replace($this->docs_ext, '', $file);
-                    $title = str_replace('_', ' ', $title);
-                    $title = ucwords($title);
-
-                    $toc["{$tocRoot}/{$file}"] = $title;
-                } else {
-                    $toc[$tocRoot] = $type;
-                }
-            }
-        }
-
-        $toc = $this->columnizeTOC($toc);
-
-        return $toc;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sorts the passed TOC array into columns of as close to equal length
-     * as we can get it.
-     *
-     * @param $toc
-     * @return array
-     */
-    protected function columnizeTOC($toc)
-    {
-        $section_count = count($toc);
-
-        // First - determine the size of each 'section'.
-        $sizes = [];
-
-        foreach ($toc as $section => $chapters) {
-            $sizes[] = count($chapters);
-        }
-
-        $column_avg = (int)round(array_sum($sizes) / $section_count);
-
-        // Split things into 4 columns of approximately equal size.
-        // If we only have 4 columns (or less), then make sure to
-        // deal with that also.
-        $columns = [];
-
-        $current_column = 0;
-        $current_column_count = 0;
-        $keys = array_keys($toc);
-
-        for ($i = 0; $i <= $section_count; $i++) {
-            if (! isset($keys[$i])) {
-                continue;
-            }
-
-            $section = array_shift($toc);
-
-            // Can we stay in this column?
-            if ($current_column_count <= $column_avg && $section_count > 4) {
-                // Don't forget to account for the heading also.
-                $current_column_count += count($section) + 1;
-            } else {
-                $current_column_count = 0;
-                $current_column++;
-            }
-
-            $columns[$current_column][$keys[$i]] = $section;
-        }
-
-        return $columns;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Folder Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns the current docFolders array.
-     *
-     * @return array
-     */
-    public function docFolders()
-    {
-        return $this->doc_folders;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Registers a path to be used when searching for documentation files.
-     *
-     * @param $name     A nickname to reference it by later.
-     * @param $path     The server path to the folder.
-     * @return $this
-     */
-    public function addDocFolder($name, $path)
-    {
-        // Standardize the path
-        $path = realpath($path) . '/';
-
-        // realpath will return FALSE if the path doesn't exist
-        // or the script doesn't have access to it.
-        if (! $path || $path == '/') {
-            return $this;
-        }
-
-        $name = strtolower($name);
-
-        $this->doc_folders[$name] = $path;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Removes a folder from the folders we scan for documentation files
-     * within.
-     *
-     * @param $name
-     * @return $this
-     */
-    public function removeDocFolder($name)
-    {
-        $name = strtolower($name);
-
-        if (isset($this->doc_folders[$name])) {
-            unset($this->doc_folders[$name]);
-        }
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Private Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Analyzes the passed in current url string and checks against
-     * a list of groups to determine what the current group is.
-     *
-     * @param $current_url
-     * @param $groups
-     * @return string
-     */
-    protected function detectCurrentFolder($current_url, $groups = [])
-    {
-        if (! is_array($groups)) {
-            return null;
-        }
-
-        $segments = explode('/', $current_url);
-
-        // We start from the back of the array since
-        // that's most likely to be close to the end.
-        $segments = array_reverse($segments);
-
-        foreach ($segments as $segment) {
-            foreach ($groups as $group) {
-                if (strtolower($group) == strtolower($segment)) {
-                    return $group;
-                }
-            }
-        }
-
-        // Nothing found?
-        return null;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Private Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Locates the file on disk and reads the contents into a single string.
-     *
-     * If a folder Nickname (see addDocFolder() ) is passed as the second parameter,
-     * it will limit it's search to that single folder. If nothing is passed, it will
-     * search through all of the folders in the order they were given to the library,
-     * until it finds the first one.
-     *
-     * @param string $path The 'path' of the file (relative to the docs
-     *                                 folder. Usually from the URI)
-     * @param string $restrictToFolder (Optional) The nickname of one of the
-     *                                 folders to restrict the search to.
-     *
-     * @throws RuntimeException
-     * @return null|string
-     */
-    private function locateAndReadFile($path, $restrictToFolder = null)
-    {
-        $folders = $this->doc_folders;
-
-        if (! is_null($restrictToFolder)) {
-            // Make sure the folder exists
-            if (! is_null($restrictToFolder) && ! isset($this->doc_folders[$restrictToFolder])) {
-                throw new \RuntimeException('You must add the docs folder that you wish to find docs from.');
-            }
-
-            $folders = [$this->doc_folders[$restrictToFolder]];
-        }
-
-        foreach ($folders as $alias => $folder) {
-            if (file_exists($folder . $path . $this->docs_ext)) {
-                // Store the alias so we know which folder we're in.
-                $this->current_folder = $alias;
-
-                return file_get_contents($folder . $path . $this->docs_ext);
-            }
-        }
-
-        return null;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Re-formats the passed in link.
-     *
-     * @param $link
-     * @param $current_url
-     * @param $site_url
-     * @return mixed
-     */
-    private function reformatAnchor($link, $groups, $current_url, $site_url)
-    {
-        // Grab the href value.
-        $href = $link->attributes()->href;
-
-        // If the href is null, it's probably a named anchor with no content.
-        if (! $href) {
-            // Make sure it has an href, else the XML will not close this
-            // tag correctly.
-            $link['href'] = ' ';
-
-            return $link;
-        }
-
-        // Remove any trailing # signs
-        $href = rtrim($href, '# ');
-
-        // If the href starts with #, then attach the current_url to it
-        if ($href != '' && substr_compare($href, '#', 0, 1) === 0) {
-            $link['href'] = $current_url . $href;
-
-            return $link;
-        }
-
-        // If it's a full external path, go on...
-        if ((strpos($href, 'http://') !== false || strpos($href, 'https://') !== false) &&
-            strpos($href, $site_url) === false
-        ) {
-            $link['target'] = "_blank";
-            return $link;
-        }
-
-        // If it's a full local path, get rid of it.
-        if (strpos($href, $site_url) !== false) {
-            $href = str_replace($site_url, '', $href);
-        }
-
-        // Strip out some unnecessary items, just in case they're there.
-        if (substr($href, 0, strlen('docs/')) == 'docs/') {
-            $href = substr($href, strlen('docs/'));
-        }
-
-        // This includes 'bonfire/' if it was missed during the conversion.
-        if (substr($href, 0, strlen('bonfire/')) == 'bonfire/') {
-            $href = substr($href, strlen('bonfire/'));
-        }
-
-        // If another 'group' is not already defined at the head of the link
-        // then add the current group to it.
-        $group_found = false;
-
-        foreach ($groups as $group) {
-            if (strpos($href, $group) === 0) {
-                $group_found = true;
-            }
-        }
-
-        if (! $group_found) {
-            $href = $this->current_folder . '/' . $href;
-        }
-
-        // Convert to full site_url
-        if (strpos($href, 'http') !== 0) {
-            $href = $site_url . 'docs/' . ltrim($href, '/ ');
-        }
-
-        // Save the corrected href
-        $link['href'] = $href;
-
-        return $link;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Creates a Document Map based on <h2> and <h3> tags.
-     * Also adds named anchors into the $content so the map
-     * can link to the content properly.
-     *
-     * @param $content
-     * @param $xml
-     * @param $map
-     * @return array
-     */
-    protected function extractDocMapAndAddAnchors(&$content, $xml, $map)
-    {
-        // Holds the current h2 we're processing
-        $current_obj = [];
-
-        $currentChild = 0;
-
-        foreach ($xml->children() as $childType => $line) {
-            $currentChild++;
-
-            // If it's an h1 - take the first and make it
-            // our page title.
-            if ($childType == 'h1' && empty($this->page_title))
-            {
-                $this->page_title = (string)$line;
-            }
-
-            // Make sure that our current object is
-            // stored and reset.
-            if ($childType == 'h1' || $childType == 'h2') {
-                if (count($current_obj)) {
-                    $map[] = $current_obj;
-                    $current_obj = [];
-                }
-            }
-
-            if ($childType == 'h2') {
-                $name = (string)$line;
-                $link = strtolower(str_replace(' ', '_', (string)$line));
-
-                $current_obj['name'] = $name;
-                $current_obj['link'] = '#' . $link;
-                $current_obj['items'] = [];
-
-                // Insert a named anchor into the $content
-                $anchor = '<a name="' . $link . '" id="' . $link . '" ></a>';
-
-                $search = "<h2>{$name}</h2>";
-
-                $content = str_replace($search, $anchor . $search, $content);
-            } elseif ($childType == 'h3') {
-                // Make sure we have some place to store the items.
-                if (! isset($current_obj['items'])) {
-                    $current_obj['items'] = [];
-                }
-
-                $link = strtolower(str_replace(' ', '_', (string)$line));
-                $name = (string)$line;
-
-                $current_obj['items'][] = [
-                    'name' => $name,
-                    'link' => '#' . $link
-                ];
-
-                // Insert a named anchor into the $content
-                $anchor = '<a name="' . $link . '" id="' . $link . '" ></a>';
-
-                $search = "<h3>{$name}</h3>";
-
-                $content = str_replace($search, $anchor . $search, $content);
-            }
-
-            // Is this the last element? Then close out our current object.
-            if (count($xml) == $currentChild) {
-                if (count($current_obj)) {
-                    $map[] = $current_obj;
-                }
-            }
-        }
-        return [$map, $content];
-    }
-    //--------------------------------------------------------------------
-
-    /**
-     * Create a Directory Map
-     *
-     * Reads the specified directory and builds an array
-     * representation of it. Sub-folders contained with the
-     * directory will be mapped as well.
-     *
-     * @param    string $source_dir Path to source
-     * @param    int $directory_depth Depth of directories to traverse
-     *                        (0 = fully recursive, 1 = current dir, etc)
-     * @param    bool $hidden Whether to show hidden files
-     * @return    array
-     */
-    protected function directory_map($source_dir, $directory_depth = 0, $hidden = FALSE)
-    {
-        if ($fp = @opendir($source_dir)) {
-            $filedata = array();
-            $new_depth = $directory_depth - 1;
-            $source_dir = rtrim($source_dir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
-
-            while (FALSE !== ($file = readdir($fp))) {
-                // Remove '.', '..', and hidden files [optional]
-                if ($file === '.' OR $file === '..' OR ($hidden === FALSE && $file[0] === '.')) {
-                    continue;
-                }
-
-                is_dir($source_dir . $file) && $file .= DIRECTORY_SEPARATOR;
-
-                if (($directory_depth < 1 OR $new_depth > 0) && is_dir($source_dir . $file)) {
-                    $filedata[$file] = directory_map($source_dir . $file, $new_depth, $hidden);
-                } else {
-                    $filedata[] = $file;
-                }
-            }
-
-            closedir($fp);
-            return $filedata;
-        }
-
-        return FALSE;
-    }
-
-    //--------------------------------------------------------------------
+		foreach ($xml->xpath('//a') as $link) {
+			$link = $this->reformatAnchor($link, $groups, $current_url, $site_url);
+		}
+
+		$content = $xml->asXML();
+		$content = trim(str_replace('<?xml version="1.0" standalone="yes"?>', '', $content));
+
+		// Clean up and style the tables
+		$content = str_replace('<table>', '<table class="' . $this->table_classes . '">', $content);
+
+		return $content;
+	}
+	//--------------------------------------------------------------------
+
+	/**
+	 * Allows users to define the classes that are attached to
+	 * generated tables.
+	 *
+	 * @param null $classes
+	 * @return $this
+	 */
+	public function setTableClasses($classes = null)
+	{
+		$this->table_classes = $classes;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Given the contents to render, will build a list of links for the sidebar
+	 * out of the headings in the file.
+	 *
+	 * Note: Will ONLY use h2 and h3 to build the links from.
+	 *
+	 * Note: The $content passed in WILL be modified by adding named anchors
+	 * that match up with the locations.
+	 *
+	 * @param string $content The HTML to analyse for headings.
+	 * @return string
+	 */
+	public function buildDocumentMap(&$content)
+	{
+		if (empty($content)) {
+			return $content;
+		}
+
+		// If $content already has a wrapping <div> and </div> tags, remove them,
+		// since we'll replace them just below.
+		if (strpos($content, '<div>') === 0) {
+			$content = substr($content, 5);
+
+			// Trailing div also?
+			if (substr($content, -6) == '</div>') {
+				$content = substr($content, 0, -6);
+			}
+		}
+
+		try {
+			$xml = new \SimpleXMLElement('<?xml version="1.0" standalone="yes"?><div>' . $content . '</div>');
+		} catch (\Exception $e) {
+			// SimpleXML barfed on us, so send back the un-modified content
+			return [];
+		}
+
+		$map = [];
+		list($map, $content) = $this->extractDocMapAndAddAnchors($content, $xml, $map);
+
+		return $map;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Stores the name of the callback method to run to convert the source
+	 * files to viewable files. By default, this should be used to register
+	 * a Mardown Extended formatter with the system, but could be used to
+	 * extend the
+	 *
+	 * @param string $callback
+	 * @param bool $cascade // If FALSE the formatting of a component ends here. If TRUE, will be passed to next formatter.
+	 * @return $this
+	 */
+	public function registerFormatter($callback = null, $cascade = false)
+	{
+		if (empty($callback)) return;
+
+		$this->formatters[] = [
+			'callable' => $callback,
+			'cascade'  => (bool)$cascade
+		];
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Runs the text through the registered formatters.
+	 *
+	 * @param $str
+	 * @return mixed
+	 */
+	public function format($str)
+	{
+		if (! is_array($this->formatters)) return $str;
+
+		foreach ($this->formatters as $formatter) {
+			$method = $formatter['callable'];
+			$cascade = $formatter['cascade'];
+
+			$str = call_user_func($method, $str);
+
+			if (! $cascade) return $str;
+		}
+
+		return $str;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Table of Contents methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves the list of files in a folder and preps the name and filename
+	 * so it's ready for creating the HTML.
+	 *
+	 * @param  String $folder The path to the folder to retrieve.
+	 *
+	 * @return Array  An associative array @see parse_ini_file for format
+	 * details.
+	 */
+	public function buildTOC($folder)
+	{
+		// If the toc file exists in the folder, use it to build the links.
+		if (is_file("{$folder}/_toc.ini")) {
+			$toc = parse_ini_file("{$folder}/_toc.ini", true);
+			return $this->columnizeTOC($toc);
+		}
+
+		// If the toc file does not exist, build the links by listing the files
+		// in the directory (and any sub-directories)
+		$map = $this->directory_map($folder);
+
+		// If directory_map can not open the directory or find any files inside
+		// the directory, return an empty array.
+		if (empty($map)) {
+			return [];
+		}
+
+		// If these docs are located in the /application/docs or /bonfire/docs
+		// directory, just use $this->current_group for the root.
+		// Module docs need $this->current_group and $type.
+		$tocRoot = $this->current_folder;
+		if ($this->current_folder != strtolower($folder)) {
+			$tocRoot .= '/' . strtolower($folder);
+		}
+
+		$toc = [];
+		foreach ($map as $files) {
+			// If $files isn't an array, then make it one so that all situations
+			// may be dealt with cleanly.
+			if (! is_array($files)) {
+				$files = [$files];
+			}
+
+			foreach ($files as $file) {
+				if (in_array($file, $this->ignore_files)) {
+					continue;
+				}
+
+				// The title for the index is the passed $type. Otherwise,
+				// build the title from the file's name.
+				if (strpos($file, 'index') === false) {
+					$title = str_replace($this->docs_ext, '', $file);
+					$title = str_replace('_', ' ', $title);
+					$title = ucwords($title);
+
+					$toc["{$tocRoot}/{$file}"] = $title;
+				} else {
+					$toc[$tocRoot] = $type;
+				}
+			}
+		}
+
+		$toc = $this->columnizeTOC($toc);
+
+		return $toc;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sorts the passed TOC array into columns of as close to equal length
+	 * as we can get it.
+	 *
+	 * @param $toc
+	 * @return array
+	 */
+	protected function columnizeTOC($toc)
+	{
+		$section_count = count($toc);
+
+		// First - determine the size of each 'section'.
+		$sizes = [];
+
+		foreach ($toc as $section => $chapters) {
+			$sizes[] = count($chapters);
+		}
+
+		$column_avg = (int)round(array_sum($sizes) / $section_count);
+
+		// Split things into 4 columns of approximately equal size.
+		// If we only have 4 columns (or less), then make sure to
+		// deal with that also.
+		$columns = [];
+
+		$current_column = 0;
+		$current_column_count = 0;
+		$keys = array_keys($toc);
+
+		for ($i = 0; $i <= $section_count; $i++) {
+			if (! isset($keys[$i])) {
+				continue;
+			}
+
+			$section = array_shift($toc);
+
+			// Can we stay in this column?
+			if ($current_column_count <= $column_avg && $section_count > 4) {
+				// Don't forget to account for the heading also.
+				$current_column_count += count($section) + 1;
+			} else {
+				$current_column_count = 0;
+				$current_column++;
+			}
+
+			$columns[$current_column][$keys[$i]] = $section;
+		}
+
+		return $columns;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Folder Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns the current docFolders array.
+	 *
+	 * @return array
+	 */
+	public function docFolders()
+	{
+		return $this->doc_folders;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Registers a path to be used when searching for documentation files.
+	 *
+	 * @param $name     A nickname to reference it by later.
+	 * @param $path     The server path to the folder.
+	 * @return $this
+	 */
+	public function addDocFolder($name, $path)
+	{
+		// Standardize the path
+		$path = realpath($path) . '/';
+
+		// realpath will return FALSE if the path doesn't exist
+		// or the script doesn't have access to it.
+		if (! $path || $path == '/') {
+			return $this;
+		}
+
+		$name = strtolower($name);
+
+		$this->doc_folders[$name] = $path;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Removes a folder from the folders we scan for documentation files
+	 * within.
+	 *
+	 * @param $name
+	 * @return $this
+	 */
+	public function removeDocFolder($name)
+	{
+		$name = strtolower($name);
+
+		if (isset($this->doc_folders[$name])) {
+			unset($this->doc_folders[$name]);
+		}
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Private Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Analyzes the passed in current url string and checks against
+	 * a list of groups to determine what the current group is.
+	 *
+	 * @param $current_url
+	 * @param $groups
+	 * @return string
+	 */
+	protected function detectCurrentFolder($current_url, $groups = [])
+	{
+		if (! is_array($groups)) {
+			return null;
+		}
+
+		$segments = explode('/', $current_url);
+
+		// We start from the back of the array since
+		// that's most likely to be close to the end.
+		$segments = array_reverse($segments);
+
+		foreach ($segments as $segment) {
+			foreach ($groups as $group) {
+				if (strtolower($group) == strtolower($segment)) {
+					return $group;
+				}
+			}
+		}
+
+		// Nothing found?
+		return null;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Private Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Locates the file on disk and reads the contents into a single string.
+	 *
+	 * If a folder Nickname (see addDocFolder() ) is passed as the second parameter,
+	 * it will limit it's search to that single folder. If nothing is passed, it will
+	 * search through all of the folders in the order they were given to the library,
+	 * until it finds the first one.
+	 *
+	 * @param string $path The 'path' of the file (relative to the docs
+	 *                                 folder. Usually from the URI)
+	 * @param string $restrictToFolder (Optional) The nickname of one of the
+	 *                                 folders to restrict the search to.
+	 *
+	 * @throws RuntimeException
+	 * @return null|string
+	 */
+	private function locateAndReadFile($path, $restrictToFolder = null)
+	{
+		$folders = $this->doc_folders;
+
+		if (! is_null($restrictToFolder)) {
+			// Make sure the folder exists
+			if (! is_null($restrictToFolder) && ! isset($this->doc_folders[$restrictToFolder])) {
+				throw new \RuntimeException('You must add the docs folder that you wish to find docs from.');
+			}
+
+			$folders = [$this->doc_folders[$restrictToFolder]];
+		}
+
+		foreach ($folders as $alias => $folder) {
+			if (file_exists($folder . $path . $this->docs_ext)) {
+				// Store the alias so we know which folder we're in.
+				$this->current_folder = $alias;
+
+				return file_get_contents($folder . $path . $this->docs_ext);
+			}
+		}
+
+		return null;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Re-formats the passed in link.
+	 *
+	 * @param $link
+	 * @param $current_url
+	 * @param $site_url
+	 * @return mixed
+	 */
+	private function reformatAnchor($link, $groups, $current_url, $site_url)
+	{
+		// Grab the href value.
+		$href = $link->attributes()->href;
+
+		// If the href is null, it's probably a named anchor with no content.
+		if (! $href) {
+			// Make sure it has an href, else the XML will not close this
+			// tag correctly.
+			$link['href'] = ' ';
+
+			return $link;
+		}
+
+		// Remove any trailing # signs
+		$href = rtrim($href, '# ');
+
+		// If the href starts with #, then attach the current_url to it
+		if ($href != '' && substr_compare($href, '#', 0, 1) === 0) {
+			$link['href'] = $current_url . $href;
+
+			return $link;
+		}
+
+		// If it's a full external path, go on...
+		if ((strpos($href, 'http://') !== false || strpos($href, 'https://') !== false) &&
+			strpos($href, $site_url) === false
+		) {
+			$link['target'] = "_blank";
+			return $link;
+		}
+
+		// If it's a full local path, get rid of it.
+		if (strpos($href, $site_url) !== false) {
+			$href = str_replace($site_url, '', $href);
+		}
+
+		// Strip out some unnecessary items, just in case they're there.
+		if (substr($href, 0, strlen('docs/')) == 'docs/') {
+			$href = substr($href, strlen('docs/'));
+		}
+
+		// This includes 'bonfire/' if it was missed during the conversion.
+		if (substr($href, 0, strlen('bonfire/')) == 'bonfire/') {
+			$href = substr($href, strlen('bonfire/'));
+		}
+
+		// If another 'group' is not already defined at the head of the link
+		// then add the current group to it.
+		$group_found = false;
+
+		foreach ($groups as $group) {
+			if (strpos($href, $group) === 0) {
+				$group_found = true;
+			}
+		}
+
+		if (! $group_found) {
+			$href = $this->current_folder . '/' . $href;
+		}
+
+		// Convert to full site_url
+		if (strpos($href, 'http') !== 0) {
+			$href = $site_url . 'docs/' . ltrim($href, '/ ');
+		}
+
+		// Save the corrected href
+		$link['href'] = $href;
+
+		return $link;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Creates a Document Map based on <h2> and <h3> tags.
+	 * Also adds named anchors into the $content so the map
+	 * can link to the content properly.
+	 *
+	 * @param $content
+	 * @param $xml
+	 * @param $map
+	 * @return array
+	 */
+	protected function extractDocMapAndAddAnchors(&$content, $xml, $map)
+	{
+		// Holds the current h2 we're processing
+		$current_obj = [];
+
+		$currentChild = 0;
+
+		foreach ($xml->children() as $childType => $line) {
+			$currentChild++;
+
+			// If it's an h1 - take the first and make it
+			// our page title.
+			if ($childType == 'h1' && empty($this->page_title))
+			{
+				$this->page_title = (string)$line;
+			}
+
+			// Make sure that our current object is
+			// stored and reset.
+			if ($childType == 'h1' || $childType == 'h2') {
+				if (count($current_obj)) {
+					$map[] = $current_obj;
+					$current_obj = [];
+				}
+			}
+
+			if ($childType == 'h2') {
+				$name = (string)$line;
+				$link = strtolower(str_replace(' ', '_', (string)$line));
+
+				$current_obj['name'] = $name;
+				$current_obj['link'] = '#' . $link;
+				$current_obj['items'] = [];
+
+				// Insert a named anchor into the $content
+				$anchor = '<a name="' . $link . '" id="' . $link . '" ></a>';
+
+				$search = "<h2>{$name}</h2>";
+
+				$content = str_replace($search, $anchor . $search, $content);
+			} elseif ($childType == 'h3') {
+				// Make sure we have some place to store the items.
+				if (! isset($current_obj['items'])) {
+					$current_obj['items'] = [];
+				}
+
+				$link = strtolower(str_replace(' ', '_', (string)$line));
+				$name = (string)$line;
+
+				$current_obj['items'][] = [
+					'name' => $name,
+					'link' => '#' . $link
+				];
+
+				// Insert a named anchor into the $content
+				$anchor = '<a name="' . $link . '" id="' . $link . '" ></a>';
+
+				$search = "<h3>{$name}</h3>";
+
+				$content = str_replace($search, $anchor . $search, $content);
+			}
+
+			// Is this the last element? Then close out our current object.
+			if (count($xml) == $currentChild) {
+				if (count($current_obj)) {
+					$map[] = $current_obj;
+				}
+			}
+		}
+		return [$map, $content];
+	}
+	//--------------------------------------------------------------------
+
+	/**
+	 * Create a Directory Map
+	 *
+	 * Reads the specified directory and builds an array
+	 * representation of it. Sub-folders contained with the
+	 * directory will be mapped as well.
+	 *
+	 * @param    string $source_dir Path to source
+	 * @param    int $directory_depth Depth of directories to traverse
+	 *                        (0 = fully recursive, 1 = current dir, etc)
+	 * @param    bool $hidden Whether to show hidden files
+	 * @return    array
+	 */
+	protected function directory_map($source_dir, $directory_depth = 0, $hidden = FALSE)
+	{
+		if ($fp = @opendir($source_dir)) {
+			$filedata = array();
+			$new_depth = $directory_depth - 1;
+			$source_dir = rtrim($source_dir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+
+			while (FALSE !== ($file = readdir($fp))) {
+				// Remove '.', '..', and hidden files [optional]
+				if ($file === '.' OR $file === '..' OR ($hidden === FALSE && $file[0] === '.')) {
+					continue;
+				}
+
+				is_dir($source_dir . $file) && $file .= DIRECTORY_SEPARATOR;
+
+				if (($directory_depth < 1 OR $new_depth > 0) && is_dir($source_dir . $file)) {
+					$filedata[$file] = directory_map($source_dir . $file, $new_depth, $hidden);
+				} else {
+					$filedata[] = $file;
+				}
+			}
+
+			closedir($fp);
+			return $filedata;
+		}
+
+		return FALSE;
+	}
+
+	//--------------------------------------------------------------------
 
 }

Spacing +40 added lines, -40 removed lines

@@ -86,7 +86,7 @@ 
 
     public function __construct($config = array())
     {
-        $this->apppath = ! empty($config['apppath']) ? rtrim($config['apppath'], '/') . '/' : '';
+        $this->apppath = ! empty($config['apppath']) ? rtrim($config['apppath'], '/').'/' : '';
     }
 
     //--------------------------------------------------------------------
@@ -157,7 +157,7 @@ 
         }
 
         try {
-            $xml = new \SimpleXMLElement('<?xml version="1.0" standalone="yes"?><div>' . $content . '</div>');
+            $xml = new \SimpleXMLElement('<?xml version="1.0" standalone="yes"?><div>'.$content.'</div>');
         } catch (\Exception $e) {
             // SimpleXML barfed on us, so send back the un-modified content
             return $content;
@@ -165,7 +165,7 @@ 
 
         // Prepare some things and cleanup others
         $groups = array_keys($this->doc_folders);
-        $site_url = rtrim($site_url, '/') . '/';
+        $site_url = rtrim($site_url, '/').'/';
         $current_url = rtrim($current_url, '#/');
 
         // Try to determine the current_url if one isn't set.
@@ -184,7 +184,7 @@ 
         $content = trim(str_replace('<?xml version="1.0" standalone="yes"?>', '', $content));
 
         // Clean up and style the tables
-        $content = str_replace('<table>', '<table class="' . $this->table_classes . '">', $content);
+        $content = str_replace('<table>', '<table class="'.$this->table_classes.'">', $content);
 
         return $content;
     }
@@ -236,7 +236,7 @@ 
         }
 
         try {
-            $xml = new \SimpleXMLElement('<?xml version="1.0" standalone="yes"?><div>' . $content . '</div>');
+            $xml = new \SimpleXMLElement('<?xml version="1.0" standalone="yes"?><div>'.$content.'</div>');
         } catch (\Exception $e) {
             // SimpleXML barfed on us, so send back the un-modified content
             return [];
@@ -266,7 +266,7 @@ 
 
         $this->formatters[] = [
             'callable' => $callback,
-            'cascade'  => (bool)$cascade
+            'cascade'  => (bool) $cascade
         ];
 
         return $this;
@@ -282,7 +282,7 @@ 
      */
     public function format($str)
     {
-        if (! is_array($this->formatters)) return $str;
+        if ( ! is_array($this->formatters)) return $str;
 
         foreach ($this->formatters as $formatter) {
             $method = $formatter['callable'];
@@ -290,7 +290,7 @@ 
 
             $str = call_user_func($method, $str);
 
-            if (! $cascade) return $str;
+            if ( ! $cascade) return $str;
         }
 
         return $str;
@@ -334,14 +334,14 @@ 
         // Module docs need $this->current_group and $type.
         $tocRoot = $this->current_folder;
         if ($this->current_folder != strtolower($folder)) {
-            $tocRoot .= '/' . strtolower($folder);
+            $tocRoot .= '/'.strtolower($folder);
         }
 
         $toc = [];
         foreach ($map as $files) {
             // If $files isn't an array, then make it one so that all situations
             // may be dealt with cleanly.
-            if (! is_array($files)) {
+            if ( ! is_array($files)) {
                 $files = [$files];
             }
 
@@ -389,7 +389,7 @@ 
             $sizes[] = count($chapters);
         }
 
-        $column_avg = (int)round(array_sum($sizes) / $section_count);
+        $column_avg = (int) round(array_sum($sizes) / $section_count);
 
         // Split things into 4 columns of approximately equal size.
         // If we only have 4 columns (or less), then make sure to
@@ -401,7 +401,7 @@ 
         $keys = array_keys($toc);
 
         for ($i = 0; $i <= $section_count; $i++) {
-            if (! isset($keys[$i])) {
+            if ( ! isset($keys[$i])) {
                 continue;
             }
 
@@ -450,11 +450,11 @@ 
     public function addDocFolder($name, $path)
     {
         // Standardize the path
-        $path = realpath($path) . '/';
+        $path = realpath($path).'/';
 
         // realpath will return FALSE if the path doesn't exist
         // or the script doesn't have access to it.
-        if (! $path || $path == '/') {
+        if ( ! $path || $path == '/') {
             return $this;
         }
 
@@ -501,7 +501,7 @@ 
      */
     protected function detectCurrentFolder($current_url, $groups = [])
     {
-        if (! is_array($groups)) {
+        if ( ! is_array($groups)) {
             return null;
         }
 
@@ -549,9 +549,9 @@ 
     {
         $folders = $this->doc_folders;
 
-        if (! is_null($restrictToFolder)) {
+        if ( ! is_null($restrictToFolder)) {
             // Make sure the folder exists
-            if (! is_null($restrictToFolder) && ! isset($this->doc_folders[$restrictToFolder])) {
+            if ( ! is_null($restrictToFolder) && ! isset($this->doc_folders[$restrictToFolder])) {
                 throw new \RuntimeException('You must add the docs folder that you wish to find docs from.');
             }
 
@@ -559,11 +559,11 @@ 
         }
 
         foreach ($folders as $alias => $folder) {
-            if (file_exists($folder . $path . $this->docs_ext)) {
+            if (file_exists($folder.$path.$this->docs_ext)) {
                 // Store the alias so we know which folder we're in.
                 $this->current_folder = $alias;
 
-                return file_get_contents($folder . $path . $this->docs_ext);
+                return file_get_contents($folder.$path.$this->docs_ext);
             }
         }
 
@@ -586,7 +586,7 @@ 
         $href = $link->attributes()->href;
 
         // If the href is null, it's probably a named anchor with no content.
-        if (! $href) {
+        if ( ! $href) {
             // Make sure it has an href, else the XML will not close this
             // tag correctly.
             $link['href'] = ' ';
@@ -599,7 +599,7 @@ 
 
         // If the href starts with #, then attach the current_url to it
         if ($href != '' && substr_compare($href, '#', 0, 1) === 0) {
-            $link['href'] = $current_url . $href;
+            $link['href'] = $current_url.$href;
 
             return $link;
         }
@@ -637,13 +637,13 @@ 
             }
         }
 
-        if (! $group_found) {
-            $href = $this->current_folder . '/' . $href;
+        if ( ! $group_found) {
+            $href = $this->current_folder.'/'.$href;
         }
 
         // Convert to full site_url
         if (strpos($href, 'http') !== 0) {
-            $href = $site_url . 'docs/' . ltrim($href, '/ ');
+            $href = $site_url.'docs/'.ltrim($href, '/ ');
         }
 
         // Save the corrected href
@@ -678,7 +678,7 @@ 
             // our page title.
             if ($childType == 'h1' && empty($this->page_title))
             {
-                $this->page_title = (string)$line;
+                $this->page_title = (string) $line;
             }
 
             // Make sure that our current object is
@@ -691,39 +691,39 @@ 
             }
 
             if ($childType == 'h2') {
-                $name = (string)$line;
-                $link = strtolower(str_replace(' ', '_', (string)$line));
+                $name = (string) $line;
+                $link = strtolower(str_replace(' ', '_', (string) $line));
 
                 $current_obj['name'] = $name;
-                $current_obj['link'] = '#' . $link;
+                $current_obj['link'] = '#'.$link;
                 $current_obj['items'] = [];
 
                 // Insert a named anchor into the $content
-                $anchor = '<a name="' . $link . '" id="' . $link . '" ></a>';
+                $anchor = '<a name="'.$link.'" id="'.$link.'" ></a>';
 
                 $search = "<h2>{$name}</h2>";
 
-                $content = str_replace($search, $anchor . $search, $content);
+                $content = str_replace($search, $anchor.$search, $content);
             } elseif ($childType == 'h3') {
                 // Make sure we have some place to store the items.
-                if (! isset($current_obj['items'])) {
+                if ( ! isset($current_obj['items'])) {
                     $current_obj['items'] = [];
                 }
 
-                $link = strtolower(str_replace(' ', '_', (string)$line));
-                $name = (string)$line;
+                $link = strtolower(str_replace(' ', '_', (string) $line));
+                $name = (string) $line;
 
                 $current_obj['items'][] = [
                     'name' => $name,
-                    'link' => '#' . $link
+                    'link' => '#'.$link
                 ];
 
                 // Insert a named anchor into the $content
-                $anchor = '<a name="' . $link . '" id="' . $link . '" ></a>';
+                $anchor = '<a name="'.$link.'" id="'.$link.'" ></a>';
 
                 $search = "<h3>{$name}</h3>";
 
-                $content = str_replace($search, $anchor . $search, $content);
+                $content = str_replace($search, $anchor.$search, $content);
             }
 
             // Is this the last element? Then close out our current object.
@@ -755,7 +755,7 @@ 
         if ($fp = @opendir($source_dir)) {
             $filedata = array();
             $new_depth = $directory_depth - 1;
-            $source_dir = rtrim($source_dir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+            $source_dir = rtrim($source_dir, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
 
             while (FALSE !== ($file = readdir($fp))) {
                 // Remove '.', '..', and hidden files [optional]
@@ -763,10 +763,10 @@ 
                     continue;
                 }
 
-                is_dir($source_dir . $file) && $file .= DIRECTORY_SEPARATOR;
+                is_dir($source_dir.$file) && $file .= DIRECTORY_SEPARATOR;
 
-                if (($directory_depth < 1 OR $new_depth > 0) && is_dir($source_dir . $file)) {
-                    $filedata[$file] = directory_map($source_dir . $file, $new_depth, $hidden);
+                if (($directory_depth < 1 OR $new_depth > 0) && is_dir($source_dir.$file)) {
+                    $filedata[$file] = directory_map($source_dir.$file, $new_depth, $hidden);
                 } else {
                     $filedata[] = $file;
                 }

Braces +9 added lines, -3 removed lines

@@ -262,7 +262,9 @@ 
      */
     public function registerFormatter($callback = null, $cascade = false)
     {
-        if (empty($callback)) return;
+        if (empty($callback)) {
+        	return;
+        }
 
         $this->formatters[] = [
             'callable' => $callback,
@@ -282,7 +284,9 @@ 
      */
     public function format($str)
     {
-        if (! is_array($this->formatters)) return $str;
+        if (! is_array($this->formatters)) {
+        	return $str;
+        }
 
         foreach ($this->formatters as $formatter) {
             $method = $formatter['callable'];
@@ -290,7 +294,9 @@ 
 
             $str = call_user_func($method, $str);
 
-            if (! $cascade) return $str;
+            if (! $cascade) {
+            	return $str;
+            }
         }
 
         return $str;

myth/Forensics/Profiler.php

Doc Comments +1 added lines, -1 removed lines

@@ -501,7 +501,7 @@
 	 *
 	 * Allows any data passed to views to be available in the profiler bar.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function _compile_view_data()
 	{

Indentation +5 added lines, -5 removed lines

@@ -531,16 +531,16 @@
 
 
 	public static function get_file_size($size, $retstring = null) {
-        // adapted from code at http://aidanlister.com/repos/v/function.size_readable.php
-	    $sizes = array('bytes', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB');
+		// adapted from code at http://aidanlister.com/repos/v/function.size_readable.php
+		$sizes = array('bytes', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB');
 
-	    if ($retstring === null) { $retstring = '%01.2f %s'; }
+		if ($retstring === null) { $retstring = '%01.2f %s'; }
 
 		$lastsizestring = end($sizes);
 
 		foreach ($sizes as $sizestring) {
-	       	if ($size < 1024) { break; }
-	           if ($sizestring != $lastsizestring) { $size /= 1024; }
+		   	if ($size < 1024) { break; }
+			   if ($sizestring != $lastsizestring) { $size /= 1024; }
 		}
 
 		if ($sizestring == $sizes[0]) { $retstring = '%01d %s'; } // Bytes aren't normally fractional

Spacing +12 added lines, -12 removed lines

@@ -81,20 +81,20 @@ 
 										'view_data'
 										);
 
-	protected $_sections = array();		// Stores _compile_x() results
+	protected $_sections = array(); // Stores _compile_x() results
 
-	protected $_query_toggle_count 	= 25;
+	protected $_query_toggle_count = 25;
 
 	// --------------------------------------------------------------------
 
 	public function __construct($config = array())
 	{
-		$this->CI =& get_instance();
+		$this->CI = & get_instance();
 		$this->CI->load->language('profiler');
 
 		// If the config file has a query_toggle_count,
 		// use it, but remove it from the config array.
-		if ( isset($config['query_toggle_count']) )
+		if (isset($config['query_toggle_count']))
 		{
 			$this->_query_toggle_count = (int) $config['query_toggle_count'];
 			unset($config['query_toggle_count']);
@@ -195,7 +195,7 @@ 
 		// Let's determine which databases are currently connected to
 		foreach (get_object_vars($this->CI) as $CI_object)
 		{
-			if (is_object($CI_object) && is_subclass_of(get_class($CI_object), 'CI_DB') )
+			if (is_object($CI_object) && is_subclass_of(get_class($CI_object), 'CI_DB'))
 			{
 				$dbs[] = $CI_object;
 			}
@@ -229,7 +229,7 @@ 
 
 					foreach ($highlight as $bold)
 					{
-						$val = str_replace($bold, '<b>'. $bold .'</b>', $val);
+						$val = str_replace($bold, '<b>'.$bold.'</b>', $val);
 					}
 
 					$output[][$time] = $val;
@@ -268,7 +268,7 @@ 
 			{
 				if (is_array($val))
 				{
-					$output[$key] = "<pre>" . htmlspecialchars(stripslashes(print_r($val, true))) . "</pre>";
+					$output[$key] = "<pre>".htmlspecialchars(stripslashes(print_r($val, true)))."</pre>";
 				}
 				else
 				{
@@ -306,11 +306,11 @@ 
 
 				if (is_array($val))
 				{
-					$output['&#36;_POST['. $key .']'] = '<pre>'. htmlspecialchars(stripslashes(print_r($val, TRUE))) . '</pre>';
+					$output['&#36;_POST['.$key.']'] = '<pre>'.htmlspecialchars(stripslashes(print_r($val, TRUE))).'</pre>';
 				}
 				else
 				{
-					$output['&#36;_POST['. $key .']'] = htmlspecialchars(stripslashes($val));
+					$output['&#36;_POST['.$key.']'] = htmlspecialchars(stripslashes($val));
 				}
 			}
 		}
@@ -366,7 +366,7 @@ 
 	{
 		if (function_exists('memory_get_usage') && ($usage = memory_get_usage()) != '')
 		{
-			$output = number_format($usage) .' bytes';
+			$output = number_format($usage).' bytes';
 		}
 		else
 		{
@@ -389,10 +389,10 @@ 
 	{
 		$output = array();
 
-		foreach (array('HTTP_ACCEPT', 'HTTP_USER_AGENT', 'HTTP_CONNECTION', 'SERVER_PORT', 'SERVER_NAME', 'REMOTE_ADDR', 'SERVER_SOFTWARE', 'HTTP_ACCEPT_LANGUAGE', 'SCRIPT_NAME', 'REQUEST_METHOD',' HTTP_HOST', 'REMOTE_HOST', 'CONTENT_TYPE', 'SERVER_PROTOCOL', 'QUERY_STRING', 'HTTP_ACCEPT_ENCODING', 'HTTP_X_FORWARDED_FOR') as $header)
+		foreach (array('HTTP_ACCEPT', 'HTTP_USER_AGENT', 'HTTP_CONNECTION', 'SERVER_PORT', 'SERVER_NAME', 'REMOTE_ADDR', 'SERVER_SOFTWARE', 'HTTP_ACCEPT_LANGUAGE', 'SCRIPT_NAME', 'REQUEST_METHOD', ' HTTP_HOST', 'REMOTE_HOST', 'CONTENT_TYPE', 'SERVER_PROTOCOL', 'QUERY_STRING', 'HTTP_ACCEPT_ENCODING', 'HTTP_X_FORWARDED_FOR') as $header)
 		{
 			$val = (isset($_SERVER[$header])) ? $_SERVER[$header] : '';
-			$output[$header] =  $val;
+			$output[$header] = $val;
 		}
 
 		return $output;

Braces +13 added lines, -21 removed lines

@@ -217,8 +217,7 @@ 
 			if (count($db->queries) == 0)
 			{
 				$output = $this->CI->lang->line('profiler_no_queries');
-			}
-			else
+			} else
 			{
 				$total = 0; // total query time
 
@@ -261,16 +260,14 @@ 
 		if (count($get) == 0 || $get === false)
 		{
 			$output = $this->CI->lang->line('profiler_no_get');
-		}
-		else
+		} else
 		{
 			foreach ($get as $key => $val)
 			{
 				if (is_array($val))
 				{
 					$output[$key] = "<pre>" . htmlspecialchars(stripslashes(print_r($val, true))) . "</pre>";
-				}
-				else
+				} else
 				{
 					$output[$key] = htmlspecialchars(stripslashes($val));
 				}
@@ -294,8 +291,7 @@ 
 		if (count($_POST) == 0)
 		{
 			$output = $this->CI->lang->line('profiler_no_post');
-		}
-		else
+		} else
 		{
 			foreach ($_POST as $key => $val)
 			{
@@ -307,8 +303,7 @@ 
 				if (is_array($val))
 				{
 					$output['&#36;_POST['. $key .']'] = '<pre>'. htmlspecialchars(stripslashes(print_r($val, TRUE))) . '</pre>';
-				}
-				else
+				} else
 				{
 					$output['&#36;_POST['. $key .']'] = htmlspecialchars(stripslashes($val));
 				}
@@ -330,8 +325,7 @@ 
 		if ($this->CI->uri->uri_string == '')
 		{
 			$output = $this->CI->lang->line('profiler_no_uri');
-		}
-		else
+		} else
 		{
 			$output = $this->CI->uri->uri_string;
 		}
@@ -367,8 +361,7 @@ 
 		if (function_exists('memory_get_usage') && ($usage = memory_get_usage()) != '')
 		{
 			$output = number_format($usage) .' bytes';
-		}
-		else
+		} else
 		{
 			$output = $this->CI->lang->line('profiler_no_memory_usage');
 		}
@@ -448,8 +441,7 @@ 
 				if ($log['type'] == 'log')
 				{
 					$logs['console'][$key]['data'] = print_r($log['data'], true);
-				}
-				elseif ($log['type'] == 'memory')
+				} elseif ($log['type'] == 'memory')
 				{
 					$logs['console'][$key]['data'] = $this->get_file_size($log['data']);
 				}
@@ -482,8 +474,7 @@ 
 					if (is_array($val) || is_object($val))
 					{
 						$output[$key] = htmlspecialchars(stripslashes(print_r($val, true)));
-					}
-					else
+					} else
 					{
 						$output[$key] = htmlspecialchars(stripslashes($val));
 					}
@@ -517,8 +508,7 @@ 
 			if (is_array($val) || is_object($val))
 			{
 				$output[$key] = htmlspecialchars(stripslashes(print_r($val, true)));
-			}
-			else
+			} else
 			{
 				$output[$key] = htmlspecialchars(stripslashes($val));
 			}
@@ -565,7 +555,9 @@ 
 			if ($this->_compile_{$section} !== FALSE)
 			{
 				$func = "_compile_{$section}";
-				if ($section == 'http_headers') $section = 'headers';
+				if ($section == 'http_headers') {
+					$section = 'headers';
+				}
 				$this->_sections[$section] = $this->{$func}();
 				$fields_displayed++;
 			}

myth/Forge/BaseGenerator.php

Doc Comments +7 added lines, -7 removed lines

@@ -167,10 +167,10 @@ 
     /**
      * Creates a new directory at the specified path.
      *
-     * @param $path
-     * @param int|string $perms
+     * @param string $path
+     * @param integer $perms
      *
-     * @return bool
+     * @return BaseGenerator
      */
     public function createDirectory($path, $perms=0755)
     {
@@ -221,7 +221,7 @@ 
      * parses it with the passed in data, and writes to the new location.
      *
      * @param $template
-     * @param $destination
+     * @param string $destination
      * @param array $data
      * @param bool $overwrite
      *
@@ -253,7 +253,7 @@ 
      *      replace => ''   - a simple string to be replaced. All locations will be replaced.
      *      regex   => ''   - a pregex pattern to use to replace all locations.
      *
-     * @param $path
+     * @param string $path
      * @param $content
      * @param array $options
      *
@@ -318,7 +318,7 @@ 
 	 * the next command.
 	 *
 	 * @param $command
-	 * @param null $options
+	 * @param string|null $options
 	 */
     public function generate($command, $options = '', $quiet=false)
     {
@@ -544,7 +544,7 @@ 
 	/**
 	 * Scans through the collections for the folder for this generator.
 	 *
-	 * @param $name
+	 * @param string $name
 	 *
 	 * @return null|string
 	 */

Spacing +68 added lines, -68 removed lines

@@ -79,7 +79,7 @@ 
 
 		    if (is_array($folders))
 		    {
-			    $this->module_path = $folders[0] . strtolower($module) .'/';
+			    $this->module_path = $folders[0].strtolower($module).'/';
 		    }
 		}
 
@@ -101,7 +101,7 @@ 
      * @param bool  $quiet      If true, models should accept default values.
      * @return mixed
      */
-    abstract function run($segments=[], $quiet=false);
+    abstract function run($segments = [], $quiet = false);
 
     //--------------------------------------------------------------------
 
@@ -114,7 +114,7 @@ 
      *
      * @return bool
      */
-    public function createFile($path, $contents=null, $overwrite=false, $perms=0644)
+    public function createFile($path, $contents = null, $overwrite = false, $perms = 0644)
     {
 	    $path = $this->sandbox($path);
 
@@ -123,8 +123,8 @@ 
         // Does file already exist?
         if ($file_exists)
         {
-	        if (! $overwrite) {
-		        CLI::write( CLI::color("\t". strtolower(lang('exists')) .": ", 'blue') . str_replace(APPPATH, '', $path ) );
+	        if ( ! $overwrite) {
+		        CLI::write(CLI::color("\t".strtolower(lang('exists')).": ", 'blue').str_replace(APPPATH, '', $path));
 		        return true;
 	        }
 
@@ -136,27 +136,27 @@ 
 		array_pop($segments);
 		$folder = implode('/', $segments);
 
-	    if (! is_dir($folder))
+	    if ( ! is_dir($folder))
 	    {
 		    $this->createDirectory($folder);
 	    }
 
         get_instance()->load->helper('file');
 
-        if (! write_file($path, $contents))
+        if ( ! write_file($path, $contents))
         {
-            throw new \RuntimeException( sprintf( lang('errors.writing_file'),  $path) );
+            throw new \RuntimeException(sprintf(lang('errors.writing_file'), $path));
         }
 
         chmod($path, $perms);
 
 	    if ($overwrite && $file_exists)
 	    {
-		    CLI::write( CLI::color("\t". strtolower( lang('overwrote') ) ." ", 'light_red') . str_replace(APPPATH, '', $path ) );
+		    CLI::write(CLI::color("\t".strtolower(lang('overwrote'))." ", 'light_red').str_replace(APPPATH, '', $path));
 	    }
 	    else
 	    {
-		    CLI::write( CLI::color("\t". strtolower( lang('created') ) ." ", 'yellow') . str_replace(APPPATH, '', $path ) );
+		    CLI::write(CLI::color("\t".strtolower(lang('created'))." ", 'yellow').str_replace(APPPATH, '', $path));
 	    }
 
         return $this;
@@ -172,7 +172,7 @@ 
      *
      * @return bool
      */
-    public function createDirectory($path, $perms=0755)
+    public function createDirectory($path, $perms = 0755)
     {
 	    $path = $this->sandbox($path);
 
@@ -181,9 +181,9 @@ 
             return $this;
         }
 
-        if (! mkdir($path, $perms, true) )
+        if ( ! mkdir($path, $perms, true))
         {
-            throw new \RuntimeException( sprintf( lang('errors.creating_dir'), $path) );
+            throw new \RuntimeException(sprintf(lang('errors.creating_dir'), $path));
         }
 
         return $this;
@@ -200,11 +200,11 @@ 
      *
      * @return bool
      */
-    public function copyFile($source, $destination, $overwrite=false)
+    public function copyFile($source, $destination, $overwrite = false)
     {
 	    $source = $this->sandbox($source);
 
-	    if (! file_exists($source))
+	    if ( ! file_exists($source))
 	    {
 		    return null;
 	    }
@@ -227,9 +227,9 @@ 
      *
      * @return $this
      */
-    public function copyTemplate($template, $destination, $data=[], $overwrite=false)
+    public function copyTemplate($template, $destination, $data = [], $overwrite = false)
     {
-	    if (! is_array($data))
+	    if ( ! is_array($data))
 	    {
 		    $data = array($data);
 	    }
@@ -259,7 +259,7 @@ 
      *
      * @return $this
      */
-    public function injectIntoFile($path, $content, $options='append')
+    public function injectIntoFile($path, $content, $options = 'append')
     {
         $kit = new FileKit();
 
@@ -270,11 +270,11 @@ 
         else if (is_array($options) && count($options))
         {
             $keys = array_keys($options);
-            $action = array_shift( $keys );
+            $action = array_shift($keys);
             $param = $options[$action];
         }
 
-        switch ( strtolower($action) )
+        switch (strtolower($action))
         {
             case 'prepend':
                 $success = $kit->prepend($path, $content);
@@ -299,11 +299,11 @@ 
 
         if ($success)
         {
-            CLI::write( CLI::color("\t". strtolower( lang('modified') ) ." ", 'cyan') . str_replace(APPPATH, '', $path ) );
+            CLI::write(CLI::color("\t".strtolower(lang('modified'))." ", 'cyan').str_replace(APPPATH, '', $path));
         }
         else
         {
-            CLI::write( CLI::color("\t". strtolower( lang('error') ) ." ", 'light_red') . str_replace(APPPATH, '', $path ) );
+            CLI::write(CLI::color("\t".strtolower(lang('error'))." ", 'light_red').str_replace(APPPATH, '', $path));
         }
 
         return $this;
@@ -320,10 +320,10 @@ 
 	 * @param $command
 	 * @param null $options
 	 */
-    public function generate($command, $options = '', $quiet=false)
+    public function generate($command, $options = '', $quiet = false)
     {
 		$orig_options = CLI::optionString();
-	    $options = $orig_options .' '. $options;
+	    $options = $orig_options.' '.$options;
 
 	    if ($quiet === true)
 	    {
@@ -335,7 +335,7 @@ 
 		    $options .= ' -overwrite';
 	    }
 
-	    passthru( "php sprint forge {$command} {$options}" );
+	    passthru("php sprint forge {$command} {$options}");
     }
 
     //--------------------------------------------------------------------
@@ -348,7 +348,7 @@ 
      *
      * @return \Myth\Forge\BaseGenerator
      */
-    public function route($left, $right, $options=[], $method='any')
+    public function route($left, $right, $options = [], $method = 'any')
     {
         $option_str = '[';
 
@@ -361,7 +361,7 @@ 
 
         $content = "\$routes->{$method}('{$left}', '{$right}', {$option_str});\n";
 
-        return $this->injectIntoFile(APPPATH .'config/routes.php', $content, ['after' => "// Auto-generated routes go here\n"]);
+        return $this->injectIntoFile(APPPATH.'config/routes.php', $content, ['after' => "// Auto-generated routes go here\n"]);
     }
     
     //--------------------------------------------------------------------
@@ -369,21 +369,21 @@ 
     /**
      * Outputs the contents of the file in the template's source path.
      */
-    public function readme($file='readme.txt')
+    public function readme($file = 'readme.txt')
     {
 	    $name = str_replace('Generator', '', get_class($this));
 
 	    $path = $this->locateGenerator($name);
 
-        if (! file_exists($path . $file))
+        if ( ! file_exists($path.$file))
         {
-            CLI::error(sprintf( lang('forge.cant_find_readme'), $file) );
+            CLI::error(sprintf(lang('forge.cant_find_readme'), $file));
         }
 
-	    $contents = file_get_contents($path . $file);
+	    $contents = file_get_contents($path.$file);
 
         CLI::new_line(2);
-        CLI::write( CLI::wrap($contents), 'green' );
+        CLI::write(CLI::wrap($contents), 'green');
         CLI::new_line();
     }
 
@@ -399,7 +399,7 @@ 
      *
      * @return string The rendered template
      */
-    public function render($template_name, $data=[], $folder=null)
+    public function render($template_name, $data = [], $folder = null)
     {
         if (empty($this->themer))
         {
@@ -410,27 +410,27 @@ 
 
         $output = null;
 
-	    $view = $template_name .'.tpl';
+	    $view = $template_name.'.tpl';
 
         $groups = config_item('forge.collections');
 
-	    $name = str_replace('Generator', '', get_class($this) );
+	    $name = str_replace('Generator', '', get_class($this));
 
         foreach ($groups as $group => $path)
         {
-	        $path = rtrim($path, '/ ') .'/';
+	        $path = rtrim($path, '/ ').'/';
 	        $folders = scandir($path);
 
-	        if (! $i = array_search(ucfirst($name), $folders))
+	        if ( ! $i = array_search(ucfirst($name), $folders))
 	        {
 		        continue;
 	        }
 
-	        $view = $folders[$i] . '/'. $view;
+	        $view = $folders[$i].'/'.$view;
 
-            if (realpath($path . $view .'.php'))
+            if (realpath($path.$view.'.php'))
             {
-                $output = $this->themer->display($group .':'. $view, $data);
+                $output = $this->themer->display($group.':'.$view, $data);
                 break;
             }
         }
@@ -461,24 +461,24 @@ 
         $path = $this->normalizePath($path);
 
 		// If it's writing to BASEPATH - FIX IT
-		if (strpos($path, $this->normalizePath(BASEPATH) ) === 0)
+		if (strpos($path, $this->normalizePath(BASEPATH)) === 0)
 		{
-			return APPPATH . $path;
+			return APPPATH.$path;
 		}
 
 		// Exact match for FCPATH?
-		if (strpos($path, $this->normalizePath(FCPATH) ) === 0)
+		if (strpos($path, $this->normalizePath(FCPATH)) === 0)
 		{
 			return $path;
 		}
 
 		// Exact match for APPPATH?
-		if (strpos($path, $this->normalizePath(APPPATH) ) === 0)
+		if (strpos($path, $this->normalizePath(APPPATH)) === 0)
 		{
 			return $path;
 		}
 
-	    return APPPATH . $path;
+	    return APPPATH.$path;
 	}
 
 	//--------------------------------------------------------------------
@@ -493,12 +493,12 @@ 
     {
         $themer_name = config_item('forge.themer');
 
-        if (! $themer_name)
+        if ( ! $themer_name)
         {
-            throw new \RuntimeException( lang('forge.no_themer') );
+            throw new \RuntimeException(lang('forge.no_themer'));
         }
 
-        $this->themer = new $themer_name( get_instance() );
+        $this->themer = new $themer_name(get_instance());
 
         // Register our paths with the themer
         $paths = config_item('forge.collections');
@@ -514,9 +514,9 @@ 
 	{
 		$kit_name = config_item('theme.uikit');
 
-		if (! $kit_name)
+		if ( ! $kit_name)
 		{
-			throw new \RuntimeException( lang('forge.no_uikit') );
+			throw new \RuntimeException(lang('forge.no_uikit'));
 		}
 
 		$uikit = new $kit_name();
@@ -527,16 +527,16 @@ 
 	//--------------------------------------------------------------------
 
 
-	protected function determineOutputPath($folder='')
+	protected function determineOutputPath($folder = '')
 	{
-		$path = APPPATH . $folder;
+		$path = APPPATH.$folder;
 
-		if (! empty($this->module_path))
+		if ( ! empty($this->module_path))
 		{
-			$path = $this->module_path . $folder;
+			$path = $this->module_path.$folder;
 		}
 
-		return rtrim($path, '/ ') .'/';
+		return rtrim($path, '/ ').'/';
 	}
 
 	//--------------------------------------------------------------------
@@ -552,22 +552,22 @@ 
 	{
 		$collections = config_item('forge.collections');
 
-		if (! is_array($collections) || ! count($collections) )
+		if ( ! is_array($collections) || ! count($collections))
 		{
-			return CLI::error( lang('forge.no_collections') );
+			return CLI::error(lang('forge.no_collections'));
 		}
 
 		foreach ($collections as $alias => $path)
 		{
-			$path = rtrim($path, '/ ') .'/';
+			$path = rtrim($path, '/ ').'/';
 			$folders = scandir($path);
 
-			if (! $i = array_search(ucfirst($name), $folders))
+			if ( ! $i = array_search(ucfirst($name), $folders))
 			{
 				continue;
 			}
 
-			$this->gen_path = $path . $folders[$i] .'/';
+			$this->gen_path = $path.$folders[$i].'/';
 
 			return $this->gen_path;
 		}
@@ -584,9 +584,9 @@ 
 	 *
 	 * @return string
 	 */
-	protected function stringify($array, $depth=0)
+	protected function stringify($array, $depth = 0)
 	{
-		if (! is_array($array))
+		if ( ! is_array($array))
 		{
 			return '';
 		}
@@ -606,9 +606,9 @@ 
 
 		foreach ($array as $key => $value)
 		{
-			$str .= str_repeat("\t", $depth +1);
+			$str .= str_repeat("\t", $depth + 1);
 
-			if (! is_numeric($key))
+			if ( ! is_numeric($key))
 			{
 				$str .= "'{$key}' => ";
 			}
@@ -632,7 +632,7 @@ 
 			}
 		}
 
-		$str .= str_repeat("\t", $depth) ."],";
+		$str .= str_repeat("\t", $depth)."],";
 
 		return $str;
 	}
@@ -667,13 +667,13 @@ 
         // Initialize testing variable
         $test = '';
 
-        foreach($segments as $segment)
+        foreach ($segments as $segment)
         {
-            if($segment != '.')
+            if ($segment != '.')
             {
                 $test = array_pop($parts);
 
-                if(is_null($test))
+                if (is_null($test))
                 {
                     $parts[] = $segment;
                 }

Braces +8 added lines, -16 removed lines

@@ -153,8 +153,7 @@ 
 	    if ($overwrite && $file_exists)
 	    {
 		    CLI::write( CLI::color("\t". strtolower( lang('overwrote') ) ." ", 'light_red') . str_replace(APPPATH, '', $path ) );
-	    }
-	    else
+	    } else
 	    {
 		    CLI::write( CLI::color("\t". strtolower( lang('created') ) ." ", 'yellow') . str_replace(APPPATH, '', $path ) );
 	    }
@@ -266,8 +265,7 @@ 
         if (is_string($options))
         {
             $action = $options;
-        }
-        else if (is_array($options) && count($options))
+        } else if (is_array($options) && count($options))
         {
             $keys = array_keys($options);
             $action = array_shift( $keys );
@@ -300,8 +298,7 @@ 
         if ($success)
         {
             CLI::write( CLI::color("\t". strtolower( lang('modified') ) ." ", 'cyan') . str_replace(APPPATH, '', $path ) );
-        }
-        else
+        } else
         {
             CLI::write( CLI::color("\t". strtolower( lang('error') ) ." ", 'light_red') . str_replace(APPPATH, '', $path ) );
         }
@@ -616,17 +613,14 @@ 
 			if (is_array($value))
 			{
 				$str .= $this->stringify($value, $depth);
-			}
-			else if (is_bool($value))
+			} else if (is_bool($value))
 			{
 				$b = $value === true ? 'true' : 'false';
 				$str .= "{$b},\n";
-			}
-			else if (is_numeric($value))
+			} else if (is_numeric($value))
 			{
 				$str .= "{$value},\n";
-			}
-			else
+			} else
 			{
 				$str .= "'{$value}',\n";
 			}
@@ -676,8 +670,7 @@ 
                 if(is_null($test))
                 {
                     $parts[] = $segment;
-                }
-                else if ($segment == '..')
+                } else if ($segment == '..')
                 {
                     if ($test == '..')
                     {
@@ -688,8 +681,7 @@ 
                     {
                         $parts[] = $segment;
                     }
-                }
-                else
+                } else
                 {
                     $parts[] = $test;
                     $parts[] = $segment;

Indentation +412 added lines, -412 removed lines

@@ -43,13 +43,13 @@ 
  */
 abstract class BaseGenerator extends CLIController {
 
-    /**
-     * Instance of the active themer.
-     * @var null
-     */
-    protected $themer = null;
+	/**
+	 * Instance of the active themer.
+	 * @var null
+	 */
+	protected $themer = null;
 
-    protected $gen_path = null;
+	protected $gen_path = null;
 
 	/**
 	 * The name of the module being used, if any.
@@ -62,254 +62,254 @@ 
 
 	protected $overwrite = false;
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    public function __construct()
-    {
-        parent::__construct();
+	public function __construct()
+	{
+		parent::__construct();
 
-        $this->load->config('forge');
+		$this->load->config('forge');
 
-	    // Detect if we're genning in a module
-	    if ($module = CLI::option('module'))
-	    {
-		    $this->module = $module;
+		// Detect if we're genning in a module
+		if ($module = CLI::option('module'))
+		{
+			$this->module = $module;
 
-		    $folders = config_item('modules_locations');
+			$folders = config_item('modules_locations');
 
-		    if (is_array($folders))
-		    {
-			    $this->module_path = $folders[0] . strtolower($module) .'/';
-		    }
+			if (is_array($folders))
+			{
+				$this->module_path = $folders[0] . strtolower($module) .'/';
+			}
 		}
 
-	    // Should we overwrite files?
-	    if (CLI::option('overwrite'))
-	    {
-		    $this->overwrite = true;
-	    }
-    }
+		// Should we overwrite files?
+		if (CLI::option('overwrite'))
+		{
+			$this->overwrite = true;
+		}
+	}
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
 
-    /**
-     * The method called by the main generator script. This must be
-     * overridden by child classes to implement the actual logic used.
-     *
-     * @param array $segments
-     * @param bool  $quiet      If true, models should accept default values.
-     * @return mixed
-     */
-    abstract function run($segments=[], $quiet=false);
+	/**
+	 * The method called by the main generator script. This must be
+	 * overridden by child classes to implement the actual logic used.
+	 *
+	 * @param array $segments
+	 * @param bool  $quiet      If true, models should accept default values.
+	 * @return mixed
+	 */
+	abstract function run($segments=[], $quiet=false);
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
 
-    /**
-     * Creates a file at the specified path with the given contents.
-     *
-     * @param $path
-     * @param null $contents
-     *
-     * @return bool
-     */
-    public function createFile($path, $contents=null, $overwrite=false, $perms=0644)
-    {
-	    $path = $this->sandbox($path);
+	/**
+	 * Creates a file at the specified path with the given contents.
+	 *
+	 * @param $path
+	 * @param null $contents
+	 *
+	 * @return bool
+	 */
+	public function createFile($path, $contents=null, $overwrite=false, $perms=0644)
+	{
+		$path = $this->sandbox($path);
 
-	    $file_exists = is_file($path);
+		$file_exists = is_file($path);
 
-        // Does file already exist?
-        if ($file_exists)
-        {
-	        if (! $overwrite) {
-		        CLI::write( CLI::color("\t". strtolower(lang('exists')) .": ", 'blue') . str_replace(APPPATH, '', $path ) );
-		        return true;
-	        }
+		// Does file already exist?
+		if ($file_exists)
+		{
+			if (! $overwrite) {
+				CLI::write( CLI::color("\t". strtolower(lang('exists')) .": ", 'blue') . str_replace(APPPATH, '', $path ) );
+				return true;
+			}
 
-	        unlink($path);
-        }
+			unlink($path);
+		}
 
-	    // Do we need to create the directory?
-	    $segments = explode('/', $path);
+		// Do we need to create the directory?
+		$segments = explode('/', $path);
 		array_pop($segments);
 		$folder = implode('/', $segments);
 
-	    if (! is_dir($folder))
-	    {
-		    $this->createDirectory($folder);
-	    }
+		if (! is_dir($folder))
+		{
+			$this->createDirectory($folder);
+		}
 
-        get_instance()->load->helper('file');
+		get_instance()->load->helper('file');
 
-        if (! write_file($path, $contents))
-        {
-            throw new \RuntimeException( sprintf( lang('errors.writing_file'),  $path) );
-        }
+		if (! write_file($path, $contents))
+		{
+			throw new \RuntimeException( sprintf( lang('errors.writing_file'),  $path) );
+		}
 
-        chmod($path, $perms);
+		chmod($path, $perms);
 
-	    if ($overwrite && $file_exists)
-	    {
-		    CLI::write( CLI::color("\t". strtolower( lang('overwrote') ) ." ", 'light_red') . str_replace(APPPATH, '', $path ) );
-	    }
-	    else
-	    {
-		    CLI::write( CLI::color("\t". strtolower( lang('created') ) ." ", 'yellow') . str_replace(APPPATH, '', $path ) );
-	    }
+		if ($overwrite && $file_exists)
+		{
+			CLI::write( CLI::color("\t". strtolower( lang('overwrote') ) ." ", 'light_red') . str_replace(APPPATH, '', $path ) );
+		}
+		else
+		{
+			CLI::write( CLI::color("\t". strtolower( lang('created') ) ." ", 'yellow') . str_replace(APPPATH, '', $path ) );
+		}
 
-        return $this;
-    }
+		return $this;
+	}
     
-    //--------------------------------------------------------------------
-
-    /**
-     * Creates a new directory at the specified path.
-     *
-     * @param $path
-     * @param int|string $perms
-     *
-     * @return bool
-     */
-    public function createDirectory($path, $perms=0755)
-    {
-	    $path = $this->sandbox($path);
-
-        if (is_dir($path))
-        {
-            return $this;
-        }
-
-        if (! mkdir($path, $perms, true) )
-        {
-            throw new \RuntimeException( sprintf( lang('errors.creating_dir'), $path) );
-        }
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Copies a file from the current template group to the destination.
-     *
-     * @param $source
-     * @param $destination
-     * @param bool $overwrite
-     *
-     * @return bool
-     */
-    public function copyFile($source, $destination, $overwrite=false)
-    {
-	    $source = $this->sandbox($source);
-
-	    if (! file_exists($source))
-	    {
-		    return null;
-	    }
-
-	    $content = file_get_contents($source);
-
-	    return $this->createFile($destination, $content, $overwrite);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Attempts to locate a template within the current template group,
-     * parses it with the passed in data, and writes to the new location.
-     *
-     * @param $template
-     * @param $destination
-     * @param array $data
-     * @param bool $overwrite
-     *
-     * @return $this
-     */
-    public function copyTemplate($template, $destination, $data=[], $overwrite=false)
-    {
-	    if (! is_array($data))
-	    {
-		    $data = array($data);
-	    }
-
-        $content = $this->render($template, $data);
-
-        return $this->createFile($destination, $content, $overwrite);
-    }
-
-    //--------------------------------------------------------------------
-
-
-    /**
-     * Injects a block of code into an existing file. Using options
-     * you can specify where the code should be inserted. Available options
-     * are:
-     *      prepend         - Place at beginning of file
-     *      append          - Place at end of file
-     *      before  => ''   - Insert just prior to this line of text (don't forget the line ending "\n")
-     *      after   => ''   - Insert just after this line of text (don't forget the line ending "\n")
-     *      replace => ''   - a simple string to be replaced. All locations will be replaced.
-     *      regex   => ''   - a pregex pattern to use to replace all locations.
-     *
-     * @param $path
-     * @param $content
-     * @param array $options
-     *
-     * @return $this
-     */
-    public function injectIntoFile($path, $content, $options='append')
-    {
-        $kit = new FileKit();
-
-        if (is_string($options))
-        {
-            $action = $options;
-        }
-        else if (is_array($options) && count($options))
-        {
-            $keys = array_keys($options);
-            $action = array_shift( $keys );
-            $param = $options[$action];
-        }
-
-        switch ( strtolower($action) )
-        {
-            case 'prepend':
-                $success = $kit->prepend($path, $content);
-                break;
-            case 'before':
-                $success = $kit->before($path, $param, $content);
-                break;
-            case 'after':
-                $success = $kit->after($path, $param, $content);
-                break;
-            case 'replace':
-                $success = $kit->replaceIn($path, $param, $content);
-                break;
-            case 'regex':
-                $success = $kit->replaceWithRegex($path, $param, $content);
-                break;
-            case 'append':
-            default:
-                $success = $kit->append($path, $content);
-                break;
-        }
-
-        if ($success)
-        {
-            CLI::write( CLI::color("\t". strtolower( lang('modified') ) ." ", 'cyan') . str_replace(APPPATH, '', $path ) );
-        }
-        else
-        {
-            CLI::write( CLI::color("\t". strtolower( lang('error') ) ." ", 'light_red') . str_replace(APPPATH, '', $path ) );
-        }
-
-        return $this;
-    }
+	//--------------------------------------------------------------------
+
+	/**
+	 * Creates a new directory at the specified path.
+	 *
+	 * @param $path
+	 * @param int|string $perms
+	 *
+	 * @return bool
+	 */
+	public function createDirectory($path, $perms=0755)
+	{
+		$path = $this->sandbox($path);
+
+		if (is_dir($path))
+		{
+			return $this;
+		}
+
+		if (! mkdir($path, $perms, true) )
+		{
+			throw new \RuntimeException( sprintf( lang('errors.creating_dir'), $path) );
+		}
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Copies a file from the current template group to the destination.
+	 *
+	 * @param $source
+	 * @param $destination
+	 * @param bool $overwrite
+	 *
+	 * @return bool
+	 */
+	public function copyFile($source, $destination, $overwrite=false)
+	{
+		$source = $this->sandbox($source);
+
+		if (! file_exists($source))
+		{
+			return null;
+		}
+
+		$content = file_get_contents($source);
+
+		return $this->createFile($destination, $content, $overwrite);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Attempts to locate a template within the current template group,
+	 * parses it with the passed in data, and writes to the new location.
+	 *
+	 * @param $template
+	 * @param $destination
+	 * @param array $data
+	 * @param bool $overwrite
+	 *
+	 * @return $this
+	 */
+	public function copyTemplate($template, $destination, $data=[], $overwrite=false)
+	{
+		if (! is_array($data))
+		{
+			$data = array($data);
+		}
+
+		$content = $this->render($template, $data);
+
+		return $this->createFile($destination, $content, $overwrite);
+	}
+
+	//--------------------------------------------------------------------
+
+
+	/**
+	 * Injects a block of code into an existing file. Using options
+	 * you can specify where the code should be inserted. Available options
+	 * are:
+	 *      prepend         - Place at beginning of file
+	 *      append          - Place at end of file
+	 *      before  => ''   - Insert just prior to this line of text (don't forget the line ending "\n")
+	 *      after   => ''   - Insert just after this line of text (don't forget the line ending "\n")
+	 *      replace => ''   - a simple string to be replaced. All locations will be replaced.
+	 *      regex   => ''   - a pregex pattern to use to replace all locations.
+	 *
+	 * @param $path
+	 * @param $content
+	 * @param array $options
+	 *
+	 * @return $this
+	 */
+	public function injectIntoFile($path, $content, $options='append')
+	{
+		$kit = new FileKit();
+
+		if (is_string($options))
+		{
+			$action = $options;
+		}
+		else if (is_array($options) && count($options))
+		{
+			$keys = array_keys($options);
+			$action = array_shift( $keys );
+			$param = $options[$action];
+		}
+
+		switch ( strtolower($action) )
+		{
+			case 'prepend':
+				$success = $kit->prepend($path, $content);
+				break;
+			case 'before':
+				$success = $kit->before($path, $param, $content);
+				break;
+			case 'after':
+				$success = $kit->after($path, $param, $content);
+				break;
+			case 'replace':
+				$success = $kit->replaceIn($path, $param, $content);
+				break;
+			case 'regex':
+				$success = $kit->replaceWithRegex($path, $param, $content);
+				break;
+			case 'append':
+			default:
+				$success = $kit->append($path, $content);
+				break;
+		}
+
+		if ($success)
+		{
+			CLI::write( CLI::color("\t". strtolower( lang('modified') ) ." ", 'cyan') . str_replace(APPPATH, '', $path ) );
+		}
+		else
+		{
+			CLI::write( CLI::color("\t". strtolower( lang('error') ) ." ", 'light_red') . str_replace(APPPATH, '', $path ) );
+		}
+
+		return $this;
+	}
     
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
 	/**
 	 * Runs another generator. The first parameter is the name of the
@@ -320,130 +320,130 @@ 
 	 * @param $command
 	 * @param null $options
 	 */
-    public function generate($command, $options = '', $quiet=false)
-    {
+	public function generate($command, $options = '', $quiet=false)
+	{
 		$orig_options = CLI::optionString();
-	    $options = $orig_options .' '. $options;
-
-	    if ($quiet === true)
-	    {
-		    $options .= ' -quiet';
-	    }
-
-	    if ($this->overwrite === true)
-	    {
-		    $options .= ' -overwrite';
-	    }
-
-	    passthru( "php sprint forge {$command} {$options}" );
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Adds a new route to the application's route file.
-     *
-     * @param $left
-     * @param $right
-     *
-     * @return \Myth\Forge\BaseGenerator
-     */
-    public function route($left, $right, $options=[], $method='any')
-    {
-        $option_str = '[';
-
-        foreach ($options as $key => $value)
-        {
-            $option_str .= "";
-        }
-
-        $option_str .= ']';
-
-        $content = "\$routes->{$method}('{$left}', '{$right}', {$option_str});\n";
-
-        return $this->injectIntoFile(APPPATH .'config/routes.php', $content, ['after' => "// Auto-generated routes go here\n"]);
-    }
+		$options = $orig_options .' '. $options;
+
+		if ($quiet === true)
+		{
+			$options .= ' -quiet';
+		}
+
+		if ($this->overwrite === true)
+		{
+			$options .= ' -overwrite';
+		}
+
+		passthru( "php sprint forge {$command} {$options}" );
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Adds a new route to the application's route file.
+	 *
+	 * @param $left
+	 * @param $right
+	 *
+	 * @return \Myth\Forge\BaseGenerator
+	 */
+	public function route($left, $right, $options=[], $method='any')
+	{
+		$option_str = '[';
+
+		foreach ($options as $key => $value)
+		{
+			$option_str .= "";
+		}
+
+		$option_str .= ']';
+
+		$content = "\$routes->{$method}('{$left}', '{$right}', {$option_str});\n";
+
+		return $this->injectIntoFile(APPPATH .'config/routes.php', $content, ['after' => "// Auto-generated routes go here\n"]);
+	}
     
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    /**
-     * Outputs the contents of the file in the template's source path.
-     */
-    public function readme($file='readme.txt')
-    {
-	    $name = str_replace('Generator', '', get_class($this));
+	/**
+	 * Outputs the contents of the file in the template's source path.
+	 */
+	public function readme($file='readme.txt')
+	{
+		$name = str_replace('Generator', '', get_class($this));
 
-	    $path = $this->locateGenerator($name);
+		$path = $this->locateGenerator($name);
 
-        if (! file_exists($path . $file))
-        {
-            CLI::error(sprintf( lang('forge.cant_find_readme'), $file) );
-        }
+		if (! file_exists($path . $file))
+		{
+			CLI::error(sprintf( lang('forge.cant_find_readme'), $file) );
+		}
 
-	    $contents = file_get_contents($path . $file);
+		$contents = file_get_contents($path . $file);
 
-        CLI::new_line(2);
-        CLI::write( CLI::wrap($contents), 'green' );
-        CLI::new_line();
-    }
+		CLI::new_line(2);
+		CLI::write( CLI::wrap($contents), 'green' );
+		CLI::new_line();
+	}
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    /**
-     * Renders a single generator template. The file must be in a folder
-     * under the template group named the same as $this->generator_name.
-     * The file must have a '.tpl.php' file extension.
-     *
-     * @param $template_name
-     * @param array $data
-     *
-     * @return string The rendered template
-     */
-    public function render($template_name, $data=[], $folder=null)
-    {
-        if (empty($this->themer))
-        {
-            $this->setupThemer();
-        }
+	/**
+	 * Renders a single generator template. The file must be in a folder
+	 * under the template group named the same as $this->generator_name.
+	 * The file must have a '.tpl.php' file extension.
+	 *
+	 * @param $template_name
+	 * @param array $data
+	 *
+	 * @return string The rendered template
+	 */
+	public function render($template_name, $data=[], $folder=null)
+	{
+		if (empty($this->themer))
+		{
+			$this->setupThemer();
+		}
 
-	    $data['uikit'] = $this->loadUIKit();
+		$data['uikit'] = $this->loadUIKit();
 
-        $output = null;
+		$output = null;
 
-	    $view = $template_name .'.tpl';
+		$view = $template_name .'.tpl';
 
-        $groups = config_item('forge.collections');
+		$groups = config_item('forge.collections');
 
-	    $name = str_replace('Generator', '', get_class($this) );
+		$name = str_replace('Generator', '', get_class($this) );
 
-        foreach ($groups as $group => $path)
-        {
-	        $path = rtrim($path, '/ ') .'/';
-	        $folders = scandir($path);
+		foreach ($groups as $group => $path)
+		{
+			$path = rtrim($path, '/ ') .'/';
+			$folders = scandir($path);
 
-	        if (! $i = array_search(ucfirst($name), $folders))
-	        {
-		        continue;
-	        }
+			if (! $i = array_search(ucfirst($name), $folders))
+			{
+				continue;
+			}
 
-	        $view = $folders[$i] . '/'. $view;
+			$view = $folders[$i] . '/'. $view;
 
-            if (realpath($path . $view .'.php'))
-            {
-                $output = $this->themer->display($group .':'. $view, $data);
-                break;
-            }
-        }
+			if (realpath($path . $view .'.php'))
+			{
+				$output = $this->themer->display($group .':'. $view, $data);
+				break;
+			}
+		}
 
-	    // To allow for including any PHP code in the templates,
-	    // replace any '@php' and '@=' tags with their correct PHP syntax.
-	    $output = str_replace('@php', '<?php', $output);
-	    $output = str_replace('@=', '<?=', $output);
+		// To allow for including any PHP code in the templates,
+		// replace any '@php' and '@=' tags with their correct PHP syntax.
+		$output = str_replace('@php', '<?php', $output);
+		$output = str_replace('@=', '<?=', $output);
 
-        return $output;
-    }
+		return $output;
+	}
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
 	/**
 	 * Forces a path to exist within the current application's folder.
@@ -458,7 +458,7 @@ 
 	 */
 	public function sandbox($path)
 	{
-        $path = $this->normalizePath($path);
+		$path = $this->normalizePath($path);
 
 		// If it's writing to BASEPATH - FIX IT
 		if (strpos($path, $this->normalizePath(BASEPATH) ) === 0)
@@ -478,37 +478,37 @@ 
 			return $path;
 		}
 
-	    return APPPATH . $path;
+		return APPPATH . $path;
 	}
 
 	//--------------------------------------------------------------------
 
 
 
-    //--------------------------------------------------------------------
-    // Private Methods
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
+	// Private Methods
+	//--------------------------------------------------------------------
 
-    protected function setupThemer()
-    {
-        $themer_name = config_item('forge.themer');
+	protected function setupThemer()
+	{
+		$themer_name = config_item('forge.themer');
 
-        if (! $themer_name)
-        {
-            throw new \RuntimeException( lang('forge.no_themer') );
-        }
+		if (! $themer_name)
+		{
+			throw new \RuntimeException( lang('forge.no_themer') );
+		}
 
-        $this->themer = new $themer_name( get_instance() );
+		$this->themer = new $themer_name( get_instance() );
 
-        // Register our paths with the themer
-        $paths = config_item('forge.collections');
+		// Register our paths with the themer
+		$paths = config_item('forge.collections');
 
-        foreach ($paths as $key => $path) {
-            $this->themer->addThemePath($key, $path);
-        }
-    }
+		foreach ($paths as $key => $path) {
+			$this->themer->addThemePath($key, $path);
+		}
+	}
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
 	public function loadUIKit()
 	{
@@ -521,7 +521,7 @@ 
 
 		$uikit = new $kit_name();
 
-	    return $uikit;
+		return $uikit;
 	}
 
 	//--------------------------------------------------------------------
@@ -639,66 +639,66 @@ 
 
 	//--------------------------------------------------------------------
 
-    /**
-     * Normalizes a path and cleans it up for healthy use within
-     * realpath() and helps to mitigate changes between Windows and *nix
-     * operating systems.
-     *
-     * Found at http://php.net/manual/en/function.realpath.php#112367
-     *
-     * @param $path
-     *
-     * @return string
-     */
-    protected function normalizePath($path)
-    {
-        // Array to build a new path from the good parts
-        $parts = array();
-
-        // Replace backslashes with forward slashes
-        $path = str_replace('\\', '/', $path);
-
-        // Combine multiple slashes into a single slash
-        $path = preg_replace('/\/+/', '/', $path);
-
-        // Collect path segments
-        $segments = explode('/', $path);
-
-        // Initialize testing variable
-        $test = '';
-
-        foreach($segments as $segment)
-        {
-            if($segment != '.')
-            {
-                $test = array_pop($parts);
-
-                if(is_null($test))
-                {
-                    $parts[] = $segment;
-                }
-                else if ($segment == '..')
-                {
-                    if ($test == '..')
-                    {
-                        $parts[] = $test;
-                    }
-
-                    if ($test == '..' || $test == '')
-                    {
-                        $parts[] = $segment;
-                    }
-                }
-                else
-                {
-                    $parts[] = $test;
-                    $parts[] = $segment;
-                }
-            }
-        }
-        return implode('/', $parts);
-    }
-
-    //--------------------------------------------------------------------
+	/**
+	 * Normalizes a path and cleans it up for healthy use within
+	 * realpath() and helps to mitigate changes between Windows and *nix
+	 * operating systems.
+	 *
+	 * Found at http://php.net/manual/en/function.realpath.php#112367
+	 *
+	 * @param $path
+	 *
+	 * @return string
+	 */
+	protected function normalizePath($path)
+	{
+		// Array to build a new path from the good parts
+		$parts = array();
+
+		// Replace backslashes with forward slashes
+		$path = str_replace('\\', '/', $path);
+
+		// Combine multiple slashes into a single slash
+		$path = preg_replace('/\/+/', '/', $path);
+
+		// Collect path segments
+		$segments = explode('/', $path);
+
+		// Initialize testing variable
+		$test = '';
+
+		foreach($segments as $segment)
+		{
+			if($segment != '.')
+			{
+				$test = array_pop($parts);
+
+				if(is_null($test))
+				{
+					$parts[] = $segment;
+				}
+				else if ($segment == '..')
+				{
+					if ($test == '..')
+					{
+						$parts[] = $test;
+					}
+
+					if ($test == '..' || $test == '')
+					{
+						$parts[] = $segment;
+					}
+				}
+				else
+				{
+					$parts[] = $test;
+					$parts[] = $segment;
+				}
+			}
+		}
+		return implode('/', $parts);
+	}
+
+	//--------------------------------------------------------------------
 
 }