类 CGI::Cookie

类表示一个 HTTP cookie。

除了其特定字段和方法外，Cookie 实例还是其值数组的委托者。

请参阅 RFC 2965。

cookie1 = CGI::Cookie.new("name", "value1", "value2", ...)
cookie1 = CGI::Cookie.new("name" => "name", "value" => "value")
cookie1 = CGI::Cookie.new('name'     => 'name',
                          'value'    => ['value1', 'value2', ...],
                          'path'     => 'path',   # optional
                          'domain'   => 'domain', # optional
                          'expires'  => Time.now, # optional
                          'secure'   => true,     # optional
                          'httponly' => true      # optional
                          )

cgi.out("cookie" => [cookie1, cookie2]) { "string" }

name     = cookie1.name
values   = cookie1.value
path     = cookie1.path
domain   = cookie1.domain
expires  = cookie1.expires
secure   = cookie1.secure
httponly = cookie1.httponly

cookie1.name     = 'name'
cookie1.value    = ['value1', 'value2', ...]
cookie1.path     = 'path'
cookie1.domain   = 'domain'
cookie1.expires  = Time.now + 30
cookie1.secure   = true
cookie1.httponly = true

常量

DOMAIN_VALUE_RE
PATH_VALUE_RE
TOKEN_RE

属性

domain[R]

此 cookie 适用的域，作为 String

expires[RW]

时间此 cookie 过期，作为 时间

httponly[R]

如果此 cookie 为 httponly，则为 True；否则为 false

name[R]

此 cookie 的名称，作为 String

path[R]

此 cookie 适用的路径，作为 String

secure[R]

如果此 cookie 为安全，则为 True；否则为 false

公共类方法

new(name_string,*value) 单击以切换源

new(options_hash)

创建一个新的 CGI::Cookie 对象。

name_string

cookie 的名称；在此形式中，没有 domain 或过期时间。path 从 SCRIPT_NAME 环境变量中获取，secure 为 false。

*value

cookie 的值或值列表

options_hash

用于初始化此 Cookie 的选项的 哈希。可能的选项是

name: cookie 的名称。必需。
value: cookie 的值或值列表。
path: 此 cookie 适用的路径。默认为 SCRIPT_NAME 环境变量的值。
domain: 此 cookie 适用的域。
expires: 此 cookie 过期的时间，作为 Time 对象。
secure: 此 cookie 是否为安全 cookie（默认为 false）。安全 cookie 仅传输到 HTTPS 服务器。
httponly: 此 cookie 是否为 HttpOnly cookie（默认为

false).  HttpOnly cookies are not available to javascript.

这些关键字对应于 cookie 对象的属性。

调用超类方法 Array::new

# File lib/cgi/cookie.rb, line 75
def initialize(name = "", *value)
  @domain = nil
  @expires = nil
  if name.kind_of?(String)
    self.name = name
    self.path = (%r|\A(.*/)| =~ ENV["SCRIPT_NAME"] ? $1 : "")
    @secure = false
    @httponly = false
    return super(value)
  end

  options = name
  unless options.has_key?("name")
    raise ArgumentError, "`name' required"
  end

  self.name = options["name"]
  value = Array(options["value"])
  # simple support for IE
  self.path = options["path"] || (%r|\A(.*/)| =~ ENV["SCRIPT_NAME"] ? $1 : "")
  self.domain = options["domain"]
  @expires = options["expires"]
  @secure = options["secure"] == true
  @httponly = options["httponly"] == true

  super(value)
end

parse(raw_cookie) 点击切换源代码

将原始 cookie 字符串解析为 cookie 名称 => Cookie 对的哈希。

cookies = CGI::Cookie.parse("raw_cookie_string")
  # { "name1" => cookie1, "name2" => cookie2, ... }

# File lib/cgi/cookie.rb, line 183
def self.parse(raw_cookie)
  cookies = Hash.new([])
  return cookies unless raw_cookie

  raw_cookie.split(/;\s?/).each do |pairs|
    name, values = pairs.split('=',2)
    next unless name and values
    values ||= ""
    values = values.split('&').collect{|v| CGI.unescape(v,@@accept_charset) }
    if cookies.has_key?(name)
      values = cookies[name].value + values
    end
    cookies[name] = Cookie.new(name, *values)
  end

  cookies
end

公共实例方法

domain=(str) 点击切换源代码

Set 此 cookie 适用的域

# File lib/cgi/cookie.rb, line 126
def domain=(str)
  if str and ((str = str.b).bytesize > 255 or !DOMAIN_VALUE_RE.match?(str))
    raise ArgumentError, "invalid domain: #{str.dump}"
  end
  @domain = str
end

httponly=(val) 点击切换源代码

Set Cookie 是否为 httponly cookie。

val 必须为布尔值。

# File lib/cgi/cookie.rb, line 161
def httponly=(val)
  @httponly = !!val
end

inspect() 点击切换源代码

cookie 字符串的摘要。

# File lib/cgi/cookie.rb, line 202
def inspect
  "#<CGI::Cookie: #{self.to_s.inspect}>"
end

name=(str) 点击切换源代码

Set 此 cookie 的名称

# File lib/cgi/cookie.rb, line 106
def name=(str)
  if str and !TOKEN_RE.match?(str)
    raise ArgumentError, "invalid name: #{str.dump}"
  end
  @name = str
end

path=(str) 点击切换源代码

Set 此 cookie 适用的路径

# File lib/cgi/cookie.rb, line 116
def path=(str)
  if str and !PATH_VALUE_RE.match?(str)
    raise ArgumentError, "invalid path: #{str.dump}"
  end
  @path = str
end

secure=(val) 点击切换源代码

Set Cookie 是否为安全 cookie。

val 必须为布尔值。

# File lib/cgi/cookie.rb, line 153
def secure=(val)
  @secure = val if val == true or val == false
  @secure
end

to_s() 点击切换源代码

将 Cookie 转换为其字符串表示形式。

# File lib/cgi/cookie.rb, line 166
def to_s
  val = collect{|v| CGI.escape(v) }.join("&")
  buf = "#{@name}=#{val}".dup
  buf << "; domain=#{@domain}" if @domain
  buf << "; path=#{@path}"     if @path
  buf << "; expires=#{CGI.rfc1123_date(@expires)}" if @expires
  buf << "; secure"            if @secure
  buf << "; HttpOnly"          if @httponly
  buf
end

value() 点击切换源代码

返回此 cookie 的值或值列表。

# File lib/cgi/cookie.rb, line 141
def value
  self
end

value=(val) 点击切换源代码

用新值或值列表替换此 cookie 的值。

# File lib/cgi/cookie.rb, line 146
def value=(val)
  replace(Array(val))
end

使用示例¶ ↑