Inheritance diagram for EventAttendees:

Collaboration diagram for EventAttendees:

Public Member Functions
	__construct ()
	Constructor of the class.

	deleteById ($id)
	Delete an event attendee.

	deleteByRef ($ref)
	Delete an event attendee.

	getById ($id)
	Get properties of a event attendee by id.

	getByRef ($ref)
	Get properties of an event attendee by ref.

	index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='', $properties='', $pagination_data=false)
	List Event attendees.

	post ($request_data=null)
	Create an event attendee.

	putById ($id, $request_data=null)
	Update an event attendee.

	putByRef ($ref, $request_data=null)
	Update an event attendee.

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
	_fetch ($id, $ref='')
	Get properties of an event attendee.

	_validate ($data)
	Validate fields before create or update object.

	_checkAccessRights ($accesstype, $project_id=0)
	function to check for access rights - should probably have 1.

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 31 of file api_eventattendees.class.php.

Member Function Documentation

◆ _checkAccessRights()

EventAttendees::_checkAccessRights	(		$accesstype,
			$project_id = 0 )

private

function to check for access rights - should probably have 1.

parameter which is read/write/delete/... Why a separate function? because we probably needs to check so many many different kinds of objects

Parameters

string	$accesstype	accesstype: read, write, delete, ...
int	$project_id	which project do we need to check for access to, 0 means don't check

Returns: bool Return true if access is granted else false

Exceptions

RestException	403
RestException	500

Definition at line 603 of file api_eventattendees.class.php.

References dol_syslog().

Referenced by _fetch(), deleteById(), deleteByRef(), index(), post(), putById(), and putByRef().

◆ _cleanObjectDatas()

EventAttendees::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object $object Object to clean @phan-param ConferenceOrBoothAttendee $object @phpstan-param ConferenceOrBoothAttendee $object

Returns: Object Object with cleaned properties @phan-return ConferenceOrBoothAttendee @phpstan-return ConferenceOrBoothAttendee

Reimplemented from DolibarrApi.

Definition at line 497 of file api_eventattendees.class.php.

References $object.

Referenced by _fetch(), and index().

◆ _fetch()

EventAttendees::_fetch	(		$id,
			$ref = '' )

private

Get properties of an event attendee.

Return an array with Event attendees

Parameters

int	$id	ID of event_attendees
string	$ref	Ref of event_attendees

Returns: Object Object with cleaned properties @phan-return ConferenceOrBoothAttendee @phpstan-return ConferenceOrBoothAttendee

Exceptions

RestException	403
RestException	404

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

References $id, _checkAccessRights(), and _cleanObjectDatas().

Referenced by getById(), getByRef(), putById(), and putByRef().

◆ _validate()

EventAttendees::_validate ( $data )

private

Validate fields before create or update object.

Parameters

?array<string,null|int|string> $data Data to validate

Returns: array<string,null|int|string> Return array with validated mandatory fields and their value @phan-return array<string,?int|?string> Return array with validated mandatory fields and their value

Exceptions

RestException 400

Definition at line 580 of file api_eventattendees.class.php.

Referenced by post().

◆ deleteById()

EventAttendees::deleteById ( $id )

Delete an event attendee.

Parameters

int $id event attendee ID

Returns: array @phan-return array<array<string,int|string>> @phpstan-return array<array<string,int|string>>

@url DELETE {id}

Exceptions

RestException	403
RestException	404
RestException	500

Definition at line 85 of file api_eventattendees.class.php.

References $id, and _checkAccessRights().

◆ deleteByRef()

EventAttendees::deleteByRef ( $ref )

Delete an event attendee.

Parameters

string $ref event attendee ref

Returns: array @phan-return array<array<string,int|string>> @phpstan-return array<array<string,int|string>>

@url DELETE ref/{ref}

Exceptions

RestException	403
RestException	404
RestException	500

Definition at line 123 of file api_eventattendees.class.php.

References _checkAccessRights().

◆ getById()

EventAttendees::getById ( $id )

Get properties of a event attendee by id.

Return an array with event attendee information

Parameters

int $id ID of event attendee

