From 66a9fabd06ee295870a8b14039d801a730816021 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Mon, 9 Sep 2019 14:18:25 +0200 Subject: [PATCH] If you develop your own emailing target selector and used parent::add_to_target(...), you must now use parent::addToTargets(...) --- ChangeLog | 1 + htdocs/comm/mailing/class/mailing.class.php | 2 +- htdocs/core/modules/mailings/README | 3 +++ .../core/modules/mailings/advthirdparties.modules.php | 11 ++++++----- htdocs/core/modules/mailings/contacts1.modules.php | 2 +- htdocs/core/modules/mailings/example.modules.php | 2 +- htdocs/core/modules/mailings/fraise.modules.php | 2 +- htdocs/core/modules/mailings/modules_mailings.php | 6 ++---- htdocs/core/modules/mailings/pomme.modules.php | 2 +- htdocs/core/modules/mailings/thirdparties.modules.php | 2 +- .../thirdparties_services_expired.modules.php | 2 +- htdocs/core/modules/mailings/xinputfile.modules.php | 2 +- htdocs/core/modules/mailings/xinputuser.modules.php | 5 ++--- .../mailinglist_mymodule_myobject.modules.php | 2 +- 14 files changed, 23 insertions(+), 21 deletions(-) diff --git a/ChangeLog b/ChangeLog index 2e0bbf78352..3aa4f789f3f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -20,6 +20,7 @@ Following changes may create regressions for some external modules, but were nec * The deprecated method get_OutstandingBill has been removed. You can use getOutstandingBills() instead. * The hook "moreFamily" must return payment into var "totalpayment" and no more "paiement" (english replace french). * Removed deprecated method actioncomm->add(), use create() instead +* If you develop your own emailing target selector and used parent::add_to_target(...), you must now use parent::addToTargets(...) ***** ChangeLog for 10.0.1 compared to 10.0.0 ***** diff --git a/htdocs/comm/mailing/class/mailing.class.php b/htdocs/comm/mailing/class/mailing.class.php index d82ec07612d..adb817f418f 100644 --- a/htdocs/comm/mailing/class/mailing.class.php +++ b/htdocs/comm/mailing/class/mailing.class.php @@ -370,7 +370,7 @@ class Mailing extends CommonObject return -1; } - $mailing_target->add_to_target($object->id, $target_array); + $mailing_target->addTargetsToDatabase($object->id, $target_array); } } diff --git a/htdocs/core/modules/mailings/README b/htdocs/core/modules/mailings/README index 096f680bd38..a69265a9424 100644 --- a/htdocs/core/modules/mailings/README +++ b/htdocs/core/modules/mailings/README @@ -43,6 +43,9 @@ $target[0]=array('email'=>'email_0','name'=>'name_0','firstname'=>'firstname_0', $target[n]=array('email'=>'email_n','name'=>'name_n','firstname'=>'firstname_n', 'other'=>'other_n'); // ----- Your code end here ----- +and call the method + +parent::addTargetsToDatabase($mailing_id, $target); ***** STEP 3 ***** diff --git a/htdocs/core/modules/mailings/advthirdparties.modules.php b/htdocs/core/modules/mailings/advthirdparties.modules.php index a29fdd119bf..a27863cf055 100644 --- a/htdocs/core/modules/mailings/advthirdparties.modules.php +++ b/htdocs/core/modules/mailings/advthirdparties.modules.php @@ -65,7 +65,7 @@ class mailing_advthirdparties extends MailingTargets // phpcs:enable global $conf, $langs; - dol_syslog(get_class($this)."::add_to_target socid=".var_export($socid, true).' contactid='.var_export($contactid, true)); + dol_syslog(get_class($this)."::add_to_target_spec socid=".var_export($socid, true).' contactid='.var_export($contactid, true)); $cibles = array(); @@ -86,7 +86,7 @@ class mailing_advthirdparties extends MailingTargets $num = $this->db->num_rows($result); $i = 0; - dol_syslog(get_class($this)."::add_to_target mailing ".$num." targets found", LOG_DEBUG); + dol_syslog(get_class($this)."::add_to_target_spec mailing ".$num." targets found", LOG_DEBUG); $old = ''; while ($i < $num) @@ -142,7 +142,7 @@ class mailing_advthirdparties extends MailingTargets $num = $this->db->num_rows($result); $i = 0; - dol_syslog(get_class($this)."::add_to_target mailing ".$num." targets found"); + dol_syslog(get_class($this)."::add_to_target_spec mailing ".$num." targets found"); $old = ''; while ($i < $num) @@ -177,8 +177,9 @@ class mailing_advthirdparties extends MailingTargets } - dol_syslog(get_class($this)."::add_to_target mailing cibles=".var_export($cibles, true), LOG_DEBUG); - return parent::add_to_target($mailing_id, $cibles); + dol_syslog(get_class($this)."::add_to_target_spec mailing cibles=".var_export($cibles, true), LOG_DEBUG); + + return parent::addTargetsToDatabase($mailing_id, $cibles); } diff --git a/htdocs/core/modules/mailings/contacts1.modules.php b/htdocs/core/modules/mailings/contacts1.modules.php index 79c58b1c7ce..bc67c8d3fec 100644 --- a/htdocs/core/modules/mailings/contacts1.modules.php +++ b/htdocs/core/modules/mailings/contacts1.modules.php @@ -447,6 +447,6 @@ class mailing_contacts1 extends MailingTargets return -1; } - return parent::add_to_target($mailing_id, $cibles); + return parent::addTargetsToDatabase($mailing_id, $cibles); } } diff --git a/htdocs/core/modules/mailings/example.modules.php b/htdocs/core/modules/mailings/example.modules.php index 45af3dd5b4d..a96457c2625 100644 --- a/htdocs/core/modules/mailings/example.modules.php +++ b/htdocs/core/modules/mailings/example.modules.php @@ -80,7 +80,7 @@ class mailing_example extends MailingTargets // ----- Your code end here ----- - return parent::add_to_target($mailing_id, $target); + return parent::addTargetsToDatabase($mailing_id, $target); } diff --git a/htdocs/core/modules/mailings/fraise.modules.php b/htdocs/core/modules/mailings/fraise.modules.php index 2ea4ba8e3b5..60196b23784 100644 --- a/htdocs/core/modules/mailings/fraise.modules.php +++ b/htdocs/core/modules/mailings/fraise.modules.php @@ -315,6 +315,6 @@ class mailing_fraise extends MailingTargets return -1; } - return parent::add_to_target($mailing_id, $cibles); + return parent::addTargetsToDatabase($mailing_id, $cibles); } } diff --git a/htdocs/core/modules/mailings/modules_mailings.php b/htdocs/core/modules/mailings/modules_mailings.php index 6c97e165199..42a9868cf7c 100644 --- a/htdocs/core/modules/mailings/modules_mailings.php +++ b/htdocs/core/modules/mailings/modules_mailings.php @@ -151,17 +151,15 @@ class MailingTargets // This can't be abstract as it is used for some method return $nb; } - // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps /** - * Ajoute destinataires dans table des cibles + * Add a list of targets int the database * * @param int $mailing_id Id of emailing * @param array $cibles Array with targets * @return int < 0 si erreur, nb ajout si ok */ - public function add_to_target($mailing_id, $cibles) + public function addTargetsToDatabase($mailing_id, $cibles) { - // phpcs:enable global $conf; $this->db->begin(); diff --git a/htdocs/core/modules/mailings/pomme.modules.php b/htdocs/core/modules/mailings/pomme.modules.php index 74dc86c1d9a..1f4fff68bf1 100644 --- a/htdocs/core/modules/mailings/pomme.modules.php +++ b/htdocs/core/modules/mailings/pomme.modules.php @@ -217,6 +217,6 @@ class mailing_pomme extends MailingTargets return -1; } - return parent::add_to_target($mailing_id, $cibles); + return parent::addTargetsToDatabase($mailing_id, $cibles); } } diff --git a/htdocs/core/modules/mailings/thirdparties.modules.php b/htdocs/core/modules/mailings/thirdparties.modules.php index 10e5f9e93c9..00db6eb89ea 100644 --- a/htdocs/core/modules/mailings/thirdparties.modules.php +++ b/htdocs/core/modules/mailings/thirdparties.modules.php @@ -190,7 +190,7 @@ class mailing_thirdparties extends MailingTargets return -1; } - return parent::add_to_target($mailing_id, $cibles); + return parent::addTargetsToDatabase($mailing_id, $cibles); } diff --git a/htdocs/core/modules/mailings/thirdparties_services_expired.modules.php b/htdocs/core/modules/mailings/thirdparties_services_expired.modules.php index a19c5480722..75dc4b9499b 100644 --- a/htdocs/core/modules/mailings/thirdparties_services_expired.modules.php +++ b/htdocs/core/modules/mailings/thirdparties_services_expired.modules.php @@ -159,7 +159,7 @@ class mailing_thirdparties_services_expired extends MailingTargets // ----- Your code end here ----- - return parent::add_to_target($mailing_id, $cibles); + return parent::addTargetsToDatabase($mailing_id, $cibles); } diff --git a/htdocs/core/modules/mailings/xinputfile.modules.php b/htdocs/core/modules/mailings/xinputfile.modules.php index f4eac646db6..6a7af95b17b 100644 --- a/htdocs/core/modules/mailings/xinputfile.modules.php +++ b/htdocs/core/modules/mailings/xinputfile.modules.php @@ -221,6 +221,6 @@ class mailing_xinputfile extends MailingTargets ini_set('auto_detect_line_endings', false); - return parent::add_to_target($mailing_id, $cibles); + return parent::addTargetsToDatabase($mailing_id, $cibles); } } diff --git a/htdocs/core/modules/mailings/xinputuser.modules.php b/htdocs/core/modules/mailings/xinputuser.modules.php index cd3a6f79b0f..e56bfbc66a2 100644 --- a/htdocs/core/modules/mailings/xinputuser.modules.php +++ b/htdocs/core/modules/mailings/xinputuser.modules.php @@ -113,10 +113,9 @@ class mailing_xinputuser extends MailingTargets * Ajoute destinataires dans table des cibles * * @param int $mailing_id Id of emailing - * @param array $cibles Array with targets * @return int < 0 si erreur, nb ajout si ok */ - public function add_to_target($mailing_id, $cibles) + public function add_to_target($mailing_id) { // phpcs:enable global $conf,$langs,$_FILES; @@ -144,7 +143,7 @@ class mailing_xinputuser extends MailingTargets 'source_type' => 'file' ); - return parent::add_to_target($mailing_id, $cibles); + return parent::addTargetsToDatabase($mailing_id, $cibles); } else { diff --git a/htdocs/modulebuilder/template/core/modules/mailings/mailinglist_mymodule_myobject.modules.php b/htdocs/modulebuilder/template/core/modules/mailings/mailinglist_mymodule_myobject.modules.php index 07419af532d..41974ca8b79 100644 --- a/htdocs/modulebuilder/template/core/modules/mailings/mailinglist_mymodule_myobject.modules.php +++ b/htdocs/modulebuilder/template/core/modules/mailings/mailinglist_mymodule_myobject.modules.php @@ -161,7 +161,7 @@ class mailing_mailinglist_mymodule_myobject extends MailingTargets // ----- Your code end here ----- - return parent::add_to_target($mailing_id, $target); + return parent::addTargetsToDatabase($mailing_id, $target); }