dolibarr 20.0.0
thirdparties_services_expired.modules.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2005-2010 Laurent Destailleur <eldy@users.sourceforge.net>
3 *
4* This file is an example to follow to add your own email selector inside
5* the Dolibarr email tool.
6* Follow instructions given in README file to know what to change to build
7* your own emailing list selector.
8* Code that need to be changed in this file are marked by "CHANGE THIS" tag.
9*/
10
16include_once DOL_DOCUMENT_ROOT.'/core/modules/mailings/modules_mailings.php';
17require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
18
19
24{
25 public $name = 'DolibarrContractsLinesExpired';
26 // This label is used if no translation is found for key XXX neither MailingModuleDescXXX where XXX=name is found
27 public $desc = 'Third parties with expired contract\'s lines';
28 public $require_admin = 0;
29
30 public $require_module = array('contrat');
31
32 public $enabled = 'isModEnabled("societe")';
33
37 public $picto = 'company';
38
39 public $arrayofproducts = array();
40
41
47 public function __construct($db)
48 {
49 global $conf;
50
51 $this->db = $db;
52
53 $this->arrayofproducts = array();
54
55 // List of services
56 $sql = "SELECT ref FROM ".MAIN_DB_PREFIX."product";
57 $sql .= " WHERE entity IN (".getEntity('product').")";
58 if (!getDolGlobalString('CONTRACT_SUPPORT_PRODUCTS')) {
59 $sql .= " AND fk_product_type = 1"; // By default, only services
60 }
61 $sql .= " ORDER BY ref";
62 $result = $this->db->query($sql);
63 if ($result) {
64 $num = $this->db->num_rows($result);
65 dol_syslog("dolibarr_services_expired.modules.php:mailing_dolibarr_services_expired ".$num." services found");
66
67 $i = 0;
68 while ($i < $num) {
69 $obj = $this->db->fetch_object($result);
70 $i++;
71 $this->arrayofproducts[$i] = $obj->ref;
72 }
73 } else {
74 dol_print_error($this->db);
75 }
76 }
77
78
79 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
86 public function add_to_target($mailing_id)
87 {
88 global $conf;
89
90 // phpcs:enable
91 $key = GETPOSTINT('filter');
92
93 $cibles = array();
94 $j = 0;
95
96 $product = '';
97 if ($key == '0') {
98 $this->error = "Error: You must choose a filter";
99 $this->errors[] = $this->error;
100 return -1;
101 }
102
103 $product = $this->arrayofproducts[$key];
104
105 $now = dol_now();
106
107 // La requete doit retourner: id, email, name
108 $sql = "SELECT s.rowid as id, s.email, s.nom as name, cd.rowid as cdid, cd.date_ouverture as date_start_real, cd.date_fin_validite as date_end, cd.fk_contrat";
109 $sql .= " FROM ".MAIN_DB_PREFIX."societe as s, ".MAIN_DB_PREFIX."contrat as c";
110 $sql .= ", ".MAIN_DB_PREFIX."contratdet as cd, ".MAIN_DB_PREFIX."product as p";
111 $sql .= " WHERE s.entity IN (".getEntity('societe').")";
112 $sql .= " AND s.email NOT IN (SELECT email FROM ".MAIN_DB_PREFIX."mailing_cibles WHERE fk_mailing=".((int) $mailing_id).")";
113 $sql .= " AND s.rowid = c.fk_soc AND cd.fk_contrat = c.rowid AND s.email != ''";
114 $sql .= " AND cd.statut= 4 AND cd.fk_product=p.rowid AND p.ref = '".$this->db->escape($product)."'";
115 $sql .= " AND cd.date_fin_validite < '".$this->db->idate($now)."'";
116 if (empty($this->evenunsubscribe)) {
117 $sql .= " AND NOT EXISTS (SELECT rowid FROM ".MAIN_DB_PREFIX."mailing_unsubscribe as mu WHERE mu.email = s.email and mu.entity = ".((int) $conf->entity).")";
118 }
119 $sql .= " ORDER BY s.email";
120
121 // Stocke destinataires dans cibles
122 $result = $this->db->query($sql);
123 if ($result) {
124 $num = $this->db->num_rows($result);
125 $i = 0;
126
127 dol_syslog(get_class($this)."::add_to_target ".$num." targets found");
128
129 $old = '';
130 while ($i < $num) {
131 $obj = $this->db->fetch_object($result);
132 if ($old != $obj->email) {
133 $cibles[$j] = array(
134 'email' => $obj->email,
135 'lastname' => $obj->name, // For thirdparties, lastname must be name
136 'firstname' => '', // For thirdparties, firstname is ''
137 'other' =>
138 ('DateStart='.dol_print_date($this->db->jdate($obj->date_start_real), 'day')).';'. // date start real
139 ('DateEnd='.dol_print_date($this->db->jdate($obj->date_end), 'day')).';'. // date end planned
140 ('Contract='.$obj->fk_contrat).';'.
141 ('ContactLine='.$obj->cdid),
142 'source_url' => $this->url($obj->id),
143 'source_id' => $obj->id,
144 'source_type' => 'thirdparty'
145 );
146 $old = $obj->email;
147 $j++;
148 }
149
150 $i++;
151 }
152 } else {
153 dol_syslog($this->db->lasterror());
154 $this->error = $this->db->lasterror();
155 return -1;
156 }
157
158 // ----- Your code end here -----
159
160 return parent::addTargetsToDatabase($mailing_id, $cibles);
161 }
162
163
172 public function getSqlArrayForStats()
173 {
174
175 //var $statssql=array();
176 //$this->statssql[0]="SELECT field1 as label, count(distinct(email)) as nb FROM mytable WHERE email IS NOT NULL";
177
178 return array();
179 }
180
181
190 public function getNbOfRecipients($sql = '')
191 {
192 global $conf;
193
194 $now = dol_now();
195
196 // Example: return parent::getNbOfRecipients("SELECT count(*) as nb from dolibarr_table");
197 // Example: return 500;
198 $sql = "SELECT count(*) as nb";
199 $sql .= " FROM ".MAIN_DB_PREFIX."societe as s, ".MAIN_DB_PREFIX."contrat as c";
200 $sql .= ", ".MAIN_DB_PREFIX."contratdet as cd, ".MAIN_DB_PREFIX."product as p";
201 $sql .= " WHERE s.entity IN (".getEntity('societe').")";
202 $sql .= " AND s.rowid = c.fk_soc AND cd.fk_contrat = c.rowid AND s.email != ''";
203 $sql .= " AND cd.statut= 4 AND cd.fk_product=p.rowid";
204 $sql .= " AND p.ref IN (".$this->db->sanitize("'".implode("','", $this->arrayofproducts)."'", 1).")";
205 $sql .= " AND cd.date_fin_validite < '".$this->db->idate($now)."'";
206 if (empty($this->evenunsubscribe)) {
207 $sql .= " AND NOT EXISTS (SELECT rowid FROM ".MAIN_DB_PREFIX."mailing_unsubscribe as mu WHERE mu.email = s.email and mu.entity = ".((int) $conf->entity).")";
208 }
209
210 $a = parent::getNbOfRecipients($sql);
211
212 return $a;
213 }
214
221 public function formFilter()
222 {
223 global $langs;
224
225 $s = img_picto('', 'product', 'class="pictofixedwidth"').'<select id="filter_services_expired" name="filter" class="flat">';
226 if (count($this->arrayofproducts)) {
227 $langs->loadLangs(array("products"));
228 $s .= '<option value="-1">'.$langs->trans("ProductOrService").'</option>';
229 } else {
230 $s .= '<option value="0">'.$langs->trans("ContactsAllShort").'</option>';
231 }
232 foreach ($this->arrayofproducts as $key => $val) {
233 $s .= '<option value="'.$key.'">'.$val.'</option>';
234 }
235 $s .= '</select>';
236 $s .= ajax_combobox("filter_services_expired");
237
238 return $s;
239 }
240
241
248 public function url($id)
249 {
250 return '<a href="'.DOL_URL_ROOT.'/societe/card.php?socid='.$id.'">'.img_object('', "company").'</a>';
251 }
252}
ajax_combobox($htmlname, $events=array(), $minLengthToAutocomplete=0, $forcefocus=0, $widthTypeOfAutocomplete='resolve', $idforemptyvalue='-1', $morecss='')
Convert a html select field into an ajax combobox.
Definition ajax.lib.php:456
Parent class of emailing target selectors modules.
Class to offer a selector of emailing targets with Rule 'services expired'.
getSqlArrayForStats()
On the main mailing area, there is a box with statistics.
getNbOfRecipients($sql='')
Return here number of distinct emails returned by your selector.
formFilter()
This is to add a form filter to provide variant of selector If used, the HTML select must be called "...
url($id)
Can include an URL link on each record provided by selector shown on target page.
add_to_target($mailing_id)
This is the main function that returns the array of emails.
img_object($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0)
Show a picto called object_picto (generic function)
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
GETPOSTINT($paramname, $method=0)
Return the value of a $_GET or $_POST supervariable, converted into integer.
dol_now($mode='auto')
Return date for now.
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.