dolibarr 21.0.0-alpha
eventorganization.modules.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2018-2018 Andre Schild <a.schild@aarboard.ch>
3 * Copyright (C) 2005-2010 Laurent Destailleur <eldy@users.sourceforge.net>
4 * Copyright (C) 2005-2009 Regis Houssin <regis.houssin@inodbox.com>
5 *
6 * This file is an example to follow to add your own email selector inside
7 * the Dolibarr email tool.
8 * Follow instructions given in README file to know what to change to build
9 * your own emailing list selector.
10 * Code that need to be changed in this file are marked by "CHANGE THIS" tag.
11 */
12
20// Load Dolibarr Environment
21include_once DOL_DOCUMENT_ROOT.'/core/modules/mailings/modules_mailings.php';
22
23
28{
29 // This label is used if no translation is found for key XXX neither MailingModuleDescXXX where XXX=name is found
30 public $name = 'AttendeesOfOrganizedEvent';
31 public $desc = "Attendees of an organized event";
32
33 public $require_admin = 0;
34
35 public $require_module = array(); // This module allows to select by categories must be also enabled if category module is not activated
36
40 public $picto = 'conferenceorbooth';
41
42 public $enabled = 'isModEnabled("eventorganization")';
43
44
50 public function __construct($db)
51 {
52 global $conf, $langs;
53 $langs->load('companies');
54
55 $this->db = $db;
56 }
57
58
59 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
66 public function add_to_target($mailing_id)
67 {
68 // phpcs:enable
69 global $conf, $langs;
70
71 $cibles = array();
72 $addDescription = '';
73
74 $sql = "SELECT p.ref, p.entity, e.rowid as id, e.fk_project, e.email as email, e.email_company as company_name, e.firstname as firstname, e.lastname as lastname,";
75 $sql .= " 'eventorganizationattendee' as source";
76 $sql .= " FROM ".MAIN_DB_PREFIX."eventorganization_conferenceorboothattendee as e,";
77 $sql .= " ".MAIN_DB_PREFIX."projet as p";
78 $sql .= " WHERE e.email <> ''";
79 $sql .= " AND e.fk_project = p.rowid";
80 $sql .= " AND p.entity IN (".getEntity('project').")";
81 $sql .= " AND e.email NOT IN (SELECT email FROM ".MAIN_DB_PREFIX."mailing_cibles WHERE fk_mailing=".((int) $mailing_id).")";
82 if (GETPOSTINT('filter_eventorganization') > 0) {
83 $sql .= " AND e.fk_project = ".(GETPOSTINT('filter_eventorganization'));
84 }
85 if (empty($this->evenunsubscribe)) {
86 $sql .= " AND NOT EXISTS (SELECT rowid FROM ".MAIN_DB_PREFIX."mailing_unsubscribe as mu WHERE mu.email = e.email and mu.entity = ".((int) $conf->entity).")";
87 }
88 $sql .= " ORDER BY e.email";
89
90 // Stock recipients emails into targets table
91 $result = $this->db->query($sql);
92 if ($result) {
93 $num = $this->db->num_rows($result);
94 $i = 0;
95 $j = 0;
96
97 dol_syslog(get_class($this)."::add_to_target mailing ".$num." targets found");
98
99 $old = '';
100 while ($i < $num) {
101 $obj = $this->db->fetch_object($result);
102 if ($old != $obj->email) {
103 $otherTxt = ($obj->ref ? $langs->transnoentities("Project").'='.$obj->ref : '');
104 if (strlen($addDescription) > 0 && strlen($otherTxt) > 0) {
105 $otherTxt .= ";";
106 }
107 $otherTxt .= $addDescription;
108 $cibles[$j] = array(
109 'email' => $obj->email,
110 'fk_project' => $obj->fk_project,
111 'lastname' => $obj->lastname,
112 'firstname' => $obj->firstname,
113 'other' => $otherTxt,
114 'source_url' => $this->url($obj->id, $obj->source),
115 'source_id' => $obj->id,
116 'source_type' => $obj->source
117 );
118 $old = $obj->email;
119 $j++;
120 }
121
122 $i++;
123 }
124 } else {
125 dol_syslog($this->db->error());
126 $this->error = $this->db->error();
127 return -1;
128 }
129
130 return parent::addTargetsToDatabase($mailing_id, $cibles);
131 }
132
133
142 public function getSqlArrayForStats()
143 {
144 // CHANGE THIS: Optional
145
146 //var $statssql=array();
147 //$this->statssql[0]="SELECT field1 as label, count(distinct(email)) as nb FROM mytable WHERE email IS NOT NULL";
148 return array();
149 }
150
151
160 public function getNbOfRecipients($sql = '')
161 {
162 global $conf;
163
164 $sql = "SELECT COUNT(DISTINCT(e.email)) as nb";
165 $sql .= " FROM ".MAIN_DB_PREFIX."eventorganization_conferenceorboothattendee as e, ";
166 $sql .= " ".MAIN_DB_PREFIX."projet as p";
167 $sql .= " WHERE e.email <> ''";
168 $sql .= " AND e.fk_project = p.rowid";
169 $sql .= " AND p.entity IN (".getEntity('project').")";
170 if (empty($this->evenunsubscribe)) {
171 $sql .= " AND NOT EXISTS (SELECT rowid FROM ".MAIN_DB_PREFIX."mailing_unsubscribe as mu WHERE mu.email = e.email and mu.entity = ".((int) $conf->entity).")";
172 }
173
174 //print $sql;
175
176 // La requete doit retourner un champ "nb" pour etre comprise par parent::getNbOfRecipients
177 return parent::getNbOfRecipients($sql);
178 }
179
186 public function formFilter()
187 {
188 global $conf, $langs;
189
190 $langs->load("companies");
191
192 include_once DOL_DOCUMENT_ROOT.'/core/class/html.formprojet.class.php';
193 $formproject = new FormProjets($this->db);
194
195 $s = img_picto($langs->trans("OrganizedEvent"), 'project', 'class="pictofixedwidth"');
196 $s .= $formproject->select_projects(-1, 0, "filter_eventorganization", 0, 0, $langs->trans("OrganizedEvent"), 1, 0, 0, 0, '', 1, 0, '', '', 'usage_organize_event=1');
197
198 return $s;
199 }
200
201
209 public function url($id, $sourcetype = 'thirdparty')
210 {
211 if ($sourcetype == 'project') {
212 return '<a href="'.DOL_URL_ROOT.'/eventorganization/conferenceorboothattendee_card.php?id='.((int) $id).'">'.img_object('', "eventorganization").'</a>';
213 }
214
215 return '';
216 }
217}
Class to manage building of HTML components.
Parent class of emailing target selectors modules.
Class to manage a list of personalised recipients for mailing feature.
add_to_target($mailing_id)
This is the main function that returns the array of emails.
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, $sourcetype='thirdparty')
Can include an URL link on each record provided by selector shown on target page.
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_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.