CODEWITHSUNDEEP
phpzend-frameworkzend-framework2zend-rest
Geek
Geek

Reputation: 8320

Zend framework 2 REST API : set Request parameters

I am new to PHP frameworks and building REST API on Zend Framework 2. I want to add params to Request. I could not find method to add params so I'll do it by getting all params then, adding new params to them and then setting this new set of params to Request. I get params using

$this->params()->fromQuery()

but, I don't find any way to set params back to Request. Is there any method available for this?

EDIT : I tried below. Which is not giving desired result.

In Module.php : 

public function onBootstrap(\Zend\Mvc\MvcEvent $e)
{
    $em = $e->getApplication()->getEventManager();
    echo "Outside";

    $em->attach (MvcEvent::EVENT_DISPATCH, function(MvcEvent $e) {

        echo "Inside";
        $routeMatch = $e->getRouteMatch();
        $routeMatch->setParam("myParam", "paramValue");        
    });
}

In my controller :

echo "myParam : " . $this->params()->fromQuery('myParam');

Param value is null when I get it. This is on account of controller code is executed first(where I get param value) and then the Dispatch event is triggered(where I add param to RouteMatch).

Outside
myParam : 
Inside

Upvotes: 4

Views: 2869

Answers (3)

Carlos Robles
Carlos Robles

Reputation: 10947

Probably you don't need to add params to the request, and you can achieve the same adding params to the routeMatch (this is, the object tha represents the route that the current requests matches). I do this every now and then.

I use to do it in the Module.php, in the onBootstrap function. UPDATE: Attaching some code to the EVENT_ROUTE

public function onBootstrap(MvcEvent $e) {

 $em = $e->getApplication ()->getEventManager ();
 $em->attach ( MvcEvent::EVENT_ROUTE, function(MvcEvent $e) {

         $routeMatch   = $e->getRouteMatch();

         $params =  //your params, as an array

    foreach($params as $key => $value)  

       $routeMatch->setParam($k, $v);

    });
}

Upvotes: 3

BreyndotEchse
BreyndotEchse

Reputation: 2230

public function onBootstrap(MvcEvent $e)
{
    $em = $e->getApplication()->getEventManager();
    $em->attach(MvcEvent::EVENT_ROUTE, function(MvcEvent $e) {
        $request = $e->getRequest();
        $request->getQuery()->set('myParam', 'paramValue');
    });
}

Untestet, but this should work (play around with different MvcEvent constants if it does not).

See: https://github.com/zendframework/zf2/blob/release-2.2.5/library/Zend/Http/Request.php#L225 $request->getQuery() returns and object of \Zend\Stdlib\ParametersInterface (https://github.com/zendframework/zf2/blob/release-2.2.5/library/Zend/Stdlib/ParametersInterface.php)/ParametersInterface.php

Upvotes: 0

edigu
edigu

Reputation: 10099

Querystring parameters are just simple key-value pairs and they are properties of the Http Uri instance, not Request's itself directly. You can use the public api of the \Zend\Uri\Http instance which implements UriInterface to modify them.

For example, in your controller you can:

/**
 * @var \Zend\Uri\Http Implements UriInterface
 */
 $uri = $this->getRequest()->getUri();

 $params = $uri->getQueryAsArray();

 // Remove a parameter by name
 unset($params['baz']);

 // Add a key-value pair
 $params['foo'] = 'bar';

 $uri->setQuery($params);

But this may not a good practice if we talking about a REST api. There are multiple ways to interact with qs parameters, params() is just a controller plugin and makes our lives easier.

Upvotes: 0

Related Questions