NAME

PHP::Session - PHPセッションファイルの読み書き

SYNOPSIS

  use PHP::Session;

  my $session = PHP::Session->new($id);

  # session id
  my $id = $session->id;

  # セッションデータの get/set
  my $foo = $session->get('foo');
  $session->set(bar => $bar);

  # セッションデータの削除
  $session->unregister('foo');

  # すべてのセッションデータを削除
  $session->unset;

  # データが登録されているかチェック
  $session->is_registered('bar');

  # セッションデータを保存
  $session->save;

  # セッションを破壊
  $session->destroy;

  # もし存在しなければ、セッションファイルを生成する
  $session = PHP::Session->new($new_sid, { create => 1 });

PHP::Session を使用するとPHP4のセッションファイルを読み書きすることができ、PerlアプリケーションのセッションをPHP4と共有することができます。

セッション管理に Apache::Session のインタフェースを使用したい場合には、 Apache::Session::PHP を使用すると、このモジュールと Apache::Session の橋渡しをうまくやってくれます。

コンストラクタ new にはハッシュリファレンスでオプションを渡せます。

save_path
セッションファイルが保持されるディレクトリパス。デフォルトは /tmp。
serialize_handler
シリアライズハンドラのタイプ。現在サポートされているのはPHPデフォルトシリアライズハンドラのみ。
create
存在しない場合にセッションファイルを生成するか。デフォルトは0。
auto_save
変更をセッションファイルに自動的に保存するか。デフォルトは0。

以下のような場合に:
```
  my $session = PHP::Session->new($sid, { auto_save => 1 });
  $session->param(foo => 'bar');
```
```
  # あーっと save() メソッドを忘れてる!
```
auto_save を真の値にしておけば、パラメータを変更した後に saveメソッドを呼び忘れても、セッションオブジェクトがスコープ外に消えるときに、このモジュールが自動的にセッションファイルに保存します。

0にしておいた場合(デフォルト)、かつ warnings がオンの場合には、以下のような警告を発生させます:
```
  PHP::Session: some keys are changed but not modified.
```

PHP の配列は Perl のハッシュになります。
PHP でのオブジェクトは PHP::Session::Object (空のクラス) に bless されたオブジェクトとなり、元のクラス名は _class というキーに保持されます。
データを save() するときのロックは排他的な flock にて行われます。これは PHP の実装と同じです。
十分なテストはおこなっていませんので、シリアライゼーションまわりでバグがあるかもしれません。もし見つけたらemailで教えてください。

Tatsuhiko Miyagawa <miyagawa@bulknews.net>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.