dolibarr 20.0.0
|
Class to manage categories. More...
Public Member Functions | |
__construct ($db) | |
Constructor. | |
getMapList () | |
Get map list. | |
fetch ($id, $label='', $type=null, $ref_ext='') | |
Load category into memory from database. | |
create ($user, $notrigger=0) | |
Add category into database. | |
update (User $user, $notrigger=0) | |
Update category. | |
delete ($user, $notrigger=0) | |
Delete a category from database. | |
add_type ($obj, $type='') | |
Link an object to the category. | |
del_type ($obj, $type) | |
Delete object from category. | |
getObjectsInCateg ($type, $onlyids=0, $limit=0, $offset=0, $sortfield='', $sortorder='ASC', $filter='', $filtermode='AND') | |
Return list of fetched instance of elements having this category. | |
containsObject ($type, $object_id) | |
Check for the presence of an object in a category. | |
getListForItem ($id, $type='customer', $sortfield="s.rowid", $sortorder='ASC', $limit=0, $page=0) | |
List categories of an element id. | |
get_filles () | |
Return direct children ids of a category into an array. | |
get_full_arbo ($type, $fromid=0, $include=0) | |
Rebuilding the category tree as an array Return an array of table('id','id_mere',...) sorted to have a human readable tree, with id = id of category id_mere = id of parent category id_children = array of child ids label = name of category fulllabel = Name with full path for the category fullpath = Full path built with the id's. | |
get_all_categories ($type=null, $parent=false) | |
Returns all categories. | |
get_main_categories ($type=null) | |
Returns the top level categories (which are not child) | |
already_exists () | |
Check if a category with same label already exists for this cat's parent or root and for this cat's type. | |
print_all_ways ($sep='>>', $url='', $nocolor=0, $addpicto=0) | |
Returns the path of the category, with the names of the categories separated by $sep (" >> " by default) | |
get_meres () | |
Returns an array containing the list of parent categories. | |
get_all_ways () | |
Returns in a table all possible paths to get to the category starting with the major categories represented by Tables of categories. | |
containing ($id, $type, $mode='object') | |
Return list of categories (object instances or labels) linked to element of id $id and type $type Should be named getListOfCategForObject. | |
rechercher ($id, $nom, $type, $exact=false, $case=false) | |
Returns categories whose id or name match add wildcards in the name unless $exact = true. | |
isAnyPhotoAvailable ($sdir) | |
Return if at least one photo is available. | |
getTooltipContentArray ($params) | |
getTooltipContentArray | |
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. | |
add_photo ($sdir, $file) | |
Add the image uploaded as $file to the directory $sdir/<category>-<id>/photos/. | |
liste_photos ($dir, $nbmax=0) | |
Return an array with all photos inside the directory. | |
delete_photo ($file) | |
Efface la photo de la categorie et sa vignette. | |
get_image_size ($file) | |
Load size of image file. | |
setMultiLangs (User $user, $notrigger=0) | |
Update ou cree les traductions des infos produits. | |
getMultiLangs () | |
Load array this->multilangs. | |
getLibStatut ($mode) | |
Return label of contact status. | |
initAsSpecimen () | |
Initialise an instance with random values. | |
countNbOfCategories () | |
Count all categories. | |
Public Member Functions inherited from CommonObject | |
isEmpty () | |
isEmpty We consider CommonObject isEmpty if this->id is empty | |
setErrorsFromObject ($object) | |
setErrorsFromObject | |
getTooltipContent ($params) | |
getTooltipContent | |
errorsToString () | |
Method to output saved errors. | |
getFormatedCustomerRef ($objref) | |
Return customer ref for screen output. | |
getFormatedSupplierRef ($objref) | |
Return supplier ref for screen output. | |
getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='') | |
Return full address of contact. | |
getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0) | |
Return the link of last main doc file for direct public download. | |
add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0) | |
Add a link between element $this->element and a contact. | |
copy_linked_contact ($objFrom, $source='internal') | |
Copy contact from one element to current. | |
update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0) | |
Update a link to contact line. | |
delete_contact ($rowid, $notrigger=0) | |
Delete a link to contact line. | |
delete_linked_contact ($source='', $code='') | |
Delete all links between an object $this and all its contacts in llx_element_contact. | |
liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array()) | |
Get array of all contacts for an object. | |
swapContactStatus ($rowid) | |
Update status of a contact linked to object. | |
liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='') | |
Return array with list of possible values for type of contacts. | |
listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='') | |
Return array with list of possible values for type of contacts. | |
getIdContact ($source, $code, $status=0) | |
Return id of contacts for a source and a contact code. | |
fetch_contact ($contactid=null) | |
Load object contact with id=$this->contact_id into $this->contact. | |
fetch_thirdparty ($force_thirdparty_id=0) | |
Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. | |
fetchOneLike ($ref) | |
Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. | |
fetch_barcode () | |
Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. | |
fetch_project () | |
Load the project with id $this->fk_project into this->project. | |
fetch_projet () | |
Load the project with id $this->fk_project into this->project. | |
fetch_product () | |
Load the product with id $this->fk_product into this->product. | |
fetch_user ($userid) | |
Load the user with id $userid into this->user. | |
fetch_origin () | |
Read linked origin object. | |
fetchObjectFrom ($table, $field, $key, $element=null) | |
Load object from specific field. | |
getValueFrom ($table, $id, $field) | |
Getter generic. | |
setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif') | |
Setter generic. | |
load_previous_next_ref ($filter, $fieldid, $nodbprefix=0) | |
Load properties id_previous and id_next by comparing $fieldid with $this->ref. | |
getListContactId ($source='external') | |
Return list of id of contacts of object. | |
setProject ($projectid, $notrigger=0) | |
Link element with a project. | |
setPaymentMethods ($id) | |
Change the payments methods. | |
setMulticurrencyCode ($code) | |
Change the multicurrency code. | |
setPaymentTerms ($id, $deposit_percent=null) | |
Change the payments terms. | |
setTransportMode ($id) | |
Change the transport mode methods. | |
setRetainedWarrantyPaymentTerms ($id) | |
Change the retained warranty payments terms. | |
setDeliveryAddress ($id) | |
Define delivery address. | |
setShippingMethod ($shipping_method_id, $notrigger=0, $userused=null) | |
Change the shipping method. | |
setWarehouse ($warehouse_id) | |
Change the warehouse. | |
setDocModel ($user, $modelpdf) | |
Set last model used by doc generator. | |
setBankAccount ($fk_account, $notrigger=0, $userused=null) | |
Change the bank account. | |
line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true) | |
Save a new position (field rang) for details lines. | |
getChildrenOfLine ($id, $includealltree=0) | |
Get children of line. | |
line_up ($rowid, $fk_parent_line=true) | |
Update a line to have a lower rank. | |
line_down ($rowid, $fk_parent_line=true) | |
Update a line to have a higher rank. | |
updateRangOfLine ($rowid, $rang) | |
Update position of line (rang) | |
line_ajaxorder ($rows) | |
Update position of line with ajax (rang) | |
updateLineUp ($rowid, $rang) | |
Update position of line up (rang) | |
updateLineDown ($rowid, $rang, $max) | |
Update position of line down (rang) | |
getRangOfLine ($rowid) | |
Get position of line (rang) | |
getIdOfLine ($rang) | |
Get rowid of the line relative to its position. | |
line_max ($fk_parent_line=0) | |
Get max value used for position of line (rang) | |
update_ref_ext ($ref_ext) | |
Update external ref of element. | |
update_note ($note, $suffix='', $notrigger=0) | |
Update note of element. | |
update_note_public ($note) | |
Update public note (kept for backward compatibility) | |
update_price ($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null) | |
Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). | |
add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0) | |
Add an object link into llx_element_element. | |
getElementType () | |
Return an element type string formatted like element_element target_type and source_type. | |
fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1) | |
Fetch array of objects linked to current object (object of enabled modules only). | |
clearObjectLinkedCache () | |
Clear the cache saying that all linked object were already loaded. | |
updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0) | |
Update object linked of a current object. | |
deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0) | |
Delete all links between an object $this. | |
setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut') | |
Set status of an object. | |
getCanvas ($id=0, $ref='') | |
Load type of canvas of an object if it exists. | |
getSpecialCode ($lineid) | |
Get special code of a line. | |
isObjectUsed ($id=0, $entity=0) | |
Function to check if an object is used by others (by children). | |
hasProductsOrServices ($predefined=-1) | |
Function to say how many lines object contains. | |
getTotalDiscount () | |
Function that returns the total amount HT of discounts applied for all lines. | |
getTotalWeightVolume () | |
Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. | |
setExtraParameters () | |
Set extra parameters. | |
formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl') | |
Show add free and predefined products/services form. | |
printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl') | |
Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects. | |
printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl') | |
Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) | |
printOriginLinesList ($restrictlist='', $selectedLines=array()) | |
Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). | |
printOriginLine ($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array()) | |
Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). | |
add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0) | |
Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. | |
delete_resource ($rowid, $element, $notrigger=0) | |
Delete a link to resource line. | |
__clone () | |
Overwrite magic function to solve problem of cloning object that are kept as references. | |
indexFile ($destfull, $update_main_doc_field) | |
Index a file into the ECM database. | |
addThumbs ($file) | |
Build thumb. | |
delThumbs ($file) | |
Delete thumbs. | |
getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml') | |
Return the default value to use for a field when showing the create form of object. | |
call_trigger ($triggerName, $user) | |
Call trigger based on this instance. | |
fetchValuesForExtraLanguages () | |
Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately. | |
setValuesForExtraLanguages ($onlykey='') | |
Fill array_options property of object by extrafields value (using for data sent by forms) | |
fetchNoCompute ($id) | |
Function to make a fetch but set environment to avoid to load computed values before. | |
fetch_optionals ($rowid=null, $optionsArray=null) | |
Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately. | |
deleteExtraFields () | |
Delete all extra fields values for the current object. | |
insertExtraFields ($trigger='', $userused=null) | |
Add/Update all extra fields values for the current object. | |
insertExtraLanguages ($trigger='', $userused=null) | |
Add/Update all extra fields values for the current object. | |
updateExtraField ($key, $trigger=null, $userused=null) | |
Update 1 extra field value for the current object. | |
getExtraField ($key) | |
Convenience method for retrieving the value of an extrafield without actually fetching it from the database. | |
setExtraField ($key, $value) | |
Convenience method for setting the value of an extrafield without actually updating it in the database. | |
updateExtraLanguages ($key, $trigger=null, $userused=null) | |
Update an extra language value for the current object. | |
showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0) | |
Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. | |
clearFieldError ($fieldKey) | |
clear validation message result for a field | |
setFieldError ($fieldKey, $msg='') | |
set validation error message a field | |
getFieldError ($fieldKey) | |
get field error message | |
validateField ($fields, $fieldKey, $fieldValue) | |
Return validation test result for a field. | |
showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card') | |
Function to show lines of extrafields with output data. | |
getJSListDependancies ($type='_extra') | |
getRights () | |
Returns the rights used for this class. | |
defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0) | |
Get buy price to use for margin calculation. | |
getDataToShowPhoto ($modulepart, $imagesize) | |
Function used to get the logos or photos of an object. | |
show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref') | |
Show photos of an object (nbmax maximum), into several columns. | |
isDate ($info) | |
Function test if type is date. | |
isDuration ($info) | |
Function test if type is duration. | |
isInt ($info) | |
Function test if type is integer. | |
isFloat ($info) | |
Function test if type is float. | |
isText ($info) | |
Function test if type is text. | |
setVarsFromFetchObj (&$obj) | |
Function to load data from a SQL pointer into properties of current object $this. | |
emtpyObjectVars () | |
Sets all object fields to null. | |
getFieldList ($alias='', $excludefields=array()) | |
Function to concat keys of fields. | |
createCommon (User $user, $notrigger=0) | |
Create object in the database. | |
fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0) | |
Load object in memory from the database. | |
fetchLinesCommon ($morewhere='', $noextrafields=0) | |
Load object in memory from the database. | |
updateCommon (User $user, $notrigger=0) | |
Update object into database. | |
deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0) | |
Delete object in database. | |
deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND") | |
Delete all child object from a parent ID. | |
deleteLineCommon (User $user, $idline, $notrigger=0) | |
Delete a line of object in database. | |
setStatusCommon ($user, $status, $notrigger=0, $triggercode='') | |
Set to a status. | |
setSignedStatusCommon ($user, $status, $notrigger=0, $triggercode='') | |
Set to a signed status. | |
initAsSpecimenCommon () | |
Initialise object with example values Id must be 0 if object instance is a specimen. | |
fetchComments () | |
Load comments linked with current task. | |
getNbComments () | |
Return nb comments already posted. | |
trimParameters ($parameters) | |
Trim object parameters. | |
getCategoriesCommon ($type_categ) | |
Sets object to given categories. | |
setCategoriesCommon ($categories, $type_categ='', $remove_existing=true) | |
Sets object to given categories. | |
cloneCategories ($fromId, $toId, $type='') | |
Copy related categories to another object. | |
deleteEcmFiles ($mode=0) | |
Delete related files of object in database. | |
Static Public Member Functions | |
static | replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id) |
Function used to replace a thirdparty id with another one. | |
static | getFilterJoinQuery ($type, $rowIdName) |
Return the additional SQL JOIN query for filtering a list by a category. | |
static | getFilterSelectQuery ($type, $rowIdName, $searchList) |
Return the additional SQL SELECT query for filtering a list by a category. | |
Static Public Member Functions inherited from CommonObject | |
static | isExistingObject ($element, $id, $ref='', $ref_ext='') |
Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch. | |
static | getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element) |
Function used to get an array with all items linked to an object id in association table. | |
static | getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element) |
Count items linked to an object id in association table. | |
static | deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element) |
Function used to remove all items linked to an object id in association table. | |
static | commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0) |
Function used to replace a thirdparty id with another one. | |
static | commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0) |
Function used to replace a product id with another one. | |
Protected Member Functions | |
load_motherof () | |
Load the array this->motherof that is array(id_son=>id_parent, ...) | |
Protected Member Functions inherited from CommonObject | |
deprecatedProperties () | |
Provide list of deprecated properties and replacements. | |
commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null) | |
Common function for all objects extending CommonObject for generating documents. | |
isArray ($info) | |
Function test if type is array. | |
canBeNull ($info) | |
Function test if field can be null. | |
isForcedToNullIfZero ($info) | |
Function test if field is forced to null if zero or empty. | |
isIndex ($info) | |
Function test if is indexed. | |
setSaveQuery () | |
Function to return the array of data key-value from the ->fields and all the ->properties of an object. | |
quote ($value, $fieldsentry) | |
Add quote to field value if necessary. | |
Private Member Functions | |
buildPathFromId ($id_categ, $protection=1000) | |
For category id_categ and its children available in this->cats, define property fullpath and fulllabel. | |
Additional Inherited Members | |
Public Attributes inherited from CommonObject | |
$origin_object | |
Class to manage categories.
Definition at line 48 of file categorie.class.php.
Categorie::__construct | ( | $db | ) |
Constructor.
Definition at line 293 of file categorie.class.php.
Categorie::add_photo | ( | $sdir, | |
$file ) |
Add the image uploaded as $file to the directory $sdir/<category>-<id>/photos/.
string | $sdir | Root destination directory |
array | $file | Uploaded file name |
Definition at line 1818 of file categorie.class.php.
References CommonObject\addThumbs(), dol_mkdir(), dol_move_uploaded_file(), and get_exdir().
Categorie::add_type | ( | $obj, | |
$type = '' ) |
Link an object to the category.
CommonObject | $obj | Object to link to category |
string | $type | Type of category ('product', ...). Use '' to take $obj->element. |
Definition at line 723 of file categorie.class.php.
References CommonObject\call_trigger(), dol_syslog(), and getDolGlobalString().
Categorie::already_exists | ( | ) |
Check if a category with same label already exists for this cat's parent or root and for this cat's type.
Definition at line 1355 of file categorie.class.php.
References dol_syslog().
|
private |
For category id_categ and its children 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.
int | $id_categ | id_categ entry to update |
int | $protection | Deep counter to avoid infinite loop |
Definition at line 1258 of file categorie.class.php.
References dol_syslog().
Referenced by get_full_arbo().
Categorie::containing | ( | $id, | |
$type, | |||
$mode = 'object' ) |
Return list of categories (object instances or labels) linked to element of id $id and type $type Should be named getListOfCategForObject.
int | $id | Id of element |
string | int | $type | Type of category ('customer', 'supplier', 'contact', 'product', 'member') or (0, 1, 2, ...) |
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 |
Definition at line 1528 of file categorie.class.php.
References dol_print_error().
Categorie::containsObject | ( | $type, | |
$object_id ) |
Check for the presence of an object in a category.
string | $type | Type of category ('customer', 'supplier', 'contact', 'product', 'member') |
int | $object_id | Id of the object to search |
Definition at line 947 of file categorie.class.php.
References dol_syslog().
Categorie::countNbOfCategories | ( | ) |
Count all categories.
Definition at line 2184 of file categorie.class.php.
References dol_print_error(), and dol_syslog().
Categorie::create | ( | $user, | |
$notrigger = 0 ) |
Add category into database.
User | $user | Object user |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 430 of file categorie.class.php.
References already_exists(), CommonObject\call_trigger(), description, dol_now(), dol_syslog(), getDolGlobalString(), CommonObject\insertExtraFields(), and position.
Categorie::del_type | ( | $obj, | |
$type ) |
Delete object from category.
CommonObject | $obj | Object |
string | $type | Type of category ('customer', 'supplier', 'contact', 'product', 'member') |
Definition at line 816 of file categorie.class.php.
References CommonObject\call_trigger(), and dol_syslog().
Categorie::delete | ( | $user, | |
$notrigger = 0 ) |
Delete a category from database.
User | $user | Object user that ask to delete |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 630 of file categorie.class.php.
References CommonObject\call_trigger(), CommonObject\deleteExtraFields(), and dol_syslog().
Categorie::delete_photo | ( | $file | ) |
Efface la photo de la categorie et sa vignette.
string | $file | Path to file |
Definition at line 1923 of file categorie.class.php.
References dol_delete_file().
Categorie::fetch | ( | $id, | |
$label = '', | |||
$type = null, | |||
$ref_ext = '' ) |
Load category into memory from database.
int | $id | Id of category |
string | $label | Label of category |
string | $type | Type of category ('product', '...') or (0, 1, ...) |
string | $ref_ext | External reference of object |
Definition at line 350 of file categorie.class.php.
References description, dol_print_error(), dol_syslog(), CommonObject\fetch_optionals(), getDolGlobalInt(), getEntity(), getMultiLangs(), position, and type.
Categorie::get_all_categories | ( | $type = null, | |
$parent = false ) |
Returns all categories.
int | $type | Type of category (0, 1, ...) |
boolean | $parent | Just parent categories if true |
Definition at line 1305 of file categorie.class.php.
References dol_print_error().
Referenced by get_main_categories().
Categorie::get_all_ways | ( | ) |
Returns in a table all possible paths to get to the category starting with the major categories represented by Tables of categories.
Definition at line 1494 of file categorie.class.php.
References get_meres().
Referenced by print_all_ways().
Categorie::get_filles | ( | ) |
Return direct children ids of a category into an array.
Definition at line 1071 of file categorie.class.php.
References dol_print_error().
Categorie::get_full_arbo | ( | $type, | |
$fromid = 0, | |||
$include = 0 ) |
Rebuilding the category tree as an array Return an array of table('id','id_mere',...) sorted to have a human readable tree, with id = id of category id_mere = id of parent category id_children = array of child ids label = name of category fulllabel = Name with full path for the category fullpath = Full path built with the id's.
string | $type | Type of categories ('customer', 'supplier', 'contact', 'product', 'member', ...) |
int | string | array | $fromid | Keep only or Exclude (depending on $include parameter) all categories (including the leaf $fromid) into the tree after this id $fromid. $fromid can be an :
|
int | $include | [=0] Removed or 1=Keep only |
Definition at line 1143 of file categorie.class.php.
References buildPathFromId(), dol_print_error(), dol_sort_array(), dol_syslog(), getDolGlobalInt(), and load_motherof().
Categorie::get_image_size | ( | $file | ) |
Load size of image file.
string | $file | Path to file |
Definition at line 1952 of file categorie.class.php.
Categorie::get_main_categories | ( | $type = null | ) |
Returns the top level categories (which are not child)
int | $type | Type of category (0, 1, ...) |
Definition at line 1343 of file categorie.class.php.
References get_all_categories().
Categorie::get_meres | ( | ) |
Returns an array containing the list of parent categories.
Definition at line 1462 of file categorie.class.php.
References dol_print_error().
Referenced by get_all_ways().
|
static |
Return the additional SQL JOIN query for filtering a list by a category.
string | $type | The category type (e.g Categorie\TYPE_WAREHOUSE) |
string | $rowIdName | The name of the row id inside the whole sql query (e.g. "e.rowid") |
Definition at line 2129 of file categorie.class.php.
|
static |
Return the additional SQL SELECT query for filtering a list by a category.
string | $type | The category type (e.g Categorie\TYPE_WAREHOUSE) |
string | $rowIdName | The name of the row id inside the whole sql query (e.g. "e.rowid") |
Array | $searchList | A list with the selected categories |
Definition at line 2147 of file categorie.class.php.
Categorie::getLibStatut | ( | $mode | ) |
Return label of contact status.
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 |
Definition at line 2075 of file categorie.class.php.
Categorie::getListForItem | ( | $id, | |
$type = 'customer', | |||
$sortfield = "s.rowid", | |||
$sortorder = 'ASC', | |||
$limit = 0, | |||
$page = 0 ) |
List categories of an element id.
int | $id | Id of element |
string | $type | Type of category ('member', 'customer', 'supplier', 'product', 'contact') |
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
Definition at line 974 of file categorie.class.php.
References getDolGlobalInt(), and sanitizeVal().
Categorie::getMapList | ( | ) |
Categorie::getMultiLangs | ( | ) |
Load array this->multilangs.
Definition at line 2041 of file categorie.class.php.
References description.
Referenced by fetch().
Categorie::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.
int | $withpicto | 0=No picto, 1=Include picto into link, 2=Only picto |
string | $option | On what the link point to ('nolink', ...) |
int | $maxlength | Max length of text |
string | $moreparam | More param on URL link |
int | $notooltip | 1=Disable tooltip |
string | $morecss | Add more css on link |
int | $save_lastsearch_value | -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking |
Definition at line 1716 of file categorie.class.php.
References colorIsLight(), dol_trunc(), getDolGlobalInt(), getTooltipContentArray(), img_object(), ref, and type.
Categorie::getObjectsInCateg | ( | $type, | |
$onlyids = 0, | |||
$limit = 0, | |||
$offset = 0, | |||
$sortfield = '', | |||
$sortorder = 'ASC', | |||
$filter = '', | |||
$filtermode = 'AND' ) |
Return list of fetched instance of elements having this category.
string | $type | Type of category ('customer', 'supplier', 'contact', 'product', 'member', 'knowledge_management', ...) |
int | $onlyids | Return only ids of objects (consume less memory) |
int | $limit | Limit |
int | $offset | Offset |
string | $sortfield | Sort fields |
string | $sortorder | Sort order ('ASC' or 'DESC'); |
string | $filter | Filter as an Universal Search string. Example: '((client:=:1) OR ((client:>=:2) AND (client:<=:3))) AND (client:!=:8) AND (nom:like:'a')' |
string | $filtermode | No more used |
Definition at line 877 of file categorie.class.php.
References dol_syslog(), and forgeSQLFromUniversalSearchCriteria().
Categorie::getTooltipContentArray | ( | $params | ) |
getTooltipContentArray
array | $params | params to construct tooltip data |
Reimplemented from CommonObject.
Definition at line 1690 of file categorie.class.php.
References ref.
Referenced by getNomUrl().
Categorie::initAsSpecimen | ( | ) |
Initialise an instance with random values.
Used to build previews or test instances. id must be 0 if object instance is a specimen.
Definition at line 2088 of file categorie.class.php.
References description, dol_syslog(), and type.
Categorie::isAnyPhotoAvailable | ( | $sdir | ) |
Return if at least one photo is available.
string | $sdir | Directory to scan |
Definition at line 1660 of file categorie.class.php.
References dol_is_file(), dol_osencode(), get_exdir(), image_format_supported(), and utf8_check().
Categorie::liste_photos | ( | $dir, | |
$nbmax = 0 ) |
Return an array with all photos inside the directory.
string | $dir | Dir to scan |
int | $nbmax | Nombre maximum de photos (0=pas de max) |
Definition at line 1866 of file categorie.class.php.
References dol_is_file().
|
protected |
Load the array this->motherof that is array(id_son=>id_parent, ...)
Definition at line 1099 of file categorie.class.php.
References dol_print_error(), and dol_syslog().
Referenced by get_full_arbo().
Categorie::print_all_ways | ( | $sep = '>>', | |
$url = '', | |||
$nocolor = 0, | |||
$addpicto = 0 ) |
Returns the path of the category, with the names of the categories separated by $sep (" >> " by default)
string | $sep | Separator |
string | $url | Url ('', 'none' or 'urltouse') |
int | $nocolor | 0 |
int | $addpicto | Add picto into link |
Definition at line 1409 of file categorie.class.php.
References colorIsLight(), get_all_ways(), and img_object().
Categorie::rechercher | ( | $id, | |
$nom, | |||
$type, | |||
$exact = false, | |||
$case = false ) |
Returns categories whose id or name match add wildcards in the name unless $exact = true.
int | $id | Id |
string | $nom | Name |
string | $type | Type of category ('member', 'customer', 'supplier', 'product', 'contact'). Old mode (0, 1, 2, ...) is deprecated. |
boolean | $exact | Exact string search (true/false) |
boolean | $case | Case sensitive (true/false) |
Definition at line 1604 of file categorie.class.php.
References dol_syslog().
|
static |
Function used to replace a thirdparty id with another one.
DoliDB | $dbs | Database handler, because function is static we name it $dbs not $db to avoid breaking coding test |
int | $origin_id | Old thirdparty id |
int | $dest_id | New thirdparty id |
Definition at line 2112 of file categorie.class.php.
References CommonObject\commonReplaceThirdparty().
Categorie::setMultiLangs | ( | User | $user, |
$notrigger = 0 ) |
Update ou cree les traductions des infos produits.
User | $user | Object user |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 1968 of file categorie.class.php.
References CommonObject\call_trigger(), description, and dol_syslog().
Categorie::update | ( | User | $user, |
$notrigger = 0 ) |
Update category.
User | $user | Object user |
int | $notrigger | 1=Does not execute triggers, 0= execute triggers |
Definition at line 553 of file categorie.class.php.
References already_exists(), CommonObject\call_trigger(), description, dol_print_error(), dol_syslog(), getDolGlobalString(), CommonObject\insertExtraFields(), and position.