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-2026 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((string) $this->label);
566 $this->description = trim((string) $this->description);
567 $this->color = trim((string) $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((string) $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((string) $this->label);
680 $this->description = trim((string) $this->description);
681 $this->ref_ext = trim((string) $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
860 public function add_type($obj, $type = '', $notrigger = 0)
861 {
862 // phpcs:enable
863 global $user;
864
865 $error = 0;
866
867 if ($this->id == -1) {
868 return -2;
869 }
870
871 if (empty($type)) {
872 $type = $obj->element;
873 }
874
875 dol_syslog(get_class($this).'::add_type', LOG_DEBUG);
876
877 $this->db->begin();
878
879 $sql = "INSERT INTO ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type]);
880 $sql .= " (fk_categorie, fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type]).")";
881 $sql .= " VALUES (".((int) $this->id).", ".((int) $obj->id).")";
882
883 if ($this->db->query($sql)) {
884 if (getDolGlobalString('CATEGORIE_RECURSIV_ADD')) {
885 $sql = 'SELECT fk_parent FROM '.MAIN_DB_PREFIX.'categorie';
886 $sql .= " WHERE rowid = ".((int) $this->id);
887
888 dol_syslog(get_class($this)."::add_type", LOG_DEBUG);
889 $resql = $this->db->query($sql);
890 if ($resql) {
891 if ($this->db->num_rows($resql) > 0) {
892 $objparent = $this->db->fetch_object($resql);
893
894 if (!empty($objparent->fk_parent)) {
895 $cat = new Categorie($this->db);
896 $cat->id = $objparent->fk_parent;
897 if (!$cat->containsObject($type, $obj->id)) {
898 $result = $cat->add_type($obj, $type);
899 if ($result < 0) {
900 $this->error = $cat->error;
901 $error++;
902 }
903 }
904 }
905 }
906 } else {
907 $error++;
908 $this->error = $this->db->lasterror();
909 }
910
911 if ($error) {
912 $this->db->rollback();
913 return -1;
914 }
915 }
916
917 // Call trigger
918 if (empty($notrigger)) {
919 $this->context = array('linkto' => $obj); // Save object we want to link category to into category instance to provide information to trigger
920 $result = $this->call_trigger('CATEGORY_MODIFY', $user);
921 if ($result < 0) {
922 $error++;
923 }
924 }
925 // End call triggers
926
927 if (!$error) {
928 $this->db->commit();
929 return 1;
930 } else {
931 $this->db->rollback();
932 return -2;
933 }
934 } else {
935 $this->db->rollback();
936 if ($this->db->lasterrno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') {
937 $this->error = $this->db->lasterrno();
938 return -3;
939 } else {
940 $this->error = $this->db->lasterror();
941 }
942 return -1;
943 }
944 }
945
946 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
956 public function del_type($obj, $type, $notrigger = 0)
957 {
958 // phpcs:enable
959 global $user;
960
961 $error = 0;
962
963 // For backward compatibility
964 if ($type == 'societe') {
965 $type = 'customer';
966 dol_syslog(get_class($this)."::del_type(): type 'societe' is deprecated, please use 'customer' instead", LOG_WARNING);
967 } elseif ($type == 'fournisseur') {
968 $type = 'supplier';
969 dol_syslog(get_class($this)."::del_type(): type 'fournisseur' is deprecated, please use 'supplier' instead", LOG_WARNING);
970 }
971
972 $this->db->begin();
973
974 $sql = "DELETE FROM ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type]);
975 $sql .= " WHERE fk_categorie = ".((int) $this->id);
976 $sql .= " AND fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = ".((int) $obj->id);
977
978 dol_syslog(get_class($this).'::del_type', LOG_DEBUG);
979 if ($this->db->query($sql)) {
980 // Call trigger
981 if (empty($notrigger)) {
982 $this->context = array('unlinkoff' => $obj); // Save object we want to link category to into category instance to provide information to trigger
983 $result = $this->call_trigger('CATEGORY_MODIFY', $user);
984 if ($result < 0) {
985 $error++;
986 }
987 }
988 // End call triggers
989
990 if (!$error) {
991 $this->db->commit();
992 return 1;
993 } else {
994 $this->db->rollback();
995 return -2;
996 }
997 } else {
998 $this->db->rollback();
999 $this->error = $this->db->lasterror();
1000 return -1;
1001 }
1002 }
1003
1022 public function getObjectsInCateg($type, $onlyids = 0, $limit = 0, $offset = 0, $sortfield = '', $sortorder = 'ASC', $filter = '', $filtermode = 'AND', $filterlang = '')
1023 {
1024 global $user;
1025
1026 if (empty($onlyids)) {
1027 dol_syslog("getObjectsInCateg: This method used with parameter onlyids=0 is deprecated. Try by using instead getListForItem().", LOG_WARNING);
1028 }
1029
1030 $objs = array();
1031
1032 $classnameforobj = $this->MAP_OBJ_CLASS[$type];
1033 if (!empty($classnameforobj) && class_exists($classnameforobj)) {
1034 $tmpobj = new $classnameforobj($this->db);
1037 $sql = "SELECT c.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." as fk_object";
1038 $sql .= " FROM ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type])." as c";
1039 $sql .= ", ".MAIN_DB_PREFIX.(empty($this->MAP_OBJ_TABLE[$type]) ? $type : $this->MAP_OBJ_TABLE[$type])." as o";
1040 if (!empty($filterlang)) {
1041 $sql .= ", ".MAIN_DB_PREFIX.(empty($this->MAP_OBJ_TABLE[$type]) ? $type : $this->MAP_OBJ_TABLE[$type])."_lang as ol";
1042 }
1043 $sql .= " WHERE o.entity IN (".getEntity($tmpobj->element).")";
1044 $sql .= " AND c.fk_categorie = ".((int) $this->id);
1045 // Compatibility with actioncomm table which has id instead of rowid
1046 if ((array_key_exists($type, $this->MAP_OBJ_TABLE) && $this->MAP_OBJ_TABLE[$type] == "actioncomm") || $type == "actioncomm") {
1047 $sql .= " AND c.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = o.id";
1048 } else {
1049 $sql .= " AND c.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = o.rowid";
1050 }
1051 if (!empty($filterlang)) {
1052 $sql .= " AND ol.fk_".(empty($this->MAP_OBJ_TABLE[$type]) ? $type : $this->MAP_OBJ_TABLE[$type])." = o.rowid";
1053 $sql .= " AND ol.lang = '".$this->db->escape($filterlang)."'";
1054 }
1055 // Protection for external users
1056 if (($type == 'customer' || $type == 'supplier') && $user->socid > 0) {
1057 $sql .= " AND o.rowid = ".((int) $user->socid);
1058 }
1059
1060 // Add where from hooks (for example to restrict to objects an external module shares
1061 // with the current entity by a granularity finer than this category's own)
1062 global $hookmanager;
1063 if (is_object($hookmanager)) {
1064 $parameters = array('type' => $type, 'alias' => 'o');
1065 $reshook = $hookmanager->executeHooks('printFieldListWhere', $parameters, $this);
1066 $sql .= $hookmanager->resPrint;
1067 }
1068
1069 $errormessage = '';
1070 $sql .= forgeSQLFromUniversalSearchCriteria($filter, $errormessage);
1071 if ($errormessage) {
1072 $this->errors[] = $errormessage;
1073 dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
1074 return -1;
1075 }
1076
1077 $sql .= $this->db->order($sortfield, $sortorder);
1078 if ($limit > 0 || $offset > 0) {
1079 $sql .= $this->db->plimit($limit + 1, $offset);
1080 }
1081
1082 dol_syslog(get_class($this)."::getObjectsInCateg", LOG_DEBUG);
1083
1084 $resql = $this->db->query($sql);
1085 if ($resql) {
1086 while ($rec = $this->db->fetch_array($resql)) {
1087 if ($onlyids) {
1088 $objs[] = $rec['fk_object'];
1089 } else {
1090 $tmpobj = new $classnameforobj($this->db);
1091 $tmpobj->fetch($rec['fk_object']); // The fetch will set $tmpobj->id only if it succeed.
1092 // @phpstan-ignore-next-line
1093 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.
1094 $objs[] = $tmpobj;
1095 }
1096 }
1097 }
1098 } else {
1099 $this->error = $this->db->error().' sql='.$sql;
1100 return -1;
1101 }
1102 }
1103
1104 return $objs;
1105 }
1106
1115 public function containsObject($type, $object_id)
1116 {
1117 $sql = "SELECT COUNT(*) as nb FROM ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type]);
1118 $sql .= " WHERE fk_categorie = ".((int) $this->id)." AND fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = ".((int) $object_id);
1119
1120 dol_syslog(get_class($this)."::containsObject", LOG_DEBUG);
1121
1122 $resql = $this->db->query($sql);
1123 if ($resql) {
1124 return $this->db->fetch_object($resql)->nb;
1125 } else {
1126 $this->error = $this->db->error();
1127 return -1;
1128 }
1129 }
1130
1143 public function getListForItem($id, $type = 'customer', $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0)
1144 {
1145 $categories = array();
1146
1147 $type = sanitizeVal($type, 'aZ09');
1148
1149 $sub_type = $type;
1150 $subcol_name = "fk_".$type;
1151 if ($type == "customer") {
1152 $sub_type = "societe";
1153 $subcol_name = "fk_soc";
1154 }
1155 if ($type == "supplier") {
1156 $sub_type = "fournisseur";
1157 $subcol_name = "fk_soc";
1158 }
1159 if ($type == "contact") {
1160 $subcol_name = "fk_socpeople";
1161 }
1162
1163 $idoftype = (int) (array_key_exists($type, $this->MAP_ID) ? $this->MAP_ID[$type] : -1);
1164
1165 $sql = "SELECT s.rowid";
1166 $sqlfields = $sql; // $sql fields to remove for count total
1167 $sql .= " FROM ".MAIN_DB_PREFIX."categorie as s, ".MAIN_DB_PREFIX."categorie_".$this->db->sanitize($sub_type)." as sub";
1168 $sql .= ' WHERE s.entity IN ('.getEntity('category').')';
1169 $sql .= ' AND s.type = '.((int) $idoftype);
1170 $sql .= ' AND s.rowid = sub.fk_categorie';
1171 $sql .= " AND sub.".$this->db->sanitize($subcol_name)." = ".((int) $id);
1172
1173 $offset = 0;
1174 $nbtotalofrecords = '';
1175 if (!getDolGlobalInt('MAIN_DISABLE_FULL_SCANLIST')) {
1176 $sqlforcount = preg_replace('/^'.preg_quote($sqlfields, '/').'/', 'SELECT COUNT(*) as nbtotalofrecords', $sql);
1177 $sqlforcount = preg_replace('/GROUP BY .*$/', '', $sqlforcount);
1178
1179 $resql = $this->db->query($sqlforcount);
1180 if ($resql) {
1181 $objforcount = $this->db->fetch_object($resql);
1182 $nbtotalofrecords = $objforcount->nbtotalofrecords;
1183 } else {
1184 dol_print_error($this->db);
1185 }
1186
1187 if (($limit >= (int) $nbtotalofrecords) && $page > 0) {
1188 return [];
1189 }
1190
1191 if (($page * $limit) >= (int) $nbtotalofrecords) { // if total resultset is smaller or equal then paging size (filtering), goto and load page 0
1192 $page = 0;
1193 $offset = 0;
1194 }
1195 $this->db->free($resql);
1196 }
1197
1198 $sql .= $this->db->order($sortfield, $sortorder);
1199 if ($limit) {
1200 if ($page < 0) {
1201 $page = 0;
1202 }
1203 $offset = $limit * $page;
1204
1205 $sql .= $this->db->plimit($limit + 1, $offset);
1206 }
1207
1208 $result = $this->db->query($sql);
1209 if ($result) {
1210 $i = 0;
1211 $num = $this->db->num_rows($result);
1212 $min = min($num, ($limit <= 0 ? $num : $limit));
1213 while ($i < $min) {
1214 $obj = $this->db->fetch_object($result);
1215 $category_static = new Categorie($this->db);
1216 if ($category_static->fetch($obj->rowid)) {
1217 $categories[$i]['id'] = $category_static->id;
1218 $categories[$i]['fk_parent'] = $category_static->fk_parent;
1219 $categories[$i]['label'] = $category_static->label;
1220 $categories[$i]['description'] = $category_static->description;
1221 $categories[$i]['color'] = $category_static->color;
1222 $categories[$i]['position'] = $category_static->position;
1223 $categories[$i]['socid'] = $category_static->socid;
1224 $categories[$i]['ref_ext'] = $category_static->ref_ext;
1225 $categories[$i]['visible'] = $category_static->visible;
1226 $categories[$i]['type'] = $category_static->type;
1227 $categories[$i]['entity'] = $category_static->entity;
1228 $categories[$i]['array_options'] = $category_static->array_options;
1229
1230 // multilangs
1231 if (getDolGlobalInt('MAIN_MULTILANGS') && isset($category_static->multilangs)) {
1232 $categories[$i]['multilangs'] = $category_static->multilangs;
1233 }
1234 }
1235 $i++;
1236 }
1237 } else {
1238 $this->error = $this->db->lasterror();
1239 return -1;
1240 }
1241 if (!count($categories)) {
1242 return [];
1243 }
1244
1245 return $categories;
1246 }
1247
1248 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1254 public function get_filles()
1255 {
1256 // phpcs:enable
1257 $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."categorie";
1258 $sql .= " WHERE fk_parent = ".((int) $this->id);
1259 $sql .= " AND entity IN (".getEntity('category').")";
1260
1261 $res = $this->db->query($sql);
1262 if ($res) {
1263 $cats = array();
1264 while ($rec = $this->db->fetch_array($res)) {
1265 $cat = new Categorie($this->db);
1266 $cat->fetch($rec['rowid']);
1267 $cats[] = $cat;
1268 }
1269 return $cats;
1270 } else {
1271 dol_print_error($this->db);
1272 return -1;
1273 }
1274 }
1275
1276 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1283 protected function load_motherof()
1284 {
1285 // phpcs:enable
1286 $this->motherof = array();
1287
1288 // Load array[child]=parent
1289 $sql = "SELECT fk_parent as id_parent, rowid as id_son";
1290 $sql .= " FROM ".MAIN_DB_PREFIX."categorie";
1291 $sql .= " WHERE fk_parent <> 0";
1292 $sql .= " AND entity IN (".getEntity('category').")";
1293
1294 dol_syslog(get_class($this)."::load_motherof", LOG_DEBUG);
1295 $resql = $this->db->query($sql);
1296 if ($resql) {
1297 while ($obj = $this->db->fetch_object($resql)) {
1298 $this->motherof[$obj->id_son] = $obj->id_parent;
1299 }
1300 return 1;
1301 } else {
1302 dol_print_error($this->db);
1303 return -1;
1304 }
1305 }
1306
1307 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1328 public function get_full_arbo($type, $fromid = 0, $include = 0, $forcelangcode = '')
1329 {
1330 // phpcs:enable
1331 global $langs;
1332
1333 if (!is_numeric($type)) {
1334 $type = $this->MAP_ID[$type];
1335 }
1336 if (is_null($type)) {
1337 $this->error = 'BadValueForParameterType';
1338 return -1;
1339 }
1340
1341 if (is_string($fromid)) {
1342 $fromid = explode(',', $fromid);
1343 } elseif (is_numeric($fromid)) {
1344 if ($fromid > 0) {
1345 $fromid = array($fromid);
1346 } else {
1347 $fromid = array();
1348 }
1349 } elseif (!is_array($fromid)) {
1350 $fromid = array();
1351 }
1352
1353 $this->cats = array();
1354 $nbcateg = 0;
1355
1356 // Init this->motherof that is array(id_son=>id_parent, ...)
1357 $this->load_motherof();
1358
1359 if ($forcelangcode) {
1360 $current_lang = $forcelangcode;
1361 } else {
1362 $current_lang = $langs->getDefaultLang();
1363 }
1364
1365 // Init $this->cats array
1366 // Note: The DISTINCT reduces pb with old tables with duplicates but should not be used
1367 $sql = "SELECT DISTINCT c.rowid, c.label, c.ref_ext, c.description, c.color, c.position, c.fk_parent, c.visible, c.entity";
1368 if (getDolGlobalInt('MAIN_MULTILANGS') && $current_lang !== 'none') {
1369 $sql .= ", t.label as label_trans, t.description as description_trans";
1370 }
1371 $sql .= " FROM ".MAIN_DB_PREFIX."categorie as c";
1372 if (getDolGlobalInt('MAIN_MULTILANGS') && $current_lang !== 'none') {
1373 $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."categorie_lang as t ON t.fk_category = c.rowid AND t.lang = '".$this->db->escape($current_lang)."'";
1374 }
1375 $sql .= " WHERE c.entity IN (".getEntity('category').")";
1376 $sql .= " AND c.type = ".(int) $type;
1377
1378 dol_syslog(get_class($this)."::get_full_arbo get category list", LOG_DEBUG);
1379
1380 $resql = $this->db->query($sql);
1381 if ($resql) {
1382 $i = 0;
1383 $nbcateg = $this->db->num_rows($resql);
1384
1385 while ($obj = $this->db->fetch_object($resql)) {
1386 $this->cats[(int) $obj->rowid]
1387 = array(
1388 'rowid' => (int) $obj->rowid,
1389 'id' => (int) $obj->rowid,
1390 'fk_parent' => (int) $obj->fk_parent,
1391 'label' => !empty($obj->label_trans) ? (string) $obj->label_trans : (string) $obj->label,
1392 'description' => !empty($obj->description_trans) ? (string) $obj->description_trans : (string) $obj->description,
1393 'color' => (string) $obj->color,
1394 'position' => (string) $obj->position,
1395 'visible' => (int) $obj->visible,
1396 'ref_ext' => (string) $obj->ref_ext,
1397 'entity' => (int) $obj->entity,
1398 'picto' => 'category',
1399 // fields are filled with buildPathFromId later
1400 'fullpath' => '',
1401 'fulllabel' => '',
1402 'level' => null,
1403 );
1404 $i++;
1405 }
1406 } else {
1407 dol_print_error($this->db);
1408 return -1;
1409 }
1410
1411 // Let external modules complete or filter the tree (for example to restrict categories
1412 // coming from other entities according to a sharing granularity they manage)
1413 global $hookmanager;
1414 if (is_object($hookmanager)) {
1415 $parameters = array('cats' => &$this->cats, 'motherof' => &$this->motherof, 'type' => $type);
1416 $reshook = $hookmanager->executeHooks('completeCategoryFullTree', $parameters, $this);
1417 if ($reshook < 0) {
1418 setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
1419 }
1420 }
1421
1422 // We add the fullpath property to each elements of first level (no parent exists)
1423 dol_syslog(get_class($this)."::get_full_arbo call to buildPathFromId", LOG_DEBUG);
1424
1425 foreach ($this->cats as $key => $val) {
1426 //print 'key='.$key.'<br>'."\n";
1427 $this->buildPathFromId($key, $nbcateg); // Process a branch from the root category key (this category has no parent) and adds level to $this->cats items
1428 }
1429
1430 // Include or exclude leaf (including $fromid) from tree
1431 if (count($fromid) > 0) {
1432 $keyfiltercatid = '('.implode('|', $fromid).')';
1433
1434 //print "Look to discard category ".$fromid."\n";
1435 $keyfilter1 = '^'.$keyfiltercatid.'$';
1436 $keyfilter2 = '_'.$keyfiltercatid.'$';
1437 $keyfilter3 = '^'.$keyfiltercatid.'_';
1438 $keyfilter4 = '_'.$keyfiltercatid.'_';
1439 foreach (array_keys($this->cats) as $key) {
1440 $fullpath = (string) $this->cats[$key]['fullpath'];
1441 $test = (preg_match('/'.$keyfilter1.'/', $fullpath) || preg_match('/'.$keyfilter2.'/', $fullpath)
1442 || preg_match('/'.$keyfilter3.'/', $fullpath) || preg_match('/'.$keyfilter4.'/', $fullpath));
1443
1444 if (($test && !$include) || (!$test && $include)) {
1445 unset($this->cats[$key]); // @phpstan-ignore-line
1446 }
1447 }
1448 }
1449
1450 dol_syslog(get_class($this)."::get_full_arbo dol_sort_array", LOG_DEBUG);
1451
1452 $this->cats = dol_sort_array($this->cats, 'fulllabel', 'asc', 1, 0, 1); // Sort on full label like "Label 1 >> Sublabel a >> Subsublabel"
1453
1454 return $this->cats;
1455 }
1456
1467 private function buildPathFromId($id_categ, $protection = 1000)
1468 {
1469 //dol_syslog(get_class($this)."::buildPathFromId id_categ=".$id_categ." protection=".$protection, LOG_DEBUG);
1470
1471 if (!empty($this->cats[$id_categ]['fullpath'])) {
1472 // Already defined
1473 dol_syslog(get_class($this)."::buildPathFromId fullpath and fulllabel already defined", LOG_WARNING);
1474 return -1;
1475 }
1476
1477 // $this->cats[$id_categ] is supposed to be already an array. We just want to complete it with property fullpath and fulllabel
1478
1479 // Define fullpath and fulllabel
1480 $this->cats[$id_categ]['fullpath'] = '_'.$id_categ;
1481 $this->cats[$id_categ]['fulllabel'] = $this->cats[$id_categ]['label'];
1482 $i = 0;
1483 $cursor_categ = $id_categ;
1484 //print 'Work for id_categ='.$id_categ.'<br>'."\n";
1485 while ((empty($protection) || $i < $protection) && !empty($this->motherof[$cursor_categ])) {
1486 //print '&nbsp; cursor_categ='.$cursor_categ.' i='.$i.' '.$this->motherof[$cursor_categ].'<br>'."\n";
1487 $this->cats[$id_categ]['fullpath'] = '_'.$this->motherof[$cursor_categ].$this->cats[$id_categ]['fullpath'];
1488 $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'];
1489 //print '&nbsp; Result for id_categ='.$id_categ.' : '.$this->cats[$id_categ]['fullpath'].' '.$this->cats[$id_categ]['fulllabel'].'<br>'."\n";
1490 $i++;
1491 $cursor_categ = $this->motherof[$cursor_categ];
1492 }
1493 //print 'Result for id_categ='.$id_categ.' : '.$this->cats[$id_categ]['fullpath'].'<br>'."\n";
1494
1495 // We count number of _ to have level
1496 $nbunderscore = substr_count($this->cats[$id_categ]['fullpath'], '_');
1497 $this->cats[$id_categ]['level'] = ($nbunderscore ? $nbunderscore : null);
1498
1499 return 1;
1500 }
1501
1502
1503 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1511 public function get_all_categories($type = null, $parent = false)
1512 {
1513 // phpcs:enable
1514 if (!is_numeric($type) && !is_null($type)) {
1515 $type = $this->MAP_ID[$type];
1516 }
1517
1518 $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."categorie";
1519 $sql .= " WHERE entity IN (".getEntity('category').")";
1520 if (!is_null($type)) {
1521 $sql .= " AND type = ".(int) $type;
1522 }
1523 if ($parent) {
1524 $sql .= " AND fk_parent = 0";
1525 }
1526
1527 $res = $this->db->query($sql);
1528 if ($res) {
1529 $cats = array();
1530 while ($rec = $this->db->fetch_array($res)) {
1531 $cat = new Categorie($this->db);
1532 $cat->fetch($rec['rowid']);
1533 $cats[$rec['rowid']] = $cat;
1534 }
1535 return $cats;
1536 } else {
1537 dol_print_error($this->db);
1538 return -1;
1539 }
1540 }
1541
1542 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1549 public function get_main_categories($type = null)
1550 {
1551 // phpcs:enable
1552 return $this->get_all_categories($type, true);
1553 }
1554
1555 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1561 public function already_exists()
1562 {
1563 // phpcs:enable
1564 $type = $this->type;
1565
1566 if (!is_numeric($type)) {
1567 $type = $this->MAP_ID[$type];
1568 }
1569
1570 /* We have to select any rowid from llx_categorie which category's mother and label
1571 * are equals to those of the calling category
1572 */
1573 $sql = "SELECT c.rowid";
1574 $sql .= " FROM ".MAIN_DB_PREFIX."categorie as c ";
1575 $sql .= " WHERE c.entity IN (".getEntity('category').")";
1576 $sql .= " AND c.type = ".((int) $type);
1577 $sql .= " AND c.fk_parent = ".((int) $this->fk_parent);
1578 $sql .= " AND c.label = '".$this->db->escape($this->label)."'";
1579
1580 dol_syslog(get_class($this)."::already_exists", LOG_DEBUG);
1581
1582 $resql = $this->db->query($sql);
1583 if ($resql) {
1584 if ($this->db->num_rows($resql) > 0) { // Checking for empty resql
1585 $obj = $this->db->fetch_object($resql);
1586 /* If object called create, obj cannot have is id.
1587 * If object called update, he mustn't have the same label as an other category for this mother.
1588 * 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.
1589 */
1590 if (!empty($obj) && $obj->rowid > 0 && $obj->rowid != $this->id) {
1591 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);
1592 return 1;
1593 }
1594 }
1595 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);
1596 return 0;
1597 } else {
1598 $this->error = $this->db->error();
1599 return -1;
1600 }
1601 }
1602
1603
1604 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1616 public function print_all_ways($sep = 'auto', $url = '', $nocolor = 0, $addpicto = 0, $notrunc = 0)
1617 {
1618 // phpcs:enable
1619 $ways = array();
1620
1621 if ($sep == 'auto') {
1622 $sep = '&gt;';
1623 }
1624
1625 $all_ways = $this->get_all_ways(); // Load array of categories from database to reach this->id
1626
1627 foreach ($all_ways as $way) { // It seems we always have 1 entry in this array.
1628 $w = array();
1629 $i = 0;
1630 $forced_color = '';
1631 foreach ($way as $cat) { // Loop on each successive categories to reach the target of current category
1632 $i++;
1633
1634 if (empty($nocolor)) {
1635 $forced_color = 'colortoreplace';
1636 if ($i == count($way)) { // Last category in hierarchy
1637 // Check contrast with background and correct text color
1638 $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.
1639 if ($cat->color && colorIsLight($cat->color)) {
1640 $forced_color = 'categtextblack';
1641 }
1642 }
1643 }
1644
1645 if ($url == '') {
1646 if (($i < count($way) && empty($notrunc)) && $i > 1) {
1647 $link = '';
1648 $linkend = '';
1649 } else {
1650 $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.'">';
1651 $linkend = '</a>';
1652 }
1653 $s = $link.(($addpicto && $i == 1) ? img_object('', 'category', 'class="paddingright"') : '');
1654 $s .= (($i < count($way) && empty($notrunc)) ? ($i == 1 ? dol_trunc($cat->label, 3) : '') : $cat->label);
1655 $s .= $linkend;
1656 $w[] = $s;
1657 } elseif ($url == 'none') {
1658 if (($i < count($way) && empty($notrunc)) && $i > 1) {
1659 $link = '';
1660 $linkend = '';
1661 } else {
1662 $link = '<span class="valignmiddle '.($i < count($way) ? 'small ' : '').$forced_color.'">';
1663 $linkend = '</span>';
1664 }
1665 $s = $link.(($addpicto && $i == 1) ? img_object('', 'category', 'class="paddingright"') : '');
1666 $s .= (($i < count($way) && empty($notrunc)) ? ($i == 1 ? dol_trunc($cat->label, 3) : '') : $cat->label);
1667 $s .= $linkend;
1668 $w[] = $s;
1669 } else {
1670 $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>';
1671 }
1672 }
1673 $newcategwithpath = preg_replace('/colortoreplace/', $forced_color, implode('<span class="inline-block valignmiddle paddingleft paddingright small '.$forced_color.'">'.$sep.'</span>', $w));
1674
1675 $ways[] = $newcategwithpath;
1676 }
1677
1678 return $ways;
1679 }
1680
1681
1682 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1689 public function get_meres()
1690 {
1691 // phpcs:enable
1692 $parents = array();
1693
1694 $sql = "SELECT fk_parent FROM ".MAIN_DB_PREFIX."categorie";
1695 $sql .= " WHERE rowid = ".((int) $this->id);
1696
1697 $res = $this->db->query($sql);
1698
1699 if ($res) {
1700 while ($rec = $this->db->fetch_array($res)) {
1701 if ($rec['fk_parent'] > 0) {
1702 $cat = new Categorie($this->db);
1703 $cat->fetch($rec['fk_parent']);
1704 $parents[] = $cat;
1705 }
1706 }
1707 return $parents;
1708 } else {
1709 dol_print_error($this->db);
1710 return -1;
1711 }
1712 }
1713
1714 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1721 public function get_all_ways()
1722 {
1723 // phpcs:enable
1724 $ways = array();
1725
1726 $parents = $this->get_meres();
1727 if (is_array($parents)) {
1728 foreach ($parents as $parent) {
1729 $all_ways = $parent->get_all_ways(); // recursivity. TODO Add a protection for infinite loop
1730 foreach ($all_ways as $way) {
1731 $w = $way;
1732 $w[] = $this;
1733 $ways[] = $w;
1734 }
1735 }
1736 }
1737
1738 if (count($ways) == 0) {
1739 $ways[0][0] = $this;
1740 }
1741
1742 return $ways;
1743 }
1744
1755 public function containing($id, $type, $mode = 'object')
1756 {
1757 $cats = array();
1758
1759 if (is_numeric($type)) {
1760 $type = array_search($type, $this->MAP_ID);
1761 }
1762
1763 if ($type === Categorie::TYPE_BANK_LINE) { // TODO Remove this after migration of llx_category_bankline into llx_categorie_bankline
1764 // Load bank categories
1765 $sql = "SELECT c.label, c.rowid";
1766 $sql .= " FROM ".MAIN_DB_PREFIX."category_bankline as a, ".MAIN_DB_PREFIX."categorie as c";
1767 $sql .= " WHERE a.lineid=".((int) $id)." AND a.fk_categ = c.rowid";
1768 $sql .= " AND c.entity IN (".getEntity('category').")";
1769 $sql .= " ORDER BY c.label";
1770
1771 $res = $this->db->query($sql);
1772 if ($res) {
1773 while ($obj = $this->db->fetch_object($res)) {
1774 if ($mode == 'id') {
1775 $cats[] = $obj->rowid;
1776 } elseif ($mode == 'label') {
1777 $cats[] = $obj->label;
1778 } else {
1779 $cat = new Categorie($this->db);
1780 $cat->id = $obj->rowid;
1781 $cat->label = $obj->label;
1782 $cats[] = $cat;
1783 }
1784 }
1785 } else {
1786 dol_print_error($this->db);
1787 return -1;
1788 }
1789 } else {
1790 $sql = "SELECT ct.fk_categorie, c.label, c.rowid";
1791 $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";
1792 $sql .= " WHERE ct.fk_categorie = c.rowid AND ct.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = ".(int) $id;
1793 // This seems useless because the table already contains id of category of 1 unique type. So commented.
1794 // So now it works also with external added categories.
1795 //$sql .= " AND c.type = ".((int) $this->MAP_ID[$type]);
1796 $sql .= " AND c.entity IN (".getEntity('category').")";
1797
1798 $res = $this->db->query($sql);
1799 if ($res) {
1800 while ($obj = $this->db->fetch_object($res)) {
1801 if ($mode == 'id') {
1802 $cats[] = $obj->rowid;
1803 } elseif ($mode == 'label') {
1804 $cats[] = $obj->label;
1805 } else {
1806 $cat = new Categorie($this->db);
1807 $cat->fetch($obj->fk_categorie);
1808 $cats[] = $cat;
1809 }
1810 }
1811 } else {
1812 dol_print_error($this->db);
1813 return -1;
1814 }
1815 }
1816
1817 return $cats;
1818 }
1819
1831 public function rechercher($id, $nom, $type, $exact = false, $case = false)
1832 {
1833 // Deprecation warning
1834 if (is_numeric($type)) {
1835 dol_syslog(__METHOD__.': using numeric types is deprecated.', LOG_WARNING);
1836 }
1837
1838 $cats = array();
1839
1840 // For backward compatibility
1841 if (is_numeric($type)) {
1842 // We want to reverse lookup
1843 $map_type = array_flip($this->MAP_ID);
1844 $type = $map_type[$type];
1845 dol_syslog(get_class($this)."::rechercher(): numeric types are deprecated, please use string instead", LOG_WARNING);
1846 }
1847
1848 // Generation requete recherche
1849 $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."categorie";
1850 $sql .= " WHERE type = ".((int) $this->MAP_ID[$type]);
1851 $sql .= " AND entity IN (".getEntity('category').")";
1852 if ($nom) {
1853 if (!$exact) {
1854 $nom = '%'.$this->db->escape(str_replace('*', '%', $nom)).'%';
1855 }
1856 if (!$case) {
1857 $sql .= " AND label LIKE '".$this->db->escape($nom)."'";
1858 } else {
1859 $sql .= " AND label LIKE BINARY '".$this->db->escape($nom)."'";
1860 }
1861 }
1862 if ($id) {
1863 $sql .= " AND rowid = ".((int) $id);
1864 }
1865
1866 $res = $this->db->query($sql);
1867 if ($res) {
1868 while ($rec = $this->db->fetch_array($res)) {
1869 $cat = new Categorie($this->db);
1870 $cat->fetch($rec['rowid']);
1871 $cats[] = $cat;
1872 }
1873
1874 return $cats;
1875 } else {
1876 $this->error = $this->db->error().' sql='.$sql;
1877 return -1;
1878 }
1879 }
1880
1887 public function isAnyPhotoAvailable($sdir)
1888 {
1889 include_once DOL_DOCUMENT_ROOT . '/core/lib/files.lib.php';
1890 include_once DOL_DOCUMENT_ROOT . '/core/lib/images.lib.php';
1891
1892 $sdir .= '/' . get_exdir($this->id, 2, 0, 0, $this, 'category') . $this->id . "/photos/";
1893
1894 $dir_osencoded = dol_osencode($sdir);
1895 if (file_exists($dir_osencoded)) {
1896 $handle = opendir($dir_osencoded);
1897 if (is_resource($handle)) {
1898 while (($file = readdir($handle)) !== false) {
1899 if (!utf8_check($file)) {
1900 $file = mb_convert_encoding($file, 'UTF-8', 'ISO-8859-1'); // To be sure data is stored in UTF8 in memory
1901 }
1902 if (dol_is_file($sdir . $file) && image_format_supported($file) >= 0) {
1903 return true;
1904 }
1905 }
1906 }
1907 }
1908 return false;
1909 }
1910
1917 public function getTooltipContentArray($params)
1918 {
1919 global $langs;
1920
1921 $langs->load('categories');
1922
1923 $datas = [];
1924
1925 $datas['label'] = $langs->trans("ShowCategory").': '.($this->ref ? $this->ref : $this->label);
1926
1927 return $datas;
1928 }
1929
1943 public function getNomUrl($withpicto = 0, $option = '', $maxlength = 0, $moreparam = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = 0)
1944 {
1945 global $conf, $langs, $hookmanager;
1946
1947 if (!empty($conf->dol_no_mouse_hover)) {
1948 $notooltip = 1; // Force disable tooltips
1949 }
1950
1951 $result = '';
1952 $params = [
1953 'id' => $this->id,
1954 'objecttype' => $this->element,
1955 'option' => $option,
1956 ];
1957 $classfortooltip = 'classfortooltip';
1958 $dataparams = '';
1959 if (getDolGlobalInt('MAIN_ENABLE_AJAX_TOOLTIP')) {
1960 $classfortooltip = 'classforajaxtooltip';
1961 $dataparams = ' data-params="'.dol_escape_htmltag(json_encode($params)).'"';
1962 $label = '';
1963 } else {
1964 $label = implode($this->getTooltipContentArray($params));
1965 }
1966
1967 $url = DOL_URL_ROOT.'/categories/viewcat.php?id='.$this->id.'&type='.$this->type.$moreparam.'&backtopage='.urlencode($_SERVER['PHP_SELF'].($moreparam ? '?'.$moreparam : ''));
1968
1969 if ($option !== 'nolink') {
1970 // Add param to save lastsearch_values or not
1971 $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
1972 if ($save_lastsearch_value == -1 && isset($_SERVER["PHP_SELF"]) && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
1973 $add_save_lastsearch_values = 1;
1974 }
1975 if (/* $url && */ $add_save_lastsearch_values) {
1976 $url .= '&save_lastsearch_values=1';
1977 }
1978 }
1979
1980 // Check contrast with background and correct text color
1981 $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.
1982 if ($this->color) {
1983 if (colorIsLight($this->color)) { // If color is light, we force color to dark
1984 $forced_color = 'categtextblack';
1985 }
1986 }
1987
1988 $linkclose = '';
1989 if (empty($notooltip)) {
1990 if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER')) {
1991 $label = $langs->trans("ShowCategory");
1992 $linkclose .= ' alt="'.dolPrintHTMLForAttribute($label).'"';
1993 }
1994 $linkclose .= ($label ? ' title="'.dolPrintHTMLForAttribute($label).'"' : ' title="tocomplete"');
1995 $linkclose .= $dataparams.' class="'.$classfortooltip.' '.$forced_color.($morecss ? ' '.$morecss : '').'"';
1996 } else {
1997 $linkclose = ' class="'.$forced_color.($morecss ? ' '.$morecss : '').'"';
1998 }
1999
2000 if ($option == 'nolink' /* || empty($url) */) {
2001 $linkstart = '<span';
2002 } else {
2003 $linkstart = '<a href="'.$url.'"';
2004 }
2005 $linkstart .= $linkclose.'>';
2006 if ($option == 'nolink' /* || empty($url) */) {
2007 $linkend = '</span>';
2008 } else {
2009 $linkend = '</a>';
2010 }
2011
2012 $result .= $linkstart;
2013
2014 if ($withpicto) {
2015 $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'"'), 0, 0, $notooltip ? 0 : 1);
2016 }
2017
2018 if ($withpicto != 2) {
2019 $result .= dol_trunc(($this->ref ? $this->ref : $this->label), $maxlength);
2020 }
2021
2022 $result .= $linkend;
2023
2024 global $action;
2025 $hookmanager->initHooks(array($this->element . 'dao'));
2026 $parameters = array('id' => $this->id, 'getnomurl' => &$result);
2027 $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
2028 if ($reshook > 0) {
2029 $result = $hookmanager->resPrint;
2030 } else {
2031 $result .= $hookmanager->resPrint;
2032 }
2033 return $result;
2034 }
2035
2036
2037 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2045 public function add_photo($sdir, $file)
2046 {
2047 // phpcs:enable
2048 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
2049
2050 $dir = $sdir.'/'.get_exdir($this->id, 2, 0, 0, $this, 'category').$this->id."/";
2051 $dir .= "photos/";
2052
2053 if (!file_exists($dir)) {
2054 dol_mkdir($dir);
2055 }
2056
2057 if (file_exists($dir)) {
2058 if (is_array($file['name'])) {
2059 $nbfile = count($file['name']);
2060 for ($i = 0; $i < $nbfile; $i++) {
2061 $originImage = $dir.$file['name'][$i];
2062
2063 // Cree fichier en taille origine
2064 dol_move_uploaded_file($file['tmp_name'][$i], $originImage, 1, 0, 0);
2065
2066 if (file_exists($originImage)) {
2067 // Create thumbs
2068 $this->addThumbs($originImage);
2069 }
2070 }
2071 } else {
2072 $originImage = $dir.$file['name'];
2073
2074 // Cree fichier en taille origine
2075 dol_move_uploaded_file($file['tmp_name'], $originImage, 1, 0, 0);
2076
2077 if (file_exists($originImage)) {
2078 // Create thumbs
2079 $this->addThumbs($originImage);
2080 }
2081 }
2082 }
2083 }
2084
2085 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2093 public function liste_photos($dir, $nbmax = 0)
2094 {
2095 // phpcs:enable
2096 include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
2097
2098 $nbphoto = 0;
2099 $tabobj = array();
2100
2101 $dirthumb = $dir.'thumbs/';
2102
2103 if (file_exists($dir)) {
2104 $handle = opendir($dir);
2105 if (is_resource($handle)) {
2106 while (($file = readdir($handle)) !== false) {
2107 if (dol_is_file($dir.$file) && preg_match('/(\.jpeg|\.jpg|\.bmp|\.gif|\.png|\.tiff)$/i', $dir.$file)) {
2108 $nbphoto++;
2109 $photo = $file;
2110
2111 // On determine nom du fichier vignette
2112 $photo_vignette = '';
2113 $regs = array();
2114 if (preg_match('/(\.jpeg|\.jpg|\.bmp|\.gif|\.png|\.tiff)$/i', $photo, $regs)) {
2115 $photo_vignette = preg_replace('/'.$regs[0].'/i', '', $photo).'_small'.$regs[0];
2116 }
2117
2118 // Object
2119 $obj = array();
2120 $obj['photo'] = $photo;
2121 if ($photo_vignette && is_file($dirthumb.$photo_vignette)) {
2122 $obj['photo_vignette'] = 'thumbs/'.$photo_vignette;
2123 } else {
2124 $obj['photo_vignette'] = "";
2125 }
2126
2127 $tabobj[$nbphoto - 1] = $obj;
2128
2129 // On continue ou on arrete de boucler
2130 if ($nbmax && $nbphoto >= $nbmax) {
2131 break;
2132 }
2133 }
2134 }
2135
2136 closedir($handle);
2137 }
2138 }
2139
2140 return $tabobj;
2141 }
2142
2143 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2150 public function delete_photo($file)
2151 {
2152 // phpcs:enable
2153 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
2154
2155 $dir = dirname($file).'/'; // Chemin du dossier contenant l'image d'origine
2156 $dirthumb = $dir.'/thumbs/'; // Chemin du dossier contenant la vignette
2157 $filename = preg_replace('/'.preg_quote($dir, '/').'/i', '', $file); // Nom du fichier
2158
2159 // On efface l'image d'origine
2160 dol_delete_file($file, 0); // do not use disableglob, ecmfiles will not be deleted
2161
2162 // Si elle existe, on efface la vignette
2163 $regs = array();
2164 if (preg_match('/(\.jpeg|\.jpg|\.bmp|\.gif|\.png|\.tiff)$/i', $filename, $regs)) {
2165 $photo_vignette = preg_replace('/'.$regs[0].'/i', '', $filename).'_small'.$regs[0];
2166 if (file_exists($dirthumb.$photo_vignette)) {
2167 dol_delete_file($dirthumb.$photo_vignette, 1);
2168 }
2169 }
2170 }
2171
2172 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
2179 public function get_image_size($file)
2180 {
2181 // phpcs:enable
2182 $infoImg = getimagesize($file); // Recuperation des infos de l'image
2183 $this->imgWidth = $infoImg[0]; // Largeur de l'image
2184 $this->imgHeight = $infoImg[1]; // Hauteur de l'image
2185 }
2186
2195 public function setMultiLangs(User $user, $notrigger = 0)
2196 {
2197 global $langs;
2198
2199 $langs_available = $langs->get_available_languages();
2200 $current_lang = $langs->getDefaultLang();
2201
2202 foreach ($langs_available as $key => $value) {
2203 $sql = "SELECT rowid";
2204 $sql .= " FROM ".MAIN_DB_PREFIX."categorie_lang";
2205 $sql .= " WHERE fk_category=".((int) $this->id);
2206 $sql .= " AND lang = '".$this->db->escape($key)."'";
2207
2208 $result = $this->db->query($sql);
2209
2210 if ($key == $current_lang) {
2211 $sql2 = '';
2212 if ($this->db->num_rows($result)) { // if there is already a description line for this language
2213 $sql2 = "UPDATE ".MAIN_DB_PREFIX."categorie_lang";
2214 $sql2 .= " SET label = '".$this->db->escape($this->label)."',";
2215 $sql2 .= " description = '".$this->db->escape($this->description)."'";
2216 $sql2 .= " WHERE fk_category = ".((int) $this->id)." AND lang = '".$this->db->escape($key)."'";
2217 } else { // if no line in database
2218 $sql2 = "INSERT INTO ".MAIN_DB_PREFIX."categorie_lang (fk_category, lang, label, description)";
2219 $sql2 .= " VALUES(".((int) $this->id).", '".$this->db->escape($key)."', '".$this->db->escape($this->label)."'";
2220 $sql2 .= ", '".$this->db->escape($this->description)."')";
2221 }
2222 dol_syslog(get_class($this).'::setMultiLangs', LOG_DEBUG);
2223 if (!$this->db->query($sql2)) {
2224 $this->error = $this->db->lasterror();
2225 return -1;
2226 }
2227 $this->multilangs[$key]["label"] = $this->label;
2228 $this->multilangs[$key]["description"] = $this->description;
2229 } elseif (isset($this->multilangs[$key])) { // if there is already a description line for this language
2230 if ($this->db->num_rows($result)) {
2231 $sql2 = "UPDATE ".MAIN_DB_PREFIX."categorie_lang";
2232 $sql2 .= " SET label='".$this->db->escape($this->multilangs[$key]["label"])."',";
2233 $sql2 .= " description='".$this->db->escape($this->multilangs[$key]["description"])."'";
2234 $sql2 .= " WHERE fk_category=".((int) $this->id)." AND lang='".$this->db->escape($key)."'";
2235 } else { // if no line in database
2236 $sql2 = "INSERT INTO ".MAIN_DB_PREFIX."categorie_lang (fk_category, lang, label, description)";
2237 $sql2 .= " VALUES(".((int) $this->id).", '".$this->db->escape($key)."', '".$this->db->escape($this->multilangs[$key]["label"])."'";
2238 $sql2 .= ",'".$this->db->escape($this->multilangs[$key]["description"])."')";
2239 }
2240
2241 // We do not save if main fields are empty
2242 if ($this->multilangs[$key]["label"] || $this->multilangs[$key]["description"]) {
2243 dol_syslog(get_class($this).'::setMultiLangs', LOG_DEBUG);
2244 }
2245 if (!$this->db->query($sql2)) {
2246 $this->error = $this->db->lasterror();
2247 return -1;
2248 }
2249 }
2250 }
2251
2252 // Call trigger
2253 if (!$notrigger) {
2254 $result = $this->call_trigger('CATEGORY_SET_MULTILANGS', $user);
2255 if ($result < 0) {
2256 $this->error = $this->db->lasterror();
2257 return -1;
2258 }
2259 }
2260 // End call triggers
2261
2262 return 1;
2263 }
2264
2274 public function delMultiLangs($langtodelete, $user, $notrigger = 0)
2275 {
2276 $sql = "DELETE FROM ".$this->db->prefix()."categorie_lang";
2277 $sql .= " WHERE fk_category = ".((int) $this->id)." AND lang = '".$this->db->escape($langtodelete)."'";
2278
2279 dol_syslog(get_class($this).'::delMultiLangs', LOG_DEBUG);
2280 $result = $this->db->query($sql);
2281 if ($result) {
2282 if (empty($notrigger)) {
2283 // Call trigger
2284 $result = $this->call_trigger('CATEGORY_DEL_MULTILANGS', $user);
2285 if ($result < 0) {
2286 $this->error = $this->db->lasterror();
2287 dol_syslog(get_class($this).'::delMultiLangs error='.$this->error, LOG_ERR);
2288 return -1;
2289 }
2290 // End call triggers
2291 }
2292 return 1;
2293 } else {
2294 $this->error = $this->db->lasterror();
2295 dol_syslog(get_class($this).'::delMultiLangs error='.$this->error, LOG_ERR);
2296 return -1;
2297 }
2298 }
2299
2305 public function getMultiLangs()
2306 {
2307 global $langs;
2308
2309 $current_lang = $langs->getDefaultLang();
2310
2311 $sql = "SELECT lang, label, description";
2312 $sql .= " FROM ".MAIN_DB_PREFIX."categorie_lang";
2313 $sql .= " WHERE fk_category=".((int) $this->id);
2314
2315 $result = $this->db->query($sql);
2316 if ($result) {
2317 while ($obj = $this->db->fetch_object($result)) {
2318 //print 'lang='.$obj->lang.' current='.$current_lang.'<br>';
2319 if ($obj->lang == $current_lang) { // si on a les traduct. dans la langue courante on les charge en infos principales.
2320 $this->label = $obj->label;
2321 $this->description = $obj->description;
2322 }
2323 $this->multilangs[$obj->lang]["label"] = $obj->label;
2324 $this->multilangs[$obj->lang]["description"] = $obj->description;
2325 }
2326 return 1;
2327 } else {
2328 $this->error = $langs->trans("Error")." : ".$this->db->error()." - ".$sql;
2329 return -1;
2330 }
2331 }
2332
2339 public function getLibStatut($mode)
2340 {
2341 return '';
2342 }
2343
2344
2352 public function initAsSpecimen()
2353 {
2354 dol_syslog(get_class($this)."::initAsSpecimen");
2355
2356 // Initialise parameters
2357 $this->id = 0;
2358 $this->fk_parent = 0;
2359 $this->label = 'SPECIMEN';
2360 $this->specimen = 1;
2361 $this->description = 'This is a description';
2362 $this->socid = 1;
2363 $this->type = self::TYPE_PRODUCT;
2364
2365 return 1;
2366 }
2367
2376 public static function replaceThirdparty(DoliDB $dbs, $origin_id, $dest_id)
2377 {
2378 $tables = array(
2379 'categorie_societe'
2380 );
2381
2382 return CommonObject::commonReplaceThirdparty($dbs, $origin_id, $dest_id, $tables, 1);
2383 }
2384
2393 public static function getFilterJoinQuery($type, $rowIdName)
2394 {
2395 if ($type == 'bank_account') {
2396 $type = 'account';
2397 }
2398
2399 return " LEFT JOIN ".MAIN_DB_PREFIX."categorie_".$type." as cp ON ".$rowIdName." = cp.fk_".$type;
2400 }
2401
2411 public static function getFilterSelectQuery($type, $rowIdName, $searchList)
2412 {
2413 if ($type == 'bank_account') {
2414 $type = 'account';
2415 }
2416 if ($type == 'customer') {
2417 $type = 'societe';
2418 }
2419 if ($type == 'supplier') {
2420 $type = 'fournisseur';
2421 }
2422
2423 if (empty($searchList) && !is_array($searchList)) {
2424 return "";
2425 }
2426
2427 $searchCategorySqlList = array();
2428 foreach ($searchList as $searchCategory) {
2429 if (intval($searchCategory) == -2) {
2430 $searchCategorySqlList[] = " cp.fk_categorie IS NULL";
2431 } elseif (intval($searchCategory) > 0) {
2432 $searchCategorySqlList[] = " ".$rowIdName." IN (SELECT fk_".$type." FROM ".MAIN_DB_PREFIX."categorie_".$type." WHERE fk_categorie = ".((int) $searchCategory).")";
2433 }
2434 }
2435
2436 if (!empty($searchCategorySqlList)) {
2437 return " AND (".implode(' AND ', $searchCategorySqlList).")";
2438 } else {
2439 return "";
2440 }
2441 }
2442
2448 public function countNbOfCategories()
2449 {
2450 dol_syslog(get_class($this)."::count_all_categories", LOG_DEBUG);
2451 $sql = "SELECT COUNT(rowid) FROM ".MAIN_DB_PREFIX."categorie";
2452 $sql .= " WHERE entity IN (".getEntity('category').")";
2453
2454 $res = $this->db->query($sql);
2455 if ($res) {
2456 $obj = $this->db->fetch_object($res);
2457 return $obj->count;
2458 } else {
2459 dol_print_error($this->db);
2460 return -1;
2461 }
2462 }
2463}
$propal type
'integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]',...
Definition propal.php:280
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, $notrigger=0)
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',....
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_type($obj, $type='', $notrigger=0)
Link an object to the 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)
image_format_supported($file, $acceptsvg=0)
Return if a filename is file name of a supported image format.