22 users Sign-in to change your status

Add forgot password and register functionality to sfGuardPlugin. Security

• Repository
• Download package
• Browse source

Add forgot password and register functionality to sfGuard.

Developers

Name	Status	Email
Gordon Franke	lead
Massimiliano Arione	lead	moc.liamg <<ta>> oikkarag
Stephen Ostrow	developer	moc.sngisedbewos <<ta>> wortsos

License

Copyright (c) 2009-2010 Gordon Franke, Stephen Ostrow, Massimiliano Arione

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.

Releases for sf 1.4

Releases for sf 1.3

Join this plugin team

Other releases

Release 1.4 - 16/09/2011

Release 1.3 - 26/08/2010

sfGuardExtraPlugin

This plugin provides additional modules for sfGuardPlugin: ForgotPassword and Register.

Installation

• Install the plugin

  symfony plugin:install sfGuardExtraPlugin
  

• Enable one or more modules in your settings.yml (optional). For your frontend application: sfGuardForgotPassword, sfGuardRegister

  all:
    .settings:
      enabled_modules:      [sfGuardForgotPassword, sfGuardRegister](sfGuardAuth,)

• The sfGuardPlugin automatically registered a route named password if the module sfGuardAuth is enabled, so you must be sure that sfGuardExtraPlugin is enabled before sfGuardPlugin in your ProjectConfiguration.class.php, so it can register the route early:

  // in /config/ProjectConfiguration.class.php
  public function setup()
  {
    // this list is incomplete: it depends on other plugins you could have installed before
    $this->enablePlugins('sfPropelPlugin', 'sfGuardExtraPlugin', 'sfGuardPlugin');
  }

• Add an email field to sfGuardUser schema

  sf_guard_user:
    # [...]
    email:     { type: varchar(255), required: true }
    # [...]

  Alternatively, you can add email field to sfGuardUserProfile schema, and add proxy methods to sfGuardUser class:

  public function getEmail()
  {
    return $this->getProfile()->getEmail();
  }
  public function setEmail($email)
  {
    $this->getProfile()->setEmail($email);
  }

• Add method retrieveByUsernameOrEmail to get a user by email or username in lib/model/sfGuardPlugin/sfGuardUserPeer.class. The following is a working example, if you use sfGuardUserProfile:

  public static function retrieveByUsernameOrEmail($usernameOrEmail, $isActive = true)
  {
    $c = new Criteria();
    $c->addJoin(self::ID, sfGuardUserProfilePeer::USER_ID, Criteria::LEFT_JOIN);
    $c0 = $c->getNewCriterion(self::USERNAME, $usernameOrEmail);
    $c1 = $c->getNewCriterion(sfGuardUserProfilePeer::EMAIL, $usernameOrEmail);
    $c2 = $c->getNewCriterion(self::IS_ACTIVE, $isActive);
    $c0->addOr($c1);
    $c0->addAnd($c2);
    $c->add($c0);
   
      return self::doSelectOne($c);
  }

• You can select the preferred behavior of password reset: set the new password to a random string and mail it to user, or let the user choose the new password. The first behavior is default. Set reset_type to ask for the second one (see below).

• Clear your cache

  symfony cc
  

Email delivery

Emails are sent using built-in sfMailer.

You can customize the following mail parameters:

all:
  sf_guard_extra_plugin:
    mail_from:        noreply@example.org
    name_from:        noreply
    subject_confirm:  Confirm Registration
    subject_complete: Request complete
    subject_request:  Request to reset password
    subject_success:  Password reset successfully
    reset_type:       set # set to `ask` for asking (see above)

Validators

sfGuardExtraPlugin comes with a validator that you can use in your modules: sfGuardValidatorUsernameOrEmail.

This validator is used by the sfGuardForgotPassword module to check if user exists for username or email.