Download the PHP package griiv/prestashop-module-contracts without Composer
On this page you can find all versions of the php package griiv/prestashop-module-contracts. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download griiv/prestashop-module-contracts
More information about griiv/prestashop-module-contracts
Files in griiv/prestashop-module-contracts
Package prestashop-module-contracts
Short Description Prestashop Module interface and Hook interface
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package prestashop-module-contracts
PrestaShop Module Contracts
Bibliothèque PHP fournissant des interfaces et une classe abstraite pour faciliter le développement de modules PrestaShop modernes avec une gestion automatique des hooks et l'intégration de Symfony.
Description
Ce package propose une architecture structurée pour créer des modules PrestaShop en utilisant les bonnes pratiques de développement PHP moderne. Il simplifie la gestion des hooks PrestaShop en automatisant leur résolution et en permettant une organisation claire du code basée sur des interfaces.
Fonctionnalités
- Classe abstraite ModuleAbstract : Base pour créer vos modules avec accès au kernel Symfony et aux services
- Gestion automatique des hooks : Résolution automatique des hooks basée sur des conventions de nommage
- Interfaces de hooks typées :
DisplayHookInterface: Pour les hooks d'affichage (retournent du HTML)ActionHookInterface: Pour les hooks d'action (retournent un booléen)FilterHookInterface: Pour les hooks de filtrageAdditionalHookInterface: Pour les hooks additionnels (retournent un tableau)ValidateHookInterface: Pour les hooks de validation de formulaire
- Intégration Symfony : Accès direct au kernel, aux services et à l'EntityManager Doctrine
- Traits utilitaires (Concerns) : Méthodes helper pour les traductions, tokens de sécurité et configuration module
- Attribut PHP 8.0+ :
#[AsPrestaShopHook]pour déclarer les hooks de manière déclarative (optionnel, rétrocompatible PHP 7.2) - CompilerPass Symfony : Enregistrement automatique des hooks via attributs dans le conteneur de services
- Scripts d'installation automatisés : Hooks Composer pour install/update/remove
Prérequis
- PHP >= 7.2
- PrestaShop >= 1.7.6 (avec support Symfony natif et accès au conteneur de services)
- Composer
Note : Les fonctionnalités basées sur les attributs PHP (
#[AsPrestaShopHook]etPrestaShopHookCompilerPass) nécessitent PHP 8.0+. Sur PHP 7.2 à 7.4, le reste de la bibliothèque fonctionne normalement.
Compatibilité PrestaShop 1.6
Cette bibliothèque peut également être utilisée avec PrestaShop 1.6 en installant en complément la bibliothèque prestashop/module-lib-service-container qui fournit un conteneur de services compatible.
Installation
Pour PrestaShop 1.7.6+
Pour PrestaShop 1.6
Utilisation
1. Créer votre module
Créez votre classe de module en étendant ModuleAbstract :
2. Créer des handlers de hooks
Hook d'affichage (Display)
Hook d'action (Action)
3. Utiliser les Concerns (Traits)
4. Attribut AsPrestaShopHook (PHP 8.0+)
Sur PHP 8.0+, vous pouvez déclarer vos hooks de manière déclarative avec l'attribut #[AsPrestaShopHook] :
Couplé au PrestaShopHookCompilerPass, les hooks sont automatiquement enregistrés dans le conteneur Symfony.
5. Convention de nommage
Le système de résolution automatique des hooks suit ces conventions :
- Display hooks :
hookDisplayNomDuHook→ classeVotreNamespace\Display\DisplayNomDuHook - Action hooks :
hookActionNomDuHook→ classeVotreNamespace\Action\ActionNomDuHook - Filter hooks :
hookFilterNomDuHook→ classeVotreNamespace\Filter\FilterNomDuHook - Additional hooks :
hookAdditionalNomDuHook→ classeVotreNamespace\Additional\AdditionalNomDuHook - Validate hooks :
hookValidateNomDuHook→ classeVotreNamespace\Validate\ValidateNomDuHook
Important : la résolution se fait sur le préfixe du nom du hook, pas sur sa sémantique. Tout hook dont le nom ne commence pas par
Action,Filter,AdditionalouValidateretombe sur le bucketDisplay.
Type de retour des hooks additionnels
Les hooks PrestaShop commençant par additional (additionalCustomerFormFields,
additionalCustomerAddressFields) sont exécutés avec agrégation des retours
(Hook::exec(..., $array_return = true)), et le coeur itère la valeur retournée
pour collecter les champs. AdditionalHookInterface::additional() retourne donc array :
un retour vide ou void ferait disparaître silencieusement les champs ajoutés.
Hooks de validation
Les hooks validate* reçoivent les instances de FormField créées par le module.
Le coeur matérialise les erreurs à partir de ces objets, pas de la valeur de retour :
signalez donc les erreurs en appelant FormField::addError() sur les objets reçus.
6. Accès aux services Symfony
Structure du projet
Licence
MIT License - voir le fichier LICENSE
Auteur
Arnaud Scoté - [email protected]
