3
edits
Changes
m
Meilleure traduction du mot hook, capitaine
Line 5:
Line 5:
+- '<nowiki/>'''context'''' est la chaine qui contient le contexte d'exécution. C'est un simple indicateur qui peut être utilisé par les fonctions de hook pour détecter dans quel cas elles sont appelées (plusieurs pages/modules peuvent appeler le même hook à différent endroit, et une fonction de hook peut ne vouloir s'exécuter que pour un contexte donné et pas les autres).+Note: Vous pouvez positionner plusieurs contextes en même temps (par exemple si vous avez besoin d'avoir un context commun à plusieurs pages mais que vous voulez aussi un context propre à une page donnée).+
+ +|-
−!Context
−!File / Fichier
−|-
−|accountancycustomerlist
−|htdocs\accountancy\customer\list.php
−|-
−|accountancyindex
−|htdocs\accountancy\index.php
−|-
−|accountancysupplierlist
−|htdocs\accountancy\supplier\list.php
−|-
−|actioncard
−|htdocs\comm\action\card.php
−|-
−|actiondao
−|htdocs\comm\action\class\actioncomm.class.php
−|-
−|admin
−|htdocs\accountancy\admin\accountmodel.php<br />
−htdocs\accountancy\admin\categories_list.php<br />
−htdocs\accountancy\admin\journals_list.php<br />
−htdocs\admin\dict.php<br />
−htdocs\admin\website_options.php
−|-
−|admincompany
−|htdocs\admin\company.php
−|-
−|admindefaultvalues
−|htdocs\admin\defaultvalues.php
−|-
−|adminldap
−|htdocs\admin\ldap.php
−|-
−|adminmodules
−|htdocs\admin\modules.php
−|-
−|admintranslation
−|htdocs\admin\translation.php
−|-
−|agenda
−|htdocs\comm\action\index.php
−htdocs\comm\action\pertype.php
−htdocs\comm\action\peruser.php
−|-
−|agendaexport
−|htdocs\public\agenda\agendaexport.php
−|-
−|agendalist
−|htdocs\comm\action\list.php
−|-
−|agendaresource
−|htdocs\resource\agenda.php
−|-
−|agendathirdparty
−|htdocs\societe\agenda.php
−htdocs\product\agenda.php
−|-
−|assetcard
−|htdocs\asset\card.php
−|-
−|assetdocument
−|htdocs\asset\document.php
−|-
−|assetlist
−|htdocs\asset\list.php
−|-
−|assetnote
−|htdocs\asset\note.php
−|-
−|assettypecard
−|htdocs\asset\type.php
−|-
−|bankaccountlist
−|htdocs\compta\bank\list.php
−|-
−|bankcard
−|htdocs\compta\bank\card.php
−|-
−|banktransactionlist
−|htdocs\compta\bank\bankentries_list.php
−|-
−|banktreso
−|htdocs\compta\bank\treso.php
−|-
−|bomagenda
−|htdocs\bom\bom_agenda.php
−|-
−|bomcard
−|htdocs\bom\bom_card.php
−|-
−|bomdao
−|htdocs\bom\class\bom.class.php
−|-
−|bomdocument
−|htdocs\bom\bom_document.php
−|-
−|bomlinedao
−|htdocs\bom\class\bom.class.php
−|-
−|bomlist
−|htdocs\bom\bom_list.php
−|-
−|bomnote
−|htdocs\bom\bom_note.php
−|-
−|cashcontrol
−|htdocs\compta\cashcontrol\cashcontrol_list.php
−|-
−|cashcontrolcard
−|htdocs\compta\cashcontrol\cashcontrol_card.php
−|-
−|cashdeskloginpage
−|htdocs\cashdesk\index.php
−|-
−|cashdeskTplTicket
−|htdocs\cashdesk\validation_ticket.php
−|-
−|cashfencedao
−|htdocs\compta\cashcontrol\class\cashcontrol.class.php
−|-
−|categorycard
−|htdocs\categories\card.php<br />
−htdocs\categories\edit.php<br />
−htdocs\categories\viewcat.php
−|-
−|commandefournisseurdispatchdao
−|htdocs\fourn\class\fournisseur.commande.dispatch.class.php
−|-
−|commonobject
−|htdocs\core\class\html.form.class.php
−|-
−|comptafileslist
−|htdocs\compta\compta-files.php
−|-
−|consumptioncontact
−|htdocs\contact\consumption.php
−|-
−|consumptionthirdparty
−|htdocs\societe\consumption.php
−|-
−|contactagenda
−|htdocs\contact\agenda.php
−|-
−|contactcard
−|htdocs\contact\card.php
−|-
−|contactdao
−|htdocs\contact\class\contact.class.php
−|-
−|contactlist
−|htdocs\contact\list.php
−|-
−|contactthirdparty
−|htdocs\societe\societecontact.php
−|-
−|contacttpl
−|htdocs\core\tpl\contacts.tpl.php
−htdocs\projet\tasks\contact.php
−|-
−|contractcard
−|htdocs\contrat\card.php htdocs\contrat\contact.php<br />
−htdocs\contrat\document.php<br />
−htdocs\contrat\info.php htdocs\contrat\note.php
−|-
−|contractlist
−|htdocs\contrat\list.php
−|-
−|contractservicelist
−|htdocs\contrat\services_list.php
−|-
−|cron
−|htdocs\cron\class\cronjob.class.php
−|-
−|cronjoblist
−|htdocs\cron\list.php
−|-
−|defineholidaylist
−|htdocs\holiday\define_holiday.php
−|-
−|deliverycard
−|htdocs\livraison\card.php
−|-
−|doncard
−|htdocs\don\card.php
−|-
−|element_resource
−|htdocs\resource\element_resource.php
−|-
−|emailcollectoractiondao
−|htdocs\emailcollector\class\emailcollectoraction.class.php
−|-
−|emailcollectorcard
−|htdocs\admin\emailcollector_card.php
−|-
−|emailcollectordao
−|htdocs\emailcollector\class\emailcollector.class.php
−|-
−|emailcollectorfilterdao
−|htdocs\emailcollector\class\emailcollectorfilter.class.php
−|-
−|emailcollectorlist
−|htdocs\admin\emailcollector_list.php
−|-
−|emailingdao
−|htdocs\comm\mailing\class\mailing.class.php
−|-
−|emailsenderprofilelist
−|htdocs\admin\mails_senderprofile_list.php
−|-
−|emailtemplates
−|htdocs\admin\mails_templates.php
−|-
−|expeditioncard
−|htdocs\expedition\card.php
−|-
−|expensereportcard
−|htdocs\expensereport\card.php
−|-
−|expensereportlist
−|htdocs\expensereport\list.php
−|-
−|externalbalance
−|htdocs\compta\localtax\clients.php<br />
−htdocs\compta\localtax\index.php<br />
−htdocs\compta\resultat\clientfourn.php<br />
−htdocs\compta\resultat\index.php<br />
−htdocs\compta\tva\clients.php<br />
−htdocs\compta\tva\index.php<br />
−htdocs\compta\tva\quadri_detail.php
−|-
−|fichinterdao
−|htdocs\fichinter\class\fichinter.class.php
−|-
−|fileslib
−|htdocs\core\lib\files.lib.php
−|-
−|formfile
−|htdocs\core\class\html.formfile.class.php
−|-
−|formmail
−|htdocs\core\class\html.formmail.class.php
−|-
−|globaladmin
−|htdocs\admin\company.php<br />
−htdocs\admin\defaultvalues.php<br />
−htdocs\admin\ldap.php<br />
−htdocs\admin\modules.php<br />
−htdocs\admin\translation.php
−|-
−|globalcard
−|Any page of any tab of any object
−|-
−|globallist
−|htdocs\compta\compta-files.php
−|-
−|groupcard
−|htdocs\user\group\card.php
−|-
−|groupdao
−|htdocs\user\class\usergroup.class.php
−|-
−|groupperms
−|htdocs\user\group\perms.php
−|-
−|holidaylist
−|htdocs\holiday\list.php
−|-
−|homesetup
−|htdocs\admin\index.php
−|-
−|idprofurl
−|htdocs\societe\class\societe.class.php
−|-
−|index
−|htdocs\index.php
−|-
−|interventioncard
−|htdocs\fichinter\card.php
−|-
−|interventionlist
−|htdocs\fichinter\list.php
−|-
−|intervnetiondao
−|htdocs\fichinter\class\fichinter.class.php
−|-
−|inventorycard
−|htdocs\product\inventory\card.php
−|-
−|inventorylist
−|htdocs\product\inventory\list.php
−|-
−|invoicecard
−|htdocs\compta\facture\card.php
−|-
−|invoicedao
−|htdocs\compta\facture\class\facture.class.php
−|-
−|invoiceindex
−|htdocs\compta\index.php
−|-
−|invoicelist
−|htdocs\compta\facture\list.php
−|-
−|invoicereccard
−|htdocs\compta\facture\fiche-rec.php
−htdocs\compta\facture\invoicetemplate_list.php
−|-
−|invoicesuppliercard
−|htdocs\fourn\facture\card.php
−|-
−|leavemovementlist
−|htdocs\holiday\view_log.php
−|-
−|leftblock
−|htdocs\main.inc.php
−|-
−|loancard
−|htdocs\loan\card.php
−|-
−|localtaxvatcard
−|htdocs\compta\localtax\card.php
−|-
−|login
−|htdocs\main.inc.php
−|-
−|logout
−|htdocs\user\logout.php
−|-
−|mail
−|htdocs\core\class\CMailFile.class.php
−|-
−|mailingcard
−|htdocs\comm\mailing\card.php
−|-
−|mailinglist
−|htdocs\comm\mailing\list.php
−|-
−|main
−|htdocs\core\lib\security.lib.php
−htdocs\main.inc.php
−|-
−|mainloginpage
−|htdocs\core\lib\security2.lib.php
−|-
−|membercard
−|htdocs\adherents\card.php
−|-
−|memberlist
−|htdocs\adherents\list.php
−|-
−|membertypecard
−|htdocs\adherents\type.php
−|
−|-
−|membertypeldapcard
−|htdocs\adherents\type_ldap.php
−|-
−|movementlist
−|htdocs\core\modules\stock\doc\pdf_stdmovement.modules.php
−htdocs\product\stock\movement_card.php
−htdocs\product\stock\movement_list.php
−|-
−|myobjectagenda
−|htdocs\modulebuilder\template\myobject_agenda.php
−|-
−|myobjectcard
−|htdocs\modulebuilder\template\myobject_card.php
−|-
−|myobjectdao
−|htdocs\comm\mailing\class\mailing.class.php<br />
−htdocs\modulebuilder\template\class\myobject.class.php<br />
−htdocs\compta\bank\class\paymentvarious.class.php<br />
−htdocs\compta\cashcontrol\class\cashcontrol.class.php<br />
−htdocs\compta\salaries\class\paymentsalary.class.php<br />
−htdocs\emailcollector\class\emailcollector.class.php
−|-
−|myobjectdocument
−|htdocs\modulebuilder\template\myobject_document.php
−|-
−|myobjectlist
−|htdocs\modulebuilder\template\myobject_list.php
−|-
−|myobjectnote
−|htdocs\modulebuilder\template\myobject_note.php
−|-
−|notification
−|htdocs\core\class\notify.class.php
−|-
−|odtgeneration
−|htdocs\core\modules\user\doc\doc_generic_user_odt.modules.php<br />
−htdocs\core\modules\usergroup\doc\doc_generic_usergroup_odt.modules.php<br />
−htdocs\core\modules\supplier_proposal\doc\doc_generic_supplier_proposal_odt.modules.php<br />
−htdocs\core\modules\societe\doc\doc_generic_odt.modules.php<br />
−htdocs\core\modules\stock\doc\doc_generic_stock_odt.modules.php<br />
−htdocs\core\modules\facture\doc\doc_generic_invoice_odt.modules.php<br />
−htdocs\core\modules\product\doc\doc_generic_product_odt.modules.php<br />
−htdocs\core\modules\project\doc\doc_generic_project_odt.modules.php<br />
−htdocs\core\modules\propale\doc\doc_generic_proposal_odt.modules.php<br />
−htdocs\core\modules\reception\doc\doc_generic_reception_odt.modules.php<br />
−htdocs\core\modules\commande\doc\doc_generic_order_odt.modules.php<br />
−htdocs\core\modules\contract\doc\doc_generic_contract_odt.modules.php<br />
−htdocs\core\modules\expedition\doc\doc_generic_shipment_odt.modules.php
−|-
−|ordercard
−|htdocs\commande\card.php
−|-
−|orderdao
−|htdocs\commande\class\commande.class.php
−|-
−|orderlist
−|htdocs\commande\list.php<br />
−htdocs\don\list.php
−|-
−|ordershipmentcard
−|htdocs\expedition\shipment.php
−|-
−|orderstoinvoice
−|htdocs\commande\orderstoinvoice.php
−|-
−|orderstoinvoicesupplier
−|htdocs\fourn\commande\orderstoinvoice.php
−|-
−|ordersuppliercard
−|htdocs\fourn\commande\card.php
−|-
−|ordersupplierdispatch
−|htdocs\fourn\commande\dispatch.php
−|-
−|paiementcard
−|htdocs\stripe\payment.php<br />
−htdocs\compta\paiement.php
−|-
−|passwordforgottenpage
−|htdocs\user\passwordforgotten.php
−|-
−|paymentlist
−|htdocs\compta\paiement\list.php
−|-
−|paymentsupplierlist
−|htdocs\fourn\facture\paiement.php
−|-
−|pdfgeneration
−|htdocs\core\modules\action\rapport.pdf.php<br />
−htdocs\core\modules\bank\doc\pdf_ban.modules.php<br />
−htdocs\core\modules\bank\doc\pdf_sepamandate.modules.php<br />
−htdocs\core\modules\cheque\doc\pdf_blochet.class.php<br />
−htdocs\core\modules\commande\doc\pdf_einstein.modules.php<br />
−htdocs\core\modules\commande\doc\pdf_eratosthene.modules.php<br />
−htdocs\core\modules\contract\doc\pdf_strato.modules.php<br />
−htdocs\core\modules\expedition\doc\pdf_espadon.modules.php<br />
−htdocs\core\modules\expedition\doc\pdf_merou.modules.php<br />
−htdocs\core\modules\expedition\doc\pdf_rouget.modules.php<br />
−htdocs\core\modules\expensereport\doc\pdf_standard.modules.php<br />
−htdocs\core\modules\facture\doc\pdf_crabe.modules.php<br />
−htdocs\core\modules\facture\doc\pdf_sponge.modules.php<br />
−htdocs\core\modules\fichinter\doc\pdf_soleil.modules.php<br />
−htdocs\core\modules\livraison\doc\pdf_typhon.modules.php<br />
−htdocs\core\modules\product\doc\pdf_standard.modules.php<br />
−htdocs\core\modules\project\doc\pdf_baleine.modules.php<br />
−htdocs\core\modules\project\doc\pdf_beluga.modules.php<br />
−htdocs\core\modules\project\doc\pdf_timespent.modules.php<br />
−htdocs\core\modules\propale\doc\pdf_azur.modules.php<br />
−htdocs\core\modules\propale\doc\pdf_cyan.modules.php<br />
−htdocs\core\modules\rapport\pdf_paiement.class.php<br />
−htdocs\core\modules\reception\doc\pdf_squille.modules.php<br />
−htdocs\core\modules\stock\doc\pdf_standard.modules.php<br />
−htdocs\core\modules\stock\doc\pdf_stdmovement.modules.php<br />
−htdocs\core\modules\supplier_invoice\pdf\pdf_canelle.modules.php<br />
−htdocs\core\modules\supplier_order\pdf\pdf_cornas.modules.php<br />
−htdocs\core\modules\supplier_order\pdf\pdf_muscadet.modules.php<br />
−htdocs\core\modules\supplier_payment\doc\pdf_standard.modules.php<br />
−htdocs\core\modules\supplier_proposal\doc\pdf_aurore.modules.php
−|-
−|pricesuppliercard
−|htdocs\product\fournisseurs.php
−|-
−|product_lotlist
−|htdocs\product\stock\productlot_list.php
−|-
−|productcard
−|htdocs\product\card.php
−|-
−|productdao
−|htdocs\product\class\product.class.php
−|-
−|productdocuments
−|htdocs\product\document.php
−|-
−|productindex
−|htdocs\product\index.php
−|-
−|productlotcard
−|htdocs\product\stock\productlot_card.php
−|-
−|productlotdocuments
−|htdocs\product\stock\productlot_document.php
−|-
−|productpricecard
−|htdocs\product\price.php
−|-
−|productservicelist
−|htdocs\product\list.php
−|-
−|productstatscontract
−|htdocs\product\stats\contrat.php
−|-
−|productstatsinvoice
−|htdocs\product\stats\facture.php
−|-
−|productstatsorder
−|htdocs\product\stats\commande.php
−|-
−|productstatspropal
−|htdocs\product\stats\propal.php
−htdocs\product\stats\supplier_proposal.php
−|-
−|productstatssupplyinvoice
−|htdocs\product\stats\facture_fournisseur.php
−|-
−|productstatssupplyorder
−|htdocs\product\stats\commande_fournisseur.php
−|-
−|projectcard
−|htdocs\projet\card.php
−htdocs\projet\comment.php
−|-
−|projectcontactcard
−|htdocs\projet\contact.php
−|-
−|projectdao
−|htdocs\projet\class\project.class.php
−|-
−|projectlist
−|htdocs\projet\list.php
−|-
−|projectOverview
−|htdocs\projet\element.php
−|-
−|projecttaskcard
−|htdocs\projet\tasks\task.php
−|-
−|projecttaskcommentcard
−|htdocs\projet\tasks\comment.php
−|-
−|projecttaskscard
−|htdocs\projet\tasks.php
−|-
−|projecttasktime
−|htdocs\projet\tasks\time.php
−|-
−|projectthirdparty
−|htdocs\societe\project.php
−|-
−|projectticket
−|htdocs\ticket\list.php
−|-
−|propalcard
−|htdocs\comm\propal\card.php
−|-
−|propallist
−|htdocs\comm\propal\list.php
−|
−|-
−|purchasesjournal
−|htdocs\accountancy\journal\purchasesjournal.php
−|-
−|recapcomptacard
−|htdocs\compta\recap-compta.php
−|-
−|receptioncard
−|htdocs\reception\card.php
−|-
−|receptiondao
−|htdocs\reception\card.php
−htdocs\reception\class\reception.class.php
−|-
−|receptionlist
−|htdocs\reception\list.php
−|-
−|resource
−|htdocs\resource\card.php
−|-
−|resource_card
−|htdocs\resource\card.php
−|-
−|resourcelist
−|htdocs\resource\list.php
−|-
−|salarycard
−|htdocs\compta\salaries\card.php
−|-
−|salarypayment
−|htdocs\compta\salaries\class\paymentsalary.class.php
−|-
−|searchform
−|htdocs\core\ajax\selectsearchbox.php<br />
−htdocs\core\search_page.php<br />
−htdocs\main.inc.php
−|-
−|sellsjournal
−|htdocs\accountancy\journal\sellsjournal.php
−|-
−|shipmentlist
−|htdocs\expedition\list.php
−|-
−|stockproductcard
−|htdocs\product\stock\product.php
−|-
−|stockreplenishlist
−|htdocs\product\stock\replenish.php
−|-
−|subscription
−|htdocs\adherents\subscription.php
−|-
−|subscriptionlist
−|htdocs\adherents\subscription\list.php
−|-
−|supplier_proposalcard
−|htdocs\supplier_proposal\card.php
−|-
−|supplier_proposallist
−|htdocs\supplier_proposal\list.php
−|-
−|supplierbalencelist
−|htdocs\compta\recap-compta.php
−htdocs\fourn\recap-fourn.php
−|-
−|suppliercard
−|htdocs\fourn\card.php
−|-
−|supplierinvoicelist
−|htdocs\fourn\facture\list.php
−|-
−|supplierorderlist
−|htdocs\fourn\commande\list.php
−|-
−|supplierpricelist
−|htdocs\fourn\product\list.php
−|-
−|surveylist
−|htdocs\opensurvey\list.php
−|-
−|takeposfrontend
−|htdocs\takepos\takepos.php
−|-
−|tasklist
−|htdocs\projet\tasks\list.php
−|-
−|tasktimelist
−|htdocs\projet\tasks\time.php
−|-
−|taxvatcard
−|htdocs\compta\tva\card.php
−|-
−|thirdpartybancard
−|htdocs\societe\paymentmodes.php
−|-
−|thirdpartycard
−|htdocs\core\tpl\advtarget.tpl.php
−htdocs\societe\card.php
−|-
−|thirdpartycomm
−|htdocs\comm\card.php
−|-
−|thirdpartycontact
−|htdocs\societe\contact.php
−|-
−|thirdpartycustomerprice
−|htdocs\societe\price.php
−|-
−|thirdpartydao
−|htdocs\societe\class\societe.class.php
−|-
−|thirdpartydocument
−|htdocs\societe\document.php
−|-
−|thirdpartylist
−|htdocs\societe\list.php
−|-
−|thirdpartymargins
−|htdocs\margin\tabs\thirdpartyMargins.php
−|-
−|thirdpartynote
−|htdocs\societe\note.php
−|-
−|thirdpartynotification
−|htdocs\societe\notify\card.php
−|-
−|thirdpartyticket
−|htdocs\ticket\list.php
−|-
−|ticketcard
−|htdocs\ticket\card.php
−|-
−|ticketlist
−|htdocs\ticket\list.php
−|-
−|timesheetperdaycard
−|htdocs\projet\activity\perday.php
−|-
−|timesheetperweekcard
−|htdocs\projet\activity\perweek.php
−|-
−|toprightmenu
−|htdocs\main.inc.php
−|-
−|tripsandexpensescard
−|htdocs\compta\deplacement\card.php
−|-
−|upgrade
−|htdocs\install\upgrade2.php
−|-
−|useragenda
−|htdocs\user\agenda_extsites.php
−|-
−|usercard
−|htdocs\user\agenda_extsites.php<br />
−htdocs\user\card.php<br />
−htdocs\user\clicktodial.php<br />
−htdocs\user\document.php<br />
−htdocs\user\ldap.php<br />
−htdocs\user\note.php<br />
−htdocs\user\param_ihm.php<br />
−htdocs\user\perms.php
−|-
−|userdao
−|htdocs\user\class\user.class.php
−|-
−|userdoc
−|htdocs\user\document.php
−|-
−|userhome
−|htdocs\user\home.php
−|-
−|userihm
−|htdocs\user\param_ihm.php
−|-
−|userldap
−|htdocs\user\ldap.php
−|-
−|userlist
−|htdocs\user\list.php
−|-
−|usernote
−|htdocs\user\note.php
−|-
−|userperms
−|htdocs\user\perms.php
−|-
−|variouscard
−|htdocs\compta\bank\various_payment\card.php
−|-
−|variouspayment
−|htdocs\compta\bank\class\paymentvarious.class.php
−|-
−|warehousecard
−|htdocs\product\stock\card.php
−|-
−|website
−|htdocs\admin\website.php
−|-
−|websiteaccountcard
−|htdocs\website\websiteaccount_card.php
−|-
−|websitethirdpartylist
−|htdocs\societe\website.php
−|}
[[en:Hooks_system]]
[[en:Hooks_system]]
[[es:El_sistema_Hooks]]
[[es:El_sistema_Hooks]]
−[[de:System_von_Hooks]] ]]
+[[de:System_von_Hooks]]
[[zh:钩子系统]]
[[zh:钩子系统]]
<!-- END interlang links -->
<!-- END interlang links -->
Line 12:
Line 12:
=Introduction=
=Introduction=
−Les Hooks sont une fonctionnalité, pour les développeurs, leur permettant d'ajouter du code personnalisé aux pages standards de Dolibarr sans avoir à modifier les fichiers du coeur de Dolibarr. Contrairement au [[Système de Triggers]] (autre manière d'interagir avec le code de Dolibarr) qui sont liés aux événements de Dolibarr, les Hooks peuvent s'exécuter n'importe ou et à n'importe quel moment dès lors qu'ils ont été prévu dans le core de Dolibarr. Ce sont des points d'insertion dans le programme.
+Les Hooks (crochet en anglais, dans le sens de détour) sont une fonctionnalité destinée aux développeurs, leur permettant d'ajouter du code personnalisé aux pages standards de Dolibarr sans avoir à modifier le ''core'' de Dolibarr. Contrairement au [[Système de Triggers]] (autre manière d'interagir avec le code de Dolibarr) qui sont liés aux événements de Dolibarr, les Hooks peuvent s'exécuter n'importe où et à n'importe quel moment dès lors qu'ils ont été prévus dans le ''core'' de Dolibarr. Ce sont des points d'insertion dans le programme.
*Les Hooks sont actifs ou pas selon un contexte (souvent un contexte par module : par exemple "productcard" pour les produits, "invoicecard" pour les factures...). Pour trouver les Hooks existants faites une recherche pour "'''initHooks('''"
*Les Hooks sont actifs ou pas selon un contexte (souvent un contexte par module : par exemple "productcard" pour les produits, "invoicecard" pour les factures...). Pour trouver les Hooks existants faites une recherche pour "'''initHooks('''"
Line 18:
Line 18:
=Ajouter un hook pour permettre l'insertion de code=
=Ajouter un hook pour permettre l'insertion de code=
−Pour implémenter un hook dans votre propre module (afin que votre module puisse être "hooké" par d'autres), vous devrez procéder à 2 étapes.
+Pour implémenter un hook dans votre propre module (afin que votre module puisse être "crocheté", "détourné" par d'autres), vous devrez procéder en 2 étapes.
Ces étapes doivent êtres reproduites pour chaque script php de votre module où vous voulez implémenter des hooks.
Ces étapes doivent êtres reproduites pour chaque script php de votre module où vous voulez implémenter des hooks.
−1- Initialiser l'object HookManager (placez ce bout de code au début de votre script php, juste après ou avant les includes):
+1- Initialiser l'object HookManager
−<source lang="php">
+Pour une page, placez ce bout de code au début de votre script php (après le ''include'' du ''main''):
+<syntaxhighlight lang="php">
// Initialize technical object to manage hooks of thirdparties. Note that conf->hooks_modules contains array array
// Initialize technical object to manage hooks of thirdparties. Note that conf->hooks_modules contains array array
include_once(DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php');
include_once(DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php');
$hookmanager=new HookManager($db);
$hookmanager=new HookManager($db);
$hookmanager->initHooks(array('context'));
$hookmanager->initHooks(array('context'));
−</source>
+</syntaxhighlight>
−$hookmanager->initHooks() accepte 1 paramètre (un array de contextes) et active la prise en charge des hooks pour ce script:
+$hookmanager->initHooks() accepte 1 paramètre (un array de contextes) et active la prise en charge des hooks pour ce script. '<nowiki/>'''context'''' est la chaine qui contient le contexte d'exécution. C'est un simple indicateur qui peut être utilisé par les fonctions de hook pour détecter dans quel cas elles sont appelées (plusieurs pages/modules peuvent appeler le même hook à différent endroit, et une fonction de hook peut ne vouloir s'exécuter que pour un contexte donné et pas les autres).
−Note: Vous pouvez positionner plusieurs contextes en même temps (par exemple si vous avez besoin d'avoir un contexte commun à plusieurs pages mais que vous voulez aussi un contexte propre à une page donnée).
−Pour une méthode ou fonction, il est possible de récupérer le gestionnaire de Hook par:
+<syntaxhighlight lang="php">
+global $hookmanager;
+</syntaxhighlight>
−2- Placer ensuite l'appel des hooks la où permettre l'ajout de code:
+2- Placer ensuite l'appel des hooks là où l'ajout de code est désiré :
−<source lang="php">
+<syntaxhighlight lang="php">
$parameters=array();
$parameters=array();
$reshook=$hookmanager->executeHooks('hookname',$parameters,$object,$action); // See description below
$reshook=$hookmanager->executeHooks('hookname',$parameters,$object,$action); // See description below
Line 49:
Line 54:
... // standard code that can be disabled/replaced by hook if return code > 0.
... // standard code that can be disabled/replaced by hook if return code > 0.
}
}
−</source>
+</syntaxhighlight>
'''$hookmanager->executeHooks()''' accepte 4 paramètres et ajoute un hook (qui est un point d'entrée dans votre script pour des fonctions externes à votre script et module):
'''$hookmanager->executeHooks()''' accepte 4 paramètres et ajoute un hook (qui est un point d'entrée dans votre script pour des fonctions externes à votre script et module):
Line 56:
Line 61:
- '''$parameters''' est un tableau personnalisé pour transmettre plus de données personnalisées au hook (la fonction dans le hook peut traiter ces données). Placez ici ce que vous voulez, ce peut être un fichier, un tableau de chaînes de caractères, n'importe quoi... Par exemple :
- '''$parameters''' est un tableau personnalisé pour transmettre plus de données personnalisées au hook (la fonction dans le hook peut traiter ces données). Placez ici ce que vous voulez, ce peut être un fichier, un tableau de chaînes de caractères, n'importe quoi... Par exemple :
−<source lang="php">
+<syntaxhighlight lang="php">
$parameters=array('file'=>'my/path/to/a/file', 'customnames'=>array('henry','david','john'));
$parameters=array('file'=>'my/path/to/a/file', 'customnames'=>array('henry','david','john'));
−</source>
+</syntaxhighlight>
- '''$object''' est l'objet que vous voulez passer à la fonction du hook, certainement les données du module courant (ex: l'objet facture si on est dans un module de facture, etc..). Ce peut être ce que vous voulez, mais souvenez vous qu'il sera le principal composant utilisé par les fonctions du hook.
- '''$object''' est l'objet que vous voulez passer à la fonction du hook, certainement les données du module courant (ex: l'objet facture si on est dans un module de facture, etc..). Ce peut être ce que vous voulez, mais souvenez vous qu'il sera le principal composant utilisé par les fonctions du hook.
−- '''$action''' est une chaîne indiquant l'action courante (peut être null ou quelque chose qui ressemble à 'create' ou 'edit').
+- '''$action''' est une chaîne indiquant l'action courante (peut être ''null'' ou quelque chose qui ressemble à 'create' ou 'edit').
Note: Vous devrez refaire cette étape plusieurs fois si vous voulez ajouter plusieurs hooks à différent endroits de votre script.
Note: Vous devrez refaire cette étape plusieurs fois si vous voulez ajouter plusieurs hooks à différent endroits de votre script.
−Maintenant votre module devrait pouvoir être hooké, vous pouvez suivre la procédure ci-dessous dans '''Implémenter un hook''' pour implémenter une fonction hook qui en prendra avantage (permet aussi de tester que cela fonctionne).
+Maintenant votre module devrait pouvoir exécuté des hooks d'autres origines. Vous pouvez à présent suivre la procédure ci-dessous ( '''Implémenter un hook''' ) pour construire une fonction qui se raccrochera au hook (permet aussi de tester que cela fonctionne).
=Implémenter un Hook=
=Implémenter un Hook=
Line 74:
Line 79:
Ce qui veut dire que lorsqu'on se trouve dans le contexte donné, votre code sera appelé.
Ce qui veut dire que lorsqu'on se trouve dans le contexte donné, votre code sera appelé.
Pour cela, éditer le descripteur de votre module ('''/htdocs/''yourmodulename''/core/modules/mod''YourModuleName''.class.php''') et renseignez la variable '''$this->module_parts''' comme sur l'exemple :
Pour cela, éditer le descripteur de votre module ('''/htdocs/''yourmodulename''/core/modules/mod''YourModuleName''.class.php''') et renseignez la variable '''$this->module_parts''' comme sur l'exemple :
−<source lang="php">
+<syntaxhighlight lang="php">
$this->module_parts = array(
$this->module_parts = array(
'hooks' => array('hookcontext1','hookcontext2') // Set here all hooks context you want to support
'hooks' => array('hookcontext1','hookcontext2') // Set here all hooks context you want to support
);
);
−</source>
+</syntaxhighlight>
−Note: il est possible de trouver le contexte d'un module en rajoutant
+Note: il est possible de trouver tous les contextes dans lequel vous êtes au sein d'une portion de code PHP en faisant
−<source lang="php">
+<syntaxhighlight lang="php">
−print('Module context: '.$object->context);
+print('Module context: '.join(',', $object->contextarray));
−</source>
+</syntaxhighlight>
−(rajoutez ce bout de code dans le fichier php où réside l'appel des hooks, et supprimez le, une fois la valeur du context relevée).
+(rajoutez ce bout de code dans le fichier PHP où réside l'appel des hooks, et supprimez le, une fois la valeur des contextes relevée).
−[[File:warning.png]] Attention: N'oubliez pas de désactiver puis de réactiver votre module dans l'interface d'administration des modules afin que la modification soit prise en compte car la sauvegarde des couples "modules-hooks" qui doit être gérée est faite en base, laquelle n'est mise à jour qu'au moment de l'activation du module.
+Notez que le contexte '''all''' signifie que vous souhaitez que votre hook soit exécuté quel que soit le contexte. Le '''main''' signifie que vous voulez que votre hook soit exécuté pour n'importe quelle page Web, et '''cli''' signifie dans chaque script de ligne de commande (même si vous ne pouvez pas voir ces clés de contexte dans $object->contextarray).
+[[File:warning.png]] Attention: N'oubliez pas de désactiver puis de réactiver votre module dans l'interface d'administration des modules (ou directement dans le "constructeur de module") afin que la modification soit prise en compte, car l'enregistrement qui relie les éléments du couple "module-hook" est géré en base de donnée; celle-ci n'étant mise à jour qu'au moment de la (ré)activation du module.
Line 93:
Line 100:
Créez '''/htdocs/''yourmodulename''/class/actions_''yourmodulename''.class.php''' dans votre module avec un code qui contient la méthode appelée par le hook (le nom de cette méthode se voit au moment de l'appel executeHooks). Voici un exemple:
Créez '''/htdocs/''yourmodulename''/class/actions_''yourmodulename''.class.php''' dans votre module avec un code qui contient la méthode appelée par le hook (le nom de cette méthode se voit au moment de l'appel executeHooks). Voici un exemple:
−<source lang="php">
+<syntaxhighlight lang="php">
class ActionsYourModuleName
class ActionsYourModuleName
{
{
Line 132:
Line 139:
}
}
}
}
−</source>
+</syntaxhighlight>
La méthode sera alors automatiquement appelée au moment de l'appel du code qui contient le executeHooks fournissant à votre code les éléments $parameters, $object et $action.
La méthode sera alors automatiquement appelée au moment de l'appel du code qui contient le executeHooks fournissant à votre code les éléments $parameters, $object et $action.
−'''Avec''':
+'''Avec''' :
*'''$parameters''' est un tableau (array) de meta-data regroupant les données du hook (son contexte accessible par $parameters['context'] mais d'autres information peuvent etre disponible selon le cas)
*'''$parameters''' est un tableau (array) de meta-data regroupant les données du hook (son contexte accessible par $parameters['context'] mais d'autres information peuvent etre disponible selon le cas)
*'''$object''' est l'objet sur lequel vous désirez travailler (par exemple : product pour le contexte productcard)
*'''$object''' est l'objet sur lequel vous désirez travailler (par exemple : product pour le contexte productcard)
*'''$action''' désigne l'action à exécuter (par exemple "create", "edit" or "view").
*'''$action''' désigne l'action à exécuter (par exemple "create", "edit" or "view").
−*'''$hookmanager''' n'est propagé que pour permettre à votre hook d'appeler d'autres hooks.
+*'''$hookmanager''' n'est propagé que pour permettre à votre hook d'appeler d'autres hooks.<br />
−'''Retours''':
+'''Retours de fonction''' :
*Le code retour d'un hook doit être 0 ou 1 en cas de succès, négatif en cas d'erreur. En général, il sera 0. Il peut être 1, ce qui dans certains cas signifie que ce que fait votre hook remplace complètement ce que devait faire Dolibarr juste après l'appel du hook. Si le code est négatif, il est possible de fournir un message d'erreur à l'utilisateur en positionnant $this->errors[]='Message erreur'
*Le code retour d'un hook doit être 0 ou 1 en cas de succès, négatif en cas d'erreur. En général, il sera 0. Il peut être 1, ce qui dans certains cas signifie que ce que fait votre hook remplace complètement ce que devait faire Dolibarr juste après l'appel du hook. Si le code est négatif, il est possible de fournir un message d'erreur à l'utilisateur en positionnant $this->errors[]='Message erreur'
Line 160:
Line 167:
−=Liste des Contexts disponibles dans Dolibarr=
+=Liste des Contextes disponibles dans Dolibarr=
Pour trouver les contextes disponibles dans Dolibarr, la procédure est similaire aux hooks.
Pour trouver les contextes disponibles dans Dolibarr, la procédure est similaire aux hooks.
Faites une recherche sur "'''initHooks('''" dans le code source et vous trouverez facilement tous les contextes déjà implémentées.
Faites une recherche sur "'''initHooks('''" dans le code source et vous trouverez facilement tous les contextes déjà implémentées.
−{{ListOfContexts}}
−{| class="wikitable sortable"
−Note: veuillez noter que cette liste s'enrichie à chaque version, donc si vous voulez vraiment savoir si un hook ou contexte spécifique existe, veuillez chercher directement dans le code source avec la méthode indiquée ci-dessus.
Note: veuillez noter que cette liste s'enrichie à chaque version, donc si vous voulez vraiment savoir si un hook ou contexte spécifique existe, veuillez chercher directement dans le code source avec la méthode indiquée ci-dessus.