ZendFramework2(ZF2)でログイン処理を行う認証モデルの作成からセッションでの状態保持

会員サイトを作成する際に必須となるログイン機能をモデルの作成からソースコード付きで解説します。

今回はZendFramework2でのログイン処理をコード付きで解説したいと思います。
認証用のロジックは汎用的に使いまわせる様にモデルとして作成し、
コントローラから認証が必要な際にモデルの機能を呼ぶといった実装内容とします。

モデルの機能と致しましては、

• ログイン処理⇒認証を行い、認証結果をセッションとして保存する
• ログアウト処理⇒セッションに保存された認証情報を破棄する
• ログイン状態の確認⇒セッションの値を確認し、現在ログイン中が否かを取得
• ログインユーザ情報の取得⇒セッションに保存されているユーザ情報を取得する

といった、ログイン関係に良く使うであろうシンプルなものとなっています。

後は状況によって追加して行ければモデルとしての機能も強化されるかと思います。

1. 認証用モデルを作成しよう
2. ログイン機能の実装
3. ログアウトをサクッと実装しよう
4. 現在のログイン状態を確認しよう
5. ログインしているユーザの情報を取得しよう
6. 作成した認証用モデルを使ってみよう

認証用モデルを作成しよう

まずは認証用モデルの枠組みを作成します。
今回は『Auth』というクラスを作成します。

認証用モデル作成に当たって、必要となるクラスを下記の様に読み込みます

namespace User\Model;

// AUTHアダプタクラス
use Zend\Authentication\Adapter\DbTable as AuthAdapter;

// AUTHサービス
use Zend\Authentication\AuthenticationService;

// AUTHセッションストレージ
use Zend\Authentication\Storage\Session as SessionStorage;

// 認証クラス
class Auth
{
 // ......
}

続いて、認証クラスの初期設定です。
認証クラスのメンバとして、サービスロケータと、認証用オブジェクトを保持します。
コンストラクタではサービスロケータを受け取りメンバへ格納。
認証用オブジェクトはセッションのネームスペースを指定して認証オブジェクトを作成し、
メンバに保持します。

 // サービスロケータ
 protected $service_locator;

 // 認証オブジェクト
 protected $auth;

 /* コンストラクタ
 ----------------------------------------------------------------------------------*/
 public function __construct( $service_locator )
 {
  // MVC巡廻のアプリ情報を取得する(コントローラ）
  $this->service_locator = $service_locator;

  // 認証情報を取得する
  $this->auth = new AuthenticationService( new SessionStorage( 'session_name_space' ) );
 }

認証用オブジェクトには永続的なログイン情報を保持する為に
作成時にセッション用のオブジェクトをセットしてあげます。
この時に設定するネームスペースが後のキーとなります。

サービスロケータを保持するのは、アプリのオートローダーで読み込んだ
ＤＢ設定等を参照する為です。



ココまで準備が出来ましたら、いよいよ機能の実装です。

ログイン機能の実装

ログイン機能に必要なのが、名前やメールアドレス等のログインユーザを識別する値と、
その値と遂になるパスワードが必要です。
今回作成するログイン機能では、引数としてキーとパスワードを受け取ります。

 /* ログイン
 ----------------------------------------------------------------------------------*/
 public function login( $key, $pass )
 {
  // DBアダプタの取得
  $dbAdapter = $this->service_locator->get('Zend\Db\Adapter\Adapter');

  // 認証アダプターを作成
  $authAdapter = new AuthAdapter( $dbAdapter );

  // 認証項目内容を設定
  $authAdapter
   // 検索するテーブル名
   ->setTableName('member')

   // 認証対象カラム
   ->setIdentityColumn( 'id_culumn_name' )

   // 認証パスワードカラム
   ->setCredentialColumn( 'password_culumn_name' );

  // デリートフラグが落ちている事も認証条件に加える
  $select = $authAdapter->getDbSelect();
  $select->where("deleted = 0");

  // フォームからの入力値をセットする
  $authAdapter
   // 認証対象値
   ->setIdentity( $key )

   // 認証パスワード
   ->setCredential( $pass );

  // 認証クエリを実行し、認証結果を保存する
  $result = $this->auth->authenticate( $authAdapter );

  // 認証成功(isValid()で認証結果のチェック）
  if( $result->isValid() ){

   // 認証ストレージを取得する
   $storage = $this->auth->getStorage();

   // 結果オブジェクトをストレージに書き込む
   $storage->write( $authAdapter->getResultRowObject() );

   return( true );
  }
  // 認証失敗
  else{
   return( false );
  }

 }

処理の流れと致しましては、まず認証を行うＤＢへのアクセス用アダプタを作成します。
先ほど保持したサービスロケータを仕様すれば、アプリ全体の設定からＤＢ情報を使って作成出来るので便利です。

そのＤＢへのアダプタを認証アダプタとして登録します。

そのアダプタに、認証方法を設定していきます。

今回は、認証情報を検索するテーブル名と、
キーとなるカラム名、パスワードが格納されているカラム名を
それぞれ専用のセッタメソッドにて設定しています。


また、完全削除だけでなく、論理削除の様な形を取ったり、
他にも認証の条件を追加したい時はアダプタからセレクト条件を抽出し、
whereで条件を追加すれば認証時にも設定した条件が適用される様になります。


