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

Public Member Functions

 __construct ()
 Constructor.
 
 get ($id)
 Get properties of a reception object. More...
 
 index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $thirdparty_ids='', $sqlfilters='', $properties='')
 List receptions. More...
 
 post ($request_data=null)
 Create reception object. More...
 
 deleteLine ($id, $lineid)
 Delete a line to given reception. More...
 
 put ($id, $request_data=null)
 Update reception general fields (won't touch lines of reception) More...
 
 delete ($id)
 Delete reception. More...
 
 validate ($id, $notrigger=0)
 Validate a reception. More...
 
 close ($id, $notrigger=0)
 Close a reception (Classify it as "Delivered") 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 30 of file api_receptions.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Receptions::_cleanObjectDatas (   $object)
protected

Clean sensible object datas.

Parameters
Object$objectObject to clean
Returns
Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 690 of file api_receptions.class.php.

References $object.

◆ _validate()

Receptions::_validate (   $data)
private

Validate fields before create or update object.

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

Definition at line 729 of file api_receptions.class.php.

◆ close()

Receptions::close (   $id,
  $notrigger = 0 
)

Close a reception (Classify it as "Delivered")

Parameters
int$idReception ID
int$notriggerDisabled triggers

@url POST {id}/close

Returns
Object

Definition at line 652 of file api_receptions.class.php.

◆ delete()

Receptions::delete (   $id)

Delete reception.

Parameters
int$idReception ID
Returns
array

Definition at line 485 of file api_receptions.class.php.

◆ deleteLine()

Receptions::deleteLine (   $id,
  $lineid 
)

Delete a line to given reception.

Parameters
int$idId of reception to update
int$lineidId of line to delete
Returns
array

@url DELETE {id}/lines/{lineid}

Exceptions
RestException401
RestException404

Definition at line 408 of file api_receptions.class.php.

◆ get()

Receptions::get (   $id)

Get properties of a reception object.

Return an array with reception information

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

Definition at line 65 of file api_receptions.class.php.

◆ index()

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

List receptions.

Get a list of receptions

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$thirdparty_idsThirdparty ids to filter receptions 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 reception objects
Exceptions
RestException

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

◆ post()

Receptions::post (   $request_data = null)

Create reception object.

Parameters
array$request_dataRequest data
Returns
int ID of reception created

Definition at line 181 of file api_receptions.class.php.

◆ put()

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

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

Parameters
int$idId of reception to update
array$request_dataDatas
Returns
Object Object with cleaned properties

Definition at line 445 of file api_receptions.class.php.

◆ validate()

Receptions::validate (   $id,
  $notrigger = 0 
)

Validate a reception.

This may record stock movements if module stock is enabled and option to decrease stock on reception is on.

Parameters
int$idReception ID
int$notrigger1=Does not execute triggers, 0= execute triggers

@url POST {id}/validate

Returns
Object

Definition at line 530 of file api_receptions.class.php.


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