BOOMR ユーティリティ関数

全てのユーティリティ関数は名前空間 BOOMR.utils のもとに定義されています。以降のメソッドにアクセスするには BOOMR.utils オブジェクトを参照してください。例: getCookie() メソッドを呼び出すには BOOMR.utils.getCookie() を使用します。

メソッド

getCookie(sName)

sName をキーとした Cookie の値を取得します。

返り値

sName に結びつく Cookie の文字列。空の文字列の場合もあります。
Cookie が見つからないか sName が空だった場合は null を返します。

setCookie(sName, oSubCookies, nMaxAge, sPath, sDomain, bSecure)

シリアライズ化された oSubCookies の値に sName の名前をつけて Cookie をセットします。

パラメーター:

sName: Cookie の名前
oSubCookies: key/value ペアの Cookie に書き込むデータ。これらは URL エンコードした key=value ペアのリストを & で連結されてシリアライズ化されます。
nMaxAge: Cookie の有効時間（秒）。ブラウザーが閉じるまで有効にする場合は 0 をセットします。デフォルトは 0 です。
sPath: Cookie が有効となる HTTP のパス。Cookie はこのドメイン上の sPath 以下の全ての URL へ送信されます。セットしていない場合は現在のドキュメントのパスがデフォルトになります。あなたがサーバー上で同じドメインを複数のユーザーと共有している限り、/（スラッシュ）をセットすることになるでしょう。
sDomain: Cookie が有効となる HTTP ドメイン。Cookie はこのドメインのサブドメイン上の全ての URL へ送信されます。セットしていない場合は現在のドキュメントのドメインがデフォルトになります。もし null をセットした場合、BOOMR.init() が呼び出されて設定された site_domain の値が使用されます。大抵の場合 null をセットすることになるでしょう。
bSecure: もし true がセットされると、Cookie は HTTPS の URL だけに送信します。false がセットされているか、またはセットされていない場合は Cookie は上記のルールに沿った全ての URL へ送信されます。あなたのサイトが完全な SSL ベースでない限りこの設定は無視できます。

全体の名前と値が4000文字未満である必要があることを注意してください。

例:

BOOMR.plugins.RT プラグインはこの関数をこのようにして使います:

if(!BOOMR.utils.setCookie(
			impl.cookie,
			{ s: t_start, r: url },
			impl.cookie_exp,
			"/",
			null
		)) {
	BOOMR.error("cannot set start cookie", "rt");
	return this;
}

返り値

Cookie のセットに成功した場合は true を返します
Cookie のセットに失敗した場合は false を返します

getSubCookies(sCookie)

getCookie() によって取得した Cookie の文字列をパースし、サブ Cookie とした構成で切り分けます。

例:

BOOMR.plugins.BW プラグインはこの関数をこのようにして使います:

var cookies = BOOMR.utils.getSubCookies(BOOMR.utils.getCookie(impl.cookie));

返り値

成功すると全てのサブ Cookie が key/value のペアとなったオブジェクトを返します。サブ Cookie の値が空の場合もあることに注意してください。
sCookie がセットされていないか有効なサブ Cookie が含まれていない場合は null を返します。

removeCookie(sName)

sName にセットされた値を無効化して Cookie を削除し、セッション Cookie をつくります。

返り値

なし

pluginConfig(oImpl, oConfig, sName, aProperties)

init() メソッドに渡された設定オブジェクトと一緒に設定するためにプラグインが呼び出せる便利なメソッドです。

パラメーター:

oImpl: 全ての設定とプライベートのプロパティを格納したプラグインの impl オブジェクト。
oConfig: プラグインの init() メソッドに渡された設定オブジェクト。
sName: BOOMR.plugins オブジェクト内でのプラグインの名前。
aProperties: プラグインが設定できる全てのプロパティを含んだ配列。

例:

BOOMR.plugins.RT プラグインはこのメソッドをこのようにして使います:

BOOMR.utils.pluginConfig(impl, config, "RT", ["cookie", "cookie_exp", "strict_referrer"]);

返り値

最低ひとつのプロパティがセットされれば true を返します。
プロパティがセットされていないか oConfig オブジェクトがセットされていなければ false を返します。

最新のソースコードとドキュメントは github.com/SOASTA/boomerang に公開されています。