Download the PHP package openclassrooms/use-case without Composer
On this page you can find all versions of the php package openclassrooms/use-case. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download openclassrooms/use-case
More information about openclassrooms/use-case
Files in openclassrooms/use-case
Package use-case
Short Description Use case library
License MIT
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 use-case
UseCase
UseCase is a library that provides facilities to manage technical code over a Use Case in a Clean / Hexagonal / Use Case Architecture.
- Security access
- Cache management
- Transactional context
- Events
- Logs
The goal is to have only functional code on the Use Case and manage technical code in an elegant way using annotations.
More details on :
Installation
or by adding the package to the composer.json file directly.
Instantiation
The UseCaseProxy needs a lot of dependencies.
The Dependency Injection Pattern is clearly helpful.
For an implementation with Symfony2, the UseCaseBundle is more appropriate.
UseCaseProxy can be instantiate as following:
Only and are mandatory.
Usage
A classic Use Case in Clean / Hexagonal / Use Case Architecture style looks like this:
The library provides a Proxy of the UseCase.
Security
@Security annotation allows to check access.
"roles" is mandatory.
Other options :
Cache
@Cache annotation allows to manage cache.
The key is equal to : and the TTL is the default one.
Other options:
Transaction
@Transaction annotation gives a transactional context around the Use Case.
- begin transaction
- execute()
- commit
- rollback on exception
Event
@Event annotation allows to send events.
An implementation of OpenClassrooms\UseCase\Application\Services\EventSender\EventFactory must be written in the application context.
The message can be send:
- pre execute
- post execute
- on exception or all of them.
Post is default.
The name of the event is the name of the use case with underscore, prefixed by the method. For previous example, the name would be : use_case.post.a_use_case
Prefixes can be :
- use_case.pre.
- use_case.post.
- use_case.exception.
Log
@Log annotation allows to add log following the PSR standard.
The log can be:
- pre execute
- post execute
- on exception or all of them.
On exception is default.
Level can be specified following PSR's levels. Warning is default.
Workflow
The execution order is the following:
Pre Excecute:
- log (pre)
- security
- cache (fetch)
- transaction (begin transaction)
- event (pre)
Post Excecute:
- cache (save if needed)
- transaction (commit)
- event (post)
- log (post)
On Exception:
- log (on exception)
- transaction (rollback)
- event (on exception)
Utils
The library provide a generic response for paginated collection.
All versions of use-case with dependencies
doctrine/annotations Version ^1.0|~2.0
psr/log Version ^2.0|^3.0
psr/cache Version ^2.0|^3.0