README

Português: Classe para retornar respostas para serviços web com um padrão comum definido
English: Class to return response to web services with a common pattern

EM PORTUGUÊS

Exemplo em PHP:

exemplo de sucesso

$response = new WebRespone();
$response->setSuccess(true); 
$response->setMessage('redirect');  
$response->addData('url-to-redirect', 'http://www.prsolucoes.com');
echo($response);

exemplo de erro na validação

$response = new WebRespone();
$response->setSuccess(false);
$response->setMessage('validate');
$response->addError('nome', 'O nome não pode ser vazio');
$response->addError('email', 'O email informado é inválido');
echo($response);

exemplo de erro comum

$response = new WebRespone();  
$response->setSuccess(false);
$response->setMessage('login-error');
echo($response);

para usar com o framework Yii2 + Composer, adicione as linhas abaixo dentro do array de configuração:

$config = [
    // ... outras configs ...
    'aliases' => [
        '@com/prsolucoes' => '@vendor/prsolucoes/web-response/php/source',
    ],
    // ... outras configs ...
];    

Repositório no Packagist: https://packagist.org/packages/prsolucoes/web-response

IN ENGLISH

PHP example:

success example

$response = new WebRespone();
$response->setSuccess(true); 
$response->setMessage('redirect');  
$response->addData('url-to-redirect', 'http://www.prsolucoes.com');
echo($response);

validation example

$response = new WebRespone();
$response->setSuccess(false);
$response->setMessage('validate');
$response->addError('name', 'The name cannot be empty');
$response->addError('email', 'The email is invalid');
echo($response);

simple erro example

$response = new WebRespone();  
$response->setSuccess(false);
$response->setMessage('login-error');
echo($response);

to use with framework Yii2, add these two lines in the configuration array:

$config = [
    // ... other configs ...
    'aliases' => [
        '@com/prsolucoes' => '@vendor/prsolucoes/web-response/php/source',
    ],
    // ... other configs ...
];    

Packagist repository: https://packagist.org/packages/prsolucoes/web-response

Result JSON format

{
    "success": false,
    "message": "register-failed",
    "data": {
        "errors": [
            "email": [
                "E-mail required",
                "E-mail invalid",
            ]
        ],
        "tag": "task-3414"
    }
}