finbarrmccarthy/forgotpassword

Adding Forgot Password functionalitiy to ZfcUser (Custom)

ForgotPassword

Version 0.1.3 Created by Finbarr, _(*1)

Introduction

A Zend Framework 2 (ZF2) Module offering forgot password via e-mail functionality to ZfcUser, _(*2)

Information

Requirements

• Zend Framework 2 (latest master).
• ZfcBase (latest master).
• ZfcUser (latest master).
• MailService (latest master).

Features / Goals

• Add pluggable behaviour to request a password reset [COMPLETE]
• Provide updated login view [COMPLETE]

Installation

Main Setup

With composer

1. Add this project and the requirements in your composer.json:, _(*3)

   "require": {
       "finbarrmccarthy/forgotpassword": "0.*"
   }
   

2. Now tell composer to download ZfcUser by running the command:, _(*4)

   $ php composer.phar update
   

Post installation

1. Enabling it in your application.config.phpfile., _(*5)

   <?php
   return array(
       'modules' => array(
           // ...
           'ZfcBase',
           'ZfcUser',
           'MailService',
           'ForgotPassword'
       ),
       // ...
   );
   

2. Then Import the SQL schema located in ./vendor/finbarrmccarthy/forgotpassword/data/schema.sql., _(*6)

3. Make sure that the MailService is configured correctly., _(*7)

Post-Install: Zend\Db

1. If you do not already have a valid Zend\Db\Adapter\Adapter in your service manager configuration, put the following in ./config/autoload/database.local.php:, _(*8)

   <?php
   
   $dbParams = array(
       'database'  => 'changeme',
       'username'  => 'changeme',
       'password'  => 'changeme',
       'hostname'  => 'changeme',
   );
   
   return array(
       'service_manager' => array(
           'factories' => array(
               'Zend\Db\Adapter\Adapter' => function ($sm) use ($dbParams) {
                   return new Zend\Db\Adapter\Adapter(array(
                       'driver'    => 'pdo',
                       'dsn'       => 'mysql:dbname='.$dbParams['database'].';host='.$dbParams['hostname'],
                       'database'  => $dbParams['database'],
                       'username'  => $dbParams['username'],
                       'password'  => $dbParams['password'],
                       'hostname'  => $dbParams['hostname'],
                   ));
               },
           ),
       ),
   );

Post-Install: Doctrine2 ORM

There is an additional module for Doctrine integration ForgotPasswordORM, _(*9)

Usage

Navigate to http://yourproject/user and you should land on a login page., _(*10)

Options

The ForgotPassword module has some options to allow you to quickly customize the basic functionality. After installing, copy ./vendor/finbarrmccarthy/forgotpassword/config/forgotpassword.global.php.dist to ./config/autoload/forgotpassword.global.php and change the values as desired., _(*11)

The following options are available:, _(*12)

• password_entity_class - Name of Entity class to use. Useful for using your own entity class instead of the default one provided. Default is RememberMe\Entity\RememberMe.
• reset_expire - Integer value in seconds when the login cookie should expire. Default is 86400 (24 hours).
• email_transport - String value which transport class to use. Default is Zend\Mail\Transport\Sendmail.
• reset_email_subject_line - String value which transport class to use. Default is You requested to reset your password.
• email_from_address - Array Default is array( 'email' => 'your_email_address@here.com', 'name' => 'Your name', ).

Acknowledgements

Daniel Strøm (https://github.com/Danielss89) for most of the basic work in the cookie adapter etc., _(*13)