dolibarr  17.0.4
categorie.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2005 Matthieu Valleton <mv@seeschloss.org>
3  * Copyright (C) 2005 Davoleau Brice <brice.davoleau@gmail.com>
4  * Copyright (C) 2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
5  * Copyright (C) 2006-2012 Regis Houssin <regis.houssin@inodbox.com>
6  * Copyright (C) 2006-2012 Laurent Destailleur <eldy@users.sourceforge.net>
7  * Copyright (C) 2007 Patrick Raguin <patrick.raguin@gmail.com>
8  * Copyright (C) 2013-2016 Juanjo Menent <jmenent@2byte.es>
9  * Copyright (C) 2013-2018 Philippe Grand <philippe.grand@atoo-net.com>
10  * Copyright (C) 2015 Marcos García <marcosgdf@gmail.com>
11  * Copyright (C) 2015 Raphaël Doursenaud <rdoursenaud@gpcsolutions.fr>
12  * Copyright (C) 2016 Charlie Benke <charlie@patas-monkey.com>
13  * Copyright (C) 2018-2022 Frédéric France <frederic.france@netlogic.fr>
14  * Copyright (C) 2023 Benjamin Falière <benjamin.faliere@altairis.fr>
15  *
16  * This program is free software; you can redistribute it and/or modify
17  * it under the terms of the GNU General Public License as published by
18  * the Free Software Foundation; either version 3 of the License, or
19  * (at your option) any later version.
20  *
21  * This program is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24  * GNU General Public License for more details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program. If not, see <https://www.gnu.org/licenses/>.
28  */
29 
36 require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
37 require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
38 require_once DOL_DOCUMENT_ROOT.'/ticket/class/ticket.class.php';
39 require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.class.php';
40 require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
41 require_once DOL_DOCUMENT_ROOT.'/knowledgemanagement/class/knowledgerecord.class.php';
42 
43 
47 class Categorie extends CommonObject
48 {
49  // Categories types (we use string because we want to accept any modules/types in a future)
50  const TYPE_PRODUCT = 'product';
51  const TYPE_SUPPLIER = 'supplier';
52  const TYPE_CUSTOMER = 'customer';
53  const TYPE_MEMBER = 'member';
54  const TYPE_CONTACT = 'contact';
55  const TYPE_USER = 'user';
56  const TYPE_PROJECT = 'project';
57  const TYPE_ACCOUNT = 'bank_account';
58  const TYPE_BANK_LINE = 'bank_line';
59  const TYPE_WAREHOUSE = 'warehouse';
60  const TYPE_ACTIONCOMM = 'actioncomm';
61  const TYPE_WEBSITE_PAGE = 'website_page';
62  const TYPE_TICKET = 'ticket';
63  const TYPE_KNOWLEDGEMANAGEMENT = 'knowledgemanagement';
64 
68  public $picto = 'category';
69 
70 
74  protected $MAP_ID = array(
75  'product' => 0,
76  'supplier' => 1,
77  'customer' => 2,
78  'member' => 3,
79  'contact' => 4,
80  'bank_account' => 5,
81  'project' => 6,
82  'user' => 7,
83  'bank_line' => 8,
84  'warehouse' => 9,
85  'actioncomm' => 10,
86  'website_page' => 11,
87  'ticket' => 12,
88  'knowledgemanagement' => 13
89  );
90 
96  public static $MAP_ID_TO_CODE = array(
97  0 => 'product',
98  1 => 'supplier',
99  2 => 'customer',
100  3 => 'member',
101  4 => 'contact',
102  5 => 'bank_account',
103  6 => 'project',
104  7 => 'user',
105  8 => 'bank_line',
106  9 => 'warehouse',
107  10 => 'actioncomm',
108  11 => 'website_page',
109  12 => 'ticket',
110  13 => 'knowledgemanagement'
111  );
112 
118  public $MAP_CAT_FK = array(
119  'customer' => 'soc',
120  'supplier' => 'soc',
121  'contact' => 'socpeople',
122  'bank_account' => 'account',
123  );
124 
130  public $MAP_CAT_TABLE = array(
131  'customer' => 'societe',
132  'supplier' => 'fournisseur',
133  'bank_account'=> 'account',
134  );
135 
141  public $MAP_OBJ_CLASS = array(
142  'product' => 'Product',
143  'customer' => 'Societe',
144  'supplier' => 'Fournisseur',
145  'member' => 'Adherent',
146  'contact' => 'Contact',
147  'user' => 'User',
148  'account' => 'Account', // old for bank account
149  'bank_account' => 'Account',
150  'project' => 'Project',
151  'warehouse'=> 'Entrepot',
152  'actioncomm' => 'ActionComm',
153  'website_page' => 'WebsitePage',
154  'ticket' => 'Ticket',
155  'knowledgemanagement' => 'KnowledgeRecord'
156  );
157 
163  public static $MAP_TYPE_TITLE_AREA = array(
164  'product' => 'ProductsCategoriesArea',
165  'customer' => 'CustomersCategoriesArea',
166  'supplier' => 'SuppliersCategoriesArea',
167  'member' => 'MembersCategoriesArea',
168  'contact' => 'ContactsCategoriesArea',
169  'user' => 'UsersCategoriesArea',
170  'account' => 'AccountsCategoriesArea', // old for bank account
171  'bank_account' => 'AccountsCategoriesArea',
172  'project' => 'ProjectsCategoriesArea',
173  'warehouse'=> 'StocksCategoriesArea',
174  'actioncomm' => 'ActioncommCategoriesArea',
175  'website_page' => 'WebsitePageCategoriesArea'
176  );
177 
182  public $MAP_OBJ_TABLE = array(
183  'customer' => 'societe',
184  'supplier' => 'societe',
185  'member' => 'adherent',
186  'contact' => 'socpeople',
187  'account' => 'bank_account', // old for bank account
188  'project' => 'projet',
189  'warehouse'=> 'entrepot',
190  'knowledgemanagement' => 'knowledgemanagement_knowledgerecord'
191  );
192 
196  public $element = 'category';
197 
201  public $table_element = 'categorie';
202 
206  public $fk_parent;
207 
211  public $label;
212 
216  public $description;
217 
221  public $color;
222 
226  public $visible;
227 
231  public $socid;
232 
250  public $type;
251 
255  public $cats = array();
256 
260  public $motherof = array();
261 
265  public $childs = array();
266 
267 
273  public function __construct($db)
274  {
275  global $hookmanager;
276 
277  $this->db = $db;
278 
279  if (is_object($hookmanager)) {
280  $hookmanager->initHooks(array('category'));
281  $parameters = array();
282  $reshook = $hookmanager->executeHooks('constructCategory', $parameters, $this); // Note that $action and $object may have been modified by some hooks
283  if ($reshook >= 0 && !empty($hookmanager->resArray)) {
284  foreach ($hookmanager->resArray as $mapList) {
285  $mapId = $mapList['id'];
286  $mapCode = $mapList['code'];
287  self::$MAP_ID_TO_CODE[$mapId] = $mapCode;
288  $this->MAP_ID[$mapCode] = $mapId;
289  $this->MAP_CAT_FK[$mapCode] = $mapList['cat_fk'];
290  $this->MAP_CAT_TABLE[$mapCode] = $mapList['cat_table'];
291  $this->MAP_OBJ_CLASS[$mapCode] = $mapList['obj_class'];
292  $this->MAP_OBJ_TABLE[$mapCode] = $mapList['obj_table'];
293  }
294  }
295  }
296  }
297 
303  public function getMapList()
304  {
305  $mapList = array();
306 
307  foreach ($this->MAP_ID as $mapCode => $mapId) {
308  $mapList[] = array(
309  'id' => $mapId,
310  'code' => $mapCode,
311  'cat_fk' => (empty($this->MAP_CAT_FK[$mapCode]) ? $mapCode : $this->MAP_CAT_FK[$mapCode]),
312  'cat_table' => (empty($this->MAP_CAT_TABLE[$mapCode]) ? $mapCode : $this->MAP_CAT_TABLE[$mapCode]),
313  'obj_class' => (empty($this->MAP_OBJ_CLASS[$mapCode]) ? $mapCode : $this->MAP_OBJ_CLASS[$mapCode]),
314  'obj_table' => (empty($this->MAP_OBJ_TABLE[$mapCode]) ? $mapCode : $this->MAP_OBJ_TABLE[$mapCode])
315  );
316  }
317 
318  return $mapList;
319  }
320 
330  public function fetch($id, $label = '', $type = null, $ref_ext = '')
331  {
332  global $conf;
333 
334  // Check parameters
335  if (empty($id) && empty($label) && empty($ref_ext)) {
336  $this->error = "No category to search for";
337  return -1;
338  }
339  if (!is_null($type) && !is_numeric($type)) {
340  $type = $this->MAP_ID[$type];
341  }
342 
343  $sql = "SELECT rowid, fk_parent, entity, label, description, color, fk_soc, visible, type, ref_ext";
344  $sql .= ", date_creation, tms, fk_user_creat, fk_user_modif";
345  $sql .= " FROM ".MAIN_DB_PREFIX."categorie";
346  if ($id) {
347  $sql .= " WHERE rowid = ".((int) $id);
348  } elseif (!empty($ref_ext)) {
349  $sql .= " WHERE ref_ext LIKE '".$this->db->escape($ref_ext)."'";
350  } else {
351  $sql .= " WHERE label = '".$this->db->escape($label)."' AND entity IN (".getEntity('category').")";
352  if (!is_null($type)) {
353  $sql .= " AND type = ".((int) $type);
354  }
355  }
356 
357  dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
358  $resql = $this->db->query($sql);
359  if ($resql) {
360  if ($this->db->num_rows($resql) > 0) {
361  $res = $this->db->fetch_array($resql);
362 
363  $this->id = $res['rowid'];
364  //$this->ref = $res['rowid'];
365  $this->fk_parent = (int) $res['fk_parent'];
366  $this->label = $res['label'];
367  $this->description = $res['description'];
368  $this->color = $res['color'];
369  $this->socid = (int) $res['fk_soc'];
370  $this->visible = (int) $res['visible'];
371  $this->type = (int) $res['type'];
372  $this->ref_ext = $res['ref_ext'];
373  $this->entity = (int) $res['entity'];
374  $this->date_creation = $this->db->jdate($res['date_creation']);
375  $this->date_modification = $this->db->jdate($res['tms']);
376  $this->user_creation_id = (int) $res['fk_user_creat'];
377  $this->user_modification_id = (int) $res['fk_user_modif'];
378  $this->user_creation = (int) $res['fk_user_creat'];
379  $this->user_modification = (int) $res['fk_user_modif'];
380 
381  // Retrieve all extrafield
382  // fetch optionals attributes and labels
383  $this->fetch_optionals();
384 
385  $this->db->free($resql);
386 
387  // multilangs
388  if (getDolGlobalInt('MAIN_MULTILANGS')) {
389  $this->getMultiLangs();
390  }
391 
392  return 1;
393  } else {
394  $this->error = "No category found";
395  return 0;
396  }
397  } else {
398  dol_print_error($this->db);
399  $this->error = $this->db->lasterror;
400  $this->errors[] = $this->db->lasterror;
401  return -1;
402  }
403  }
404 
414  public function create($user)
415  {
416  global $conf, $langs, $hookmanager;
417  $langs->load('categories');
418 
419  $type = $this->type;
420 
421  if (!is_numeric($type)) {
422  $type = $this->MAP_ID[$type];
423  }
424 
425  $error = 0;
426 
427  dol_syslog(get_class($this).'::create', LOG_DEBUG);
428 
429  // Clean parameters
430  $this->label = trim($this->label);
431  $this->description = trim($this->description);
432  $this->color = trim($this->color);
433  $this->import_key = trim($this->import_key);
434  $this->ref_ext = trim($this->ref_ext);
435  if (empty($this->visible)) {
436  $this->visible = 0;
437  }
438  $this->fk_parent = ($this->fk_parent != "" ? intval($this->fk_parent) : 0);
439 
440  if ($this->already_exists()) {
441  $this->error = $langs->trans("ImpossibleAddCat", $this->label);
442  $this->error .= " : ".$langs->trans("CategoryExistsAtSameLevel");
443  dol_syslog($this->error, LOG_WARNING);
444  return -4;
445  }
446 
447  $this->db->begin();
448  $now = dol_now();
449  $sql = "INSERT INTO ".MAIN_DB_PREFIX."categorie (";
450  $sql .= "fk_parent,";
451  $sql .= " label,";
452  $sql .= " description,";
453  $sql .= " color,";
454  if (!empty($conf->global->CATEGORY_ASSIGNED_TO_A_CUSTOMER)) {
455  $sql .= "fk_soc,";
456  }
457  $sql .= " visible,";
458  $sql .= " type,";
459  $sql .= " import_key,";
460  $sql .= " ref_ext,";
461  $sql .= " entity,";
462  $sql .= " date_creation,";
463  $sql .= " fk_user_creat";
464  $sql .= ") VALUES (";
465  $sql .= (int) $this->fk_parent.",";
466  $sql .= "'".$this->db->escape($this->label)."', ";
467  $sql .= "'".$this->db->escape($this->description)."', ";
468  $sql .= "'".$this->db->escape($this->color)."', ";
469  if (!empty($conf->global->CATEGORY_ASSIGNED_TO_A_CUSTOMER)) {
470  $sql .= ($this->socid > 0 ? $this->socid : 'null').", ";
471  }
472  $sql .= "'".$this->db->escape($this->visible)."', ";
473  $sql .= ((int) $type).", ";
474  $sql .= (!empty($this->import_key) ? "'".$this->db->escape($this->import_key)."'" : 'null').", ";
475  $sql .= (!empty($this->ref_ext) ? "'".$this->db->escape($this->ref_ext)."'" : 'null').", ";
476  $sql .= (int) $conf->entity.", ";
477  $sql .= "'".$this->db->idate($now)."', ";
478  $sql .= (int) $user->id;
479  $sql .= ")";
480 
481  $res = $this->db->query($sql);
482  if ($res) {
483  $id = $this->db->last_insert_id(MAIN_DB_PREFIX."categorie");
484 
485  if ($id > 0) {
486  $this->id = $id;
487 
488  $action = 'create';
489 
490  // Actions on extra fields
491  if (!$error) {
492  $result = $this->insertExtraFields();
493  if ($result < 0) {
494  $error++;
495  }
496  }
497 
498  if (!$error) {
499  // Call trigger
500  $result = $this->call_trigger('CATEGORY_CREATE', $user);
501  if ($result < 0) {
502  $error++;
503  }
504  // End call triggers
505  }
506 
507  if (!$error) {
508  $this->db->commit();
509  return $id;
510  } else {
511  $this->db->rollback();
512  return -3;
513  }
514  } else {
515  $this->db->rollback();
516  return -2;
517  }
518  } else {
519  $this->error = $this->db->error();
520  $this->db->rollback();
521  return -1;
522  }
523  }
524 
533  public function update(User $user)
534  {
535  global $conf, $langs, $hookmanager;
536 
537  $error = 0;
538 
539  // Clean parameters
540  $this->label = trim($this->label);
541  $this->description = trim($this->description);
542  $this->ref_ext = trim($this->ref_ext);
543  $this->fk_parent = ($this->fk_parent != "" ? intval($this->fk_parent) : 0);
544  $this->visible = ($this->visible != "" ? intval($this->visible) : 0);
545 
546  if ($this->already_exists()) {
547  $this->error = $langs->trans("ImpossibleUpdateCat");
548  $this->error .= " : ".$langs->trans("CategoryExistsAtSameLevel");
549  return -1;
550  }
551 
552  $this->db->begin();
553 
554  $sql = "UPDATE ".MAIN_DB_PREFIX."categorie";
555  $sql .= " SET label = '".$this->db->escape($this->label)."',";
556  $sql .= " description = '".$this->db->escape($this->description)."',";
557  $sql .= " ref_ext = '".$this->db->escape($this->ref_ext)."',";
558  $sql .= " color = '".$this->db->escape($this->color)."'";
559  if (!empty($conf->global->CATEGORY_ASSIGNED_TO_A_CUSTOMER)) {
560  $sql .= ", fk_soc = ".($this->socid > 0 ? $this->socid : 'null');
561  }
562  $sql .= ", visible = ".(int) $this->visible;
563  $sql .= ", fk_parent = ".(int) $this->fk_parent;
564  $sql .= ", fk_user_modif = ".(int) $user->id;
565  $sql .= " WHERE rowid = ".((int) $this->id);
566 
567  dol_syslog(get_class($this)."::update", LOG_DEBUG);
568  if ($this->db->query($sql)) {
569  $action = 'update';
570 
571  // Actions on extra fields
572  if (!$error) {
573  $result = $this->insertExtraFields();
574  if ($result < 0) {
575  $error++;
576  }
577  }
578 
579  if (!$error) {
580  // Call trigger
581  $result = $this->call_trigger('CATEGORY_MODIFY', $user);
582  if ($result < 0) {
583  $error++; $this->db->rollback(); return -1;
584  }
585  // End call triggers
586  }
587 
588  $this->db->commit();
589 
590  return 1;
591  } else {
592  $this->db->rollback();
593  dol_print_error($this->db);
594  return -1;
595  }
596  }
597 
605  public function delete($user, $notrigger = 0)
606  {
607  global $conf, $langs;
608 
609  $error = 0;
610 
611  // Clean parameters
612  $this->fk_parent = ($this->fk_parent != "" ? intval($this->fk_parent) : 0);
613 
614  dol_syslog(get_class($this)."::remove");
615 
616  $this->db->begin();
617 
618  if (!$error && !$notrigger) {
619  // Call trigger
620  $result = $this->call_trigger('CATEGORY_DELETE', $user);
621  if ($result < 0) {
622  $error++;
623  }
624  // End call triggers
625  }
626 
627  /* FIX #1317 : Check for child category and move up 1 level*/
628  if (!$error) {
629  $sql = "UPDATE ".MAIN_DB_PREFIX."categorie";
630  $sql .= " SET fk_parent = ".((int) $this->fk_parent);
631  $sql .= " WHERE fk_parent = ".((int) $this->id);
632 
633  if (!$this->db->query($sql)) {
634  $this->error = $this->db->lasterror();
635  $error++;
636  }
637  }
638 
639  $arraydelete = array(
640  'categorie_account' => 'fk_categorie',
641  'categorie_actioncomm' => 'fk_categorie',
642  'categorie_contact' => 'fk_categorie',
643  'categorie_fournisseur' => 'fk_categorie',
644  'categorie_knowledgemanagement' => array('field' => 'fk_categorie', 'enabled' => isModEnabled('knowledgemanagement')),
645  'categorie_member' => 'fk_categorie',
646  'categorie_user' => 'fk_categorie',
647  'categorie_product' => 'fk_categorie',
648  'categorie_project' => 'fk_categorie',
649  'categorie_societe' => 'fk_categorie',
650  'categorie_ticket' => array('field' => 'fk_categorie', 'enabled' => isModEnabled('ticket')),
651  'categorie_warehouse' => 'fk_categorie',
652  'categorie_website_page' => array('field' => 'fk_categorie', 'enabled' => isModEnabled('website')),
653  'bank_class' => 'fk_categ',
654  'categorie_lang' => 'fk_category',
655  'categorie' => 'rowid',
656  );
657  foreach ($arraydelete as $key => $value) {
658  if (is_array($value)) {
659  if (empty($value['enabled'])) {
660  continue;
661  }
662  $value = $value['field'];
663  }
664  $sql = "DELETE FROM ".MAIN_DB_PREFIX.$key;
665  $sql .= " WHERE ".$value." = ".((int) $this->id);
666  if (!$this->db->query($sql)) {
667  $this->errors[] = $this->db->lasterror();
668  dol_syslog("Error sql=".$sql." ".$this->error, LOG_ERR);
669  $error++;
670  }
671  }
672 
673  // Removed extrafields
674  if (!$error) {
675  $result = $this->deleteExtraFields();
676  if ($result < 0) {
677  $error++;
678  dol_syslog(get_class($this)."::delete erreur ".$this->error, LOG_ERR);
679  }
680  }
681 
682  if (!$error) {
683  $this->db->commit();
684  return 1;
685  } else {
686  $this->db->rollback();
687  return -1;
688  }
689  }
690 
691  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
700  public function add_type($obj, $type = '')
701  {
702  // phpcs:enable
703  global $user, $langs, $conf;
704 
705  $error = 0;
706 
707  if ($this->id == -1) {
708  return -2;
709  }
710 
711  if (empty($type)) {
712  $type = $obj->element;
713  }
714 
715  dol_syslog(get_class($this).'::add_type', LOG_DEBUG);
716 
717  $this->db->begin();
718 
719  $sql = "INSERT INTO ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type]);
720  $sql .= " (fk_categorie, fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type]).")";
721  $sql .= " VALUES (".((int) $this->id).", ".((int) $obj->id).")";
722 
723  if ($this->db->query($sql)) {
724  if (!empty($conf->global->CATEGORIE_RECURSIV_ADD)) {
725  $sql = 'SELECT fk_parent FROM '.MAIN_DB_PREFIX.'categorie';
726  $sql .= " WHERE rowid = ".((int) $this->id);
727 
728  dol_syslog(get_class($this)."::add_type", LOG_DEBUG);
729  $resql = $this->db->query($sql);
730  if ($resql) {
731  if ($this->db->num_rows($resql) > 0) {
732  $objparent = $this->db->fetch_object($resql);
733 
734  if (!empty($objparent->fk_parent)) {
735  $cat = new Categorie($this->db);
736  $cat->id = $objparent->fk_parent;
737  if (!$cat->containsObject($type, $obj->id)) {
738  $result = $cat->add_type($obj, $type);
739  if ($result < 0) {
740  $this->error = $cat->error;
741  $error++;
742  }
743  }
744  }
745  }
746  } else {
747  $error++;
748  $this->error = $this->db->lasterror();
749  }
750 
751  if ($error) {
752  $this->db->rollback();
753  return -1;
754  }
755  }
756 
757  // Call trigger
758  $this->context = array('linkto'=>$obj); // Save object we want to link category to into category instance to provide information to trigger
759  $result = $this->call_trigger('CATEGORY_LINK', $user);
760  if ($result < 0) {
761  $error++;
762  }
763  // End call triggers
764 
765  if (!$error) {
766  $this->db->commit();
767  return 1;
768  } else {
769  $this->db->rollback();
770  return -2;
771  }
772  } else {
773  $this->db->rollback();
774  if ($this->db->lasterrno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') {
775  $this->error = $this->db->lasterrno();
776  return -3;
777  } else {
778  $this->error = $this->db->lasterror();
779  }
780  return -1;
781  }
782  }
783 
784  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
793  public function del_type($obj, $type)
794  {
795  // phpcs:enable
796  global $user, $langs, $conf;
797 
798  $error = 0;
799 
800  // For backward compatibility
801  if ($type == 'societe') {
802  $type = 'customer';
803  dol_syslog(get_class($this)."::del_type(): type 'societe' is deprecated, please use 'customer' instead", LOG_WARNING);
804  } elseif ($type == 'fournisseur') {
805  $type = 'supplier';
806  dol_syslog(get_class($this)."::del_type(): type 'fournisseur' is deprecated, please use 'supplier' instead", LOG_WARNING);
807  }
808 
809  $this->db->begin();
810 
811  $sql = "DELETE FROM ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type]);
812  $sql .= " WHERE fk_categorie = ".((int) $this->id);
813  $sql .= " AND fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = ".((int) $obj->id);
814 
815  dol_syslog(get_class($this).'::del_type', LOG_DEBUG);
816  if ($this->db->query($sql)) {
817  // Call trigger
818  $this->context = array('unlinkoff'=>$obj); // Save object we want to link category to into category instance to provide information to trigger
819  $result = $this->call_trigger('CATEGORY_UNLINK', $user);
820  if ($result < 0) {
821  $error++;
822  }
823  // End call triggers
824 
825  if (!$error) {
826  $this->db->commit();
827  return 1;
828  } else {
829  $this->db->rollback();
830  return -2;
831  }
832  } else {
833  $this->db->rollback();
834  $this->error = $this->db->lasterror();
835  return -1;
836  }
837  }
838 
851  public function getObjectsInCateg($type, $onlyids = 0, $limit = 0, $offset = 0, $sortfield = '', $sortorder = 'ASC')
852  {
853  global $user;
854 
855  $objs = array();
856 
857  $classnameforobj = $this->MAP_OBJ_CLASS[$type];
858  $obj = new $classnameforobj($this->db);
859 
860  $sql = "SELECT c.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type]);
861  $sql .= " FROM ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type])." as c";
862  $sql .= ", ".MAIN_DB_PREFIX.(empty($this->MAP_OBJ_TABLE[$type]) ? $type : $this->MAP_OBJ_TABLE[$type])." as o";
863  $sql .= " WHERE o.entity IN (".getEntity($obj->element).")";
864  $sql .= " AND c.fk_categorie = ".((int) $this->id);
865  // Compatibility with actioncomm table which has id instead of rowid
866  if ((!empty($this->MAP_OBJ_TABLE[$type]) && $this->MAP_OBJ_TABLE[$type] == "actioncomm" ) || $type == "actioncomm") {
867  $sql .= " AND c.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = o.id";
868  } else {
869  $sql .= " AND c.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = o.rowid";
870  }
871  // Protection for external users
872  if (($type == 'customer' || $type == 'supplier') && $user->socid > 0) {
873  $sql .= " AND o.rowid = ".((int) $user->socid);
874  }
875  $sql .= $this->db->order($sortfield, $sortorder);
876  if ($limit > 0 || $offset > 0) {
877  $sql .= $this->db->plimit($limit + 1, $offset);
878  }
879 
880  dol_syslog(get_class($this)."::getObjectsInCateg", LOG_DEBUG);
881  $resql = $this->db->query($sql);
882  if ($resql) {
883  while ($rec = $this->db->fetch_array($resql)) {
884  if ($onlyids) {
885  $objs[] = $rec['fk_'.(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])];
886  } else {
887  $classnameforobj = $this->MAP_OBJ_CLASS[$type];
888 
889  $obj = new $classnameforobj($this->db);
890  $obj->fetch($rec['fk_'.(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])]);
891 
892  $objs[] = $obj;
893  }
894  }
895  return $objs;
896  } else {
897  $this->error = $this->db->error().' sql='.$sql;
898  return -1;
899  }
900  }
901 
910  public function containsObject($type, $object_id)
911  {
912  $sql = "SELECT COUNT(*) as nb FROM ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type]);
913  $sql .= " WHERE fk_categorie = ".((int) $this->id)." AND fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = ".((int) $object_id);
914  dol_syslog(get_class($this)."::containsObject", LOG_DEBUG);
915  $resql = $this->db->query($sql);
916  if ($resql) {
917  return $this->db->fetch_object($resql)->nb;
918  } else {
919  $this->error = $this->db->error().' sql='.$sql;
920  return -1;
921  }
922  }
923 
935  public function getListForItem($id, $type = 'customer', $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0)
936  {
937  global $conf;
938 
939  $categories = array();
940 
941  $type = sanitizeVal($type, 'aZ09');
942 
943  $sub_type = $type;
944  $subcol_name = "fk_".$type;
945  if ($type == "customer") {
946  $sub_type = "societe";
947  $subcol_name = "fk_soc";
948  }
949  if ($type == "supplier") {
950  $sub_type = "fournisseur";
951  $subcol_name = "fk_soc";
952  }
953  if ($type == "contact") {
954  $subcol_name = "fk_socpeople";
955  }
956 
957  $idoftype = array_search($type, self::$MAP_ID_TO_CODE);
958 
959  $sql = "SELECT s.rowid";
960  $sql .= " FROM ".MAIN_DB_PREFIX."categorie as s, ".MAIN_DB_PREFIX."categorie_".$sub_type." as sub";
961  $sql .= ' WHERE s.entity IN ('.getEntity('category').')';
962  $sql .= ' AND s.type='.((int) $idoftype);
963  $sql .= ' AND s.rowid = sub.fk_categorie';
964  $sql .= " AND sub.".$subcol_name." = ".((int) $id);
965 
966  $sql .= $this->db->order($sortfield, $sortorder);
967 
968  $offset = 0;
969  $nbtotalofrecords = '';
970  if (empty($conf->global->MAIN_DISABLE_FULL_SCANLIST)) {
971  $result = $this->db->query($sql);
972  $nbtotalofrecords = $this->db->num_rows($result);
973  if (($page * $limit) > $nbtotalofrecords) { // if total resultset is smaller then paging size (filtering), goto and load page 0
974  $page = 0;
975  $offset = 0;
976  }
977  }
978 
979  if ($limit) {
980  if ($page < 0) {
981  $page = 0;
982  }
983  $offset = $limit * $page;
984 
985  $sql .= $this->db->plimit($limit + 1, $offset);
986  }
987 
988  $result = $this->db->query($sql);
989  if ($result) {
990  $i = 0;
991  $num = $this->db->num_rows($result);
992  $min = min($num, ($limit <= 0 ? $num : $limit));
993  while ($i < $min) {
994  $obj = $this->db->fetch_object($result);
995  $category_static = new Categorie($this->db);
996  if ($category_static->fetch($obj->rowid)) {
997  $categories[$i]['id'] = $category_static->id;
998  $categories[$i]['fk_parent'] = $category_static->fk_parent;
999  $categories[$i]['label'] = $category_static->label;
1000  $categories[$i]['description'] = $category_static->description;
1001  $categories[$i]['color'] = $category_static->color;
1002  $categories[$i]['socid'] = $category_static->socid;
1003  $categories[$i]['ref_ext'] = $category_static->ref_ext;
1004  $categories[$i]['visible'] = $category_static->visible;
1005  $categories[$i]['type'] = $category_static->type;
1006  $categories[$i]['entity'] = $category_static->entity;
1007  $categories[$i]['array_options'] = $category_static->array_options;
1008 
1009  // multilangs
1010  if (getDolGlobalInt('MAIN_MULTILANGS') && isset($category_static->multilangs)) {
1011  $categories[$i]['multilangs'] = $category_static->multilangs;
1012  }
1013  }
1014  $i++;
1015  }
1016  } else {
1017  $this->error = $this->db->lasterror();
1018  return -1;
1019  }
1020  if (!count($categories)) {
1021  return 0;
1022  }
1023 
1024  return $categories;
1025  }
1026 
1027  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1033  public function get_filles()
1034  {
1035  // phpcs:enable
1036  $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."categorie";
1037  $sql .= " WHERE fk_parent = ".((int) $this->id);
1038  $sql .= " AND entity IN (".getEntity('category').")";
1039 
1040  $res = $this->db->query($sql);
1041  if ($res) {
1042  $cats = array();
1043  while ($rec = $this->db->fetch_array($res)) {
1044  $cat = new Categorie($this->db);
1045  $cat->fetch($rec['rowid']);
1046  $cats[] = $cat;
1047  }
1048  return $cats;
1049  } else {
1050  dol_print_error($this->db);
1051  return -1;
1052  }
1053  }
1054 
1055  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1061  protected function load_motherof()
1062  {
1063  // phpcs:enable
1064  $this->motherof = array();
1065 
1066  // Load array[child]=parent
1067  $sql = "SELECT fk_parent as id_parent, rowid as id_son";
1068  $sql .= " FROM ".MAIN_DB_PREFIX."categorie";
1069  $sql .= " WHERE fk_parent != 0";
1070  $sql .= " AND entity IN (".getEntity('category').")";
1071 
1072  dol_syslog(get_class($this)."::load_motherof", LOG_DEBUG);
1073  $resql = $this->db->query($sql);
1074  if ($resql) {
1075  while ($obj = $this->db->fetch_object($resql)) {
1076  $this->motherof[$obj->id_son] = $obj->id_parent;
1077  }
1078  return 1;
1079  } else {
1080  dol_print_error($this->db);
1081  return -1;
1082  }
1083  }
1084 
1085  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1105  public function get_full_arbo($type, $markafterid = 0, $include = 0)
1106  {
1107  // phpcs:enable
1108  global $conf, $langs;
1109 
1110  if (!is_numeric($type)) {
1111  $type = $this->MAP_ID[$type];
1112  }
1113  if (is_null($type)) {
1114  $this->error = 'BadValueForParameterType';
1115  return -1;
1116  }
1117 
1118  if (is_string($markafterid)) {
1119  $markafterid = explode(',', $markafterid);
1120  } elseif (is_numeric($markafterid)) {
1121  if ($markafterid > 0) {
1122  $markafterid = array($markafterid);
1123  } else {
1124  $markafterid = array();
1125  }
1126  } elseif (!is_array($markafterid)) {
1127  $markafterid = array();
1128  }
1129 
1130  $this->cats = array();
1131 
1132  // Init this->motherof that is array(id_son=>id_parent, ...)
1133  $this->load_motherof();
1134  $current_lang = $langs->getDefaultLang();
1135 
1136  // Init $this->cats array
1137  $sql = "SELECT DISTINCT c.rowid, c.label, c.ref_ext, c.description, c.color, c.fk_parent, c.visible"; // Distinct reduce pb with old tables with duplicates
1138  if (getDolGlobalInt('MAIN_MULTILANGS')) {
1139  $sql .= ", t.label as label_trans, t.description as description_trans";
1140  }
1141  $sql .= " FROM ".MAIN_DB_PREFIX."categorie as c";
1142  if (getDolGlobalInt('MAIN_MULTILANGS')) {
1143  $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."categorie_lang as t ON t.fk_category=c.rowid AND t.lang='".$this->db->escape($current_lang)."'";
1144  }
1145  $sql .= " WHERE c.entity IN (".getEntity('category').")";
1146  $sql .= " AND c.type = ".(int) $type;
1147 
1148  dol_syslog(get_class($this)."::get_full_arbo get category list", LOG_DEBUG);
1149  $resql = $this->db->query($sql);
1150  if ($resql) {
1151  $i = 0;
1152  while ($obj = $this->db->fetch_object($resql)) {
1153  $this->cats[$obj->rowid]['rowid'] = $obj->rowid;
1154  $this->cats[$obj->rowid]['id'] = $obj->rowid;
1155  $this->cats[$obj->rowid]['fk_parent'] = $obj->fk_parent;
1156  $this->cats[$obj->rowid]['label'] = !empty($obj->label_trans) ? $obj->label_trans : $obj->label;
1157  $this->cats[$obj->rowid]['description'] = !empty($obj->description_trans) ? $obj->description_trans : $obj->description;
1158  $this->cats[$obj->rowid]['color'] = $obj->color;
1159  $this->cats[$obj->rowid]['visible'] = $obj->visible;
1160  $this->cats[$obj->rowid]['ref_ext'] = $obj->ref_ext;
1161  $this->cats[$obj->rowid]['picto'] = 'category';
1162  $i++;
1163  }
1164  } else {
1165  dol_print_error($this->db);
1166  return -1;
1167  }
1168 
1169  // We add the fullpath property to each elements of first level (no parent exists)
1170  dol_syslog(get_class($this)."::get_full_arbo call to buildPathFromId", LOG_DEBUG);
1171  foreach ($this->cats as $key => $val) {
1172  //print 'key='.$key.'<br>'."\n";
1173  $this->buildPathFromId($key, 0); // Process a branch from the root category key (this category has no parent)
1174  }
1175 
1176  // Include or exclude leaf including $markafterid from tree
1177  if (count($markafterid) > 0) {
1178  $keyfiltercatid = '('.implode('|', $markafterid).')';
1179 
1180  //print "Look to discard category ".$markafterid."\n";
1181  $keyfilter1 = '^'.$keyfiltercatid.'$';
1182  $keyfilter2 = '_'.$keyfiltercatid.'$';
1183  $keyfilter3 = '^'.$keyfiltercatid.'_';
1184  $keyfilter4 = '_'.$keyfiltercatid.'_';
1185  foreach ($this->cats as $key => $val) {
1186  $test = (preg_match('/'.$keyfilter1.'/', $val['fullpath']) || preg_match('/'.$keyfilter2.'/', $val['fullpath'])
1187  || preg_match('/'.$keyfilter3.'/', $val['fullpath']) || preg_match('/'.$keyfilter4.'/', $val['fullpath']));
1188 
1189  if (($test && !$include) || (!$test && $include)) {
1190  unset($this->cats[$key]);
1191  }
1192  }
1193  }
1194 
1195  dol_syslog(get_class($this)."::get_full_arbo dol_sort_array", LOG_DEBUG);
1196  $this->cats = dol_sort_array($this->cats, 'fulllabel', 'asc', true, false);
1197 
1198  //$this->debug_cats();
1199 
1200  return $this->cats;
1201  }
1202 
1213  private function buildPathFromId($id_categ, $protection = 1000)
1214  {
1215  //dol_syslog(get_class($this)."::buildPathFromId id_categ=".$id_categ." protection=".$protection, LOG_DEBUG);
1216 
1217  if (!empty($this->cats[$id_categ]['fullpath'])) {
1218  // Already defined
1219  dol_syslog(get_class($this)."::buildPathFromId fullpath and fulllabel already defined", LOG_WARNING);
1220  return;
1221  }
1222 
1223  // First build full array $motherof
1224  //$this->load_motherof(); // Disabled because already done by caller of buildPathFromId
1225 
1226  // $this->cats[$id_categ] is supposed to be already an array. We just want to complete it with property fullpath and fulllabel
1227 
1228  // Define fullpath and fulllabel
1229  $this->cats[$id_categ]['fullpath'] = '_'.$id_categ;
1230  $this->cats[$id_categ]['fulllabel'] = $this->cats[$id_categ]['label'];
1231  $i = 0; $cursor_categ = $id_categ;
1232  //print 'Work for id_categ='.$id_categ.'<br>'."\n";
1233  while ((empty($protection) || $i < $protection) && !empty($this->motherof[$cursor_categ])) {
1234  //print '&nbsp; cursor_categ='.$cursor_categ.' i='.$i.' '.$this->motherof[$cursor_categ].'<br>'."\n";
1235  $this->cats[$id_categ]['fullpath'] = '_'.$this->motherof[$cursor_categ].$this->cats[$id_categ]['fullpath'];
1236  $this->cats[$id_categ]['fulllabel'] = (empty($this->cats[$this->motherof[$cursor_categ]]) ? 'NotFound' : $this->cats[$this->motherof[$cursor_categ]]['label']).' >> '.$this->cats[$id_categ]['fulllabel'];
1237  //print '&nbsp; Result for id_categ='.$id_categ.' : '.$this->cats[$id_categ]['fullpath'].' '.$this->cats[$id_categ]['fulllabel'].'<br>'."\n";
1238  $i++;
1239  $cursor_categ = $this->motherof[$cursor_categ];
1240  }
1241  //print 'Result for id_categ='.$id_categ.' : '.$this->cats[$id_categ]['fullpath'].'<br>'."\n";
1242 
1243  // We count number of _ to have level
1244  $nbunderscore = substr_count($this->cats[$id_categ]['fullpath'], '_');
1245  $this->cats[$id_categ]['level'] = ($nbunderscore ? $nbunderscore : null);
1246 
1247  return;
1248  }
1249 
1250  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1256  public function debug_cats()
1257  {
1258  // phpcs:enable
1259  // Display $this->cats
1260  foreach ($this->cats as $key => $val) {
1261  print 'id: '.$this->cats[$key]['id'];
1262  print ' label: '.$this->cats[$key]['label'];
1263  print ' mother: '.$this->cats[$key]['fk_parent'];
1264  //print ' children: '.(is_array($this->cats[$key]['id_children'])?join(',',$this->cats[$key]['id_children']):'');
1265  print ' fullpath: '.$this->cats[$key]['fullpath'];
1266  print ' fulllabel: '.$this->cats[$key]['fulllabel'];
1267  print "<br>\n";
1268  }
1269  }
1270 
1271 
1272  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1280  public function get_all_categories($type = null, $parent = false)
1281  {
1282  // phpcs:enable
1283  if (!is_numeric($type)) {
1284  $type = $this->MAP_ID[$type];
1285  }
1286 
1287  $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."categorie";
1288  $sql .= " WHERE entity IN (".getEntity('category').")";
1289  if (!is_null($type)) {
1290  $sql .= " AND type = ".(int) $type;
1291  }
1292  if ($parent) {
1293  $sql .= " AND fk_parent = 0";
1294  }
1295 
1296  $res = $this->db->query($sql);
1297  if ($res) {
1298  $cats = array();
1299  while ($rec = $this->db->fetch_array($res)) {
1300  $cat = new Categorie($this->db);
1301  $cat->fetch($rec['rowid']);
1302  $cats[$rec['rowid']] = $cat;
1303  }
1304  return $cats;
1305  } else {
1306  dol_print_error($this->db);
1307  return -1;
1308  }
1309  }
1310 
1311  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1318  public function get_main_categories($type = null)
1319  {
1320  // phpcs:enable
1321  return $this->get_all_categories($type, true);
1322  }
1323 
1324  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1330  public function already_exists()
1331  {
1332  // phpcs:enable
1333  $type = $this->type;
1334 
1335  if (!is_numeric($type)) {
1336  $type = $this->MAP_ID[$type];
1337  }
1338 
1339  /* We have to select any rowid from llx_categorie which category's mother and label
1340  * are equals to those of the calling category
1341  */
1342  $sql = "SELECT c.rowid";
1343  $sql .= " FROM ".MAIN_DB_PREFIX."categorie as c ";
1344  $sql .= " WHERE c.entity IN (".getEntity('category').")";
1345  $sql .= " AND c.type = ".((int) $type);
1346  $sql .= " AND c.fk_parent = ".((int) $this->fk_parent);
1347  $sql .= " AND c.label = '".$this->db->escape($this->label)."'";
1348 
1349  dol_syslog(get_class($this)."::already_exists", LOG_DEBUG);
1350  $resql = $this->db->query($sql);
1351  if ($resql) {
1352  if ($this->db->num_rows($resql) > 0) { // Checking for empty resql
1353  $obj = $this->db->fetch_array($resql);
1354  /* If object called create, obj cannot have is id.
1355  * If object called update, he mustn't have the same label as an other category for this mother.
1356  * So if the result have the same id, update is not for label, and if result have an other one,
1357  * update may be for label.
1358  */
1359  if ($obj[0] > 0 && $obj[0] != $this->id) {
1360  dol_syslog(get_class($this)."::already_exists category with name=".$this->label." and parent ".$this->fk_parent." exists: rowid=".$obj[0]." current_id=".$this->id, LOG_DEBUG);
1361  return 1;
1362  }
1363  }
1364  dol_syslog(get_class($this)."::already_exists no category with same name=".$this->label." and same parent ".$this->fk_parent." than category id=".$this->id, LOG_DEBUG);
1365  return 0;
1366  } else {
1367  $this->error = $this->db->error();
1368  return -1;
1369  }
1370  }
1371 
1372 
1373  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1384  public function print_all_ways($sep = '&gt;&gt;', $url = '', $nocolor = 0, $addpicto = 0)
1385  {
1386  // phpcs:enable
1387  $ways = array();
1388 
1389  $allways = $this->get_all_ways(); // Load array of categories
1390  foreach ($allways as $way) {
1391  $w = array();
1392  $i = 0;
1393  $forced_color = '';
1394  foreach ($way as $cat) {
1395  $i++;
1396 
1397  if (empty($nocolor)) {
1398  $forced_color = 'colortoreplace';
1399  if ($i == count($way)) { // Last category in hierarchy
1400  // Check contrast with background and correct text color
1401  $forced_color = 'categtextwhite';
1402  if ($cat->color) {
1403  if (colorIsLight($cat->color)) {
1404  $forced_color = 'categtextblack';
1405  }
1406  }
1407  }
1408  }
1409 
1410  if ($url == '') {
1411  $link = '<a href="'.DOL_URL_ROOT.'/categories/viewcat.php?id='.$cat->id.'&type='.$cat->type.'" class="'.$forced_color.'">';
1412  $linkend = '</a>';
1413  $w[] = $link.(($addpicto && $i == 1) ? img_object('', 'category', 'class="paddingright"') : '').$cat->label.$linkend;
1414  } elseif ($url == 'none') {
1415  $link = '<span class="'.$forced_color.'">';
1416  $linkend = '</span>';
1417  $w[] = $link.(($addpicto && $i == 1) ? img_object('', 'category', 'class="paddingright"') : '').$cat->label.$linkend;
1418  } else {
1419  $w[] = '<a class="'.$forced_color.'" href="'.DOL_URL_ROOT.'/'.$url.'?catid='.$cat->id.'">'.($addpicto ? img_object('', 'category') : '').$cat->label.'</a>';
1420  }
1421  }
1422  $newcategwithpath = preg_replace('/colortoreplace/', $forced_color, implode('<span class="inline-block valignmiddle paddingleft paddingright '.$forced_color.'">'.$sep.'</span>', $w));
1423 
1424  $ways[] = $newcategwithpath;
1425  }
1426 
1427  return $ways;
1428  }
1429 
1430 
1431  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1437  public function get_meres()
1438  {
1439  // phpcs:enable
1440  $parents = array();
1441 
1442  $sql = "SELECT fk_parent FROM ".MAIN_DB_PREFIX."categorie";
1443  $sql .= " WHERE rowid = ".((int) $this->id);
1444 
1445  $res = $this->db->query($sql);
1446 
1447  if ($res) {
1448  while ($rec = $this->db->fetch_array($res)) {
1449  if ($rec['fk_parent'] > 0) {
1450  $cat = new Categorie($this->db);
1451  $cat->fetch($rec['fk_parent']);
1452  $parents[] = $cat;
1453  }
1454  }
1455  return $parents;
1456  } else {
1457  dol_print_error($this->db);
1458  return -1;
1459  }
1460  }
1461 
1462  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1469  public function get_all_ways()
1470  {
1471  // phpcs:enable
1472  $ways = array();
1473 
1474  $parents = $this->get_meres();
1475  if (is_array($parents)) {
1476  foreach ($parents as $parent) {
1477  $allways = $parent->get_all_ways();
1478  foreach ($allways as $way) {
1479  $w = $way;
1480  $w[] = $this;
1481  $ways[] = $w;
1482  }
1483  }
1484  }
1485 
1486  if (count($ways) == 0) {
1487  $ways[0][0] = $this;
1488  }
1489 
1490  return $ways;
1491  }
1492 
1503  public function containing($id, $type, $mode = 'object')
1504  {
1505  $cats = array();
1506 
1507  if (is_numeric($type)) {
1508  $type = Categorie::$MAP_ID_TO_CODE[$type];
1509  }
1510 
1511  if ($type === Categorie::TYPE_BANK_LINE) { // TODO Remove this with standard category code after migration of llx_bank_categ into llx_categorie
1512  // Load bank categories
1513  $sql = "SELECT c.label, c.rowid";
1514  $sql .= " FROM ".MAIN_DB_PREFIX."bank_class as a, ".MAIN_DB_PREFIX."bank_categ as c";
1515  $sql .= " WHERE a.lineid=".((int) $id)." AND a.fk_categ = c.rowid";
1516  $sql .= " AND c.entity IN (".getEntity('category').")";
1517  $sql .= " ORDER BY c.label";
1518 
1519  $res = $this->db->query($sql);
1520  if ($res) {
1521  while ($obj = $this->db->fetch_object($res)) {
1522  if ($mode == 'id') {
1523  $cats[] = $obj->rowid;
1524  } elseif ($mode == 'label') {
1525  $cats[] = $obj->label;
1526  } else {
1527  $cat = new Categorie($this->db);
1528  $cat->id = $obj->rowid;
1529  $cat->label = $obj->label;
1530  $cats[] = $cat;
1531  }
1532  }
1533  } else {
1534  dol_print_error($this->db);
1535  return -1;
1536  }
1537  } else {
1538  $sql = "SELECT ct.fk_categorie, c.label, c.rowid";
1539  $sql .= " FROM ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type])." as ct, ".MAIN_DB_PREFIX."categorie as c";
1540  $sql .= " WHERE ct.fk_categorie = c.rowid AND ct.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = ".(int) $id;
1541  // This seems useless because the table already contains id of category of 1 unique type. So commented.
1542  // So now it works also with external added categories.
1543  //$sql .= " AND c.type = ".((int) $this->MAP_ID[$type]);
1544  $sql .= " AND c.entity IN (".getEntity('category').")";
1545 
1546  $res = $this->db->query($sql);
1547  if ($res) {
1548  while ($obj = $this->db->fetch_object($res)) {
1549  if ($mode == 'id') {
1550  $cats[] = $obj->rowid;
1551  } elseif ($mode == 'label') {
1552  $cats[] = $obj->label;
1553  } else {
1554  $cat = new Categorie($this->db);
1555  $cat->fetch($obj->fk_categorie);
1556  $cats[] = $cat;
1557  }
1558  }
1559  } else {
1560  dol_print_error($this->db);
1561  return -1;
1562  }
1563  }
1564 
1565  return $cats;
1566  }
1567 
1579  public function rechercher($id, $nom, $type, $exact = false, $case = false)
1580  {
1581  // Deprecation warning
1582  if (is_numeric($type)) {
1583  dol_syslog(__METHOD__.': using numeric types is deprecated.', LOG_WARNING);
1584  }
1585 
1586  $cats = array();
1587 
1588  // For backward compatibility
1589  if (is_numeric($type)) {
1590  // We want to reverse lookup
1591  $map_type = array_flip($this->MAP_ID);
1592  $type = $map_type[$type];
1593  dol_syslog(get_class($this)."::rechercher(): numeric types are deprecated, please use string instead", LOG_WARNING);
1594  }
1595 
1596  // Generation requete recherche
1597  $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."categorie";
1598  $sql .= " WHERE type = ".((int) $this->MAP_ID[$type]);
1599  $sql .= " AND entity IN (".getEntity('category').")";
1600  if ($nom) {
1601  if (!$exact) {
1602  $nom = '%'.$this->db->escape(str_replace('*', '%', $nom)).'%';
1603  }
1604  if (!$case) {
1605  $sql .= " AND label LIKE '".$this->db->escape($nom)."'";
1606  } else {
1607  $sql .= " AND label LIKE BINARY '".$this->db->escape($nom)."'";
1608  }
1609  }
1610  if ($id) {
1611  $sql .= " AND rowid = ".((int) $id);
1612  }
1613 
1614  $res = $this->db->query($sql);
1615  if ($res) {
1616  while ($rec = $this->db->fetch_array($res)) {
1617  $cat = new Categorie($this->db);
1618  $cat->fetch($rec['rowid']);
1619  $cats[] = $cat;
1620  }
1621 
1622  return $cats;
1623  } else {
1624  $this->error = $this->db->error().' sql='.$sql;
1625  return -1;
1626  }
1627  }
1628 
1639  public function getNomUrl($withpicto = 0, $option = '', $maxlength = 0, $moreparam = '')
1640  {
1641  global $langs, $hookmanager;
1642 
1643  $result = '';
1644  $label = $langs->trans("ShowCategory").': '.($this->ref ? $this->ref : $this->label);
1645 
1646  // Check contrast with background and correct text color
1647  $forced_color = 'categtextwhite';
1648  if ($this->color) {
1649  if (colorIsLight($this->color)) {
1650  $forced_color = 'categtextblack';
1651  }
1652  }
1653 
1654  $link = '<a href="'.DOL_URL_ROOT.'/categories/viewcat.php?id='.$this->id.'&type='.$this->type.$moreparam.'&backtopage='.urlencode($_SERVER['PHP_SELF'].($moreparam ? '?'.$moreparam : '')).'" title="'.dol_escape_htmltag($label, 1).'" class="classfortooltip '.$forced_color.'">';
1655  $linkend = '</a>';
1656 
1657  $picto = 'category';
1658 
1659 
1660  if ($withpicto) {
1661  $result .= ($link.img_object($label, $picto, 'class="classfortooltip"').$linkend);
1662  }
1663  if ($withpicto && $withpicto != 2) {
1664  $result .= ' ';
1665  }
1666  if ($withpicto != 2) {
1667  $result .= $link.dol_trunc(($this->ref ? $this->ref : $this->label), $maxlength).$linkend;
1668  }
1669  global $action;
1670  $hookmanager->initHooks(array($this->element . 'dao'));
1671  $parameters = array('id'=>$this->id, 'getnomurl' => &$result);
1672  $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
1673  if ($reshook > 0) {
1674  $result = $hookmanager->resPrint;
1675  } else {
1676  $result .= $hookmanager->resPrint;
1677  }
1678  return $result;
1679  }
1680 
1681 
1682  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1690  public function add_photo($sdir, $file)
1691  {
1692  // phpcs:enable
1693  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
1694 
1695  $dir = $sdir.'/'.get_exdir($this->id, 2, 0, 0, $this, 'category').$this->id."/";
1696  $dir .= "photos/";
1697 
1698  if (!file_exists($dir)) {
1699  dol_mkdir($dir);
1700  }
1701 
1702  if (file_exists($dir)) {
1703  if (is_array($file['name']) && count($file['name']) > 0) {
1704  $nbfile = count($file['name']);
1705  for ($i = 0; $i <= $nbfile; $i++) {
1706  $originImage = $dir.$file['name'][$i];
1707 
1708  // Cree fichier en taille origine
1709  dol_move_uploaded_file($file['tmp_name'][$i], $originImage, 1, 0, 0);
1710 
1711  if (file_exists($originImage)) {
1712  // Create thumbs
1713  $this->addThumbs($originImage);
1714  }
1715  }
1716  } else {
1717  $originImage = $dir.$file['name'];
1718 
1719  // Cree fichier en taille origine
1720  dol_move_uploaded_file($file['tmp_name'], $originImage, 1, 0, 0);
1721 
1722  if (file_exists($originImage)) {
1723  // Create thumbs
1724  $this->addThumbs($originImage);
1725  }
1726  }
1727  }
1728  }
1729 
1730  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1738  public function liste_photos($dir, $nbmax = 0)
1739  {
1740  // phpcs:enable
1741  include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
1742 
1743  $nbphoto = 0;
1744  $tabobj = array();
1745 
1746  $dirthumb = $dir.'thumbs/';
1747 
1748  if (file_exists($dir)) {
1749  $handle = opendir($dir);
1750  if (is_resource($handle)) {
1751  while (($file = readdir($handle)) !== false) {
1752  if (dol_is_file($dir.$file) && preg_match('/(\.jpeg|\.jpg|\.bmp|\.gif|\.png|\.tiff)$/i', $dir.$file)) {
1753  $nbphoto++;
1754  $photo = $file;
1755 
1756  // On determine nom du fichier vignette
1757  $photo_vignette = '';
1758  if (preg_match('/(\.jpeg|\.jpg|\.bmp|\.gif|\.png|\.tiff)$/i', $photo, $regs)) {
1759  $photo_vignette = preg_replace('/'.$regs[0].'/i', '', $photo).'_small'.$regs[0];
1760  }
1761 
1762  // Objet
1763  $obj = array();
1764  $obj['photo'] = $photo;
1765  if ($photo_vignette && is_file($dirthumb.$photo_vignette)) {
1766  $obj['photo_vignette'] = 'thumbs/'.$photo_vignette;
1767  } else {
1768  $obj['photo_vignette'] = "";
1769  }
1770 
1771  $tabobj[$nbphoto - 1] = $obj;
1772 
1773  // On continue ou on arrete de boucler
1774  if ($nbmax && $nbphoto >= $nbmax) {
1775  break;
1776  }
1777  }
1778  }
1779 
1780  closedir($handle);
1781  }
1782  }
1783 
1784  return $tabobj;
1785  }
1786 
1787  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1794  public function delete_photo($file)
1795  {
1796  // phpcs:enable
1797  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
1798 
1799  $dir = dirname($file).'/'; // Chemin du dossier contenant l'image d'origine
1800  $dirthumb = $dir.'/thumbs/'; // Chemin du dossier contenant la vignette
1801  $filename = preg_replace('/'.preg_quote($dir, '/').'/i', '', $file); // Nom du fichier
1802 
1803  // On efface l'image d'origine
1804  dol_delete_file($file, 1);
1805 
1806  // Si elle existe, on efface la vignette
1807  if (preg_match('/(\.jpeg|\.jpg|\.bmp|\.gif|\.png|\.tiff)$/i', $filename, $regs)) {
1808  $photo_vignette = preg_replace('/'.$regs[0].'/i', '', $filename).'_small'.$regs[0];
1809  if (file_exists($dirthumb.$photo_vignette)) {
1810  dol_delete_file($dirthumb.$photo_vignette, 1);
1811  }
1812  }
1813  }
1814 
1815  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1822  public function get_image_size($file)
1823  {
1824  // phpcs:enable
1825  $infoImg = getimagesize($file); // Recuperation des infos de l'image
1826  $this->imgWidth = $infoImg[0]; // Largeur de l'image
1827  $this->imgHeight = $infoImg[1]; // Hauteur de l'image
1828  }
1829 
1837  public function setMultiLangs($user)
1838  {
1839  global $langs;
1840 
1841  $langs_available = $langs->get_available_languages();
1842  $current_lang = $langs->getDefaultLang();
1843 
1844  foreach ($langs_available as $key => $value) {
1845  $sql = "SELECT rowid";
1846  $sql .= " FROM ".MAIN_DB_PREFIX."categorie_lang";
1847  $sql .= " WHERE fk_category=".((int) $this->id);
1848  $sql .= " AND lang = '".$this->db->escape($key)."'";
1849 
1850  $result = $this->db->query($sql);
1851 
1852  if ($key == $current_lang) {
1853  if ($this->db->num_rows($result)) { // si aucune ligne dans la base
1854  $sql2 = "UPDATE ".MAIN_DB_PREFIX."categorie_lang";
1855  $sql2 .= " SET label = '".$this->db->escape($this->label)."',";
1856  $sql2 .= " description = '".$this->db->escape($this->description)."'";
1857  $sql2 .= " WHERE fk_category = ".((int) $this->id)." AND lang = '".$this->db->escape($key)."'";
1858  } else {
1859  $sql2 = "INSERT INTO ".MAIN_DB_PREFIX."categorie_lang (fk_category, lang, label, description)";
1860  $sql2 .= " VALUES(".((int) $this->id).", '".$this->db->escape($key)."', '".$this->db->escape($this->label)."'";
1861  $sql2 .= ", '".$this->db->escape($this->multilangs["$key"]["description"])."')";
1862  }
1863  dol_syslog(get_class($this).'::setMultiLangs', LOG_DEBUG);
1864  if (!$this->db->query($sql2)) {
1865  $this->error = $this->db->lasterror();
1866  return -1;
1867  }
1868  } elseif (isset($this->multilangs["$key"])) {
1869  if ($this->db->num_rows($result)) { // si aucune ligne dans la base
1870  $sql2 = "UPDATE ".MAIN_DB_PREFIX."categorie_lang";
1871  $sql2 .= " SET label='".$this->db->escape($this->multilangs["$key"]["label"])."',";
1872  $sql2 .= " description='".$this->db->escape($this->multilangs["$key"]["description"])."'";
1873  $sql2 .= " WHERE fk_category=".((int) $this->id)." AND lang='".$this->db->escape($key)."'";
1874  } else {
1875  $sql2 = "INSERT INTO ".MAIN_DB_PREFIX."categorie_lang (fk_category, lang, label, description)";
1876  $sql2 .= " VALUES(".((int) $this->id).", '".$this->db->escape($key)."', '".$this->db->escape($this->multilangs["$key"]["label"])."'";
1877  $sql2 .= ",'".$this->db->escape($this->multilangs["$key"]["description"])."')";
1878  }
1879 
1880  // on ne sauvegarde pas des champs vides
1881  if ($this->multilangs["$key"]["label"] || $this->multilangs["$key"]["description"] || $this->multilangs["$key"]["note"]) {
1882  dol_syslog(get_class($this).'::setMultiLangs', LOG_DEBUG);
1883  }
1884  if (!$this->db->query($sql2)) {
1885  $this->error = $this->db->lasterror();
1886  return -1;
1887  }
1888  }
1889  }
1890 
1891  // Call trigger
1892  $result = $this->call_trigger('CATEGORY_SET_MULTILANGS', $user);
1893  if ($result < 0) {
1894  $this->error = $this->db->lasterror();
1895  return -1;
1896  }
1897  // End call triggers
1898 
1899  return 1;
1900  }
1901 
1907  public function getMultiLangs()
1908  {
1909  global $langs;
1910 
1911  $current_lang = $langs->getDefaultLang();
1912 
1913  $sql = "SELECT lang, label, description";
1914  $sql .= " FROM ".MAIN_DB_PREFIX."categorie_lang";
1915  $sql .= " WHERE fk_category=".((int) $this->id);
1916 
1917  $result = $this->db->query($sql);
1918  if ($result) {
1919  while ($obj = $this->db->fetch_object($result)) {
1920  //print 'lang='.$obj->lang.' current='.$current_lang.'<br>';
1921  if ($obj->lang == $current_lang) { // si on a les traduct. dans la langue courante on les charge en infos principales.
1922  $this->label = $obj->label;
1923  $this->description = $obj->description;
1924  }
1925  $this->multilangs["$obj->lang"]["label"] = $obj->label;
1926  $this->multilangs["$obj->lang"]["description"] = $obj->description;
1927  }
1928  return 1;
1929  } else {
1930  $this->error = $langs->trans("Error")." : ".$this->db->error()." - ".$sql;
1931  return -1;
1932  }
1933  }
1934 
1941  public function getLibStatut($mode)
1942  {
1943  return '';
1944  }
1945 
1946 
1954  public function initAsSpecimen()
1955  {
1956  dol_syslog(get_class($this)."::initAsSpecimen");
1957 
1958  // Initialise parametres
1959  $this->id = 0;
1960  $this->fk_parent = 0;
1961  $this->label = 'SPECIMEN';
1962  $this->specimen = 1;
1963  $this->description = 'This is a description';
1964  $this->socid = 1;
1965  $this->type = self::TYPE_PRODUCT;
1966  }
1967 
1976  public static function replaceThirdparty(DoliDB $db, $origin_id, $dest_id)
1977  {
1978  $tables = array(
1979  'categorie_societe'
1980  );
1981 
1982  return CommonObject::commonReplaceThirdparty($db, $origin_id, $dest_id, $tables, 1);
1983  }
1984 
1993  public static function getFilterJoinQuery($type, $rowIdName)
1994  {
1995  if ($type == 'bank_account') {
1996  $type = 'account';
1997  }
1998 
1999  return " LEFT JOIN ".MAIN_DB_PREFIX."categorie_".$type." as cp ON ".$rowIdName." = cp.fk_".$type;
2000  }
2001 
2011  public static function getFilterSelectQuery($type, $rowIdName, $searchList)
2012  {
2013  if ($type == 'bank_account') {
2014  $type = 'account';
2015  }
2016  if ($type == 'customer') {
2017  $type = 'societe';
2018  }
2019  if ($type == 'supplier') {
2020  $type = 'fournisseur';
2021  }
2022 
2023  if (empty($searchList) && !is_array($searchList)) {
2024  return "";
2025  }
2026 
2027  $searchCategorySqlList = array();
2028  foreach ($searchList as $searchCategory) {
2029  if (intval($searchCategory) == -2) {
2030  $searchCategorySqlList[] = " cp.fk_categorie IS NULL";
2031  } elseif (intval($searchCategory) > 0) {
2032  $searchCategorySqlList[] = " ".$rowIdName." IN (SELECT fk_".$type." FROM ".MAIN_DB_PREFIX."categorie_".$type." WHERE fk_categorie = ".((int) $searchCategory).")";
2033  }
2034  }
2035 
2036  if (!empty($searchCategorySqlList)) {
2037  return " AND (".implode(' AND ', $searchCategorySqlList).")";
2038  } else {
2039  return "";
2040  }
2041  }
2042 
2048  public function countNbOfCategories()
2049  {
2050  dol_syslog(get_class($this)."::count_all_categories", LOG_DEBUG);
2051  $sql = "SELECT COUNT(rowid) FROM ".MAIN_DB_PREFIX."categorie";
2052  $sql .= " WHERE entity IN (".getEntity('category').")";
2053 
2054  $res = $this->db->query($sql);
2055  if ($res) {
2056  $obj = $this->db->fetch_object($res);
2057  return $obj->count;
2058  } else {
2059  dol_print_error($this->db);
2060  return -1;
2061  }
2062  }
2063 }
$object ref
Definition: info.php:78
Class to manage categories.
setMultiLangs($user)
Update ou cree les traductions des infos produits.
getListForItem($id, $type='customer', $sortfield="s.rowid", $sortorder='ASC', $limit=0, $page=0)
List categories of an element id.
get_image_size($file)
Load size of image file.
load_motherof()
Load the array this->motherof that is array(id_son=>id_parent, ...)
debug_cats()
Display content of $this->cats.
getLibStatut($mode)
Return label of contact status.
delete_photo($file)
Efface la photo de la categorie et sa vignette.
containing($id, $type, $mode='object')
Return list of categories (object instances or labels) linked to element of id $id and type $type Sho...
countNbOfCategories()
Count all categories.
del_type($obj, $type)
Delete object from category.
buildPathFromId($id_categ, $protection=1000)
For category id_categ and its childs available in this->cats, define property fullpath and fulllabel.
static getFilterSelectQuery($type, $rowIdName, $searchList)
Return the addtional SQL SELECT query for filtering a list by a category.
rechercher($id, $nom, $type, $exact=false, $case=false)
Returns categories whose id or name match add wildcards in the name unless $exact = true.
getMultiLangs()
Load array this->multilangs.
static replaceThirdparty(DoliDB $db, $origin_id, $dest_id)
Function used to replace a thirdparty id with another one.
already_exists()
Check if no category with same label already exists for this cat's parent or root and for this cat's ...
get_filles()
Return direct childs id of a category into an array.
initAsSpecimen()
Initialise an instance with random values.
get_all_categories($type=null, $parent=false)
Returns all categories.
static getFilterJoinQuery($type, $rowIdName)
Return the addtional SQL JOIN query for filtering a list by a category.
containsObject($type, $object_id)
Check for the presence of an object in a category.
get_main_categories($type=null)
Returns the top level categories (which are not child)
__construct($db)
Constructor.
getObjectsInCateg($type, $onlyids=0, $limit=0, $offset=0, $sortfield='', $sortorder='ASC')
Return list of fetched instance of elements having this category.
getMapList()
Get map list.
get_full_arbo($type, $markafterid=0, $include=0)
Rebuilding the category tree as an array Return an array of table('id','id_mere',....
get_meres()
Returns an array containing the list of parent categories.
add_type($obj, $type='')
Link an object to the category.
create($user)
Add category into database.
update(User $user)
Update category.
liste_photos($dir, $nbmax=0)
Return tableau de toutes les photos de la categorie.
get_all_ways()
Returns in a table all possible paths to get to the category starting with the major categories repre...
print_all_ways($sep='&gt;&gt;', $url='', $nocolor=0, $addpicto=0)
Returns the path of the category, with the names of the categories separated by $sep (" >> " by defau...
getNomUrl($withpicto=0, $option='', $maxlength=0, $moreparam='')
Return name and link of category (with picto) Use ->id, ->ref, ->label, ->color.
add_photo($sdir, $file)
Deplace fichier uploade sous le nom $file dans le repertoire sdir.
fetch($id, $label='', $type=null, $ref_ext='')
Load category into memory from database.
Parent class of all other business classes (invoices, contracts, proposals, orders,...
fetch_optionals($rowid=null, $optionsArray=null)
Function to get extra fields of an object into $this->array_options This method is in most cases call...
deleteExtraFields()
Delete all extra fields values for the current object.
addThumbs($file)
Build thumb.
static commonReplaceThirdparty(DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
Function used to replace a thirdparty id with another one.
insertExtraFields($trigger='', $userused=null)
Add/Update all extra fields values for the current object.
call_trigger($triggerName, $user)
Call trigger based on this instance.
Class to manage Dolibarr database access.
Class to manage Dolibarr users.
Definition: user.class.php:47
if(isModEnabled('facture') &&!empty($user->rights->facture->lire)) if((isModEnabled('fournisseur') &&empty($conf->global->MAIN_USE_NEW_SUPPLIERMOD) && $user->hasRight("fournisseur", "facture", "lire"))||(isModEnabled('supplier_invoice') && $user->hasRight("supplier_invoice", "lire"))) if(isModEnabled('don') &&!empty($user->rights->don->lire)) if(isModEnabled('tax') &&!empty($user->rights->tax->charges->lire)) if(isModEnabled('facture') &&isModEnabled('commande') && $user->hasRight("commande", "lire") &&empty($conf->global->WORKFLOW_DISABLE_CREATE_INVOICE_FROM_ORDER)) $resql
Social contributions to pay.
Definition: index.php:745
print *****$script_file(".$version.") pid cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
dol_delete_file($file, $disableglob=0, $nophperrors=0, $nohook=0, $object=null, $allowdotdot=false, $indexdatabase=1, $nolog=0)
Remove a file or several files with a mask.
Definition: files.lib.php:1251
dol_move_uploaded_file($src_file, $dest_file, $allowoverwrite, $disablevirusscan=0, $uploaderrorcode=0, $nohook=0, $varfiles='addedfile', $upload_dir='')
Make control on an uploaded file from an GUI page and move it to final destination.
Definition: files.lib.php:1112
dol_is_file($pathoffile)
Return if path is a file.
Definition: files.lib.php:481
dol_escape_htmltag($stringtoescape, $keepb=0, $keepn=0, $noescapetags='', $escapeonlyhtmltags=0)
Returns text escaped for inclusion in HTML alt or title tags, or into values of HTML input fields.
dol_print_error($db='', $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
img_object($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0)
Show a picto called object_picto (generic function)
dol_now($mode='auto')
Return date for now.
getDolGlobalInt($key, $default=0)
Return dolibarr global constant int value.
dol_sort_array(&$array, $index, $order='asc', $natsort=0, $case_sensitive=0, $keepindex=0)
Advanced sort array by second index function, which produces ascending (default) or descending output...
colorIsLight($stringcolor)
Return true if the color is light.
sanitizeVal($out='', $check='alphanohtml', $filter=null, $options=null)
Return a sanitized or empty value after checking value against a rule.
isModEnabled($module)
Is Dolibarr module enabled.
get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart='')
Return a path to have a the directory according to object where files are stored.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
getEntity($element, $shared=1, $currentobject=null)
Get list of entity id to use.
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
$nbtotalofrecords
Count total nb of records.
Definition: list.php:329
if(preg_match('/crypted:/i', $dolibarr_main_db_pass)||!empty($dolibarr_main_db_encrypted_pass)) $conf db type
Definition: repair.php:119
$conf db
API class for accounts.
Definition: inc.php:41