dolibarr  20.0.0-alpha
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='', $properties='')
 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...
 
 getType ($id)
 Get properties of a member type object. More...
 
 indexType ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='', $properties='')
 List members types. More...
 
 postType ($request_data=null)
 Create member type object. More...
 
 putType ($id, $request_data=null)
 Update member type. More...
 
 deleteType ($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...
 
 _filterObjectProperties ($object, $properties)
 Filter properties that will be returned on object. More...
 
 _checkFilters ($sqlfilters, &$error='')
 Return if a $sqlfilters parameter is valid Function no more used. More...
 

Private Member Functions

 _validate ($data)
 Validate fields before creating an object. More...
 
 _validateType ($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 37 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 462 of file api_members.class.php.

References $object.

◆ _validate()

Members::_validate (   $data)
private

Validate fields before creating an object.

Parameters
array | null$dataData to validate
Returns
array Return array with validated mandatory fields and their value
Exceptions
RestException

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

◆ _validateType()

Members::_validateType (   $data)
private

Validate fields before creating an object.

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

Definition at line 870 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

Exceptions
RestException403 Access denied
RestException404 Member not found

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

◆ delete()

Members::delete (   $id)

Delete member.

Parameters
int$idmember ID
Returns
array
Exceptions
RestException403 Access denied
RestException404 Member not found
RestException500 Error when deleting a Member

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

◆ deleteType()

Members::deleteType (   $id)

Delete member type.

Parameters
int$idmember type ID
Returns
array

@url DELETE /types/{id}

Exceptions
RestException403 Access denied
RestException404 No Member Type found
RestException500 Error when deleting Member Type

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

◆ get()

Members::get (   $id)

Get properties of a member object.

Return an array with member information

Parameters
int$idID of member
Returns
Object Object with cleaned properties
Exceptions
RestException403 Access denied
RestException404 Member not found

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

◆ getByThirdparty()

Members::getByThirdparty (   $thirdparty)

Get properties of a member object by linked thirdparty.

Return an array with member information

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

@url GET thirdparty/{thirdparty}

Exceptions
RestException403 Access denied
RestException404 Member not found

Definition at line 104 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 information

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

@url GET thirdparty/barcode/{barcode}

Exceptions
RestException403 Access denied
RestException404 Member or ThirdParty not found

Definition at line 176 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 information

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

@url GET thirdparty/email/{email}

Exceptions
RestException403 Access denied
RestException404 Member or ThirdParty not found

Definition at line 137 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

Exceptions
RestException403 Access denied
RestException404 Category not found
RestException503 Error when retrieving Category list

Definition at line 607 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

@url GET {id}/subscriptions

Exceptions
RestException403 Access denied
RestException404 Member not found

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

◆ getType()

Members::getType (   $id)

Get properties of a member type object.

Return an array with member type information

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

@url GET /types/{id}

Exceptions
RestException403 Access denied
RestException404 No Member Type found

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

◆ index()

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

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))"
string$propertiesRestrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
Returns
array Array of member objects
Exceptions
RestException400 Error on SQL filters
RestException403 Access denied
RestException404 No Member found
RestException503 Error when retrieving Member list

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

◆ indexType()

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

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')"
string$propertiesRestrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
Returns
array Array of member type objects

@url GET /types/

Exceptions
RestException403 Access denied
RestException404 No Member Type found
RestException503 Error when retrieving Member list

Definition at line 678 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
Exceptions
RestException403 Access denied
RestException500 Error when creating Member

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

◆ postType()

Members::postType (   $request_data = null)

Create member type object.

Parameters
array$request_dataRequest data
Returns
int ID of member type

@url POST /types/

Exceptions
RestException403 Access denied
RestException500 Error when creating Member Type

Definition at line 740 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
Exceptions
RestException403 Access denied
RestException404 Member not found
RestException500 Error when resiliating, validating, excluding, updating a Member

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

◆ putType()

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

Update member type.

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

@url PUT /types/{id}

Exceptions
RestException403 Access denied
RestException404 No Member Type found
RestException500 Error when updating Member Type

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


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