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

Public Member Functions

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

Member Function Documentation

◆ _cleanObjectDatas()

Shipments::_cleanObjectDatas (   $object)
protected

Clean sensible object datas.

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

Reimplemented from DolibarrApi.

Definition at line 688 of file api_shipments.class.php.

References $object.

◆ _validate()

Shipments::_validate (   $data)
private

Validate fields before create or update object.

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

Definition at line 734 of file api_shipments.class.php.

◆ close()

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

Close a shipment (Classify it as "Delivered")

Parameters
int$idExpedition ID
int$notriggerDisabled triggers

@url POST {id}/close

Returns
object

Definition at line 650 of file api_shipments.class.php.

◆ delete()

Shipments::delete (   $id)

Delete shipment.

Parameters
int$idShipment ID
Returns
array

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

◆ deleteLine()

Shipments::deleteLine (   $id,
  $lineid 
)

Delete a line to given shipment.

Parameters
int$idId of shipment to update
int$lineidId of line to delete

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

Returns
array
Exceptions
RestException401
RestException404

Definition at line 405 of file api_shipments.class.php.

◆ get()

Shipments::get (   $id)

Get properties of a shipment object.

Return an array with shipment information

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

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

◆ index()

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

List shipments.

Get a list of shipments

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

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

◆ post()

Shipments::post (   $request_data = null)

Create shipment object.

Parameters
array$request_dataRequest data
Returns
int ID of shipment created

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

◆ put()

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

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

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

Definition at line 442 of file api_shipments.class.php.

◆ validate()

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

Validate a shipment.

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

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

@url POST {id}/validate

Returns
object

Definition at line 528 of file api_shipments.class.php.


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