dolibarr  21.0.0-alpha
Public Member Functions | List of all members
mod_ticket_simple Class Reference

Class to manage the numbering module Simple for ticket references. More...

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

Public Member Functions

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

Detailed Description

Class to manage the numbering module Simple for ticket references.

Definition at line 33 of file mod_ticket_simple.php.

Member Function Documentation

◆ canBeActivated()

mod_ticket_simple::canBeActivated (   $object)

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

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

Reimplemented from CommonNumRefGenerator.

Definition at line 89 of file mod_ticket_simple.php.

◆ getExample()

mod_ticket_simple::getExample ( )

Return an example of numbering module values.

Returns
string Example

Definition at line 77 of file mod_ticket_simple.php.

◆ getNextValue()

mod_ticket_simple::getNextValue (   $objsoc,
  $ticket 
)

Return next value.

Parameters
Societe$objsocObject third party
Ticket$ticketObject ticket
Returns
string|-1 Value if OK, -1 if KO

Definition at line 126 of file mod_ticket_simple.php.

◆ info()

mod_ticket_simple::info (   $langs)

Return description of numbering module.

Parameters
Translate$langsLang object to use for output
Returns
string Descriptive text

Reimplemented from CommonNumRefGenerator.

Definition at line 66 of file mod_ticket_simple.php.


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