Cstate Class Reference

Class to manage dictionary States (used by imports) More...

Inheritance diagram for Cstate:

Collaboration diagram for Cstate:

Public Member Functions
	__construct ($db)
	Constructor.
	create ($user, $notrigger=0)
	Create object into database.
	fetch ($id, $code='')
	Load object in memory from database.
	update ($user=null, $notrigger=0)
	Update object into database.
	delete ($user, $notrigger=0)
	Delete object in database.
	getNomUrl ($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
	Return a link to the object card (with optionally the picto)
Public Member Functions inherited from CommonDict
	errorsToString ()
	Method to output saved errors.

Detailed Description

Class to manage dictionary States (used by imports)

Definition at line 33 of file cstate.class.php.

Constructor & Destructor Documentation

__construct()

Cstate::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 60 of file cstate.class.php.

Member Function Documentation

create()

Cstate::create	(		$user,
			$notrigger = 0 )

Create object into database.

Parameters

User	$user	User that create
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 73 of file cstate.class.php.

References active, dol_syslog(), and name.

delete()

Cstate::delete	(		$user,
			$notrigger = 0 )

Delete object in database.

Parameters

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

Returns

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

Definition at line 240 of file cstate.class.php.

References dol_syslog().

fetch()

Cstate::fetch	(		$id,
			$code = '' )

Load object in memory from database.

Parameters

int	$id	State ID
string	$code	State code

Returns

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

Definition at line 139 of file cstate.class.php.

References active, dol_syslog(), and name.

getNomUrl()

Cstate::getNomUrl	(		$withpicto = 0,
			$option = '',
			$notooltip = 0,
			$morecss = '',
			$save_lastsearch_value = -1 )

Return a link to the object card (with optionally the picto)

Parameters

int	$withpicto	Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
string	$option	On what the link point to ('nolink', ...)
int	$notooltip	1=Disable tooltip
string	$morecss	Add more css on link
int	$save_lastsearch_value	-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking

Returns

string String with URL

Definition at line 280 of file cstate.class.php.

References name.

update()

Cstate::update	(		$user = null,
			$notrigger = 0 )

Update object into database.

Parameters

User	$user	User who updates
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

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

Definition at line 183 of file cstate.class.php.

References active, dol_syslog(), and name.

---

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

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