dolibarr  9.0.0
Public Member Functions | Public Attributes | List of all members
Holiday Class Reference

Class of the module paid holiday. More...

+ Inheritance diagram for Holiday:
+ Collaboration diagram for Holiday:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 getNextNumRef ($objsoc)
 Returns the reference to the following non used Order depending on the active numbering module defined into HOLIDAY_ADDON. More...
 
 updateBalance ()
 Update balance of vacations and check table of users for holidays is complete. More...
 
 create ($user, $notrigger=0)
 Créer un congés payés dans la base de données. More...
 
 fetch ($id, $ref='')
 Load object in memory from database. More...
 
 fetchByUser ($user_id, $order='', $filter='')
 List holidays for a particular user or list of users. More...
 
 fetchAll ($order, $filter)
 List all holidays of all users. More...
 
 validate ($user=null, $notrigger=0)
 Validate leave request. More...
 
 approve ($user=null, $notrigger=0)
 Approve leave request. More...
 
 update ($user=null, $notrigger=0)
 Update database. More...
 
 delete ($user, $notrigger=0)
 Delete object in database. More...
 
 verifDateHolidayCP ($fk_user, $dateStart, $dateEnd, $halfday=0)
 Check if a user is on holiday (partially or completely) into a period. More...
 
 verifDateHolidayForTimestamp ($fk_user, $timestamp, $status='-1')
 Check that a user is not on holiday for a particular timestamp. More...
 
 getNomUrl ($withpicto=0, $save_lastsearch_value=-1)
 Return clicable name (with picto eventually) More...
 
 getLibStatut ($mode=0)
 Returns the label status. More...
 
 LibStatut ($statut, $mode=0, $startdate='')
 Returns the label of a statut. More...
 
 selectStatutCP ($selected='', $htmlname='select_statut')
 Affiche un select HTML des statuts de congés payés. More...
 
 updateConfCP ($name, $value)
 Met à jour une option du module Holiday Payés. More...
 
 getConfCP ($name, $createifnotfound='')
 Return value of a conf parameterfor leave module TODO Move this into llx_const table. More...
 
 updateSoldeCP ($userID='', $nbHoliday='', $fk_type='')
 Met à jour le timestamp de la dernière mise à jour du solde des CP. More...
 
 getCheckOption ($name)
 Retourne un checked si vrai. More...
 
 createCPusers ($single=false, $userid='')
 Créer les entrées pour chaque utilisateur au moment de la configuration. More...
 
 deleteCPuser ($user_id)
 Supprime un utilisateur du module Congés Payés. More...
 
 getCPforUser ($user_id, $fk_type=0)
 Retourne le solde de congés payés pour un utilisateur. More...
 
 fetchUsers ($stringlist=true, $type=true, $filters='')
 Get list of Users or list of vacation balance. More...
 
 fetch_users_approver_holiday ()
 Return list of people with permission to validate leave requests. More...
 
 countActiveUsers ()
 Compte le nombre d'utilisateur actifs dans Dolibarr. More...
 
 countActiveUsersWithoutCP ()
 Compte le nombre d'utilisateur actifs dans Dolibarr sans CP. More...
 
 verifNbUsers ($userDolibarrWithoutCP, $userCP)
 Compare le nombre d'utilisateur actif de Dolibarr à celui des utilisateurs des congés payés. More...
 
 addLogCP ($fk_user_action, $fk_user_update, $label, $new_solde, $fk_type)
 addLogCP More...
 
 fetchLog ($order, $filter)
 Liste le log des congés payés. More...
 
 getTypes ($active=-1, $affect=-1)
 Return array with list of types. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. 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="\, $withregion=0)
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=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 ()
 Load the project with id $this->fk_project into this->project. More...
 
 fetch_product ()
 Load the product with id $this->fk_product into this->product. More...
 
 fetch_user ($userid)
 Load the user with id $userid into this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key, $element=null)
 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='', $fk_user_field='fk_user_modif')
 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 object. 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, $notrigger=false, $userused=null)
 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, $notrigger=false, $userused=null)
 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, $orderby='sourcetype', $loadalsoobjects=1)
 Fetch array of objects linked to current object (object of enabled modules only). 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='', $trigkey='')
 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...
 
 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's 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 Move this into files.lib.php. 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, $trigger=null, $userused=null)
 Update an extra field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=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='', $onetrtd=0)
 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...
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0)
 Show photos of an object (nbmax maximum), into several columns. 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, $morewhere='')
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
 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...
 
 trimParameters ($parameters)
 Trim object parameters. More...
 

