MembersTypes Class Reference

Inheritance diagram for MembersTypes:

Collaboration diagram for MembersTypes:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get properties of a member type object. More...
	index ($sortfield="t.rowid", $sortorder= 'ASC', $limit=100, $page=0, $sqlfilters= '')
	List members types. More...
	post ($request_data=null)
	Create member type object. More...
	put ($id, $request_data=null)
	Update member type. More...
	delete ($id)
	Delete member type. More...
Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir= '', $refreshCache=false)
	Constructor. More...

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas. More...
Protected Member Functions inherited from DolibarrApi
	_checkValForAPI ($field, $value, $object)
	Check and convert a string depending on its type/name. More...
	_cleanObjectDatas ($object)
	Clean sensible object datas. More...
	_checkFilters ($sqlfilters, &$error= '')
	Return if a $sqlfilters parameter is valid. More...

Private Member Functions
	_validate ($data)
	Validate fields before creating an object. More...

Additional Inherited Members
Static Protected Member Functions inherited from DolibarrApi
static	_checkAccessToResource ($resource, $resource_id=0, $dbtablename= '', $feature2= '', $dbt_keyfield= 'fk_soc', $dbt_select= 'rowid')
	Check access by user to a given resource. More...
static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria from a Generic filter string. More...

Detailed Description

Definition at line 28 of file api_memberstypes.class.php.

Member Function Documentation

MembersTypes::_cleanObjectDatas (   $object )

protected

Clean sensible object datas.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

Definition at line 271 of file api_memberstypes.class.php.

Referenced by get(), and index().

MembersTypes::_validate (   $data )

private

Validate fields before creating an object.

Parameters

array | null

$data

Data to validate

Returns

array

Exceptions

RestException

Definition at line 252 of file api_memberstypes.class.php.

Referenced by post().

MembersTypes::delete

(

$id

)

Delete member type.

Parameters

int

$id

member type ID

Returns

array

Definition at line 217 of file api_memberstypes.class.php.

References DolibarrApi\_checkAccessToResource(), and db.

MembersTypes::get

(

$id

)

Get properties of a member type object.

Return an array with member type informations

Parameters

int

$id

ID of member type

Returns

array|mixed data without useless information

Exceptions

RestException

Definition at line 56 of file api_memberstypes.class.php.

References DolibarrApi\_checkAccessToResource(), _cleanObjectDatas(), and db.

MembersTypes::index	(		$sortfield = "t.rowid",
			$sortorder = 'ASC',
			$limit = 100,
			$page = 0,
			$sqlfilters = ''
	)

List members types.

Get a list of members types

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.libelle:like:'SO-%') and (t.subscription:=:'1')"

Returns

array Array of member type objects

Exceptions

RestException

Definition at line 89 of file api_memberstypes.class.php.

References DolibarrApi\_checkFilters(), _cleanObjectDatas(), and db.

MembersTypes::post

(

$request_data = null

)

Create member type object.

Parameters

array

$request_data

Request data

Returns

int ID of member type

Definition at line 152 of file api_memberstypes.class.php.

References _validate(), and db.

MembersTypes::put	(		$id,
			$request_data = null
	)

Update member type.

Parameters

int	$id	ID of member type to update
array	$request_data	Datas

Returns

int

Definition at line 177 of file api_memberstypes.class.php.

References DolibarrApi\_checkAccessToResource(), and db.

---

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

• htdocs/adherents/class/api_memberstypes.class.php