File: README.md

Recommend this page to a friend!
  Classes of Josantonius  >  PHP Error Handler  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP Error Handler
Register handler for PHP errors and exceptions
Author: By
Last change: Update README files
Updated to 1.1.8 version
Updated to 1.1.8 version
Date: 2 years ago
Size: 6,335 bytes
 

Contents

Download

PHP ErrorHandler library

Latest Stable Version Latest Unstable Version License Codacy Badge Total Downloads Travis PSR2 PSR4 CodeCov

Versión en español

PHP library for handling exceptions and errors.

Requirements

This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.

Installation

The preferred way to install this extension is through Composer.

To install PHP ErrorHandler library, simply:

$ composer require Josantonius/ErrorHandler

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require Josantonius/ErrorHandler --prefer-source

You can also clone the complete repository with Git:

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

Or install it manually:

Download ErrorHandler.php:

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

Available Methods

Available methods in this library:

- Set customs methods to renderizate:

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

| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $class | Class name or class object. | callable | Yes | | | $method | Method name. | string| Yes | | | $repeat | Number of times to repeat method. | int | No | 0 | | $default | Show default view. | boolean | No | false |

# Return (void)

Quick Start

To use this class with Composer:

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

use Josantonius\ErrorHandler\ErrorHandler;

Or If you installed it manually, use it:

require_once __DIR__ . '/ErrorHandler.php';

use Josantonius\ErrorHandler\ErrorHandler;

Usage

Example of use for this library:

/ 
 It is recommended to instantiate the class in a base file as the index.php/

new ErrorHandler;

/
 * Optionally you can enter one or more methods to be executed instead the 
 * default view. The indicated method will receive an array with the
 * following parameters:
 *
 * [
 *  'type'      => 'Error|Exception',
 *  'message'   => 'exception|error message',
 *  'file'      => 'exception|error file',
 *  'line '     => 'exception|error line',
 *  'code'      => 'exception|error code',
 *  'http-code' => 'HTTP response status code',
 *  'mode'      => 'PHP|HHVM',
 * ];
 * 
 */
 
$class   = $this;
$method  = 'customMethodResponse';
$times   = 0;
$default = true;

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

Tests

To run tests you just need composer and to execute the following:

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

$ cd PHP-ErrorHandler

$ composer install

Run unit tests with PHPUnit:

$ composer phpunit

Run PSR2 code standard tests with PHPCS:

$ composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

$ composer phpmd

Run all previous tests:

$ composer tests

Images

image image image image

? TODO

  • [ ] Add new feature.
  • [ ] Improve tests.
  • [ ] Improve documentation.
  • [ ] Refactor code for disabled code style rules. See phpmd.xml and .php_cs.dist.

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

  • Fork and clone.
  • Run the command `composer install` to install the dependencies. This will also install the dev dependencies.
  • Run the command `composer fix` to excute code standard fixers.
  • Run the tests.
  • Create a branch, commit, push and send me a pull request.

Repository

The file structure from this repository was created with PHP-Skeleton.

License

This project is licensed under MIT license. See the LICENSE file for more info.

Copyright

2016 - 2018 Josantonius, josantonius.com

If you find it useful, let me know :wink:

You can contact me on Twitter or through my email.


For more information send a message to info at phpclasses dot org.