Public Attributes

 $rowid
 
const STATUS_DRAFT = 1
 Draft status.
 
const STATUS_VALIDATED = 2
 Validated status.
 
const STATUS_APPROVED = 3
 Approved.
 
const STATUS_CANCELED = 4
 Canceled.
 
const STATUS_REFUSED = 5
 Refused.
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

Additional Inherited Members

- 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...
 
- 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...
 
 setSaveQuery ()
 Function to prepare the values to insert. More...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 getFieldList ()
 Function to concat keys of fields. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class of the module paid holiday.

Developed by Teclib ( http://www.teclib.com/ )

Definition at line 34 of file holiday.class.php.

Constructor & Destructor Documentation

◆ __construct()

Holiday::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 152 of file holiday.class.php.

Member Function Documentation

◆ addLogCP()

Holiday::addLogCP (   $fk_user_action,
  $fk_user_update,
  $label,
  $new_solde,
  $fk_type 
)

addLogCP

Parameters
int$fk_user_actionId user creation
int$fk_user_updateId user update
string$labelLabel
int$new_soldeNew value
int$fk_typeType of vacation
Returns
int Id of record added, 0 if nothing done, < 0 if KO

Definition at line 1979 of file holiday.class.php.

◆ approve()

Holiday::approve (   $user = null,
  $notrigger = 0 
)

Approve leave request.

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

Definition at line 748 of file holiday.class.php.

◆ countActiveUsers()

Holiday::countActiveUsers ( )

Compte le nombre d'utilisateur actifs dans Dolibarr.

Returns
int retourne le nombre d'utilisateur

Definition at line 1925 of file holiday.class.php.

◆ countActiveUsersWithoutCP()

Holiday::countActiveUsersWithoutCP ( )

Compte le nombre d'utilisateur actifs dans Dolibarr sans CP.

Returns
int retourne le nombre d'utilisateur

Definition at line 1941 of file holiday.class.php.

◆ create()

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

Créer un congés payés dans la base de données.

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

Definition at line 253 of file holiday.class.php.

◆ createCPusers()

Holiday::createCPusers (   $single = false,
  $userid = '' 
)

Créer les entrées pour chaque utilisateur au moment de la configuration.

Parameters
boolean$singleSingle
int$useridId user
Returns
void

Definition at line 1582 of file holiday.class.php.

◆ delete()

Holiday::delete (   $user,
  $notrigger = 0 
)

Delete object in database.

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

Definition at line 975 of file holiday.class.php.

◆ deleteCPuser()

Holiday::deleteCPuser (   $user_id)

Supprime un utilisateur du module Congés Payés.

Parameters
int$user_idID de l'utilisateur à supprimer
Returns
boolean Vrai si pas d'erreur, faut si Erreur

Definition at line 1617 of file holiday.class.php.

◆ fetch()

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

Load object in memory from database.

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

Definition at line 339 of file holiday.class.php.

◆ fetch_users_approver_holiday()

Holiday::fetch_users_approver_holiday ( )

Return list of people with permission to validate leave requests.

Search for permission "approve leave requests"

Returns
array Array of user ids

Definition at line 1884 of file holiday.class.php.

◆ fetchAll()

Holiday::fetchAll (   $order,
  $filter 
)

List all holidays of all users.

Parameters
string$orderSort order
string$filterSQL Filter
Returns
int -1 if KO, 1 if OK, 2 if no result

Definition at line 551 of file holiday.class.php.

◆ fetchByUser()

Holiday::fetchByUser (   $user_id,
  $order = '',
  $filter = '' 
)

List holidays for a particular user or list of users.

Parameters
int | string$user_idID of user to list, or comma separated list of IDs of users to list
string$orderSort order
string$filterSQL Filter
Returns
int -1 if KO, 1 if OK, 2 if no result

Definition at line 423 of file holiday.class.php.

Referenced by verifDateHolidayCP().

◆ fetchLog()

Holiday::fetchLog (   $order,
  $filter 
)

Liste le log des congés payés.

Parameters
string$orderFiltrage par ordre
string$filterFiltre de séléction
Returns
int -1 si erreur, 1 si OK et 2 si pas de résultat

Definition at line 2048 of file holiday.class.php.

◆ fetchUsers()

Holiday::fetchUsers (   $stringlist = true,
  $type = true,
  $filters = '' 
)

Get list of Users or list of vacation balance.

Parameters
boolean$stringlistIf true return a string list of id. If false, return an array with detail.
boolean$typeIf true, read Dolibarr user list, if false, return vacation balance list.
string$filtersFilters
Returns
array|string|int Return an array

Definition at line 1664 of file holiday.class.php.

◆ getCheckOption()

Holiday::getCheckOption (   $name)

Retourne un checked si vrai.

Parameters
string$namename du paramètre de configuration
Returns
string retourne checked si > 0

Definition at line 1555 of file holiday.class.php.

◆ getConfCP()

Holiday::getConfCP (   $name,
  $createifnotfound = '' 
)

Return value of a conf parameterfor leave module TODO Move this into llx_const table.

Parameters
string$nameName of parameter
string$createifnotfound'stringvalue'=Create entry with string value if not found. For example 'YYYYMMDDHHMMSS'.
Returns
string Value of parameter. Example: 'YYYYMMDDHHMMSS' or < 0 if error

Definition at line 1351 of file holiday.class.php.

◆ getCPforUser()

Holiday::getCPforUser (   $user_id,
  $fk_type = 0 
)

Retourne le solde de congés payés pour un utilisateur.

Parameters
int$user_idID de l'utilisateur
int$fk_typeFilter on type
Returns
float Retourne le solde de congés payés de l'utilisateur

Definition at line 1634 of file holiday.class.php.

◆ getLibStatut()

Holiday::getLibStatut (   $mode = 0)

Returns the label status.

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

Definition at line 1214 of file holiday.class.php.

◆ getNextNumRef()

Holiday::getNextNumRef (   $objsoc)

Returns the reference to the following non used Order depending on the active numbering module defined into HOLIDAY_ADDON.

Parameters
Societe$objsocthird party object
Returns
string Holiday free reference

Definition at line 165 of file holiday.class.php.

◆ getNomUrl()

Holiday::getNomUrl (   $withpicto = 0,
  $save_lastsearch_value = -1 
)

Return clicable name (with picto eventually)

Parameters
int$withpicto0=_No picto, 1=Includes the picto in the linkn, 2=Picto only
int$save_lastsearch_value-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
Returns
string String with URL

Definition at line 1178 of file holiday.class.php.

◆ getTypes()

Holiday::getTypes (   $active = -1,
  $affect = -1 
)

Return array with list of types.

Parameters
int$activeStatus of type. -1 = Both
int$affectFilter on affect (a request will change sold or not). -1 = Both
Returns
array Return array with list of types

Definition at line 2125 of file holiday.class.php.

◆ initAsSpecimen()

Holiday::initAsSpecimen ( )

Initialise an instance with random values.

Used to build previews or test instances. id must be 0 if object instance is a specimen.

Returns
void

Definition at line 2162 of file holiday.class.php.

◆ LibStatut()

Holiday::LibStatut (   $statut,
  $mode = 0,
  $startdate = '' 
)

Returns the label of a statut.

Parameters
int$statutid statut
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto
date$startdateDate holiday should start
Returns
string Label

Definition at line 1228 of file holiday.class.php.

◆ selectStatutCP()

Holiday::selectStatutCP (   $selected = '',
  $htmlname = 'select_statut' 
)

Affiche un select HTML des statuts de congés payés.

Parameters
int$selectedId of preselected status
string$htmlnameName of HTML select field
Returns
string Show select of status

Definition at line 1293 of file holiday.class.php.

◆ update()

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

Update database.

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

Definition at line 861 of file holiday.class.php.

◆ updateBalance()

Holiday::updateBalance ( )

Update balance of vacations and check table of users for holidays is complete.

If not complete.

Returns
int <0 if KO, >0 if OK

Definition at line 224 of file holiday.class.php.

◆ updateConfCP()

Holiday::updateConfCP (   $name,
  $value 
)

Met à jour une option du module Holiday Payés.

Parameters
string$namename du paramètre de configuration
string$valuevrai si mise à jour OK sinon faux
Returns
boolean ok or ko

Definition at line 1327 of file holiday.class.php.

◆ updateSoldeCP()

Holiday::updateSoldeCP (   $userID = '',
  $nbHoliday = '',
  $fk_type = '' 
)

Met à jour le timestamp de la dernière mise à jour du solde des CP.

Parameters
int$userIDId of user
int$nbHolidayNb of days
int$fk_typeType of vacation
Returns
int 0=Nothing done, 1=OK, -1=KO

Definition at line 1406 of file holiday.class.php.

◆ validate()

Holiday::validate (   $user = null,
  $notrigger = 0 
)

Validate leave request.

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

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

◆ verifDateHolidayCP()

Holiday::verifDateHolidayCP (   $fk_user,
  $dateStart,
  $dateEnd,
  $halfday = 0 
)

Check if a user is on holiday (partially or completely) into a period.

This function can be used to avoid to have 2 leave requests on same period for example. Warning: It consumes a lot of memory because it load in ->holiday all holiday of a dedicated user at each call.

Parameters
int$fk_userId user
date$dateStartStart date of period to check
date$dateEndEnd date of period to check
int$halfdayTag to define how start and end the period to check: 0:Full days, 2:Start afternoon end morning, -1:Start afternoon end afternoon, 1:Start morning end morning
Returns
boolean False = New range overlap an existing holiday, True = no overlapping (is never on holiday during checked period).
See also
verifDateHolidayForTimestamp

Definition at line 1033 of file holiday.class.php.

References dol_print_error(), and fetchByUser().

◆ verifDateHolidayForTimestamp()

Holiday::verifDateHolidayForTimestamp (   $fk_user,
  $timestamp,
  $status = '-1' 
)

Check that a user is not on holiday for a particular timestamp.

Parameters
int$fk_userId user
timestamp$timestampTime stamp date for a day (YYYY-MM-DD) without hours (= 12:00AM in english and not 12:00PM that is 12:00)
string$statusFilter on holiday status. '-1' = no filter.
Returns
array array('morning'=> ,'afternoon'=> ), Boolean is true if user is available for day timestamp.
See also
verifDateHolidayCP

Definition at line 1115 of file holiday.class.php.

◆ verifNbUsers()

Holiday::verifNbUsers (   $userDolibarrWithoutCP,
  $userCP 
)

Compare le nombre d'utilisateur actif de Dolibarr à celui des utilisateurs des congés payés.

Parameters
int$userDolibarrWithoutCPNumber of active users in Dolibarr without holidays
int$userCPNumber of active users into table of holidays
Returns
int <0 if KO, >0 if OK

Definition at line 1961 of file holiday.class.php.

References dol_syslog().

Member Data Documentation

◆ $rowid

Holiday::$rowid
Deprecated:
See also
$id

Definition at line 63 of file holiday.class.php.


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