Class of the module paid holiday. More...

Inheritance diagram for Holiday:

Collaboration diagram for Holiday:

Public Member Functions
	__construct ($db)
	Constructor.

	getNextNumRef ($objsoc)
	Returns the reference to the following non used Order depending on the active numbering module defined into HOLIDAY_ADDON.

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

	create ($user, $notrigger=0)
	Créer un congés payés dans la base de données.

	fetch ($id, $ref='')
	Load object in memory from database.

	fetchByUser ($user_id, $order='', $filter='')
	List holidays for a particular user or list of users.

	fetchAll ($order, $filter)
	List all holidays of all users.

	validate ($user=null, $notrigger=0)
	Validate leave request.

	approve ($user=null, $notrigger=0)
	Approve leave request.

	update ($user=null, $notrigger=0)
	Update database.

	delete ($user, $notrigger=0)
	Delete object in database.

	verifDateHolidayCP ($fk_user, $dateStart, $dateEnd, $halfday=0)
	Check if a user is on holiday (partially or completely) into a period.

	verifDateHolidayForTimestamp ($fk_user, $timestamp, $status='-1')
	Check that a user is not on holiday for a particular timestamp.

	getTooltipContentArray ($params)
	getTooltipContentArray

	getNomUrl ($withpicto=0, $save_lastsearch_value=-1, $notooltip=0, $morecss='')
	Return clickable name (with picto eventually)

	getLibStatut ($mode=0)
	Returns the label status.

	LibStatut ($status, $mode=0, $startdate='')
	Returns the label of a status.

	selectStatutCP ($selected=0, $htmlname='select_statut', $morecss='minwidth125')
	Show select with list of leave status.

	updateConfCP ($name, $value)
	Met à jour une option du module Holiday Payés.

	getConfCP ($name, $createifnotfound='')
	Return value of a conf parameter for leave module TODO Move this into llx_const table.

	updateSoldeCP ($userID=0, $nbHoliday=0, $fk_type=0)
	Met à jour le timestamp de la dernière mise à jour du solde des CP.

	createCPusers ($single=false, $userid=0)
	Create entries for each user at setup step.

	getCPforUser ($user_id, $fk_type=0)
	Return the balance of annual leave of a user.

	fetchUsers ($stringlist=true, $type=true, $filters='')
	Get list of Users or list of vacation balance.

	fetch_users_approver_holiday ()
	Return list of people with permission to validate leave requests.

	countActiveUsers ()
	Compte le nombre d'utilisateur actifs dans Dolibarr.

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

	verifNbUsers ($userDolibarrWithoutCP, $userCP)
	Compare le nombre d'utilisateur actif de Dolibarr à celui des utilisateurs des congés payés.

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

	fetchLog ($sqlorder, $sqlwhere)
	List log of leaves.

	getTypes ($active=-1, $affect=-1)
	Return array with list of types.

	info ($id)
	Load information on object.

	initAsSpecimen ()
	Initialise an instance with random values.

	loadStateBoard ()
	Load this->nb for dashboard.

	load_board ($user)
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)

	getKanbanView ($option='', $arraydata=null)
	Return clickable link of object (with eventually picto)

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.

	fetchBarCode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.

	fetchProject ()
	Load the project with id $this->fk_project into this->project.

	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.

	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.

Public Attributes
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
	$origin_object

Additional Inherited Members
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 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.

Detailed Description

Class of the module paid holiday.

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

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

Constructor & Destructor Documentation

◆ __construct()

Holiday::__construct ( $db )

Constructor.

Parameters

DoliDB $db Database handler

Definition at line 208 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_action	Id user creation
int	$fk_user_update	Id user update
string	$label	Label (Example: 'Leave', 'Manual update', 'Leave request cancelation'...)
int	$new_solde	New value
int	$fk_type	Type of vacation

Returns: int Id of record added, 0 if nothing done, < 0 if KO

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

