constants | attributes | methods
Class

CGI::Cookie

Inheritance
< DelegateClass(Array)

Class representing an HTTP cookie.

In addition to its specific fields and methods, a Cookie instance is a delegator to the array of its values.

See RFC 2965.

Examples of use

  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
                            )

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

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

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

Attributes

Name Visibility R/W Description
domain public RW
expires public RW
name public RW
path public RW
secure public R
value public RW

Methods

Class

Visibility Signature
public new (name = "", *value)
public parse (raw_cookie)

Instance

Visibility Signature
public secure= (val)
public to_s ()

Class Method Detail

new(name = "", *value)

Create a new CGI::Cookie object.

The contents of the cookie can be specified as a name and one or more value arguments. Alternatively, the contents can be specified as a single hash argument. The possible keywords of this hash are as follows:

name:the name of the cookie. Required.
value:the cookie‘s value or list of values.
path:the path for which this cookie applies. Defaults to the base directory of the CGI script.
domain:the domain for which this cookie applies.
expires:the time at which this cookie expires, as a Time object.
secure:whether this cookie is a secure cookie or not (default to false). Secure cookies are only transmitted to HTTPS servers.

These keywords correspond to attributes of the cookie object.

parse(raw_cookie)

Parse a raw cookie string into a hash of cookie-name=>Cookie pairs. 

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

Instance Method Detail

secure=(val)

Set whether the Cookie is a secure cookie or not.

val must be a boolean.

to_s()

Convert the Cookie to its string representation.