Yaf_Request_Abstract::setParam

(Yaf >=1.0.0)

Yaf_Request_Abstract::setParam — Set a parameter to the request

Description

public function Yaf_Request_Abstract::setParam(mixed $name, mixed $value = ?): Yaf_Request_Abstract|bool|null

Set a parameter to the request, which can be retrieved by Yaf_Request_Abstract::getParam().

If called with a single array argument, every key/value pair is set as a parameter.

Parameters

name

The parameter name, or an array of key/value pairs.

value

The parameter value. Required unless name is an array.

Return Values

Returns the request object itself on success, or false on failure.

Examples

Example #1 Yaf_Request_Abstract::setParam() example

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

        $request->setParam("referrer", "newsletter");
        $request->setParam(["source" => "email", "campaign" => "spring"]);

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

The above example will output something similar to:

string(10) "newsletter"
array(3) {
  ["referrer"]=>
  string(10) "newsletter"
  ["source"]=>
  string(5) "email"
  ["campaign"]=>
  string(6) "spring"
}

See Also

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug
＋add a note

User Contributed Notes

There are no user contributed notes for this page.