Cookieログイン

今回は、「keep me logged in」などログイン画面でよくみかけるクッキーログインの機能を使ってみます。
CakePHPには、Cookieコンポーネントがあります。(PHPのsetcookieメソッドのラッパーにあたります。)メソッドはwriteとreadです。わかりやすい。
ログイン時に、「ログインしたまま」というチェックボックスをつけてログインしてきたユーザのクッキーをwriteして、次回そのユーザが訪問した際に、クッキーをreadして自動的にログインさせます。

Cookieコンポーネントの使用

var $components = array(
  'Cookie',
}

使用する際は、コントローラ内でコンポーネントを読み込んで下さい。

writeメソッド (クッキーをつくる)

ログイン画面にチェックボックスを用意します。今回は、keep_me_logged_inにします。以下は、Userモデルのusernameとpasswordという前提にしていますので、異なる場合は置き換えて下さい。

function login(){
  // keep_me_logged_inチェックボックスがcheckされている場合
  if (!empty($this->data) && $this->data['User']['keep_me_logged_in']) {
    $cookie = array();
    // username
    $cookie['username'] = $this->data['User']['username'];
    // password
    $cookie['password'] = $this->data['User']['password'];
    // cookie書き込み
    $this->Cookie->write('Auth.User', $cookie, true, '+2 weeks');
    unset($this->data['User']['keep_me_logged_in']);
  }
}

これで、CakeCookie['Auth']['User']という名前で保存されます。

readメソッド (クッキーをつかう)

ログイン画面にアクセスした際に、$keyをもとにクッキーのデータをリードして、その値でログインを試みます。

function login(){
  if (empty($this->data)) {
    $cookie = $this->Cookie->read('Auth.User');  // クッキーをリード
    if (!is_null($cookie)) {
      if ($this->Auth->login($cookie)) {
        // cookieの内容でログイン成功
        $this->Session->delete('Message.auth');
        $this->redirect($this->Auth->redirect());
      } else {
        // cookieの内容でログイン失敗
        $this->Cookie->delete('Auth.User');  //  クッキー削除
      }
      $this->log("-I- LOGIN with COOKIE", LOG_DEBUG);
    }
  }
}

deleteメソッド (削除する)

Cookieの中身を削除します。
Cookieの内容でログインできない場合は、deleteしてください。そうしないと堂々巡りになります。(上記)

destroyメソッド

Cookieそのものを破棄します。違いは、deleteはcookieの値を指定して削除できるのに対し、destroyはごっそり消します。

ログアウトの際は、破棄するのが普通(ですかね?)

Cookieコンポーネントの変数

現在の設定は、$this->log($this->Cookie, LOG_DEBUG)などで確認してみて下さい。

function beforeFilter() {
  $this->Cookie->name = 'baker_id';             // クッキー名‘baker_id’
  $this->Cookie->time = 3600;                   // 有効期間=>1時間
  $this->Cookie->path = '/bakers/preferences/'; // /bakers/preferences/
  $this->Cookie->domain = 'example.com';        // example.comドメイン
  $this->Cookie->secure = true;                 // HTTPSの場合のみ送信される。
  $this->Cookie->key = 'qSI232qs*&sXOw!';
}

今回は、クッキーデータの扱い方法をログインに例にとって投稿してみました。
**どうしてもCookieをCoockieと綴ってしまう。

Related

Cookieログイン ユーザ登録(仮登録・メール・本登録) recursive設定によるfind()性能改善 ログインに追加の条件を付与する「scope」 ChromeのCookieデータの場所と覗く方法 複数データベースの追加と切替 ユーザ登録(仮登録・メール・本登録) Htmlヘルパー