Overview

Namespaces

  • Peach
    • DF
    • DT
    • Http
      • Body
      • Header
    • Markup
    • Util

Classes

  • Body
  • DefaultEndpoint
  • Request
  • Response
  • Util

Interfaces

  • BodyRenderer
  • Endpoint
  • HeaderField
  • MultiHeaderField
  • SingleHeaderField
  • Overview
  • Namespace
  • Class

Class Request

HTTP リクエストをあらわすクラスです.

Namespace: Peach\Http
Located at Peach/Http/Request.php
Methods summary
public
# __construct( )

空の Request インスタンスを構築します.

空の Request インスタンスを構築します.

public
# setPath( string $path )

この Request のパス (URL のうち, クエリ・フラグメントを除いた部分) を設定します.

この Request のパス (URL のうち, クエリ・フラグメントを除いた部分) を設定します.

Parameters

$path
セットするパス
public string
# getPath( )

この Request のパス (URL のうち, クエリ・フラグメントを除いた部分) を返します.

この Request のパス (URL のうち, クエリ・フラグメントを除いた部分) を返します.

Returns

string
この Request のパス
public Peach\Http\HeaderField
# getHeader( string $name )

指定された名前のヘッダーを取得します. 存在しない場合は NoField オブジェクトを返します.

指定された名前のヘッダーを取得します. 存在しない場合は NoField オブジェクトを返します.

Parameters

$name
ヘッダー名

Returns

Peach\Http\HeaderField
指定されたヘッダーに該当する HeaderField オブジェクト
public Peach\Http\HeaderField[]
# getHeaderList( )

この Request が持つヘッダーの一覧を取得します.

この Request が持つヘッダーの一覧を取得します.

Returns

Peach\Http\HeaderField[]
この Request に定義されている HeaderField のリスト
public
# setHeader( Peach\Http\HeaderField $item )

指定されたヘッダーをこの Request に設定します.

指定されたヘッダーをこの Request に設定します.

Parameters

$item
public boolean
# hasHeader( string $name )

指定された名前の HeaderField が存在するかどうか調べます.

指定された名前の HeaderField が存在するかどうか調べます.

Parameters

$name
ヘッダー名

Returns

boolean
指定された名前の HeaderField が存在する場合のみ true
public
# setQuery( array|Peach\Util\ArrayMap $params )

指定された値を GET パラメータとしてセットします. 引数には配列または ArrayMap オブジェクトを指定することができます. 配列または ArrayMap のキーをパラメータ名, 値をそのパラメータの値とします.

指定された値を GET パラメータとしてセットします. 引数には配列または ArrayMap オブジェクトを指定することができます. 配列または ArrayMap のキーをパラメータ名, 値をそのパラメータの値とします.

Parameters

$params
public string|array
# getQuery( string $name, string|array $defaultValue = null )

指定された名前の GET パラメータを返します. 第 2 引数に, そのパラメータが存在しなかった場合に返される代替値を指定することができます. 第 2 引数を指定しない場合は null を返します.

指定された名前の GET パラメータを返します. 第 2 引数に, そのパラメータが存在しなかった場合に返される代替値を指定することができます. 第 2 引数を指定しない場合は null を返します.

Parameters

$name
パラメータ名
$defaultValue
そのパラメータが存在しない場合の代替値. 未指定の場合は null

Returns

string|array
パラメータの値
public
# setPost( array|Peach\Util\ArrayMap $params )

指定された値を POST パラメータとしてセットします. 引数には配列または ArrayMap オブジェクトを指定することができます. 配列または ArrayMap のキーをパラメータ名, 値をそのパラメータの値とします.

指定された値を POST パラメータとしてセットします. 引数には配列または ArrayMap オブジェクトを指定することができます. 配列または ArrayMap のキーをパラメータ名, 値をそのパラメータの値とします.

Parameters

$params
public string|array
# getPost( string $name, string|array $defaultValue = null )

指定された名前の POST パラメータを返します. 第 2 引数に, そのパラメータが存在しなかった場合に返される代替値を指定することができます. 第 2 引数を指定しない場合は null を返します.

指定された名前の POST パラメータを返します. 第 2 引数に, そのパラメータが存在しなかった場合に返される代替値を指定することができます. 第 2 引数を指定しない場合は null を返します.

Parameters

$name
パラメータ名
$defaultValue
そのパラメータが存在しない場合の代替値. 未指定の場合は null

Returns

string|array
パラメータの値
public boolean
# isMalformed( )

この Request が malformed (不正な形式) かどうかを判断します. 以下に挙げるヘッダーのうち, 1 つでも欠けているものがあった場合に malformed と判定します.

この Request が malformed (不正な形式) かどうかを判断します. 以下に挙げるヘッダーのうち, 1 つでも欠けているものがあった場合に malformed と判定します.

  • :method
  • :scheme
  • :path
  • :authority (または Host)

Returns

boolean
この Request が malformed と判定された場合のみ true
PEACH2 API documentation generated by ApiGen