Object: Cookie

クッキーを設定・取得します。

クレジット:

  • Peter-Paul KochのQuirksMode関数に撰っています。
  • domain - (文字列: 初期値=false) クッキーの属するドメイン。
  • path - (文字列: 初期値=false) クッキーの属するパス。
  • duration - (: 初期値=false) クッキーが削除されるまでの期間(単位:日)。falseか0がセットされると、ブラウザを閉じたときに破棄されるセッション・クッキーになります。
  • secure - (真偽値: 初期値=false) 安全な環境からのみクッキーにアクセスできるようにします。

注意点:

  • 異なるパスにあるページとクッキーを共有するには、Cookie.options.domainがセットされていなくてはいけません。

Cookieメソッド: write

ブラウザにクッキーを書き込みます。

構文:

var myCookie = Cookie.write(key, value[, options]);

引数:

  1. key - (文字列) クッキーのキー(または名前)。
  2. value - (文字列) セットする値。セミコロンは入れられません。
  3. options - (いろいろ, オプション) Cookieを見てください。

戻り値:

  • (オブジェクト) キーと値のペアを持つオブジェクト。これはCookie.removeの引数として渡すことができます。

例:

セッションの間だけクッキーを保存:
var myCookie = Cookie.write('username', 'Harald');
一日だけクッキーを保存:
var myCookie  = Cookie.write('username', 'JackBauer', {duration: 1});

Cookieメソッド: read

クッキーの値を読み取ります。

構文:

var myCookie = Cookie.read(name);

引数:

  1. name - (文字列) 取得したいクッキーの名前。

戻り値:

  • (いろいろ) クッキー文字列。見つからなければnull。

例:

Cookie.read("username");

Cookieメソッド: dispose

ブラウザからクッキーを消去します。

構文:

var oldCookie = Cookie.dispose(cookie[, options]);

引数:

  1. name - (文字列) 消去したいクッキーの名前か、以前に保存されたCookieインスタンス。
  2. options - (オブジェクト, オプション) Cookieを見てください。

例:

クッキーの削除:
Cookie.dispose('username'); //バイバイJackBauer! 24時間後に会おう。
クッキーを生成して、すぐに削除:
var myCookie = Cookie.write('username', 'Aaron', {domain: 'mootools.net'});
if (Cookie.read('username') == 'Aaron') { Cookie.dispose(myCookie); }

このドキュメントはMooToolsのドキュメントを元に高橋文樹が翻訳(ちょっと改変)しました。
本家と同じく、Attribution-NonCommercial-ShareAlike 3.0ライセンスで公表されています。

トップに戻る