https://github.com/mnavarrocarter/problem-details
A framework agnostic RFC7807 implementation
https://github.com/mnavarrocarter/problem-details
api error-handling exception-handling exceptions php php7 problem-details rest rest-api rfc7807
Last synced: about 2 months ago
JSON representation
A framework agnostic RFC7807 implementation
- Host: GitHub
- URL: https://github.com/mnavarrocarter/problem-details
- Owner: mnavarrocarter
- Created: 2018-04-04T14:36:18.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-04T15:30:53.000Z (about 7 years ago)
- Last Synced: 2025-03-07T03:34:07.317Z (about 2 months ago)
- Topics: api, error-handling, exception-handling, exceptions, php, php7, problem-details, rest, rest-api, rfc7807
- Language: PHP
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ApiException (RFC7807 Implementation)
=====================================
ApiException is an **abstract exception class for php** that implements the
[RFC7807](https://tools.ietf.org/html/rfc7807) problem details structure.
It is ment to be extended into other exception classes that define specific error
types, according to the RFC.
### Installing
Simply do:
composer require mnavarrocarter/problem-details
## Usage
### Creating your custom Exception Types
For the different problem types in your api, you must create meaningful exception
classes that will extend this abstract one, and override the constructor to set
your custom type, title and, if you want, status code.
```php
areValidCredentials($sentCredentials)) {
return $this->findUser($sentCredentials);
}
throw AuthenticationProblemException::invalidCredentials($sentCredentials);
}
}
```
Then, at your controller level, you can catch these exceptions to provide a response.
Or, if you use frameworks like Symfony, you can configure an Exception Listener.
```php
tryAction($request);
} catch (ApiException $e) {
return $this->json($e, $e->getStatusCode());
}
return $variable;
}
}
```
If you noticed, the ApiException implements PHP's `\JsonSerializable` interface. So
it is easily serialized with a simple `json_encode()`. If you want to just normalize
the object, you can call the `toArray()` method.
### Modifiying the implementation
tldr; You can't. You can implement the interface though.
This implementation is very closed. Property visibility is hidden from you,
and you can only interact with the properties via the public methods.
Also, the implementation methods are declared final, so you can't override them.
This will protect you from breaking anything, as this class is developed to always
provide a meaningful response by checking stuff in getters and setters.
The interface is there in case you want to create your own implementation.