Inheritance diagram for Members:

Collaboration diagram for Members:

Public Member Functions
	__construct ()
	Constructor.

	get ($id)
	Get properties of a member object.

	getByThirdparty ($thirdparty)
	Get properties of a member object by linked thirdparty.

	getByThirdpartyEmail ($email)
	Get properties of a member object by linked thirdparty email.

	getByThirdpartyBarcode ($barcode)
	Get properties of a member object by linked thirdparty barcode.

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

	post ($request_data=null)
	Create member object.

	put ($id, $request_data=null)
	Update member.

	delete ($id)
	Delete member.

	getSubscriptions ($id)
	List subscriptions of a member.

	createSubscription ($id, $start_date, $end_date, $amount, $label='')
	Add a subscription for a member.

	getCategories ($id, $sortfield="s.rowid", $sortorder='ASC', $limit=0, $page=0)
	Get categories for a member.

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.

	_filterObjectProperties ($object, $properties)
	Filter properties that will be returned on object.

	_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 34 of file api_members.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Members::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties

Reimplemented from DolibarrApi.

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

Referenced by get(), getByThirdparty(), getByThirdpartyBarcode(), getByThirdpartyEmail(), getSubscriptions(), and index().

◆ _validate()

Members::_validate ( $data )

private

Validate fields before creating an object.

Parameters

array | null $data Data to validate

Returns: array

Exceptions

RestException

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

Referenced by post().

◆ createSubscription()

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

Add a subscription for a member.

Parameters

int	$id	ID of member
string	$start_date	Start date {@from body} {@type timestamp}
string	$end_date	End date {@from body} {@type timestamp}
float	$amount	Amount (may be 0) {@from body}
string	$label	Label {@from body}

Returns: int ID of subscription

@url POST {id}/subscriptions

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

◆ delete()

Members::delete ( $id )

Delete member.

Parameters

int $id member ID

Returns: array

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

References DolibarrApi\_checkAccessToResource().

◆ get()

Members::get ( $id )

Get properties of a member object.

Return an array with member informations

Parameters

int $id ID of member

Returns: Object Object with cleaned properties

Exceptions

RestException

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

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

◆ getByThirdparty()

Members::getByThirdparty ( $thirdparty )

Get properties of a member object by linked thirdparty.

Return an array with member informations

Parameters

int $thirdparty ID of third party

Returns: Object Data without useless information

@url GET thirdparty/{thirdparty}

Exceptions

RestException	401
RestException	404

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

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

◆ getByThirdpartyBarcode()

Members::getByThirdpartyBarcode ( $barcode )

Get properties of a member object by linked thirdparty barcode.

Return an array with member informations

Parameters

string $barcode Barcode of third party

Returns: Object Data without useless information

@url GET thirdparty/barcode/{barcode}

Exceptions

RestException	401
RestException	404

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

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

◆ getByThirdpartyEmail()

Members::getByThirdpartyEmail ( $email )

Get properties of a member object by linked thirdparty email.

Return an array with member informations

Parameters

string $email Email of third party

Returns: Object Data without useless information

@url GET thirdparty/email/{email}

Exceptions

RestException	401
RestException	404

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

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

◆ getCategories()

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

Get categories for a member.

Parameters

int	$id	ID of member
string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number

Returns: mixed

@url GET {id}/categories

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

◆ getSubscriptions()

Members::getSubscriptions ( $id )

List subscriptions of a member.

Get a list of subscriptions

Parameters

int $id ID of member

Returns: array Array of subscription objects

Exceptions

RestException

@url GET {id}/subscriptions

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

References _cleanObjectDatas().

◆ 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	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$typeid	ID of the type of member
int	$category	Use this param to filter list by category
string	$sqlfilters	Other criteria to filter answers separated by a comma. Example: "(t.ref:like:'SO-%') and ((t.date_creation:<:'20160101') or (t.nature:is:NULL))"
string	$properties	Restrict the data returned to theses properties. Ignored if empty. Comma separated list of properties names

Returns: array Array of member objects

Exceptions

RestException

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

References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), and forgeSQLFromUniversalSearchCriteria().

◆ post()

Members::post ( $request_data = null )

Create member object.

Parameters

array $request_data Request data

Returns: int ID of member

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

References _validate().

◆ put()

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

Update member.

Parameters

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

Returns: Object Updated object

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

References DolibarrApi\_checkAccessToResource().

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

dolibarr_19.0/htdocs/adherents/class/api_members.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cleanObjectDatas()

◆ _validate()

◆ createSubscription()

◆ delete()

◆ get()

◆ getByThirdparty()

◆ getByThirdpartyBarcode()

◆ getByThirdpartyEmail()

◆ getCategories()

◆ getSubscriptions()

◆ index()

◆ post()

◆ put()