dolibarr 18.0.6
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.
 
 index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='')
 List members types.
 
 post ($request_data=null)
 Create member type object.
 
 put ($id, $request_data=null)
 Update member type.
 
 delete ($id)
 Delete member type.
 
- Public Member Functions inherited from DolibarrApi
 __construct ($db, $cachedir='', $refreshCache=false)
 Constructor.
 

Protected Member Functions

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

Private Member Functions

 _validate ($data)
 Validate fields before creating an object.
 

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.
 
static _forge_criteria_callback ($matches)
 Function to forge a SQL criteria from a Generic filter string.
 

Detailed Description

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

Member Function Documentation

◆ _cleanObjectDatas()

MembersTypes::_cleanObjectDatas ( $object)
protected

Clean sensible object datas.

Parameters
Object$objectObject to clean
Returns
Object Object with cleaned properties

Reimplemented from DolibarrApi.

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

Referenced by get(), and index().

◆ _validate()

MembersTypes::_validate ( $data)
private

Validate fields before creating an object.

Parameters
array | null$dataData to validate
Returns
array
Exceptions
RestException

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

Referenced by post().

◆ delete()

MembersTypes::delete ( $id)

Delete member type.

Parameters
int$idmember type ID
Returns
array

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

References DolibarrApi\_checkAccessToResource().

◆ get()

MembersTypes::get ( $id)

Get properties of a member type object.

Return an array with member type informations

Parameters
int$idID of member type
Returns
Object Object with cleaned properties
Exceptions
RestException

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

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

◆ index()

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

List members types.

Get a list of members types

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$sqlfiltersOther 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 _cleanObjectDatas(), and forgeSQLFromUniversalSearchCriteria().

◆ post()

MembersTypes::post ( $request_data = null)

Create member type object.

Parameters
array$request_dataRequest data
Returns
int ID of member type

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

References _validate().

◆ put()

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

Update member type.

Parameters
int$idID of member type to update
array$request_dataDatas
Returns
int

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

References DolibarrApi\_checkAccessToResource().


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