Download the PHP package ebolution/laravel-core without Composer
On this page you can find all versions of the php package ebolution/laravel-core. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ebolution/laravel-core
More information about ebolution/laravel-core
Files in ebolution/laravel-core
Package laravel-core
Short Description Base features and tools to use in the application
License MIT
Informations about the package laravel-core
Core
Base features and tools to use in the application
Features
1) Process timer
This feature offers a mechanism to log information about a running process using a common format. When the method
start
is called, a starting message is logged including a unique identifier defined for this process.
When the method stop
is called, a finishing message is logged, including the total processing time and the
identifier as well, so a match between start and finish of the same process can be stated in latter reviews.
Where to log?
As different processes can be logged in different ways, this feature provides a mechanism to support its own on-demmand logging channels. The summarized sequence would be this:
- The implementations of
ProcessTimerInterface
must include an implementation ofLoggerFactoryInterface
- The objects produced by
LoggerFactoryInterface
are instances ofEbolution\Logger\Infrastructure\Logger
, and it requires an implementation ofBuilderInterface
. - The specific implementation of
BuilderInterface
hosts the details about the logger used by the Process timer.
Maybe it's easier to try an example:
- Create a command in
app/Console/Commands
using the commandartisan make:command FooProcessTimer
. - Replace the signature of the command to:
foo:process-timer
- Create the
Logging
directory in appmkdir app/Logging
- Create a new class
ProcessTimer
that extendsEbolution\Core\Infrastructure\Repositories\ProcessTimer
(which implementsProcessTimerInterface
) ` - Create a class
LoggerFactory
that extends fromEbolution\Logger\Infrastructure\LoggerFactory
` - Create a new class
LoggerBuilder
that extends fromEbolution\Logger\Domain\LoggerBuilder
. Here is where the on-demand logger is defined. In this example, the log messages are written to a file, but many other options are available. If you want a different behavior, just override the methods in this class. Make sure to provide a
path for you log file (required) and, also a prefix to add to the logs (optional). ` - As this approach is heavily based on dependency injection, we need to inform Laravel what concrete
implementations we want to pass to each class instead of just interfaces, if it's the case. So, create a class
DependencyServicesProvider
extendingIlluminate\Support\ServiceProvider
and declare the right injection for classesLoggerFactory
andProcessTimer
. ` - Finally, go to
config/app.php
and declare the newly created service provider into theproviders
section. ` - Go back to
App\Console\Commands\FooProcessTimer
and create a constructor injecting the newly createdProcessTimer
class (please notice that we use properties promotion here). ` - Now the timer itself, we need to call the
start
andstop
methods when the command is executed. Please notice thatstart
expect for a name for this process. `
Now we are ready to see if everything is on its place executing the command artisan foo:process-timer
, and going to
storage/logs/foo.log
to check the output.
All the instructions above are meant to follow a classic development pattern, however, we recommend to follow the
modular approach using in combination with the Ebolution_ModuleManager
module. The logic is the same, but the
location of the files is different.
Of course this is a ten steps process, we're open to optimize, automatize and improve it. Just don't hesitate to make your suggestions :D