ModelNumRefHolidays Class Reference

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

Inheritance diagram for ModelNumRefHolidays:

Public Member Functions
	isEnabled ()
	Return if a module can be used or not.
	info ()
	Return default description of numbering model.
	getExample ()
	Return numbering example.
	canBeActivated ()
	Test if existing numbers make problems with numbering.
	getNextValue ($objsoc, $holiday)
	Return next value.
	getVersion ()
	Return numbering version module.

Detailed Description

Parent class for all holidays numbering modules.

Definition at line 72 of file modules_holiday.php.

Member Function Documentation

canBeActivated()

ModelNumRefHolidays::canBeActivated

(

)

Test if existing numbers make problems with numbering.

Returns

boolean false if conflict, true if ok

Reimplemented in mod_holiday_madonna.

Definition at line 118 of file modules_holiday.php.

getExample()

ModelNumRefHolidays::getExample

(

)

Return numbering example.

Returns

string Example

Reimplemented in mod_holiday_immaculate, and mod_holiday_madonna.

Definition at line 106 of file modules_holiday.php.

getNextValue()

ModelNumRefHolidays::getNextValue	(		$objsoc,
			$holiday )

Return next value.

Parameters

Societe	$objsoc	third party object
Object	$holiday	Holiday object

Returns

string Value if OK, 0 if KO

Reimplemented in mod_holiday_immaculate, and mod_holiday_madonna.

Definition at line 130 of file modules_holiday.php.

getVersion()

ModelNumRefHolidays::getVersion

(

)

Return numbering version module.

Returns

string Value

Definition at line 141 of file modules_holiday.php.

info()

ModelNumRefHolidays::info

(

)

Return default description of numbering model.

Returns

string text description

Reimplemented in mod_holiday_immaculate, and mod_holiday_madonna.

Definition at line 94 of file modules_holiday.php.

isEnabled()

ModelNumRefHolidays::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Definition at line 84 of file modules_holiday.php.

---

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

• dolibarr_18.0/htdocs/core/modules/holiday/modules_holiday.php