module CGI::QueryExtension (Ruby 3.1 リファレンスマニュアル)

要約

クエリ文字列を扱うためのメソッドを定義しているモジュールです。

インスタンスメソッド

self[key] -> Array[permalink][rdoc][edit]

文字列 key に対応するパラメータを配列で返します。 key に対応するパラメータが見つからなかった場合は、nil を返します。（CGI#paramsと等価です）

フォームから入力された値や、URL に埋め込まれた QUERY_STRING のパース結果の取得などに使用します。

[PARAM] key:: キーを文字列で指定します。

accept -> String[permalink][rdoc][edit]

ENV['HTTP_ACCEPT'] を返します。

accept_charset -> String[permalink][rdoc][edit]

ENV['HTTP_ACCEPT_CHARSET'] を返します。

accept_encoding -> String[permalink][rdoc][edit]

ENV['HTTP_ACCEPT_ENCODING'] を返します。

accept_language -> String[permalink][rdoc][edit]

ENV['HTTP_ACCEPT_LANGUAGE'] を返します。

auth_type -> String[permalink][rdoc][edit]

ENV['AUTH_TYPE'] を返します。

cache_control -> String[permalink][rdoc][edit]

ENV['HTTP_CACHE_CONTROL'] を返します。

content_length -> Integer[permalink][rdoc][edit]

ENV['CONTENT_LENGTH'] を返します。

content_type -> String[permalink][rdoc][edit]

ENV['CONTENT_TYPE'] を返します。

cookies -> Hash[permalink][rdoc][edit]

クッキーの名前と値をペアにした要素を持つハッシュを返します。

cookies=(value)[permalink][rdoc][edit]

クッキーをセットします。

[PARAM] value:: クッキーの名前と値をペアにした要素を持つハッシュを指定します。

create_body(is_large) -> StringIO | Tempfile[permalink][rdoc][edit]

files -> Hash[permalink][rdoc][edit]

アップロードされたファイルの名前とその内容を表すオブジェクトをペアとする要素を持つハッシュを返します。

from -> String[permalink][rdoc][edit]

ENV['HTTP_FROM'] を返します。

gateway_interface -> String[permalink][rdoc][edit]

ENV['GATEWAY_INTERFACE'] を返します。

has_key?(*args) -> bool[permalink][rdoc][edit]

key?(*args) -> bool

include?(*args) -> bool

与えられたキーがクエリに含まれている場合は、真を返します。そうでない場合は、偽を返します。

[PARAM] args:: キーを一つ以上指定します。

host -> String[permalink][rdoc][edit]

ENV['HTTP_HOST'] を返します。

keys(*args) -> [String][permalink][rdoc][edit]

すべてのパラメータのキーを配列として返します。

multipart? -> bool[permalink][rdoc][edit]

マルチパートフォームの場合は、真を返します。そうでない場合は、偽を返します。

例：
cgi = CGI.new
if cgi.multipart?
  field1=cgi['field1'].read
else
  field1=cgi['field1']
end

negotiate -> String[permalink][rdoc][edit]

ENV['HTTP_NEGOTIATE'] を返します。

params -> Hash[permalink][rdoc][edit]

パラメータを格納したハッシュを返します。

フォームから入力された値や、URLに埋め込まれた QUERY_STRING のパース結果の取得などに使用します。

cgi = CGI.new
cgi.params['developer']     # => ["Matz"] (Array)
cgi.params['developer'][0]  # => "Matz"
cgi.params['']              # => nil

params=(hash)[permalink][rdoc][edit]

与えられたハッシュをパラメータにセットします。

[PARAM] hash:: ハッシュを指定します。

path_info -> String[permalink][rdoc][edit]

ENV['PATH_INFO'] を返します。

path_translated -> String[permalink][rdoc][edit]

ENV['PATH_TRANSLATED'] を返します。

pragma -> String[permalink][rdoc][edit]

ENV['HTTP_PRAGMA'] を返します。

query_string -> String[permalink][rdoc][edit]

ENV['QUERY_STRING'] を返します。

raw_cookie -> String[permalink][rdoc][edit]

ENV["HTTP_COOKIE"] を返します。

raw_cookie2 -> String[permalink][rdoc][edit]

ENV["HTTP_COOKIE2"] を返します。

referer -> String[permalink][rdoc][edit]

ENV['HTTP_REFERER'] を返します。

remote_addr -> String[permalink][rdoc][edit]

ENV['REMOTE_ADDR'] を返します。

remote_host -> String[permalink][rdoc][edit]

ENV['REMOTE_HOST'] を返します。

remote_ident -> String[permalink][rdoc][edit]

ENV['REMOTE_IDENT'] を返します。

remote_user -> String[permalink][rdoc][edit]

ENV['REMOTE_USER'] を返します。

request_method -> String[permalink][rdoc][edit]

ENV['REQUEST_METHOD'] を返します。

script_name -> String[permalink][rdoc][edit]

ENV['SCRIPT_NAME'] を返します。

server_name -> String[permalink][rdoc][edit]

ENV['SERVER_NAME'] を返します。

server_port -> Integer[permalink][rdoc][edit]

ENV['SERVER_PORT'] を返します。

server_protocol -> String[permalink][rdoc][edit]

ENV['SERVER_PROTOCOL'] を返します。

server_software -> String[permalink][rdoc][edit]

ENV['SERVER_SOFTWARE'] を返します。

unescape_filename? -> bool[permalink][rdoc][edit]

user_agent -> String[permalink][rdoc][edit]

ENV['HTTP_USER_AGENT'] を返します。

要約

目次

インスタンスメソッド