dolibarr 25.0.0-alpha
emailcollectoraction.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2017 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) ---Put here your own copyright and developer email---
4 * Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
5 * Copyright (C) 2024-2026 MDW <mdeweerd@users.noreply.github.com>
6 * Copyright (C) 2025 Vincent de Grandpré <vincent@de-grandpre.quebec>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 */
21
28// Put here all includes required by your class file
29require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
30
35{
39 public $element = 'emailcollectoraction';
40
44 public $table_element = 'emailcollector_emailcollectoraction';
45
49 public $picto = 'emailcollectoraction@emailcollector';
50
51
71 // BEGIN MODULEBUILDER PROPERTIES
75 public $fields = array(
76 'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'visible' => -1, 'position' => 1, 'notnull' => 1, 'index' => 1, 'comment' => "Id",),
77 'fk_emailcollector' => array('type' => 'integer', 'label' => 'Id of emailcollector', 'enabled' => 1, 'visible' => 0, 'foreignkey' => 'emailcollector.rowid', 'position' => 0,),
78 'type' => array('type' => 'varchar(128)', 'label' => 'Type', 'enabled' => 1, 'visible' => 1, 'position' => 10, 'notnull' => 1, 'index' => 1),
79 'actionparam' => array('type' => 'text', 'label' => 'ParamForAction', 'enabled' => 1, 'visible' => 1, 'position' => 40, 'notnull' => -1),
80 'date_creation' => array('type' => 'datetime', 'label' => 'DateCreation', 'enabled' => 1, 'visible' => -2, 'position' => 500, 'notnull' => 1,),
81 'tms' => array('type' => 'timestamp', 'label' => 'DateModification', 'enabled' => 1, 'visible' => -2, 'position' => 501, 'notnull' => 1,),
82 'fk_user_creat' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserAuthor', 'enabled' => 1, 'visible' => -2, 'position' => 510, 'notnull' => 1, 'foreignkey' => 'llx_user.rowid',),
83 'fk_user_modif' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserModif', 'enabled' => 1, 'visible' => -2, 'position' => 511, 'notnull' => -1,),
84 'position' => array('type' => 'integer', 'label' => 'Position', 'enabled' => 1, 'visible' => 1, 'position' => 600, 'default' => '0',),
85 'import_key' => array('type' => 'varchar(14)', 'label' => 'ImportId', 'enabled' => 1, 'visible' => -2, 'position' => 1000, 'notnull' => -1,),
86 'status' => array('type' => 'integer', 'label' => 'Status', 'enabled' => 1, 'visible' => 1, 'position' => 1000, 'notnull' => 1, 'default' => '1', 'arrayofkeyval' => array(0 => 'Disabled', 1 => 'Enabled')),
87 );
91 public $rowid;
95 public $fk_emailcollector;
99 public $type;
103 public $actionparam;
104
108 public $fk_user_creat;
112 public $fk_user_modif;
116 public $position;
120 public $import_key;
124 public $status;
125 // END MODULEBUILDER PROPERTIES
126
132 public function __construct(DoliDB $db)
133 {
134 global $conf, $langs;
135
136 $this->db = $db;
137
138 $this->ismultientitymanaged = 0;
139 $this->isextrafieldmanaged = 0;
140
141 if (!getDolGlobalString('MAIN_SHOW_TECHNICAL_ID') && isset($this->fields['rowid'])) {
142 $this->fields['rowid']['visible'] = 0;
143 }
144 if (!isModEnabled('multicompany') && isset($this->fields['entity'])) {
145 $this->fields['entity']['enabled'] = 0;
146 }
147
148 // Unset fields that are disabled
149 foreach ($this->fields as $key => $val) {
150 if (isset($val['enabled']) && empty($val['enabled'])) {
151 unset($this->fields[$key]);
152 }
153 }
154
155 // Translate some data of arrayofkeyval
156 if (is_object($langs)) {
157 foreach ($this->fields as $key => $val) {
158 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
159 foreach ($val['arrayofkeyval'] as $key2 => $val2) {
160 $this->fields[$key]['arrayofkeyval'][$key2] = $langs->trans($val2);
161 }
162 }
163 }
164 }
165 }
166
174 public function create(User $user, $notrigger = 0)
175 {
176 global $langs;
177 if (empty($this->type)) {
178 $langs->load("errors");
179 $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("Type"));
180 return -1;
181 }
182
183 return $this->createCommon($user, $notrigger);
184 }
185
193 public function createFromClone(User $user, $fromid)
194 {
195 global $langs, $hookmanager, $extrafields;
196 $error = 0;
197
198 dol_syslog(__METHOD__, LOG_DEBUG);
199
200 $object = new self($this->db);
201
202 $this->db->begin();
203
204 // Load source object
205 $object->fetchCommon($fromid);
206 // Reset some properties
207 unset($object->id);
208 unset($object->fk_user_creat);
209 unset($object->import_key);
210
211 // Clear fields
212 $object->ref = "copy_of_".$object->ref;
213 // $object->title = $langs->trans("CopyOf")." ".$object->title;
214
215 // Clear extrafields that are unique
216 if (is_array($object->array_options) && count($object->array_options) > 0) {
217 $extrafields->fetch_name_optionals_label($this->table_element);
218 foreach ($object->array_options as $key => $option) {
219 $shortkey = preg_replace('/options_/', '', $key);
220 if (!empty($extrafields->attributes[$this->element]['unique'][$shortkey])) {
221 unset($object->array_options[$key]);
222 }
223 }
224 }
225
226 // Create clone
227 $object->context['createfromclone'] = 'createfromclone';
228 $result = $object->createCommon($user);
229 if ($result < 0) {
230 $error++;
231 $this->error = $object->error;
232 $this->errors = $object->errors;
233 }
234
235 unset($object->context['createfromclone']);
236
237 // End
238 if (!$error) {
239 $this->db->commit();
240 return $object;
241 } else {
242 $this->db->rollback();
243 return -1;
244 }
245 }
246
254 public function fetch($id, $ref = null)
255 {
256 $result = $this->fetchCommon($id, $ref);
257
258 return $result;
259 }
260
268 public function update(User $user, $notrigger = 0)
269 {
270 return $this->updateCommon($user, $notrigger);
271 }
272
280 public function delete(User $user, $notrigger = 0)
281 {
282 return $this->deleteCommon($user, $notrigger);
283 }
284
295 public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
296 {
297 global $db, $conf, $langs, $hookmanager;
298 global $dolibarr_main_authentication, $dolibarr_main_demo;
299 global $menumanager;
300
301 if (!empty($conf->dol_no_mouse_hover)) {
302 $notooltip = 1; // Force disable tooltips
303 }
304
305 $result = '';
306
307 $label = '<u>'.$langs->trans("EmailcollectorAction").'</u>';
308 $label .= '<br>';
309 $label .= '<b>'.$langs->trans('Ref').':</b> '.$this->ref;
310
311 $url = dol_buildpath('/emailcollector/emailcollectoraction_card.php', 1).'?id='.$this->id;
312
313 if ($option != 'nolink') {
314 // Add param to save lastsearch_values or not
315 $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
316 if ($save_lastsearch_value == -1 && isset($_SERVER["PHP_SELF"]) && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
317 $add_save_lastsearch_values = 1;
318 }
319 if ($add_save_lastsearch_values) {
320 $url .= '&save_lastsearch_values=1';
321 }
322 }
323
324 $linkclose = '';
325 if (empty($notooltip)) {
326 if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
327 $label = $langs->trans("ShowEmailcollectorAction");
328 $linkclose .= ' alt="'.dolPrintHTMLForAttribute($label).'"';
329 }
330 $linkclose .= ' title="'.dolPrintHTMLForAttribute($label).'"';
331 $linkclose .= ' class="classfortooltip'.($morecss ? ' '.$morecss : '').'"';
332
333 /*
334 $hookmanager->initHooks(array('emailcollectoractiondao'));
335 $parameters=array('id'=>$this->id);
336 $reshook=$hookmanager->executeHooks('getnomurltooltip',$parameters,$this,$action); // Note that $action and $object may have been modified by some hooks
337 if ($reshook > 0) $linkclose = $hookmanager->resPrint;
338 */
339 } else {
340 $linkclose = ($morecss ? ' class="'.$morecss.'"' : '');
341 }
342
343 $linkstart = '<a href="'.$url.'"';
344 $linkstart .= $linkclose.'>';
345 $linkend = '</a>';
346
347 $result .= $linkstart;
348 if ($withpicto) {
349 $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'classfortooltip"'), 0, 0, $notooltip ? 0 : 1);
350 }
351 if ($withpicto != 2) {
352 $result .= $this->ref;
353 }
354 $result .= $linkend;
355 //if ($withpicto != 2) $result.=(($addlabel && $this->label) ? $sep . dol_trunc($this->label, ($addlabel > 1 ? $addlabel : 0)) : '');
356
357 global $action, $hookmanager;
358 $hookmanager->initHooks(array('emailcollectoractiondao'));
359 $parameters = array('id' => $this->id, 'getnomurl' => &$result);
360 $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
361 if ($reshook > 0) {
362 $result = $hookmanager->resPrint;
363 } else {
364 $result .= $hookmanager->resPrint;
365 }
366
367 return $result;
368 }
369
376 public function getLibStatut($mode = 0)
377 {
378 return $this->LibStatut($this->status, $mode);
379 }
380
381 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
389 public function LibStatut($status, $mode = 0)
390 {
391 // phpcs:enable
392 if (empty($this->labelStatus)) {
393 global $langs;
394 //$langs->load("emailcollector");
395 $this->labelStatus[1] = $langs->trans('Enabled');
396 $this->labelStatus[0] = $langs->trans('Disabled');
397 }
398
399 if ($mode == 0) {
400 return $this->labelStatus[$status];
401 } elseif ($mode == 1) {
402 return $this->labelStatus[$status];
403 } elseif ($mode == 2) {
404 if ($status == 1) {
405 return img_picto($this->labelStatus[$status], 'statut4', '', 0, 0, 0, '', 'valignmiddle').' '.$this->labelStatus[$status];
406 } elseif ($status == 0) {
407 return img_picto($this->labelStatus[$status], 'statut5', '', 0, 0, 0, '', 'valignmiddle').' '.$this->labelStatus[$status];
408 }
409 } elseif ($mode == 3) {
410 if ($status == 1) {
411 return img_picto($this->labelStatus[$status], 'statut4', '', 0, 0, 0, '', 'valignmiddle');
412 } elseif ($status == 0) {
413 return img_picto($this->labelStatus[$status], 'statut5', '', 0, 0, 0, '', 'valignmiddle');
414 }
415 } elseif ($mode == 4) {
416 if ($status == 1) {
417 return img_picto($this->labelStatus[$status], 'statut4', '', 0, 0, 0, '', 'valignmiddle').' '.$this->labelStatus[$status];
418 } elseif ($status == 0) {
419 return img_picto($this->labelStatus[$status], 'statut5', '', 0, 0, 0, '', 'valignmiddle').' '.$this->labelStatus[$status];
420 }
421 } elseif ($mode == 5) {
422 if ($status == 1) {
423 return $this->labelStatus[$status].' '.img_picto($this->labelStatus[$status], 'statut4', '', 0, 0, 0, '', 'valignmiddle');
424 } elseif ($status == 0) {
425 return $this->labelStatus[$status].' '.img_picto($this->labelStatus[$status], 'statut5', '', 0, 0, 0, '', 'valignmiddle');
426 }
427 } elseif ($mode == 6) {
428 if ($status == 1) {
429 return $this->labelStatus[$status].' '.img_picto($this->labelStatus[$status], 'statut4', '', 0, 0, 0, '', 'valignmiddle');
430 } elseif ($status == 0) {
431 return $this->labelStatus[$status].' '.img_picto($this->labelStatus[$status], 'statut5', '', 0, 0, 0, '', 'valignmiddle');
432 }
433 }
434 return "";
435 }
436
443 public function info($id)
444 {
445 $sql = 'SELECT rowid, date_creation as datec, tms as datem,';
446 $sql .= ' fk_user_creat, fk_user_modif';
447 $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as t';
448 $sql .= ' WHERE t.rowid = '.((int) $id);
449 $result = $this->db->query($sql);
450 if ($result) {
451 if ($this->db->num_rows($result)) {
452 $obj = $this->db->fetch_object($result);
453
454 $this->id = $obj->rowid;
455
456 $this->user_creation_id = $obj->fk_user_creat;
457 $this->user_modification_id = $obj->fk_user_modif;
458 $this->date_creation = $this->db->jdate($obj->datec);
459 $this->date_modification = empty($obj->datem) ? '' : $this->db->jdate($obj->datem);
460 }
461
462 $this->db->free($result);
463 } else {
464 dol_print_error($this->db);
465 }
466 }
467
474 public function initAsSpecimen()
475 {
476 return $this->initAsSpecimenCommon();
477 }
478}
if(! $sortfield) if(! $sortorder) $object
Definition account.php:100
$propal type
'integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]',...
Definition propal.php:281
if(!isModEnabled('ai')||!getDolGlobalString('AI_ASSISTANT_ENABLED')) global $conf
The main.inc.php has been included so the following variable are now defined:
createCommon(User $user, $notrigger=0)
Create object in the database.
updateCommon(User $user, $notrigger=0)
Update object into database.
initAsSpecimenCommon()
Initialise object with example values Id must be 0 if object instance is a specimen.
fetchCommon($id, $ref=null, $morewhere='', $noextrafields=0)
Load object in memory from the database.
deleteCommon(User $user, $notrigger=0, $forcechilddeletion=0)
Delete object in database.
Class to manage Dolibarr database access.
Class for EmailCollectorAction.
fetch($id, $ref=null)
Load object in memory from the database.
create(User $user, $notrigger=0)
Create object into database.
LibStatut($status, $mode=0)
Return the status.
getNomUrl($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
Return a link to the object card (with optionally the picto)
__construct(DoliDB $db)
Constructor.
createFromClone(User $user, $fromid)
Clone and object into another one.
info($id)
Charge les information d'ordre info dans l'objet commande.
getLibStatut($mode=0)
Return label of the status.
initAsSpecimen()
Initialise object with example values Id must be 0 if object instance is a specimen.
update(User $user, $notrigger=0)
Update object into database.
Class to manage Dolibarr users.
print $langs trans("Ref").' m titre as m m statut as status
Or an array listing all the potential status of the object: array: int of the status => translated la...
Definition index.php:169
dol_buildpath($path, $type=0, $returnemptyifnotfound=0)
Return path of url or filesystem.
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
isModEnabled($module)
Is Dolibarr module enabled.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.