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 sensitive object data fields @phpstan-template T of Object.
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 creating or updating 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 38 of file api_mymodule.class.php.

Constructor & Destructor Documentation

__construct()

MyModuleApi::__construct

(

)

Constructor.

@url GET /

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

Member Function Documentation

_cleanObjectDatas()

MyModuleApi::_cleanObjectDatas ( $object )

protected

Clean sensitive object data fields @phpstan-template T of Object.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

@phpstan-param T $object @phpstan-return T

Reimplemented from DolibarrApi.

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

References $object, and _cleanObjectDatas().

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

_validateMyObject()

MyModuleApi::_validateMyObject ( $data )

private

Validate fields before creating or updating object.

Parameters

array

$data

Array of data to validate @phan-param array<string,null|int|float|string> $data @phpstan-param array<string,null|int|float|string> $data

Returns

array @phan-return array<string,null|int|float|string>|array{} @phpstan-return array<string,null|int|float|string>|array{}

Exceptions

RestException

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

Referenced by post().

delete()

MyModuleApi::delete

(

$id

)

Delete myobject.

Parameters

int

$id

MyObject ID

Returns

array @phan-return array<string,array{code:int,message:string}> @phpstan-return array<string,array{code:int,message:string}>

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

References $id, and 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 @phan-return MyObject Object with cleaned properties @phpstan-return MyObject Object with cleaned properties

@phan-return MyObject

@url GET myobjects/{id}

Exceptions

RestException	403 Not allowed
RestException	404 Not found

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

References $id, 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 MyObject objects @phan-return array<int,MyObject> @phpstan-return array<int,MyObject>

Exceptions

RestException	403 Not allowed
RestException	503 System error

@url GET /myobjects/

Definition at line 116 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 data @phan-param array{string,mixed} $request_data @phpstan-param array{string,mixed} $request_data

Returns

int ID of myobject

Exceptions

RestException	403 Not allowed
RestException	500 System error

@url POST myobjects/

Definition at line 206 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	Data @phan-param mixed[] $request_data @phpstan-param mixed[] $request_data

Returns

Object Object after update @phan-return MyObject @phpstan-return MyObject

@phan-return MyObject

Exceptions

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

@url PUT myobjects/{id}

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

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

---

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

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