Skip to Content Skip to Search

Mixin module that provides the following:

  1. Access to the CGI environment variables as methods. See documentation to the CGI class for a list of these variables. The methods are exposed by removing the leading HTTP_ (if it exists) and downcasing the name. For example, auth_type will return the environment variable AUTH_TYPE, and accept will return the value for HTTP_ACCEPT.

  2. Access to cookies, including the cookies attribute.

  3. Access to parameters, including the params attribute, and overloading [] to perform parameter value lookup by key.

  4. The initialize_query method, for initializing the above mechanisms, handling multipart forms, and allowing the class to be used in “offline” mode.

Methods
#
H
I
K
M
P
R

Attributes

[RW] cookies

Get the cookies as a hash of cookie-name=>Cookie pairs.
[R] files

Get the uploaded files as a hash of name=>values pairs
[R] params

Get the parameters as a hash of name=>values pairs, where values is an Array.

Instance Public methods

[](key)

Get the value for the parameter with a given key.

If the parameter has multiple values, only the first will be retrieved; use params to get the array of values.

Source: show | on GitHub 

# File ruby/lib/cgi/core.rb, line 714
def [](key)
  params = @params[key]
  return '' unless params
  value = params[0]
  if @multipart
    if value
      return value
    elsif defined? StringIO
      StringIO.new("".b)
    else
      Tempfile.new("CGI",encoding: Encoding::ASCII_8BIT)
    end
  else
    str = if value then value.dup else "" end
    str
  end
end

has_key?(*args)

Returns true if a given query string parameter exists.

Also aliased as: key?, include?

Source: show | on GitHub 

# File ruby/lib/cgi/core.rb, line 738
def has_key?(*args)
  @params.has_key?(*args)
end

include?(*args)

Alias for: has_key?

key?(*args)

Alias for: has_key?

keys(*args)

Return all query parameter names as an array of String.

Source: show | on GitHub 

# File ruby/lib/cgi/core.rb, line 733
def keys(*args)
  @params.keys(*args)
end

multipart?()

Returns whether the form contained multipart/form-data

Source: show | on GitHub 

# File ruby/lib/cgi/core.rb, line 706
def multipart?
  @multipart
end

params=(hash)

Set all the parameters.

Source: show | on GitHub 

# File ruby/lib/cgi/core.rb, line 474
def params=(hash)
  @params.clear
  @params.update(hash)
end

Get the raw cookies as a string.

Source: show | on GitHub

raw_cookie2()

Get the raw RFC2965 cookies as a string.

Source: show | on GitHub 

# File ruby/lib/cgi/core.rb, line 459
def raw_cookie2
  env_table["HTTP_COOKIE2"]
end