dolibarr  16.0.5
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
Members Class Reference
Inheritance diagram for Members:
Inheritance graph
[legend]
Collaboration diagram for Members:
Collaboration graph
[legend]

Public Member Functions

 __construct ()
 Constructor.
 
 get ($id)
 Get properties of a member object. More...
 
 getByThirdparty ($thirdparty)
 Get properties of a member object by linked thirdparty. More...
 
 getByThirdpartyEmail ($email)
 Get properties of a member object by linked thirdparty email. More...
 
 getByThirdpartyBarcode ($barcode)
 Get properties of a member object by linked thirdparty barcode. More...
 
 index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $typeid='', $category=0, $sqlfilters='')
 List members. More...
 
 post ($request_data=null)
 Create member object. More...
 
 put ($id, $request_data=null)
 Update member. More...
 
 delete ($id)
 Delete member. More...
 
 getSubscriptions ($id)
 List subscriptions of a member. More...
 
 createSubscription ($id, $start_date, $end_date, $amount, $label='')
 Add a subscription for a member. More...
 
 getCategories ($id, $sortfield="s.rowid", $sortorder='ASC', $limit=0, $page=0)
 Get categories for a member. 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...
 
 _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 34 of file api_members.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Members::_cleanObjectDatas (   $object)
protected

Clean sensible object datas.

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

Reimplemented from DolibarrApi.

Definition at line 429 of file api_members.class.php.

◆ _validate()

Members::_validate (   $data)
private

Validate fields before creating an object.

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

Definition at line 410 of file api_members.class.php.

◆ createSubscription()

Members::createSubscription (   $id,
  $start_date,
  $end_date,
  $amount,
  $label = '' 
)

Add a subscription for a member.

Parameters
int$idID of member
string$start_dateStart date {@from body} {@type timestamp}
string$end_dateEnd date {@from body} {@type timestamp}
float$amountAmount (may be 0) {@from body}
string$labelLabel {@from body}
Returns
int ID of subscription

@url POST {id}/subscriptions

Definition at line 496 of file api_members.class.php.

◆ delete()

Members::delete (   $id)

Delete member.

Parameters
int$idmember ID
Returns
array

Definition at line 371 of file api_members.class.php.

◆ get()

Members::get (   $id)

Get properties of a member object.

Return an array with member informations

Parameters
int$idID of member
Returns
array|mixed data without useless information
Exceptions
RestException

Definition at line 63 of file api_members.class.php.

◆ getByThirdparty()

Members::getByThirdparty (   $thirdparty)

Get properties of a member object by linked thirdparty.

Return an array with member informations

Parameters
int$thirdpartyID of third party
Returns
Object Data without useless information

@url GET thirdparty/{thirdparty}

Exceptions
RestException401
RestException404

Definition at line 100 of file api_members.class.php.

◆ getByThirdpartyBarcode()

Members::getByThirdpartyBarcode (   $barcode)

Get properties of a member object by linked thirdparty barcode.

Return an array with member informations

Parameters
string$barcodeBarcode of third party
Returns
Object Data without useless information

@url GET thirdparty/barcode/{barcode}

Exceptions
RestException401
RestException404

Definition at line 172 of file api_members.class.php.

◆ getByThirdpartyEmail()

Members::getByThirdpartyEmail (   $email)

Get properties of a member object by linked thirdparty email.

Return an array with member informations

Parameters
string$emailEmail of third party
Returns
Object Data without useless information

@url GET thirdparty/email/{email}

Exceptions
RestException401
RestException404

Definition at line 133 of file api_members.class.php.

◆ getCategories()

Members::getCategories (   $id,
  $sortfield = "s.rowid",
  $sortorder = 'ASC',
  $limit = 0,
  $page = 0 
)

Get categories for a member.

Parameters
int$idID of member
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
Returns
mixed

@url GET {id}/categories

Definition at line 524 of file api_members.class.php.

◆ getSubscriptions()

Members::getSubscriptions (   $id)

List subscriptions of a member.

Get a list of subscriptions

Parameters
int$idID of member
Returns
array Array of subscription objects
Exceptions
RestException@url GET {id}/subscriptions

Definition at line 463 of file api_members.class.php.

◆ index()

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

List members.

Get a list of members

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$typeidID of the type of member
int$categoryUse this param to filter list by category
string$sqlfiltersOther criteria to filter answers separated by a comma. Example: "(t.ref:like:'SO-%') and ((t.date_creation:<:'20160101') or (t.nature:is:NULL))"
Returns
array Array of member objects
Exceptions
RestException

Definition at line 214 of file api_members.class.php.

◆ post()

Members::post (   $request_data = null)

Create member object.

Parameters
array$request_dataRequest data
Returns
int ID of member

Definition at line 287 of file api_members.class.php.

◆ put()

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

Update member.

Parameters
int$idID of member to update
array$request_dataDatas
Returns
Object Updated object

Definition at line 312 of file api_members.class.php.


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