References $conf, dol_now(), dol_syslog(), getCPforUser(), and price2num().

Referenced by updateSoldeCP().

◆ approve()

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

Approve leave request.

Parameters

User	$user	User that approve
	int<0,1>	$notrigger 0=launch triggers after, 1=disable triggers

Returns: int Return integer <0 if KO, >0 if OK

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

References CommonObject\call_trigger(), description, dol_syslog(), getCPforUser(), getDictionaryValue(), and status.

◆ countActiveUsers()

Holiday::countActiveUsers ( )

Compte le nombre d'utilisateur actifs dans Dolibarr.

Returns: int retourne le nombre d'utilisateur

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

References $object.

◆ countActiveUsersWithoutCP()

Holiday::countActiveUsersWithoutCP ( )

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

Returns: int retourne le nombre d'utilisateur

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

References $object.

◆ create()

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

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

Parameters

User	$user	User that create
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns: int Return integer <0 if KO, Id of created object if OK

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

References $conf, CommonObject\call_trigger(), description, dol_now(), dol_syslog(), CommonObject\insertExtraFields(), and ref.

◆ createCPusers()

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

Create entries for each user at setup step.

Parameters

boolean	$single	Single
int	$userid	Id user

Returns: void

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

References dol_print_error(), dol_syslog(), and fetchUsers().

◆ delete()

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

Delete object in database.

Parameters

User	$user	User that delete
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns: int Return integer <0 if KO, >0 if OK

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

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

◆ fetch()

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

Load object in memory from database.

Parameters

int	$id	Id object
string	$ref	Ref object

Returns: int Return integer <0 if KO, 0 if not found, >0 if OK

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

References description, dol_syslog(), CommonObject\fetch_optionals(), ref, and status.

◆ 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: int[]|int<-1,-1> Array of user ids or -1 if error

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

References dol_syslog().

◆ fetchAll()

Holiday::fetchAll	(		$order,
			$filter )

List all holidays of all users.

Parameters

string	$order	Sort order
string	$filter	SQL Filter

Returns: int -1 if KO, 1 if OK, 2 if no result

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

References dol_syslog().

◆ fetchByUser()

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

List holidays for a particular user or list of users.

Parameters

int \| string	$user_id	ID of user to list, or comma separated list of IDs of users to list
string	$order	Sort order
string	$filter	SQL Filter

Returns: int -1 if KO, 1 if OK, 2 if no result

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

References dol_syslog().

Referenced by updateSoldeCP(), and verifDateHolidayCP().

◆ fetchLog()

Holiday::fetchLog	(		$sqlorder,
			$sqlwhere )

List log of leaves.

Parameters

string	$sqlorder	SQL sort order
string	$sqlwhere	SQL where

Returns: int -1 si erreur, 1 si OK et 2 si pas de résultat

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

References dol_syslog().

◆ fetchUsers()

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

Get list of Users or list of vacation balance.

Parameters

boolean	$stringlist	If true return a string list of id. If false, return an array with detail.
boolean	$type	If true, read Dolibarr user list, if false, return vacation balance list.
string	$filters	Filters. Warning: This must not contains data from user input.

Returns: array<array{rowid:int,id:int,name:string,lastname:string,firstname:string,gender:string,status:int,employee:int,photo:string,fk_user:int,type?:int,nb_holiday?:int}>|string|int<-1,-1> Return an array

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

References $conf, dol_syslog(), and getDolGlobalString().

Referenced by createCPusers(), and updateSoldeCP().

◆ getConfCP()

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

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

Parameters

string	$name	Name of parameter
string	$createifnotfound	'stringvalue'=Create entry with string value if not found. For example 'YYYYMMDDHHMMSS'.

Returns: string|int<min,0> Value of parameter. Example: 'YYYYMMDDHHMMSS' or < 0 if error

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

References dol_syslog().

Referenced by updateSoldeCP().

◆ getCPforUser()

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

Return the balance of annual leave of a user.

Parameters

