dolibarr 21.0.0-alpha
timespent.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2017 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2023-2024 Frédéric France <frederic.france@free.fr>
4 * Copyright (C) 2023 Gauthier VERDOL <gauthier.verdol@atm-consulting.fr>
5 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
19 */
20
27// Put here all includes required by your class file
28require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
29//require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php';
30//require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
31
36{
40 public $module = 'timespent';
41
45 public $element = 'timespent';
46
50 public $table_element = 'element_time';
51
55 public $picto = 'fa-file';
56
57
58 const STATUS_DRAFT = 0;
59 const STATUS_VALIDATED = 1;
60 const STATUS_CANCELED = 9;
61
62
102 // BEGIN MODULEBUILDER PROPERTIES
106 public $fields = array(
107 'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'position' => 1, 'notnull' => 1, 'visible' => 0, 'noteditable' => 1, 'index' => 1, 'css' => 'left', 'comment' => "Id"),
108 'tms' => array('type' => 'timestamp', 'label' => 'DateModification', 'enabled' => 1, 'position' => 17, 'notnull' => 0, 'visible' => -2,),
109 'import_key' => array('type' => 'varchar(14)', 'label' => 'import_key', 'enabled' => 1, 'position' => 15, 'notnull' => 0, 'visible' => -1,),
110 'fk_element' => array('type' => 'integer', 'label' => 'fk_element', 'enabled' => 1, 'position' => 2, 'notnull' => 1, 'visible' => -1,),
111 'elementtype' => array('type' => 'varchar(32)', 'label' => 'elementtype', 'enabled' => 1, 'position' => 3, 'notnull' => 1, 'visible' => -1,),
112 'element_date' => array('type' => 'date', 'label' => 'element_date', 'enabled' => 1, 'position' => 4, 'notnull' => 0, 'visible' => -1,),
113 'element_datehour' => array('type' => 'datetime', 'label' => 'element_datehour', 'enabled' => 1, 'position' => 5, 'notnull' => 0, 'visible' => -1,),
114 'element_date_withhour' => array('type' => 'integer', 'label' => 'element_date_withhour', 'enabled' => 1, 'position' => 6, 'notnull' => 0, 'visible' => -1,),
115 'element_duration' => array('type' => 'double', 'label' => 'element_duration', 'enabled' => 1, 'position' => 7, 'notnull' => 0, 'visible' => -1,),
116 'fk_product' => array('type' => 'integer', 'label' => 'fk_product', 'enabled' => 1, 'position' => 8, 'notnull' => 0, 'visible' => -1,),
117 'fk_user' => array('type' => 'integer', 'label' => 'fk_user', 'enabled' => 1, 'position' => 9, 'notnull' => 0, 'visible' => -1,),
118 'thm' => array('type' => 'double(24,8)', 'label' => 'thm', 'enabled' => 1, 'position' => 10, 'notnull' => 0, 'visible' => -1,),
119 'invoice_id' => array('type' => 'integer', 'label' => 'invoice_id', 'enabled' => 1, 'position' => 11, 'notnull' => 0, 'visible' => -1, 'default' => 'NULL',),
120 'invoice_line_id' => array('type' => 'integer', 'label' => 'invoice_line_id', 'enabled' => 1, 'position' => 12, 'notnull' => 0, 'visible' => -1, 'default' => 'NULL',),
121 'intervention_id' => array('type' => 'integer', 'label' => 'intervention_id', 'enabled' => 1, 'position' => 13, 'notnull' => 0, 'visible' => -1, 'default' => 'NULL',),
122 'intervention_line_id' => array('type' => 'integer', 'label' => 'intervention_line_id', 'enabled' => 1, 'position' => 14, 'notnull' => 0, 'visible' => -1, 'default' => 'NULL',),
123 'datec' => array('type' => 'datetime', 'label' => 'datec', 'enabled' => 1, 'position' => 16, 'notnull' => 0, 'visible' => -1,),
124 'note' => array('type' => 'text', 'label' => 'note', 'enabled' => 1, 'position' => 18, 'notnull' => 0, 'visible' => -1,),
125 );
126 public $rowid;
127 public $import_key;
128 public $fk_element;
129 public $elementtype;
130 public $element_date;
131 public $element_datehour;
132 public $element_date_withhour;
133 public $element_duration;
134 public $fk_product;
135 public $fk_user;
136 public $thm;
137 public $invoice_id;
138 public $invoice_line_id;
139 public $intervention_id;
140 public $intervention_line_id;
141 public $datec;
142 public $note;
143 // END MODULEBUILDER PROPERTIES
144
150 public function __construct(DoliDB $db)
151 {
152 global $langs;
153
154 $this->db = $db;
155
156 $this->ismultientitymanaged = 0;
157 $this->isextrafieldmanaged = 0;
158
159 if (!getDolGlobalString('MAIN_SHOW_TECHNICAL_ID') && isset($this->fields['rowid']) && !empty($this->fields['ref'])) {
160 $this->fields['rowid']['visible'] = 0;
161 }
162 if (!isModEnabled('multicompany') && isset($this->fields['entity'])) {
163 $this->fields['entity']['enabled'] = 0;
164 }
165
166 // Example to show how to set values of fields definition dynamically
167 /*if ($user->rights->timespent->timespent->read) {
168 $this->fields['myfield']['visible'] = 1;
169 $this->fields['myfield']['noteditable'] = 0;
170 }*/
171
172 // Unset fields that are disabled
173 foreach ($this->fields as $key => $val) {
174 if (isset($val['enabled']) && empty($val['enabled'])) {
175 unset($this->fields[$key]);
176 }
177 }
178
179 // Translate some data of arrayofkeyval
180 if (is_object($langs)) {
181 foreach ($this->fields as $key => $val) {
182 if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
183 foreach ($val['arrayofkeyval'] as $key2 => $val2) {
184 $this->fields[$key]['arrayofkeyval'][$key2] = $langs->trans($val2);
185 }
186 }
187 }
188 }
189 }
190
198 public function create(User $user, $notrigger = 0)
199 {
200 $resultcreate = $this->createCommon($user, $notrigger);
201
202 //$resultvalidate = $this->validate($user, $notrigger);
203
204 return $resultcreate;
205 }
206
214 public function createFromClone(User $user, $fromid)
215 {
216 global $langs, $extrafields;
217 $error = 0;
218
219 dol_syslog(__METHOD__, LOG_DEBUG);
220
221 $object = new self($this->db);
222
223 $this->db->begin();
224
225 // Load source object
226 $result = $object->fetchCommon($fromid);
227
228 // Reset some properties
229 unset($object->id);
230 unset($object->fk_user_creat);
231 unset($object->import_key);
232
233 // Clear fields
234 if (property_exists($object, 'ref')) {
235 $object->ref = empty($this->fields['ref']['default']) ? "Copy_Of_".$object->ref : $this->fields['ref']['default'];
236 }
237 if (property_exists($object, 'label')) {
238 $object->label = empty($this->fields['label']['default']) ? $langs->trans("CopyOf")." ".$object->label : $this->fields['label']['default'];
239 }
240 if (property_exists($object, 'status')) {
241 $object->status = self::STATUS_DRAFT;
242 }
243 if (property_exists($object, 'date_creation')) {
244 $object->date_creation = dol_now();
245 }
246 if (property_exists($object, 'date_modification')) {
247 $object->date_modification = null;
248 }
249 // ...
250 // Clear extrafields that are unique
251 if (is_array($object->array_options) && count($object->array_options) > 0) {
252 $extrafields->fetch_name_optionals_label($this->table_element);
253 foreach ($object->array_options as $key => $option) {
254 $shortkey = preg_replace('/options_/', '', $key);
255 if (!empty($extrafields->attributes[$this->table_element]['unique'][$shortkey])) {
256 //var_dump($key);
257 //var_dump($clonedObj->array_options[$key]); exit;
258 unset($object->array_options[$key]);
259 }
260 }
261 }
262
263 // Create clone
264 $object->context['createfromclone'] = 'createfromclone';
265 $result = $object->createCommon($user);
266 if ($result < 0) {
267 $error++;
268 $this->error = $object->error;
269 $this->errors = $object->errors;
270 }
271
272 if (!$error) {
273 // copy internal contacts
274 if ($this->copy_linked_contact($object, 'internal') < 0) {
275 $error++;
276 }
277 }
278
279 if (!$error) {
280 // copy external contacts if same company
281 if (!empty($object->socid) && property_exists($this, 'fk_soc') && $this->fk_soc == $object->socid) {
282 if ($this->copy_linked_contact($object, 'external') < 0) {
283 $error++;
284 }
285 }
286 }
287
288 unset($object->context['createfromclone']);
289
290 // End
291 if (!$error) {
292 $this->db->commit();
293 return $object;
294 } else {
295 $this->db->rollback();
296 return -1;
297 }
298 }
299
307 public function fetch($id, $ref = null)
308 {
309 $result = $this->fetchCommon($id, $ref);
310
311 return $result;
312 }
313
326 public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, $filter = '', $filtermode = 'AND')
327 {
328 global $conf;
329
330 dol_syslog(__METHOD__, LOG_DEBUG);
331
332 $records = array();
333
334 $sql = "SELECT ";
335 $sql .= $this->getFieldList('t');
336 $sql .= " FROM ".$this->db->prefix().$this->table_element." as t";
337 if (isset($this->ismultientitymanaged) && $this->ismultientitymanaged == 1) {
338 $sql .= " WHERE t.entity IN (".getEntity($this->element).")";
339 } else {
340 $sql .= " WHERE 1 = 1";
341 }
342
343 // Manage filter
344 $errormessage = '';
345 $sql .= forgeSQLFromUniversalSearchCriteria($filter, $errormessage);
346 if ($errormessage) {
347 $this->errors[] = $errormessage;
348 dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
349 return -1;
350 }
351
352 if (!empty($sortfield)) {
353 $sql .= $this->db->order($sortfield, $sortorder);
354 }
355 if (!empty($limit)) {
356 $sql .= $this->db->plimit($limit, $offset);
357 }
358
359 $resql = $this->db->query($sql);
360 if ($resql) {
361 $num = $this->db->num_rows($resql);
362 $i = 0;
363 while ($i < ($limit ? min($limit, $num) : $num)) {
364 $obj = $this->db->fetch_object($resql);
365
366 $record = new self($this->db);
367 $record->setVarsFromFetchObj($obj);
368
369 $records[$record->id] = $record;
370
371 $i++;
372 }
373 $this->db->free($resql);
374
375 return $records;
376 } else {
377 $this->errors[] = 'Error '.$this->db->lasterror();
378 dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
379
380 return -1;
381 }
382 }
383
391 public function update(User $user, $notrigger = 0)
392 {
393 return $this->updateCommon($user, $notrigger);
394 }
395
403 public function delete(User $user, $notrigger = 0)
404 {
405 return $this->deleteCommon($user, $notrigger);
406 //return $this->deleteCommon($user, $notrigger, 1);
407 }
408
417 public function deleteLine(User $user, $idline, $notrigger = 0)
418 {
419 if ($this->status < 0) {
420 $this->error = 'ErrorDeleteLineNotAllowedByObjectStatus';
421 return -2;
422 }
423
424 return $this->deleteLineCommon($user, $idline, $notrigger);
425 }
426
427
435 public function validate($user, $notrigger = 0)
436 {
437 global $conf, $langs;
438
439 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
440
441 $error = 0;
442
443 // Protection
444 if ($this->status == self::STATUS_VALIDATED) {
445 dol_syslog(get_class($this)."::validate action abandoned: already validated", LOG_WARNING);
446 return 0;
447 }
448
449 /*if (! ((empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->timespent->timespent->write))
450 || (!empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->timespent->timespent->timespent_advance->validate))))
451 {
452 $this->error='NotEnoughPermissions';
453 dol_syslog(get_class($this)."::valid ".$this->error, LOG_ERR);
454 return -1;
455 }*/
456
457 $now = dol_now();
458
459 $this->db->begin();
460
461 // Define new ref
462 if (!$error && (preg_match('/^[\‍(]?PROV/i', $this->ref) || empty($this->ref))) { // empty should not happened, but when it occurs, the test save life
463 $num = $this->getNextNumRef();
464 } else {
465 $num = $this->ref;
466 }
467 $this->newref = $num;
468
469 if (!empty($num)) {
470 // Validate
471 $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element;
472 $sql .= " SET ref = '".$this->db->escape($num)."',";
473 $sql .= " status = ".self::STATUS_VALIDATED;
474 if (!empty($this->fields['date_validation'])) {
475 $sql .= ", date_validation = '".$this->db->idate($now)."'";
476 }
477 if (!empty($this->fields['fk_user_valid'])) {
478 $sql .= ", fk_user_valid = ".((int) $user->id);
479 }
480 $sql .= " WHERE rowid = ".((int) $this->id);
481
482 dol_syslog(get_class($this)."::validate()", LOG_DEBUG);
483 $resql = $this->db->query($sql);
484 if (!$resql) {
485 dol_print_error($this->db);
486 $this->error = $this->db->lasterror();
487 $error++;
488 }
489
490 if (!$error && !$notrigger) {
491 // Call trigger
492 $result = $this->call_trigger('timespent_VALIDATE', $user);
493 if ($result < 0) {
494 $error++;
495 }
496 // End call triggers
497 }
498 }
499
500 if (!$error) {
501 $this->oldref = $this->ref;
502
503 // Rename directory if dir was a temporary ref
504 if (preg_match('/^[\‍(]?PROV/i', $this->ref)) {
505 // Now we rename also files into index
506 $sql = 'UPDATE '.MAIN_DB_PREFIX."ecm_files set filename = CONCAT('".$this->db->escape($this->newref)."', SUBSTR(filename, ".(strlen($this->ref) + 1).")), filepath = 'timespent/".$this->db->escape($this->newref)."'";
507 $sql .= " WHERE filename LIKE '".$this->db->escape($this->ref)."%' AND filepath = 'timespent/".$this->db->escape($this->ref)."' and entity = ".$conf->entity;
508 $resql = $this->db->query($sql);
509 if (!$resql) {
510 $error++;
511 $this->error = $this->db->lasterror();
512 }
513 $sql = 'UPDATE '.MAIN_DB_PREFIX."ecm_files set filepath = 'timespent/".$this->db->escape($this->newref)."'";
514 $sql .= " WHERE filepath = 'timespent/".$this->db->escape($this->ref)."' and entity = ".$conf->entity;
515 $resql = $this->db->query($sql);
516 if (!$resql) {
517 $error++;
518 $this->error = $this->db->lasterror();
519 }
520
521 // We rename directory ($this->ref = old ref, $num = new ref) in order not to lose the attachments
522 $oldref = dol_sanitizeFileName($this->ref);
523 $newref = dol_sanitizeFileName($num);
524 $dirsource = $conf->timespent->dir_output.'/timespent/'.$oldref;
525 $dirdest = $conf->timespent->dir_output.'/timespent/'.$newref;
526 if (!$error && file_exists($dirsource)) {
527 dol_syslog(get_class($this)."::validate() rename dir ".$dirsource." into ".$dirdest);
528
529 if (@rename($dirsource, $dirdest)) {
530 dol_syslog("Rename ok");
531 // Rename docs starting with $oldref with $newref
532 $listoffiles = dol_dir_list($conf->timespent->dir_output.'/timespent/'.$newref, 'files', 1, '^'.preg_quote($oldref, '/'));
533 foreach ($listoffiles as $fileentry) {
534 $dirsource = $fileentry['name'];
535 $dirdest = preg_replace('/^'.preg_quote($oldref, '/').'/', $newref, $dirsource);
536 $dirsource = $fileentry['path'].'/'.$dirsource;
537 $dirdest = $fileentry['path'].'/'.$dirdest;
538 @rename($dirsource, $dirdest);
539 }
540 }
541 }
542 }
543 }
544
545 // Set new ref and current status
546 if (!$error) {
547 $this->ref = $num;
548 $this->status = self::STATUS_VALIDATED;
549 }
550
551 if (!$error) {
552 $this->db->commit();
553 return 1;
554 } else {
555 $this->db->rollback();
556 return -1;
557 }
558 }
559
560
568 public function setDraft($user, $notrigger = 0)
569 {
570 // Protection
571 if ($this->status <= self::STATUS_DRAFT) {
572 return 0;
573 }
574
575 /*if (! ((empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->timespent->write))
576 || (!empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->timespent->timespent_advance->validate))))
577 {
578 $this->error='Permission denied';
579 return -1;
580 }*/
581
582 return $this->setStatusCommon($user, self::STATUS_DRAFT, $notrigger, 'timespent_UNVALIDATE');
583 }
584
592 public function cancel($user, $notrigger = 0)
593 {
594 // Protection
595 if ($this->status != self::STATUS_VALIDATED) {
596 return 0;
597 }
598
599 /*if (! ((empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->timespent->write))
600 || (!empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->timespent->timespent_advance->validate))))
601 {
602 $this->error='Permission denied';
603 return -1;
604 }*/
605
606 return $this->setStatusCommon($user, self::STATUS_CANCELED, $notrigger, 'timespent_CANCEL');
607 }
608
616 public function reopen($user, $notrigger = 0)
617 {
618 // Protection
619 if ($this->status == self::STATUS_VALIDATED) {
620 return 0;
621 }
622
623 /*if (! ((empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->timespent->write))
624 || (!empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->timespent->timespent_advance->validate))))
625 {
626 $this->error='Permission denied';
627 return -1;
628 }*/
629
630 return $this->setStatusCommon($user, self::STATUS_VALIDATED, $notrigger, 'timespent_REOPEN');
631 }
632
639 public function getTooltipContentArray($params)
640 {
641 global $conf, $langs, $user;
642
643 $datas = [];
644
645 if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
646 return ['optimize' => $langs->trans("ShowTimeSpent")];
647 }
648 $datas['picto'] = img_picto('', $this->picto).' <u>'.$langs->trans("TimeSpent").'</u>';
649 if (isset($this->status)) {
650 $datas['picto'] .= ' '.$this->getLibStatut(5);
651 }
652 $datas['ref'] .= '<br><b>'.$langs->trans('Ref').':</b> '.$this->ref;
653
654 return $datas;
655 }
656
667 public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
668 {
669 global $conf, $langs, $hookmanager;
670
671 if (!empty($conf->dol_no_mouse_hover)) {
672 $notooltip = 1; // Force disable tooltips
673 }
674
675 $result = '';
676 $params = [
677 'id' => $this->id,
678 'objecttype' => $this->element,
679 'option' => $option,
680 ];
681 $classfortooltip = 'classfortooltip';
682 $dataparams = '';
683 if (getDolGlobalInt('MAIN_ENABLE_AJAX_TOOLTIP')) {
684 $classfortooltip = 'classforajaxtooltip';
685 $dataparams = ' data-params="'.dol_escape_htmltag(json_encode($params)).'"';
686 $label = '';
687 } else {
688 $label = implode($this->getTooltipContentArray($params));
689 }
690
691 $url = dol_buildpath('/timespent/timespent_card.php', 1).'?id='.$this->id;
692
693 if ($option != 'nolink') {
694 // Add param to save lastsearch_values or not
695 $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
696 if ($save_lastsearch_value == -1 && isset($_SERVER["PHP_SELF"]) && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
697 $add_save_lastsearch_values = 1;
698 }
699 if ($url && $add_save_lastsearch_values) {
700 $url .= '&save_lastsearch_values=1';
701 }
702 }
703
704 $linkclose = '';
705 if (empty($notooltip)) {
706 if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
707 $label = $langs->trans("ShowTimeSpent");
708 $linkclose .= ' alt="'.dol_escape_htmltag($label, 1).'"';
709 }
710 $linkclose .= ($label ? ' title="'.dol_escape_htmltag($label, 1).'"' : ' title="tocomplete"');
711 $linkclose .= $dataparams.' class="'.$classfortooltip.($morecss ? ' '.$morecss : '').'"';
712 } else {
713 $linkclose = ($morecss ? ' class="'.$morecss.'"' : '');
714 }
715
716 if ($option == 'nolink' || empty($url)) {
717 $linkstart = '<span';
718 } else {
719 $linkstart = '<a href="'.$url.'"';
720 }
721 $linkstart .= $linkclose.'>';
722 if ($option == 'nolink' || empty($url)) {
723 $linkend = '</span>';
724 } else {
725 $linkend = '</a>';
726 }
727
728 $result .= $linkstart;
729
730 if (empty($this->showphoto_on_popup)) {
731 if ($withpicto) {
732 $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : $dataparams.' class="'.(($withpicto != 2) ? 'paddingright ' : '').$classfortooltip.'"'), 0, 0, $notooltip ? 0 : 1);
733 }
734 } else {
735 if ($withpicto) {
736 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
737
738 list($class, $module) = explode('@', $this->picto);
739 $upload_dir = $conf->$module->multidir_output[$conf->entity]."/$class/".dol_sanitizeFileName($this->ref);
740 $filearray = dol_dir_list($upload_dir, "files");
741 $filename = $filearray[0]['name'];
742 if (!empty($filename)) {
743 $pospoint = strpos($filearray[0]['name'], '.');
744
745 $pathtophoto = $class.'/'.$this->ref.'/thumbs/'.substr($filename, 0, $pospoint).'_mini'.substr($filename, $pospoint);
746 if (!getDolGlobalString(strtoupper($module.'_'.$class).'_FORMATLISTPHOTOSASUSERS')) {
747 $result .= '<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref"><img class="photo'.$module.'" alt="No photo" border="0" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$module.'&entity='.$conf->entity.'&file='.urlencode($pathtophoto).'"></div></div>';
748 } else {
749 $result .= '<div class="floatleft inline-block valignmiddle divphotoref"><img class="photouserphoto userphoto" alt="No photo" border="0" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$module.'&entity='.$conf->entity.'&file='.urlencode($pathtophoto).'"></div>';
750 }
751
752 $result .= '</div>';
753 } else {
754 $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);
755 }
756 }
757 }
758
759 if ($withpicto != 2) {
760 $result .= $this->ref;
761 }
762
763 $result .= $linkend;
764 //if ($withpicto != 2) $result.=(($addlabel && $this->label) ? $sep . dol_trunc($this->label, ($addlabel > 1 ? $addlabel : 0)) : '');
765
766 global $action, $hookmanager;
767 $hookmanager->initHooks(array($this->element.'dao'));
768 $parameters = array('id' => $this->id, 'getnomurl' => &$result);
769 $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
770 if ($reshook > 0) {
771 $result = $hookmanager->resPrint;
772 } else {
773 $result .= $hookmanager->resPrint;
774 }
775
776 return $result;
777 }
778
786 public function getKanbanView($option = '', $arraydata = null)
787 {
788 global $conf, $langs;
789
790 $selected = (empty($arraydata['selected']) ? 0 : $arraydata['selected']);
791
792 $return = '<div class="box-flex-item box-flex-grow-zero">';
793 $return .= '<div class="info-box info-box-sm">';
794 $return .= '<span class="info-box-icon bg-infobox-action">';
795 $return .= img_picto('', $this->picto);
796 $return .= '</span>';
797 $return .= '<div class="info-box-content">';
798 $return .= '<span class="info-box-ref inline-block tdoverflowmax150 valignmiddle">'.(method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref).'</span>';
799 if ($selected >= 0) {
800 $return .= '<input id="cb'.$this->id.'" class="flat checkforselect fright" type="checkbox" name="toselect[]" value="'.$this->id.'"'.($selected ? ' checked="checked"' : '').'>';
801 }
802 if (property_exists($this, 'label')) {
803 $return .= ' <div class="inline-block opacitymedium valignmiddle tdoverflowmax100">'.$this->label.'</div>';
804 }
805 if (property_exists($this, 'amount')) {
806 $return .= '<br>';
807 $return .= '<span class="info-box-label amount">'.price($this->amount, 0, $langs, 1, -1, -1, $conf->currency).'</span>';
808 }
809 if (method_exists($this, 'getLibStatut')) {
810 $return .= '<br><div class="info-box-status">'.$this->getLibStatut(5).'</div>';
811 }
812 $return .= '</div>';
813 $return .= '</div>';
814 $return .= '</div>';
815
816 return $return;
817 }
818
825 public function getLabelStatus($mode = 0)
826 {
827 return $this->LibStatut($this->status, $mode);
828 }
829
836 public function getLibStatut($mode = 0)
837 {
838 return $this->LibStatut($this->status, $mode);
839 }
840
841 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
849 public function LibStatut($status, $mode = 0)
850 {
851 // phpcs:enable
852 if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
853 global $langs;
854 //$langs->load("timespent@timespent");
855 $this->labelStatus[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
856 $this->labelStatus[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('Enabled');
857 $this->labelStatus[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Disabled');
858 $this->labelStatusShort[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
859 $this->labelStatusShort[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('Enabled');
860 $this->labelStatusShort[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Disabled');
861 }
862
863 $statusType = 'status'.$status;
864 //if ($status == self::STATUS_VALIDATED) $statusType = 'status1';
865 if ($status == self::STATUS_CANCELED) {
866 $statusType = 'status6';
867 }
868
869 return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
870 }
871
878 public function info($id)
879 {
880 $sql = "SELECT rowid,";
881 $sql .= " date_creation as datec, tms as datem,";
882 $sql .= " fk_user_creat, fk_user_modif";
883 $sql .= " FROM ".MAIN_DB_PREFIX.$this->table_element." as t";
884 $sql .= " WHERE t.rowid = ".((int) $id);
885
886 $result = $this->db->query($sql);
887 if ($result) {
888 if ($this->db->num_rows($result)) {
889 $obj = $this->db->fetch_object($result);
890
891 $this->id = $obj->rowid;
892
893 $this->user_creation_id = $obj->fk_user_creat;
894 $this->user_modification_id = $obj->fk_user_modif;
895 $this->date_creation = $this->db->jdate($obj->datec);
896 $this->date_modification = empty($obj->datem) ? '' : $this->db->jdate($obj->datem);
897 }
898
899 $this->db->free($result);
900 } else {
901 dol_print_error($this->db);
902 }
903 }
904
911 public function initAsSpecimen()
912 {
913 // Set here init that are not common fields
914 // $this->property1 = ...
915 // $this->property2 = ...
916
917 return $this->initAsSpecimenCommon();
918 }
919
925 public function getNextNumRef()
926 {
927 global $langs, $conf;
928 $langs->load("timespent@timespent");
929
930 if (!getDolGlobalString('TIMESPENT_timespent_ADDON')) {
931 $conf->global->TIMESPENT_timespent_ADDON = 'mod_timespent_standard';
932 }
933
934 if (getDolGlobalString('TIMESPENT_timespent_ADDON')) {
935 $mybool = false;
936
937 $file = getDolGlobalString('TIMESPENT_timespent_ADDON') . ".php";
938 $classname = getDolGlobalString('TIMESPENT_timespent_ADDON');
939
940 // Include file with class
941 $dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']);
942 foreach ($dirmodels as $reldir) {
943 $dir = dol_buildpath($reldir."core/modules/timespent/");
944
945 // Load file with numbering class (if found)
946 $mybool = ((bool) @include_once $dir.$file) || $mybool;
947 }
948
949 if ($mybool === false) {
950 dol_print_error(null, "Failed to include file ".$file);
951 return '';
952 }
953
954 if (class_exists($classname)) {
955 $obj = new $classname();
956 $numref = $obj->getNextValue($this);
957
958 if ($numref != '' && $numref != '-1') {
959 return $numref;
960 } else {
961 $this->error = $obj->error;
962 //dol_print_error($this->db,get_class($this)."::getNextNumRef ".$obj->error);
963 return "";
964 }
965 } else {
966 print $langs->trans("Error")." ".$langs->trans("ClassNotFound").' '.$classname;
967 return "";
968 }
969 } else {
970 print $langs->trans("ErrorNumberingModuleNotSetup", $this->element);
971 return "";
972 }
973 }
974
986 public function generateDocument($modele, $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0, $moreparams = null)
987 {
988 global $conf, $langs;
989
990 $result = 0;
991 $includedocgeneration = 0;
992
993 $langs->load("timespent@timespent");
994
995 if (!dol_strlen($modele)) {
996 $modele = 'standard_timespent';
997
998 if (!empty($this->model_pdf)) {
999 $modele = $this->model_pdf;
1000 } elseif (getDolGlobalString('timespent_ADDON_PDF')) {
1001 $modele = getDolGlobalString('timespent_ADDON_PDF');
1002 }
1003 }
1004
1005 $modelpath = "core/modules/timespent/doc/";
1006
1007 if ($includedocgeneration && !empty($modele)) {
1008 $result = $this->commonGenerateDocument($modelpath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams);
1009 }
1010
1011 return $result;
1012 }
1013}
if( $user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
Definition card.php:58
print $langs trans("AuditedSecurityEvents").'</strong >< span class="opacitymedium"></span >< br > status
Or an array listing all the potential status of the object: array: int of the status => translated la...
Definition security.php:626
$object ref
Definition info.php:79
Parent class of all other business classes (invoices, contracts, proposals, orders,...
deleteLineCommon(User $user, $idline, $notrigger=0)
Delete a line of object in database.
commonGenerateDocument($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
Common function for all objects extending CommonObject for generating documents.
createCommon(User $user, $notrigger=0)
Create object in the database.
getFieldList($alias='', $excludefields=array())
Function to concat keys of fields.
updateCommon(User $user, $notrigger=0)
Update object into database.
setStatusCommon($user, $status, $notrigger=0, $triggercode='')
Set to a status.
initAsSpecimenCommon()
Initialise object with example values Id must be 0 if object instance is a specimen.
copy_linked_contact($objFrom, $source='internal')
Copy contact from one element to current.
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.
call_trigger($triggerName, $user)
Call trigger based on this instance.
Class to manage Dolibarr database access.
Class for TimeSpent.
validate($user, $notrigger=0)
Validate object.
getNomUrl($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
Return a link to the object card (with optionally the picto)
fetch($id, $ref=null)
Load object in memory from the database.
setDraft($user, $notrigger=0)
Set draft status.
getTooltipContentArray($params)
getTooltipContentArray
cancel($user, $notrigger=0)
Set cancel status.
initAsSpecimen()
Initialise object with example values Id must be 0 if object instance is a specimen.
deleteLine(User $user, $idline, $notrigger=0)
Delete a line of object in database.
fetchAll($sortorder='', $sortfield='', $limit=0, $offset=0, $filter='', $filtermode='AND')
Load list of objects in memory from the database.
getLabelStatus($mode=0)
Return the label of the status.
__construct(DoliDB $db)
Constructor.
getLibStatut($mode=0)
Return the label of the status.
generateDocument($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
Create a document onto disk according to template module.
reopen($user, $notrigger=0)
Set back to validated status.
createFromClone(User $user, $fromid)
Clone an object into another one.
info($id)
Load the info information in the object.
LibStatut($status, $mode=0)
Return the status.
update(User $user, $notrigger=0)
Update object into database.
create(User $user, $notrigger=0)
Create object into database.
getNextNumRef()
Returns the reference to the following non used object depending on the active numbering module.
getKanbanView($option='', $arraydata=null)
Return a thumb for kanban views.
Class to manage Dolibarr users.
dol_dir_list($utf8_path, $types="all", $recursive=0, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0, $nohook=0, $relativename="", $donotfollowsymlinks=0, $nbsecondsold=0)
Scan a directory and return a list of files/directories.
Definition files.lib.php:63
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)
dol_strlen($string, $stringencoding='UTF-8')
Make a strlen call.
forgeSQLFromUniversalSearchCriteria($filter, &$errorstr='', $noand=0, $nopar=0, $noerror=0)
forgeSQLFromUniversalSearchCriteria
dol_now($mode='auto')
Return date for now.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
dol_buildpath($path, $type=0, $returnemptyifnotfound=0)
Return path of url or filesystem.
dol_sanitizeFileName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a file name.
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.