dolibarr 25.0.0-alpha
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-2025 Charlene Benke <charlene@patas-monkey.com>
13 * Copyright (C) 2018-2026 Frédéric France <frederic.france@free.fr>
14 * Copyright (C) 2022-2023 Solution Libre SAS <contact@solution-libre.fr>
15 * Copyright (C) 2023-2024 Benjamin Falière <benjamin.faliere@altairis.fr>
16 * Copyright (C) 2024-2026 MDW <mdeweerd@users.noreply.github.com>
17 * Copyright (C) 2025 Alexandre Spangaro <alexandre@inovea-conseil.com>
18 *
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation; either version 3 of the License, or
22 * (at your option) any later version.
23 *
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
28 *
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <https://www.gnu.org/licenses/>.
31 */
32
39require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
40require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
41require_once DOL_DOCUMENT_ROOT.'/ticket/class/ticket.class.php';
42require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.class.php';
43require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
44require_once DOL_DOCUMENT_ROOT.'/knowledgemanagement/class/knowledgerecord.class.php';
45
46
51{
52 // Categories types (we use string because we want to accept any modules/types in a future)
53 const TYPE_PRODUCT = 'product';
54 const TYPE_SUPPLIER = 'supplier';
55 const TYPE_CUSTOMER = 'customer';
56 const TYPE_MEMBER = 'member';
57 const TYPE_CONTACT = 'contact';
58 const TYPE_USER = 'user';
59 const TYPE_PROJECT = 'project';
60 const TYPE_ACCOUNT = 'bank_account';
61 const TYPE_BANK_LINE = 'bank_line';
62 const TYPE_WAREHOUSE = 'warehouse';
63 const TYPE_ACTIONCOMM = 'actioncomm';
64 const TYPE_WEBSITE_PAGE = 'website_page';
65 const TYPE_TICKET = 'ticket';
66 const TYPE_KNOWLEDGEMANAGEMENT = 'knowledgemanagement';
67 const TYPE_FICHINTER = 'fichinter';
68 const TYPE_ORDER = 'order';
69 const TYPE_INVOICE = 'invoice';
70 const TYPE_SUPPLIER_ORDER = 'supplier_order';
71 const TYPE_SUPPLIER_INVOICE = 'supplier_invoice';
72 const TYPE_SUPPLIER_PROPOSAL = 'supplier_proposal';
73 const TYPE_PROPOSAL = 'propal';
74 const TYPE_PROJECT_TASK = 'project_task';
75 const TYPE_MO = 'mo';
76
77
81 public $picto = 'category';
82
83
87 public $MAP_ID = array(
88 'product' => 0,
89 'service' => 0,
90 'supplier' => 1,
91 'customer' => 2,
92 'member' => 3,
93 'contact' => 4,
94 'bank_account' => 5,
95 'project' => 6,
96 'user' => 7,
97 'bank_line' => 8,
98 'warehouse' => 9,
99 'actioncomm' => 10,
100 'website_page' => 11,
101 'ticket' => 12,
102 'knowledgemanagement' => 13,
103 'fichinter' => 14,
104 'order' => 16,
105 'invoice' => 17,
106 'supplier_order' => 20,
107 'supplier_invoice' => 21,
108 'supplier_proposal' => 22,
109 'propal' => 23,
110 'project_task' => 24,
111 'mo' => 25,
112 );
113
119 /*
120 public static $MAP_ID_TO_CODE = array(
121 0 => 'product',
122 1 => 'supplier',
123 2 => 'customer',
124 3 => 'member',
125 4 => 'contact',
126 5 => 'bank_account',
127 6 => 'project',
128 7 => 'user',
129 8 => 'bank_line',
130 9 => 'warehouse',
131 10 => 'actioncomm',
132 11 => 'website_page',
133 12 => 'ticket',
134 13 => 'knowledgemanagement',
135 14 => 'fichinter',
136 16 => 'order',
137 17 => 'invoice',
138 20 => 'supplier_order',
139 21 => 'supplier_invoice',
140 22 => 'supplier_proposal',
141 23 => 'propal',
142 24 => 'project_task'
143 );
144 */
145
149 public $MAP_CAT_FK = array(
150 'customer' => 'soc',
151 'supplier' => 'soc',
152 'contact' => 'socpeople',
153 'bank_account' => 'account',
154 );
155
159 public $MAP_CAT_TABLE = array(
160 'customer' => 'societe',
161 'supplier' => 'fournisseur',
162 'bank_account' => 'account',
163 );
164
168 public $MAP_OBJ_CLASS = array(
169 'product' => 'Product',
170 'service' => 'Product',
171 'customer' => 'Societe',
172 'supplier' => 'Fournisseur',
173 'member' => 'Adherent',
174 'contact' => 'Contact',
175 'user' => 'User',
176 'account' => 'Account', // old for bank account
177 'bank_account' => 'Account',
178 'project' => 'Project',
179 'warehouse' => 'Entrepot',
180 'actioncomm' => 'ActionComm',
181 'website_page' => 'WebsitePage',
182 'ticket' => 'Ticket',
183 'knowledgemanagement' => 'KnowledgeRecord',
184 'fichinter' => 'Fichinter',
185 'order' => 'Commande',
186 'invoice' => 'Facture',
187 'supplier_order' => 'CommandeFournisseur',
188 'supplier_invoice' => 'FactureFournisseur',
189 'supplier_proposal' => 'SupplierProposal',
190 'propal' => 'Propal',
191 'project_task' => 'Task',
192 'mo' => 'Mo',
193 );
194
198 public static $MAP_TYPE_TITLE_AREA = array(
199 'product' => 'Products',
200 'service' => 'Services',
201 'customer' => 'ProspectsOrCustomers',
202 'supplier' => 'Suppliers',
203 'member' => 'Members',
204 'contact' => 'Contacts',
205 'user' => 'Users',
206 'account' => 'Accounts', // old for bank account
207 'bank_account' => 'BankAccounts',
208 'bank_line' => 'BankTransactions',
209 'project' => 'Projects',
210 'warehouse' => 'Warehouse',
211 'actioncomm' => 'AgendaEvents',
212 'website_page' => 'WebsitePages',
213 'ticket' => 'Tickets',
214 'knowledgemanagement' => 'KnowledgeRecords',
215 'fichinter' => 'Interventions',
216 'order' => 'Orders',
217 'invoice' => 'Invoices',
218 'supplier_order' => 'SuppliersOrders',
219 'supplier_invoice' => 'SuppliersInvoices',
220 'propal' => 'Proposals',
221 'supplier_proposal' => 'SupplierProposals',
222 'project_task' => 'Tasks',
223 'mo' => 'MOs'
224 );
225
230 public $MAP_OBJ_TABLE = array(
231 'customer' => 'societe',
232 'supplier' => 'societe',
233 'member' => 'adherent',
234 'contact' => 'socpeople',
235 'account' => 'bank_account', // old for bank account
236 'project' => 'projet',
237 'warehouse' => 'entrepot',
238 'knowledgemanagement' => 'knowledgemanagement_knowledgerecord',
239 'fichinter' => 'fichinter',
240 'order' => 'commande',
241 'invoice' => 'facture',
242 'supplier_order' => 'commande_fournisseur',
243 'supplier_invoice' => 'facture_fourn',
244 'project_task' => 'projet_task',
245 'mo' => 'mrp_mo'
246 );
247
251 public $element = 'category';
252
256 public $table_element = 'categorie';
257
261 public $fk_parent;
262
266 public $label;
267
271 public $description;
272
276 public $color;
277
281 public $position;
282
286 public $visible;
287
291 public $socid;
292
316 public $type;
317
321 public $cats = array();
322
326 public $motherof = array();
327
331 public $childs = array();
332
336 public $multilangs = array();
337
341 public $imgWidth;
342
346 public $imgHeight;
347
372 public $fields = array(
373 'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'position' => 10, 'notnull' => 1, 'visible' => 0,),
374 'entity' => array('type' => 'integer', 'label' => 'Entity', 'enabled' => 1, 'visible' => 0, 'default' => '1', 'notnull' => 1, 'index' => 1, 'position' => 5),
375 'fk_parent' => array('type' => 'integer', 'label' => 'ParentCategory', 'enabled' => 1, 'position' => 20, 'notnull' => 1, 'visible' => 0, 'css' => 'maxwidth500 widthcentpercentminusxx',),
376 'label' => array('type' => 'varchar(180)', 'label' => 'Ref', 'enabled' => 1, 'position' => 25, 'notnull' => 1, 'visible' => 1, 'alwayseditable' => 1, 'css' => 'minwidth300', 'cssview' => 'wordbreak', 'csslist' => 'tdoverflowmax150', 'showoncombobox' => 1),
377 'ref_ext' => array('type' => 'varchar(255)', 'label' => 'RefExt', 'enabled' => 1, 'position' => 30, 'notnull' => 0, 'visible' => 0, 'alwayseditable' => 1,),
378 'type' => array('type' => 'integer', 'label' => 'Type', 'enabled' => 1, 'position' => 35, 'notnull' => 1, 'visible' => 0, 'alwayseditable' => 1,),
379 'description' => array('type' => 'text', 'label' => 'Description', 'enabled' => 1, 'position' => 40, 'notnull' => 0, 'visible' => 1, 'alwayseditable' => 1,),
380 'color' => array('type' => 'varchar(8)', 'label' => 'Color', 'enabled' => 1, 'position' => 45, 'notnull' => 0, 'visible' => 1, 'alwayseditable' => 1,),
381 'position' => array('type' => 'integer', 'label' => 'Position', 'enabled' => 1, 'position' => 50, 'notnull' => 0, 'visible' => -1, 'alwayseditable' => 1,),
382 'fk_soc' => array('type' => 'integer:Societe:societe/class/societe.class.php', 'label' => 'ThirdParty', 'picto' => 'company', 'enabled' => 1, 'position' => 55, 'notnull' => 0, 'visible' => 0, 'alwayseditable' => 1, 'css' => 'maxwidth500 widthcentpercentminusxx', 'csslist' => 'tdoverflowmax150',),
383 'visible' => array('type' => 'integer', 'label' => 'Visible', 'enabled' => 1, 'position' => 60, 'notnull' => 1, 'visible' => 0, 'alwayseditable' => 1,),
384 'import_key' => array('type' => 'varchar(14)', 'label' => 'ImportId', 'enabled' => 1, 'position' => 900, 'notnull' => 0, 'visible' => -2, 'alwayseditable' => 1,),
385 'date_creation' => array('type' => 'datetime', 'label' => 'DateCreation', 'enabled' => 1, 'position' => 70, 'notnull' => 0, 'visible' => -1, 'alwayseditable' => 1,),
386 'tms' => array('type' => 'timestamp', 'label' => 'DateModification', 'enabled' => 1, 'position' => 75, 'notnull' => 1, 'visible' => -1, 'alwayseditable' => 1,),
387 'fk_user_creat' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserAuthor', 'enabled' => 1, 'position' => 80, 'notnull' => 0, 'visible' => -2, 'alwayseditable' => 1, 'css' => 'maxwidth500 widthcentpercentminusxx', 'csslist' => 'tdoverflowmax150',),
388 'fk_user_modif' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserModif', 'enabled' => 1, 'position' => 85, 'notnull' => -1, 'visible' => -2, 'alwayseditable' => 1, 'css' => 'maxwidth500 widthcentpercentminusxx', 'csslist' => 'tdoverflowmax150',),
389 );
390
396 public function __construct($db)
397 {
398 global $hookmanager;
399
400 $this->db = $db;
401
402 $this->ismultientitymanaged = 1;
403 $this->isextrafieldmanaged = 1;
404
405 if (is_object($hookmanager)) {
406 $hookmanager->initHooks(array('category'));
407 $parameters = array();
408 $reshook = $hookmanager->executeHooks('constructCategory', $parameters, $this); // Note that $action and $object may have been modified by some hooks
409 if ($reshook >= 0 && !empty($hookmanager->resArray)) {
410 foreach ($hookmanager->resArray as $mapList) {
412 $mapId = $mapList['id'];
413 $mapCode = $mapList['code'];
414 //self::$MAP_ID_TO_CODE[$mapId] = $mapCode;
415 $this->MAP_ID[$mapCode] = $mapId;
416 $this->MAP_CAT_FK[$mapCode] = isset($mapList['cat_fk']) ? $mapList['cat_fk'] : null; // @phan-suppress-current-line SqlInjection
417 $this->MAP_CAT_TABLE[$mapCode] = isset($mapList['cat_table']) ? $mapList['cat_table'] : null; // @phan-suppress-current-line SqlInjection
418 $this->MAP_OBJ_CLASS[$mapCode] = $mapList['obj_class']; // @phan-suppress-current-line SqlInjection
419 $this->MAP_OBJ_TABLE[$mapCode] = $mapList['obj_table']; // @phan-suppress-current-line SqlInjection
420 self::$MAP_TYPE_TITLE_AREA[$mapCode] = isset($mapList['label']) ? $mapList['label'] : null;
421 }
422 }
423 }
424 }
425
431 public function getMapList()
432 {
433 $mapList = array();
434
435 foreach ($this->MAP_ID as $mapCode => $mapId) {
436 $mapList[] = array(
437 'id' => $mapId,
438 'code' => $mapCode,
439 'cat_fk' => (empty($this->MAP_CAT_FK[$mapCode]) ? $mapCode : $this->MAP_CAT_FK[$mapCode]),
440 'cat_table' => (empty($this->MAP_CAT_TABLE[$mapCode]) ? $mapCode : $this->MAP_CAT_TABLE[$mapCode]),
441 'obj_class' => (empty($this->MAP_OBJ_CLASS[$mapCode]) ? $mapCode : $this->MAP_OBJ_CLASS[$mapCode]),
442 'obj_table' => (empty($this->MAP_OBJ_TABLE[$mapCode]) ? $mapCode : $this->MAP_OBJ_TABLE[$mapCode]),
443 );
444 }
445
446 return $mapList;
447 }
448
454 public function getMapId()
455 {
456 return $this->MAP_ID;
457 }
458
468 public function fetch($id, $label = '', $type = null, $ref_ext = '')
469 {
470 // Check parameters
471 if (empty($id) && empty($label) && empty($ref_ext)) {
472 $this->error = "No category to search for";
473 return -1;
474 }
475 if (!is_null($type) && !is_numeric($type)) {
476 $type = $this->MAP_ID[$type];
477 }
478
479 $sql = "SELECT rowid, fk_parent, entity, label, description, color, position, fk_soc, visible, type, ref_ext";
480 $sql .= ", date_creation, tms, fk_user_creat, fk_user_modif, import_key";
481 $sql .= " FROM ".MAIN_DB_PREFIX."categorie";
482 if ($id) {
483 $sql .= " WHERE rowid = ".((int) $id);
484 } elseif (!empty($ref_ext)) {
485 $sql .= " WHERE ref_ext LIKE '".$this->db->escape($ref_ext)."'";
486 } else {
487 $sql .= " WHERE label = '".$this->db->escape($label)."' AND entity IN (".getEntity('category').")";
488 if (!is_null($type)) {
489 $sql .= " AND type = ".((int) $type);
490 }
491 }
492
493 dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
494 $resql = $this->db->query($sql);
495 if ($resql) {
496 if ($this->db->num_rows($resql) > 0 && $res = $this->db->fetch_array($resql)) {
497 $this->id = $res['rowid'];
498 //$this->ref = $res['rowid'];
499 $this->fk_parent = (int) $res['fk_parent'];
500 $this->label = $res['label'];
501 $this->description = $res['description'];
502 $this->color = $res['color'];
503 $this->position = $res['position'];
504 $this->socid = (int) $res['fk_soc'];
505 $this->visible = (int) $res['visible'];
506 $this->type = $res['type'];
507 $this->ref_ext = $res['ref_ext'];
508 $this->entity = (int) $res['entity'];
509 $this->date_creation = $this->db->jdate($res['date_creation']);
510 $this->date_modification = $this->db->jdate($res['tms']);
511 $this->user_creation_id = (int) $res['fk_user_creat'];
512 $this->user_modification_id = (int) $res['fk_user_modif'];
513 $this->import_key = $res['import_key'];
514
515 // Retrieve all extrafields
516 // fetch optionals attributes and labels
517 $this->fetch_optionals();
518
519 $this->db->free($resql);
520
521 // multilangs
522 if (getDolGlobalInt('MAIN_MULTILANGS')) {
523 $this->getMultiLangs();
524 }
525
526 return 1;
527 } else {
528 $this->error = "No category found";
529 return 0;
530 }
531 } else {
532 dol_print_error($this->db);
533 $this->error = $this->db->lasterror;
534 $this->errors[] = $this->db->lasterror;
535 return -1;
536 }
537 }
538
549 public function create($user, $notrigger = 0)
550 {
551 global $conf, $langs;
552 $langs->load('categories');
553
554 $type = $this->type;
555
556 if (!is_numeric($type)) {
557 $type = $this->MAP_ID[$type];
558 }
559
560 $error = 0;
561
562 dol_syslog(get_class($this).'::create', LOG_DEBUG);
563
564 // Clean parameters
565 $this->label = trim($this->label);
566 $this->description = trim($this->description);
567 $this->color = trim($this->color);
568 $this->position = (int) $this->position;
569 if (isset($this->import_key)) {
570 $this->import_key = trim($this->import_key);
571 }
572 $this->ref_ext = trim($this->ref_ext);
573 if (empty($this->visible)) {
574 $this->visible = 0;
575 }
576 $this->fk_parent = ($this->fk_parent != "" ? intval($this->fk_parent) : 0);
577
578 if ($this->already_exists()) {
579 $this->error = $langs->trans("ImpossibleAddCat", $this->label);
580 $this->error .= " : ".$langs->trans("CategoryExistsAtSameLevel");
581 dol_syslog($this->error, LOG_WARNING);
582 return -4;
583 }
584
585 $this->db->begin();
586 $now = dol_now();
587 $sql = "INSERT INTO ".MAIN_DB_PREFIX."categorie (";
588 $sql .= "fk_parent,";
589 $sql .= " label,";
590 $sql .= " description,";
591 $sql .= " color,";
592 $sql .= " position,";
593 if (getDolGlobalString('CATEGORY_ASSIGNED_TO_A_CUSTOMER')) {
594 $sql .= "fk_soc,";
595 }
596 $sql .= " visible,";
597 $sql .= " type,";
598 $sql .= " import_key,";
599 $sql .= " ref_ext,";
600 $sql .= " entity,";
601 $sql .= " date_creation,";
602 $sql .= " fk_user_creat";
603 $sql .= ") VALUES (";
604 $sql .= (int) $this->fk_parent.",";
605 $sql .= "'".$this->db->escape($this->label)."', ";
606 $sql .= "'".$this->db->escape($this->description)."', ";
607 $sql .= "'".$this->db->escape($this->color)."', ";
608 $sql .= (int) $this->position.",";
609 if (getDolGlobalString('CATEGORY_ASSIGNED_TO_A_CUSTOMER')) {
610 $sql .= ($this->socid > 0 ? ((int) $this->socid) : 'null').", ";
611 }
612 $sql .= "'".$this->db->escape((string) $this->visible)."', ";
613 $sql .= ((int) $type).", ";
614 $sql .= (!empty($this->import_key) ? "'".$this->db->escape($this->import_key)."'" : 'null').", ";
615 $sql .= (!empty($this->ref_ext) ? "'".$this->db->escape($this->ref_ext)."'" : 'null').", ";
616 $sql .= (int) $conf->entity.", ";
617 $sql .= "'".$this->db->idate($now)."', ";
618 $sql .= (int) $user->id;
619 $sql .= ")";
620
621 $res = $this->db->query($sql);
622 if ($res) {
623 $id = $this->db->last_insert_id(MAIN_DB_PREFIX."categorie");
624
625 if ($id > 0) {
626 $this->id = $id;
627
628 $action = 'create';
629
630 // Actions on extra fields
631 $result = $this->insertExtraFields();
632 if ($result < 0) {
633 $error++;
634 }
635
636 if (!$error && !$notrigger) {
637 // Call trigger
638 $result = $this->call_trigger('CATEGORY_CREATE', $user);
639 if ($result < 0) {
640 $error++;
641 }
642 // End call triggers
643 }
644
645 if (!$error) {
646 $this->db->commit();
647 return $id;
648 } else {
649 $this->db->rollback();
650 return -3;
651 }
652 } else {
653 $this->db->rollback();
654 return -2;
655 }
656 } else {
657 $this->error = $this->db->error();
658 $this->db->rollback();
659 return -1;
660 }
661 }
662
672 public function update(User $user, $notrigger = 0)
673 {
674 global $langs;
675
676 $error = 0;
677
678 // Clean parameters
679 $this->label = trim($this->label);
680 $this->description = trim($this->description);
681 $this->ref_ext = trim($this->ref_ext);
682 $this->fk_parent = ($this->fk_parent != "" ? intval($this->fk_parent) : 0);
683 $this->visible = ($this->visible != "" ? intval($this->visible) : 0);
684
685 if ($this->fk_parent > 0 && $this->fk_parent == $this->id) {
686 $langs->load('categories');
687 $this->error = $langs->trans("ErrorCategoryCannotBeItsOwnParent");
688 dol_syslog($this->error, LOG_WARNING);
689 return -1;
690 }
691
692 if ($this->already_exists()) {
693 $this->error = $langs->trans("ImpossibleUpdateCat");
694 $this->error .= " : ".$langs->trans("CategoryExistsAtSameLevel");
695 return -1;
696 }
697
698 $this->db->begin();
699
700 $sql = "UPDATE ".MAIN_DB_PREFIX."categorie";
701 $sql .= " SET label = '".$this->db->escape($this->label)."',";
702 $sql .= " description = '".$this->db->escape($this->description)."',";
703 $sql .= " ref_ext = '".$this->db->escape($this->ref_ext)."',";
704 $sql .= " color = '".$this->db->escape($this->color)."'";
705 $sql .= ", position = ".(int) $this->position;
706 if (getDolGlobalString('CATEGORY_ASSIGNED_TO_A_CUSTOMER')) {
707 $sql .= ", fk_soc = ".($this->socid > 0 ? ((int) $this->socid) : 'null');
708 }
709 $sql .= ", visible = ".(int) $this->visible;
710 $sql .= ", fk_parent = ".(int) $this->fk_parent;
711 $sql .= ", fk_user_modif = ".(int) $user->id;
712 $sql .= " WHERE rowid = ".((int) $this->id);
713
714 dol_syslog(get_class($this)."::update", LOG_DEBUG);
715 if ($this->db->query($sql)) {
716 // Multilangs
717 if (getDolGlobalInt('MAIN_MULTILANGS')) {
718 if ($this->setMultiLangs($user, $notrigger) < 0) {
719 $this->db->rollback();
720 return -2;
721 }
722 }
723
724 $action = 'update';
725
726 // Actions on extra fields
727 $result = $this->insertExtraFields();
728 if ($result < 0) {
729 $error++;
730 }
731
732 if (!$error && !$notrigger) {
733 // Call trigger
734 $result = $this->call_trigger('CATEGORY_MODIFY', $user);
735 if ($result < 0) {
736 $error++;
737 }
738 // End call triggers
739 }
740
741 if (!$error) {
742 $this->db->commit();
743 return 1;
744 } else {
745 $this->db->rollback();
746 return -1;
747 }
748 } else {
749 $this->db->rollback();
750 dol_print_error($this->db);
751 return -1;
752 }
753 }
754
762 public function delete($user, $notrigger = 0)
763 {
764 $error = 0;
765
766 // Clean parameters
767 $this->fk_parent = ($this->fk_parent != "" ? intval($this->fk_parent) : 0);
768
769 dol_syslog(get_class($this)."::remove");
770
771 $this->db->begin();
772
773 if (/* !$error && */ !$notrigger) {
774 // Call trigger
775 $result = $this->call_trigger('CATEGORY_DELETE', $user);
776 if ($result < 0) {
777 $error++;
778 }
779 // End call triggers
780 }
781
782 /* FIX #1317 : Check for child category and move up 1 level*/
783 if (!$error) {
784 $sql = "UPDATE ".MAIN_DB_PREFIX."categorie";
785 $sql .= " SET fk_parent = ".((int) $this->fk_parent);
786 $sql .= " WHERE fk_parent = ".((int) $this->id);
787
788 if (!$this->db->query($sql)) {
789 $this->error = $this->db->lasterror();
790 $error++;
791 }
792 }
793
794 $arraydelete = array(
795 'categorie_account' => 'fk_categorie',
796 'categorie_actioncomm' => 'fk_categorie',
797 'categorie_contact' => 'fk_categorie',
798 'categorie_fournisseur' => 'fk_categorie',
799 'categorie_knowledgemanagement' => array('field' => 'fk_categorie', 'enabled' => isModEnabled('knowledgemanagement')),
800 'categorie_fichinter' => array('field' => 'fk_categorie', 'enabled' => false ), // not yet fully implemented (wait 22) isModEnabled('intervention')),
801 'categorie_member' => 'fk_categorie',
802 'categorie_user' => 'fk_categorie',
803 'categorie_product' => 'fk_categorie',
804 'categorie_project' => 'fk_categorie',
805 'categorie_project_task' => array('field' => 'fk_categorie', 'enabled' => isModEnabled('project')),
806 'categorie_societe' => 'fk_categorie',
807 'categorie_ticket' => array('field' => 'fk_categorie', 'enabled' => isModEnabled('ticket')),
808 'categorie_warehouse' => array('field' => 'fk_categorie', 'enabled' => isModEnabled('stock')),
809 'categorie_website_page' => array('field' => 'fk_categorie', 'enabled' => isModEnabled('website')),
810 'category_bankline' => 'fk_categ',
811 'categorie_lang' => 'fk_category',
812 'categorie' => 'rowid',
813 );
814 foreach ($arraydelete as $key => $value) {
815 $sanitizedvalue = $value;
816 if (is_array($value)) {
817 if (empty($value['enabled'])) {
818 continue;
819 }
820 $sanitizedvalue = $value['field']; // From explicit array above @phan-suppress-current-line SqlInjection
821 }
822
823 $sql = "DELETE FROM ".$this->db->sanitize(MAIN_DB_PREFIX.$key);
824 $sql .= " WHERE ".$this->db->sanitize($sanitizedvalue)." = ".((int) $this->id);
825 if (!$this->db->query($sql)) {
826 $this->errors[] = $this->db->lasterror();
827 dol_syslog("Error sql=".$sql." ".$this->error, LOG_ERR);
828 $error++;
829 }
830 }
831
832 // Removed extrafields
833 if (!$error) {
834 $result = $this->deleteExtraFields();
835 if ($result < 0) {
836 $error++;
837 dol_syslog(get_class($this)."::delete erreur ".$this->error, LOG_ERR);
838 }
839 }
840
841 if (!$error) {
842 $this->db->commit();
843 return 1;
844 } else {
845 $this->db->rollback();
846 return -1;
847 }
848 }
849
850 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
859 public function add_type($obj, $type = '')
860 {
861 // phpcs:enable
862 global $user;
863
864 $error = 0;
865
866 if ($this->id == -1) {
867 return -2;
868 }
869
870 if (empty($type)) {
871 $type = $obj->element;
872 }
873
874 dol_syslog(get_class($this).'::add_type', LOG_DEBUG);
875
876 $this->db->begin();
877
878 $sql = "INSERT INTO ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type]);
879 $sql .= " (fk_categorie, fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type]).")";
880 $sql .= " VALUES (".((int) $this->id).", ".((int) $obj->id).")";
881
882 if ($this->db->query($sql)) {
883 if (getDolGlobalString('CATEGORIE_RECURSIV_ADD')) {
884 $sql = 'SELECT fk_parent FROM '.MAIN_DB_PREFIX.'categorie';
885 $sql .= " WHERE rowid = ".((int) $this->id);
886
887 dol_syslog(get_class($this)."::add_type", LOG_DEBUG);
888 $resql = $this->db->query($sql);
889 if ($resql) {
890 if ($this->db->num_rows($resql) > 0) {
891 $objparent = $this->db->fetch_object($resql);
892
893 if (!empty($objparent->fk_parent)) {
894 $cat = new Categorie($this->db);
895 $cat->id = $objparent->fk_parent;
896 if (!$cat->containsObject($type, $obj->id)) {
897 $result = $cat->add_type($obj, $type);
898 if ($result < 0) {
899 $this->error = $cat->error;
900 $error++;
901 }
902 }
903 }
904 }
905 } else {
906 $error++;
907 $this->error = $this->db->lasterror();
908 }
909
910 if ($error) {
911 $this->db->rollback();
912 return -1;
913 }
914 }
915
916 // Call trigger
917 $this->context = array('linkto' => $obj); // Save object we want to link category to into category instance to provide information to trigger
918 $result = $this->call_trigger('CATEGORY_MODIFY', $user);
919 if ($result < 0) {
920 $error++;
921 }
922 // End call triggers
923
924 if (!$error) {
925 $this->db->commit();
926 return 1;
927 } else {
928 $this->db->rollback();
929 return -2;
930 }
931 } else {
932 $this->db->rollback();
933 if ($this->db->lasterrno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') {
934 $this->error = $this->db->lasterrno();
935 return -3;
936 } else {
937 $this->error = $this->db->lasterror();
938 }
939 return -1;
940 }
941 }
942
943 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
952 public function del_type($obj, $type)
953 {
954 // phpcs:enable
955 global $user;
956
957 $error = 0;
958
959 // For backward compatibility
960 if ($type == 'societe') {
961 $type = 'customer';
962 dol_syslog(get_class($this)."::del_type(): type 'societe' is deprecated, please use 'customer' instead", LOG_WARNING);
963 } elseif ($type == 'fournisseur') {
964 $type = 'supplier';
965 dol_syslog(get_class($this)."::del_type(): type 'fournisseur' is deprecated, please use 'supplier' instead", LOG_WARNING);
966 }
967
968 $this->db->begin();
969
970 $sql = "DELETE FROM ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type]);
971 $sql .= " WHERE fk_categorie = ".((int) $this->id);
972 $sql .= " AND fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = ".((int) $obj->id);
973
974 dol_syslog(get_class($this).'::del_type', LOG_DEBUG);
975 if ($this->db->query($sql)) {
976 // Call trigger
977 $this->context = array('unlinkoff' => $obj); // Save object we want to link category to into category instance to provide information to trigger
978 $result = $this->call_trigger('CATEGORY_MODIFY', $user);
979 if ($result < 0) {
980 $error++;
981 }
982 // End call triggers
983
984 if (!$error) {
985 $this->db->commit();
986 return 1;
987 } else {
988 $this->db->rollback();
989 return -2;
990 }
991 } else {
992 $this->db->rollback();
993 $this->error = $this->db->lasterror();
994 return -1;
995 }
996 }
997
1016 public function getObjectsInCateg($type, $onlyids = 0, $limit = 0, $offset = 0, $sortfield = '', $sortorder = 'ASC', $filter = '', $filtermode = 'AND', $filterlang = '')
1017 {
1018 global $user;
1019
1020 if (empty($onlyids)) {
1021 dol_syslog("getObjectsInCateg: This method used with parameter onlyids=0 is deprecated. Try by using instead getListForItem().", LOG_WARNING);
1022 }
1023
1024 $objs = array();
1025
1026 $classnameforobj = $this->MAP_OBJ_CLASS[$type];
1027 if (!empty($classnameforobj) && class_exists($classnameforobj)) {
1028 $tmpobj = new $classnameforobj($this->db);
1031 $sql = "SELECT c.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." as fk_object";
1032 $sql .= " FROM ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type])." as c";
1033 $sql .= ", ".MAIN_DB_PREFIX.(empty($this->MAP_OBJ_TABLE[$type]) ? $type : $this->MAP_OBJ_TABLE[$type])." as o";
1034 if (!empty($filterlang)) {
1035 $sql .= ", ".MAIN_DB_PREFIX.(empty($this->MAP_OBJ_TABLE[$type]) ? $type : $this->MAP_OBJ_TABLE[$type])."_lang as ol";
1036 }
1037 $sql .= " WHERE o.entity IN (".getEntity($tmpobj->element).")";
1038 $sql .= " AND c.fk_categorie = ".((int) $this->id);
1039 // Compatibility with actioncomm table which has id instead of rowid
1040 if ((array_key_exists($type, $this->MAP_OBJ_TABLE) && $this->MAP_OBJ_TABLE[$type] == "actioncomm") || $type == "actioncomm") {
1041 $sql .= " AND c.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = o.id";
1042 } else {
1043 $sql .= " AND c.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = o.rowid";
1044 }
1045 if (!empty($filterlang)) {
1046 $sql .= " AND ol.fk_".(empty($this->MAP_OBJ_TABLE[$type]) ? $type : $this->MAP_OBJ_TABLE[$type])." = o.rowid";
1047 $sql .= " AND ol.lang = '".$this->db->escape($filterlang)."'";
1048 }
1049 // Protection for external users
1050 if (($type == 'customer' || $type == 'supplier') && $user->socid > 0) {
1051 $sql .= " AND o.rowid = ".((int) $user->socid);
1052 }
1053
1054 // Add where from hooks (for example to restrict to objects an external module shares
1055 // with the current entity by a granularity finer than this category's own)
1056 global $hookmanager;
1057 if (is_object($hookmanager)) {
1058 $parameters = array('type' => $type, 'alias' => 'o');
1059 $reshook = $hookmanager->executeHooks('printFieldListWhere', $parameters, $this);
1060 $sql .= $hookmanager->resPrint;
1061 }
1062
1063 $errormessage = '';
1064 $sql .= forgeSQLFromUniversalSearchCriteria($filter, $errormessage);
1065 if ($errormessage) {
1066 $this->errors[] = $errormessage;
1067 dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
1068 return -1;
1069 }
1070
1071 $sql .= $this->db->order($sortfield, $sortorder);
1072 if ($limit > 0 || $offset > 0) {
1073 $sql .= $this->db->plimit($limit + 1, $offset);
1074 }
1075
1076 dol_syslog(get_class($this)."::getObjectsInCateg", LOG_DEBUG);
1077
1078 $resql = $this->db->query($sql);
1079 if ($resql) {
1080 while ($rec = $this->db->fetch_array($resql)) {
1081 if ($onlyids) {
1082 $objs[] = $rec['fk_object'];
1083 } else {
1084 $tmpobj = new $classnameforobj($this->db);
1085 $tmpobj->fetch($rec['fk_object']); // The fetch will set $tmpobj->id only if it succeed.
1086 // @phpstan-ignore-next-line
1087 if ($tmpobj->id > 0) { // Failing fetch may happen for example when a category supplier was set and third party was moved as customer only. The object supplier can't be loaded.
1088 $objs[] = $tmpobj;
1089 }
1090 }
1091 }
1092 } else {
1093 $this->error = $this->db->error().' sql='.$sql;
1094 return -1;
1095 }
1096 }
1097
1098 return $objs;
1099 }
1100
1109 public function containsObject($type, $object_id)
1110 {
1111 $sql = "SELECT COUNT(*) as nb FROM ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type]);
1112 $sql .= " WHERE fk_categorie = ".((int) $this->id)." AND fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = ".((int) $object_id);
1113
1114 dol_syslog(get_class($this)."::containsObject", LOG_DEBUG);
1115
1116 $resql = $this->db->query($sql);
1117 if ($resql) {
1118 return $this->db->fetch_object($resql)->nb;
1119 } else {
1120 $this->error = $this->db->error();
1121 return -1;
1122 }
1123 }
1124
1137 public function getListForItem($id, $type = 'customer', $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0)
1138 {
1139 $categories = array();
1140
1141 $type = sanitizeVal($type, 'aZ09');
1142
1143 $sub_type = $type;
1144 $subcol_name = "fk_".$type;
1145 if ($type == "customer") {
1146 $sub_type = "societe";
1147 $subcol_name = "fk_soc";
1148 }
1149 if ($type == "supplier") {
1150 $sub_type = "fournisseur";
1151 $subcol_name = "fk_soc";
1152 }
1153 if ($type == "contact") {
1154 $subcol_name = "fk_socpeople";
1155 }
1156
1157 $idoftype = (int) (array_key_exists($type, $this->MAP_ID) ? $this->MAP_ID[$type] : -1);
1158
1159 $sql = "SELECT s.rowid";
1160 $sqlfields = $sql; // $sql fields to remove for count total
1161 $sql .= " FROM ".MAIN_DB_PREFIX."categorie as s, ".MAIN_DB_PREFIX."categorie_".$this->db->sanitize($sub_type)." as sub";
1162 $sql .= ' WHERE s.entity IN ('.getEntity('category').')';
1163 $sql .= ' AND s.type = '.((int) $idoftype);
1164 $sql .= ' AND s.rowid = sub.fk_categorie';
1165 $sql .= " AND sub.".$this->db->sanitize($subcol_name)." = ".((int) $id);
1166
1167 $offset = 0;
1168 $nbtotalofrecords = '';
1169 if (!getDolGlobalInt('MAIN_DISABLE_FULL_SCANLIST')) {
1170 $sqlforcount = preg_replace('/^'.preg_quote($sqlfields, '/').'/', 'SELECT COUNT(*) as nbtotalofrecords', $sql);
1171 $sqlforcount = preg_replace('/GROUP BY .*$/', '', $sqlforcount);
1172
1173 $resql = $this->db->query($sqlforcount);
1174 if ($resql) {
1175 $objforcount = $this->db->fetch_object($resql);
1176 $nbtotalofrecords = $objforcount->nbtotalofrecords;
1177 } else {
1178 dol_print_error($this->db);
1179 }
1180
1181 if (($limit >= (int) $nbtotalofrecords) && $page > 0) {
1182 return [];
1183 }
1184
1185 if (($page * $limit) >= (int) $nbtotalofrecords) { // if total resultset is smaller or equal then paging size (filtering), goto and load page 0
1186 $page = 0;
1187 $offset = 0;
1188 }
1189 $this->db->free($resql);
1190 }
1191
1192 $sql .= $this->db->order($sortfield, $sortorder);
1193 if ($limit) {
1194 if ($page < 0) {
1195 $page = 0;
1196 }
1197 $offset = $limit * $page;
1198
1199 $sql .= $this->db->plimit($limit + 1, $offset);
1200 }
1201
1202 $result = $this->db->query($sql);
1203 if ($result) {
1204 $i = 0;
1205 $num = $this->db->num_rows($result);
1206 $min = min($num, ($limit <= 0 ? $num : $limit));
1207 while ($i < $min) {
1208 $obj = $this->db->fetch_object($result);
1209 $category_static = new Categorie($this->db);
1210 if ($category_static->fetch($obj->rowid)) {
1211 $categories[$i]['id'] = $category_static->id;
1212 $categories[$i]['fk_parent'] = $category_static->fk_parent;
1213 $categories[$i]['label'] = $category_static->label;
1214 $categories[$i]['description'] = $category_static->description;
1215 $categories[$i]['color'] = $category_static->color;
1216 $categories[$i]['position'] = $category_static->position;
1217 $categories[$i]['socid'] = $category_static->socid;
1218 $categories[$i]['ref_ext'] = $category_static->ref_ext;
1219 $categories[$i]['visible'] = $category_static->visible;
1220 $categories[$i]['type'] = $category_static->type;
1221 $categories[$i]['entity'] = $category_static->entity;
1222 $categories[$i]['array_options'] = $category_static->array_options;
1223
1224 // multilangs
1225 if (getDolGlobalInt('MAIN_MULTILANGS') && isset($category_static->multilangs)) {
1226 $categories[$i]['multilangs'] = $category_static->multilangs;
1227 }
1228 }
1229 $i++;
1230 }
1231 } else {
1232 $this->error = $this->db->lasterror();
1233 return -1;
1234 }
1235 if (!count($categories)) {
1236 return [];
1237 }
1238
1239 return $categories;
1240 }
1241
1242 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1248 public function get_filles()
1249 {
1250 // phpcs:enable
1251 $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."categorie";
1252 $sql .= " WHERE fk_parent = ".((int) $this->id);
1253 $sql .= " AND entity IN (".getEntity('category').")";
1254
1255 $res = $this->db->query($sql);
1256 if ($res) {
1257 $cats = array();
1258 while ($rec = $this->db->fetch_array($res)) {
1259 $cat = new Categorie($this->db);
1260 $cat->fetch($rec['rowid']);
1261 $cats[] = $cat;
1262 }
1263 return $cats;
1264 } else {
1265 dol_print_error($this->db);
1266 return -1;
1267 }
1268 }
1269
1270 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1277 protected function load_motherof()
1278 {
1279 // phpcs:enable
1280 $this->motherof = array();
1281
1282 // Load array[child]=parent
1283 $sql = "SELECT fk_parent as id_parent, rowid as id_son";
1284 $sql .= " FROM ".MAIN_DB_PREFIX."categorie";
1285 $sql .= " WHERE fk_parent <> 0";
1286 $sql .= " AND entity IN (".getEntity('category').")";
1287
1288 dol_syslog(get_class($this)."::load_motherof", LOG_DEBUG);
1289 $resql = $this->db->query($sql);
1290 if ($resql) {
1291 while ($obj = $this->db->fetch_object($resql)) {
1292 $this->motherof[$obj->id_son] = $obj->id_parent;
1293 }
1294 return 1;
1295 } else {
1296 dol_print_error($this->db);
1297 return -1;
1298 }
1299 }
1300
1301 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1322 public function get_full_arbo($type, $fromid = 0, $include = 0, $forcelangcode = '')
1323 {
1324 // phpcs:enable
1325 global $langs;
1326
1327 if (!is_numeric($type)) {
1328 $type = $this->MAP_ID[$type];
1329 }
1330 if (is_null($type)) {
1331 $this->error = 'BadValueForParameterType';
1332 return -1;
1333 }
1334
1335 if (is_string($fromid)) {
1336 $fromid = explode(',', $fromid);
1337 } elseif (is_numeric($fromid)) {
1338 if ($fromid > 0) {
1339 $fromid = array($fromid);
1340 } else {
1341 $fromid = array();
1342 }
1343 } elseif (!is_array($fromid)) {
1344 $fromid = array();
1345 }
1346
1347 $this->cats = array();
1348 $nbcateg = 0;
1349
1350 // Init this->motherof that is array(id_son=>id_parent, ...)
1351 $this->load_motherof();
1352
1353 if ($forcelangcode) {
1354 $current_lang = $forcelangcode;
1355 } else {
1356 $current_lang = $langs->getDefaultLang();
1357 }
1358
1359 // Init $this->cats array
1360 // Note: The DISTINCT reduces pb with old tables with duplicates but should not be used
1361 $sql = "SELECT DISTINCT c.rowid, c.label, c.ref_ext, c.description, c.color, c.position, c.fk_parent, c.visible, c.entity";
1362 if (getDolGlobalInt('MAIN_MULTILANGS') && $current_lang !== 'none') {
1363 $sql .= ", t.label as label_trans, t.description as description_trans";
1364 }
1365 $sql .= " FROM ".MAIN_DB_PREFIX."categorie as c";
1366 if (getDolGlobalInt('MAIN_MULTILANGS') && $current_lang !== 'none') {
1367 $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."categorie_lang as t ON t.fk_category = c.rowid AND t.lang = '".$this->db->escape($current_lang)."'";
1368 }
1369 $sql .= " WHERE c.entity IN (".getEntity('category').")";
1370 $sql .= " AND c.type = ".(int) $type;
1371
1372 dol_syslog(get_class($this)."::get_full_arbo get category list", LOG_DEBUG);
1373
1374 $resql = $this->db->query($sql);
1375 if ($resql) {
1376 $i = 0;
1377 $nbcateg = $this->db->num_rows($resql);
1378
1379 while ($obj = $this->db->fetch_object($resql)) {
1380 $this->cats[(int) $obj->rowid]
1381 = array(
1382 'rowid' => (int) $obj->rowid,
1383 'id' => (int) $obj->rowid,
1384 'fk_parent' => (int) $obj->fk_parent,
1385 'label' => !empty($obj->label_trans) ? (string) $obj->label_trans : (string) $obj->label,
1386 'description' => !empty($obj->description_trans) ? (string) $obj->description_trans : (string) $obj->description,
1387 'color' => (string) $obj->color,
1388 'position' => (string) $obj->position,
1389 'visible' => (int) $obj->visible,
1390 'ref_ext' => (string) $obj->ref_ext,
1391 'entity' => (int) $obj->entity,
1392 'picto' => 'category',
1393 // fields are filled with buildPathFromId later
1394 'fullpath' => '',
1395 'fulllabel' => '',
1396 'level' => null,
1397 );
1398 $i++;
1399 }
1400 } else {
1401 dol_print_error($this->db);
1402 return -1;
1403 }
1404
1405 // Let external modules complete or filter the tree (for example to restrict categories
1406 // coming from other entities according to a sharing granularity they manage)
1407 global $hookmanager;
1408 if (is_object($hookmanager)) {
1409 $parameters = array('cats' => &$this->cats, 'motherof' => &$this->motherof, 'type' => $type);
1410 $reshook = $hookmanager->executeHooks('completeCategoryFullTree', $parameters, $this);
1411 if ($reshook < 0) {
1412 setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
1413 }
1414 }
1415
1416 // We add the fullpath property to each elements of first level (no parent exists)
1417 dol_syslog(get_class($this)."::get_full_arbo call to buildPathFromId", LOG_DEBUG);
1418
1419 foreach ($this->cats as $key => $val) {
1420 //print 'key='.$key.'<br>'."\n";
1421 $this->buildPathFromId($key, $nbcateg); // Process a branch from the root category key (this category has no parent) and adds level to $this->cats items
1422 }
1423
1424 // Include or exclude leaf (including $fromid) from tree
1425 if (count($fromid) > 0) {
1426 $keyfiltercatid = '('.implode('|', $fromid).')';
1427
1428 //print "Look to discard category ".$fromid."\n";
1429 $keyfilter1 = '^'.$keyfiltercatid.'$';
1430 $keyfilter2 = '_'.$keyfiltercatid.'$';
1431 $keyfilter3 = '^'.$keyfiltercatid.'_';
1432 $keyfilter4 = '_'.$keyfiltercatid.'_';
1433 foreach (array_keys($this->cats) as $key) {
1434 $fullpath = (string) $this->cats[$key]['fullpath'];
1435 $test = (preg_match('/'.$keyfilter1.'/', $fullpath) || preg_match('/'.$keyfilter2.'/', $fullpath)
1436 || preg_match('/'.$keyfilter3.'/', $fullpath) || preg_match('/'.$keyfilter4.'/', $fullpath));
1437
1438 if (($test && !$include) || (!$test && $include)) {
1439 unset($this->cats[$key]); // @phpstan-ignore-line
1440 }
1441 }
1442 }
1443
1444 dol_syslog(get_class($this)."::get_full_arbo dol_sort_array", LOG_DEBUG);
1445
1446 $this->cats = dol_sort_array($this->cats, 'fulllabel', 'asc', 1, 0, 1); // Sort on full label like "Label 1 >> Sublabel a >> Subsublabel"
1447
1448 return $this->cats;
1449 }
1450
1461 private function buildPathFromId($id_categ, $protection = 1000)
1462 {
1463 //dol_syslog(get_class($this)."::buildPathFromId id_categ=".$id_categ." protection=".$protection, LOG_DEBUG);
1464
1465 if (!empty($this->cats[$id_categ]['fullpath'])) {
1466 // Already defined
1467 dol_syslog(get_class($this)."::buildPathFromId fullpath and fulllabel already defined", LOG_WARNING);
1468 return -1;
1469 }
1470
1471 // $this->cats[$id_categ] is supposed to be already an array. We just want to complete it with property fullpath and fulllabel
1472
1473 // Define fullpath and fulllabel
1474 $this->cats[$id_categ]['fullpath'] = '_'.$id_categ;
1475 $this->cats[$id_categ]['fulllabel'] = $this->cats[$id_categ]['label'];
1476 $i = 0;
1477 $cursor_categ = $id_categ;
1478 //print 'Work for id_categ='.$id_categ.'<br>'."\n";
1479 while ((empty($protection) || $i < $protection) && !empty($this->motherof[$cursor_categ])) {
1480 //print '&nbsp; cursor_categ='.$cursor_categ.' i='.$i.' '.$this->motherof[$cursor_categ].'<br>'."\n";
1481 $this->cats[$id_categ]['fullpath'] = '_'.$this->motherof[$cursor_categ].$this->cats[$id_categ]['fullpath'];
1482 $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'];
1483 //print '&nbsp; Result for id_categ='.$id_categ.' : '.$this->cats[$id_categ]['fullpath'].' '.$this->cats[$id_categ]['fulllabel'].'<br>'."\n";
1484 $i++;
1485 $cursor_categ = $this->motherof[$cursor_categ];
1486 }
1487 //print 'Result for id_categ='.$id_categ.' : '.$this->cats[$id_categ]['fullpath'].'<br>'."\n";
1488
1489 // We count number of _ to have level
1490 $nbunderscore = substr_count($this->cats[$id_categ]['fullpath'], '_');
1491 $this->cats[$id_categ]['level'] = ($nbunderscore ? $nbunderscore : null);
1492
1493 return 1;
1494 }
1495
1496
1497 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1505 public function get_all_categories($type = null, $parent = false)
1506 {
1507 // phpcs:enable
1508 if (!is_numeric($type) && !is_null($type)) {
1509 $type = $this->MAP_ID[$type];
1510 }
1511
1512 $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."categorie";
1513 $sql .= " WHERE entity IN (".getEntity('category').")";
1514 if (!is_null($type)) {
1515 $sql .= " AND type = ".(int) $type;
1516 }
1517 if ($parent) {
1518 $sql .= " AND fk_parent = 0";
1519 }
1520
1521 $res = $this->db->query($sql);
1522 if ($res) {
1523 $cats = array();
1524 while ($rec = $this->db->fetch_array($res)) {
1525 $cat = new Categorie($this->db);
1526 $cat->fetch($rec['rowid']);
1527 $cats[$rec['rowid']] = $cat;
1528 }
1529 return $cats;
1530 } else {
1531 dol_print_error($this->db);
1532 return -1;
1533 }
1534 }
1535
1536 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1543 public function get_main_categories($type = null)
1544 {
1545 // phpcs:enable
1546 return $this->get_all_categories($type, true);
1547 }
1548
1549 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1555 public function already_exists()
1556 {
1557 // phpcs:enable
1558 $type = $this->type;
1559
1560 if (!is_numeric($type)) {
1561 $type = $this->MAP_ID[$type];
1562 }
1563
1564 /* We have to select any rowid from llx_categorie which category's mother and label
1565 * are equals to those of the calling category
1566 */
1567 $sql = "SELECT c.rowid";
1568 $sql .= " FROM ".MAIN_DB_PREFIX."categorie as c ";
1569 $sql .= " WHERE c.entity IN (".getEntity('category').")";
1570 $sql .= " AND c.type = ".((int) $type);
1571 $sql .= " AND c.fk_parent = ".((int) $this->fk_parent);
1572 $sql .= " AND c.label = '".$this->db->escape($this->label)."'";
1573
1574 dol_syslog(get_class($this)."::already_exists", LOG_DEBUG);
1575
1576 $resql = $this->db->query($sql);
1577 if ($resql) {
1578 if ($this->db->num_rows($resql) > 0) { // Checking for empty resql
1579 $obj = $this->db->fetch_object($resql);
1580 /* If object called create, obj cannot have is id.
1581 * If object called update, he mustn't have the same label as an other category for this mother.
1582 * So if the result has the same id, update is not for label, and if result has an other one, update may be for label.
1583 */
1584 if (!empty($obj) && $obj->rowid > 0 && $obj->rowid != $this->id) {
1585 dol_syslog(get_class($this)."::already_exists category with name=".$this->label." and parent ".$this->fk_parent." exists: rowid=".$obj->rowid." current_id=".$this->id, LOG_DEBUG);
1586 return 1;
1587 }
1588 }
1589 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);
1590 return 0;
1591 } else {
1592 $this->error = $this->db->error();
1593 return -1;
1594 }
1595 }
1596
1597
1598 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1610 public function print_all_ways($sep = 'auto', $url = '', $nocolor = 0, $addpicto = 0, $notrunc = 0)
1611 {
1612 // phpcs:enable
1613 $ways = array();
1614
1615 if ($sep == 'auto') {
1616 $sep = '&gt;';
1617 }
1618
1619 $all_ways = $this->get_all_ways(); // Load array of categories from database to reach this->id
1620
1621 foreach ($all_ways as $way) { // It seems we always have 1 entry in this array.
1622 $w = array();
1623 $i = 0;
1624 $forced_color = '';
1625 foreach ($way as $cat) { // Loop on each successive categories to reach the target of current category
1626 $i++;
1627
1628 if (empty($nocolor)) {
1629 $forced_color = 'colortoreplace';
1630 if ($i == count($way)) { // Last category in hierarchy
1631 // Check contrast with background and correct text color
1632 $forced_color = 'categtextwhite'; // We want color white because the getNomUrl of a tag is always called inside a dark background like '<span color="bbb"></span>' to show it as a tag. TODO Add this in param to force when called outside of span.
1633 if ($cat->color && colorIsLight($cat->color)) {
1634 $forced_color = 'categtextblack';
1635 }
1636 }
1637 }
1638
1639 if ($url == '') {
1640 if (($i < count($way) && empty($notrunc)) && $i > 1) {
1641 $link = '';
1642 $linkend = '';
1643 } else {
1644 $link = '<a href="'.DOL_URL_ROOT.'/categories/viewcat.php?id='.((int) $cat->id).'&type='.urlencode($cat->type).'" class="'.(($i < count($way) && empty($notrunc)) ? 'small ' : '').$forced_color.'">';
1645 $linkend = '</a>';
1646 }
1647 $s = $link.(($addpicto && $i == 1) ? img_object('', 'category', 'class="paddingright"') : '');
1648 $s .= (($i < count($way) && empty($notrunc)) ? ($i == 1 ? dol_trunc($cat->label, 3) : '') : $cat->label);
1649 $s .= $linkend;
1650 $w[] = $s;
1651 } elseif ($url == 'none') {
1652 if (($i < count($way) && empty($notrunc)) && $i > 1) {
1653 $link = '';
1654 $linkend = '';
1655 } else {
1656 $link = '<span class="valignmiddle '.($i < count($way) ? 'small ' : '').$forced_color.'">';
1657 $linkend = '</span>';
1658 }
1659 $s = $link.(($addpicto && $i == 1) ? img_object('', 'category', 'class="paddingright"') : '');
1660 $s .= (($i < count($way) && empty($notrunc)) ? ($i == 1 ? dol_trunc($cat->label, 3) : '') : $cat->label);
1661 $s .= $linkend;
1662 $w[] = $s;
1663 } else {
1664 $w[] = '<a class="valignmiddle '.($i < count($way) ? 'small ' : '').$forced_color.'" href="'.DOL_URL_ROOT.'/'.$url.'?catid='.((int) $cat->id).'">'.($addpicto ? img_object('', 'category') : '').$cat->label.'</a>';
1665 }
1666 }
1667 $newcategwithpath = preg_replace('/colortoreplace/', $forced_color, implode('<span class="inline-block valignmiddle paddingleft paddingright small '.$forced_color.'">'.$sep.'</span>', $w));
1668
1669 $ways[] = $newcategwithpath;
1670 }
1671
1672 return $ways;
1673 }
1674
1675
1676 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1683 public function get_meres()
1684 {
1685 // phpcs:enable
1686 $parents = array();
1687
1688 $sql = "SELECT fk_parent FROM ".MAIN_DB_PREFIX."categorie";
1689 $sql .= " WHERE rowid = ".((int) $this->id);
1690
1691 $res = $this->db->query($sql);
1692
1693 if ($res) {
1694 while ($rec = $this->db->fetch_array($res)) {
1695 if ($rec['fk_parent'] > 0) {
1696 $cat = new Categorie($this->db);
1697 $cat->fetch($rec['fk_parent']);
1698 $parents[] = $cat;
1699 }
1700 }
1701 return $parents;
1702 } else {
1703 dol_print_error($this->db);
1704 return -1;
1705 }
1706 }
1707
1708 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1715 public function get_all_ways()
1716 {
1717 // phpcs:enable
1718 $ways = array();
1719
1720 $parents = $this->get_meres();
1721 if (is_array($parents)) {
1722 foreach ($parents as $parent) {
1723 $all_ways = $parent->get_all_ways(); // recursivity. TODO Add a protection for infinite loop
1724 foreach ($all_ways as $way) {
1725 $w = $way;
1726 $w[] = $this;
1727 $ways[] = $w;
1728 }
1729 }
1730 }
1731
1732 if (count($ways) == 0) {
1733 $ways[0][0] = $this;
1734 }
1735
1736 return $ways;
1737 }
1738
1749 public function containing($id, $type, $mode = 'object')
1750 {
1751 $cats = array();
1752
1753 if (is_numeric($type)) {
1754 $type = array_search($type, $this->MAP_ID);
1755 }
1756
1757 if ($type === Categorie::TYPE_BANK_LINE) { // TODO Remove this after migration of llx_category_bankline into llx_categorie_bankline
1758 // Load bank categories
1759 $sql = "SELECT c.label, c.rowid";
1760 $sql .= " FROM ".MAIN_DB_PREFIX."category_bankline as a, ".MAIN_DB_PREFIX."categorie as c";
1761 $sql .= " WHERE a.lineid=".((int) $id)." AND a.fk_categ = c.rowid";
1762 $sql .= " AND c.entity IN (".getEntity('category').")";
1763 $sql .= " ORDER BY c.label";
1764
1765 $res = $this->db->query($sql);
1766 if ($res) {
1767 while ($obj = $this->db->fetch_object($res)) {
1768 if ($mode == 'id') {
1769 $cats[] = $obj->rowid;
1770 } elseif ($mode == 'label') {
1771 $cats[] = $obj->label;
1772 } else {
1773 $cat = new Categorie($this->db);
1774 $cat->id = $obj->rowid;
1775 $cat->label = $obj->label;
1776 $cats[] = $cat;
1777 }
1778 }
1779 } else {
1780 dol_print_error($this->db);
1781 return -1;
1782 }
1783 } else {
1784 $sql = "SELECT ct.fk_categorie, c.label, c.rowid";
1785 $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";
1786 $sql .= " WHERE ct.fk_categorie = c.rowid AND ct.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = ".(int) $id;
1787 // This seems useless because the table already contains id of category of 1 unique type. So commented.
1788 // So now it works also with external added categories.
1789 //$sql .= " AND c.type = ".((int) $this->MAP_ID[$type]);
1790 $sql .= " AND c.entity IN (".getEntity('category').")";
1791
1792 $res = $this->db->query($sql);
1793 if ($res) {
1794 while ($obj = $this->db->fetch_object($res)) {
1795 if ($mode == 'id') {
1796 $cats[] = $obj->rowid;
1797 } elseif ($mode == 'label') {
1798 $cats[] = $obj->label;
1799 } else {
1800 $cat = new Categorie($this->db);
1801 $cat->fetch($obj->fk_categorie);
1802 $cats[] = $cat;
1803 }
1804 }
1805 } else {
1806 dol_print_error($this->db);
1807 return -1;
1808 }
1809 }
1810
1811 return $cats;
1812 }
1813
1825 public function rechercher($id, $nom, $type, $exact = false, $case = false)
1826 {
1827 // Deprecation warning
1828 if (is_numeric($type)) {
1829 dol_syslog(__METHOD__.': using numeric types is deprecated.', LOG_WARNING);
1830 }
1831
1832 $cats = array();
1833
1834 // For backward compatibility
1835 if (is_numeric($type)) {
1836 // We want to reverse lookup
1837 $map_type = array_flip($this->MAP_ID);
1838 $type = $map_type[$type];
1839 dol_syslog(get_class($this)."::rechercher(): numeric types are deprecated, please use string instead", LOG_WARNING);
1840 }
1841
1842 // Generation requete recherche
1843 $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."categorie";
1844 $sql .= " WHERE type = ".((int) $this->MAP_ID[$type]);
1845 $sql .= " AND entity IN (".getEntity('category').")";
1846 if ($nom) {
1847 if (!$exact) {
1848 $nom = '%'.$this->db->escape(str_replace('*', '%', $nom)).'%';
1849 }
1850 if (!$case) {
1851 $sql .= " AND label LIKE '".$this->db->escape($nom)."'";
1852 } else {
1853 $sql .= " AND label LIKE BINARY '".$this->db->escape($nom)."'";
1854 }
1855 }
1856 if ($id) {
1857 $sql .= " AND rowid = ".((int) $id);
1858 }
1859
1860 $res = $this->db->query($sql);
1861 if ($res) {
1862 while ($rec = $this->db->fetch_array($res)) {
1863 $cat = new Categorie($this->db);
1864 $cat->fetch($rec['rowid']);
1865 $cats[] = $cat;
1866 }
1867
1868 return $cats;
1869 } else {
1870 $this->error = $this->db->error().' sql='.$sql;
1871 return -1;
1872 }
1873 }
1874
1881 public function isAnyPhotoAvailable($sdir)
1882 {
1883 include_once DOL_DOCUMENT_ROOT . '/core/lib/files.lib.php';
1884 include_once DOL_DOCUMENT_ROOT . '/core/lib/images.lib.php';
1885
1886 $sdir .= '/' . get_exdir($this->id, 2, 0, 0, $this, 'category') . $this->id . "/photos/";
1887
1888 $dir_osencoded = dol_osencode($sdir);
1889 if (file_exists($dir_osencoded)) {
1890 $handle = opendir($dir_osencoded);
1891 if (is_resource($handle)) {
1892 while (($file = readdir($handle)) !== false) {
1893 if (!utf8_check($file)) {
1894 $file = mb_convert_encoding($file, 'UTF-8', 'ISO-8859-1'); // To be sure data is stored in UTF8 in memory
1895 }
1896 if (dol_is_file($sdir . $file) && image_format_supported($file) >= 0) {
1897 return true;
1898 }
1899 }
1900 }
1901 }
1902 return false;
1903 }
1904
1911 public function getTooltipContentArray($params)
1912 {
1913 global $langs;
1914
1915 $langs->load('categories');
1916
1917 $datas = [];
1918
1919 $datas['label'] = $langs->trans("ShowCategory").': '.($this->ref ? $this->ref : $this->label);
1920
1921 return $datas;
1922 }
1923
1937 public function getNomUrl($withpicto = 0, $option = '', $maxlength = 0, $moreparam = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = 0)
1938 {
1939 global $conf, $langs, $hookmanager;
1940
1941 if (!empty($conf->dol_no_mouse_hover)) {
1942 $notooltip = 1; // Force disable tooltips
1943 }
1944
1945 $result = '';
1946 $params = [
1947 'id' => $this->id,
1948 'objecttype' => $this->element,
1949 'option' => $option,
1950 ];
1951 $classfortooltip = 'classfortooltip';
1952 $dataparams = '';
1953 if (getDolGlobalInt('MAIN_ENABLE_AJAX_TOOLTIP')) {
1954 $classfortooltip = 'classforajaxtooltip';
1955 $dataparams = ' data-params="'.dol_escape_htmltag(json_encode($params)).'"';
1956 $label = '';
1957 } else {
1958 $label = implode($this->getTooltipContentArray($params));
1959 }
1960
1961 $url = DOL_URL_ROOT.'/categories/viewcat.php?id='.$this->id.'&type='.$this->type.$moreparam.'&backtopage='.urlencode($_SERVER['PHP_SELF'].($moreparam ? '?'.$moreparam : ''));
1962
1963 if ($option !== 'nolink') {
1964 // Add param to save lastsearch_values or not
1965 $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
1966 if ($save_lastsearch_value == -1 && isset($_SERVER["PHP_SELF"]) && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
1967 $add_save_lastsearch_values = 1;
1968 }
1969 if (/* $url && */ $add_save_lastsearch_values) {
1970 $url .= '&save_lastsearch_values=1';
1971 }
1972 }
1973
1974 // Check contrast with background and correct text color
1975 $forced_color = 'categtextwhite'; // We want color white because the getNomUrl of a tag is always called inside a dark background like '<span color="bbb"></span>' to show it as a tag. TODO Add this in param to force when called outside of span.
1976 if ($this->color) {
1977 if (colorIsLight($this->color)) { // If color is light, we force color to dark
1978 $forced_color = 'categtextblack';
1979 }
1980 }
1981
1982 $linkclose = '';
1983 if (empty($notooltip)) {
1984 if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER')) {
1985 $label = $langs->trans("ShowCategory");
1986 $linkclose .= ' alt="'.dolPrintHTMLForAttribute($label).'"';
1987 }
1988 $linkclose .= ($label ? ' title="'.dolPrintHTMLForAttribute($label).'"' : ' title="tocomplete"');
1989 $linkclose .= $dataparams.' class="'.$classfortooltip.' '.$forced_color.($morecss ? ' '.$morecss : '').'"';
1990 } else {
1991 $linkclose = ' class="'.$forced_color.($morecss ? ' '.$morecss : '').'"';
1992 }
1993
1994 if ($option == 'nolink' /* || empty($url) */) {
1995 $linkstart = '<span';
1996 } else {
1997 $linkstart = '<a href="'.$url.'"';
1998 }
1999 $linkstart .= $linkclose.'>';
2000 if ($option == 'nolink' /* || empty($url) */) {
2001 $linkend = '</span>';
2002 } else {
2003 $linkend = '</a>';
2004 }
2005
2006 $result .= $linkstart;
2007
2008 if ($withpicto) {
2009 $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'"'), 0, 0, $notooltip ? 0 : 1);
2010 }
2011
2012 if ($withpicto != 2) {
2013 $result .= dol_trunc(($this->ref ? $this->ref : $this->label), $maxlength);
2014 }
2015
2016 $result .= $linkend;
2017
2018 global $action;
2019 $hookmanager->initHooks(array($this->element . 'dao'));
2020 $parameters = array('id' => $this->id, 'getnomurl' => &$result);
2021 $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
2022 if ($reshook > 0) {
2023 $result = $hookmanager->resPrint;
2024 } else {
2025 $result .= $hookmanager->resPrint;
2026 }
2027 return $result;
2028 }
2029
2030
2031 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2039 public function add_photo($sdir, $file)
2040 {
2041 // phpcs:enable
2042 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
2043
2044 $dir = $sdir.'/'.get_exdir($this->id, 2, 0, 0, $this, 'category').$this->id."/";
2045 $dir .= "photos/";
2046
2047 if (!file_exists($dir)) {
2048 dol_mkdir($dir);
2049 }
2050
2051 if (file_exists($dir)) {
2052 if (is_array($file['name'])) {
2053 $nbfile = count($file['name']);
2054 for ($i = 0; $i < $nbfile; $i++) {
2055 $originImage = $dir.$file['name'][$i];
2056
2057 // Cree fichier en taille origine
2058 dol_move_uploaded_file($file['tmp_name'][$i], $originImage, 1, 0, 0);
2059
2060 if (file_exists($originImage)) {
2061 // Create thumbs
2062 $this->addThumbs($originImage);
2063 }
2064 }
2065 } else {
2066 $originImage = $dir.$file['name'];
2067
2068 // Cree fichier en taille origine
2069 dol_move_uploaded_file($file['tmp_name'], $originImage, 1, 0, 0);
2070
2071 if (file_exists($originImage)) {
2072 // Create thumbs
2073 $this->addThumbs($originImage);
2074 }
2075 }
2076 }
2077 }
2078
2079 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2087 public function liste_photos($dir, $nbmax = 0)
2088 {
2089 // phpcs:enable
2090 include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
2091
2092 $nbphoto = 0;
2093 $tabobj = array();
2094
2095 $dirthumb = $dir.'thumbs/';
2096
2097 if (file_exists($dir)) {
2098 $handle = opendir($dir);
2099 if (is_resource($handle)) {
2100 while (($file = readdir($handle)) !== false) {
2101 if (dol_is_file($dir.$file) && preg_match('/(\.jpeg|\.jpg|\.bmp|\.gif|\.png|\.tiff)$/i', $dir.$file)) {
2102 $nbphoto++;
2103 $photo = $file;
2104
2105 // On determine nom du fichier vignette
2106 $photo_vignette = '';
2107 $regs = array();
2108 if (preg_match('/(\.jpeg|\.jpg|\.bmp|\.gif|\.png|\.tiff)$/i', $photo, $regs)) {
2109 $photo_vignette = preg_replace('/'.$regs[0].'/i', '', $photo).'_small'.$regs[0];
2110 }
2111
2112 // Object
2113 $obj = array();
2114 $obj['photo'] = $photo;
2115 if ($photo_vignette && is_file($dirthumb.$photo_vignette)) {
2116 $obj['photo_vignette'] = 'thumbs/'.$photo_vignette;
2117 } else {
2118 $obj['photo_vignette'] = "";
2119 }
2120
2121 $tabobj[$nbphoto - 1] = $obj;
2122
2123 // On continue ou on arrete de boucler
2124 if ($nbmax && $nbphoto >= $nbmax) {
2125 break;
2126 }
2127 }
2128 }
2129
2130 closedir($handle);
2131 }
2132 }
2133
2134 return $tabobj;
2135 }
2136
2137 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2144 public function delete_photo($file)
2145 {
2146 // phpcs:enable
2147 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
2148
2149 $dir = dirname($file).'/'; // Chemin du dossier contenant l'image d'origine
2150 $dirthumb = $dir.'/thumbs/'; // Chemin du dossier contenant la vignette
2151 $filename = preg_replace('/'.preg_quote($dir, '/').'/i', '', $file); // Nom du fichier
2152
2153 // On efface l'image d'origine
2154 dol_delete_file($file, 0); // do not use disableglob, ecmfiles will not be deleted
2155
2156 // Si elle existe, on efface la vignette
2157 $regs = array();
2158 if (preg_match('/(\.jpeg|\.jpg|\.bmp|\.gif|\.png|\.tiff)$/i', $filename, $regs)) {
2159 $photo_vignette = preg_replace('/'.$regs[0].'/i', '', $filename).'_small'.$regs[0];
2160 if (file_exists($dirthumb.$photo_vignette)) {
2161 dol_delete_file($dirthumb.$photo_vignette, 1);
2162 }
2163 }
2164 }
2165
2166 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2173 public function get_image_size($file)
2174 {
2175 // phpcs:enable
2176 $infoImg = getimagesize($file); // Recuperation des infos de l'image
2177 $this->imgWidth = $infoImg[0]; // Largeur de l'image
2178 $this->imgHeight = $infoImg[1]; // Hauteur de l'image
2179 }
2180
2189 public function setMultiLangs(User $user, $notrigger = 0)
2190 {
2191 global $langs;
2192
2193 $langs_available = $langs->get_available_languages();
2194 $current_lang = $langs->getDefaultLang();
2195
2196 foreach ($langs_available as $key => $value) {
2197 $sql = "SELECT rowid";
2198 $sql .= " FROM ".MAIN_DB_PREFIX."categorie_lang";
2199 $sql .= " WHERE fk_category=".((int) $this->id);
2200 $sql .= " AND lang = '".$this->db->escape($key)."'";
2201
2202 $result = $this->db->query($sql);
2203
2204 if ($key == $current_lang) {
2205 $sql2 = '';
2206 if ($this->db->num_rows($result)) { // if there is already a description line for this language
2207 $sql2 = "UPDATE ".MAIN_DB_PREFIX."categorie_lang";
2208 $sql2 .= " SET label = '".$this->db->escape($this->label)."',";
2209 $sql2 .= " description = '".$this->db->escape($this->description)."'";
2210 $sql2 .= " WHERE fk_category = ".((int) $this->id)." AND lang = '".$this->db->escape($key)."'";
2211 } else { // if no line in database
2212 $sql2 = "INSERT INTO ".MAIN_DB_PREFIX."categorie_lang (fk_category, lang, label, description)";
2213 $sql2 .= " VALUES(".((int) $this->id).", '".$this->db->escape($key)."', '".$this->db->escape($this->label)."'";
2214 $sql2 .= ", '".$this->db->escape($this->description)."')";
2215 }
2216 dol_syslog(get_class($this).'::setMultiLangs', LOG_DEBUG);
2217 if (!$this->db->query($sql2)) {
2218 $this->error = $this->db->lasterror();
2219 return -1;
2220 }
2221 $this->multilangs[$key]["label"] = $this->label;
2222 $this->multilangs[$key]["description"] = $this->description;
2223 } elseif (isset($this->multilangs[$key])) { // if there is already a description line for this language
2224 if ($this->db->num_rows($result)) {
2225 $sql2 = "UPDATE ".MAIN_DB_PREFIX."categorie_lang";
2226 $sql2 .= " SET label='".$this->db->escape($this->multilangs[$key]["label"])."',";
2227 $sql2 .= " description='".$this->db->escape($this->multilangs[$key]["description"])."'";
2228 $sql2 .= " WHERE fk_category=".((int) $this->id)." AND lang='".$this->db->escape($key)."'";
2229 } else { // if no line in database
2230 $sql2 = "INSERT INTO ".MAIN_DB_PREFIX."categorie_lang (fk_category, lang, label, description)";
2231 $sql2 .= " VALUES(".((int) $this->id).", '".$this->db->escape($key)."', '".$this->db->escape($this->multilangs[$key]["label"])."'";
2232 $sql2 .= ",'".$this->db->escape($this->multilangs[$key]["description"])."')";
2233 }
2234
2235 // We do not save if main fields are empty
2236 if ($this->multilangs[$key]["label"] || $this->multilangs[$key]["description"]) {
2237 dol_syslog(get_class($this).'::setMultiLangs', LOG_DEBUG);
2238 }
2239 if (!$this->db->query($sql2)) {
2240 $this->error = $this->db->lasterror();
2241 return -1;
2242 }
2243 }
2244 }
2245
2246 // Call trigger
2247 if (!$notrigger) {
2248 $result = $this->call_trigger('CATEGORY_SET_MULTILANGS', $user);
2249 if ($result < 0) {
2250 $this->error = $this->db->lasterror();
2251 return -1;
2252 }
2253 }
2254 // End call triggers
2255
2256 return 1;
2257 }
2258
2268 public function delMultiLangs($langtodelete, $user, $notrigger = 0)
2269 {
2270 $sql = "DELETE FROM ".$this->db->prefix()."categorie_lang";
2271 $sql .= " WHERE fk_category = ".((int) $this->id)." AND lang = '".$this->db->escape($langtodelete)."'";
2272
2273 dol_syslog(get_class($this).'::delMultiLangs', LOG_DEBUG);
2274 $result = $this->db->query($sql);
2275 if ($result) {
2276 if (empty($notrigger)) {
2277 // Call trigger
2278 $result = $this->call_trigger('CATEGORY_DEL_MULTILANGS', $user);
2279 if ($result < 0) {
2280 $this->error = $this->db->lasterror();
2281 dol_syslog(get_class($this).'::delMultiLangs error='.$this->error, LOG_ERR);
2282 return -1;
2283 }
2284 // End call triggers
2285 }
2286 return 1;
2287 } else {
2288 $this->error = $this->db->lasterror();
2289 dol_syslog(get_class($this).'::delMultiLangs error='.$this->error, LOG_ERR);
2290 return -1;
2291 }
2292 }
2293
2299 public function getMultiLangs()
2300 {
2301 global $langs;
2302
2303 $current_lang = $langs->getDefaultLang();
2304
2305 $sql = "SELECT lang, label, description";
2306 $sql .= " FROM ".MAIN_DB_PREFIX."categorie_lang";
2307 $sql .= " WHERE fk_category=".((int) $this->id);
2308
2309 $result = $this->db->query($sql);
2310 if ($result) {
2311 while ($obj = $this->db->fetch_object($result)) {
2312 //print 'lang='.$obj->lang.' current='.$current_lang.'<br>';
2313 if ($obj->lang == $current_lang) { // si on a les traduct. dans la langue courante on les charge en infos principales.
2314 $this->label = $obj->label;
2315 $this->description = $obj->description;
2316 }
2317 $this->multilangs[$obj->lang]["label"] = $obj->label;
2318 $this->multilangs[$obj->lang]["description"] = $obj->description;
2319 }
2320 return 1;
2321 } else {
2322 $this->error = $langs->trans("Error")." : ".$this->db->error()." - ".$sql;
2323 return -1;
2324 }
2325 }
2326
2333 public function getLibStatut($mode)
2334 {
2335 return '';
2336 }
2337
2338
2346 public function initAsSpecimen()
2347 {
2348 dol_syslog(get_class($this)."::initAsSpecimen");
2349
2350 // Initialise parameters
2351 $this->id = 0;
2352 $this->fk_parent = 0;
2353 $this->label = 'SPECIMEN';
2354 $this->specimen = 1;
2355 $this->description = 'This is a description';
2356 $this->socid = 1;
2357 $this->type = self::TYPE_PRODUCT;
2358
2359 return 1;
2360 }
2361
2370 public static function replaceThirdparty(DoliDB $dbs, $origin_id, $dest_id)
2371 {
2372 $tables = array(
2373 'categorie_societe'
2374 );
2375
2376 return CommonObject::commonReplaceThirdparty($dbs, $origin_id, $dest_id, $tables, 1);
2377 }
2378
2387 public static function getFilterJoinQuery($type, $rowIdName)
2388 {
2389 if ($type == 'bank_account') {
2390 $type = 'account';
2391 }
2392
2393 return " LEFT JOIN ".MAIN_DB_PREFIX."categorie_".$type." as cp ON ".$rowIdName." = cp.fk_".$type;
2394 }
2395
2405 public static function getFilterSelectQuery($type, $rowIdName, $searchList)
2406 {
2407 if ($type == 'bank_account') {
2408 $type = 'account';
2409 }
2410 if ($type == 'customer') {
2411 $type = 'societe';
2412 }
2413 if ($type == 'supplier') {
2414 $type = 'fournisseur';
2415 }
2416
2417 if (empty($searchList) && !is_array($searchList)) {
2418 return "";
2419 }
2420
2421 $searchCategorySqlList = array();
2422 foreach ($searchList as $searchCategory) {
2423 if (intval($searchCategory) == -2) {
2424 $searchCategorySqlList[] = " cp.fk_categorie IS NULL";
2425 } elseif (intval($searchCategory) > 0) {
2426 $searchCategorySqlList[] = " ".$rowIdName." IN (SELECT fk_".$type." FROM ".MAIN_DB_PREFIX."categorie_".$type." WHERE fk_categorie = ".((int) $searchCategory).")";
2427 }
2428 }
2429
2430 if (!empty($searchCategorySqlList)) {
2431 return " AND (".implode(' AND ', $searchCategorySqlList).")";
2432 } else {
2433 return "";
2434 }
2435 }
2436
2442 public function countNbOfCategories()
2443 {
2444 dol_syslog(get_class($this)."::count_all_categories", LOG_DEBUG);
2445 $sql = "SELECT COUNT(rowid) FROM ".MAIN_DB_PREFIX."categorie";
2446 $sql .= " WHERE entity IN (".getEntity('category').")";
2447
2448 $res = $this->db->query($sql);
2449 if ($res) {
2450 $obj = $this->db->fetch_object($res);
2451 return $obj->count;
2452 } else {
2453 dol_print_error($this->db);
2454 return -1;
2455 }
2456 }
2457}
print $object position
Definition edit.php:206
$object ref
Definition info.php:90
Class to manage categories.
getListForItem($id, $type='customer', $sortfield="s.rowid", $sortorder='ASC', $limit=0, $page=0)
Return the list of the categories of a given element (a product, a customer, ...).
get_image_size($file)
Load size of image file.
load_motherof()
Load the array this->motherof that is array(id_son=>id_parent, ...), so array of all child categories...
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 a given object having id $id and typ...
getTooltipContentArray($params)
getTooltipContentArray
countNbOfCategories()
Count all categories.
del_type($obj, $type)
Delete object from category.
buildPathFromId($id_categ, $protection=1000)
For category id_categ and its children available in this->cats, define property fullpath and fulllabe...
static getFilterSelectQuery($type, $rowIdName, $searchList)
Return the additional SQL SELECT query for filtering a list by a category.
create($user, $notrigger=0)
Add category into database.
rechercher($id, $nom, $type, $exact=false, $case=false)
Returns categories whose id or name matches.
getMultiLangs()
Load array this->multilangs.
isAnyPhotoAvailable($sdir)
Return if at least one photo is available.
already_exists()
Check if a category with same label already exists for this cat's parent or root and for this cat's t...
get_filles()
Return direct children ids 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 additional SQL JOIN query for filtering a list by a category.
containsObject($type, $object_id)
Check for the presence of a given object in the current category.
get_main_categories($type=null)
Returns the first level categories (which are not child)
getMapId()
Get MAP_ID.
static replaceThirdparty(DoliDB $dbs, $origin_id, $dest_id)
Function used to replace a thirdparty id with another one.
setMultiLangs(User $user, $notrigger=0)
Create or Update translations of categories labels.
getMapList()
Get map list.
$fields
'type' if the field format ('integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter...
get_meres()
Returns an array containing the list of parent categories Note: A category can only have one parent b...
get_full_arbo($type, $fromid=0, $include=0, $forcelangcode='')
Rebuilding the category tree as an array Return an array of table('id','id_mere',....
add_type($obj, $type='')
Link an object to the category.
print_all_ways($sep='auto', $url='', $nocolor=0, $addpicto=0, $notrunc=0)
Returns the path of the category, with the names of the categories separated by $sep (" >> " by defau...
update(User $user, $notrigger=0)
Update category.
liste_photos($dir, $nbmax=0)
Return an array with all photos inside the directory.
get_all_ways()
Returns in a array all possible paths to go to the category starting with the major categories repres...
getNomUrl($withpicto=0, $option='', $maxlength=0, $moreparam='', $notooltip=0, $morecss='', $save_lastsearch_value=0)
Return name and link of category (with picto) Use ->id, ->ref, ->label, ->color.
delMultiLangs($langtodelete, $user, $notrigger=0)
Delete a language for this category.
add_photo($sdir, $file)
Add the image uploaded as $file to the directory $sdir/<category>-<id>/photos/.
fetch($id, $label='', $type=null, $ref_ext='')
Load category into memory from database.
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.
static commonReplaceThirdparty(DoliDB $dbs, $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.
addThumbs($file, $quality=50)
Build thumb.
Class to manage Dolibarr database access.
Class to manage Dolibarr users.
print $script_file $mode $langs defaultlang(is_numeric($duration_value) ? " delay=". $duration_value :"").(is_numeric($duration_value2) ? " after cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
if(!isModEnabled('ai')||!getDolGlobalString('AI_ASSISTANT_ENABLED')) global $conf
The main.inc.php has been included so the following variable are now defined:
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.
dol_is_file($pathoffile)
Return if path is a file.
dol_move_uploaded_file($src_file, $dest_file, $allowoverwrite, $disablevirusscan=0, $uploaderrorcode=0, $nohook=0, $keyforsourcefile='addedfile', $upload_dir='', $mode=0)
Check validity of a file upload from an GUI page, and move it to its final destination.
dol_now($mode='gmt')
Return date for now.
dol_osencode($str)
Return a string encoded into OS filesystem encoding.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
dol_sort_array(&$array, $index, $order='asc', $natsort=0, $case_sensitive=0, $keepindex=0)
Advanced sort array by the value of a given key, which produces ascending (default) or descending out...
forgeSQLFromUniversalSearchCriteria($filter, &$errorstr='', $noand=0, $nopar=0, $noerror=0, $forbiddenfields=array())
forgeSQLFromUniversalSearchCriteria
colorIsLight($stringcolor)
Return true if the color is light.
dol_trunc($string, $size=40, $trunc='right', $stringencoding='UTF-8', $nodot=0, $display=0)
Truncate a string to a particular length adding '...' if string larger than length.
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
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.
utf8_check($str)
Check if a string is in UTF8.
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)
setEventMessages($mesg, $mesgs, $style='mesgs', $messagekey='', $noduplicate=0, $attop=0)
Set event messages in dol_events session object.
img_object($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $allowothertags=array())
Show a picto called object_picto (generic function)
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
image_format_supported($file, $acceptsvg=0)
Return if a filename is file name of a supported image format.
print $langs trans("Show") . '< td style="' . $timeColor . '" align="center"> s</td > badge status0 badge status4 badge status3 Error badge status8< td align="center">< span class="badge ' . $badge . '"></span ></td >< td align="center">< a href="#" class="button button-small" onclick="openLogModal(this)" data-req="' . dol_escape_htmltag($reqSafe) . '" data-res="' . dol_escape_htmltag($resSafe) . '" data-err="' . dol_escape_htmltag($errSafe) . '">< span class="fa fa-search-plus"></span ></a ></td ></tr >< tr >< td colspan="' . $colspan . '" class="opacitymedium"></td ></tr ></table ></div ></form > logModal none logModal none s a JSON string
if(preg_match('/(crypted|dolcrypt):/i', $dolibarr_main_db_pass)||!empty($dolibarr_main_db_encrypted_pass)) $conf db type
'integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]',...
Definition repair.php:130