Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > cgi/coreライブラリ > CGI::QueryExtensionモジュール

module CGI::QueryExtension

クラスの継承リスト: CGI::QueryExtension

要約

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

インスタンスメソッド: [] accept accept_charset accept_encoding accept_language auth_type cache_control content_length content_type cookies cookies= create_body files from gateway_interface has_key? include? key? host keys multipart? negotiate params params= path_info path_translated pragma query_string raw_cookie raw_cookie2 referer remote_addr remote_host remote_ident remote_user request_method script_name server_name server_port server_protocol server_software unescape_filename? user_agent

インスタンスメソッド

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

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

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

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

accept -> String[permalink][rdoc]

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

accept_charset -> String[permalink][rdoc]

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

accept_encoding -> String[permalink][rdoc]

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

accept_language -> String[permalink][rdoc]

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

auth_type -> String[permalink][rdoc]

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

cache_control -> String[permalink][rdoc]

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

content_length -> Integer[permalink][rdoc]

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

content_type -> String[permalink][rdoc]

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

cookies -> Hash[permalink][rdoc]

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

cookies=(value)[permalink][rdoc]

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

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

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

files -> Hash[permalink][rdoc]

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

from -> String[permalink][rdoc]

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

gateway_interface -> String[permalink][rdoc]

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

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

key?(*args) -> bool

include?(*args) -> bool

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

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

host -> String[permalink][rdoc]

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

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

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

multipart? -> bool[permalink][rdoc]

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

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

negotiate -> String[permalink][rdoc]

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

params -> Hash[permalink][rdoc]

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

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

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

params=(hash)[permalink][rdoc]

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

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

path_info -> String[permalink][rdoc]

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

path_translated -> String[permalink][rdoc]

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

pragma -> String[permalink][rdoc]

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

query_string -> String[permalink][rdoc]

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

raw_cookie -> String[permalink][rdoc]

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

raw_cookie2 -> String[permalink][rdoc]

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

referer -> String[permalink][rdoc]

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

remote_addr -> String[permalink][rdoc]

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

remote_host -> String[permalink][rdoc]

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

remote_ident -> String[permalink][rdoc]

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

remote_user -> String[permalink][rdoc]

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

request_method -> String[permalink][rdoc]

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

script_name -> String[permalink][rdoc]

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

server_name -> String[permalink][rdoc]

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

server_port -> Integer[permalink][rdoc]

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

server_protocol -> String[permalink][rdoc]

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

server_software -> String[permalink][rdoc]

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

unescape_filename? -> bool[permalink][rdoc]

user_agent -> String[permalink][rdoc]

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

module CGI::QueryExtension

要約

目次

インスタンスメソッド