mod_bookkeeping_argon Class Reference

Class to manage Bookkeeping numbering rules Argon. More...

Inheritance diagram for mod_bookkeeping_argon:

Collaboration diagram for mod_bookkeeping_argon:

Public Member Functions
	__construct ()
	Constructor.
	info ($langs)
	Return description of numbering module.
	getExample ()
	Return an example of numbering.
	canBeActivated ($object)
	Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.
	getNextValue (BookKeeping $object, $mode='next')
	Return next free value.
Public Member Functions inherited from ModeleNumRefBookkeeping
	getNextValue (BookKeeping $object)
	Return next free value.
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.
	getVersion ()
	Returns version of numbering module.

Private Member Functions
	getPrefix (BookKeeping $object)
	Returns the prefix for current Bookkeeping object Year used in prefix is the beginning fiscal year.

Detailed Description

Class to manage Bookkeeping numbering rules Argon.

Definition at line 31 of file mod_bookkeeping_argon.php.

Member Function Documentation

canBeActivated()

mod_bookkeeping_argon::canBeActivated

(

$object

)

Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working.

Parameters

CommonObject

$object

Object we need next value for

Returns

boolean false if conflict, true if ok

Reimplemented from CommonNumRefGenerator.

Definition at line 94 of file mod_bookkeeping_argon.php.

References $object, and getPrefix().

getExample()

mod_bookkeeping_argon::getExample

(

)

Return an example of numbering.

Returns

string Example

Reimplemented from ModeleNumRefBookkeeping.

Definition at line 81 of file mod_bookkeeping_argon.php.

getNextValue()

mod_bookkeeping_argon::getNextValue	(	BookKeeping	$object,
			$mode = 'next' )

Return next free value.

Parameters

BookKeeping	$object	Object we need next value for
string	$mode	'next' for next value or 'last' for last value

Returns

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

Definition at line 122 of file mod_bookkeeping_argon.php.

References $conf, $object, and get_next_value().

getPrefix()

mod_bookkeeping_argon::getPrefix ( BookKeeping $object )

private

Returns the prefix for current Bookkeeping object Year used in prefix is the beginning fiscal year.

Parameters

BookKeeping

$object

Book keeping record

Returns

string Prefix for this bookkeeping object

Definition at line 149 of file mod_bookkeeping_argon.php.

References $object, dol_print_date(), and getDolGlobalInt().

Referenced by canBeActivated().

info()

mod_bookkeeping_argon::info

(

$langs

)

Return description of numbering module.

Parameters

Translate

$langs

Lang object to use for output

Returns

string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 69 of file mod_bookkeeping_argon.php.

---

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

• dolibarr_22.0/htdocs/core/modules/accountancy/mod_bookkeeping_argon.php