セッションライブラリ¶

セッションの初期化¶

セッションは通常、各ページをまたいでグローバルに実行されます。 そのため、セッションクラスは次のどちらかによって初期化されるべきです、 コントローラ のコンストラクタ、 またはシステムによる オートロード によってです。 たいていの場合、セッションクラスはバックグラウンドで黙って実行されます。 そして明示的なクラスの初期化は読み込み、作成、更新が必要な時にだけ 行えばよいです。

セッションクラスの初期化をコントローラのコンストラクタで手動で 行うには、 $this->load->library() メソッドを使用します:

$this->load->library('session');

いちどロードされれば、セッションライブラリのオブジェクトは次のように利用することができます:

$this->session

セッションはどのように動作しますか？¶

ページが読み込まれると、セッションクラスは有効なセッションクッキーが ユーザのブラウザから送信されたかどうかをチェックします。 セッションクッキーが存在 しない 場合（またはサーバに保存されているものと一致しないか、 有効期限が切れている場合は）、新しいセッションが作成され、保存されます。

有効なセッションが存在する場合、その情報が更新されます。 更新するごとにセッション ID を再生成されるように設定することもできます。

いちど初期化されたら、セッションクラスは自動的に実行されるということを 理解することは重要なことです。上記の動作をさせるためにあなたが何かをする 必要はありません。以降に書かれているように、セッションデータを使いながら あなたのやりたい処理を書くことができますが、セッションの読み込み、書き込み、 更新のプロセスは自動的に行われます。

セッションデータとは何か？¶

セッションデータは、特定のセッション ID（クッキー）に結びつけられた 単なる配列です。

もし以前から PHP でセッションを利用しているなら、 PHP の $_SESSION スーパーグローバル変数 に精通している ことでしょう（そうでない場合は、そのリンクのコンテンツをお読みください）。

CodeIgniter はセッションデータへのアクセス方法をそれと同じ手段で提供します。 つまり、 PHP のセッションハンドラの仕組みを使っています。 セッションデータの使い方は $ _SESSION 配列を操作（読み込み、設定および削除）するのと同じくらい 簡単です。

くわえて、CodeIgniterでは以下に説明されているさらに 2 種類の セッションデータを提供します: flashdata と tempdata です。

セッションデータの取得¶

セッション配列のどんな情報でも、 $ _SESSION スーパーグローバル変数を通して 利用できます:

$_SESSION['item']

もしくはマジックメソッドを通して:

$this->session->item

そして後方互換性のために、 userdata() メソッドを通して:

$this->session->userdata('item');

item は、取得したい項目に対応する配列のキーです。 たとえば $name 変数に以前に格納した「 name 」の項目を割り当てるには、 こうします:

$name = $_SESSION['name'];

// または:

$name = $this->session->name

// または:

$name = $this->session->userdata('name');

存在するすべてのユーザーデータを取得したい場合は、 単にキーを省略してください（マジックメソッドはプロパティとしてのみ動きます）:

$_SESSION

// または:

$this->session->userdata();

セッションデータを追加する¶

それでは、あなたのサイトにあるユーザがログインしたとしましょう。 認証されると、セッションにユーザー名とメールアドレスを追加することができます。 あなたがそれを必要とするときに、どこでも、データベースクエリを実行することなく 取得できるようにするためです。

シンプルに $ _SESSION 配列にデータを割り当てることができます、ほかの変数と同じようにです。 もしくは $this->session プロパティとして割り当てられます。

あるいは、古い方法である「 userdata 」も使えます。 とはいえそれは set_userdata() メソッドに新しいデータを含む配列を 渡すだけです:

$this->session->set_userdata($array);

$array はあなたの新しいデータを含む連想配列です。 次に例を示します:

$newdata = array(
        'username'  => 'johndoe',
        'email'     => 'johndoe@some-site.com',
        'logged_in' => TRUE
);

$this->session->set_userdata($newdata);

ユーザデータにひとつひとつ値を追加したい場合、 set_userdata() は 次の構文もサポートしています:

$this->session->set_userdata('some_name', 'some_value');

セッション値が存在することを確認したい場合は、単に isset() で 確認してください:

// 'some_name' の値が存在しない場合またはNULLである場合は FALSE を、
// それ以外の場合は TRUE を返します:
isset($_SESSION['some_name'])

もしくは has_userdata() を呼び出します:

$this->session->has_userdata('some_name');

セッションデータを削除する¶

他の変数とまったく同じように、 $_SESSION の値を 削除するには unset() を使えます:

unset($_SESSION['some_name']);

// 複数の値を削除したい場合:

unset(
        $_SESSION['some_name'],
        $_SESSION['another_name']
);

また、セッションに情報を追加するために set_userdata() が 使えるように、 unset_userdata() にキーを渡すことで削除することができます。 例として、セッションデータ配列から「 some_name 」を 削除したい場合は:

