diff --git a/htdocs/core/modules/mailings/contacts1.modules.php b/htdocs/core/modules/mailings/contacts1.modules.php index 5b7b04d95c1..42e5863fa55 100755 --- a/htdocs/core/modules/mailings/contacts1.modules.php +++ b/htdocs/core/modules/mailings/contacts1.modules.php @@ -42,12 +42,25 @@ class mailing_contacts1 extends MailingTargets var $db; - function mailing_contacts1($DB) + /** + * Constructor + * + * @param DoliDB $db Database handler + */ + function mailing_contacts1($db) { - $this->db=$DB; + $this->db=$db; } + /** + * On the main mailing area, there is a box with statistics. + * If you want to add a line in this report you must provide an + * array of SQL request that returns two field: + * One called "label", One called "nb". + * + * @return array Array with SQL requests + */ function getSqlArrayForStats() { global $conf, $langs; diff --git a/htdocs/core/modules/mailings/contacts2.modules.php b/htdocs/core/modules/mailings/contacts2.modules.php index 17a1fd2a217..47c8b34a6ed 100755 --- a/htdocs/core/modules/mailings/contacts2.modules.php +++ b/htdocs/core/modules/mailings/contacts2.modules.php @@ -41,9 +41,14 @@ class mailing_contacts2 extends MailingTargets var $db; - function mailing_contacts2($DB) + /** + * Constructor + * + * @param DoliDB $db Database handler + */ + function mailing_contacts2($db) { - $this->db=$DB; + $this->db=$db; } @@ -109,11 +114,12 @@ class mailing_contacts2 extends MailingTargets /** - * On the main mailing area, there is a box with statistics. - * If you want to add a line in this report you must provide an - * array of SQL request that returns two field: - * One called "label", One called "nb". - * @return array + * On the main mailing area, there is a box with statistics. + * If you want to add a line in this report you must provide an + * array of SQL request that returns two field: + * One called "label", One called "nb". + * + * @return array Array with SQL requests */ function getSqlArrayForStats() { diff --git a/htdocs/core/modules/mailings/contacts3.modules.php b/htdocs/core/modules/mailings/contacts3.modules.php index b776bfdb796..7bbb2c0c9c5 100755 --- a/htdocs/core/modules/mailings/contacts3.modules.php +++ b/htdocs/core/modules/mailings/contacts3.modules.php @@ -41,12 +41,16 @@ class mailing_contacts3 extends MailingTargets var $db; - function mailing_contacts3($DB) + /** + * Constructor + * + * @param DoliDB $db Database handler + */ + function mailing_contacts3($db) { - $this->db=$DB; + $this->db=$db; } - /** * \brief Renvoie url lien vers fiche de la source du destinataire du mailing * \return string Url lien @@ -114,13 +118,14 @@ class mailing_contacts3 extends MailingTargets /** - * On the main mailing area, there is a box with statistics. - * If you want to add a line in this report you must provide an - * array of SQL request that returns two field: - * One called "label", One called "nb". - * @return array + * On the main mailing area, there is a box with statistics. + * If you want to add a line in this report you must provide an + * array of SQL request that returns two field: + * One called "label", One called "nb". + * + * @return array Array with SQL requests */ - function getSqlArrayForStats() + function getSqlArrayForStats() { global $conf, $langs; diff --git a/htdocs/core/modules/mailings/example.modules.php b/htdocs/core/modules/mailings/example.modules.php index d82611174d7..c65a19e8592 100644 --- a/htdocs/core/modules/mailings/example.modules.php +++ b/htdocs/core/modules/mailings/example.modules.php @@ -51,10 +51,11 @@ class mailing_example extends MailingTargets /** - * \brief This is the main function that returns the array of emails - * \param mailing_id Id of mailing. No need to use it. - * \param filterarray If you used the formFilter function. Empty otherwise. - * \return int <0 if error, number of emails added if ok + * This is the main function that returns the array of emails + * + * @param mailing_id Id of mailing. No need to use it. + * @param filterarray If you used the formFilter function. Empty otherwise. + * @return int <0 if error, number of emails added if ok */ function add_to_target($mailing_id,$filtersarray=array()) { @@ -77,11 +78,12 @@ class mailing_example extends MailingTargets /** - * \brief On the main mailing area, there is a box with statistics. - * If you want to add a line in this report you must provide an - * array of SQL request that returns two field: - * One called "label", One called "nb". - * \return array + * On the main mailing area, there is a box with statistics. + * If you want to add a line in this report you must provide an + * array of SQL request that returns two field: + * One called "label", One called "nb". + * + * @return array Array with SQL requests */ function getSqlArrayForStats() { @@ -93,11 +95,12 @@ class mailing_example extends MailingTargets } - /* - * \brief Return here number of distinct emails returned by your selector. - * For example if this selector is used to extract 500 different - * emails from a text file, this function must return 500. - * \return int + /** + * Return here number of distinct emails returned by your selector. + * For example if this selector is used to extract 500 different + * emails from a text file, this function must return 500. + * + * @return int */ function getNbOfRecipients() { @@ -109,9 +112,10 @@ class mailing_example extends MailingTargets } /** - * \brief This is to add a form filter to provide variant of selector - * If used, the HTML select must be called "filter" - * \return string A html select zone + * This is to add a form filter to provide variant of selector + * If used, the HTML select must be called "filter" + * + * @return string A html select zone */ function formFilter() { @@ -123,9 +127,10 @@ class mailing_example extends MailingTargets /** - * \brief Can include an URL link on each record provided by selector - * shown on target page. - * \return string Url link + * Can include an URL link on each record provided by selector + * shown on target page. + * + * @return string Url link */ function url($id) { diff --git a/htdocs/core/modules/mailings/fraise.modules.php b/htdocs/core/modules/mailings/fraise.modules.php index 997522d669e..381659c457a 100644 --- a/htdocs/core/modules/mailings/fraise.modules.php +++ b/htdocs/core/modules/mailings/fraise.modules.php @@ -47,13 +47,26 @@ class mailing_fraise extends MailingTargets var $db; - function mailing_fraise($DB) + /** + * Constructor + * + * @param DoliDB $db Database handler + */ + function mailing_fraise($db) { - $this->db=$DB; + $this->db=$db; } - function getSqlArrayForStats() + /** + * On the main mailing area, there is a box with statistics. + * If you want to add a line in this report you must provide an + * array of SQL request that returns two field: + * One called "label", One called "nb". + * + * @return array Array with SQL requests + */ + function getSqlArrayForStats() { global $langs; diff --git a/htdocs/core/modules/mailings/framboise.modules.php b/htdocs/core/modules/mailings/framboise.modules.php index 90f2cc77388..6d689d7b081 100644 --- a/htdocs/core/modules/mailings/framboise.modules.php +++ b/htdocs/core/modules/mailings/framboise.modules.php @@ -40,11 +40,11 @@ class mailing_framboise extends MailingTargets /** * Constructor * - * @param DoliDB $DB Database handler + * @param DoliDB $db Database handler */ - function mailing_framboise($DB) + function mailing_framboise($db) { - $this->db=$DB; + $this->db=$db; } @@ -117,12 +117,13 @@ class mailing_framboise extends MailingTargets } - /** - * \brief On the main mailing area, there is a box with statistics. - * If you want to add a line in this report you must provide an - * array of SQL request that returns two field: - * One called "label", One called "nb". - * \return array + /** + * On the main mailing area, there is a box with statistics. + * If you want to add a line in this report you must provide an + * array of SQL request that returns two field: + * One called "label", One called "nb". + * + * @return array Array with SQL requests */ function getSqlArrayForStats() { diff --git a/htdocs/core/modules/mailings/modules_mailings.php b/htdocs/core/modules/mailings/modules_mailings.php index b58b2d94d0e..1f468399cf5 100644 --- a/htdocs/core/modules/mailings/modules_mailings.php +++ b/htdocs/core/modules/mailings/modules_mailings.php @@ -39,11 +39,11 @@ class MailingTargets // This can't be abstract as it is used for some method /** * Constructor * - * @param DoliDB $DB Database handler + * @param DoliDB $db Database handler */ - function MailingTargets($DB) + function MailingTargets($db) { - $this->db = $DB; + $this->db = $db; } /** diff --git a/htdocs/core/modules/mailings/peche.modules.php b/htdocs/core/modules/mailings/peche.modules.php index c0894917e17..09b5e472c41 100644 --- a/htdocs/core/modules/mailings/peche.modules.php +++ b/htdocs/core/modules/mailings/peche.modules.php @@ -40,12 +40,25 @@ class mailing_peche extends MailingTargets var $db; - function mailing_peche($DB) + /** + * Constructor + * + * @param DoliDB $db Database handler + */ + function mailing_peche($db) { - $this->db=$DB; + $this->db=$db; } + /** + * On the main mailing area, there is a box with statistics. + * If you want to add a line in this report you must provide an + * array of SQL request that returns two field: + * One called "label", One called "nb". + * + * @return array Array with SQL requests + */ function getSqlArrayForStats() { global $langs; diff --git a/htdocs/core/modules/mailings/pomme.modules.php b/htdocs/core/modules/mailings/pomme.modules.php index 41dfe8514f3..56033172566 100644 --- a/htdocs/core/modules/mailings/pomme.modules.php +++ b/htdocs/core/modules/mailings/pomme.modules.php @@ -40,12 +40,25 @@ class mailing_pomme extends MailingTargets var $db; - function mailing_pomme($DB) + /** + * Constructor + * + * @param DoliDB $db Database handler + */ + function mailing_pomme($db) { - $this->db=$DB; + $this->db=$db; } + /** + * On the main mailing area, there is a box with statistics. + * If you want to add a line in this report you must provide an + * array of SQL request that returns two field: + * One called "label", One called "nb". + * + * @return array Array with SQL requests + */ function getSqlArrayForStats() { global $conf, $langs; diff --git a/htdocs/core/modules/mailings/thirdparties.modules.php b/htdocs/core/modules/mailings/thirdparties.modules.php index 45b6318272d..afa6f987d35 100755 --- a/htdocs/core/modules/mailings/thirdparties.modules.php +++ b/htdocs/core/modules/mailings/thirdparties.modules.php @@ -37,9 +37,14 @@ class mailing_thirdparties extends MailingTargets var $db; - function mailing_thirdparties($DB) + /** + * Constructor + * + * @param DoliDB $DB Database handler + */ + function mailing_thirdparties($db) { - $this->db=$DB; + $this->db=$db; } @@ -112,12 +117,13 @@ class mailing_thirdparties extends MailingTargets } - /** - * \brief On the main mailing area, there is a box with statistics. - * If you want to add a line in this report you must provide an - * array of SQL request that returns two field: - * One called "label", One called "nb". - * \return array + /** + * On the main mailing area, there is a box with statistics. + * If you want to add a line in this report you must provide an + * array of SQL request that returns two field: + * One called "label", One called "nb". + * + * @return array Array with SQL requests */ function getSqlArrayForStats() { diff --git a/htdocs/core/modules/mailings/thirdparties_services_expired.modules.php b/htdocs/core/modules/mailings/thirdparties_services_expired.modules.php index abaee5eeca7..9e0304b027e 100755 --- a/htdocs/core/modules/mailings/thirdparties_services_expired.modules.php +++ b/htdocs/core/modules/mailings/thirdparties_services_expired.modules.php @@ -1,12 +1,12 @@ * - * This file is an example to follow to add your own email selector inside - * the Dolibarr email tool. - * Follow instructions given in README file to know what to change to build - * your own emailing list selector. - * Code that need to be changed in this file are marked by "CHANGE THIS" tag. - */ +* This file is an example to follow to add your own email selector inside +* the Dolibarr email tool. +* Follow instructions given in README file to know what to change to build +* your own emailing list selector. +* Code that need to be changed in this file are marked by "CHANGE THIS" tag. +*/ /** * \file htdocs/core/modules/mailings/thirdparties_services_expired.modules.php @@ -23,71 +23,70 @@ require_once(DOL_DOCUMENT_ROOT."/core/lib/functions2.lib.php"); */ class mailing_thirdparties_services_expired extends MailingTargets { - var $name='DolibarrContractsLinesExpired'; - var $desc='Third parties with expired contract\'s lines'; - var $require_admin=0; + var $name='DolibarrContractsLinesExpired'; + var $desc='Third parties with expired contract\'s lines'; + var $require_admin=0; - var $require_module=array('contrat'); - var $picto='company'; - var $db; - var $arrayofproducts=array(); + var $require_module=array('contrat'); + var $picto='company'; + var $db; + var $arrayofproducts=array(); - /** - * Constructor - * - * @param DoliDB $DB Database handler - * @return mailing_thirdparties_services_expired - */ - function mailing_thirdparties_services_expired($DB) - { - $this->db=$DB; + /** + * Constructor + * + * @param DoliDB $db Database handler + */ + function mailing_thirdparties_services_expired($db) + { + $this->db=$db; - $this->arrayofproducts=array(); + $this->arrayofproducts=array(); - // List of services - $sql = "SELECT ref FROM ".MAIN_DB_PREFIX."product"; - $sql.= " WHERE fk_product_type = 1"; - $sql.= " ORDER BY ref"; - $result=$this->db->query($sql); - if ($result) - { - $num = $this->db->num_rows($result); - dol_syslog("dolibarr_services_expired.modules.php:mailing_dolibarr_services_expired ".$num." services found"); + // List of services + $sql = "SELECT ref FROM ".MAIN_DB_PREFIX."product"; + $sql.= " WHERE fk_product_type = 1"; + $sql.= " ORDER BY ref"; + $result=$this->db->query($sql); + if ($result) + { + $num = $this->db->num_rows($result); + dol_syslog("dolibarr_services_expired.modules.php:mailing_dolibarr_services_expired ".$num." services found"); - $i = 0; - while ($i < $num) - { - $obj = $this->db->fetch_object($result); - $i++; - $this->arrayofproducts[$i]=$obj->ref; - } + $i = 0; + while ($i < $num) + { + $obj = $this->db->fetch_object($result); + $i++; + $this->arrayofproducts[$i]=$obj->ref; + } - } - else - { - dol_print_error($this->db); - } - } + } + else + { + dol_print_error($this->db); + } + } - /** - * \brief This is the main function that returns the array of emails - * \param mailing_id Id of mailing. No need to use it. - * \param filterarray If you used the formFilter function. Empty otherwise. - * \return int <0 if error, number of emails added if ok - */ - function add_to_target($mailing_id,$filtersarray=array()) - { - $target = array(); + /** + * \brief This is the main function that returns the array of emails + * \param mailing_id Id of mailing. No need to use it. + * \param filterarray If you used the formFilter function. Empty otherwise. + * \return int <0 if error, number of emails added if ok + */ + function add_to_target($mailing_id,$filtersarray=array()) + { + $target = array(); - // ----- Your code start here ----- + // ----- Your code start here ----- - $cibles = array(); - $j = 0; + $cibles = array(); + $j = 0; - $product=''; - foreach($filtersarray as $key) + $product=''; + foreach($filtersarray as $key) { if ($key == '0') return "Error: You must choose a filter"; $product=$this->arrayofproducts[$key]; @@ -95,139 +94,140 @@ class mailing_thirdparties_services_expired extends MailingTargets $now=dol_now(); - // La requete doit retourner: id, email, name - $sql = " select s.rowid as id, s.email, s.nom as name, cd.rowid as cdid, cd.date_ouverture, cd.date_fin_validite, cd.fk_contrat"; - $sql.= " from ".MAIN_DB_PREFIX."societe as s, ".MAIN_DB_PREFIX."contrat as c,"; - $sql.= " ".MAIN_DB_PREFIX."contratdet as cd, ".MAIN_DB_PREFIX."product as p"; - $sql.= " where s.rowid = c.fk_soc AND cd.fk_contrat = c.rowid AND s.email != ''"; - $sql.= " AND cd.statut= 4 AND cd.fk_product=p.rowid AND p.ref = '".$product."'"; - $sql.= " AND cd.date_fin_validite < '".$this->db->idate($now)."'"; - $sql.= " ORDER BY s.email"; + // La requete doit retourner: id, email, name + $sql = " select s.rowid as id, s.email, s.nom as name, cd.rowid as cdid, cd.date_ouverture, cd.date_fin_validite, cd.fk_contrat"; + $sql.= " from ".MAIN_DB_PREFIX."societe as s, ".MAIN_DB_PREFIX."contrat as c,"; + $sql.= " ".MAIN_DB_PREFIX."contratdet as cd, ".MAIN_DB_PREFIX."product as p"; + $sql.= " where s.rowid = c.fk_soc AND cd.fk_contrat = c.rowid AND s.email != ''"; + $sql.= " AND cd.statut= 4 AND cd.fk_product=p.rowid AND p.ref = '".$product."'"; + $sql.= " AND cd.date_fin_validite < '".$this->db->idate($now)."'"; + $sql.= " ORDER BY s.email"; - // Stocke destinataires dans cibles - $result=$this->db->query($sql); - if ($result) - { - $num = $this->db->num_rows($result); - $i = 0; + // Stocke destinataires dans cibles + $result=$this->db->query($sql); + if ($result) + { + $num = $this->db->num_rows($result); + $i = 0; - dol_syslog(get_class($this)."::add_to_target ".$num." targets found"); + dol_syslog(get_class($this)."::add_to_target ".$num." targets found"); - $old = ''; - while ($i < $num) - { - $obj = $this->db->fetch_object($result); - if ($old <> $obj->email) - { - $cibles[$j] = array( + $old = ''; + while ($i < $num) + { + $obj = $this->db->fetch_object($result); + if ($old <> $obj->email) + { + $cibles[$j] = array( 'email' => $obj->email, 'name' => $obj->name, 'other' => - ('StartDate='.dol_print_date($this->db->jdate($obj->date_ouverture),'day')).';'. - ('EndDate='.dol_print_date($this->db->jdate($obj->date_fin_validite),'day')).';'. - ('Contract='.$obj->fk_contrat).';'. - ('ContactLine='.$obj->cdid), + ('StartDate='.dol_print_date($this->db->jdate($obj->date_ouverture),'day')).';'. + ('EndDate='.dol_print_date($this->db->jdate($obj->date_fin_validite),'day')).';'. + ('Contract='.$obj->fk_contrat).';'. + ('ContactLine='.$obj->cdid), 'source_url' => $this->url($obj->id), 'source_id' => $obj->id, 'source_type' => 'thirdparty' - ); - $old = $obj->email; - $j++; - } + ); + $old = $obj->email; + $j++; + } - $i++; - } - } - else - { - dol_syslog($this->db->error()); - $this->error=$this->db->error(); - return -1; - } + $i++; + } + } + else + { + dol_syslog($this->db->error()); + $this->error=$this->db->error(); + return -1; + } - // ----- Your code end here ----- + // ----- Your code end here ----- - return parent::add_to_target($mailing_id, $cibles); - } + return parent::add_to_target($mailing_id, $cibles); + } - /** - * \brief On the main mailing area, there is a box with statistics. - * If you want to add a line in this report you must provide an - * array of SQL request that returns two field: - * One called "label", One called "nb". - * \return array - */ - function getSqlArrayForStats() - { + /** + * On the main mailing area, there is a box with statistics. + * If you want to add a line in this report you must provide an + * array of SQL request that returns two field: + * One called "label", One called "nb". + * + * @return array Array with SQL requests + */ + function getSqlArrayForStats() + { - //var $statssql=array(); - //$this->statssql[0]="SELECT field1 as label, count(distinct(email)) as nb FROM mytable WHERE email IS NOT NULL"; + //var $statssql=array(); + //$this->statssql[0]="SELECT field1 as label, count(distinct(email)) as nb FROM mytable WHERE email IS NOT NULL"; - return array(); - } + return array(); + } - /** - * \brief Return here number of distinct emails returned by your selector. - * For example if this selector is used to extract 500 different - * emails from a text file, this function must return 500. - * \return int - */ - function getNbOfRecipients($filter=1,$option='') - { + /** + * \brief Return here number of distinct emails returned by your selector. + * For example if this selector is used to extract 500 different + * emails from a text file, this function must return 500. + * \return int + */ + function getNbOfRecipients($filter=1,$option='') + { $now=dol_now(); // Example: return parent::getNbOfRecipients("SELECT count(*) as nb from dolibarr_table"); - // Example: return 500; - $sql = " select count(*) as nb"; - $sql.= " from ".MAIN_DB_PREFIX."societe as s, ".MAIN_DB_PREFIX."contrat as c,"; - $sql.= " ".MAIN_DB_PREFIX."contratdet as cd, ".MAIN_DB_PREFIX."product as p"; - $sql.= " where s.rowid = c.fk_soc AND cd.fk_contrat = c.rowid AND s.email != ''"; - $sql.= " AND cd.statut= 4 AND cd.fk_product=p.rowid"; - $sql.= " AND p.ref in ('".join("','",$this->arrayofproducts)."')"; - $sql.= " AND cd.date_fin_validite < '".$this->db->idate($now)."'"; - //print $sql; - $a=parent::getNbOfRecipients($sql); + // Example: return 500; + $sql = " select count(*) as nb"; + $sql.= " from ".MAIN_DB_PREFIX."societe as s, ".MAIN_DB_PREFIX."contrat as c,"; + $sql.= " ".MAIN_DB_PREFIX."contratdet as cd, ".MAIN_DB_PREFIX."product as p"; + $sql.= " where s.rowid = c.fk_soc AND cd.fk_contrat = c.rowid AND s.email != ''"; + $sql.= " AND cd.statut= 4 AND cd.fk_product=p.rowid"; + $sql.= " AND p.ref in ('".join("','",$this->arrayofproducts)."')"; + $sql.= " AND cd.date_fin_validite < '".$this->db->idate($now)."'"; + //print $sql; + $a=parent::getNbOfRecipients($sql); - return $a; - } + return $a; + } - /** - * \brief This is to add a form filter to provide variant of selector - * If used, the HTML select must be called "filter" - * \return string A html select zone - */ - function formFilter() - { + /** + * \brief This is to add a form filter to provide variant of selector + * If used, the HTML select must be called "filter" + * \return string A html select zone + */ + function formFilter() + { global $langs; - $s=''; + $s=''; $s.=''; - return $s; - } + return $s; + } - /** - * \brief Can include an URL link on each record provided by selector - * shown on target page. - * \return string Url link - */ - function url($id) - { - //$companystatic=new Societe($this->db); - //$companystatic->id=$id; - //$companystatic->nom=''; - //return $companystatic->getNomUrl(1); // Url too long + /** + * \brief Can include an URL link on each record provided by selector + * shown on target page. + * \return string Url link + */ + function url($id) + { + //$companystatic=new Societe($this->db); + //$companystatic->id=$id; + //$companystatic->nom=''; + //return $companystatic->getNomUrl(1); // Url too long return ''.img_object('',"company").''; - } + } }