Inheritance diagram for KnowledgeManagement:

Collaboration diagram for KnowledgeManagement:

Public Member Functions
	__construct ()
	Constructor. More...

	get ($id)
	Get properties of a knowledgerecord object. More...

	getCategories ($id, $sortfield="s.rowid", $sortorder= 'ASC', $limit=0, $page=0)
	Get categories for a knowledgerecord object. More...

	index ($sortfield="t.rowid", $sortorder= 'ASC', $limit=100, $page=0, $sqlfilters= '')
	List knowledgerecords. More...

	post ($request_data=null)
	Create knowledgerecord object. More...

	put ($id, $request_data=null)
	Update knowledgerecord. More...

	delete ($id)
	Delete knowledgerecord. 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...

	_cleanObjectDatas ($object)
	Clean sensible object datas. More...

	_checkFilters ($sqlfilters, &$error= '')
	Return if a $sqlfilters parameter is valid. 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 38 of file api_knowledgemanagement.class.php.

Constructor & Destructor Documentation

KnowledgeManagement::__construct ( )

Constructor.

GET /

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

References db.

Member Function Documentation

KnowledgeManagement::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties

Definition at line 350 of file api_knowledgemanagement.class.php.

Referenced by get(), and index().

KnowledgeManagement::_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 414 of file api_knowledgemanagement.class.php.

Referenced by post().

KnowledgeManagement::delete ( $id )

Delete knowledgerecord.

Parameters

int $id KnowledgeRecord ID

Returns: array

Exceptions

RestException DELETE knowledgerecords/{id}

Definition at line 316 of file api_knowledgemanagement.class.php.

References DolibarrApi\_checkAccessToResource().

KnowledgeManagement::get ( $id )

Get properties of a knowledgerecord object.

Return an array with knowledgerecord informations

Parameters

int $id ID of knowledgerecord

Returns: array|mixed data without useless information

GET knowledgerecords/{id}

Exceptions

RestException	401 Not allowed
RestException	404 Not found

Definition at line 71 of file api_knowledgemanagement.class.php.

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

KnowledgeManagement::getCategories	(	$id,
		$sortfield = `"s.rowid"`,
		$sortorder = `'ASC'`,
		$limit = `0`,
		$page = `0`
	)

Get categories for a knowledgerecord object.

Parameters

int	$id	ID of knowledgerecord object
string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number

Returns: mixed

GET /knowledgerecords/{id}/categories

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

References db.

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

List knowledgerecords.

Get a list of knowledgerecords

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')"