Naify\Psr\Contract\RequestInterface インターフェース

implements Naify\Psr\Contract\MessageInterface

リクエストインターフェース — PSR-7 RequestInterface 相当

HTTP メソッド、リクエストターゲット、URI を扱う。 Browser 由来の詳細までは持たず、純粋に HTTP request の形を表現する。

使用例

$request = $request
    ->withMethod('POST')
    ->withRequestTarget('/posts/42?preview=1');

メソッド

メソッド説明
public getRequestTarget(): string リクエストターゲット (パス + クエリ) を返す
public withRequestTarget(string $requestTarget): static リクエストターゲットを差し替えた新インスタンスを返す
public getMethod(): string HTTP メソッド (GET, POST 等) を返す
public withMethod(string $method): static HTTP メソッドを差し替えた新インスタンスを返す
public getUri(): UriInterface リクエスト URI を返す
public withUri(UriInterface $uri, bool $preserveHost = false): static URI を差し替えた新インスタンスを返す

継承メソッド

メソッド説明継承元
public getProtocolVersion(): string HTTP プロトコルバージョンを返す MessageInterface
public withProtocolVersion(): static HTTP プロトコルバージョンを変更した新しいインスタンスを返す MessageInterface
public getHeaders(): array すべてのヘッダーを返す MessageInterface
public hasHeader(): bool 指定したヘッダーが存在するか判定する MessageInterface
public getHeader(): array 指定したヘッダーの値一覧を返す MessageInterface
public getHeaderLine(): string 指定したヘッダーを 1 行文字列として返す MessageInterface
public withHeader(): static ヘッダーを置き換えた新しいインスタンスを返す MessageInterface
public withAddedHeader(): static ヘッダー値を追加した新しいインスタンスを返す MessageInterface
public withoutHeader(): static 指定したヘッダーを除外した新しいインスタンスを返す MessageInterface
public getBody(): StreamInterface メッセージボディのストリームを返す MessageInterface
public withBody(): static メッセージボディを差し替えた新しいインスタンスを返す MessageInterface