php8.5
Home/ Manual/ yaf / yaf_request_abstract/ Yaf_Request_Abstract::clearParams

Yaf_Request_Abstract::clearParams

PHP function Edit on GitHub ✎

(Yaf >=3.2.0)

Remove all parameters

Description

Yaf_Request_Abstract::clearParams(): Yaf_Request_Abstract|null

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

Parameters Parameters

Return Values

Returns the request object itself.

Examples

Yaf_Request_Abstract::clearParams example

php
<?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"));
    }
}
?>

The above example will output something similar to:

output
string(10) "newsletter"
NULL

See Also

  • Yaf_Request_Abstract::setParam
  • Yaf_Request_Abstract::getParam
  • Yaf_Request_Abstract::getParams

Source: reference/yaf/yaf_request_abstract/clearparams.xml · from the official PHP manual (php/doc-en)