dolibarr  20.0.0-alpha
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
Donations Class Reference
Inheritance diagram for Donations:
Inheritance graph
[legend]
Collaboration diagram for Donations:
Collaboration graph
[legend]

Public Member Functions

 __construct ()
 Constructor.
 
 get ($id)
 Get properties of an donation object. More...
 
 index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $thirdparty_ids='', $sqlfilters='', $properties='')
 List donations. More...
 
 post ($request_data=null)
 Create donation object. More...
 
 put ($id, $request_data=null)
 Update order general fields (won't touch lines of order) More...
 
 delete ($id)
 Delete donation. More...
 
 validate ($id, $idwarehouse=0, $notrigger=0)
 Validate an donation. 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
 _checkValForAPI ($field, $value, $object)
 Check and convert a string depending on its type/name. More...
 
 _filterObjectProperties ($object, $properties)
 Filter properties that will be returned on object. More...
 
 _checkFilters ($sqlfilters, &$error='')
 Return if a $sqlfilters parameter is valid Function no more used. More...
 

Private Member Functions

 _validate ($data)
 Validate fields before create or update 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 access by user to a given resource. More...
 
static _forge_criteria_callback ($matches)
 Function to forge a SQL criteria from a Generic filter string. More...
 

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$objectObject to clean
Returns
Object Object with cleaned properties

Reimplemented from DolibarrApi.

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

References $object.

◆ _validate()

Donations::_validate (   $data)
private

Validate fields before create or update object.

Parameters
array$dataArray with data to verify
Returns
array
Exceptions
RestException

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

◆ delete()

Donations::delete (   $id)

Delete donation.

Parameters
int$idOrder ID
Returns
array

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

◆ get()

Donations::get (   $id)

Get properties of an donation object.

Return an array with donation information

Parameters
int$idID of order
Returns
Object Object with cleaned properties
Exceptions
RestException

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

◆ index()

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

List donations.

Get a list of donations

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$thirdparty_idsThirdparty ids to filter orders of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
string$sqlfiltersOther criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
string$propertiesRestrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
Returns
array Array of order objects
Exceptions
RestException

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

◆ post()

Donations::post (   $request_data = null)

Create donation object.

Parameters
array$request_dataRequest data
Returns
int ID of order

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

◆ put()

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

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

Parameters
int$idId of order to update
array$request_dataDatas
Returns
Object Updated object

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

◆ 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$idOrder ID
int$idwarehouseWarehouse ID
int$notrigger1=Does not execute triggers, 0= execute triggers

@url POST {id}/validate

Exceptions
RestException304
RestException403
RestException404
RestException500 System error
Returns
object

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


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