Mos Class Reference

Inheritance diagram for Mos:

Collaboration diagram for Mos:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get properties of a MO object.
	index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='')
	List Mos.
	post ($request_data=null)
	Create MO object.
	put ($id, $request_data=null)
	Update MO.
	delete ($id)
	Delete MO.
	produceAndConsume ($id, $request_data=null)
	Produce and consume.
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.
	_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.
	checkRefNumbering ()
	Validate the ref field and get the next Number if it's necessary.

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 36 of file api_mos.class.php.

Member Function Documentation

_cleanObjectDatas()

Mos::_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 653 of file api_mos.class.php.

References _cleanObjectDatas().

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

_validate()

Mos::_validate ( $data )

private

Validate fields before create or update object.

Parameters

array

$data

Array of data to validate

Returns

array

Exceptions

RestException

Definition at line 716 of file api_mos.class.php.

Referenced by post().

checkRefNumbering()

Mos::checkRefNumbering ( )

private

Validate the ref field and get the next Number if it's necessary.

Returns

void

Definition at line 736 of file api_mos.class.php.

Referenced by post(), and put().

delete()

Mos::delete

(

$id

)

Delete MO.

Parameters

int

$id

MO ID

Returns

array

Definition at line 259 of file api_mos.class.php.

References DolibarrApi\_checkAccessToResource().

get()

Mos::get

(

$id

)

Get properties of a MO object.

Return an array with MO informations

Parameters

int

$id

ID of MO

Returns

Object Object with cleaned properties

@url GET {id}

Exceptions

RestException

Definition at line 64 of file api_mos.class.php.

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

index()

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

List Mos.

Get a list of MOs

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.ref:like:'SO-%') and (t.date_creation:<:'20160101')"

Returns

array Array of order objects

Exceptions

RestException

Definition at line 97 of file api_mos.class.php.

References _cleanObjectDatas(), and forgeSQLFromUniversalSearchCriteria().

post()

Mos::post

(

$request_data = null

)

Create MO object.

Parameters

array

$request_data

Request datas

Returns

int ID of MO

Definition at line 194 of file api_mos.class.php.

References _validate(), and checkRefNumbering().

produceAndConsume()

Mos::produceAndConsume	(		$id,
			$request_data = null )

Produce and consume.

Example: { "inventorylabel": "Produce and consume using API", "inventorycode": "PRODUCEAPI-YY-MM-DD", "autoclose": 1, "arraytoconsume": [], "arraytoproduce": [] }

Parameters

int	$id	ID of state
array	$request_data	Request datas

@url POST {id}/produceandconsume

Returns

int ID of MO

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

References dol_include_once(), dol_now(), and dol_syslog().

put()

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

Update MO.

Parameters

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

Returns

int

Definition at line 222 of file api_mos.class.php.

References DolibarrApi\_checkAccessToResource(), and checkRefNumbering().

---

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

• dolibarr_18.0/htdocs/mrp/class/api_mos.class.php