dolibarr  7.0.0-beta
Public Member Functions | List of all members
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...
 
 _validate ($data)
 Validate fields before creating an object. More...
 
 _cleanObjectDatas ($object)
 Clean sensible object datas. More...
 
- Public Member Functions inherited from DolibarrApi
 __construct ($db, $cachedir='', $refreshCache=false)
 Constructor. More...
 
 _cleanObjectDatas ($object)
 Executed method when API is called without parameter. More...
 
 _checkFilters ($sqlfilters)
 Return if a $sqlfilters parameter is valid. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DolibarrApi
static _checkAccessToResource ($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid')
 Check user access to a resource. More...
 
static _forge_criteria_callback ($matches)
 Function to forge a SQL criteria. More...
 

Detailed Description

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

Member Function Documentation

MembersTypes::_cleanObjectDatas (   $object)

Clean sensible object datas.

Parameters
object$objectObject to clean
Returns
array Array of cleaned object properties

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

Referenced by get(), and index().

MembersTypes::_validate (   $data)

Validate fields before creating an object.

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

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

Referenced by post().

MembersTypes::delete (   $id)

Delete member type.

Parameters
int$idmember type ID
Returns
array

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

References DolibarrApi\_checkAccessToResource().

MembersTypes::get (   $id)

Get properties of a member type object.

Return an array with member type informations

Parameters
int$idID 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(), and _cleanObjectDatas().

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 DolibarrApi\_checkFilters(), and _cleanObjectDatas().

MembersTypes::post (   $request_data = null)

Create member type object.

Parameters
array$request_dataRequest data
Returns
int ID of member type

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

References _validate().

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 181 of file api_memberstypes.class.php.

References DolibarrApi\_checkAccessToResource().


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