Cregion Class Reference

Class to manage dictionary Regions. More...

Inheritance diagram for Cregion:

Collaboration diagram for Cregion:

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

Detailed Description

Class to manage dictionary Regions.

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

Constructor & Destructor Documentation

__construct()

Cregion::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 66 of file cregion.class.php.

Member Function Documentation

create()

Cregion::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 79 of file cregion.class.php.

delete()

Cregion::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 275 of file cregion.class.php.

fetch()

Cregion::fetch	(		$id,
			$code_region = 0,
			$fk_pays = 0
	)

Load object in memory from database.

Parameters

int	$id	Id object
int	$code_region	Code
int	$fk_pays	Country Id

Returns

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

Definition at line 157 of file cregion.class.php.

References $sql.

getNomUrl()

Cregion::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 316 of file cregion.class.php.

update()

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

Update object into database.

Parameters

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

Returns

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

Definition at line 209 of file cregion.class.php.

---

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

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