fintem/workflow-logger-bundle

Allows to log symfony workflow in your application

1.2 2018-02-19 15:48 UTC

Requires

• php: ^7.0
• doctrine/common: ^2.7
• doctrine/orm: ^2.5
• gedmo/doctrine-extensions: ^2.4
• psr/log: ^1.0
• symfony/config: ~3.0
• symfony/console: ~3.0
• symfony/dependency-injection: ~3.0
• symfony/event-dispatcher: ~3.0
• symfony/http-kernel: ~3.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^1.12
• phpunit/phpunit: ^5.7

MIT

• log
• workflow

README

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require fintem/workflow-logger-bundle "~1.0.1"

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            // ...
            new Fintem\WorkflowLoggerBundle\WorkflowLoggerBundle(),
        ];

        // ...
    }

    // ...
}

Step 3: Update schema

$ php app/console doctrine:schema:update --force

How to use

When you install workflow logger bundle, you can use this bundle straight away, all workflow is recorded to workflow_logger table (WorkflowLogger entity).

If you want to log particular workflow in your application you should note it explicitly. For example if you have got three workflows in your application (wfl-1, wfl-2, wfl3) and you want to log only wfl-1 and wfl-3. You should add additional lines of code to your config.yml file. If you do not add any workflow it will log all workflows by default.

workflow_logger:
    workflows:
        - 'wfl-1'
        - 'wfl-3'

If you want to stop logging all workflows, set logging property to false. Its property true by default.

workflow_logger:
    logging: false