Download the PHP package kodeops/rro without Composer
On this page you can find all versions of the php package kodeops/rro. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package rro
rro | rich response object
Setup
Add composer package:
$ composer require kodeops/rro:dev-master
Copy function helpers to your project within your namespace (recommended, not mandatory):
https://raw.githubusercontent.com/kodeops/rro/master/src/helpers.php
Add rro-helpers.php
to composer.json
autoload section:
Usage
Assuming helper functions are loaded in composer.json
:
Checking status:
Additionaly, isError
and isSuccess
accepts two parameters for checking type
or message
content:
Or you can access independent whether it's an error
or response
:
Accessing response:
Methods
Building response
type(string $string)
Set the type for the response.
message(string $string)
Set the message for the response.
data(array $data)
Set the data for the response.
code(int $code)
Set the status code for the response.
trans(string $translation)
Uses the translation to set the type
and the translation itself is placed in the message
.
A valid translation path must be entered, if not it will throw an rroException
.
Check response status
isError()
Wether the response is an error.
isSuccess()
Wether the response is a success.
Accessing response details
response('type')
Get the response type.
response('message')
Get the response message.
response('data', $dot)
Get the response data array (uses dot syntax to retrieve specific key).
Example: response('data', 'user.id')
response('code')
Get the response code.
response('add', array $data)
Add more items to the data array (will be automatically merged to existing data).
response('is_type', $type)
Wether the response type equals to the parameter sent.
response('is_message', $message)
Wether the response message equals to the parameter sent.
Render response
HTML raw code toHtml()
Will output the message and type in HTML as follows:
So this snippet:
will produce:
If type
is not set, h3
tag will not be rendered.
Render to array toArray()
Render response to a simple array (otherwise responds with an instance of rro class).
So this snippet:
will produce:
For Laravel response toResponse()
Render response in Laravel way.