dolibarr  7.0.0-beta
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Dolresource Class Reference

DAO Resource object. More...

+ Inheritance diagram for Dolresource:
+ Collaboration diagram for Dolresource:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 create ($user, $notrigger=0)
 Create object into database. More...
 
 fetch ($id, $ref='')
 Load object in memory from database. More...
 
 update ($user=null, $notrigger=0)
 Update object into database. More...
 
 fetch_element_resource ($id)
 Load object in memory from database. More...
 
 delete ($rowid, $notrigger=0)
 Delete a resource object. More...
 
 fetch_all ($sortorder, $sortfield, $limit, $offset, $filter='')
 Load resource objects into $this->lines. More...
 
 fetch_all_resources ($sortorder, $sortfield, $limit, $offset, $filter='')
 Load all objects into $this->lines. More...
 
 fetch_all_used ($sortorder, $sortfield, $limit, $offset=1, $filter='')
 Load all objects into $this->lines. More...
 
 fetch_all_available ()
 Fetch all resources available, declared by modules Load available resource in array $this->available_resources. More...
 
 update_element_resource ($user=null, $notrigger=0)
 Update element resource into database. More...
 
 getElementResources ($element, $element_id, $resource_type='')
 Return an array with resources linked to the element. More...
 
 load_cache_code_type_resource ()
 Load in cache resource type code (setup in dictionary) More...
 
 getNomUrl ($withpicto=0, $option='', $get_params='', $notooltip=0)
 Return clicable link of object (with eventually picto) More...
 
 getLibStatut ($mode=0)
 Retourne le libelle du status d'un user (actif, inactif) More...
 
- Public Member Functions inherited from CommonObject
 errorsToString ()
 Method to output saved errors. More...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 getFullAddress ($withcountry=0, $sep="\n")
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=0)
 Return the link of last main doc file for direct public download. More...
 
 add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
 Add a link between element $this->element and a contact. More...
 
 copy_linked_contact ($objFrom, $source='internal')
 Copy contact from one element to current. More...
 
 update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
 Update a link to contact line. More...
 
 delete_contact ($rowid, $notrigger=0)
 Delete a link to contact line. More...
 
 delete_linked_contact ($source='', $code='')
 Delete all links between an object $this and all its contacts. More...
 
 liste_contact ($statut=-1, $source='external', $list=0, $code='')
 Get array of all contacts for an object. More...
 
 swapContactStatus ($rowid)
 Update status of a contact linked to object. More...
 
 liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
 Return array with list of possible values for type of contacts. More...
 
 getIdContact ($source, $code, $status=0)
 Return id of contacts for a source and a contact code. More...
 
 fetch_contact ($contactid=null)
 Load object contact with id=$this->contactid into $this->contact. More...
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...
 
 fetchOneLike ($ref)
 Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More...
 
 fetch_barcode ()
 Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More...
 
 fetch_projet ()
 Charge le projet d'id $this->fk_project dans this->projet. More...
 
 fetch_user ($userid)
 Charge le user d'id userid dans this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key)
 Load object from specific field. More...
 
 getValueFrom ($table, $id, $field)
 Getter generic. More...
 
 setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='')
 Setter generic. More...
 
 load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
 Load properties id_previous and id_next by comparing $fieldid with $this->ref. More...
 
 getListContactId ($source='external')
 Return list of id of contacts of project. More...
 
 setProject ($projectid)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setMulticurrencyRate ($rate, $mode=1)
 Change the multicurrency rate. More...
 
 setPaymentTerms ($id)
 Change the payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id)
 Change the shipping method. More...
 
 setWarehouse ($warehouse_id)
 Change the warehouse. More...
 
 setDocModel ($user, $modelpdf)
 Set last model used by doc generator. More...
 
 setBankAccount ($fk_account)
 Change the bank account. More...
 
 line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
 Save a new position (field rang) for details lines. More...
 
 getChildrenOfLine ($id)
 Get children of line. More...
 
 line_up ($rowid, $fk_parent_line=true)
 Update a line to have a lower rank. More...
 
 line_down ($rowid, $fk_parent_line=true)
 Update a line to have a higher rank. More...
 
 updateRangOfLine ($rowid, $rang)
 Update position of line (rang) More...
 
 line_ajaxorder ($rows)
 Update position of line with ajax (rang) More...
 
 updateLineUp ($rowid, $rang)
 Update position of line up (rang) More...
 
 updateLineDown ($rowid, $rang, $max)
 Update position of line down (rang) More...
 
 getRangOfLine ($rowid)
 Get position of line (rang) More...
 
 getIdOfLine ($rang)
 Get rowid of the line relative to its position. More...
 
 line_max ($fk_parent_line=0)
 Get max value used for position of line (rang) More...
 
 update_ref_ext ($ref_ext)
 Update external ref of element. More...
 
 update_note ($note, $suffix='')
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust='none', $nodatabaseupdate=0, $seller=null)
 Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...
 
 add_object_linked ($origin=null, $origin_id=null)
 Add objects linked in llx_element_element. More...
 
 fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1)
 Fetch array of objects linked to current object. More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='')
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='')
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='')
 Set status of an object. More...
 
 getCanvas ($id=0, $ref='')
 Load type of canvas of an object if it exists. More...
 
 getSpecialCode ($lineid)
 Get special code of a line. More...
 
 isObjectUsed ($id=0)
 Function to check if an object is used by others. More...
 
 hasProductsOrServices ($predefined=-1)
 Function to say how many lines object contains. More...
 
 getTotalDiscount ()
 Function that returns the total amount HT of discounts applied for all lines. More...
 
 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. More...
 
 setExtraParameters ()
 Set extra parameters. More...
 
 display_incoterms ()
 Return incoterms informations TODO Use a cache for label get. More...
 
 getIncotermsForPDF ()
 Return incoterms informations for pdf display. More...
 
 setIncoterms ($id_incoterm, $location)
 Define incoterms values of current object. More...
 
 isInEEC ()
 Return if a country is inside the EEC (European Economic Community) More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer)
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0)
 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'st possible as we keep a method available on overloaded objects. More...
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafieldsline=0)
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='')
 Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 printOriginLine ($line, $var, $restrictlist='')
 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). More...
 
 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. More...
 
 delete_resource ($rowid, $element, $notrigger=0)
 Delete a link to resource line. More...
 
 __clone ()
 Overwrite magic function to solve problem of cloning object that are kept as references. More...
 
 addThumbs ($file)
 Build thumb. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($trigger_name, $user)
 Call trigger based on this instance. More...
 
 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. More...
 
 deleteExtraFields ()
 Delete all extra fields values for the current object. More...
 
 insertExtraFields ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key)
 Update an exta field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='')
 Function to show lines of extrafields with output datas. More...
 
 getRights ()
 Returns the rights used for this class. More...
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 isInt ($info)
 Function test if type is integer. More...
 
 isFloat ($info)
 Function test if type is float. More...
 
 isText ($info)
 Function test if type is text. More...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null)
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false)
 Delete object in database. More...
 
 initAsSpecimenCommon ()
 Initialise object with example values Id must be 0 if object instance is a specimen. More...
 
 fetchComments ()
 Load comments linked with current task. More...
 
 getNbComments ()
 Return nb comments already posted. More...
 

