--- !ruby/object:RI::MethodDescription
aliases: []
block_params:
comment:
- !ruby/struct:SM::Flow::P
body: Create an HTTP header block as a string.
- !ruby/struct:SM::Flow::P
body: Includes the empty line that ends the header block.
- !ruby/struct:SM::Flow::P
body: "<tt>options</tt> can be a string specifying the Content-Type (defaults to text/html), or a hash of header key/value pairs. The following header keys are recognized:"
- !ruby/object:SM::Flow::LIST
contents:
- !ruby/struct:SM::Flow::LI
label: "type:"
body: the Content-Type header. Defaults to "text/html"
- !ruby/struct:SM::Flow::LI
label: "charset:"
body: the charset of the body, appended to the Content-Type header.
- !ruby/struct:SM::Flow::LI
label: "nph:"
body: a boolean value. If true, prepend protocol string and status code, and date; and sets default values for "server" and "connection" if not explicitly set.
- !ruby/struct:SM::Flow::LI
label: "status:"
body: the HTTP status code, returned as the Status header. See the list of available status codes below.
- !ruby/struct:SM::Flow::LI
label: "server:"
body: the server software, returned as the Server header.
- !ruby/struct:SM::Flow::LI
label: "connection:"
body: the connection type, returned as the Connection header (for instance, "close".
- !ruby/struct:SM::Flow::LI
label: "length:"
body: the length of the content that will be sent, returned as the Content-Length header.
- !ruby/struct:SM::Flow::LI
label: "language:"
body: the language of the content, returned as the Content-Language header.
- !ruby/struct:SM::Flow::LI
label: "expires:"
body: the time on which the current content expires, as a <tt>Time</tt> object, returned as the Expires header.
- !ruby/struct:SM::Flow::LI
label: "cookie:"
body: a cookie or cookies, returned as one or more Set-Cookie headers. The value can be the literal string of the cookie; a CGI::Cookie object; an Array of literal cookie strings or Cookie objects; or a hash all of whose values are literal cookie strings or Cookie objects. These cookies are in addition to the cookies held in the @output_cookies field.
type: :NOTE
- !ruby/struct:SM::Flow::P
body: "Other header lines can also be set; they are appended as key: value."
- !ruby/struct:SM::Flow::VERB
body: " header\n # Content-Type: text/html\n\n header("text/plain")\n # Content-Type: text/plain\n\n header("nph" => true,\n "status" => "OK", # == "200 OK"\n # "status" => "200 GOOD",\n "server" => ENV['SERVER_SOFTWARE'],\n "connection" => "close",\n "type" => "text/html",\n "charset" => "iso-2022-jp",\n # Content-Type: text/html; charset=iso-2022-jp\n "length" => 103,\n "language" => "ja",\n "expires" => Time.now + 30,\n "cookie" => [cookie1, cookie2],\n "my_header1" => "my_value"\n "my_header2" => "my_value")\n"
- !ruby/struct:SM::Flow::P
body: "The status codes are:"
- !ruby/struct:SM::Flow::VERB
body: " "OK" --> "200 OK"\n "PARTIAL_CONTENT" --> "206 Partial Content"\n "MULTIPLE_CHOICES" --> "300 Multiple Choices"\n "MOVED" --> "301 Moved Permanently"\n "REDIRECT" --> "302 Found"\n "NOT_MODIFIED" --> "304 Not Modified"\n "BAD_REQUEST" --> "400 Bad Request"\n "AUTH_REQUIRED" --> "401 Authorization Required"\n "FORBIDDEN" --> "403 Forbidden"\n "NOT_FOUND" --> "404 Not Found"\n "METHOD_NOT_ALLOWED" --> "405 Method Not Allowed"\n "NOT_ACCEPTABLE" --> "406 Not Acceptable"\n "LENGTH_REQUIRED" --> "411 Length Required"\n "PRECONDITION_FAILED" --> "412 Precondition Failed"\n "SERVER_ERROR" --> "500 Internal Server Error"\n "NOT_IMPLEMENTED" --> "501 Method Not Implemented"\n "BAD_GATEWAY" --> "502 Bad Gateway"\n "VARIANT_ALSO_VARIES" --> "506 Variant Also Negotiates"\n"
- !ruby/struct:SM::Flow::P
body: This method does not perform charset conversion.
full_name: CGI#header
is_singleton: false
name: header
params: (options = "text/html")
visibility: public
