Skip to content

improving readme.md #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lorenzo merged 1 commit into from
Jul 31, 2011
Merged

improving readme.md #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,33 @@ or

You will also need the [CakeDC Search plugin](http://github.com/CakeDC/search), just grab it and put it into your application's plugin folder.

## How to use it ##
Activate some necessary core components:

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

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

$this->Auth->authorize = 'controller';
$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 = true;
$this->Auth->userModel = 'User';
$this->Auth->userScope = array('User.active' => 1);
$this->Auth->allowedActions = array('index');

## 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
* User registration (http://localhost/users/users/register)
* Account verification by a token sent via email
* User login (email / password)
* 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
Expand Down Expand Up @@ -60,7 +78,7 @@ You can overwrite the render() method to fall back to the plugin views in the ca

### Extending the model ###

Declare the model
Declare the model

App::import('Model', 'Users.User');
AppUser extends User {
Expand Down