MyModuleApi Class Reference

Inheritance diagram for MyModuleApi:

Collaboration diagram for MyModuleApi:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get properties of a myobject object.
	index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='', $properties='')
	List myobjects.
	post ($request_data=null)
	Create myobject object.
	put ($id, $request_data=null)
	Update myobject.
	delete ($id)
	Delete myobject.
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.
	_filterObjectProperties ($object, $properties)
	Filter properties that will be returned on object.
	_checkFilters ($sqlfilters, &$error='')
	Return if a $sqlfilters parameter is valid Function no more used.

Private Member Functions
	_validateMyObject ($data)
	Validate fields before create or update object.

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 37 of file api_mymodule.class.php.

Constructor & Destructor Documentation

__construct()

MyModuleApi::__construct

(

)

Constructor.

@url GET /

Definition at line 50 of file api_mymodule.class.php.

Member Function Documentation

_cleanObjectDatas()

MyModuleApi::_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 365 of file api_mymodule.class.php.

References $object, and _cleanObjectDatas().

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

_validateMyObject()

MyModuleApi::_validateMyObject ( $data )

private

Validate fields before create or update object.

Parameters

array

$data

Array of data to validate

Returns

array

Exceptions

RestException

Definition at line 339 of file api_mymodule.class.php.

Referenced by post().

delete()

MyModuleApi::delete

(

$id

)

Delete myobject.

Parameters

int

$id

MyObject ID

Returns

array

Exceptions

RestException	403 Not allowed
RestException	404 Not found
RestException	409 Nothing to do
RestException	500 System error

@url DELETE myobjects/{id}

Definition at line 302 of file api_mymodule.class.php.

References DolibarrApi\_checkAccessToResource().

get()

MyModuleApi::get

(

$id

)

Get properties of a myobject object.

Return an array with myobject information

Parameters

int

$id

ID of myobject

Returns

Object Object with cleaned properties

@url GET myobjects/{id}

Exceptions

RestException	403 Not allowed
RestException	404 Not found

Definition at line 73 of file api_mymodule.class.php.

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

index()

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

List myobjects.

Get a list of myobjects

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

Returns

array Array of order objects

Exceptions

RestException	403 Not allowed
RestException	503 System error

@url GET /myobjects/

Definition at line 109 of file api_mymodule.class.php.

References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), and forgeSQLFromUniversalSearchCriteria().

post()

MyModuleApi::post

(

$request_data = null

)

Create myobject object.

Parameters

array

$request_data

Request datas

Returns

int ID of myobject

Exceptions

RestException	403 Not allowed
RestException	500 System error

@url POST myobjects/

Definition at line 197 of file api_mymodule.class.php.

References DolibarrApi\_checkValForAPI(), _validateMyObject(), and sanitizeVal().

put()

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

Update myobject.

Parameters

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

Returns

Object Object after update

Exceptions

RestException	403 Not allowed
RestException	404 Not found
RestException	500 System error

@url PUT myobjects/{id}

Definition at line 245 of file api_mymodule.class.php.

References DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), and sanitizeVal().

---

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

• dolibarr_20.0/htdocs/modulebuilder/template/class/api_mymodule.class.php