PHPackages                             griiv/synchroengine - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. griiv/synchroengine

ActivePrestashop-module

griiv/synchroengine
===================

Set of command and codes to create imports and exports

1.1.3(8mo ago)14PHP

Since Mar 4Pushed 8mo ago1 watchersCompare

[ Source](https://github.com/griiv-git/prestashop-module-synchroengine)[ Packagist](https://packagist.org/packages/griiv/synchroengine)[ RSS](/packages/griiv-synchroengine/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (2)Versions (10)Used By (0)

Griiv Synchro Engine
====================

[](#griiv-synchro-engine)

Le module de synchro Griiv est utilisé pour créer des flux d'import, export via des fichiers CSV, fichier texte, API Prestashop, BDD, API REST, etc...

Il permet également de traiter de gros volumes de données avec une parallélisation de plusieurs sous tâche pour traiter les données entrantes.

Par exemple un fichier CSV de 1 000 000 peut être traité via 100 sous taĉhes lancées en parallèle qui traite chacune 10 000 entrées de la source de donnée entrante

La librairie `symfony/process` est utilisé pour faire cette parallélisation.

Commandes Symfony disponible
----------------------------

[](#commandes-symfony-disponible)

- `gsynchro:add-export` : Créer un export
- `gsynchro:add-import` : Créer un import
- `gsynchro:add-sequence` : Créer une séquence
- `gsynchro:create-ftp-folders` : Crée la structure des dossiers pour le ftp
- `gsynchro:execute` : Lancer un import, un export ou une séquence
- `gsynchro:log-rotate` : Compresser les logs dépassant 100Mo

Utilisation pour la crontab notamment `php bin/console gsynchro:execute MonImport`

Configuration générale `modules/griivsynchroengine/config/services.yml`
-----------------------------------------------------------------------

[](#configuration-générale-modulesgriivsynchroengineconfigservicesyml)

- `gsynchro.importPath` : Chemin du ftp ou sont mis à disposition les fichiers à importer
- `gsynchro.importBackup` : Chemin du ftp ou sont sauvegardé les fichiers qui ont été importé
- `gsynchro.exportPath` : Chemin du ftp ou sont mis à disposition les fichiers pour les services externe
- `gsynchro.exportBackup` : Chemin du ftp ou sont sauvegardés les fichiers exportés
- `gsynchro.logsPath` : Chemin du dossier qui contient les logs
- `gsynchro.batchSynchro` : Chemin de l'executable PHP pour les sous tâches
- `gsynchro.importPathFixtures` : Chemin du dossier contenant les jeux de données de test (fixtures)
- `gsynchro.lockPath` : Chemin du dossier des fichiers de verrouillage pour éviter les exécutions concurrentes
- `gsynchro.enableEmailNotification` : Activer les notifications par e‑mail (mettre `1` pour activer)
- `gsynchro.enableKchatNotification` : Activer les notifications via Kchat (mettre `1` pour activer)

Variables d'environnement `.env`
--------------------------------

[](#variables-denvironnement-env)

Un fichier `.env` est fourni à la racine du module pour personnaliser les chemins utilisés par l'application et configurer les notifications. Les principales variables sont :

- `GRIIVSYNCHRO_SMTP_HOST` et `GRIIVSYNCHRO_SMTP_PORT` : paramètres du serveur SMTP pour l'envoi d'e‑mails.
- `GRIIVSYNCHRO_SMTP_EMAIL` et `GRIIVSYNCHRO_SMTP_PWD` : identifiants de connexion au serveur SMTP.
- `GRIIVSYNCHRO_RECIPIENTS_NOTIF` : liste des adresses e‑mail séparées par des virgules qui recevront les notifications.
- `GRIIVSYNCHRO_KCHAT_TOKEN` et `GRIIVSYNCHRO_KCHAT_CHANNEL_ID` : informations nécessaires pour publier des messages sur Kchat.
- `GRIIVSYNCHRO_IMPORT_PATH` : dossier où sont récupérés les fichiers à importer.
- `GRIIVSYNCHRO_IMPORT_PATH_FIXTURES` : emplacement des jeux de données de test (fixtures).
- `GRIIVSYNCHRO_IMPORT_BACKUP` : répertoire de sauvegarde des fichiers importés.
- `GRIIVSYNCHRO_EXPORT_PATH` : emplacement où sont générés les exports.
- `GRIIVSYNCHRO_EXPORT_BACKUP` : dossier de sauvegarde des exports générés.
- `GRIIVSYNCHRO_LOGS_PATH` : répertoire contenant les fichiers de log du moteur.
- `GRIIVSYNCHRO_BATCH_SYNCHRO` : chemin vers l'exécutable PHP utilisé pour les sous‑processus.
- `GRIIVSYNCHRO_LOCK_PATH` : dossier des fichiers de verrouillage pour éviter les exécutions concurrentes.
- `GRIIVSYNCHRO_ENABLE_EMAIL_NOTIFICATION` : mettre `1` pour activer les alertes par e‑mail.
- `GRIIVSYNCHRO_ENABLE_KCHAT_NOTIFICATION` : mettre `1` pour activer les notifications via Kchat.

Créer un Import
---------------

[](#créer-un-import)

Pour créer un import :

Si la dossier n'existe pas à la racine du projet, d'abord lancer la commande `php bin/console gsynchro:create-ftp-folders`

Lancer la commande `php bin/console gsynchro:add-import gsynchro Customers`

Le fichier suivant est crée : `_PS_ROOT_DIR_/modules/griivsynchroengine/src/Synchro/Import/CustomersImport.php`

**Pensez à faire un `composer dumpautoload` dans votre module pour mettre à jour l'autoloading**

Voici le contenu fichier crée :

```
namespace Griiv\SynchroEngine\Synchro\Import;

use Griiv\SynchroEngine\Core\ImportBase;

class CustomersImport extends ImportBase
{
    protected function initDataSources()
    {
        // TODO: Implement initDataSources() method.
    }

    protected function initItemDefinition()
    {
        // TODO: Implement initItemDefinition() method.
    }

    protected function processRow($dataArray)
    {
        // TODO: Implement processRow() method.
    }
}
```

La méthode `initDataSources()` permet d'initialisé la ou les sources de données que l'on souhaite utilisé pour l'import (Fichier, Api, Requete BDD, etc)

La méthode `initItemDefinition()` permet de définir la structure de la source de donnée, pour un fichier CSV par exemple cela va être le nom des colonnes du fichier traité

La méthode `processRow()` cette méthode sera appelé pour traité un jeu de donnée source

Il est également possible pour chaque import de surcharger les méthodes suivantes :

`initLogger()` : permet d'initialiser un logger pour l'import. De base un fichier de log est pour chaque import voir `SynchroBase::initLogger()`

### Créer le service associé à l'import

[](#créer-le-service-associé-à-limport)

Pour que l'import soit reconnu par le système, il faut créer un service dans le fichier `services.yml` de votre module :

```
  griiv.synchro.import.customer_import:
    class: Griiv\Synchro\Synchro\Import\CustomerImport
    tags: [ gsynchro.synchro ]
```

Créer un Export
---------------

[](#créer-un-export)

Pour générer la classe d'export il suffit d'exécuter la commande suivante :

```
php bin/console gsynchro:add-export gsynchro NomDeMonExport
```

Un fichier `NomDeMonExportExport.php` est alors créé dans le dossier `_PS_ROOT_DIR_/modules/griivsynchroengine/src/Synchro/Export/` de votre module. Pensez à lancer `composer dumpautoload` après la création pour que l'autoload soit mis à jour.

Le squelette généré ressemble à ceci :

```
namespace Griiv\SynchroEngine\Synchro\Export;

use Griiv\SynchroEngine\Core\ExportBase;

class NomDeMonExportExport extends ExportBase
{
    protected function initDataTargets()
    {
        // Définir les cibles de données (fichier, API, ...)
    }

    protected function initTargetItemDefinition()
    {
        // Structure des données attendues par la cible
    }

    protected function initDataSources()
    {
        // Sources à exporter (BDD, API, ...)
    }

    protected function initItemDefinition()
    {
        // Définition des données issues de la source
    }

    protected function processRow($dataArray)
    {
        return parent::processRow($dataArray);
    }
}
```

### Les DataSources

[](#les-datasources)

Une **DataSource** décrit la manière de lire les données en entrée. Plusieurs implémentations sont fournies dans `src/Core/DataSource` :

- `FileDataSource` pour lire des fichiers CSV ou texte ;
- `GlobDataSource` afin de traiter un ensemble de fichiers correspondant à un motif (`glob`) ;
- `DbQueryDataSource` et `PDODataSource` pour récupérer des données en base ;
- `PrestashopApiDataSource` ou `AkeneoApiRestDataSource` pour des appels API ;
- `BufferDataSource` lorsque les données sont déjà en mémoire.

### Les DataTargets

[](#les-datatargets)

Une **DataTarget** représente la destination des données lors d'un export. Quelques classes sont disponibles dans `src/Core/DataTarget` :

- `FileDataTarget` et `PlainFileDataTarget` pour écrire dans des fichiers ;
- `ApiRestDataTarget` pour envoyer les informations vers une API REST ;
- `PDODataTarget` pour insérer ou mettre à jour des lignes en base.

### Sous le capot

[](#sous-le-capot)

Le moteur s'appuie sur `symfony/process` pour paralléliser les traitements. Chaque lot de données est exécuté dans un sous‑processus via le script `bin/batchSynchro.php`. Les logs sont gérés par *Monolog* et stockés dans le répertoire défini par le paramètre `gsynchro.logsPath`. Les fichiers sources peuvent être archivés automatiquement après traitement et les logs sont compressés grâce à la commande `gsynchro:log-rotate`.

TODO
----

[](#todo)

1. Mise en place Validateur pour ItemProperty
2. Mise en place des séquences
3. Mise en place logrotate fichier de logs
4. Mise en place backup file gzip après import (pour les fichiers)
5. Rajouter des hooks pour Prestashop
6. Mise en place rotate pour les fichiers dans.backup
7. Ajouter Datasource database doctrine ORM
8. Mise en place service tagé pour identifier les synchros
9. Mise en place dispatcher d'évènement Symfony
10. Mettre parameterBag pour les globalparameters
11. En mode cli ajout d'un mode debug
12. En mode cli sur la commande `gsynchro:execute` ajouter un paramètre pour avoir une progessbar
13. Tester avec un gros fichier +1M de ligne

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance60

Regular maintenance activity

Popularity5

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~137 days

Total

5

Last Release

256d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/a0283890f234c2bba3c30ab0008b4a0bbbc7f0f0b6ba64a5d634ba7341a0e232?d=identicon)[Mch0](/maintainers/Mch0)

---

Top Contributors

[![Mch0](https://avatars.githubusercontent.com/u/3593331?v=4)](https://github.com/Mch0 "Mch0 (48 commits)")

### Embed Badge

![Health badge](/badges/griiv-synchroengine/health.svg)

```
[![Health](https://phpackages.com/badges/griiv-synchroengine/health.svg)](https://phpackages.com/packages/griiv-synchroengine)
```

###  Alternatives

[laravel/framework

The Laravel Framework.

34.6k509.9M17.0k](/packages/laravel-framework)[matomo/matomo

Matomo is the leading Free/Libre open analytics platform

21.4k37.3k](/packages/matomo-matomo)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[magento/community-edition

Magento 2 (Open Source)

12.1k52.1k10](/packages/magento-community-edition)[prestashop/prestashop

PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers.

9.0k15.4k](/packages/prestashop-prestashop)[magento/magento2-functional-testing-framework

Magento2 Functional Testing Framework

15511.5M30](/packages/magento-magento2-functional-testing-framework)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)