Introduction à IDCIStepBundle

Introduction

Suite au besoin d'un client, nous nous sommes demandé comment répondre à la problématique d'une création de workflow interactif. Il fallait pouvoir réaliser facilement des parcours navigables par un internaute et déclencher facilement différents traitements (envoi de mail, sauvegarde en base de données, appel d'un web service) en fonction des actions utilisateurs (passage d'une étape à une autre). L'évolutivité de la complexité des parcours étant un point important, l'ensemble du workflow se devait d'être configurable (et non hardcodé).

Nous avons testé des bundles existants, qui semblaient répondre à notre problématique, mais ceux-ci n'étaient pas satisfaisant. En bas de page, nous avons ajouté un rapide comparatif de ces différents bundles.

Ainsi, nous avons choisi de développer notre propre Bundle, nous l'avons pensé générique et réutilisable.

Cet article a pour vocation d'introduire IDCIStepBundle. Dans de prochains articles, nous rentrerons plus dans les détails et vous parlerons de ses spécifités au travers d'exemples concrets.

IDCIStepBundle permet de simplifier la création d'un parcours interactif à destination d'un internaute. Sa configuration se définie par un système de Map (carte), de Step (étape) et de Path (chemin). Nous avons utilisé la métaphore de la navigation tout au long de notre développement.

Dans un premier temps, nous devons définir une map, et imaginer chaque écran (page web) comme une step, puis les lier entre elles en utilisant les paths qui ajouteront des boutons de navigation.

Ce Bundle est compatible avec la version 2.8 de Symfony. La version 3.0 sera disponible prochainement.

Qu'est-ce qu'une map ?

Une map définit le workflow de navigation, elle se compose de steps et de paths.

Qu'est-ce qu'une step ?

Une step se matérialise par une page web, et définit un potentiel point de passage. Elle peut être de différents types. Par défaut, notre bundle fournit deux types de step :

• html : affichage d'un contenu HTML
• form : affichage d'un formulaire (FormType Symfony)

Qu'est-ce qu'un path ?

Un path est un itinéraire qui a pour origine une step et pour destination zéro ou plusieurs steps. Il peut être de différents types. Par défaut, notre bundle fournit trois types de path :

• single : une seule destination
• conditionnel : plusieurs destinations en fonction de règles conditionnelles.
• end : le path qui détermine une fin de navigation.

Légende

Nous allons utiliser un diagramme qui fera office de légende.

• Les carrés représentent les steps.
• Les flèches représentent les paths.

Pourquoi utiliser IDCIStepBundle ?

IDCIStepBundle permet de mettre en place aussi bien un parcours simple (une step, un path) qu'un parcours plus complexes (plusieurs steps et paths). Vous pouvez commencer facilement à partir d'une configuration, qui représente la map, en utilisant le langage yml ou json. Vous pouvez aussi représenter une map en utilisant directement la programmation objet, mais cela est peut-être plus compliqué pour des non initiés au code et à la programmation objet.

Voici une liste non exhaustive des cas d'utilisation de StepBundle :

• Un formulaire de contact,
• Un processus d'inscription,
• Un questionnaire,
• Une enquête,
• Etc.

Sans plus attendre, partons à la rencontre de ce Bundle.

Commençons par créer un projet Symfony en version 2.8, nous appellerons ce projet demo_step.

$ composer create-project symfony/framework-standard-edition demo_step "2.8.*"

Installation

Ajoutons la dépendance avec notre bundle, en modifiant le fichier composer.json :

"require": {
    ...
    "idci/step-bundle": "~1.5"
},

Ou en éxécutant la commande composer suivante :

$ composer require idci/step-bundle:~1.5

Puis, installons cette nouvelle dépendance en utilisant composer :

$ composer update

Déclarons le bundle dans notre fichier AppKernel.php :

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        ...
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new IDCI\Bundle\StepBundle\IDCIStepBundle(),
    );
}

Enfin, ajoutons les spécificités de configuration de ce Bundle à notre application. Pour cela, éditons le fichier app/config/config.yml :

imports:
    ...
    - { resource: @IDCIStepBundle/Resources/config/config.yml }

Notre Bundle est installé et prêt à l'emploi.

Dans notre prochain article, nous testerons un cas concret d'utilisation de IDCIStepBundle : la création d'un formulaire de contact.

Comparatif

Voici un tableau comparatif (points forts / points faibles) des Bundles permetant de réaliser des workflows intéractifs.

Bundle	Forces	Faiblesses
CraueFormFlowBundle	Compatible avec symfony2 et 3. Retour en arrière possible sur plusieurs niveau avec conservation des données saisies à chaque étape. Deux approches possible (un "FormType" pour tout le flow, ou un "FormType" par step)	Création de nombreux fichiers necessaires pour réaliser des parcours complexe car 1 fichier = 1 step. Pas d'enregistrement de l'ensemble des données de navigation (quand réactualisation) On ne peux pas définir les étapes via de la configuration. Pas de notion de chemins, les étapes se suives chronologiquement.
IDCIStepBundle	Utilisation de chemins "path" reliant les étapes "step", ce qui permet une navigation par forcément chronologique entre chaque étapes. Parcours entiérement configurable (json/yaml), possibilité également de les "hardcoder". Sauvegarde de l'ensemble des données saisies ou récupérées durant la navigation. Retour en arrière possible sur plusieurs niveau avec conservation des données saisies à chaque étape. Usage natif de "champs de fusion" permettant de récupérer facilement les données saisies ou autres. "Debugger" intégrer contenant l'historique et le donnée de navigation. Possibilité de brancher des "EventActions" sur les "paths" ou les "steps".	Seulement compatible avec Symfony2 pour le moment. La configuration devient rapidement très dense.

D'autres bundles ont été rapidement analysé mais pas testé:

• KitpagesWorkflowBundle : Ce bundle propose seulement une version beta.
• SyliusFlowBundle : Ce Bundle affiche "Read only" sur Github.

Si vous avez besoin d'une aide ou d'une expertise concernant IDCIStepBundle vous pouvez nous contacter.