Default paramater

Question

Default paramater

Brian Feb '18

Created Feb '18	Last Reply Mar '18	Replies 3	Views 259	Votes 1

Brian 3.7k

Feb '18

Hi,

In regards to routing controllers with defined parameters, is there a way to default a parameter to something if it was empty?

Suppose you have the following:

 $id  = $this->dispatcher->getParam('id');
 $page = $this->dispatcher->getParam('page');

which would then produce the result:

site.com/id/page

Assume afterwards, you were to do the following:

site.com/id

would there be a way to default the second parameter to let's say 1 if it was not defined? such as doing something like:

 $page = $this->dispatcher->getParam('id');

if (!$page) {
return $this->response->redirect("idhere/1");
}

Any help would be appreciated. Thanks in advance.

1

Emilio Degiovanni · Answer 1 · 2018-02-28T15:31:14-07:00

Hi @Brian you have to define 2 routes like this

$router->add('/{idParam:[0-9]+}/{pageParam:[a-z0-9-]+}', ['controller' => 'index', 'action' => 'index'])->setName('idAndPage');
$router->add('/{idParam:[0-9]+}', ['controller' => 'index', 'action' => 'index'])->setName('onlyId');

Routing docs

Brian · Answer 2 · 2018-02-28T16:08:23-07:00

Hi @Brian you have to define 2 routes like this

$router->add('/{idParam:[0-9]+}/{pageParam:[a-z0-9-]+}', ['controller' => 'index', 'action' => 'index'])->setName('idAndPage');
$router->add('/{idParam:[0-9]+}', ['controller' => 'index', 'action' => 'index'])->setName('onlyId');

Routing docs

I get that, but my issue is that the page I am talking about is a news system which requires both the ID and the page number to be specified in order to properly load the controller. I would like to know if there is a way to detect you're missing the page paramater and being able to default it to page 1 for example.

Emilio Degiovanni · Answer 3 · 2018-02-28T18:55:08-07:00

sure the getParam() method has 3 parameters dispatcher docs

name
filter name (optional) filter docs
default value (optional)

$page = $this->dispatcher->getParam('page', 'absint', false);

Good luck

Dylan Anderson · Answer 4 · 2018-03-02T13:54:29-07:00

Personally I don't use getParam(), opting for simple function parameters instead.

site.com/id/page will, by default, run the pageAction() method on the IdController class. So I'm assuming you've set up your routes to have that url point to a particular controller and action - let's say showAction()

You can absolutely do $page = $this->dispatcher->getParam('page', 'absint', false); as @emiliodeg suggested. Myself, I would just do this:


public function showAction($id=null,$page=1){
...
}