Static Public Member Functions

static LibStatut ($status, $mode=0)
 Return the status. More...
 
- Static Public Member Functions inherited from CommonObject
static isExistingObject ($element, $id, $ref='', $ref_ext='')
 Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch. More...
 
static commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 

Public Attributes

 $element ='dolresource'
 Id that identify managed objects.
 
 $table_element ='resource'
 Name of table without prefix where object is stored.
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
 Common function for all objects extending CommonObject for generating documents. More...
 
 isArray ($info)
 Function test if type is array. More...
 
 isNull ($info)
 Function test if type is null. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

DAO Resource object.

Definition at line 31 of file dolresource.class.php.

Constructor & Destructor Documentation

Dolresource::__construct (   $db)

Constructor.

Parameters
DoliDb$dbDatabase handler

Definition at line 54 of file dolresource.class.php.

Member Function Documentation

Dolresource::create (   $user,
  $notrigger = 0 
)

Create object into database.

Parameters
User$userUser that creates
int$notrigger0=launch triggers after, 1=disable triggers
Returns
int <0 if KO, Id of created object if OK

Definition at line 67 of file dolresource.class.php.

References $resql, description, dol_syslog(), and CommonObject\insertExtraFields().

Dolresource::delete (   $rowid,
  $notrigger = 0 
)

Delete a resource object.

Parameters
int$rowidId of resource line to delete
int$notriggerDisable all triggers
Returns
int >0 if OK, <0 if KO

Definition at line 414 of file dolresource.class.php.

References $resql, CommonObject\call_trigger(), CommonObject\deleteExtraFields(), dol_delete_dir_recursive(), dol_sanitizeFileName(), and dol_syslog().

Dolresource::fetch (   $id,
  $ref = '' 
)

Load object in memory from database.