int	$user_id	User ID
int	$fk_type	Filter on type

Returns: ?float Balance of annual leave if OK, null if KO.

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

References dol_syslog().

Referenced by addLogCP(), approve(), update(), and validate().

◆ getKanbanView()

Holiday::getKanbanView	(		$option = '',
			$arraydata = null )

Return clickable link of object (with eventually picto)

Parameters

string	$option	Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
	?array{labeltype:string,selected?:int<0,1>,nbopenedday?:int}	$arraydata Label of holiday type (if known)

Returns: string HTML Code for Kanban thumb.

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

References dol_escape_htmltag(), and img_picto().

◆ getLibStatut()

Holiday::getLibStatut ( $mode = 0 )

Returns the label status.

Parameters

int $mode 0=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 1498 of file holiday.class.php.

References LibStatut(), and status.

◆ 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 $objsoc third party object

Returns: string Holiday free reference

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

References $conf, dol_buildpath(), dol_print_error(), and getDolGlobalString().

Referenced by validate().

◆ getNomUrl()

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

Return clickable name (with picto eventually)

Parameters

int	$withpicto	0=_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
int	$notooltip	1=Disable tooltip
string	$morecss	Add more css on link

Returns: string String with URL

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

References $conf, getDolGlobalInt(), getTooltipContentArray(), and img_object().

◆ getTooltipContentArray()

Holiday::getTooltipContentArray ( $params )

getTooltipContentArray

Parameters

array<string,mixed> $params params to construct tooltip data

Since: v18

Returns: array{picto?:string,ref?:string,refsupplier?:string,label?:string,date?:string,date_echeance?:string,amountht?:string,total_ht?:string,totaltva?:string,amountlt1?:string,amountlt2?:string,amountrevenustamp?:string,totalttc?:string}|array{optimize:string}

Reimplemented from CommonObject.

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

References dol_print_date(), getTypes(), img_picto(), and status.

Referenced by getNomUrl().

◆ getTypes()

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

Return array with list of types.

Parameters

int	$active	Status of type. -1 = Both
int	$affect	Filter on affect (a request will change sold or not). -1 = Both

Returns: array<int,array{id:int,rowid:int,code:string,label:string,affect:int,delay:int,newbymonth:int}> Return array with list of types

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

References dol_print_error().

Referenced by getTooltipContentArray(), and updateSoldeCP().

◆ info()

Holiday::info ( $id )

Load information on object.

Parameters

int $id Id of object

Returns: void

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

References $conf, dol_print_error(), STATUS_APPROVED, and STATUS_CANCELED.

◆ 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: int

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

References description, dol_now(), status, and STATUS_VALIDATED.

◆ LibStatut()

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

Returns the label of a status.

Parameters

int	$status	Id status
int	$mode	0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto
int \| string	$startdate	Date holiday should start

Returns: string Label

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

References dol_now(), dolGetStatus(), STATUS_APPROVED, STATUS_CANCELED, STATUS_DRAFT, STATUS_REFUSED, and STATUS_VALIDATED.

Referenced by getLibStatut().

◆ load_board()

Holiday::load_board ( $user )

Load indicators for dashboard (this->nbtodo and this->nbtodolate)

Parameters

User $user Object user

Returns: WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK

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

References $conf, dol_now(), dol_print_error(), and img_object().

◆ loadStateBoard()

Holiday::loadStateBoard ( )

Load this->nb for dashboard.

Returns: int Return integer <0 if KO, >0 if OK

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

References dol_print_error().

◆ selectStatutCP()

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

Show select with list of leave status.

Parameters

int	$selected	Id of preselected status
string	$htmlname	Name of HTML select field
string	$morecss	More CSS on select component

Returns: string Show select of status

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

References ajax_combobox().

◆ update()

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

Update database.

Parameters

User	$user	User that modify
	int<0,1>	$notrigger 0=launch triggers after, 1=disable triggers

Returns: int Return integer <0 if KO, >0 if OK

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

