Extended maintenance of Ruby 1.9.3 ended on February 23, 2015. Read more
Mixin module that provides the following:
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
.
Access to cookies, including the cookies attribute.
Access to parameters, including the params attribute, and overloading [] to perform parameter value lookup by key.
The initialize_query method, for initializing the above mechanisms, handling multipart forms, and allowing the class to be used in “offline” mode.
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.
# File cgi/core.rb, line 687 def [](key) params = @params[key] return '' unless params value = params[0] if @multipart if value return value elsif defined? StringIO StringIO.new("".force_encoding("ascii-8bit")) else Tempfile.new("CGI",encoding:"ascii-8bit") end else str = if value then value.dup else "" end str end end
Returns true if a given query string parameter exists.
# File cgi/core.rb, line 711 def has_key?(*args) @params.has_key?(*args) end
Return all query parameter names as an array of String.
# File cgi/core.rb, line 706 def keys(*args) @params.keys(*args) end
Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.
If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.
If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.
If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.