Zend Authによるログイン処理作成のチュートリアル

intro

Zend_Authを利用したログイン画面を作成します。ソースコードはこちらからダウンロードできます。

1.bootstrap.phpとconfig.iniの作成

以下のようにapplication/bootstrap.phpファイルを作成します。
APP_BASEとCONFIG_PATHを環境に合わせて変更してください。

<?php
set_include_path('../library' . PATH_SEPARATOR . get_include_path());
define('APP_BASE', '../application');
define('CONFIG_PATH', APP_BASE . '/config.ini');

require_once 'Zend/Controller/Front.php';
require_once 'Zend/Layout.php';

$layout = Zend_Layout::startMvc();
//$layout->getView()->baseUrl = '/yourBaseUrl';
Zend_Controller_Front::run(APP_BASE . '/controllers');

<?php

set_include_path('../library' . PATH_SEPARATOR . get_include_path());

define('APP_BASE', '../application');

define('CONFIG_PATH', APP_BASE . '/config.ini');

require_once 'Zend/Controller/Front.php';

require_once 'Zend/Layout.php';

$layout = Zend_Layout::startMvc();

//$layout->getView()->baseUrl = '/yourBaseUrl';

Zend_Controller_Front::run(APP_BASE . '/controllers');

以下のようにapplication/config.iniファイルを作成します。
環境に合わせてdatabase.params以下を変更してください。

[staging]
database.adapter         = pdo_mysql
database.params.host     = localhost
database.params.username = db_user
database.params.password = db_password
database.params.dbname   = db_name
auth.tableName           = users
auth.identityColumn      = username
auth.credentialColumn    = password

[staging]

database.adapter = pdo_mysql

database.params.host = localhost

database.params.username = db_user

database.params.password = db_password

database.params.dbname = db_name

auth.tableName = users

auth.identityColumn = username

auth.credentialColumn = password

この記事では以下のSQLを使用しました(MySQL)。
異なるテーブルを使用する場合、iniファイルのauth以下を変更してください。

CREATE TABLE users
(
    id integer auto_increment NOT NULL PRIMARY KEY,
    username varchar(20) NOT NULL,
    password varchar(20) NOT NULL
);

INSERT INTO users (username, password)
    values ('testuser', 'testpassword');

CREATE TABLE users

(

id integer auto_increment NOT NULL PRIMARY KEY,

username varchar(20) NOT NULL,

password varchar(20) NOT NULL

);

INSERT INTO users (username, password)

values ('testuser', 'testpassword');

2.コントローラの作成

以下のようにapplication/constorllers/IndexController.phpファイルを作成します。

<?php
require_once 'Zend/Controller/Action.php';
require_once 'Zend/Db.php';
require_once 'Zend/Auth.php';
require_once 'Zend/Auth/Adapter/DbTable.php';
require_once 'Zend/Form.php';
require_once 'Zend/Config/Ini.php';

class IndexController extends Zend_Controller_Action
{
    protected $_auth = null;

    protected function getAuthAdapter()
    {
        $config = new Zend_Config_Ini(CONFIG_PATH, 'staging');
        $params = $config->database->params->toArray();
        $dbAdapter = Zend_Db::factory($config->database->adapter, $params);
        $authAdapter =  new Zend_Auth_Adapter_DbTable($dbAdapter);
        $authAdapter->setTableName($config->auth->tableName)
                    ->setIdentityColumn($config->auth->identityColumn)
                    ->setCredentialColumn($config->auth->credentialColumn);
        return $authAdapter;
    }

    public function getLoginForm()
    {
        $form = new Zend_Form(array(
            'method'   => 'post',
            'action'   => $this->_request->getBaseUrl() . '/index/login',
            'elements' => array(
                'username' => array('text', array(
                    'required' => true,
                    'label' => 'User Name',
                    'filters' => array(
                        'StringTrim',
                        'StringToLower'
                    ),
                    'validators' => array(
                        'alnum',
                        array('stringLength', true, array(6, 20)),
                        array('regex', false, array('/^[a-z][a-z0-9]*$/'))
                    ),
                )),
                'password' => array('password', array(
                    'required' => true,
                    'label' => 'Password',
                    'validators' => array(
                        array('stringLength', true, array(6, 20))
                    ),
                )),
                'submit' => array('submit', array(
                    'label' => 'Send'
                ))
            ),
        ));

        return $form;
    }

    public function init()
    {
        $this->_auth = Zend_Auth::getInstance();
    }

    public function indexAction()
    {
        $this->_forward('login');
    }

