Mos

class Mos extends DolibarrApi (View source)

API class for MO

Properties

protected DoliDB $db from  DolibarrApi
Restler $r from  DolibarrApi
Mo $mo

Methods

__construct()

Constructor

string|array<string, mixed>
_checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

from  DolibarrApi
object
_filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

from  DolibarrApi
object
_cleanObjectDatas(object $object)

Clean sensible object datas

static bool
_checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

from  DolibarrApi
bool|string
_checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

from  DolibarrApi
static string
_forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

from  DolibarrApi
object
get(int $id)

Get properties of a MO object

array
index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $sqlfilters = '', string $properties = '')

List Mos

int
post(array $request_data = null)

Create MO object

object
put(int $id, array $request_data = null)

Update MO

array
delete(int $id)

Delete MO

int
produceAndConsumeAll(int $id, array $request_data = null)

Produce and consume all

int
produceAndConsume(int $id, array $request_data = null)

Produce and consume

Details

at line 48
__construct()

Constructor

in DolibarrApi at line 98
protected string|array<string, mixed> _checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

Parameters

string $field

Field name
string|string[] $value

Value to check/clean
object $object Object

Return Value

string|array<string, mixed>

Value cleaned

in DolibarrApi at line 156
protected object _filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

Parameters

object $object

Object to clean
string $properties

Comma separated list of properties names

Return Value

object

Object with cleaned properties

at line 930
protected object _cleanObjectDatas(object $object)

Clean sensible object datas

Parameters

object $object

Object to clean

Return Value

object

Object with cleaned properties

in DolibarrApi at line 393
static protected bool _checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

Parameters

string $resource

element to check
int $resource_id

Object ID if we want to check a particular record (optional) is linked to a owned thirdparty (optional).
string $dbtablename

'TableName&SharedElement' with Tablename is table where object is stored. SharedElement is an optional key to define where to check entity. Not used if objectid is null (optional)
string $feature2

Feature to check, second level of permission (optional). Can be or check with 'level1|level2'.
string $dbt_keyfield

Field name for socid foreign key if not fk_soc. Not used if objectid is null (optional)
string $dbt_select

Field name for select if not rowid. Not used if objectid is null (optional)

Return Value

bool

in DolibarrApi at line 421
protected bool|string _checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string $sqlfilters

sqlfilter string
string $error

Error message

Return Value

bool|string

True if valid, False if not valid

in DolibarrApi at line 439
static protected string _forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string[] $matches

Array of found string by regex search. Each entry is 1 and only 1 criteria. Example: "t.ref:like:'SO-%'", "t.date_creation:<:'20160101'", "t.date_creation:<:'2016-01-01 12:30:00'", "t.nature:is:NULL", "t.field2:isnot:NULL"

Return Value

string

Forged criteria. Example: "t.field like 'abc%'"

at line 66
object get(int $id)

Get properties of a MO object

Return an array with MO information

Parameters

int $id

ID of MO

Return Value

object

Object with cleaned properties

Exceptions

RestException

at line 102
array index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $sqlfilters = '', string $properties = '')

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')"
string $properties

Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names

Return Value

array

Array of order objects

Exceptions

RestException

at line 187
int post(array $request_data = null)

Create MO object

Parameters

array $request_data

Request datas

Return Value

int

ID of MO

Exceptions

RestException

at line 225
object put(int $id, array $request_data = null)

Update MO

Parameters

int $id

Id of MO to update
array $request_data Datas

Return Value

object

Updated object

at line 277
array delete(int $id)

Delete MO

Parameters

int $id

MO ID

Return Value

array

at line 336
int produceAndConsumeAll(int $id, array $request_data = null)

Produce and consume all

  • If arraytoconsume and arraytoproduce are both filled, this fill an empty MO with the lines to consume and produce and record the consumption and production.
  • If arraytoconsume and arraytoproduce are not provided, it consumes and produces all existing lines.

Example: { "inventorylabel": "Produce and consume using API", "inventorycode": "PRODUCEAPI-YY-MM-DD", "autoclose": 1, "arraytoconsume": [ "objectid": 123, -- ID_of_product "qty": "2", "fk_warehouse": "789" ], "arraytoproduce": [ "objectid": 456, -- ID_of_product "qty": "1", "fk_warehouse": "789" ] }

Parameters

int $id

ID of state
array $request_data

Request datas

Return Value

int

ID of MO

at line 714
int produceAndConsume(int $id, array $request_data = null)

Produce and consume

Example: { "inventorylabel": "Produce and consume using API", "inventorycode": "PRODUCEAPI-YY-MM-DD", "autoclose": 1, "arraytoconsume": [ { "objectid": "123", -- rowid of MoLine "qty": "2", "fk_warehouse": "789" -- "0" or empty, if stock change is disabled. } ], "arraytoproduce": [ { "objectid": "456", -- rowid of MoLine "qty": "1", "fk_warehouse": "789", "pricetoproduce": "12.3" -- optional } ] }

Parameters

int $id

ID of state
array $request_data

Request datas

Return Value

int

ID of MO