casa-publicadora-brasileira/portal-utils

Ferramentas genéricas do Portal da Educação da CPB

1.3.11 2024-04-10 12:45 UTC

Requires

• php: >=7.4

Requires (Dev)

• aws/aws-sdk-php: *
• laravel/framework: ^8.75
• phpunit/phpunit: ^9.6
• sentry/sentry-laravel: ^3.1
• tymon/jwt-auth: ^1.0

MIT

• Josué Oliveira

• library
• response
• utils
• CPB
• Portal da educação

README

Ferramentas genéricas do Portal da Educação da CPB

Requisitos

• Laravel >=7.30
• PHP >=7.4

Instalação

composer require casa-publicadora-brasileira/portal-utils

Classes

• Response

Enums

• HttpCodesEnum
• ResponseEnum

Exemplos

Response

Essa biblioteca conta com três métodos públicos de resposta de API.

Sucesso: Tendo como todos os parâmetros opcionais.

<?php

use CasaPublicadoraBrasileira\PortalUtils\HTTP\Response;

return Response::success('Sucesso ao buscar os dados', ['id' => 1, 'name' => 'Teste']);

Erro: Tendo como todos os parâmetros opcionais.

<?php

use CasaPublicadoraBrasileira\PortalUtils\HTTP\Response;

catch (Exception $e) {
    return Response::error('Erro ao buscar os dados', $e);
}

Warning: Tendo como todos os parâmetros opcionais.

<?php

use CasaPublicadoraBrasileira\PortalUtils\HTTP\Response;

return Response::warning('E-mail já cadastrado', ['email' => '[e-mail]'], [], 200);