Parameters
int$idId of object
string$refRef of object
Returns
int <0 if KO, >0 if OK

Definition at line 179 of file dolresource.class.php.

References $resql, description, dol_syslog(), and CommonObject\fetch_optionals().

Dolresource::fetch_all (   $sortorder,
  $sortfield,
  $limit,
  $offset,
  $filter = '' 
)

Load resource objects into $this->lines.

Parameters
string$sortordersort order
string$sortfieldsort field
int$limitlimit page
int$offsetpage
array$filterfilter output
Returns
int <0 if KO, >0 if OK

Definition at line 503 of file dolresource.class.php.

References $resql, and dol_syslog().

Dolresource::fetch_all_available ( )

Fetch all resources available, declared by modules Load available resource in array $this->available_resources.

Returns
int number of available resources declared by modules
Deprecated:
, remplaced by hook getElementResources
See also
getElementResources()

Definition at line 753 of file dolresource.class.php.

Dolresource::fetch_all_resources (   $sortorder,
  $sortfield,
  $limit,
  $offset,
  $filter = '' 
)

Load all objects into $this->lines.

Parameters
string$sortordersort order
string$sortfieldsort field
int$limitlimit page
int$offsetpage
array$filterfilter output
Returns
int <0 if KO, >0 if OK

Definition at line 599 of file dolresource.class.php.

References $resql, dol_syslog(), and fetchObjectByElement().

Dolresource::fetch_all_used (   $sortorder,
  $sortfield,
  $limit,
  $offset = 1,
  $filter = '' 
)

Load all objects into $this->lines.

Parameters
string$sortordersort order
string$sortfieldsort field
int$limitlimit page
int$offsetpage
array$filterfilter output
Returns
int <0 if KO, >0 if OK

Definition at line 677 of file dolresource.class.php.

References $resql, dol_syslog(), and fetchObjectByElement().

Dolresource::fetch_element_resource (   $id)

Load object in memory from database.

Parameters
int$idid object
Returns
int <0 if KO, >0 if OK

Definition at line 355 of file dolresource.class.php.

References $resql, dol_syslog(), and fetchObjectByElement().

Dolresource::getElementResources (   $element,
  $element_id,
  $resource_type = '' 
)

Return an array with resources linked to the element.

Parameters
string$elementElement
int$element_idId
string$resource_typeType
Returns
array Aray of resources

Definition at line 841 of file dolresource.class.php.

References $element, $resql, and dol_syslog().

Dolresource::getLibStatut (   $mode = 0)

Retourne le libelle du status d'un user (actif, inactif)

Parameters
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
Returns
string Label of status

Definition at line 974 of file dolresource.class.php.

References LibStatut().

Dolresource::getNomUrl (   $withpicto = 0,
  $option = '',
  $get_params = '',
  $notooltip = 0 
)

Return clicable link of object (with eventually picto)

Parameters
int$withpictoAdd picto into link
string$optionWhere point the link ('compta', 'expedition', 'document', ...)
string$get_paramsParametres added to url
int$notooltip1=Disable tooltip
Returns
string String with URL

Definition at line 942 of file dolresource.class.php.

References dol_escape_htmltag(), and img_object().

static Dolresource::LibStatut (   $status,
  $mode = 0 
)
static

Return the status.

Parameters
int$statusId status
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 5=Long label + Picto
Returns
string Label of status

Definition at line 986 of file dolresource.class.php.

Referenced by getLibStatut().

Dolresource::load_cache_code_type_resource ( )

Load in cache resource type code (setup in dictionary)

Returns
int Nb lignes chargees, 0 si deja chargees, <0 si ko

Definition at line 898 of file dolresource.class.php.

References $resql, dol_print_error(), and dol_syslog().

Dolresource::update (   $user = null,
  $notrigger = 0 
)

Update object into database.

Parameters
User$userUser that modifies
int$notrigger0=launch triggers after, 1=disable triggers
Returns
int <0 if KO, >0 if OK

Definition at line 244 of file dolresource.class.php.

References $resql, CommonObject\call_trigger(), description, dol_sanitizeFileName(), dol_syslog(), and CommonObject\insertExtraFields().

Dolresource::update_element_resource (   $user = null,
  $notrigger = 0 
)

Update element resource into database.

Parameters
User$userUser that modifies
int$notrigger0=launch triggers after, 1=disable triggers
Returns
int <0 if KO, >0 if OK

Definition at line 772 of file dolresource.class.php.

References $resql, CommonObject\call_trigger(), and dol_syslog().


The documentation for this class was generated from the following file: