Inheritance diagram for Members:

Collaboration diagram for Members:

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
	_cleanObjectDatas ($object)
	Executed method when API is called without parameter. More...

	_checkFilters ($sqlfilters)
	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 user access to a resource. More...

static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria. More...

Detailed Description

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

Member Function Documentation

Members::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties

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

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

Members::_validate ( $data )

private

Validate fields before creating an object.

Parameters

array | null $data Data to validate

Returns: array

Exceptions

RestException

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

Referenced by post().

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

Add a subscription for a member.

Parameters

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

Returns: int ID of subscription

POST {id}/subscriptions

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

References db.

Members::delete ( $id )

Delete member.

Parameters

int $id member ID

Returns: array

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

References DolibarrApi\_checkAccessToResource(), and db.

Members::get ( $id )

Get properties of a member object.

Return an array with member informations

Parameters

int $id ID of member

Returns: array|mixed data without useless information

Exceptions

RestException

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

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

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

GET thirdparty/{thirdparty}

Exceptions

RestException	401
RestException	404

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

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

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

GET thirdparty/barcode/{barcode}

Exceptions

RestException	401
RestException	404

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

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

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

GET thirdparty/email/{email}

Exceptions

RestException	401
RestException	404

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

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

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

GET {id}/categories

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

References db.

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 GET {id}/subscriptions

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

References _cleanObjectDatas(), and db.

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

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))"

Returns: array Array of member objects

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), _cleanObjectDatas(), and db.

Members::post ( $request_data = null )

Create member object.

Parameters

array $request_data Request data

Returns: int ID of member

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

References _validate(), and db.

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

References DolibarrApi\_checkAccessToResource(), and db.

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

htdocs/adherents/class/api_members.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation