Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Users Plugin for CakePHP
PHP
Branch: master
Pull request Compare This branch is 500 commits behind CakeDC:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
config
controllers
locale
models
tests
views
license.txt
readme.md
users_app_controller.php
users_app_model.php

readme.md

Users Plugin for CakePHP

Version 1.1

The users plugin is for allowing users to register and login manage their profile. It also allows admins to manage the users.

The plugin is thought as a base to extend your app specific users controller and model from.

Installation

The plugin is pretty easy to set up, all you need to do is to copy it to you application plugins folder and load the needed tables. You can create database tables using either the schema shell or the CakeDC Migrations plugin:

cake schema create -plugin users -name users

or

cake migration all -plugin users

You will also need the CakeDC Search plugin, just grab it and put it into your application's plugin folder.

Activate some necessary core components:

public $components = array('RequestHandler', 'Session', 'Auth');

Add some lines to your beforeFilter and configure at your taste:

$this->Auth->fields = array('username' => 'email', 'password' => 'passwd');
$this->Auth->loginAction = array('plugin' => 'users', 'controller' => 'users', 'action' => 'login', 'admin' => false);
$this->Auth->loginRedirect = '/';
$this->Auth->logoutRedirect = '/';
$this->Auth->authError = __('Sorry, but you need to login to access this location.', true);
$this->Auth->loginError = __('Invalid e-mail / password combination.  Please try again', true);
$this->Auth->autoRedirect = false;
$this->Auth->userModel = 'Users.User';
$this->Auth->userScope = array('User.active' => 1);

What it is capable of

You can use the plugin as it comes if you're happy with it or, more common, extend your app specific user implementation from the plugin.

The plugin itself is already capable of:

  • User registration (http://localhost/users/users/register)
  • Account verification by a token sent via email
  • User login (email / password) (http://localhost/users/users/login)
  • Password reset based on requesting a token by email and entering a new password
  • Simple profiles for users
  • User search
  • User management using the "admin" section

How to extend the plugin

Extending the controller

Declare the controller class

App::import('Controller', 'Users.Users');
AppUsersController extends UsersController

In the case you want to extend also the user model it's required to set the right user class in the beforeFilter() because the controller will use the inherited model which would be Users.User.

public function beforeFilter() {
    parent::beforeFilter();
    $this->User = ClassRegistry::init('AppUser');
}

You can overwrite the render() method to fall back to the plugin views in the case you want to use some of them

public function render($action = null, $layout = null, $file = null) {
    if (is_null($action)) {
        $action = $this->action;
    }
    if (!file_exists(VIEWS . $this->viewPath . DS . $action . '.ctp')) {
        $file = App::pluginPath('users') . 'views' . DS . 'users' . DS . $action . '.ctp';
    }
    return parent::render($action, $layout, $file);
}

Extending the model

Declare the model

App::import('Model', 'Users.User');
AppUser extends User {
    public $useTable = 'users';
    public $name = 'AppUser';
}

It's important to override the AppUser::useTable property with the 'users' table.

You can override/extend all methods or properties like validation rules to suit your needs.

Requirements

Support

For support and feature request, please visit the Users Plugin Support Site.

For more information about our Professional CakePHP Services please visit the Cake Development Corporation website.

License

Copyright 2009-2010, Cake Development Corporation

Licensed under The MIT License
Redistributions of files must retain the above copyright notice.

Copyright

Copyright 2009-2010
Cake Development Corporation
1785 E. Sahara Avenue, Suite 490-423
Las Vegas, Nevada 89104
http://cakedc.com

Something went wrong with that request. Please try again.