osflab/exception

OSF standardized exceptions

3.0.0 2018-02-26 14:34 UTC

Requires

• php: ^7.1.0

Requires (Dev)

• osflab/test: ~3.0.0

Suggests

• osflab/application: ~3.0.0
• osflab/container: ~3.0.0
• osflab/controller: ~3.0.0
• osflab/log: ~3.0.0
• osflab/view: ~3.0.0

Provides

• osflab/application: 3.0.0
• osflab/bean: 3.0.0
• osflab/cache: 3.0.0
• osflab/config: 3.0.0
• osflab/container: 3.0.0
• osflab/controller: 3.0.0
• osflab/crypt: 3.0.0
• osflab/db: 3.0.0
• osflab/device: 3.0.0
• osflab/doc-maker: 3.0.0
• osflab/filter: 3.0.0
• osflab/form: 3.0.0
• osflab/generator: 3.0.0
• osflab/helper: 3.0.0
• osflab/image: 3.0.0
• osflab/log: 3.0.0
• osflab/navigation: 3.0.0
• osflab/office: 3.0.0
• osflab/pdf: 3.0.0
• osflab/safety: 3.0.0
• osflab/session: 3.0.0
• osflab/stream: 3.0.0
• osflab/validator: 3.0.0
• osflab/view: 3.0.0

AGPL-3.0-or-later

• Guillaume Ponçon

README

The root OSF exceptions have a type corresponding to the underlying processing. In this way, they can be used explicitly to display errors, perform rollback processing, record debugging information, or issue alerts.

Exception types

• ArchException: to report a technical malfunction
• DisplayedException: displayed to the end user
• DbException: used to perform databases rollbacks
• PhpErrorException: PHP error handling
• OsfException: root exception of OSF components
• AlertException: launch a bootstrap alert (require osflab/view)
• HttpException: generate an error with a specific HTTP code

These exceptions are used in OSF-based components and applications.

Installation

You need at least php 7.1 and composer:

sudo apt install composer

In your application via composer

This is the recommended way to use this feature in a non-osf project.

Just add osflab/exception in your composer.json file.

From github

To test the component or participate in its development.

git clone https://github.com/osflab/exception.git
cd exception && composer update

Unit tests launch:

vendor/bin/runtests