Interrupt FuelPHP REST controller flow and display response

Question

I am using FuelPHP's rest controller.

I am trying to break the flow and display my response after encountering an error.

Here is my basic flow needed:

When any of the methods are called I run a "validate" function, which validates parameters and other business logic.
If the "validate" function determines something is off, I want to stop the entire script and display the errors I have complied so far.

I have tried the following in my "validate" function but it simply exits the validate function... then continues to the initial method being requested. How do I stop the script immediately and display the contents of this response?

return $this->response( array(
        'error_count' => 2,
        'error' => $this->data['errors'] //an array of error messages/codes
    ) );

score 2 · Accepted Answer · answered Aug 31 '13 at 23:17

That is very bad practice. If you exit you not only abort the current controller, but also the rest of the framework flow.

Just validate in the action:

// do your validation, set a response and return if it failed
if ( ! $valid)
{
    $this->response( array(
        'error_count' => 2,
        'error' => $this->data['errors'] //an array of error messages/codes
    ), 400); //400 is an HTTP status code
    return;
}

Or if you want to do central validation (as opposed to in the controller action), use the router() method:

public function router($resource, $arguments)
{
    if ($this->valid_request($resource))
    {
        return parent::router($resource, $arguments);
    }
}

protected function valid_request($resource)
{
    // do your validation here, $resource tells you what was called
    // set $this->response like above if validation failed, and return false
    // if valid, return true
}

I have URL like this... http://localhost/confirm/user/codexyz. confirm is controller name user is username which is different codexyz is different for each user too. How to route it in controller? I try your code but arguments is just empty array. It should be array with username and codexyz in it. — vee, Dec 23 '13 at 15:40
That is just a URL. Assuming what is called is `Controller_Confirm::action_user()` (which this URL does if you don't route it), `codexyz` should be passed to it as an argument, if `action_user()` has one defined. — WanWizard, Dec 24 '13 at 18:35

score 0 · Answer 2 · answered Aug 04 '13 at 18:52

I am new to FuelPHP so if this method is bad practice, let me know.

If you want your REST controller to break the flow at some other point than when the requested method returns something, use this code. You can change the $this->response array to return whatever you want. The main part of the script is the $this->response->send() method and exit method.

    $this->response( array(
        'error_count' => 2,
        'error' => $this->data['errors'] //an array of error messages/codes
    ), 400); //400 is an HTTP status code

    //The send method sends the response body to the output buffer (i.e. it is echo'd out).
    //pass it TRUE to send any defined HTTP headers before sending the response body.

    $this->response->send(true);

    //kill the entire script so nothing is processed past this point.
    exit;

For more information on the send method, check out the FuelPHP documentation for the response class.

Yes, that is equally bad practice. The exit will cause the rest of the request not to be executed. Never use either exit or die() in FuelPHP code. — WanWizard, Dec 24 '13 at 18:34

Interrupt FuelPHP REST controller flow and display response

2 Answers2