Class: CGI::Cookie (Ruby 2.2.3)
Description: Class : CGI::Cookie - Ruby 2.2.3

- Home
- Core 2.2.3
- Std-lib 2.2.3
- Downloads

Support for the Ruby 2.2 series has ended. See here for reference.

### Home Classes Methods

### In Files

- cgi/cookie.rb
- cgi/core.rb
- cgi/session.rb

### Parent

Array

### Methods

- ::new
- ::parse
- #inspect
- #secure=
- #to_s
- #value
- #value=

### Class/Module Index

Quicksearch

- CGI
- CGI::Cookie
- CGI::HTML3
- CGI::HTML4
- CGI::HTML4Fr
- CGI::HTML4Tr
- CGI::HTML5
- CGI::HtmlExtension
- CGI::InvalidEncoding
- CGI::QueryExtension
- CGI::Session
- CGI::Session::FileStore
- CGI::Session::MemoryStore
- CGI::Session::NullStore
- CGI::Session::PStore
- CGI::Util

No matching classes.

# CGI::Cookie

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

domain[RW]

Domain for which this cookie applies, as a `String`

expires[RW]

Time at which this cookie expires, as a `Time`

name[RW]

Name of this cookie, as a `String`

path[RW]

Path for which this cookie applies, as a `String`

secure[R]

True if this cookie is secure; false otherwise

### Public Class Methods

new(name_string,*value) click to toggle source
new(options_hash)

Create a new CGI::Cookie object.

`name_string`

  The name of the cookie; in this form, there is no domain or expiration. The path is gleaned from the `SCRIPT_NAME` environment variable, and secure is false.

`*value`

  value or list of values of the cookie

`options_hash`

  A Hash of options to initialize this Cookie. Possible options are:

  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 the value of the `SCRIPT_NAME` environment variable.

  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.

                   # File cgi/cookie.rb, line 65
    def initialize(name = "", *value)
      @domain = nil
      @expires = nil
      if name.kind_of?(String)
        @name = name
        %r|^(.*/)|.match(ENV["SCRIPT_NAME"])
        @path = ($1 or "")
        @secure = false
        return super(value)
      end

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

      @name = options["name"]
      value = Array(options["value"])
      # simple support for IE
      if options["path"]
        @path = options["path"]
      else
        %r|^(.*/)|.match(ENV["SCRIPT_NAME"])
        @path = ($1 or "")
      end
      @domain = options["domain"]
      @expires = options["expires"]
      @secure = options["secure"] == true ? true : false

      super(value)
    end

parse(raw_cookie) click to toggle source

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

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

                   # File cgi/cookie.rb, line 143
    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
        name = CGI.unescape(name)
        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

### Public Instance Methods

inspect() click to toggle source

A summary of cookie string.

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

secure=(val) click to toggle source

Set whether the Cookie is a secure cookie or not.

`val` must be a boolean.

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

to_s() click to toggle source

Convert the Cookie to its string representation.

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

value() click to toggle source

Returns the value or list of values for this cookie.

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

value=(val) click to toggle source

Replaces the value of this cookie with a new value or list of values.

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