Comment dois-je configurer mon module ?

Ce module a pour vocation d’exporter toutes vos données relatives à vos commandes utiles pour votre comptabilité classique.

Le Module «Rapport Commandes TVA & Bénéfices» vous permettra de configurer :
- votre format de rapport à partir d’une liste de type de rapport.
- choisir le format d’exportation, HTML afin de contrôler directement les données ou CSV afin d’exploiter les données dans votre système de comptabilité ou autre.

Facile de configuration et d’accès par l’onglet d’administration «Commandes», ce module vous donnera rapidement le résultat des données recherchées.

Affichage par défaut :

Paramètres de base

inclure les «en-têtes et totaux»
 

L’option est cochée par défaut. Elle permet d’afficher l’intitulé des colonnes plus les totaux des données numériques.

Dans le cas d’une exploitation des données par un système tiers, veuillez décocher cette option.

configurer le format de date

Le format sélectionné sera utilisé pour le format d’affichage des dates affichées dans le rapport.

Gérer l’onglet d’administration du menu «Commandes»

Par défaut, vous aurez cet écran :

Choisir le format

Cette option vous permet de sélectionner un format de rapport prédéfini dans le module.
Chaque format contient un nombre de champs pertinents provenant de la Base de données.

Vous pouvez directement au sous-onglet du modules dans l’onglet « commandes » en cliquant sur le bouton « formulaire d’export ».

Encodage

Cette option vous permettra d’encoder votre rapport CSV afin de l’exploiter dans une application telle qu’Excel qui ne gère pas l’UTF-8.
 

Champs de recherche et de tri

Dans les types de rapport, une notion de groupe est définie.
 

Recherche :

Tous ces champs vous permettrons d’affiner le résultat de votre rapport.
Vous avez les champs date et les champs numéro. Soit vous choisissez de mettre un intervalle soit une valeur de début ou de fin.
Vous pouvez aussi choisir un statut de commande à retourner. Si vous ne cochez aucun statut, par défaut la recherche sera faite sur tous les statuts.
Chaque sélection sera enregistrée afin de vous éviter de sélectionner les mêmes valeurs à chaque création de rapport.
Un rapport du groupe «produit» affichera des caractéristiques de filtrage supplémentaire (cf screenshot précedent).

Tri :

Le champ de tri vous permettra de sélectionner une des données remontées dans votre rapport. La liste est exhaustive, elle est basée sur un ensemble de valeurs dédiées à chaque rapport.
Selon que vous choisissiez un rapport de type «commandes», «produits», «marque», «fournisseur» ou «catégorie» vous aurez des champs de tri différents.

Ensuite, vous pouvez choisir la direction de tri.

Format d’exportation :

Vous pouvez choisir entre 2 formats:
- html = vous donne la possibilité de contrôler directement dans votre navigateur le résultat. Le rapport s’affichera au-dessus de votre formulaire de recherche.
- csv = vous donne la possibilité de classer vos rapports afin de les exploiter dans votre comptabilité classique ou dans un autre système. Selon votre navigateur, soit le téléchargement s’effectuera tout seul, soit une fenêtre de téléchargement apparaitra.

Résultats de recherche HTML - rapport type «commandes»

Résultats de recherche HTML - rapport type «produits»

Résultats de recherche CSV - rapport type «commandes»

Résultats de recherche CSV - rapport type «produits»

Visualisation du Module

Le module est utilisable uniquement dans le contexte de l’administration.

Note aux Développeurs

Architecture

L’architecture de ce module est décomposée de la sorte (regardez le PHP Doc de ordertaxprofitreport class):
- conf/
- common: utilisée de base par toutes les autres conf. Défini les chemins principaux du module + des variables globales
- admin: uniquement utilisée lors de la configuration de votre module
- install: uniquement utilisée lors de l’installation de votre module
- lib/install
- i-install.php (interface)
- install-ctrl_class.php (contrôleur = patron de conception «fabrique»)
- install-sql_class.php classes (classe «métier» de l’installation)
- install-config_class.php classes (classe «métier» de l’installation)
- nstall-tab_class.php classes (classe «métier» de l’installation)
- lib/admin
- i-admin.class.php (interface)
- admin-ctrl.class.php (contrôleur = patron de conception «stratégie»)
- admin-display_class.php et admin-update_class.php et admin-export_class.php classes (classes «métier» de la configuration)
- lib/module-dao_class.php => D.A.O (Data Access Object) gère les requêtes SQL
- lib/module-tools_class.php => regroupement des fonctions transverses
- lib/warnings_class.php => gère les warnings gérés par Prestashop lors de l’installation d’un module qui n’est pas encore configuré.

- templates/
- admin/ => templates utilisés pour l’administration et l’onglet d’administration
 

Astuces

Fonctionnelles
Aucunes.

Techniques

Chaque classe métier utilisée dans lib/admin doit retourner un tableau associatif :
‘tpl’ => nom du template à utiliser
‘assign’ valeurs assignées à smarty

Ainsi, la fonction d’affichage displayModule() centralise l’affichage.