dolibarr  19.0.0-dev
Public Member Functions | List of all members
mod_asset_standard Class Reference

Class to manage the Standard numbering rule for Asset. More...

Inheritance diagram for mod_asset_standard:
Inheritance graph
[legend]
Collaboration diagram for mod_asset_standard:
Collaboration graph
[legend]

Public Member Functions

 info ()
 Return description of numbering module. More...
 
 getExample ()
 Return an example of numbering. More...
 
 canBeActivated ($object)
 Checks if the numbers already in the database do not cause conflicts that would prevent this numbering working. More...
 
 getNextValue ($object)
 Return next free value. More...
 
- Public Member Functions inherited from ModeleNumRefAsset
 isEnabled ()
 Return if a module can be used or not. More...
 
 getVersion ()
 Returns version of numbering module. More...
 

Detailed Description

Class to manage the Standard numbering rule for Asset.

Definition at line 32 of file mod_asset_standard.php.

Member Function Documentation

◆ canBeActivated()

mod_asset_standard::canBeActivated (   $object)

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

Parameters
Object$objectObject we need next value for
Returns
boolean false if conflict, true if ok

Reimplemented from ModeleNumRefAsset.

Definition at line 83 of file mod_asset_standard.php.

◆ getExample()

mod_asset_standard::getExample ( )

Return an example of numbering.

Returns
string Example

Reimplemented from ModeleNumRefAsset.

Definition at line 70 of file mod_asset_standard.php.

◆ getNextValue()

mod_asset_standard::getNextValue (   $object)

Return next free value.

Parameters
Object$objectObject we need next value for
Returns
string Value if KO, <0 if KO

Reimplemented from ModeleNumRefAsset.

Definition at line 122 of file mod_asset_standard.php.

◆ info()

mod_asset_standard::info ( )

Return description of numbering module.

Returns
string Text with description

Reimplemented from ModeleNumRefAsset.

Definition at line 58 of file mod_asset_standard.php.


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