    public function loginAction()
    {
        $form = $this->getLoginForm();
        if ($this->getRequest()->isPost()) {
            if ($form->isValid($_POST)) {
                $values = $form->getValues();
                // authenticate username and password
                $adapter = $this->getAuthAdapter();
                $adapter->setIdentity($values['username'])
                        ->setCredential($values['password']);
                $result = $this->_auth->authenticate($adapter);
                if ($result->isValid())
                {
                    return $this->_helper->redirector('index', 'profile');
                }
                else
                {
                    $this->view->message = 'Authentication Error';
                }
            }
        }

        $this->view->form = $form;
    }

    public function logoutAction()
    {
        $this->_auth->clearIdentity();
        $this->_forward('login');
    }
}

100

<?php

require_once 'Zend/Controller/Action.php';

require_once 'Zend/Db.php';

require_once 'Zend/Auth.php';

require_once 'Zend/Auth/Adapter/DbTable.php';

require_once 'Zend/Form.php';

require_once 'Zend/Config/Ini.php';

class IndexController extends Zend_Controller_Action

{

protected $_auth = null;

protected function getAuthAdapter()

{

$config = new Zend_Config_Ini(CONFIG_PATH, 'staging');

$params = $config->database->params->toArray();

$dbAdapter = Zend_Db::factory($config->database->adapter, $params);

$authAdapter = new Zend_Auth_Adapter_DbTable($dbAdapter);

$authAdapter->setTableName($config->auth->tableName)

->setIdentityColumn($config->auth->identityColumn)

->setCredentialColumn($config->auth->credentialColumn);

return $authAdapter;

}

public function getLoginForm()

{

$form = new Zend_Form(array(

'method' => 'post',

'action' => $this->_request->getBaseUrl() . '/index/login',

'elements' => array(

'username' => array('text', array(

'required' => true,

'label' => 'User Name',

'filters' => array(

'StringTrim',

'StringToLower'

'validators' => array(

'alnum',

array('stringLength', true, array(6, 20)),

array('regex', false, array('/^[a-z][a-z0-9]*$/'))

)),

'password' => array('password', array(

'required' => true,

'label' => 'Password',

'validators' => array(

array('stringLength', true, array(6, 20))

)),

'submit' => array('submit', array(

'label' => 'Send'

))

));

return $form;

}

public function init()

{

$this->_auth = Zend_Auth::getInstance();

}

public function indexAction()

{

$this->_forward('login');

}

public function loginAction()

{

$form = $this->getLoginForm();

if ($this->getRequest()->isPost()) {

if ($form->isValid($_POST)) {

$values = $form->getValues();

// authenticate username and password

$adapter = $this->getAuthAdapter();

$adapter->setIdentity($values['username'])

->setCredential($values['password']);

$result = $this->_auth->authenticate($adapter);

if ($result->isValid())

{

return $this->_helper->redirector('index', 'profile');

}

else

{

$this->view->message = 'Authentication Error';

}

$this->view->form = $form;

}

public function logoutAction()

{

$this->_auth->clearIdentity();

$this->_forward('login');

}

以下のようにapplication/constorllers/ProfileController.phpファイルを作成します。
Zend_Authでは認証に成功するとidentityがストレージ(デフォルトではセッション)に保存されます。

<?php
require_once 'Zend/Controller/Action.php';
require_once 'Zend/Auth.php';

class ProfileController extends Zend_Controller_Action
{
    protected $_auth = null;

    public function init()
    {
        $this->_auth = Zend_Auth::getInstance();
    }

    public function preDispatch()
    {
        if (!$this->_auth->hasIdentity())
        {
            $this->_forward('login', 'index');
        }
    }

    public function indexAction()
    {
        $this->view->identity = $this->_auth->getIdentity();
    }
}

<?php

require_once 'Zend/Controller/Action.php';

require_once 'Zend/Auth.php';

class ProfileController extends Zend_Controller_Action

{

protected $_auth = null;

public function init()

{

$this->_auth = Zend_Auth::getInstance();

}

public function preDispatch()

{

if (!$this->_auth->hasIdentity())

{

$this->_forward('login', 'index');

}

public function indexAction()

{

$this->view->identity = $this->_auth->getIdentity();

}

3.ビューの作成

以下のようにapplication/views/scripts/index/login.phtmlファイルを作成します。

<span style="color: red;"><?= $this->message ?></span>
<?= $this->form; ?>

1 2	<span style="color: red;"><?= $this->message ?></span> <?= $this->form; ?>

以下のようにapplication/views/scripts/profile/index.phtmlファイルを作成します。

<p>Hello <?= $this->identity ?></p>

1	<p>Hello <?= $this->identity ?></p>

4.確認

Webサーバにアクセスしてログイン処理が行われていることを確認してみてください。
(上記SQLを実行した場合、testuser/testpasswordでログインできます)

履歴

日付	内容
2008/4/9	公開
2008/4/18	ログイン後の処理をフォワードではなくリダイレクトにしました

Zend_Authによるログイン処理

コメントを残す