New! TypeRocket v5 is now available. See docs.
Access all of Typerocket. Get Pro.
Responses
( v4 )
- # Make Response
- # Set Message
- # Flash Next
- # Flash Now
- # Exit Any
- # Exit JSON
- # Exit Message
- # Exit Not Found
- # With Fields
The Response
object has several methods for working with the HTTP response.
Make Response
$response = new \TypeRocket\Http\Response();
Set Message
To set the JSON API response message use the setMessage()
method.
$response->setMessage('Message');
Flash Next
To flash a message on the next request in the admin use the flashNext()
method. This is useful when a controller or page redirects.
$response->flashNext('Message');
Flash Now
To flash a message on the current request in the admin use the flashNow()
method.
$response->flashNow('Message');
Exit Any
To exit right away on any request, JSON API or normal request, use the exitAny()
method.
$response->exitAny( 404 );
Exit JSON
To exit right away during a JSON API request use the exitAny()
method.
$response->exitJson( 500 );
Exit Message
To exit right away during a normal request use the exitMessage()
method.
$response->exitMessage( 500 );
Exit Not Found
To exit with 404
.
$response->exitNotFound();
With Fields
To respond with fields use the withFields()
method.
$response->withFields( ['field_name' => 'The field value'] );
Found a typo? Something is wrong in this documentation? Fork and edit it!