2017 © Pedro Peláez
 

library vnderror

application/vnd.error builder / formatter for PHP 5.3+

image

ramsey/vnderror

application/vnd.error builder / formatter for PHP 5.3+

  • Monday, February 15, 2016
  • by ramsey
  • Repository
  • 2 Watchers
  • 17 Stars
  • 13,587 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 7 Forks
  • 1 Open issues
  • 5 Versions
  • 10 % Grown

The README.md

ramsey/vnderror

Build Status Coverage Status Latest Stable Version Total Downloads Latest Unstable Version License, (*1)

Ramsey\VndError is a PHP implementation of the vnd.error specification. This implementation currently targets the e88d5cd1ad revision of the specification., (*2)

From the vnd.error specification:, (*3)

vnd.error is a simple way of expressing an error response in XML or JSON., (*4)

Often when returning a response to a client a response type is needed to represent a problem to the user (human or otherwise). A media type representation is a convenient way of expressing the error in a standardised format and can be understood by many client applications., (*5)

Examples

Use application/vnd.error+json or application/vnd.error+xml media types to communicate errors with HTTP 4xx and 5xx status codes., (*6)

use Ramsey\VndError\VndError;

$vndError = new VndError('Validation failed', 42);
$vndError->addLink('help', 'http://.../', array('title' => 'Error Information'));
$vndError->addLink('describes', 'http://.../', array('title' => 'Error Description'));

JSON output (application/vnd.error+json):

header('Content-Type: application/vnd.error+json');
echo $vndError->asJson();

Results in:, (*7)

{
    "message": "Validation failed",
    "logref": 42,
    "_links": {
        "help": {
            "href": "http://.../",
            "title": "Error Information"
        },
        "describes": {
            "href": "http://.../",
            "title": "Error Description"
        }
    }
}

XML output (application/vnd.error+xml)

header('Content-Type: application/vnd.error+xml');
echo $vndError->asXml();

Results in:, (*8)

<?xml version="1.0"?>
<resource logref="42">
    <link rel="help" href="http://.../" title="Error Information"/>
    <link rel="describes" href="http://.../" title="Error Description"/>
    <message>Validation failed</message>
</resource>

Installation

The preferred method of installation is via Composer:, (*9)

php composer.phar require ramsey/vnderror

The Versions

15/02 2016

dev-master

9999999-dev https://github.com/ramsey/vnderror

application/vnd.error builder / formatter for PHP 5.3+

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ben Ramsey

json xml rest error hypermedia

15/02 2016

3.0.1

3.0.1.0 https://github.com/ramsey/vnderror

application/vnd.error builder / formatter for PHP 5.3+

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ben Ramsey

json xml rest error hypermedia

20/03 2015

3.0.0

3.0.0.0 https://github.com/ramsey/vnderror

application/vnd.error builder / formatter for PHP 5.3+

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ben Ramsey

json xml rest error hypermedia

27/02 2014

2.0.0

2.0.0.0 https://github.com/ramsey/vnderror

application/vnd.error builder / formatter for PHP 5.3+

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ben Ramsey

json xml rest error hypermedia

18/07 2012

1.0.0

1.0.0.0 https://github.com/ramsey/vnderror

application/vnd.error builder / formatter for PHP 5.3+

  Sources   Download

MIT

The Requires

  • php >=5.3.3

 

by Ben Ramsey

json xml rest error hypermedia