class 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
'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
Public Class Methods
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 646
def initialize: (String name_string, *String value) -> void
| (Hash[String, untyped] options_hash) -> void
Create a new CGI::Cookie object.
name_string-
The name of the cookie; in this form, there is no
domainor #expiration. Thepathis gleaned from theSCRIPT_NAMEenvironment variable, andsecureis false. *value-
value or list of values of the cookie
options_hash-
A
Hashof options to initialize thisCookie. 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 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.
httponly
: whether this cookie is a HttpOnly cookie or not (default to
false). HttpOnly cookies are not available to javascript. These keywords correspond to attributes of the cookie object.
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 485
def self.parse: (String raw_cookie) -> Hash[String, instance]
Parse a raw cookie string into a hash of cookie-name=>Cookie pairs.
cookies = CGI::Cookie.parse("raw_cookie_string") # { "name1" => cookie1, "name2" => cookie2, ... }
Public Instance Methods
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 490
def domain: () -> String?
Domain for which this cookie applies, as a String
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 498
def domain=: (String domain) -> String
Set domain for which this cookie applies
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 503
def expires: () -> Time?
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 508
def expires=: (Time time) -> Time
() → bool
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 513
def httponly: () -> bool
True if this cookie is httponly; false otherwise
(boolish val) → bool
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 523
def httponly=: (boolish val) -> bool
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 531
def inspect: () -> String
A summary of cookie string.
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 536
def name: () -> String
Name of this cookie, as a String
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 544
def name=: (String name) -> String
Set name of this cookie
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 549
def path: () -> String?
Path for which this cookie applies, as a String
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 557
def path=: (String path) -> String
Set path for which this cookie applies
() → bool
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 562
def secure: () -> bool
True if this cookie is secure; false otherwise
[A] (boolish val) → A
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 572
def secure=: [A] (boolish val) -> A
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 580
def to_s: () -> String
Convert the Cookie to its string representation.
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 588
def value: () -> Array[String]
Returns the value or list of values for this cookie.