$this->session->unset_userdata('some_name');

このメソッドは削除したい項目のキーの配列を受けつけます:

$array_items = array('username', 'email');

$this->session->unset_userdata($array_items);

フラッシュデータ¶

CodeIgniter では「 flashdata 」をサポートします。すなわち、次のリクエストのためだけに利用でき、 その後自動的にクリアされるセッションデータです。

これは非常に便利で、特に1回だけの情報、エラーまたは ステータスメッセージに使えます（たとえば: 「レコード2を削除しました」）。

flashdata 変数は通常のセッション変数であり、「 __ci_vars 」キーによりとある方法で マークされただけのものであることに注意してください （__ci_vars には触らないでくださいね、忠告しましたよ？）。

「 flashdata 」としてすでに作ったアイテムをマークするにはこうします:

$this->session->mark_as_flash('item');

フラッシュデータとして複数の項目をマークしたい場合は、単に配列としてキーを 渡します:

$this->session->mark_as_flash(array('item', 'item2'));

フラッシュデータを追加するにはこうします:

$_SESSION['item'] = 'value';
$this->session->mark_as_flash('item');

または別法として、 set_flashdata() メソッドを使います:

$this->session->set_flashdata('item', 'value');

また、 set_userdata() と同じ方法で set_flashdata() に配列を渡すことが できます。

フラッシュデータ変数の読み取りは通常のセッションデータと同じく $_SESSION を使います:

$_SESSION['item']

「 flashdata 」だけを確実に読みたい場合（ほかの種類のセッションを 読みたくない場合）、 flashdata() メソッドを使用することができます:

$this->session->flashdata('item');

フラッシュデータを全部取得するには、単にキーパラメータを省略します:

$this->session->flashdata();

もし次のリクエストでもフラシュデータ変数を保持する必要があるとわかった場合、 keep_flashdata() メソッドを使用して保持することができます。 単一のフラッシュデータ、またはフラッシュデータの配列を渡せます。

$this->session->keep_flashdata('item');
$this->session->keep_flashdata(array('item1', 'item2', 'item3'));

テンプデータ¶

CodeIgniter は「 tempdata 」をサポートします。特定の有効期限を持つセッションデータです。 値の有効期限が切れた、またはセッションの有効期限が切れるか削除された後、 値は自動的に削除されます。

フラッシュデータと同様に、テンプデータ変数はとある方法で「 __ci_vars 」キーで マークされた通常のセッション変数です（もう一度言います。 __ci_vars には触らないでください）。

すでにあるアイテムを「 tempdata 」としてマークするには、シンプルにそのキーと有効期限を （単位は秒で！）``mark_as_temp()`` メソッドに渡してください:

// 'item' は 300 秒後に消されます
$this->session->mark_as_temp('item', 300);

複数のアイテムを tempdata としてマークできますが、 有効期限が同じかどうかにより方法がふたつあります:

// 'item' と 'item2' の両方が 300 秒後に期限切れします
$this->session->mark_as_temp(array('item', 'item2'), 300);

// 'item'  は 300 秒後に、
// そのあいだに 'item2' は240 秒後に消えます
$this->session->mark_as_temp(array(
        'item'  => 300,
        'item2' => 240
));

テンプデータを追加するにはこうします:

$_SESSION['item'] = 'value';
$this->session->mark_as_temp('item', 300); // 5 分で期限切れ

または別法として、 set_tempdata() メソッドを使用します:

$this->session->set_tempdata('item', 'value', 300);

また、 set_tempdata() には配列を渡すことができます:

$tempdata = array('newuser' => TRUE, 'message' => 'Thanks for joining!');

$this->session->set_tempdata($tempdata, NULL, $expire);

テンプデータ変数を読み取るには、またですが、 $_SESSION スーパーグローバル配列でアクセスすることができます:

$_SESSION['item']

「 tempdata 」だけを確実に読みたい場合（ほかの種類のセッションを読みたくない場合）、 tempdata() メソッドを使用することができます:

$this->session->tempdata('item');

そしてもちろん、すべてのテンプデータを取得する場合はこうします:

$this->session->tempdata();

有効期限が切れる前にテンプデータ値を削除する必要がある場合は $_SESSION 配列を直接 unset してください:

unset($_SESSION['item']);

しかしながら、この方法はアイテムをテンプデータとするマーカーを削除しません (次の HTTP リクエストで不正扱いになります) 。 そのため同じリクエストで同じキーを再利用したい場合、 unset_tempdata() を使用すべきところでしょう:

$this->session->unset_tempdata('item');

セッションの破棄¶

現在のセッションをクリアするには（たとえばログアウト時）、 単に PHP の session_destroy() 関数を使うか、 sess_destroy() メソッドを使います。 どちらもまったく同じです:

