Updates for Kohana 3.2 plus minor changes

classes/useradmin/appform.php

@@ -43,7 +43,7 @@ class Useradmin_Appform {
 	 * @param string $class
 	 * @return array
 	 */
-	private static function add_class ($attributes, $class)
+	protected static function add_class ($attributes, $class)
 	{
 		if (isset($attributes['class']))
 		{
@@ -62,7 +62,7 @@ private static function add_class ($attributes, $class)
 	 * @param <type> $value
 	 * @param <type> $attributes 
 	 */
-	private function load_values ($name, &$value, &$attributes)
+	protected function load_values ($name, &$value, &$attributes)
 	{
 		if (isset($this->errors[$name]))
 		{
@@ -85,7 +85,7 @@ private function load_values ($name, &$value, &$attributes)
 	 * @param string $attrInfo  $attributes['info']
 	 * @return string
 	 */
-	private function addAlertSpan($errorName, $attributes = NULL)
+	protected function addAlertSpan($errorName, $attributes = NULL)
 	{
 		if (isset($errorName))
 		{

classes/useradmin/auth/orm.php

@@ -7,6 +7,15 @@
  * @author     Gabriel R. Giannattasio
  */
 class Useradmin_Auth_ORM extends Kohana_Auth_ORM implements Useradmin_Driver_iAuth {
+
+	/** User Model Fields
+	 * Override in your app to add fields
+	 */
+	public $user_model_fields = array(
+		'username',
+		'password',
+		'email',
+	);
 
 	/**
 	 * Extends the Kohana Auth ORM driver to give useradmin module extras
@@ -21,6 +30,8 @@ protected function _login($user, $password, $remember)
 			// Load the user
 			$user = ORM::factory('user');
 			$user->where($user->unique_key($username), '=', $username)->find();
+			if($user->loaded())
+				$user->validation_required(false);
 		}
 
 		// if there are too many recent failed logins, fail now
@@ -84,11 +95,7 @@ public function register($fields)
 		}
 		try 
 		{
-			$user->create_user($fields, array(
-				'username',
-				'password',
-				'email',
-			));
+			$user->create_user($fields, $this->user_model_fields);
 			// Add the login role to the user (add a row to the db)
 			$login_role = new Model_Role(array('name' =>'login'));
             $user->add('roles', $login_role);

classes/useradmin/controller/admin/user.php

@@ -1,121 +1,127 @@
 <?php defined('SYSPATH') or die('No direct access allowed.');
 
-/**
- * User controller: user administration, also user accounts/profiles.
- *
- * @author Mikito Takada
- * @package default
- * @version 1.0
+/**
+ * User controller: user administration, also user accounts/profiles.
+ *
+ * @author Mikito Takada
+ * @package default
+ * @version 1.0
  */
 class Useradmin_Controller_Admin_User extends Controller_App {
 
-	/**
-	 * @var string Filename of the template file.
+	/**
+	 * @var string Filename of the template file.
 	 */
 	public $template = 'template/useradmin';
 
-	/**
-	 * Controls access for the whole controller, if not set to FALSE we will only allow user roles specified.
-	 *
-	 * See Controller_App for how this implemented.
-	 *
-	 * Can be set to a string or an array, for example array('login', 'admin') or 'login'
+	/**
+	 * Controls access for the whole controller, if not set to FALSE we will only allow user roles specified.
+	 *
+	 * See Controller_App for how this implemented.
+	 *
+	 * Can be set to a string or an array, for example array('login', 'admin') or 'login'
 	 */
 	public $auth_required = 'admin';
 
-	/** Controls access for separate actions
-	 *
-	 * See Controller_App for how this implemented.
-	 *
-	 * Examples:
-	 * 'adminpanel' => 'admin' will only allow users with the role admin to access action_adminpanel
-	 * 'moderatorpanel' => array('login', 'moderator') will only allow users with the roles login and moderator to access action_moderatorpanel
+	/** Controls access for separate actions
+	 *
+	 * See Controller_App for how this implemented.
+	 *
+	 * Examples:
+	 * 'adminpanel' => 'admin' will only allow users with the role admin to access action_adminpanel
+	 * 'moderatorpanel' => array('login', 'moderator') will only allow users with the roles login and moderator to access action_moderatorpanel
 	 */
 	public $secure_actions = array();
+
+	/** User Model Fields
+	 * Override in your app to add fields
+	 */
+	public $user_model_fields = array(
+		'username', 
+		'password', 
+		'email'
+	);
 
-	// USER ADMINISTRATION
-	/**
-	 * Administator view of users.
+	// USER ADMINISTRATION
+	/**
+	 * Administator view of users.
 	 */
 	public function action_index()
 	{
-		// set the template title (see Controller_App for implementation)
+		// set the template title (see Controller_App for implementation)
 		$this->template->title = __('User administration');
-		// create a user
+		// create a user
 		$user = ORM::factory('user');
-		// This is an example of how to use Kohana pagination
-		// Get the total count for the pagination
+		// This is an example of how to use Kohana pagination
+		// Get the total count for the pagination
 		$total = $user->count_all();
-		// Create a paginator
+		// Create a paginator
 		$pagination = new Pagination(array(
 			'total_items' => $total, 
-			'items_per_page' => 30,  // set this to 30 or 15 for the real thing, now just for testing purposes...
+			'items_per_page' => 30,  // set this to 30 or 15 for the real thing, now just for testing purposes...
 			'auto_hide' => false, 
 			'view' => 'pagination/useradmin'
 		));
-		// Get the items for the query
-		$sort = isset($_GET['sort']) ? $_GET['sort'] : 'username'; // set default sorting direction here
+		// Get the items for the query
+		$sort = isset($_GET['sort']) ? $_GET['sort'] : 'username'; // set default sorting direction here
 		$dir = isset($_GET['dir']) ? 'DESC' : 'ASC';
 		$result = $user->limit($pagination->items_per_page)
 			->offset($pagination->offset)
 			->order_by($sort, $dir)
 			->find_all();
-		// render view
-		// pass the paginator, result and default sorting direction
+		// render view
+		// pass the paginator, result and default sorting direction
 		$this->template->content = View::factory('user/admin/index')
 			->set('users', $result)
 			->set('paging', $pagination)
 			->set('default_sort', $sort);
 	}
 
-	/**
-	 * Administrator edit user.
-	 * @param string $id
-	 * @return void
+	/**
+	 * Administrator edit user.
+	 * @param string $id
+	 * @return void
 	 */
-	public function action_edit($id = NULL)
+	public function action_edit()
 	{
-		// set the template title (see Controller_App for implementation)
+		$id = $this->request->param('id');
+		// set the template title (see Controller_App for implementation)
 		$this->template->title = __('Edit user');
-		// load the content from view
+		// load the content from view
 		$view = View::factory('user/admin/edit');
-		// save the data
+		// save the data
 		if (! empty($_POST))
 		{
-			//FIXME: Use Model_User in the controller insteat ORM::factory() for model generic driver compatibility
-			// sample code paths for edit and create
+			//FIXME: Use Model_User in the controller insteat ORM::factory() for model generic driver compatibility
+			// sample code paths for edit and create
 			if (is_numeric($id))
 			{
-				// EDIT: load the model with ID
+				// EDIT: load the model with ID
 				$user = ORM::factory('user', $id);
 			}
 			else
 			{
-				// CREATE: do not specify id
+				// CREATE: do not specify id
 				$user = ORM::factory('user');
 			}
 			if (empty($_POST['password']) || empty($_POST['password_confirm']))
 			{
-				// force unsetting the password! Otherwise Kohana3 will automatically hash the empty string - preventing logins
+				// force unsetting the password! Otherwise Kohana3 will automatically hash the empty string - preventing logins
 				unset($_POST['password'], $_POST['password_confirm']);
 			}
-			// you can't change your user id
+			// you can't change your user id
 			unset($_POST['id']);
 			$user->values($_POST);
-			// since we combine both editing and creating here we need a separate variable
-			// you can get rid of it if your actions don't need to do that
+			// since we combine both editing and creating here we need a separate variable
+			// you can get rid of it if your actions don't need to do that
 			$result = false;
 			$errors = null;
 			if (is_numeric($id))
 			{
-				// EDIT: check using alternative rules
+				// EDIT: check using alternative rules
 				try
 				{
-					$user->update_user($_POST, array(
-						'username', 
-						'password', 
-						'email'
-					));
+					$user->update_user($_POST, $this->user_model_fields);
 					$result = true;
 				}
 				catch (ORM_Validation_Exception $e)
@@ -126,14 +132,10 @@ public function action_edit($id = NULL)
 			}
 			else
 			{
-				// CREATE: check using default rules
+				// CREATE: check using default rules
 				try
 				{
-					$user->create_user($_POST, array(
-						'username', 
-						'password', 
-						'email'
-					));
+					$user->create_user($_POST, $this->user_model_fields);
 					$result = true;
 				}
 				catch (ORM_Validation_Exception $e)
@@ -144,45 +146,45 @@ public function action_edit($id = NULL)
 			}
 			if ($result)
 			{
-				// roles have to be added separately, and all users have to have the login role
-				// you first have to remove the items, otherwise add() will try to add duplicates
+				// roles have to be added separately, and all users have to have the login role
+				// you first have to remove the items, otherwise add() will try to add duplicates
 				if (is_numeric($id))
 				{
-					// could also use array_diff, but this is much simpler
+					// could also use array_diff, but this is much simpler
 					DB::delete('roles_users')->where('user_id', '=', $id)
 					                         ->execute();
 				}
 				foreach ($_POST['roles'] as $role)
 				{
-					// add() executes the query immediately, and saves the data (unlike the KO2 docs say)
+					// add() executes the query immediately, and saves the data (unlike the KO2 docs say)
 					$user->add('roles', 
 						ORM::factory('role')->where('name', '=', $role)
 						                    ->find()
 					);
 				}
-				// message: save success
+				// message: save success
 				Message::add('success', __('Values saved.'));
-				// redirect and exit
+				// redirect and exit
 				Request::current()->redirect('admin_user/index');
 				return;
 			}
 			else
 			{
-				// Get errors for display in view --> to AppForm
+				// Get errors for display in view --> to AppForm
 				Message::add('error', __('Error: Values could not be saved.'));
-				// Note how the first param is the path to the message file (e.g. /messages/register.php)
+				// Note how the first param is the path to the message file (e.g. /messages/register.php)
 				$view->set('errors', $errors);
-				// Pass on the old form values --> to AppForm
+				// Pass on the old form values --> to AppForm
 				$view->set('data', $user->as_array());
 			}
 		}
-		// if an ID is set, load the information
+		// if an ID is set, load the information
 		if (is_numeric($id))
 		{
-			// instantiatiate a new model
+			// instantiatiate a new model
 			$user = ORM::factory('user', $id);
 			$view->set('data', $user->as_array());
-			// retrieve roles into array
+			// retrieve roles into array
 			$roles = array();
 			foreach ($user->roles->find_all() as $role)
 			{
@@ -196,10 +198,10 @@ public function action_edit($id = NULL)
 				'login' => 'login'
 			));
 		}
-		// get all roles
+		// get all roles
 		$all_roles = array();
 		$role_model = ORM::factory('role');
-		foreach ($role_model->find_all() as $role)
+		foreach ($role_model->order_by('name')->find_all() as $role)
 		{
 			$all_roles[$role->name] = $role->description;
 		}
@@ -208,40 +210,44 @@ public function action_edit($id = NULL)
 		$this->template->content = $view;
 	}
 
-	/**
-	 * Administrator delete user
-	 * @param string $id
-	 * @return void
+	/**
+	 * Administrator delete user
+	 * @param string $id
+	 * @return void
 	 */
-	public function action_delete($id = NULL)
+	public function action_delete()
 	{
-		// set the template title (see Controller_App for implementation)
+		$id = $this->request->param('id');
+		// set the template title (see Controller_App for implementation)
 		$this->template->title = __('Delete user');
 		$user = ORM::factory('user', $id);
-		// check for confirmation
+		// check for confirmation
 		if (is_numeric($id) && isset($_POST['confirmation']) && $_POST['confirmation'] == 'Y')
 		{
 			if ($user->loaded())
 			{
-				// Delete the user
+				// Delete the user
 				$user->delete($id);
-				// Delete any associated identities
-				DB::delete('user_identity')->where('user_id', '=', $id)
+				// Delete any associated identities
+				DB::delete('user_identities')->where('user_id', '=', $id)
+				                           ->execute();
+				// Delete any associated roles
+				DB::delete('roles_users')->where('user_id', '=', $id)
 				                           ->execute();
-				// message: save success
+				// message: save success
 				Message::add('success', __('User deleted.'));
 			}
 			else
 			{
 				Message::add('success', __('User is already deleted.'));
 			}
-			// redirect and exit
+			// redirect and exit
 			Request::current()->redirect('admin_user/index');
 			return;
 		}
-		// display confirmation
+		// display confirmation
 		$this->template->content = View::factory('user/admin/delete')
 			->set('id', $id)
 			->set('data',array('username' => $user->username));
 	}
-}
+}