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.

	getType ($id)
	Get properties of a member type object.

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

	postType ($request_data=null)
	Create member type object.

	putType ($id, $request_data=null)
	Update member type.

	deleteType ($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.

	_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.

	_validateType ($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 37 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 464 of file api_members.class.php.

References $object.

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

◆ _validate()

Members::_validate ( $data )

private

Validate fields before creating an object.

Parameters

array | null $data Data to validate

Returns: array Return array with validated mandatory fields and their value

Exceptions

RestException

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

Referenced by post().

◆ _validateType()

Members::_validateType ( $data )

private

Validate fields before creating an object.

Parameters

array | null $data Data to validate

Returns: array

Exceptions

RestException

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

Referenced by postType().

◆ 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

Exceptions

RestException	403 Access denied
RestException	404 Member not found

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

◆ delete()

Members::delete ( $id )

Delete member.

Parameters

int $id member ID

Returns: array

Exceptions

RestException	403 Access denied
RestException	404 Member not found
RestException	500 Error when deleting a Member

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

References DolibarrApi\_checkAccessToResource().

◆ deleteType()

Members::deleteType ( $id )

Delete member type.

Parameters

int $id member type ID

Returns: array

@url DELETE /types/{id}

Exceptions

RestException	403 Access denied
RestException	404 No Member Type found
RestException	500 Error when deleting Member Type

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

References DolibarrApi\_checkAccessToResource().

◆ get()

Members::get ( $id )

Get properties of a member object.

Return an array with member information

Parameters

int $id ID of member

Returns: Object Object with cleaned properties

Exceptions

RestException	403 Access denied
RestException	404 Member not found

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

Parameters

int $thirdparty ID of third party

Returns: Object Data without useless information

@url GET thirdparty/{thirdparty}

Exceptions

RestException	403 Access denied
RestException	404 Member not found

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

Parameters

string $barcode Barcode of third party

Returns: Object Data without useless information

@url GET thirdparty/barcode/{barcode}

Exceptions

RestException	403 Access denied
RestException	404 Member or ThirdParty not found

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

Parameters

string $email Email of third party

Returns: Object Data without useless information

@url GET thirdparty/email/{email}

Exceptions

RestException	403 Access denied
RestException	404 Member or ThirdParty not found

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

Exceptions

RestException	403 Access denied
RestException	404 Category not found
RestException	503 Error when retrieving Category list

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

@url GET {id}/subscriptions

Exceptions

RestException	403 Access denied
RestException	404 Member not found

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

References _cleanObjectDatas().

◆ getType()

Members::getType ( $id )

Get properties of a member type object.

Return an array with member type information

Parameters

int $id ID of member type

Returns: Object Object with cleaned properties

@url GET /types/{id}

Exceptions

RestException	403 Access denied
RestException	404 No Member Type found

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

References DolibarrApi\_checkAccessToResource(), and _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 these properties. Ignored if empty. Comma separated list of properties names

Returns: array Array of member objects

Exceptions

RestException	400 Error on SQL filters
RestException	403 Access denied
RestException	404 No Member found
RestException	503 Error when retrieving Member list

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

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

◆ 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	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.libelle:like:'SO-%') and (t.subscription:=:'1')"
string	$properties	Restrict 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

RestException	403 Access denied
RestException	404 No Member Type found
RestException	503 Error when retrieving Member list

Definition at line 680 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 @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: int ID of member

Exceptions

RestException	403 Access denied
RestException	500 Error when creating Member

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

References DolibarrApi\_checkValForAPI(), _validate(), and sanitizeVal().

◆ postType()

Members::postType ( $request_data = null )

Create member type object.

Parameters

array $request_data Request data

Returns: int ID of member type

@url POST /types/

Exceptions

RestException	403 Access denied
RestException	500 Error when creating Member Type

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

References DolibarrApi\_checkValForAPI(), _validateType(), and sanitizeVal().

◆ 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

Exceptions

RestException	403 Access denied
RestException	404 Member not found
RestException	500 Error when resiliating, validating, excluding, updating a Member

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

References DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), and sanitizeVal().

◆ putType()

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

Update member type.

Parameters

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

Returns: Object Updated object

@url PUT /types/{id}

Exceptions

RestException	403 Access denied
RestException	404 No Member Type found
RestException	500 Error when updating Member Type

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

References DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), and sanitizeVal().

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

dolibarr_20.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()

◆ _validateType()

◆ createSubscription()

◆ delete()

◆ deleteType()

◆ get()

◆ getByThirdparty()

◆ getByThirdpartyBarcode()

◆ getByThirdpartyEmail()

◆ getCategories()

◆ getSubscriptions()

◆ getType()

◆ index()

◆ indexType()

◆ post()

◆ postType()

◆ put()

◆ putType()