Ruby 2.4.0 リファレンスマニュアル > ライブラリ一覧 > webrick/cookieライブラリ > WEBrick::Cookieクラス

class WEBrick::Cookie

クラスの継承リスト: WEBrick::Cookie < Object < Kernel < BasicObject

要約

Cookie を表すクラスです。[RFC2109] に準拠しています。 RFC2109 は [RFC2965] により破棄されましたが、WEBrick::Cookie クラスは RFC2965 に対応していません。

目次

特異メソッド
new parse parse_set_cookie parse_set_cookies
インスタンスメソッド
comment comment= domain domain= expires expires= max_age max_age= name path path= secure secure= to_s value value= version version=

特異メソッド

new(name, value) -> WEBrick::Cookie[permalink][rdoc]

新しい WEBrick::Cookie オブジェクトを生成して返します。 name にクッキーの名前を、value にクッキーで保持する値を与える。

[PARAM] name:
Cookie の名前を文字列で指定します。
[PARAM] value:
Cookie の値を文字列で指定します。
parse(str) -> [WEBrick::Cookie][permalink][rdoc]

ユーザーエージェントから送られてきた Cookie ヘッダの値 str をパースし、 新しく WEBrick::Cookie オブジェクトを生成しその配列を返します。 各属性の形式が仕様に準拠しているかを確認しません。

[PARAM] str:
Cookie を表す文字列を指定します。
require 'webrick'
include WEBrick
c = Cookie.parse('$Version="1"; Customer="WILE"; $Path="/foo"; P_Number="Rocket"; $Path="/foo/hoge"')
p c[1].name, c[1].path

#=>
"P_Number"
"/foo/hoge"

サーバから送られてくる Set-Cookie ヘッダの値 str をパースし、 新しく WEBrick::Cookie オブジェクトを生成し返します。

[PARAM] str:
Set-Cookie ヘッダの値を文字列で指定します。
require 'webrick'
include WEBrick
c = Cookie.parse_set_cookie('Shipping="FedEx"; Version="1"; Path="/acme"')
p c.name, c.value

#=>
"Shipping"
"FedEx"
parse_set_cookies(str) -> [WEBrick::Cookie][permalink][rdoc]

サーバから送られてくる Set-Cookie ヘッダの値 str をパースし、 新しく WEBrick::Cookie オブジェクトの配列を生成し返します。

[PARAM] str:
Set-Cookie ヘッダの値を文字列で指定します。

インスタンスメソッド

comment -> String[permalink][rdoc]
comment=(value)

コメントを文字列で表すアクセサです。

[PARAM] value:
コメントを文字列で指定します。
domain -> String[permalink][rdoc]
domain=(value)

ドメイン名を文字列で表すアクセサです。

[PARAM] value:
ドメイン名を表す文字列を指定します。
expires -> Time[permalink][rdoc]
expires=(value)

有効期限を Timeオブジェクトで表すアクセサです。

[PARAM] value:
有効期限を Time オブジェクトまたは文字列を指定します。
max_age -> Integer[permalink][rdoc]
max_age=(value)

クッキーの寿命を整数(単位は秒)で表すアクセサです。

[PARAM] value:
クッキーの寿命を正の整数で指定します。0 は直ちに破棄される事を意味する。
name -> String[permalink][rdoc]

Cookie の名前を文字列で返します。

path -> String[permalink][rdoc]
path=(value)

パス名を文字列で表すアクセサです。

[PARAM] value:
パス名を文字列で指定します。
secure -> bool[permalink][rdoc]
secure=(value)

クッキーのSecure属性を真偽値で表すアクセサです。

[PARAM] value:
クッキーのSecure属性を真偽値で指定します。
to_s -> String[permalink][rdoc]

クッキーを文字列にして返します。

value -> String[permalink][rdoc]
value=(str)

クッキーの値を文字列で表すアクセサです。

[PARAM] str:
クッキーの値を文字列で指定します。
version -> Integer[permalink][rdoc]
version=(value)

Cookie のバージョン番号を整数で表すアクセサです。

[PARAM] value:
Cookie のバージョン番号を整数で指定します。