PHP ErrorHandler library

English version

Biblioteca PHP para manejar excepciones y errores.

• Instalación
• Requisitos
• Cómo empezar y ejemplos
• Métodos disponibles
• Uso
• Tests
• Imágenes
• Tareas pendientes
• Contribuir
• Repositorio
• Licencia
• Copyright

Requisitos

Esta clase es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.

Instalación

La mejor forma de instalar esta extensión es a través de Composer.

Para instalar PHP ErrorHandler library, simplemente escribe:

$ composer require Josantonius/ErrorHandler

El comando anterior sólo instalará los archivos necesarios, si prefieres descargar todo el código fuente puedes utilizar:

$ composer require Josantonius/ErrorHandler --prefer-source

También puedes clonar el repositorio completo con Git:

$ git clone https://github.com/Josantonius/PHP-ErrorHandler.git

O instalarlo manualmente:

Descargar ErrorHandler.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-ErrorHandler/master/src/ErrorHandler.php

Métodos disponibles

Métodos disponibles en esta biblioteca:

- Set customs methods to renderizate:

ErrorHandler::setCustomMethod($class, $method, $repeat, $default);

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $class | Nombre de la clase u objeto. | callable | Yes | | | $method | Nombre del método. | string | Yes | | | $repeat | Número de veces que repetir el método en caso de múltiples errores. | int | No | 0 | | $default | Mostrar vista por defecto. | boolean | No | false |

# Return (void)

Cómo empezar

Para utilizar esta clase con Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\ErrorHandler\ErrorHandler;

Si la instalaste manualmente, utiliza:

require_once __DIR__ . '/ErrorHandler.php';

use Josantonius\ErrorHandler\ErrorHandler;

Uso

Ejemplo de uso para esta biblioteca:

/Se recomienda intanciar la clase en un archivo base como el index.php/

new ErrorHandler;

/
 * Opcionalmente puedes introducir uno o más métodos para ejecutar en lugar de
 * la vista predeterminada. El método indicado recibirá un array con los
 * siguientes parámetros:
 *
 * [
 * 	'type'      => 'Error|Exception',
 *	'message'   => 'exception|error mensaje',
 *	'file'      => 'exception|error archivo',
 *	'line '     => 'exception|error línea',
 *	'code'      => 'exception|error código de error',
 *	'http-code' => 'Código de estado de respuesta HTTP',
 *	'mode'      => 'PHP|HHVM',
 * ];
 * 
 */

$class   = $this;
$method  = 'customMethodResponse';
$times   = 0;
$default = true;

ErrorHandler::SetCustomMethod($class, $method, $times, $default);

Tests

Para ejecutar las pruebas necesitarás Composer y seguir los siguientes pasos:

$ git clone https://github.com/Josantonius/PHP-ErrorHandler.git

$ cd PHP-ErrorHandler

$ composer install

Ejecutar pruebas unitarias con PHPUnit:

$ composer phpunit

Ejecutar pruebas de estándares de código PSR2 con PHPCS:

$ composer phpcs

Ejecutar pruebas con PHP Mess Detector para detectar inconsistencias en el estilo de codificación:

$ composer phpmd

Ejecutar todas las pruebas anteriores:

$ composer tests

Imágenes

? Tareas pendientes

• [ ] Añadir nueva funcionalidad.
• [ ] Mejorar pruebas.
• [ ] Mejorar documentación.
• [ ] Refactorizar código para las reglas de estilo de código deshabilitadas. Ver phpmd.xml y .php_cs.dist.

Contribuir

Si deseas colaborar, puedes echar un vistazo a la lista de issues o tareas pendientes.

Pull requests

• Fork and clone.
• Ejecuta el comando `composer install` para instalar dependencias. Esto también instalará las dependencias de desarrollo.
• Ejecuta el comando `composer fix` para estandarizar el código.
• Ejecuta las pruebas.
• Crea una nueva rama (branch), commit, push y envíame un pull request.

Repositorio

La estructura de archivos de este repositorio se creó con PHP-Skeleton.

Licencia

Este proyecto está licenciado bajo licencia MIT. Consulta el archivo LICENSE para más información.

Copyright

2016 - 2018 Josantonius, josantonius.com

Si te ha resultado útil, házmelo saber :wink:

Puedes contactarme en Twitter o a través de mi correo electrónico.