README

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

Requisitos

• Laravel >=10.0
• PHP >=8.1

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' => 'teste@teste.com'], [], 200);