| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058 |
- <?php
- /* Copyright (C) 2005 Matthieu Valleton <mv@seeschloss.org>
- * Copyright (C) 2005 Davoleau Brice <brice.davoleau@gmail.com>
- * Copyright (C) 2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
- * Copyright (C) 2006-2012 Regis Houssin <regis.houssin@inodbox.com>
- * Copyright (C) 2006-2012 Laurent Destailleur <eldy@users.sourceforge.net>
- * Copyright (C) 2007 Patrick Raguin <patrick.raguin@gmail.com>
- * Copyright (C) 2013-2016 Juanjo Menent <jmenent@2byte.es>
- * Copyright (C) 2013-2018 Philippe Grand <philippe.grand@atoo-net.com>
- * Copyright (C) 2015 Marcos García <marcosgdf@gmail.com>
- * Copyright (C) 2015 Raphaël Doursenaud <rdoursenaud@gpcsolutions.fr>
- * Copyright (C) 2016 Charlie Benke <charlie@patas-monkey.com>
- * Copyright (C) 2018-2022 Frédéric France <frederic.france@netlogic.fr>
- * Copyright (C) 2023 Benjamin Falière <benjamin.faliere@altairis.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <https://www.gnu.org/licenses/>.
- */
- /**
- * \file htdocs/categories/class/categorie.class.php
- * \ingroup categorie
- * \brief File of class to manage categories
- */
- require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
- require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
- require_once DOL_DOCUMENT_ROOT.'/ticket/class/ticket.class.php';
- require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.class.php';
- require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
- require_once DOL_DOCUMENT_ROOT.'/knowledgemanagement/class/knowledgerecord.class.php';
- /**
- * Class to manage categories
- */
- class Categorie extends CommonObject
- {
- // Categories types (we use string because we want to accept any modules/types in a future)
- const TYPE_PRODUCT = 'product';
- const TYPE_SUPPLIER = 'supplier';
- const TYPE_CUSTOMER = 'customer';
- const TYPE_MEMBER = 'member';
- const TYPE_CONTACT = 'contact';
- const TYPE_USER = 'user';
- const TYPE_PROJECT = 'project';
- const TYPE_ACCOUNT = 'bank_account';
- const TYPE_BANK_LINE = 'bank_line';
- const TYPE_WAREHOUSE = 'warehouse';
- const TYPE_ACTIONCOMM = 'actioncomm';
- const TYPE_WEBSITE_PAGE = 'website_page';
- const TYPE_TICKET = 'ticket';
- const TYPE_KNOWLEDGEMANAGEMENT = 'knowledgemanagement';
- /**
- * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
- */
- public $picto = 'category';
- /**
- * @var array Table of mapping between type string and ID used for field 'type' in table llx_categories
- */
- protected $MAP_ID = array(
- 'product' => 0,
- 'supplier' => 1,
- 'customer' => 2,
- 'member' => 3,
- 'contact' => 4,
- 'bank_account' => 5,
- 'project' => 6,
- 'user' => 7,
- 'bank_line' => 8,
- 'warehouse' => 9,
- 'actioncomm' => 10,
- 'website_page' => 11,
- 'ticket' => 12,
- 'knowledgemanagement' => 13
- );
- /**
- * @var array Code mapping from ID
- *
- * @note This array should be removed in future, once previous constants are moved to the string value. Deprecated
- */
- public static $MAP_ID_TO_CODE = array(
- 0 => 'product',
- 1 => 'supplier',
- 2 => 'customer',
- 3 => 'member',
- 4 => 'contact',
- 5 => 'bank_account',
- 6 => 'project',
- 7 => 'user',
- 8 => 'bank_line',
- 9 => 'warehouse',
- 10 => 'actioncomm',
- 11 => 'website_page',
- 12 => 'ticket',
- 13 => 'knowledgemanagement'
- );
- /**
- * @var array Foreign keys mapping from type string when value does not match
- *
- * @todo Move to const array when PHP 5.6 will be our minimum target
- */
- public $MAP_CAT_FK = array(
- 'customer' => 'soc',
- 'supplier' => 'soc',
- 'contact' => 'socpeople',
- 'bank_account' => 'account',
- );
- /**
- * @var array Category tables mapping from type string (llx_categorie_...) when value does not match
- *
- * @note Move to const array when PHP 5.6 will be our minimum target
- */
- public $MAP_CAT_TABLE = array(
- 'customer' => 'societe',
- 'supplier' => 'fournisseur',
- 'bank_account'=> 'account',
- );
- /**
- * @var array Object class mapping from type string
- *
- * @note Move to const array when PHP 5.6 will be our minimum target
- */
- public $MAP_OBJ_CLASS = array(
- 'product' => 'Product',
- 'customer' => 'Societe',
- 'supplier' => 'Fournisseur',
- 'member' => 'Adherent',
- 'contact' => 'Contact',
- 'user' => 'User',
- 'account' => 'Account', // old for bank account
- 'bank_account' => 'Account',
- 'project' => 'Project',
- 'warehouse'=> 'Entrepot',
- 'actioncomm' => 'ActionComm',
- 'website_page' => 'WebsitePage',
- 'ticket' => 'Ticket',
- 'knowledgemanagement' => 'KnowledgeRecord'
- );
- /**
- * @var array Title Area mapping from type string
- *
- * @note Move to const array when PHP 5.6 will be our minimum target
- */
- public static $MAP_TYPE_TITLE_AREA = array(
- 'product' => 'ProductsCategoriesArea',
- 'customer' => 'CustomersCategoriesArea',
- 'supplier' => 'SuppliersCategoriesArea',
- 'member' => 'MembersCategoriesArea',
- 'contact' => 'ContactsCategoriesArea',
- 'user' => 'UsersCategoriesArea',
- 'account' => 'AccountsCategoriesArea', // old for bank account
- 'bank_account' => 'AccountsCategoriesArea',
- 'project' => 'ProjectsCategoriesArea',
- 'warehouse'=> 'StocksCategoriesArea',
- 'actioncomm' => 'ActioncommCategoriesArea',
- 'website_page' => 'WebsitePageCategoriesArea'
- );
- /**
- * @var array Object table mapping from type string (table llx_...) when value of key does not match table name.
- * This array may be completed by external modules with hook "constructCategory"
- */
- public $MAP_OBJ_TABLE = array(
- 'customer' => 'societe',
- 'supplier' => 'societe',
- 'member' => 'adherent',
- 'contact' => 'socpeople',
- 'account' => 'bank_account', // old for bank account
- 'project' => 'projet',
- 'warehouse'=> 'entrepot',
- 'knowledgemanagement' => 'knowledgemanagement_knowledgerecord'
- );
- /**
- * @var string ID to identify managed object
- */
- public $element = 'category';
- /**
- * @var string Name of table without prefix where object is stored
- */
- public $table_element = 'categorie';
- /**
- * @var int ID
- */
- public $fk_parent;
- /**
- * @var string Category label
- */
- public $label;
- /**
- * @var string description
- */
- public $description;
- /**
- * @var string Color
- */
- public $color;
- /**
- * @var int Visible
- */
- public $visible;
- /**
- * @var int Id of thirdparty when CATEGORY_ASSIGNED_TO_A_CUSTOMER is set
- */
- public $socid;
- /**
- * @var string Category type
- *
- * @see Categorie::TYPE_PRODUCT
- * @see Categorie::TYPE_SUPPLIER
- * @see Categorie::TYPE_CUSTOMER
- * @see Categorie::TYPE_MEMBER
- * @see Categorie::TYPE_CONTACT
- * @see Categorie::TYPE_USER
- * @see Categorie::TYPE_PROJECT
- * @see Categorie::TYPE_ACCOUNT
- * @see Categorie::TYPE_BANK_LINE
- * @see Categorie::TYPE_WAREHOUSE
- * @see Categorie::TYPE_ACTIONCOMM
- * @see Categorie::TYPE_WEBSITE_PAGE
- * @see Categorie::TYPE_TICKET
- */
- public $type;
- /**
- * @var array Categories table in memory
- */
- public $cats = array();
- /**
- * @var array Mother of table
- */
- public $motherof = array();
- /**
- * @var array Childs
- */
- public $childs = array();
- /**
- * Constructor
- *
- * @param DoliDB $db Database handler
- */
- public function __construct($db)
- {
- global $hookmanager;
- $this->db = $db;
- if (is_object($hookmanager)) {
- $hookmanager->initHooks(array('category'));
- $parameters = array();
- $reshook = $hookmanager->executeHooks('constructCategory', $parameters, $this); // Note that $action and $object may have been modified by some hooks
- if ($reshook >= 0 && !empty($hookmanager->resArray)) {
- foreach ($hookmanager->resArray as $mapList) {
- $mapId = $mapList['id'];
- $mapCode = $mapList['code'];
- self::$MAP_ID_TO_CODE[$mapId] = $mapCode;
- $this->MAP_ID[$mapCode] = $mapId;
- $this->MAP_CAT_FK[$mapCode] = $mapList['cat_fk'];
- $this->MAP_CAT_TABLE[$mapCode] = $mapList['cat_table'];
- $this->MAP_OBJ_CLASS[$mapCode] = $mapList['obj_class'];
- $this->MAP_OBJ_TABLE[$mapCode] = $mapList['obj_table'];
- }
- }
- }
- }
- /**
- * Get map list
- *
- * @return array
- */
- public function getMapList()
- {
- $mapList = array();
- foreach ($this->MAP_ID as $mapCode => $mapId) {
- $mapList[] = array(
- 'id' => $mapId,
- 'code' => $mapCode,
- 'cat_fk' => (empty($this->MAP_CAT_FK[$mapCode]) ? $mapCode : $this->MAP_CAT_FK[$mapCode]),
- 'cat_table' => (empty($this->MAP_CAT_TABLE[$mapCode]) ? $mapCode : $this->MAP_CAT_TABLE[$mapCode]),
- 'obj_class' => (empty($this->MAP_OBJ_CLASS[$mapCode]) ? $mapCode : $this->MAP_OBJ_CLASS[$mapCode]),
- 'obj_table' => (empty($this->MAP_OBJ_TABLE[$mapCode]) ? $mapCode : $this->MAP_OBJ_TABLE[$mapCode])
- );
- }
- return $mapList;
- }
- /**
- * Load category into memory from database
- *
- * @param int $id Id of category
- * @param string $label Label of category
- * @param string $type Type of category ('product', '...') or (0, 1, ...)
- * @param string $ref_ext External reference of object
- * @return int <0 if KO, >0 if OK
- */
- public function fetch($id, $label = '', $type = null, $ref_ext = '')
- {
- global $conf;
- // Check parameters
- if (empty($id) && empty($label) && empty($ref_ext)) {
- $this->error = "No category to search for";
- return -1;
- }
- if (!is_null($type) && !is_numeric($type)) {
- $type = $this->MAP_ID[$type];
- }
- $sql = "SELECT rowid, fk_parent, entity, label, description, color, fk_soc, visible, type, ref_ext";
- $sql .= ", date_creation, tms, fk_user_creat, fk_user_modif";
- $sql .= " FROM ".MAIN_DB_PREFIX."categorie";
- if ($id) {
- $sql .= " WHERE rowid = ".((int) $id);
- } elseif (!empty($ref_ext)) {
- $sql .= " WHERE ref_ext LIKE '".$this->db->escape($ref_ext)."'";
- } else {
- $sql .= " WHERE label = '".$this->db->escape($label)."' AND entity IN (".getEntity('category').")";
- if (!is_null($type)) {
- $sql .= " AND type = ".((int) $type);
- }
- }
- dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if ($resql) {
- if ($this->db->num_rows($resql) > 0) {
- $res = $this->db->fetch_array($resql);
- $this->id = $res['rowid'];
- //$this->ref = $res['rowid'];
- $this->fk_parent = (int) $res['fk_parent'];
- $this->label = $res['label'];
- $this->description = $res['description'];
- $this->color = $res['color'];
- $this->socid = (int) $res['fk_soc'];
- $this->visible = (int) $res['visible'];
- $this->type = (int) $res['type'];
- $this->ref_ext = $res['ref_ext'];
- $this->entity = (int) $res['entity'];
- $this->date_creation = $this->db->jdate($res['date_creation']);
- $this->date_modification = $this->db->jdate($res['tms']);
- $this->user_creation_id = (int) $res['fk_user_creat'];
- $this->user_modification_id = (int) $res['fk_user_modif'];
- $this->user_creation = (int) $res['fk_user_creat'];
- $this->user_modification = (int) $res['fk_user_modif'];
- // Retrieve all extrafield
- // fetch optionals attributes and labels
- $this->fetch_optionals();
- $this->db->free($resql);
- // multilangs
- if (getDolGlobalInt('MAIN_MULTILANGS')) {
- $this->getMultiLangs();
- }
- return 1;
- } else {
- $this->error = "No category found";
- return 0;
- }
- } else {
- dol_print_error($this->db);
- $this->error = $this->db->lasterror;
- $this->errors[] = $this->db->lasterror;
- return -1;
- }
- }
- /**
- * Add category into database
- *
- * @param User $user Object user
- * @return int -1 : SQL error
- * -2 : new ID unknown
- * -3 : Invalid category
- * -4 : category already exists
- */
- public function create($user)
- {
- global $conf, $langs, $hookmanager;
- $langs->load('categories');
- $type = $this->type;
- if (!is_numeric($type)) {
- $type = $this->MAP_ID[$type];
- }
- $error = 0;
- dol_syslog(get_class($this).'::create', LOG_DEBUG);
- // Clean parameters
- $this->label = trim($this->label);
- $this->description = trim($this->description);
- $this->color = trim($this->color);
- $this->import_key = trim($this->import_key);
- $this->ref_ext = trim($this->ref_ext);
- if (empty($this->visible)) {
- $this->visible = 0;
- }
- $this->fk_parent = ($this->fk_parent != "" ? intval($this->fk_parent) : 0);
- if ($this->already_exists()) {
- $this->error = $langs->trans("ImpossibleAddCat", $this->label);
- $this->error .= " : ".$langs->trans("CategoryExistsAtSameLevel");
- dol_syslog($this->error, LOG_WARNING);
- return -4;
- }
- $this->db->begin();
- $now = dol_now();
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."categorie (";
- $sql .= "fk_parent,";
- $sql .= " label,";
- $sql .= " description,";
- $sql .= " color,";
- if (!empty($conf->global->CATEGORY_ASSIGNED_TO_A_CUSTOMER)) {
- $sql .= "fk_soc,";
- }
- $sql .= " visible,";
- $sql .= " type,";
- $sql .= " import_key,";
- $sql .= " ref_ext,";
- $sql .= " entity,";
- $sql .= " date_creation,";
- $sql .= " fk_user_creat";
- $sql .= ") VALUES (";
- $sql .= (int) $this->fk_parent.",";
- $sql .= "'".$this->db->escape($this->label)."', ";
- $sql .= "'".$this->db->escape($this->description)."', ";
- $sql .= "'".$this->db->escape($this->color)."', ";
- if (!empty($conf->global->CATEGORY_ASSIGNED_TO_A_CUSTOMER)) {
- $sql .= ($this->socid > 0 ? $this->socid : 'null').", ";
- }
- $sql .= "'".$this->db->escape($this->visible)."', ";
- $sql .= ((int) $type).", ";
- $sql .= (!empty($this->import_key) ? "'".$this->db->escape($this->import_key)."'" : 'null').", ";
- $sql .= (!empty($this->ref_ext) ? "'".$this->db->escape($this->ref_ext)."'" : 'null').", ";
- $sql .= (int) $conf->entity.", ";
- $sql .= "'".$this->db->idate($now)."', ";
- $sql .= (int) $user->id;
- $sql .= ")";
- $res = $this->db->query($sql);
- if ($res) {
- $id = $this->db->last_insert_id(MAIN_DB_PREFIX."categorie");
- if ($id > 0) {
- $this->id = $id;
- $action = 'create';
- // Actions on extra fields
- if (!$error) {
- $result = $this->insertExtraFields();
- if ($result < 0) {
- $error++;
- }
- }
- if (!$error) {
- // Call trigger
- $result = $this->call_trigger('CATEGORY_CREATE', $user);
- if ($result < 0) {
- $error++;
- }
- // End call triggers
- }
- if (!$error) {
- $this->db->commit();
- return $id;
- } else {
- $this->db->rollback();
- return -3;
- }
- } else {
- $this->db->rollback();
- return -2;
- }
- } else {
- $this->error = $this->db->error();
- $this->db->rollback();
- return -1;
- }
- }
- /**
- * Update category
- *
- * @param User $user Object user
- * @return int 1 : OK
- * -1 : SQL error
- * -2 : invalid category
- */
- public function update(User $user)
- {
- global $conf, $langs, $hookmanager;
- $error = 0;
- // Clean parameters
- $this->label = trim($this->label);
- $this->description = trim($this->description);
- $this->ref_ext = trim($this->ref_ext);
- $this->fk_parent = ($this->fk_parent != "" ? intval($this->fk_parent) : 0);
- $this->visible = ($this->visible != "" ? intval($this->visible) : 0);
- if ($this->already_exists()) {
- $this->error = $langs->trans("ImpossibleUpdateCat");
- $this->error .= " : ".$langs->trans("CategoryExistsAtSameLevel");
- return -1;
- }
- $this->db->begin();
- $sql = "UPDATE ".MAIN_DB_PREFIX."categorie";
- $sql .= " SET label = '".$this->db->escape($this->label)."',";
- $sql .= " description = '".$this->db->escape($this->description)."',";
- $sql .= " ref_ext = '".$this->db->escape($this->ref_ext)."',";
- $sql .= " color = '".$this->db->escape($this->color)."'";
- if (!empty($conf->global->CATEGORY_ASSIGNED_TO_A_CUSTOMER)) {
- $sql .= ", fk_soc = ".($this->socid > 0 ? $this->socid : 'null');
- }
- $sql .= ", visible = ".(int) $this->visible;
- $sql .= ", fk_parent = ".(int) $this->fk_parent;
- $sql .= ", fk_user_modif = ".(int) $user->id;
- $sql .= " WHERE rowid = ".((int) $this->id);
- dol_syslog(get_class($this)."::update", LOG_DEBUG);
- if ($this->db->query($sql)) {
- $action = 'update';
- // Actions on extra fields
- if (!$error) {
- $result = $this->insertExtraFields();
- if ($result < 0) {
- $error++;
- }
- }
- if (!$error) {
- // Call trigger
- $result = $this->call_trigger('CATEGORY_MODIFY', $user);
- if ($result < 0) {
- $error++; $this->db->rollback(); return -1;
- }
- // End call triggers
- }
- $this->db->commit();
- return 1;
- } else {
- $this->db->rollback();
- dol_print_error($this->db);
- return -1;
- }
- }
- /**
- * Delete a category from database
- *
- * @param User $user Object user that ask to delete
- * @param int $notrigger 1=Does not execute triggers, 0= execute triggers
- * @return int <0 KO >0 OK
- */
- public function delete($user, $notrigger = 0)
- {
- global $conf, $langs;
- $error = 0;
- // Clean parameters
- $this->fk_parent = ($this->fk_parent != "" ? intval($this->fk_parent) : 0);
- dol_syslog(get_class($this)."::remove");
- $this->db->begin();
- if (!$error && !$notrigger) {
- // Call trigger
- $result = $this->call_trigger('CATEGORY_DELETE', $user);
- if ($result < 0) {
- $error++;
- }
- // End call triggers
- }
- /* FIX #1317 : Check for child category and move up 1 level*/
- if (!$error) {
- $sql = "UPDATE ".MAIN_DB_PREFIX."categorie";
- $sql .= " SET fk_parent = ".((int) $this->fk_parent);
- $sql .= " WHERE fk_parent = ".((int) $this->id);
- if (!$this->db->query($sql)) {
- $this->error = $this->db->lasterror();
- $error++;
- }
- }
- $arraydelete = array(
- 'categorie_account' => 'fk_categorie',
- 'categorie_actioncomm' => 'fk_categorie',
- 'categorie_contact' => 'fk_categorie',
- 'categorie_fournisseur' => 'fk_categorie',
- 'categorie_knowledgemanagement' => array('field' => 'fk_categorie', 'enabled' => isModEnabled('knowledgemanagement')),
- 'categorie_member' => 'fk_categorie',
- 'categorie_user' => 'fk_categorie',
- 'categorie_product' => 'fk_categorie',
- 'categorie_project' => 'fk_categorie',
- 'categorie_societe' => 'fk_categorie',
- 'categorie_ticket' => array('field' => 'fk_categorie', 'enabled' => isModEnabled('ticket')),
- 'categorie_warehouse' => 'fk_categorie',
- 'categorie_website_page' => array('field' => 'fk_categorie', 'enabled' => isModEnabled('website')),
- 'bank_class' => 'fk_categ',
- 'categorie_lang' => 'fk_category',
- 'categorie' => 'rowid',
- );
- foreach ($arraydelete as $key => $value) {
- if (is_array($value)) {
- if (empty($value['enabled'])) {
- continue;
- }
- $value = $value['field'];
- }
- $sql = "DELETE FROM ".MAIN_DB_PREFIX.$key;
- $sql .= " WHERE ".$value." = ".((int) $this->id);
- if (!$this->db->query($sql)) {
- $this->errors[] = $this->db->lasterror();
- dol_syslog("Error sql=".$sql." ".$this->error, LOG_ERR);
- $error++;
- }
- }
- // Removed extrafields
- if (!$error) {
- $result = $this->deleteExtraFields();
- if ($result < 0) {
- $error++;
- dol_syslog(get_class($this)."::delete erreur ".$this->error, LOG_ERR);
- }
- }
- if (!$error) {
- $this->db->commit();
- return 1;
- } else {
- $this->db->rollback();
- return -1;
- }
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Link an object to the category
- *
- * @param CommonObject $obj Object to link to category
- * @param string $type Type of category ('product', ...). Use '' to take $obj->element.
- * @return int 1 : OK, -1 : erreur SQL, -2 : id not defined, -3 : Already linked
- * @see del_type()
- */
- public function add_type($obj, $type = '')
- {
- // phpcs:enable
- global $user, $langs, $conf;
- $error = 0;
- if ($this->id == -1) {
- return -2;
- }
- if (empty($type)) {
- $type = $obj->element;
- }
- dol_syslog(get_class($this).'::add_type', LOG_DEBUG);
- $this->db->begin();
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type]);
- $sql .= " (fk_categorie, fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type]).")";
- $sql .= " VALUES (".((int) $this->id).", ".((int) $obj->id).")";
- if ($this->db->query($sql)) {
- if (!empty($conf->global->CATEGORIE_RECURSIV_ADD)) {
- $sql = 'SELECT fk_parent FROM '.MAIN_DB_PREFIX.'categorie';
- $sql .= " WHERE rowid = ".((int) $this->id);
- dol_syslog(get_class($this)."::add_type", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if ($resql) {
- if ($this->db->num_rows($resql) > 0) {
- $objparent = $this->db->fetch_object($resql);
- if (!empty($objparent->fk_parent)) {
- $cat = new Categorie($this->db);
- $cat->id = $objparent->fk_parent;
- if (!$cat->containsObject($type, $obj->id)) {
- $result = $cat->add_type($obj, $type);
- if ($result < 0) {
- $this->error = $cat->error;
- $error++;
- }
- }
- }
- }
- } else {
- $error++;
- $this->error = $this->db->lasterror();
- }
- if ($error) {
- $this->db->rollback();
- return -1;
- }
- }
- // Call trigger
- $this->context = array('linkto'=>$obj); // Save object we want to link category to into category instance to provide information to trigger
- $result = $this->call_trigger('CATEGORY_LINK', $user);
- if ($result < 0) {
- $error++;
- }
- // End call triggers
- if (!$error) {
- $this->db->commit();
- return 1;
- } else {
- $this->db->rollback();
- return -2;
- }
- } else {
- $this->db->rollback();
- if ($this->db->lasterrno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') {
- $this->error = $this->db->lasterrno();
- return -3;
- } else {
- $this->error = $this->db->lasterror();
- }
- return -1;
- }
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Delete object from category
- *
- * @param CommonObject $obj Object
- * @param string $type Type of category ('customer', 'supplier', 'contact', 'product', 'member')
- * @return int 1 if OK, -1 if KO
- * @see add_type()
- */
- public function del_type($obj, $type)
- {
- // phpcs:enable
- global $user, $langs, $conf;
- $error = 0;
- // For backward compatibility
- if ($type == 'societe') {
- $type = 'customer';
- dol_syslog(get_class($this)."::del_type(): type 'societe' is deprecated, please use 'customer' instead", LOG_WARNING);
- } elseif ($type == 'fournisseur') {
- $type = 'supplier';
- dol_syslog(get_class($this)."::del_type(): type 'fournisseur' is deprecated, please use 'supplier' instead", LOG_WARNING);
- }
- $this->db->begin();
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type]);
- $sql .= " WHERE fk_categorie = ".((int) $this->id);
- $sql .= " AND fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = ".((int) $obj->id);
- dol_syslog(get_class($this).'::del_type', LOG_DEBUG);
- if ($this->db->query($sql)) {
- // Call trigger
- $this->context = array('unlinkoff'=>$obj); // Save object we want to link category to into category instance to provide information to trigger
- $result = $this->call_trigger('CATEGORY_UNLINK', $user);
- if ($result < 0) {
- $error++;
- }
- // End call triggers
- if (!$error) {
- $this->db->commit();
- return 1;
- } else {
- $this->db->rollback();
- return -2;
- }
- } else {
- $this->db->rollback();
- $this->error = $this->db->lasterror();
- return -1;
- }
- }
- /**
- * Return list of fetched instance of elements having this category
- *
- * @param string $type Type of category ('customer', 'supplier', 'contact', 'product', 'member', 'knowledge_management', ...)
- * @param int $onlyids Return only ids of objects (consume less memory)
- * @param int $limit Limit
- * @param int $offset Offset
- * @param string $sortfield Sort fields
- * @param string $sortorder Sort order ('ASC' or 'DESC');
- * @return array|int -1 if KO, array of instance of object if OK
- * @see containsObject()
- */
- public function getObjectsInCateg($type, $onlyids = 0, $limit = 0, $offset = 0, $sortfield = '', $sortorder = 'ASC')
- {
- global $user;
- $objs = array();
- $classnameforobj = $this->MAP_OBJ_CLASS[$type];
- $obj = new $classnameforobj($this->db);
- $sql = "SELECT c.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type]);
- $sql .= " FROM ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type])." as c";
- $sql .= ", ".MAIN_DB_PREFIX.(empty($this->MAP_OBJ_TABLE[$type]) ? $type : $this->MAP_OBJ_TABLE[$type])." as o";
- $sql .= " WHERE o.entity IN (".getEntity($obj->element).")";
- $sql .= " AND c.fk_categorie = ".((int) $this->id);
- $sql .= " AND c.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = o.rowid";
- // Protection for external users
- if (($type == 'customer' || $type == 'supplier') && $user->socid > 0) {
- $sql .= " AND o.rowid = ".((int) $user->socid);
- }
- $sql .= $this->db->order($sortfield, $sortorder);
- if ($limit > 0 || $offset > 0) {
- $sql .= $this->db->plimit($limit + 1, $offset);
- }
- dol_syslog(get_class($this)."::getObjectsInCateg", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if ($resql) {
- while ($rec = $this->db->fetch_array($resql)) {
- if ($onlyids) {
- $objs[] = $rec['fk_'.(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])];
- } else {
- $classnameforobj = $this->MAP_OBJ_CLASS[$type];
- $obj = new $classnameforobj($this->db);
- $obj->fetch($rec['fk_'.(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])]);
- $objs[] = $obj;
- }
- }
- return $objs;
- } else {
- $this->error = $this->db->error().' sql='.$sql;
- return -1;
- }
- }
- /**
- * Check for the presence of an object in a category
- *
- * @param string $type Type of category ('customer', 'supplier', 'contact', 'product', 'member')
- * @param int $object_id Id of the object to search
- * @return int Number of occurrences
- * @see getObjectsInCateg()
- */
- public function containsObject($type, $object_id)
- {
- $sql = "SELECT COUNT(*) as nb FROM ".MAIN_DB_PREFIX."categorie_".(empty($this->MAP_CAT_TABLE[$type]) ? $type : $this->MAP_CAT_TABLE[$type]);
- $sql .= " WHERE fk_categorie = ".((int) $this->id)." AND fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = ".((int) $object_id);
- dol_syslog(get_class($this)."::containsObject", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if ($resql) {
- return $this->db->fetch_object($resql)->nb;
- } else {
- $this->error = $this->db->error().' sql='.$sql;
- return -1;
- }
- }
- /**
- * List categories of an element id
- *
- * @param int $id Id of element
- * @param string $type Type of category ('member', 'customer', 'supplier', 'product', 'contact')
- * @param string $sortfield Sort field
- * @param string $sortorder Sort order
- * @param int $limit Limit for list
- * @param int $page Page number
- * @return array|int Array of categories, 0 if no cat, -1 on error
- */
- public function getListForItem($id, $type = 'customer', $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0)
- {
- global $conf;
- $categories = array();
- $type = sanitizeVal($type, 'aZ09');
- $sub_type = $type;
- $subcol_name = "fk_".$type;
- if ($type == "customer") {
- $sub_type = "societe";
- $subcol_name = "fk_soc";
- }
- if ($type == "supplier") {
- $sub_type = "fournisseur";
- $subcol_name = "fk_soc";
- }
- if ($type == "contact") {
- $subcol_name = "fk_socpeople";
- }
- $idoftype = array_search($type, self::$MAP_ID_TO_CODE);
- $sql = "SELECT s.rowid";
- $sql .= " FROM ".MAIN_DB_PREFIX."categorie as s, ".MAIN_DB_PREFIX."categorie_".$sub_type." as sub";
- $sql .= ' WHERE s.entity IN ('.getEntity('category').')';
- $sql .= ' AND s.type='.((int) $idoftype);
- $sql .= ' AND s.rowid = sub.fk_categorie';
- $sql .= " AND sub.".$subcol_name." = ".((int) $id);
- $sql .= $this->db->order($sortfield, $sortorder);
- $offset = 0;
- $nbtotalofrecords = '';
- if (empty($conf->global->MAIN_DISABLE_FULL_SCANLIST)) {
- $result = $this->db->query($sql);
- $nbtotalofrecords = $this->db->num_rows($result);
- if (($page * $limit) > $nbtotalofrecords) { // if total resultset is smaller then paging size (filtering), goto and load page 0
- $page = 0;
- $offset = 0;
- }
- }
- if ($limit) {
- if ($page < 0) {
- $page = 0;
- }
- $offset = $limit * $page;
- $sql .= $this->db->plimit($limit + 1, $offset);
- }
- $result = $this->db->query($sql);
- if ($result) {
- $i = 0;
- $num = $this->db->num_rows($result);
- $min = min($num, ($limit <= 0 ? $num : $limit));
- while ($i < $min) {
- $obj = $this->db->fetch_object($result);
- $category_static = new Categorie($this->db);
- if ($category_static->fetch($obj->rowid)) {
- $categories[$i]['id'] = $category_static->id;
- $categories[$i]['fk_parent'] = $category_static->fk_parent;
- $categories[$i]['label'] = $category_static->label;
- $categories[$i]['description'] = $category_static->description;
- $categories[$i]['color'] = $category_static->color;
- $categories[$i]['socid'] = $category_static->socid;
- $categories[$i]['ref_ext'] = $category_static->ref_ext;
- $categories[$i]['visible'] = $category_static->visible;
- $categories[$i]['type'] = $category_static->type;
- $categories[$i]['entity'] = $category_static->entity;
- $categories[$i]['array_options'] = $category_static->array_options;
- // multilangs
- if (getDolGlobalInt('MAIN_MULTILANGS') && isset($category_static->multilangs)) {
- $categories[$i]['multilangs'] = $category_static->multilangs;
- }
- }
- $i++;
- }
- } else {
- $this->error = $this->db->lasterror();
- return -1;
- }
- if (!count($categories)) {
- return 0;
- }
- return $categories;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Return direct childs id of a category into an array
- *
- * @return array|int <0 KO, array ok
- */
- public function get_filles()
- {
- // phpcs:enable
- $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."categorie";
- $sql .= " WHERE fk_parent = ".((int) $this->id);
- $sql .= " AND entity IN (".getEntity('category').")";
- $res = $this->db->query($sql);
- if ($res) {
- $cats = array();
- while ($rec = $this->db->fetch_array($res)) {
- $cat = new Categorie($this->db);
- $cat->fetch($rec['rowid']);
- $cats[] = $cat;
- }
- return $cats;
- } else {
- dol_print_error($this->db);
- return -1;
- }
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Load the array this->motherof that is array(id_son=>id_parent, ...)
- *
- * @return int <0 if KO, >0 if OK
- */
- protected function load_motherof()
- {
- // phpcs:enable
- $this->motherof = array();
- // Load array[child]=parent
- $sql = "SELECT fk_parent as id_parent, rowid as id_son";
- $sql .= " FROM ".MAIN_DB_PREFIX."categorie";
- $sql .= " WHERE fk_parent != 0";
- $sql .= " AND entity IN (".getEntity('category').")";
- dol_syslog(get_class($this)."::load_motherof", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if ($resql) {
- while ($obj = $this->db->fetch_object($resql)) {
- $this->motherof[$obj->id_son] = $obj->id_parent;
- }
- return 1;
- } else {
- dol_print_error($this->db);
- return -1;
- }
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Rebuilding the category tree as an array
- * Return an array of table('id','id_mere',...) trie selon arbre et avec:
- * id = id de la categorie
- * id_mere = id de la categorie mere
- * id_children = tableau des id enfant
- * label = nom de la categorie
- * fulllabel = nom avec chemin complet de la categorie
- * fullpath = chemin complet compose des id
- *
- * @param string $type Type of categories ('customer', 'supplier', 'contact', 'product', 'member', ...)
- * @param int|string|array $markafterid Keep only or removed all categories including the leaf $markafterid in category tree (exclude) or Keep only of category is inside the leaf starting with this id.
- * $markafterid can be an :
- * - int (id of category)
- * - string (categories ids separated by comma)
- * - array (list of categories ids)
- * @param int $include [=0] Removed or 1=Keep only
- * @return array|int Array of categories. this->cats and this->motherof are set, -1 on error
- */
- public function get_full_arbo($type, $markafterid = 0, $include = 0)
- {
- // phpcs:enable
- global $conf, $langs;
- if (!is_numeric($type)) {
- $type = $this->MAP_ID[$type];
- }
- if (is_null($type)) {
- $this->error = 'BadValueForParameterType';
- return -1;
- }
- if (is_string($markafterid)) {
- $markafterid = explode(',', $markafterid);
- } elseif (is_numeric($markafterid)) {
- if ($markafterid > 0) {
- $markafterid = array($markafterid);
- } else {
- $markafterid = array();
- }
- } elseif (!is_array($markafterid)) {
- $markafterid = array();
- }
- $this->cats = array();
- // Init this->motherof that is array(id_son=>id_parent, ...)
- $this->load_motherof();
- $current_lang = $langs->getDefaultLang();
- // Init $this->cats array
- $sql = "SELECT DISTINCT c.rowid, c.label, c.ref_ext, c.description, c.color, c.fk_parent, c.visible"; // Distinct reduce pb with old tables with duplicates
- if (getDolGlobalInt('MAIN_MULTILANGS')) {
- $sql .= ", t.label as label_trans, t.description as description_trans";
- }
- $sql .= " FROM ".MAIN_DB_PREFIX."categorie as c";
- if (getDolGlobalInt('MAIN_MULTILANGS')) {
- $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."categorie_lang as t ON t.fk_category=c.rowid AND t.lang='".$this->db->escape($current_lang)."'";
- }
- $sql .= " WHERE c.entity IN (".getEntity('category').")";
- $sql .= " AND c.type = ".(int) $type;
- dol_syslog(get_class($this)."::get_full_arbo get category list", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if ($resql) {
- $i = 0;
- while ($obj = $this->db->fetch_object($resql)) {
- $this->cats[$obj->rowid]['rowid'] = $obj->rowid;
- $this->cats[$obj->rowid]['id'] = $obj->rowid;
- $this->cats[$obj->rowid]['fk_parent'] = $obj->fk_parent;
- $this->cats[$obj->rowid]['label'] = !empty($obj->label_trans) ? $obj->label_trans : $obj->label;
- $this->cats[$obj->rowid]['description'] = !empty($obj->description_trans) ? $obj->description_trans : $obj->description;
- $this->cats[$obj->rowid]['color'] = $obj->color;
- $this->cats[$obj->rowid]['visible'] = $obj->visible;
- $this->cats[$obj->rowid]['ref_ext'] = $obj->ref_ext;
- $this->cats[$obj->rowid]['picto'] = 'category';
- $i++;
- }
- } else {
- dol_print_error($this->db);
- return -1;
- }
- // We add the fullpath property to each elements of first level (no parent exists)
- dol_syslog(get_class($this)."::get_full_arbo call to buildPathFromId", LOG_DEBUG);
- foreach ($this->cats as $key => $val) {
- //print 'key='.$key.'<br>'."\n";
- $this->buildPathFromId($key, 0); // Process a branch from the root category key (this category has no parent)
- }
- // Include or exclude leaf including $markafterid from tree
- if (count($markafterid) > 0) {
- $keyfiltercatid = '('.implode('|', $markafterid).')';
- //print "Look to discard category ".$markafterid."\n";
- $keyfilter1 = '^'.$keyfiltercatid.'$';
- $keyfilter2 = '_'.$keyfiltercatid.'$';
- $keyfilter3 = '^'.$keyfiltercatid.'_';
- $keyfilter4 = '_'.$keyfiltercatid.'_';
- foreach ($this->cats as $key => $val) {
- $test = (preg_match('/'.$keyfilter1.'/', $val['fullpath']) || preg_match('/'.$keyfilter2.'/', $val['fullpath'])
- || preg_match('/'.$keyfilter3.'/', $val['fullpath']) || preg_match('/'.$keyfilter4.'/', $val['fullpath']));
- if (($test && !$include) || (!$test && $include)) {
- unset($this->cats[$key]);
- }
- }
- }
- dol_syslog(get_class($this)."::get_full_arbo dol_sort_array", LOG_DEBUG);
- $this->cats = dol_sort_array($this->cats, 'fulllabel', 'asc', true, false);
- //$this->debug_cats();
- return $this->cats;
- }
- /**
- * For category id_categ and its childs available in this->cats, define property fullpath and fulllabel.
- * It is called by get_full_arbo()
- * This function is a memory scan only from $this->cats and $this->motherof, no database access must be done here.
- *
- * @param int $id_categ id_categ entry to update
- * @param int $protection Deep counter to avoid infinite loop
- * @return void
- * @see get_full_arbo()
- */
- private function buildPathFromId($id_categ, $protection = 1000)
- {
- //dol_syslog(get_class($this)."::buildPathFromId id_categ=".$id_categ." protection=".$protection, LOG_DEBUG);
- if (!empty($this->cats[$id_categ]['fullpath'])) {
- // Already defined
- dol_syslog(get_class($this)."::buildPathFromId fullpath and fulllabel already defined", LOG_WARNING);
- return;
- }
- // First build full array $motherof
- //$this->load_motherof(); // Disabled because already done by caller of buildPathFromId
- // $this->cats[$id_categ] is supposed to be already an array. We just want to complete it with property fullpath and fulllabel
- // Define fullpath and fulllabel
- $this->cats[$id_categ]['fullpath'] = '_'.$id_categ;
- $this->cats[$id_categ]['fulllabel'] = $this->cats[$id_categ]['label'];
- $i = 0; $cursor_categ = $id_categ;
- //print 'Work for id_categ='.$id_categ.'<br>'."\n";
- while ((empty($protection) || $i < $protection) && !empty($this->motherof[$cursor_categ])) {
- //print ' cursor_categ='.$cursor_categ.' i='.$i.' '.$this->motherof[$cursor_categ].'<br>'."\n";
- $this->cats[$id_categ]['fullpath'] = '_'.$this->motherof[$cursor_categ].$this->cats[$id_categ]['fullpath'];
- $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'];
- //print ' Result for id_categ='.$id_categ.' : '.$this->cats[$id_categ]['fullpath'].' '.$this->cats[$id_categ]['fulllabel'].'<br>'."\n";
- $i++;
- $cursor_categ = $this->motherof[$cursor_categ];
- }
- //print 'Result for id_categ='.$id_categ.' : '.$this->cats[$id_categ]['fullpath'].'<br>'."\n";
- // We count number of _ to have level
- $nbunderscore = substr_count($this->cats[$id_categ]['fullpath'], '_');
- $this->cats[$id_categ]['level'] = ($nbunderscore ? $nbunderscore : null);
- return;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Display content of $this->cats
- *
- * @return void
- */
- public function debug_cats()
- {
- // phpcs:enable
- // Display $this->cats
- foreach ($this->cats as $key => $val) {
- print 'id: '.$this->cats[$key]['id'];
- print ' label: '.$this->cats[$key]['label'];
- print ' mother: '.$this->cats[$key]['fk_parent'];
- //print ' children: '.(is_array($this->cats[$key]['id_children'])?join(',',$this->cats[$key]['id_children']):'');
- print ' fullpath: '.$this->cats[$key]['fullpath'];
- print ' fulllabel: '.$this->cats[$key]['fulllabel'];
- print "<br>\n";
- }
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Returns all categories
- *
- * @param int $type Type of category (0, 1, ...)
- * @param boolean $parent Just parent categories if true
- * @return array|int Table of Object Category, -1 on error
- */
- public function get_all_categories($type = null, $parent = false)
- {
- // phpcs:enable
- if (!is_numeric($type)) {
- $type = $this->MAP_ID[$type];
- }
- $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."categorie";
- $sql .= " WHERE entity IN (".getEntity('category').")";
- if (!is_null($type)) {
- $sql .= " AND type = ".(int) $type;
- }
- if ($parent) {
- $sql .= " AND fk_parent = 0";
- }
- $res = $this->db->query($sql);
- if ($res) {
- $cats = array();
- while ($rec = $this->db->fetch_array($res)) {
- $cat = new Categorie($this->db);
- $cat->fetch($rec['rowid']);
- $cats[$rec['rowid']] = $cat;
- }
- return $cats;
- } else {
- dol_print_error($this->db);
- return -1;
- }
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Returns the top level categories (which are not child)
- *
- * @param int $type Type of category (0, 1, ...)
- * @return array
- */
- public function get_main_categories($type = null)
- {
- // phpcs:enable
- return $this->get_all_categories($type, true);
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Check if no category with same label already exists for this cat's parent or root and for this cat's type
- *
- * @return integer 1 if already exist, 0 otherwise, -1 if error
- */
- public function already_exists()
- {
- // phpcs:enable
- $type = $this->type;
- if (!is_numeric($type)) {
- $type = $this->MAP_ID[$type];
- }
- /* We have to select any rowid from llx_categorie which category's mother and label
- * are equals to those of the calling category
- */
- $sql = "SELECT c.rowid";
- $sql .= " FROM ".MAIN_DB_PREFIX."categorie as c ";
- $sql .= " WHERE c.entity IN (".getEntity('category').")";
- $sql .= " AND c.type = ".((int) $type);
- $sql .= " AND c.fk_parent = ".((int) $this->fk_parent);
- $sql .= " AND c.label = '".$this->db->escape($this->label)."'";
- dol_syslog(get_class($this)."::already_exists", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if ($resql) {
- if ($this->db->num_rows($resql) > 0) { // Checking for empty resql
- $obj = $this->db->fetch_array($resql);
- /* If object called create, obj cannot have is id.
- * If object called update, he mustn't have the same label as an other category for this mother.
- * So if the result have the same id, update is not for label, and if result have an other one,
- * update may be for label.
- */
- if ($obj[0] > 0 && $obj[0] != $this->id) {
- dol_syslog(get_class($this)."::already_exists category with name=".$this->label." and parent ".$this->fk_parent." exists: rowid=".$obj[0]." current_id=".$this->id, LOG_DEBUG);
- return 1;
- }
- }
- 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);
- return 0;
- } else {
- $this->error = $this->db->error();
- return -1;
- }
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Returns the path of the category, with the names of the categories
- * separated by $sep (" >> " by default)
- *
- * @param string $sep Separator
- * @param string $url Url ('', 'none' or 'urltouse')
- * @param int $nocolor 0
- * @param string $addpicto Add picto into link
- * @return array
- */
- public function print_all_ways($sep = '>>', $url = '', $nocolor = 0, $addpicto = 0)
- {
- // phpcs:enable
- $ways = array();
- $allways = $this->get_all_ways(); // Load array of categories
- foreach ($allways as $way) {
- $w = array();
- $i = 0;
- $forced_color = '';
- foreach ($way as $cat) {
- $i++;
- if (empty($nocolor)) {
- $forced_color = 'colortoreplace';
- if ($i == count($way)) { // Last category in hierarchy
- // Check contrast with background and correct text color
- $forced_color = 'categtextwhite';
- if ($cat->color) {
- if (colorIsLight($cat->color)) {
- $forced_color = 'categtextblack';
- }
- }
- }
- }
- if ($url == '') {
- $link = '<a href="'.DOL_URL_ROOT.'/categories/viewcat.php?id='.$cat->id.'&type='.$cat->type.'" class="'.$forced_color.'">';
- $linkend = '</a>';
- $w[] = $link.(($addpicto && $i == 1) ? img_object('', 'category', 'class="paddingright"') : '').$cat->label.$linkend;
- } elseif ($url == 'none') {
- $link = '<span class="'.$forced_color.'">';
- $linkend = '</span>';
- $w[] = $link.(($addpicto && $i == 1) ? img_object('', 'category', 'class="paddingright"') : '').$cat->label.$linkend;
- } else {
- $w[] = '<a class="'.$forced_color.'" href="'.DOL_URL_ROOT.'/'.$url.'?catid='.$cat->id.'">'.($addpicto ? img_object('', 'category') : '').$cat->label.'</a>';
- }
- }
- $newcategwithpath = preg_replace('/colortoreplace/', $forced_color, implode('<span class="inline-block valignmiddle paddingleft paddingright '.$forced_color.'">'.$sep.'</span>', $w));
- $ways[] = $newcategwithpath;
- }
- return $ways;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Returns an array containing the list of parent categories
- *
- * @return int|array <0 KO, array OK
- */
- public function get_meres()
- {
- // phpcs:enable
- $parents = array();
- $sql = "SELECT fk_parent FROM ".MAIN_DB_PREFIX."categorie";
- $sql .= " WHERE rowid = ".((int) $this->id);
- $res = $this->db->query($sql);
- if ($res) {
- while ($rec = $this->db->fetch_array($res)) {
- if ($rec['fk_parent'] > 0) {
- $cat = new Categorie($this->db);
- $cat->fetch($rec['fk_parent']);
- $parents[] = $cat;
- }
- }
- return $parents;
- } else {
- dol_print_error($this->db);
- return -1;
- }
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Returns in a table all possible paths to get to the category
- * starting with the major categories represented by Tables of categories
- *
- * @return array
- */
- public function get_all_ways()
- {
- // phpcs:enable
- $ways = array();
- $parents = $this->get_meres();
- if (is_array($parents)) {
- foreach ($parents as $parent) {
- $allways = $parent->get_all_ways();
- foreach ($allways as $way) {
- $w = $way;
- $w[] = $this;
- $ways[] = $w;
- }
- }
- }
- if (count($ways) == 0) {
- $ways[0][0] = $this;
- }
- return $ways;
- }
- /**
- * Return list of categories (object instances or labels) linked to element of id $id and type $type
- * Should be named getListOfCategForObject
- *
- * @param int $id Id of element
- * @param string|int $type Type of category ('customer', 'supplier', 'contact', 'product', 'member') or (0, 1, 2, ...)
- * @param string $mode 'id'=Get array of category ids, 'object'=Get array of fetched category instances, 'label'=Get array of category
- * labels, 'id'= Get array of category IDs
- * @return Categorie[]|int Array of category objects or < 0 if KO
- */
- public function containing($id, $type, $mode = 'object')
- {
- $cats = array();
- if (is_numeric($type)) {
- $type = Categorie::$MAP_ID_TO_CODE[$type];
- }
- if ($type === Categorie::TYPE_BANK_LINE) { // TODO Remove this with standard category code after migration of llx_bank_categ into llx_categorie
- // Load bank categories
- $sql = "SELECT c.label, c.rowid";
- $sql .= " FROM ".MAIN_DB_PREFIX."bank_class as a, ".MAIN_DB_PREFIX."bank_categ as c";
- $sql .= " WHERE a.lineid=".((int) $id)." AND a.fk_categ = c.rowid";
- $sql .= " AND c.entity IN (".getEntity('category').")";
- $sql .= " ORDER BY c.label";
- $res = $this->db->query($sql);
- if ($res) {
- while ($obj = $this->db->fetch_object($res)) {
- if ($mode == 'id') {
- $cats[] = $obj->rowid;
- } elseif ($mode == 'label') {
- $cats[] = $obj->label;
- } else {
- $cat = new Categorie($this->db);
- $cat->id = $obj->rowid;
- $cat->label = $obj->label;
- $cats[] = $cat;
- }
- }
- } else {
- dol_print_error($this->db);
- return -1;
- }
- } else {
- $sql = "SELECT ct.fk_categorie, c.label, c.rowid";
- $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";
- $sql .= " WHERE ct.fk_categorie = c.rowid AND ct.fk_".(empty($this->MAP_CAT_FK[$type]) ? $type : $this->MAP_CAT_FK[$type])." = ".(int) $id;
- // This seems useless because the table already contains id of category of 1 unique type. So commented.
- // So now it works also with external added categories.
- //$sql .= " AND c.type = ".((int) $this->MAP_ID[$type]);
- $sql .= " AND c.entity IN (".getEntity('category').")";
- $res = $this->db->query($sql);
- if ($res) {
- while ($obj = $this->db->fetch_object($res)) {
- if ($mode == 'id') {
- $cats[] = $obj->rowid;
- } elseif ($mode == 'label') {
- $cats[] = $obj->label;
- } else {
- $cat = new Categorie($this->db);
- $cat->fetch($obj->fk_categorie);
- $cats[] = $cat;
- }
- }
- } else {
- dol_print_error($this->db);
- return -1;
- }
- }
- return $cats;
- }
- /**
- * Returns categories whose id or name match
- * add wildcards in the name unless $exact = true
- *
- * @param int $id Id
- * @param string $nom Name
- * @param string $type Type of category ('member', 'customer', 'supplier', 'product', 'contact'). Old mode (0, 1, 2, ...) is deprecated.
- * @param boolean $exact Exact string search (true/false)
- * @param boolean $case Case sensitive (true/false)
- * @return Categorie[]|int Array of Categorie, -1 if error
- */
- public function rechercher($id, $nom, $type, $exact = false, $case = false)
- {
- // Deprecation warning
- if (is_numeric($type)) {
- dol_syslog(__METHOD__.': using numeric types is deprecated.', LOG_WARNING);
- }
- $cats = array();
- // For backward compatibility
- if (is_numeric($type)) {
- // We want to reverse lookup
- $map_type = array_flip($this->MAP_ID);
- $type = $map_type[$type];
- dol_syslog(get_class($this)."::rechercher(): numeric types are deprecated, please use string instead", LOG_WARNING);
- }
- // Generation requete recherche
- $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."categorie";
- $sql .= " WHERE type = ".((int) $this->MAP_ID[$type]);
- $sql .= " AND entity IN (".getEntity('category').")";
- if ($nom) {
- if (!$exact) {
- $nom = '%'.$this->db->escape(str_replace('*', '%', $nom)).'%';
- }
- if (!$case) {
- $sql .= " AND label LIKE '".$this->db->escape($nom)."'";
- } else {
- $sql .= " AND label LIKE BINARY '".$this->db->escape($nom)."'";
- }
- }
- if ($id) {
- $sql .= " AND rowid = ".((int) $id);
- }
- $res = $this->db->query($sql);
- if ($res) {
- while ($rec = $this->db->fetch_array($res)) {
- $cat = new Categorie($this->db);
- $cat->fetch($rec['rowid']);
- $cats[] = $cat;
- }
- return $cats;
- } else {
- $this->error = $this->db->error().' sql='.$sql;
- return -1;
- }
- }
- /**
- * Return name and link of category (with picto)
- * Use ->id, ->ref, ->label, ->color
- *
- * @param int $withpicto 0=No picto, 1=Include picto into link, 2=Only picto
- * @param string $option Sur quoi pointe le lien ('', 'xyz')
- * @param int $maxlength Max length of text
- * @param string $moreparam More param on URL link
- * @return string Chaine avec URL
- */
- public function getNomUrl($withpicto = 0, $option = '', $maxlength = 0, $moreparam = '')
- {
- global $langs, $hookmanager;
- $result = '';
- $label = $langs->trans("ShowCategory").': '.($this->ref ? $this->ref : $this->label);
- // Check contrast with background and correct text color
- $forced_color = 'categtextwhite';
- if ($this->color) {
- if (colorIsLight($this->color)) {
- $forced_color = 'categtextblack';
- }
- }
- $link = '<a href="'.DOL_URL_ROOT.'/categories/viewcat.php?id='.$this->id.'&type='.$this->type.$moreparam.'&backtopage='.urlencode($_SERVER['PHP_SELF'].($moreparam ? '?'.$moreparam : '')).'" title="'.dol_escape_htmltag($label, 1).'" class="classfortooltip '.$forced_color.'">';
- $linkend = '</a>';
- $picto = 'category';
- if ($withpicto) {
- $result .= ($link.img_object($label, $picto, 'class="classfortooltip"').$linkend);
- }
- if ($withpicto && $withpicto != 2) {
- $result .= ' ';
- }
- if ($withpicto != 2) {
- $result .= $link.dol_trunc(($this->ref ? $this->ref : $this->label), $maxlength).$linkend;
- }
- global $action;
- $hookmanager->initHooks(array($this->element . 'dao'));
- $parameters = array('id'=>$this->id, 'getnomurl' => &$result);
- $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
- if ($reshook > 0) {
- $result = $hookmanager->resPrint;
- } else {
- $result .= $hookmanager->resPrint;
- }
- return $result;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Deplace fichier uploade sous le nom $file dans le repertoire sdir
- *
- * @param string $sdir Final destination directory
- * @param array $file Uploaded file name
- * @return void
- */
- public function add_photo($sdir, $file)
- {
- // phpcs:enable
- require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
- $dir = $sdir.'/'.get_exdir($this->id, 2, 0, 0, $this, 'category').$this->id."/";
- $dir .= "photos/";
- if (!file_exists($dir)) {
- dol_mkdir($dir);
- }
- if (file_exists($dir)) {
- if (is_array($file['name']) && count($file['name']) > 0) {
- $nbfile = count($file['name']);
- for ($i = 0; $i <= $nbfile; $i++) {
- $originImage = $dir.$file['name'][$i];
- // Cree fichier en taille origine
- dol_move_uploaded_file($file['tmp_name'][$i], $originImage, 1, 0, 0);
- if (file_exists($originImage)) {
- // Create thumbs
- $this->addThumbs($originImage);
- }
- }
- } else {
- $originImage = $dir.$file['name'];
- // Cree fichier en taille origine
- dol_move_uploaded_file($file['tmp_name'], $originImage, 1, 0, 0);
- if (file_exists($originImage)) {
- // Create thumbs
- $this->addThumbs($originImage);
- }
- }
- }
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Return tableau de toutes les photos de la categorie
- *
- * @param string $dir Repertoire a scanner
- * @param int $nbmax Nombre maximum de photos (0=pas de max)
- * @return array Tableau de photos
- */
- public function liste_photos($dir, $nbmax = 0)
- {
- // phpcs:enable
- include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
- $nbphoto = 0;
- $tabobj = array();
- $dirthumb = $dir.'thumbs/';
- if (file_exists($dir)) {
- $handle = opendir($dir);
- if (is_resource($handle)) {
- while (($file = readdir($handle)) !== false) {
- if (dol_is_file($dir.$file) && preg_match('/(\.jpeg|\.jpg|\.bmp|\.gif|\.png|\.tiff)$/i', $dir.$file)) {
- $nbphoto++;
- $photo = $file;
- // On determine nom du fichier vignette
- $photo_vignette = '';
- if (preg_match('/(\.jpeg|\.jpg|\.bmp|\.gif|\.png|\.tiff)$/i', $photo, $regs)) {
- $photo_vignette = preg_replace('/'.$regs[0].'/i', '', $photo).'_small'.$regs[0];
- }
- // Objet
- $obj = array();
- $obj['photo'] = $photo;
- if ($photo_vignette && is_file($dirthumb.$photo_vignette)) {
- $obj['photo_vignette'] = 'thumbs/'.$photo_vignette;
- } else {
- $obj['photo_vignette'] = "";
- }
- $tabobj[$nbphoto - 1] = $obj;
- // On continue ou on arrete de boucler
- if ($nbmax && $nbphoto >= $nbmax) {
- break;
- }
- }
- }
- closedir($handle);
- }
- }
- return $tabobj;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Efface la photo de la categorie et sa vignette
- *
- * @param string $file Path to file
- * @return void
- */
- public function delete_photo($file)
- {
- // phpcs:enable
- require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
- $dir = dirname($file).'/'; // Chemin du dossier contenant l'image d'origine
- $dirthumb = $dir.'/thumbs/'; // Chemin du dossier contenant la vignette
- $filename = preg_replace('/'.preg_quote($dir, '/').'/i', '', $file); // Nom du fichier
- // On efface l'image d'origine
- dol_delete_file($file, 1);
- // Si elle existe, on efface la vignette
- if (preg_match('/(\.jpeg|\.jpg|\.bmp|\.gif|\.png|\.tiff)$/i', $filename, $regs)) {
- $photo_vignette = preg_replace('/'.$regs[0].'/i', '', $filename).'_small'.$regs[0];
- if (file_exists($dirthumb.$photo_vignette)) {
- dol_delete_file($dirthumb.$photo_vignette, 1);
- }
- }
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Load size of image file
- *
- * @param string $file Path to file
- * @return void
- */
- public function get_image_size($file)
- {
- // phpcs:enable
- $infoImg = getimagesize($file); // Recuperation des infos de l'image
- $this->imgWidth = $infoImg[0]; // Largeur de l'image
- $this->imgHeight = $infoImg[1]; // Hauteur de l'image
- }
- /**
- * Update ou cree les traductions des infos produits
- *
- * @param User $user Object user
- *
- * @return int <0 if KO, >0 if OK
- */
- public function setMultiLangs($user)
- {
- global $langs;
- $langs_available = $langs->get_available_languages();
- $current_lang = $langs->getDefaultLang();
- foreach ($langs_available as $key => $value) {
- $sql = "SELECT rowid";
- $sql .= " FROM ".MAIN_DB_PREFIX."categorie_lang";
- $sql .= " WHERE fk_category=".((int) $this->id);
- $sql .= " AND lang = '".$this->db->escape($key)."'";
- $result = $this->db->query($sql);
- if ($key == $current_lang) {
- if ($this->db->num_rows($result)) { // si aucune ligne dans la base
- $sql2 = "UPDATE ".MAIN_DB_PREFIX."categorie_lang";
- $sql2 .= " SET label = '".$this->db->escape($this->label)."',";
- $sql2 .= " description = '".$this->db->escape($this->description)."'";
- $sql2 .= " WHERE fk_category = ".((int) $this->id)." AND lang = '".$this->db->escape($key)."'";
- } else {
- $sql2 = "INSERT INTO ".MAIN_DB_PREFIX."categorie_lang (fk_category, lang, label, description)";
- $sql2 .= " VALUES(".((int) $this->id).", '".$this->db->escape($key)."', '".$this->db->escape($this->label)."'";
- $sql2 .= ", '".$this->db->escape($this->multilangs["$key"]["description"])."')";
- }
- dol_syslog(get_class($this).'::setMultiLangs', LOG_DEBUG);
- if (!$this->db->query($sql2)) {
- $this->error = $this->db->lasterror();
- return -1;
- }
- } elseif (isset($this->multilangs["$key"])) {
- if ($this->db->num_rows($result)) { // si aucune ligne dans la base
- $sql2 = "UPDATE ".MAIN_DB_PREFIX."categorie_lang";
- $sql2 .= " SET label='".$this->db->escape($this->multilangs["$key"]["label"])."',";
- $sql2 .= " description='".$this->db->escape($this->multilangs["$key"]["description"])."'";
- $sql2 .= " WHERE fk_category=".((int) $this->id)." AND lang='".$this->db->escape($key)."'";
- } else {
- $sql2 = "INSERT INTO ".MAIN_DB_PREFIX."categorie_lang (fk_category, lang, label, description)";
- $sql2 .= " VALUES(".((int) $this->id).", '".$this->db->escape($key)."', '".$this->db->escape($this->multilangs["$key"]["label"])."'";
- $sql2 .= ",'".$this->db->escape($this->multilangs["$key"]["description"])."')";
- }
- // on ne sauvegarde pas des champs vides
- if ($this->multilangs["$key"]["label"] || $this->multilangs["$key"]["description"] || $this->multilangs["$key"]["note"]) {
- dol_syslog(get_class($this).'::setMultiLangs', LOG_DEBUG);
- }
- if (!$this->db->query($sql2)) {
- $this->error = $this->db->lasterror();
- return -1;
- }
- }
- }
- // Call trigger
- $result = $this->call_trigger('CATEGORY_SET_MULTILANGS', $user);
- if ($result < 0) {
- $this->error = $this->db->lasterror();
- return -1;
- }
- // End call triggers
- return 1;
- }
- /**
- * Load array this->multilangs
- *
- * @return int <0 if KO, >0 if OK
- */
- public function getMultiLangs()
- {
- global $langs;
- $current_lang = $langs->getDefaultLang();
- $sql = "SELECT lang, label, description";
- $sql .= " FROM ".MAIN_DB_PREFIX."categorie_lang";
- $sql .= " WHERE fk_category=".((int) $this->id);
- $result = $this->db->query($sql);
- if ($result) {
- while ($obj = $this->db->fetch_object($result)) {
- //print 'lang='.$obj->lang.' current='.$current_lang.'<br>';
- if ($obj->lang == $current_lang) { // si on a les traduct. dans la langue courante on les charge en infos principales.
- $this->label = $obj->label;
- $this->description = $obj->description;
- }
- $this->multilangs["$obj->lang"]["label"] = $obj->label;
- $this->multilangs["$obj->lang"]["description"] = $obj->description;
- }
- return 1;
- } else {
- $this->error = $langs->trans("Error")." : ".$this->db->error()." - ".$sql;
- return -1;
- }
- }
- /**
- * Return label of contact status
- *
- * @param int $mode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto
- * @return string Label of contact status
- */
- public function getLibStatut($mode)
- {
- return '';
- }
- /**
- * Initialise an instance with random values.
- * Used to build previews or test instances.
- * id must be 0 if object instance is a specimen.
- *
- * @return void
- */
- public function initAsSpecimen()
- {
- dol_syslog(get_class($this)."::initAsSpecimen");
- // Initialise parametres
- $this->id = 0;
- $this->fk_parent = 0;
- $this->label = 'SPECIMEN';
- $this->specimen = 1;
- $this->description = 'This is a description';
- $this->socid = 1;
- $this->type = self::TYPE_PRODUCT;
- }
- /**
- * Function used to replace a thirdparty id with another one.
- *
- * @param DoliDB $db Database handler
- * @param int $origin_id Old thirdparty id
- * @param int $dest_id New thirdparty id
- * @return bool
- */
- public static function replaceThirdparty(DoliDB $db, $origin_id, $dest_id)
- {
- $tables = array(
- 'categorie_societe'
- );
- return CommonObject::commonReplaceThirdparty($db, $origin_id, $dest_id, $tables, 1);
- }
- /**
- * Return the addtional SQL JOIN query for filtering a list by a category
- *
- * @param string $type The category type (e.g Categorie::TYPE_WAREHOUSE)
- * @param string $rowIdName The name of the row id inside the whole sql query (e.g. "e.rowid")
- * @return string A additional SQL JOIN query
- * @deprecated search on some categories must be done using a WHERE EXISTS or NOT EXISTS and not a LEFT JOIN. @TODO Replace with getWhereQuery($type, $searchCategoryList)
- */
- public static function getFilterJoinQuery($type, $rowIdName)
- {
- if ($type == 'bank_account') {
- $type = 'account';
- }
- return " LEFT JOIN ".MAIN_DB_PREFIX."categorie_".$type." as cp ON ".$rowIdName." = cp.fk_".$type;
- }
- /**
- * Return the addtional SQL SELECT query for filtering a list by a category
- *
- * @param string $type The category type (e.g Categorie::TYPE_WAREHOUSE)
- * @param string $rowIdName The name of the row id inside the whole sql query (e.g. "e.rowid")
- * @param Array $searchList A list with the selected categories
- * @return string A additional SQL SELECT query
- * @deprecated search on some categories must be done using a WHERE EXISTS or NOT EXISTS and not a LEFT JOIN
- */
- public static function getFilterSelectQuery($type, $rowIdName, $searchList)
- {
- if ($type == 'bank_account') {
- $type = 'account';
- }
- if ($type == 'customer') {
- $type = 'societe';
- }
- if ($type == 'supplier') {
- $type = 'fournisseur';
- }
- if (empty($searchList) && !is_array($searchList)) {
- return "";
- }
- $searchCategorySqlList = array();
- foreach ($searchList as $searchCategory) {
- if (intval($searchCategory) == -2) {
- $searchCategorySqlList[] = " cp.fk_categorie IS NULL";
- } elseif (intval($searchCategory) > 0) {
- $searchCategorySqlList[] = " ".$rowIdName." IN (SELECT fk_".$type." FROM ".MAIN_DB_PREFIX."categorie_".$type." WHERE fk_categorie = ".((int) $searchCategory).")";
- }
- }
- if (!empty($searchCategorySqlList)) {
- return " AND (".implode(' AND ', $searchCategorySqlList).")";
- } else {
- return "";
- }
- }
- /**
- * Count all categories
- *
- * @return int Number of categories, -1 on error
- */
- public function countNbOfCategories()
- {
- dol_syslog(get_class($this)."::count_all_categories", LOG_DEBUG);
- $sql = "SELECT COUNT(rowid) FROM ".MAIN_DB_PREFIX."categorie";
- $sql .= " WHERE entity IN (".getEntity('category').")";
- $res = $this->db->query($sql);
- if ($res) {
- $obj = $this->db->fetch_object($res);
- return $obj->count;
- } else {
- dol_print_error($this->db);
- return -1;
- }
- }
- }
|