PHP Classes

Mezon REST Exception: Exception class to use in REST APIs applications

Recommend this page to a friend!
     
  Info   Documentation   View files Files   Install with Composer Install with Composer   Download Download   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not enough user ratingsTotal: 65 All time: 10,397 This week: 206Up
Version License PHP version Categories
mezon-rest-exception 1.0.0MIT/X Consortium ...5HTTP, PHP 5, Language
Description 

Author

Alexey Dodonov

This package provides an exception class to use in REST APIs applications.

It extends the base PHP Exception class to take parameters with values about the current HTTP request in order to provide more context information about the conditions that may trigger an exception.

Besides the exception code and exception message that is expected by the base PHP Exception class, it can also take parameters for the HTTP status code, HTTP request body and request URL.

Innovation Award
PHP Programming Innovation award nominee
February 2021
Number 7		 Exceptions are special kind of class that is useful to pass details of errors that may happen within an application.

Usually exception classes carry information about the errors that includes an error message and an error code that can be useful to help applications to treat the errors in a a more convenient way for its users.

This package extends the information that is usually stored in an exception class. It adds details like the HTTP status code, request body and request URL, which may be useful for instance to generate error logs for applications that implement APIs.

Manuel Lemos
Picture of Alexey Dodonov
  Performance   Level  
Name: Alexey Dodonov <contact>
Classes: 58 packages by
Country: Russian Federation Russian Federation

Level 1 Star

 Innovation award
Innovation award
Nominee: 13x

Documentation

REST Exception Build Status codecov

Installation

Just type

composer require mezon/rest-exception

Usage

To use this class is very simple thing:

throw(new \Mezon\Rest\Exception(
	"", // message of the exception, like in the standard Exception class
	-1, // code of the exception, like in the standard Exception class
	200, // HTTP code of the request
	"<p>Warning!" // HTTP request body
));

  Files folder image Files (6)  
File Role Description
Files folder imageTests (1 file)
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Plain text file Exception.php Class Class source
Accessible without login Plain text file phpunit.xml Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files (6)  /  Tests  
File Role Description
  Plain text file RestExceptionUnitTest.php Class Class source

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.
Install with Composer Install with Composer
Downloadmezon-rest-exception-2020-10-23.zip 3KB
Downloadmezon-rest-exception-2020-10-23.tar.gz 2KB
Install with ComposerInstall with Composer
 Version Control Unique User Downloads Download Rankings  
 100%
Total:65
This week:0
All time:10,397
This week:206Up

  Applications that use this package  
No pages of applications that use this class were specified.

Add link image If you know an application of this package, send a message to the author to add a link here.