dolibarr  17.0.3
Public Member Functions | List of all members
CGenericDic Class Reference

Class CGenericDic. More...

Public Member Functions

 __construct (DoliDB $db)
 Constructor. More...
 
 create (User $user, $notrigger=false)
 Create object into database. More...
 
 fetch ($id, $code='', $label='')
 Load object in memory from the database. More...
 
 fetchAll ($sortorder='', $sortfield='', $limit=0, $offset=0, array $filter=array(), $filtermode='AND')
 Load object in memory from the database. More...
 
 update (User $user, $notrigger=false)
 Update object into database. More...
 
 delete (User $user, $notrigger=false)
 Delete object in database. More...
 
 createFromClone (User $user, $fromid)
 Load an object from its id and create a new one in database. More...
 
 initAsSpecimen ()
 Initialise object with example values Id must be 0 if object instance is a specimen. More...
 

Detailed Description

Class CGenericDic.

See also
CommonObject

Definition at line 31 of file cgenericdic.class.php.

Constructor & Destructor Documentation

◆ __construct()

CGenericDic::__construct ( DoliDB  $db)

Constructor.

Parameters
DoliDb$dbDatabase handler

Definition at line 63 of file cgenericdic.class.php.

Member Function Documentation

◆ create()

CGenericDic::create ( User  $user,
  $notrigger = false 
)

Create object into database.

Parameters
User$userUser that creates
bool$notriggerfalse=launch triggers after, true=disable triggers
Returns
int <0 if KO, Id of created object if OK

Definition at line 78 of file cgenericdic.class.php.

◆ createFromClone()

CGenericDic::createFromClone ( User  $user,
  $fromid 
)

Load an object from its id and create a new one in database.

Parameters
User$userUser making the clone
int$fromidId of object to clone
Returns
int New id of clone

Definition at line 430 of file cgenericdic.class.php.

◆ delete()

CGenericDic::delete ( User  $user,
  $notrigger = false 
)

Delete object in database.

Parameters
User$userUser that deletes
bool$notriggerfalse=launch triggers after, true=disable triggers
Returns
int <0 if KO, >0 if OK

Definition at line 377 of file cgenericdic.class.php.

◆ fetch()

CGenericDic::fetch (   $id,
  $code = '',
  $label = '' 
)

Load object in memory from the database.

Parameters
int$idId object
string$codecode
string$labelLabel
Returns
int <0 if KO, 0 if not found, >0 if OK

Definition at line 158 of file cgenericdic.class.php.

◆ fetchAll()

CGenericDic::fetchAll (   $sortorder = '',
  $sortfield = '',
  $limit = 0,
  $offset = 0,
array  $filter = array(),
  $filtermode = 'AND' 
)

Load object in memory from the database.

Parameters
string$sortorderSort Order
string$sortfieldSort field
int$limitoffset limit
int$offsetoffset limit
array$filterfilter array
string$filtermodefilter mode (AND or OR)
Returns
int <0 if KO, >0 if OK

Definition at line 231 of file cgenericdic.class.php.

◆ initAsSpecimen()

CGenericDic::initAsSpecimen ( )

Initialise object with example values Id must be 0 if object instance is a specimen.

Returns
void

Definition at line 478 of file cgenericdic.class.php.

References code.

◆ update()

CGenericDic::update ( User  $user,
  $notrigger = false 
)

Update object into database.

Parameters
User$userUser that modifies
bool$notriggerfalse=launch triggers after, true=disable triggers
Returns
int <0 if KO, >0 if OK

Definition at line 301 of file cgenericdic.class.php.


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