session_destroy();

// または

$this->session->sess_destroy();

セッションメタデータへのアクセス¶

CodeIgniter の以前のバージョンでは、セッションデータ配列はデフォルトで4つの項目を含んでいました: 「session_id」「ip_address」「user_agent」「last_activity」です。

これはセッションを動かすために必要だった変数ですが、今の新しい実装には不要になりました。 しかしながら、あなたのアプリケーションがこれらの値に依存しているということもあるでしょう。 そこで、 これらにアクセスするための代替手段を記します:

• session_id: session_id()
• ip_address: $_SERVER['REMOTE_ADDR']
• user_agent: $this->input->user_agent() （セッションでは使われません）
• last_activity: ストレージによります。ストレートな方法はありません。ごめんなさい！

セッションの設定¶

CodeIgniter は通常、セットアップしてすぐ動きます。 しかしながらセッションはいろいろなアプリケーションで非常に敏感な部品であるため、 いくらか慎重に設定を行われなければなりません。 オプションとその影響のすべてを考慮するため、どうか時間を取って検討してください。

次のセッション関連の設定は application/config/config.php ファイルにあります:

上記の値に加えて、クッキーとネイティブドライバは 次の設定値が適用されます。この値は 入力 および セキュリティ クラスと共有しています:

セッションドライバ¶

既に述べたように、セッションライブラリには 4 つのドライバ、 つまりストレージエンジンが付属しています:

• files
• database
• redis
• memcached

デフォルトでは ファイルドライバ がセッションが初期化されるときに使用されます。 それは最も安全な選択であり、どこでも動くと期待されるからです （実質的にあらゆる実行環境はファイルシステムを持っています）。

一方、他のドライバは application/config/config.php ファイルの $config['sess_driver'] により選択することができます、あなたがそれを選ぶなら。 しかし、それぞれのドライバには異なる注意点があり、それらを使う前にそれら （後述します）に熟知しておくべきということを頭にとどめておいてください。

また、デフォルトがあなたのユースケースを満たしていない場合、 カスタムドライバ を作成して使うことができます。

mkdir /<path to your application directory>/sessions/
chmod 0700 /<path to your application directory>/sessions/
chown www-data /<path to your application directory>/sessions/

CREATE TABLE IF NOT EXISTS `ci_sessions` (
        `id` varchar(40) NOT NULL,
        `ip_address` varchar(45) NOT NULL,
        `timestamp` int(10) unsigned DEFAULT 0 NOT NULL,
        `data` blob NOT NULL,
        KEY `ci_sessions_timestamp` (`timestamp`)
);

CREATE TABLE "ci_sessions" (
        "id" varchar(40) NOT NULL,
        "ip_address" varchar(45) NOT NULL,
        "timestamp" bigint DEFAULT 0 NOT NULL,
        "data" text DEFAULT '' NOT NULL
);

CREATE INDEX "ci_sessions_timestamp" ON "ci_sessions" ("timestamp");

// sess_match_ip = TRUE のとき
ALTER TABLE ci_sessions ADD PRIMARY KEY (id, ip_address);

// sess_match_ip = FALSE のとき
ALTER TABLE ci_sessions ADD PRIMARY KEY (id);

// 以前のプライマリキーを削除するとき（設定を変更するときに使います）
ALTER TABLE ci_sessions DROP PRIMARY KEY;

$config['sess_driver'] = 'redis';
$config['sess_save_path'] = 'tcp://localhost:6379';

$config['sess_driver'] = 'memcached';
$config['sess_save_path'] = 'localhost:11211';

// localhost はより高い優先度（5）を与えられます、
// 192.0.2.1 の重みづけ 1 と比べ。
$config['sess_save_path'] = 'localhost:11211:5,192.0.2.1:11211:1';

// application/libraries/Session/drivers/Session_dummy_driver.php:

class CI_Session_dummy_driver extends CI_Session_driver implements SessionHandlerInterface
{

        public function __construct(&$params)
        {
                // これを忘れては　な　り　ま　せ　ん
                parent::__construct($params);

                // 設定その他の初期化をします
        }

        public function open($save_path, $name)
        {
                // ストレージ機構（接続）の初期化
        }

        public function read($session_id)
        {
                // （もしあれば）セッションデータの読み込み、ロックの獲得
        }

        public function write($session_id, $session_data)
        {
                // セッションデータの作成、更新（データは存在しないかもしれません！）
        }

        public function close()
        {
                // ロックの開放、接続の切断など
        }

        public function destroy($session_id)
        {
                // close() メソッドの呼び出しと、現在のセッションデータの破棄（順序は逆かもしれません）
        }

        public function gc($maxlifetime)
        {
                // 期限切れセッションの削除
        }

}