Inheritance diagram for Contracts:

Collaboration diagram for Contracts:

Public Member Functions
	__construct ()
	Constructor.

	get ($id)
	Get properties of a contract object.

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

	post ($request_data=null)
	Create contract object.

	getLines ($id)
	Get lines of a contract.

	postLine ($id, $request_data=null)
	Add a line to given contract.

	putLine ($id, $lineid, $request_data=null)
	Update a line to given contract.

	activateLine ($id, $lineid, $datestart, $dateend=null, $comment=null)
	Activate a service line of a given contract.

	unactivateLine ($id, $lineid, $datestart, $comment=null)
	Unactivate a service line of a given contract.

	deleteLine ($id, $lineid)
	Delete a line to given contract.

	put ($id, $request_data=null)
	Update contract general fields (won't touch lines of contract)

	delete ($id)
	Delete contract.

	validate ($id, $notrigger=0)
	Validate a contract.

	close ($id, $notrigger=0)
	Close all services of a contract.

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
	_validate ($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 30 of file api_contracts.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Contracts::_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 666 of file api_contracts.class.php.

Referenced by activateLine(), get(), getLines(), index(), putLine(), and unactivateLine().

◆ _validate()

Contracts::_validate ( $data )

private

Validate fields before create or update object.

Parameters

array $data Array with data to verify

Returns: array

Exceptions

RestException

Definition at line 684 of file api_contracts.class.php.

Referenced by post().

◆ activateLine()

Contracts::activateLine	(	$id,
		$lineid,
		$datestart,
		$dateend = null,
		$comment = null )

Activate a service line of a given contract.

Parameters

int	$id	Id of contract to activate
int	$lineid	Id of line to activate
string	$datestart	{@from body} Date start {@type timestamp}
string	$dateend	{@from body} Date end {@type timestamp}
string	$comment	{@from body} Comment

@url PUT {id}/lines/{lineid}/activate

Returns: Object|bool

Definition at line 387 of file api_contracts.class.php.

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

◆ close()

Contracts::close	(		$id,
			$notrigger = 0 )

Close all services of a contract.

Parameters

int	$id	Contract ID
int	$notrigger	1=Does not execute triggers, 0= execute triggers

@url POST {id}/close

Returns: array FIXME An error 403 is returned if the request has an empty body. Error message: "Forbidden: Content type `text/plain` is not supported." Workaround: send this in the body { "notrigger": 0 }

Definition at line 627 of file api_contracts.class.php.

References DolibarrApi\_checkAccessToResource().

◆ delete()

Contracts::delete ( $id )

Delete contract.

Parameters

int $id Contract ID

Returns: array

Definition at line 539 of file api_contracts.class.php.

References DolibarrApi\_checkAccessToResource().

◆ deleteLine()

Contracts::deleteLine	(		$id,
			$lineid )

Delete a line to given contract.

Parameters

int	$id	Id of contract to update
int	$lineid	Id of line to delete

@url DELETE {id}/lines/{lineid}

Returns: array|mixed

Exceptions

RestException	401
RestException	404

Definition at line 465 of file api_contracts.class.php.

References DolibarrApi\_checkAccessToResource().

◆ get()

Contracts::get ( $id )

Get properties of a contract object.

Return an array with contract informations

Parameters

int $id ID of contract

Returns: Object Object with cleaned properties

Exceptions

RestException

Definition at line 66 of file api_contracts.class.php.

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

◆ getLines()

Contracts::getLines ( $id )

Get lines of a contract.

Parameters

int $id Id of contract

@url GET {id}/lines

Returns: array

Definition at line 234 of file api_contracts.class.php.

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

◆ index()

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

List contracts.

Get a list of contracts

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$thirdparty_ids	Thirdparty ids to filter contracts of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
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 theses properties. Ignored if empty. Comma separated list of properties names

Returns: array Array of contract objects

Exceptions

RestException	404 Not found
RestException	503 Error

Definition at line 104 of file api_contracts.class.php.

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

◆ post()

Contracts::post ( $request_data = null )

Create contract object.

Parameters

array $request_data Request data

Returns: int ID of contrat

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

References _validate().

◆ postLine()

Contracts::postLine	(		$id,
			$request_data = null )

Add a line to given contract.

Parameters

int	$id	Id of contrat to update
array	$request_data	Contractline data

@url POST {id}/lines

Returns: int|bool

Definition at line 266 of file api_contracts.class.php.

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

◆ put()

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

Update contract general fields (won't touch lines of contract)

Parameters

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

Returns: array|mixed

Definition at line 498 of file api_contracts.class.php.

References DolibarrApi\_checkAccessToResource().

◆ putLine()

Contracts::putLine	(	$id,
		$lineid,
		$request_data = null )

Update a line to given contract.

Parameters

int	$id	Id of contrat to update
int	$lineid	Id of line to update
array	$request_data	Contractline data

@url PUT {id}/lines/{lineid}

Returns: Object|bool

Definition at line 324 of file api_contracts.class.php.

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

◆ unactivateLine()

Contracts::unactivateLine	(	$id,
		$lineid,
		$datestart,
		$comment = null )

Unactivate a service line of a given contract.

Parameters

int	$id	Id of contract to activate
int	$lineid	Id of line to activate
string	$datestart	{@from body} Date start {@type timestamp}
string	$comment	{@from body} Comment

@url PUT {id}/lines/{lineid}/unactivate

Returns: Object|bool

Definition at line 425 of file api_contracts.class.php.

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

◆ validate()

Contracts::validate	(		$id,
			$notrigger = 0 )

Validate a contract.

Parameters

int	$id	Contract ID
int	$notrigger	1=Does not execute triggers, 0= execute triggers

@url POST {id}/validate

Returns: array FIXME An error 403 is returned if the request has an empty body. Error message: "Forbidden: Content type `text/plain` is not supported." Workaround: send this in the body { "notrigger": 0 }

Definition at line 581 of file api_contracts.class.php.

References DolibarrApi\_checkAccessToResource().

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

dolibarr_19.0/htdocs/contrat/class/api_contracts.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cleanObjectDatas()

◆ _validate()

◆ activateLine()

◆ close()

◆ delete()

◆ deleteLine()

◆ get()

◆ getLines()

◆ index()

◆ post()

◆ postLine()

◆ put()

◆ putLine()

◆ unactivateLine()

◆ validate()