module CGI::QueryExtension

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.

Public Instance Methods

(String key) → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 684
def []: (String key) -> String?

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.

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 686
def accept: () -> String?

accept_charset

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 688
def accept_charset: () -> String?

accept_encoding

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 690
def accept_encoding: () -> String?

accept_language

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 692
def accept_language: () -> String?

auth_type

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 694
def auth_type: () -> String?

cache_control

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 696
def cache_control: () -> String?

content_length

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 698
def content_length: () -> String?

content_type

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 700
def content_type: () -> String?

() → Hash[String, Cookie]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 705
def cookies: () -> Hash[String, Cookie]

Get the cookies as a hash of cookie-name=>Cookie pairs.

cookies=

(Hash[String, Cookie] cookies) → Hash[String, Cookie]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 710
def cookies=: (Hash[String, Cookie] cookies) -> Hash[String, Cookie]

Get the cookies as a hash of cookie-name=>Cookie pairs.

create_body

(boolish is_large) → (Tempfile | StringIO)

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 712
def create_body: (boolish is_large) -> (Tempfile | StringIO)

files

() → Hash[String, Tempfile | StringIO]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 717
def files: () -> Hash[String, Tempfile | StringIO]

Get the uploaded files as a hash of name=>values pairs

from

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 719
def from: () -> String?

gateway_interface

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 721
def gateway_interface: () -> String?

has_key?

(String key) → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 729
def has_key?: (String key) -> bool

Returns true if a given query string parameter exists.

Also aliased as: include?, key?

host

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 731
def host: () -> String?

include?

(String key) → bool

Alias for: has_key?

initialize_query

() → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 840
def initialize_query: () -> void

A wrapper class to use a StringIO object as the body and switch to a TempFile when the passed threshold is passed. Initialize the data from the query.

Handles multipart forms (in particular, forms that involve file uploads). Reads query parameters in the @params field, and cookies into @cookies.

key?

(String key) → bool

Alias for: has_key?

keys

() → Array[String]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 753
def keys: () -> Array[String]

Return all query parameter names as an array of String.

multipart?

() → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 761
def multipart?: () -> bool

Returns whether the form contained multipart/form-data

negotiate

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 763
def negotiate: () -> String?

params

() → Hash[String, Array[String] | Tempfile | StringIO]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 768
def params: () -> Hash[String, Array[String] | Tempfile | StringIO]

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

params=

(Hash[String, Array[String] | Tempfile | StringIO] hash) → Hash[String, Array[String] | Tempfile | StringIO]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 776
def params=: (Hash[String, Array[String] | Tempfile | StringIO] hash) -> Hash[String, Array[String] | Tempfile | StringIO]

Set all the parameters.

path_info

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 778
def path_info: () -> String?

path_translated

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 780
def path_translated: () -> String?

pragma

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 782
def pragma: () -> String?

query_string

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 784
def query_string: () -> String?

raw_cookie

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 792
def raw_cookie: () -> String?

Get the raw cookies as a string.

raw_cookie2

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 800
def raw_cookie2: () -> String?

Get the raw RFC2965 cookies as a string.

read_from_cmdline

() → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 848
def read_from_cmdline: () -> String

offline mode. read name=value pairs on standard input.

read_multipart

(String boundary, Integer content_length) → (Tempfile | StringIO)

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 862
def read_multipart: (String boundary, Integer content_length) -> (Tempfile | StringIO)

Parses multipart form elements according to www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2

Returns a hash of multipart form parameters with bodies of type StringIO or Tempfile depending on whether the multipart form element exceeds 10 KB

params[name => body]

referer

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 802
def referer: () -> String?

remote_addr

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 804
def remote_addr: () -> String?

remote_host

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 806
def remote_host: () -> String?

remote_ident

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 808
def remote_ident: () -> String?

remote_user

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 810
def remote_user: () -> String?

request_method

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 812
def request_method: () -> String?

script_name

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 814
def script_name: () -> String?

server_name

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 816
def server_name: () -> String?

server_port

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 818
def server_port: () -> String?

server_protocol

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 820
def server_protocol: () -> String?

server_software

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 822
def server_software: () -> String?

unescape_filename?

() → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 824
def unescape_filename?: () -> bool

user_agent

() → String?

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/cgi/0/core.rbs, line 826
def user_agent: () -> String?