Returns: Object Object with cleaned properties @phan-return ConferenceOrBoothAttendee @phpstan-return ConferenceOrBoothAttendee

@url GET {id}

Exceptions

RestException	403
RestException	404

Definition at line 162 of file api_eventattendees.class.php.

References $id, and _fetch().

◆ getByRef()

EventAttendees::getByRef ( $ref )

Get properties of an event attendee by ref.

Return an array with order information

Parameters

string $ref Ref of object

Returns: Object Object with cleaned properties @phan-return ConferenceOrBoothAttendee @phpstan-return ConferenceOrBoothAttendee

@url GET ref/{ref}

Exceptions

RestException	403
RestException	404

Definition at line 182 of file api_eventattendees.class.php.

References _fetch().

◆ index()

EventAttendees::index	(	$sortfield = "t.rowid",
		$sortorder = 'ASC',
		$limit = 100,
		$page = 0,
		$sqlfilters = '',
		$properties = '',
		$pagination_data = false )

List Event attendees.

Get a list of Event attendees

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.status:=:1) and (t.email:=:'bad@example.com')"
string	$properties	Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
bool	$pagination_data	If this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0*

Returns: array Array of order objects @phan-return ConferenceOrBoothAttendee[]|array{data:ConferenceOrBoothAttendee[],pagination:array{total:int,page:int,page_count:int,limit:int}} @phpstan-return ConferenceOrBoothAttendee[]|array{data:ConferenceOrBoothAttendee[],pagination:array{total:int,page:int,page_count:int,limit:int}}

@url GET

Exceptions

RestException	403 Access denied
RestException	503 Error

Definition at line 208 of file api_eventattendees.class.php.

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

◆ post()

EventAttendees::post ( $request_data = null )

Create an event attendee.

Example: {"module":"adherent","type_template":"member","active": 1,"ref":"(SendingEmailOnAutoSubscription)","fk_user":0,"joinfiles": "0", ... } Required: {"ref":"myBestTemplate","topic":"myBestOffer","type_template":"propal_send"}

Parameters

array $request_data Request data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

@url POST

Returns: int ID of event attendee

Exceptions

RestException	304
RestException	403
RestException	500

Definition at line 316 of file api_eventattendees.class.php.

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

◆ putById()

EventAttendees::putById	(		$id,
			$request_data = null )

Update an event attendee.

Example: {"module":"adherent","type_template":"member","active": 1,"ref":"(SendingEmailOnAutoSubscription)","fk_user":0,"joinfiles": "0", ... } Required: {"ref":"myBestTemplate","topic":"myBestOffer","type_template":"propal_send"}

Parameters

int	$id	Id of order to update
array	$request_data	Data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

@url PUT {id}

Returns: Object Object with cleaned properties

Exceptions

RestException	403
RestException	404
RestException	500

Definition at line 362 of file api_eventattendees.class.php.

References $id, _checkAccessRights(), DolibarrApi\_checkValForAPI(), _fetch(), and sanitizeVal().

◆ putByRef()

EventAttendees::putByRef	(		$ref,
			$request_data = null )

Update an event attendee.

Example: {"module":"adherent","type_template":"member","active": 1,"ref":"(SendingEmailOnAutoSubscription)","fk_user":0,"joinfiles": "0", ... } Required: {"ref":"myBestTemplate","topic":"myBestOffer","type_template":"propal_send"}

Parameters

string	$ref	Ref of order to update
array	$request_data	Data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

@url PUT ref/{ref}

Returns: Object Object with cleaned properties

Exceptions

RestException	403
RestException	404
RestException	500

Definition at line 413 of file api_eventattendees.class.php.

References _checkAccessRights(), DolibarrApi\_checkValForAPI(), _fetch(), and sanitizeVal().

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

dolibarr_22.0/htdocs/eventorganization/class/api_eventattendees.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _checkAccessRights()

◆ _cleanObjectDatas()

◆ _fetch()

◆ _validate()

◆ deleteById()

◆ deleteByRef()

◆ getById()

◆ getByRef()

◆ index()

◆ post()

◆ putById()

◆ putByRef()