準備が整ったら入力されたパラメータ（今回は引数で受け取った）値をセットしましょう。

それぞれに、キーとパスワードと遂になる様にセットし、
authenticate()で認証結果を取得します。
認証結果の有効性はisValid()で判定します。

認証に成功したら、認証オブジェクト作成時に追加したセッションストレージを取得し、
認証結果として取得出来たユーザ情報をセッションに書き込んで
ログイン処理の完了です。

ログアウトをサクッと実装しよう

ログアウト処理は簡単で、保存した認証情報とセッション内の値をクリアする事で
ログアウトは実装出来ます。

 /* ログアウト
 ----------------------------------------------------------------------------------*/
 public function logout()
 {
  // ストレージと認証情報を破棄する
  $this->auth->getStorage()->clear();
  $this->auth->clearIdentity();
 }

コンストラクタでセッションオブジェクトを新規で毎回作成しますが、
セッション名をセットしているので、該当するセッションは自動的に読み込まれます。

ストレージの値を破棄するにはclear()メソッドを使用します。

認証状況を破棄するにはclearIdentity()メソッドを使用します。

これで認証情報は破棄されますので、ログアウトが完了します。

現在のログイン状態を確認しよう

今現在ログイン状態にあるのか否かを判定する為のメソッドを定義します。

 /* ログイン状態を確認(ログイン状態ならログイン情報を返却）
 ----------------------------------------------------------------------------------*/
 public function checkLogin()
 {
  // ログイン確認
  if( $this->auth->hasIdentity() ){
   return( true );
  }
  return( false );
 }

認証状況はhasIdentity()で確認する事が出来ます。
今回作成したメソッドは、単純にhasIdentity()によって認証が確認出来ればtrueを返し
認証が認められなければfalseを返却します。

ログインしているユーザの情報を取得しよう

ログインしているユーザの名前や登録日等、ログイン中のユーザの情報を知りたい機会は頻繁に訪れます。
そこで、ログインユーザ情報を取得するメソッドも定義しておきましょう。

 /* ログインユーザの情報を取得
 ----------------------------------------------------------------------------------*/
 public function getLoginUser()
 {
  // ログイン確認
  if( $this->auth->hasIdentity() ){
   // ログイン情報を取得する
   $identity = $this->auth->getIdentity();

   return( $identity );
  }
  return( false );
 }

認証されている場合、getIdentity()にて認証されているユーザ情報を取得し、
返却しています。勿論、ログインされていなければユーザ情報は取得出来ませんので、
ログインチェックを行った後に未ログインの場合はfalseを返却します。








ここまでで簡単なモデルの作成は以上です。次は作成した認証用モデルの使用方法です。

作成した認証用モデルを使ってみよう

まずは作成したモデルを読み込みます

// 認証モデルを読み込む
use User\Model\Auth as Auth;

ログイン処理では、パラメータを受け取りモデルに渡して
認証結果によって別画面へリダイレクトします。

 /* ログイン認証処理
 ----------------------------------------------------------------------------------*/
    public function authAction()
    {

  // パラメータを取得する
  $login_name = $this->params()->fromPost( 'key', "" );
  $login_pass = $this->params()->fromPost( 'pass', "" );

  $auth = new Auth( $this->getServiceLocator() );
  if( $auth->login( $key, $lpass ) ){
   // 会員画面へリダイレクト
   return( $this->redirect()->toUrl( 'member_area' ) );
  }
  else{
   // ログイン画面へリダイレクト
   return( $this->redirect()->toUrl( 'login' ) );
  }
    }

ログアウトはログアウトメソッドを呼んでログイン画面へリダイレクトさせましょう。

 /* ログアウト
 ----------------------------------------------------------------------------------*/
    public function logoutAction()
    {

  // ログアウト処理
  $auth = new Auth( $this->getServiceLocator() );
  $auth->logout();

  // ログイン画面へリダイレクト
  return( $this->redirect()->toUrl( 'login' ) );
    }

必ずログインが必要なアクション用にフィルタを掛けるためには、
認証状況を確認して、未ログイン時にはログイン画面へ強制リダイレクトさせるメソッドも用意すると便利です。

 /* ログイン権限が必要（権限無しはリダイレクト
 ----------------------------------------------------------------------------------*/
 public function mustLogin()
 {
  // 認証を確認する
  $auth = new Auth( $this->getServiceLocator() );
  if( ! $auth->checkLogin() ){
   return( $this->redirect()->toUrl( 'login' ) );
  }
 }

mustLogin()をアクションの先頭で呼ぶ事で、
アクション毎に権限の必須が設けられます。







また、ログインユーザのロールを確認する場合はモデルで作成したgetLoginUser()から
ユーザ情報を取得し、ユーザ情報の内容によって切り分ける事で対応可能です。

その場合、getLoginUserRole()等として、モデル内に作成するのが良いでしょう。


後は作成するサイトの内容による所が大きいと思いますので、
便利な機能を盛り込んで行って下さいね。




会員専用エリアを設ける様なサイトには必須となる認証処理ですので、
是非とも参考にして頂ければ幸いです。