k1low/reminder

Password Reminder plugin for CakePHP

0.0.4 2015-01-16 07:34 UTC

Requires

• composer/installers: *
• k1low/yav: 2.*

Requires (Dev)

• phpunit/phpunit: 3.7.*

MIT

• Ken'ichiro Oyama

• cakephp
• reset password

README

Usage

Create reminders table

$ cake schema create reminders --plugin Reminder

Load Reminder plugin

<?php
  CakePlugin::load([
    'Reminder' => ['bootstrap' => true, 'routes' => true],
  ]);

Set $reminder to app/Config/email.php

<?php
  public $reminder = [
    'transport' => 'Smtp',
    'subject' => 'Password reminder',
    'from' => ['[e-mail]' => 'Reminder'],
    'host' => 'smtp.example.com',
    'username' => '[e-mail]',
    'password' => 'xxxxxxxxx',
    'log' => true,
    'charset' => 'utf-8',
    'headerCharset' => 'utf-8',
  ];

Set Reminder.models

<?php
  Configure::write('Reminder.models', [
    'User' => [
      'email' => 'email', // email field name
      'expire' => 60 * 60 * 24, // reminder url expire range (seconds)
      'subject' => 'This is Reminder mail', // reminder mail subject
    ],
  ]);

Create User::findAccountById(), User::validateAndFindAccount(), User::resetPassword()

<?php
  /**
   * findAccountById
   * find account by primary key
   * for Reminder plugin
   *
   */
  public function findAccountById($id){
    $query = array(
      'conditions' => array(
        'User.id' => $id
      ),
    );
    $user = $this->find('first', $query);
    return $user;
  }

<?php
  /**
   * validateAndFindAccount
   * check $data and find account
   * for Reminder plugin
   *
   */
  public function validateAndFindAccount($data){
    $email = $data['User']['email'];
    if (empty($email)) {
      $this->invalidate('email', 'Not empty email');
      throw new ReminderException();
    }
    $query = array(
      'conditions' => array(
        'User.email' => $email
      ),
    );
    $user = $this->find('first', $query);
    return $user;
  }

<?php
  /**
   * resetPassword
   * reset account password
   * for Reminder plugin
   *
   */
  public function resetPassword($data){
    $this->set($data);
    if (!empty($this->data['User']['password'])) {
      $this->data['User']['password'] = Security::hash($this->data['User']['password'], null, true);
    }
    if (!empty($this->data['User']['password_confirm'])) {
      $this->data['User']['password_confirm'] = Security::hash($this->data['User']['password_confirm'], null, true);
    }
    $result = $this->save(null, true);
    if ($result) {
      $this->data = $result;
      return true;
    } else {
      return false;
    }
  }

Access /reminder/user

Access /reminder/user

Design change

Default layout

<?php
  // default layout setting
  Configure::write('Reminder.layout', 'mylayout');

View change

Create following view/template files.

• app/View/Plugin/Reminder/Reminder/send.ctp
• app/View/Plugin/Reminder/Reminder/sent.ctp
• app/View/Plugin/Reminder/Reminder/reset_password.ctp
• app/View/Plugin/Reminder/Reminder/complete.ctp
• app/View/Plugin/Reminder/Emails/text/reset_mail.ctp

Custom settings

Create view/template/layout files and custom settings

<?php
  Configure::write('Reminder.models', [
    'User' => [
      'email' => 'email',
      'expire' => 60 * 60 * 24,
      'layout' => 'User/default', // User custom layout setting
      'view' => [ // User custom view/template setting
        'send' => 'user_send',
        'sent' => 'user_sent',
        'reset_password' => 'user_reset_password',
        'complete' => 'user_complete',
        'reset_mail' => 'user_send',
      ],
    ],
    'Administrator' => [
      'email' => 'email',
      'expire' => 60 * 60,
      'layout' => 'Admin/default', // Administrator layout setting
    ],
  ]);

setFlash Messages

<?php
  // setFlash settings
  Configure::write('Reminder.setFlashElement', [
      'success' => 'alert',
      'error' => 'alert',
  ]);
  Configure::write('Reminder.setFlashParams', [
      'success' => [],
      'error' => [],
  ]);

License

The MIT License