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

Yaf_Request_Abstract::getParam

PHP function Edit on GitHub ✎

(Yaf >=1.0.0)

Retrieve a parameter

Description

Yaf_Request_Abstract::getParam(string $name, [mixed $default]): mixed

Retrieves a parameter (a named routing/action parameter) from the request.

Parameters

name

The parameter name.

default

The value to return if the parameter is not set.

Return Values

The parameter value, or default if it was provided, null otherwise.

Examples

Yaf_Request_Abstract::getParam example

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

        // Assuming the request is /product/view/id/17
        $id       = (int) $request->getParam("id");
        $referrer = $request->getParam("referrer", "direct");

        var_dump($id, $referrer);
    }
}
?>

The above example will output something similar to:

output
int(17)
string(6) "direct"

See Also

  • Yaf_Request_Abstract::setParam
  • Yaf_Request_Abstract::getParams
  • Yaf_Request_Abstract::clearParams
  • Yaf_Request_Abstract::get

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