Yaf_Request_Abstract::clearParams

(Yaf >=3.2.0)

Yaf_Request_Abstract::clearParams — Remove all parameters

説明

public function Yaf_Request_Abstract::clearParams(): ?Yaf_Request_Abstract

Remove all parameters set by the router, or by Yaf_Request_Abstract::setParam().

パラメータ

この関数にはパラメータはありません。

戻り値

Returns the request object itself.

例

例1 Yaf_Request_Abstract::clearParams() example

<?php
class IndexController extends Yaf_Controller_Abstract
{
    public function indexAction()
    {
        $request = $this->getRequest();

        $request->setParam("referrer", "newsletter");
        var_dump($request->getParam("referrer"));

        $request->clearParams();
        var_dump($request->getParam("referrer"));
    }
}
?>

上の例の出力は、たとえば以下のようになります。

string(10) "newsletter"
NULL

参考

Yaf_Request_Abstract::setParam() - 呼び出しパラメータをリクエストに設定する
Yaf_Request_Abstract::getParam() - 呼び出しパラメータを取得する
Yaf_Request_Abstract::getParams() - 全ての呼び出しパラメータを取得する

関連キーワード:

Abstract Request request clearParams Remove parameters setParam referrer getParam newsletter dump router itself example IndexController extends Controller indexAction getRequest 参考リクエスト getParams