Donations Class Reference

Inheritance diagram for Donations:

Collaboration diagram for Donations:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get properties of an donation object.
	index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $thirdparty_ids='', $sqlfilters='', $properties='', $pagination_data=false)
	List donations.
	post ($request_data=null)
	Create donation object.
	put ($id, $request_data=null)
	Update order general fields (won't touch lines of order)
	delete ($id)
	Delete donation.
	validate ($id, $idwarehouse=0, $notrigger=0)
	Validate an donation.
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 create or update 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 29 of file api_donations.class.php.

Member Function Documentation

_cleanObjectDatas()

Donations::_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 368 of file api_donations.class.php.

References $object.

Referenced by get(), index(), and validate().

_validate()

Donations::_validate ( $data )

private

Validate fields before create or update object.

Parameters

array

$data

Array with data to verify

Returns

array

Exceptions

RestException

Definition at line 390 of file api_donations.class.php.

Referenced by post().

delete()

Donations::delete

(

$id

)

Delete donation.

Parameters

int

$id

Order ID

Returns

array

Definition at line 275 of file api_donations.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

get()

Donations::get

(

$id

)

Get properties of an donation object.

Return an array with donation information

Parameters

int

$id

ID of order

Returns

Object Object with cleaned properties

Exceptions

RestException

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

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

index()

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

List donations.

Get a list of donations

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$thirdparty_ids	Thirdparty ids to filter orders of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
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

Exceptions

RestException

Definition at line 101 of file api_donations.class.php.

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

post()

Donations::post

(

$request_data = null

)

Create donation object.

Parameters

array

$request_data

Request data

Returns

int ID of order

Definition at line 195 of file api_donations.class.php.

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

put()

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

Update order general fields (won't touch lines of order)

Parameters

int	$id	Id of order to update
array	$request_data	Datas

Returns

Object Updated object

Definition at line 235 of file api_donations.class.php.

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

validate()

Donations::validate	(		$id,
			$idwarehouse = 0,
			$notrigger = 0 )

Validate an donation.

If you get a bad value for param notrigger check, provide this in body { "idwarehouse": 0, "notrigger": 0 }

Parameters

int	$id	Order ID
int	$idwarehouse	Warehouse ID
int	$notrigger	1=Does not execute triggers, 0= execute triggers

@url POST {id}/validate

Exceptions

RestException	304
RestException	403
RestException	404
RestException	500 System error

Returns

object

Definition at line 324 of file api_donations.class.php.

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

---

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

• dolibarr_dev/htdocs/don/class/api_donations.class.php