LocalHttpClientRequestHeader
extends HttpHeader
in package
要求時のヘッダー一覧。
Table of Contents
Properties
- $headers : CaseInsensitiveKeyArray
- ヘッダ一覧。
- $redirect : RedirectSetting|null
- リダイレクト設定。
Methods
- __construct() : mixed
- addValue() : void
- ヘッダに値を追加。
- clearHeader() : bool
- ヘッダの削除。
- clearRedirect() : bool
- リダイレクト設定を破棄。
- createClientRequestHeader() : HttpHeader
- HTTPクライアントリクエストヘッダの生成。
- existsContentType() : bool
- existsHeader() : bool
- ヘッダ名が存在するか。
- existsRedirect() : bool
- リダイレクト設定は存在するか。
- getClientResponseHeader() : HttpHeader
- getContentType() : ContentType
- getHeaderNames() : array<string|int, non-empty-string>
- ヘッダ名一覧を取得。
- getHeaders() : array<string, string>
- 現在のヘッダ一覧を取得。
- getRedirect() : RedirectSetting
- リダイレクト情報を取得。
- getRequestHeader() : HttpHeader
- リクエストヘッダの取得。
- getValues() : array<string|int, string>
- ヘッダの値を取得。
- setContentType() : void
- setRedirect() : void
- リダイレクト設定を割り当て。
- setValue() : void
- HTTPヘッダ設定
- setValues() : void
- ヘッダに値一覧を設定。
- throwIfInvalidHeaderName() : void
- HTTPヘッダ名が不正であれば例外を投げる。
Properties
$headers
ヘッダ一覧。
private
CaseInsensitiveKeyArray
$headers
リダイレクト(Location)とは共存しない。
Tags
$redirect
リダイレクト設定。
private
RedirectSetting|null
$redirect
= null
Methods
__construct()
public
__construct() : mixed
addValue()
ヘッダに値を追加。
public
addValue(non-empty-string $name, string $value) : void
Parameters
- $name : non-empty-string
-
ヘッダ名。
- $value : string
-
値。
Tags
clearHeader()
ヘッダの削除。
public
clearHeader(non-empty-string $name) : bool
Parameters
- $name : non-empty-string
-
ヘッダ名。
Return values
bool —削除できたか。
clearRedirect()
リダイレクト設定を破棄。
public
clearRedirect() : bool
Return values
bool —破棄したか。
createClientRequestHeader()
HTTPクライアントリクエストヘッダの生成。
public
static createClientRequestHeader() : HttpHeader
Return values
HttpHeaderexistsContentType()
public
existsContentType() : bool
Return values
boolexistsHeader()
ヘッダ名が存在するか。
public
existsHeader(non-empty-string $name) : bool
Parameters
- $name : non-empty-string
-
ヘッダ名。
Return values
boolexistsRedirect()
リダイレクト設定は存在するか。
public
existsRedirect() : bool
Return values
boolgetClientResponseHeader()
public
static getClientResponseHeader(Binary $responseHeader[, Encoding|null $encoding = null ]) : HttpHeader
Parameters
Return values
HttpHeadergetContentType()
public
getContentType() : ContentType
Return values
ContentTypegetHeaderNames()
ヘッダ名一覧を取得。
public
getHeaderNames() : array<string|int, non-empty-string>
Return values
array<string|int, non-empty-string>getHeaders()
現在のヘッダ一覧を取得。
public
getHeaders() : array<string, string>
同一名ヘッダは , でまとめられる。
Return values
array<string, string>getRedirect()
リダイレクト情報を取得。
public
getRedirect() : RedirectSetting
Return values
RedirectSettinggetRequestHeader()
リクエストヘッダの取得。
public
static getRequestHeader() : HttpHeader
Return values
HttpHeadergetValues()
ヘッダの値を取得。
public
getValues(non-empty-string $name) : array<string|int, string>
Parameters
- $name : non-empty-string
-
ヘッダ名。
Tags
Return values
array<string|int, string> —値一覧。
setContentType()
public
setContentType(ContentType $value) : void
Parameters
- $value : ContentType
setRedirect()
リダイレクト設定を割り当て。
public
setRedirect(Url $url, HttpStatus|null $status) : void
Parameters
- $url : Url
- $status : HttpStatus|null
setValue()
HTTPヘッダ設定
public
setValue(non-empty-string $name, string $value) : void
Parameters
- $name : non-empty-string
-
ヘッダ名。
- $value : string
-
値。
Tags
setValues()
ヘッダに値一覧を設定。
public
setValues(non-empty-string $name, array<string|int, string> $values) : void
Parameters
- $name : non-empty-string
-
ヘッダ名。
- $values : array<string|int, string>
-
値一覧。
Tags
throwIfInvalidHeaderName()
HTTPヘッダ名が不正であれば例外を投げる。
protected
throwIfInvalidHeaderName(string $name) : void
Parameters
- $name : string
-
ヘッダ名