Download the PHP package constup-foss/php-exerr without Composer
On this page you can find all versions of the php package constup-foss/php-exerr. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package php-exerr
= constUP PHP Exerr :toc: :toclevels: 5
image:https://img.shields.io/badge/License-MIT-green[Static Badge] image:https://img.shields.io/packagist/dt/constup-foss/php-exerr[Packagist Downloads]
== Description
PHP Errors and exceptions.
This library contains a set of base exceptions with an expanded set of properties compared to PHP's default
\Exception. The idea is to provide standardized base exceptions that make controlling and debugging the application
easier.
== Installation
[source]
composer require constup-foss/php-exerr
== Available exceptions
=== abstract LibraryException
Intended to be used in composer libraries. The following properties are added to the base \Exception:
string $libraryName- Name of the library that threw the exception. Example: "constup-foss/php-exerr". Helps to identify the origin of the exception during debugging.?string $debugMessage- Debug message that can be used to identify the exact cause of the exception. This message should be used for logging purposes only and must not be displayed to the user. It should contain as much information as possible to help identify the exact cause of the exception.?string $userMessage- User-friendly message that can be displayed to the user. Must not contain sensitive information.?int $httpResponseCode- HTTP response code that should be passed as the response.?bool $recoverable- Indicates whether the exception is recoverable. Iftrue, the exception should be handled gracefully and the application should continue running. Iffalse, the exception should be handled and the application should terminate.
== Use
=== Extending a base exception
Here is an example of your own custom exception based on the LibraryException. Note that this example contains all
optional (nullable) properties, but you are free to omit them in your exceptions.
[source,php]
class YourCustomException extends LibraryException { /**
- Thrown when an item in the collection is not of the expected type.
- @param string $itemType
- @param string $expectedType
- @param int $index
-
@return $this */ public function invalidItemTypeAtIndex( string $itemType, string $expectedType, int $index, ): self { $this->message = 'Validation error'; $this->code = 1; $this->libraryName = 'your/library-name'; $this->debugMessage = "Invalid item type at index: {$index}. Expected: {$expectedType}. Got: {$itemType}"; $this->userMessage = 'You have provided invalid data. Please, try again.'; $this->httpResponseCode = 400; $this->recoverable = false;
return $this;} }
=== Throwing your exception
[source,php]
throw new YourCustomException()->invalidItemTypeAtIndex($itemType, $expectedType, $index);
=== Advantages of the above architecture
- Exceptions can be classified by their Interface. When an exception that implements
LibraryExceptionInterfaceis passed to an exception handler, the exception handler knows which properties to expect. - An exception handler can classify exceptions by their class (
YourCustomExceptionfrom the example above). - Having multiple exception methods in the same class brings the following benefits: Your exceptions can be classified by their domain. Managing of error codes is much easier. Each of your exceptions can have a possible range of codes. Exception codes that logically belong to the same range are not scattered across multiple files, making it easier to maintain and avoid conflicts.
== License
MIT License
- License file: link:LICENSE.txt[LICENSE.txt]
- Online version: https://opensource.org/license/mit
== Supporting development
If you like this library or find it useful, consider buying me a nice cup of coffee. Coffee fuels open source.
image:doc/bmac.png[width=197]
