ModelNumRefHolidays Class Reference

Parent class for all holidays numbering modules. More...

Inheritance diagram for ModelNumRefHolidays:

Collaboration diagram for ModelNumRefHolidays:

Public Member Functions
	getNextValue ($objsoc, $holiday)
	Return next value.
	getExample ()
	Return an example of numbering.
Public Member Functions inherited from CommonNumRefGenerator
	getNom ($langs)
	Return model name.
	getName ($langs)
	Return model name.
	isEnabled ()
	Return if a module can be used or not.
	info ($langs)
	Returns the default description of the numbering template.
	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	getVersion ()
	Returns version of numbering module.

Detailed Description

Parent class for all holidays numbering modules.

Definition at line 83 of file modules_holiday.php.

Member Function Documentation

getExample()

ModelNumRefHolidays::getExample ( )

abstract

Return an example of numbering.

Returns

string Example

Reimplemented in mod_holiday_immaculate, and mod_holiday_madonna.

getNextValue()

ModelNumRefHolidays::getNextValue ( $objsoc, $holiday )

abstract

Return next value.

Parameters

Societe	$objsoc	third party object
Holiday	$holiday	holiday object

Returns

string|int<-1,0> Value if OK, <=0 if KO

Reimplemented in mod_holiday_immaculate, and mod_holiday_madonna.

---

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

• dolibarr_dev/htdocs/core/modules/holiday/modules_holiday.php