{"id":2020,"date":"2019-08-05T13:55:40","date_gmt":"2019-08-05T11:55:40","guid":{"rendered":"https:\/\/www.h-hennes.fr\/blog\/?p=2020"},"modified":"2021-12-07T09:37:27","modified_gmt":"2021-12-07T07:37:27","slug":"prestashop-1-7-ajouter-des-champs-dans-un-formulaire-dadministration","status":"publish","type":"post","link":"https:\/\/www.h-hennes.fr\/blog\/2019\/08\/05\/prestashop-1-7-ajouter-des-champs-dans-un-formulaire-dadministration\/","title":{"rendered":"Prestashop 1.7 : Ajouter des champs dans un formulaire d\u2019administration"},"content":{"rendered":"\n

Cet article est une mise \u00e0 jour de l’article suivant https:\/\/www.h-hennes.fr\/blog\/2017\/06\/21\/prestashop-ajouter-des-champs-dans-un-formulaire-dadministration\/<\/a> qui s’applique aux controllers qui utilisent symfony, c’est le cas \u00e0 partir 1.7.6<\/strong> de Prestashop<\/p>\n

Si vous avez des doutes si le controller sur lequel vous souhaitez ajouter des champs fonctionne avec ce m\u00e9thode, n’h\u00e9sitez pas \u00e0 consulter l’article suivant pour l’identifier  : https:\/\/www.h-hennes.fr\/blog\/2019\/07\/25\/prestashop-1-7-identifier-si-un-controller-admin-a-ete-migre-vers-symfony\/<\/a><\/p>\n

L’objectif est d’ajouter un nouveau champ dans un formulaire d’administration de mani\u00e8re propre via un module.<\/p>\n

Fonctionnement technique<\/h3>\n

Comme pour les versions pr\u00e9c\u00e9dentes des hooks dynamiques sont pr\u00e9sents dans le code prestashop pour vous permettre g\u00e9rer des informations suppl\u00e9mentaires via vos modules dans les formulaires.<\/p>\n

Pour ajouter des champs le hook est ex\u00e9cut\u00e9 dans la fonction buildForm du fichier src\/Core\/Form\/IdentifiableObject\/Builder\/FormBuilder.php

Les noms des hooks sont construits sous la forme suivante :<\/p>\n

action . Container::camelize($formBuilder->getName()<\/strong>) . FormBuilderModifier<\/p>\n\n\n\n

\/**\n     * @param string $formType\n     * @param array $data\n     * @param int|null $id\n     * @param array $options\n     *\n     * @return FormInterface\n     *\/\n    private function buildForm($formType, $data, $id = null, array $options = [])\n    {\n        $formBuilder = $this->formFactory->createBuilder($formType, $data, $options);\n        $this->hookDispatcher->dispatchWithParameters('action' . Container::camelize($formBuilder->getName()) . 'FormBuilderModifier', [\n            'form_builder' => $formBuilder,\n            'data' => &$data,\n            'id' => $id,\n        ]);\n\n        return $formBuilder->getForm();\n    }\n<\/pre>\n\n\n\n
Pour la cr\u00e9ation et la mise \u00e0 jour des donn\u00e9es les hooks sont appell\u00e9s dans les fonctions handleFormUpdate ou handleFormCreate du fichier src\/Core\/Form\/IdentifiableObject\/Handler\/FormHandler.php<\/p>\n\n\n\n
Les noms des hooks sont construits sous la forme suivante :<\/p>\n\n\n\n
actionBeforeUpdate . Container::camelize(<\/em>$form->getName<\/strong>()<\/strong>) <\/em>. FormHandler
actionAfterUpdate. Container::camelize(<\/em>$form->getName<\/strong>()<\/strong>) <\/em>. FormHandler<\/p>\n\n\n\n
Voici le code ex\u00e9cut\u00e9 par exemple apr\u00e8s la mise \u00e0 jour d’un formulaire<\/p>\n\n\n\n
\/**\n     * @param FormInterface $form\n     * @param int $id\n     *\n     * @return FormHandlerResultInterface\n     *\/\n    private function handleFormUpdate(FormInterface $form, $id)\n    {\n        $data = $form->getData();\n\n        $this->hookDispatcher->dispatchWithParameters('actionBeforeUpdate' . Container::camelize($form->getName()) . 'FormHandler', [\n            'form_data' => &$data,\n            'id' => $id,\n        ]);\n\n        $this->dataHandler->update($id, $data);\n\n        $this->hookDispatcher->dispatchWithParameters('actionAfterUpdate' . Container::camelize($form->getName()) . 'FormHandler', [\n            'id' => $id,\n            'form_data' => &$data,\n        ]);\n\n        return FormHandlerResult::createWithId($id);\n    }\n\n<\/pre>\n\n\n\n
Exemples de noms de hooks<\/h3>\n
Suite aux informations pr\u00e9c\u00e9dentes voici donc des exemples de hook disponibles pour l’objet Category :<\/strong><\/p>\n
    \n
  • hookActionCategory<\/strong>FormBuilderModifier<\/li>\n
  • hookActionBeforeCreateCategory<\/strong>FormHandler<\/li>\n
  • hookActionAfterCreateCategory<\/strong>FormHandler<\/li>\n
  • hookActionBeforeUpdateCategory<\/strong>FormHandler<\/li>\n
  • hookActionAfterUpdateCategory<\/strong>FormHandler<\/li>\n<\/ul>\n
    Objets disponibles.<\/h3>\n
    A ce jour sur la version 1.7.6.0 ce fonctionnement est disponible pour les objets suivants :<\/p>\n
      \n
    • SqlRequest<\/li>\n
    • Customer<\/li>\n
    • Language<\/li>\n
    • Currency<\/li>\n
    • WebserviceKey<\/li>\n
    • Meta<\/li>\n
    • Category<\/li>\n
    • RootCategory<\/li>\n
    • Contact<\/li>\n
    • CmsPage<\/li>\n
    • CmsPageCategory<\/li>\n
    • Tax<\/li>\n
    • Manufacturer<\/li>\n
    • Employee<\/li>\n
    • Profile<\/li>\n
    • ManufacturerAddress<\/li>\n<\/ul>\n
      Exemple d’impl\u00e9mentation<\/h3>\n
      Voici comment proc\u00e9der pour rajouter des champs via un module qui s’appellera hh_sampleadminform<\/strong><\/p>\n
      Pour l’exemple nous allons ajouter :<\/p>\n
        \n
      • un champ simple<\/li>\n
      • un champ langue<\/li>\n<\/ul>\n
        Voici le code complet du module avec l’impl\u00e9mentation des diff\u00e9rents hooks \u00e9voqu\u00e9 plus hauts.

        J’ai mis un maximum de commentaires directement dans le code pour expliquer les diff\u00e9rentes possibilit\u00e9s. 
        ( Et laiss\u00e9 le nom des classes complets pour s’y retrouver plus facilement )

        Pour ceux qui utilisent d\u00e9j\u00e0 symfony la modification des formulaires sera relativement facile \u00e0 comprendre<\/p>\n
        \u00a0<\/p>\n\n\n\n