CGenericDic Class Reference

Class CGenericDic. More...

Inheritance diagram for CGenericDic:

Collaboration diagram for CGenericDic:

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

Detailed Description

Class CGenericDic.

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

Constructor & Destructor Documentation

__construct()

CGenericDic::__construct

(

DoliDB

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

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

Member Function Documentation

create()

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

Create object into database.

Parameters

User	$user	User that creates
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

int Return integer <0 if KO, Id of created object if OK

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

References dol_syslog().

createFromClone()

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

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

Parameters

User	$user	User making the clone
int	$fromid	Id of object to clone

Returns

int New id of clone

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

References $object, and dol_syslog().

delete()

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

Delete object in database.

Parameters

User	$user	User that deletes
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

int Return integer <0 if KO, >0 if OK

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

References dol_syslog().

fetch()

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

Load object in memory from the database.

Parameters

int	$id	Id object
string	$code	code
string	$label	Label

Returns

int Return integer <0 if KO, 0 if not found, >0 if OK

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

References dol_syslog().

fetchAll()

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

Load object in memory from the database.

Parameters

string	$sortorder	Sort Order
string	$sortfield	Sort field
int	$limit	Limit
int	$offset	offset limit
string | array	$filter	filter USF
string	$filtermode	filter mode (AND or OR)

Returns

int Return integer <0 if KO, >0 if OK

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

References dol_syslog(), and forgeSQLFromUniversalSearchCriteria().

initAsSpecimen()

CGenericDic::initAsSpecimen

(

)

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

Returns

int

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

update()

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

Update object into database.

Parameters

User	$user	User that modifies
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

int Return integer <0 if KO, >0 if OK

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

References dol_syslog().

---

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

• dolibarr_dev/htdocs/core/class/cgenericdic.class.php