References $conf, CommonObject\call_trigger(), description, dol_syslog(), getCPforUser(), getDictionaryValue(), CommonObject\insertExtraFields(), and status.

◆ updateBalance()

Holiday::updateBalance ( )

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

If not complete.

Returns: int Return integer <0 if KO, >0 if OK

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

References updateSoldeCP().

◆ updateConfCP()

Holiday::updateConfCP	(		$name,
			$value )

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

Parameters

string	$name	name du paramètre de configuration
string	$value	vrai si mise à jour OK sinon faux

Returns: boolean ok or ko

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

References dol_syslog().

◆ updateSoldeCP()

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

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

Parameters

int	$userID	Id of user
float	$nbHoliday	Nb of days
int	$fk_type	Type of vacation

Returns: int 0=Nothing done, 1=OK, -1=KO

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

References $conf, addLogCP(), dol_get_next_month(), dol_mktime(), dol_now(), dol_print_date(), dol_stringtotime(), dol_syslog(), fetchByUser(), fetchUsers(), getConfCP(), getDolGlobalInt(), getTypes(), num_open_day(), price2num(), and updateSoldeCP().

Referenced by updateBalance(), and updateSoldeCP().

◆ validate()

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

Validate leave request.

Parameters

User	$user	User that validate
	int<0,1>	$notrigger 0=launch triggers after, 1=disable triggers

Returns: int Return integer <0 if KO, >0 if OK

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

References $conf, CommonObject\call_trigger(), dol_dir_list(), dol_now(), dol_sanitizeFileName(), dol_syslog(), getCPforUser(), getDictionaryValue(), getNextNumRef(), ref, and status.

◆ 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_user	Id user
integer	$dateStart	Start date of period to check
integer	$dateEnd	End date of period to check
int	$halfday	Tag 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 1213 of file holiday.class.php.

References dol_print_error(), fetchByUser(), STATUS_CANCELED, and STATUS_REFUSED.

◆ verifDateHolidayForTimestamp()

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

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

Can check approved leave requests and not into public holidays of company.

Parameters

int	$fk_user	Id user
integer	$timestamp	Time stamp date for a day (YYYY-MM-DD) without hours (= 12:00AM in english and not 12:00PM that is 12:00)
string	$status	Filter on holiday status. '-1' = no filter.

Returns: array{morning_reason?:string,afternoon_reason?:string} array('morning'=> ,'afternoon'=> ), Boolean is true if user is available for day timestamp.

See also: verifDateHolidayCP()

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

References dol_print_error().

◆ verifNbUsers()

Holiday::verifNbUsers	(		$userDolibarrWithoutCP,
			$userCP )

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

Parameters

int	$userDolibarrWithoutCP	Number of active users in Dolibarr without holidays
int	$userCP	Number of active users into table of holidays

Returns: int Return integer <0 if KO, >0 if OK

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

References dol_syslog().

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

dolibarr_dev/htdocs/holiday/class/holiday.class.php

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addLogCP()

◆ approve()

◆ countActiveUsers()

◆ countActiveUsersWithoutCP()

◆ create()

◆ createCPusers()

◆ delete()

◆ fetch()

◆ fetch_users_approver_holiday()

◆ fetchAll()

◆ fetchByUser()

◆ fetchLog()

◆ fetchUsers()

◆ getConfCP()

◆ getCPforUser()

◆ getKanbanView()

◆ getLibStatut()

◆ getNextNumRef()

◆ getNomUrl()

◆ getTooltipContentArray()

◆ getTypes()

◆ info()

◆ initAsSpecimen()

◆ LibStatut()

◆ load_board()

◆ loadStateBoard()

◆ selectStatutCP()

◆ update()

◆ updateBalance()

◆ updateConfCP()

◆ updateSoldeCP()

◆ validate()

◆ verifDateHolidayCP()

◆ verifDateHolidayForTimestamp()

◆ verifNbUsers()