Inheritance diagram for Tasks:

Collaboration diagram for Tasks:

Public Member Functions
	__construct ()
	Constructor.

	get ($id, $includetimespent=0)
	Get properties of a task object. More...

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

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

	getRoles ($id, $userid=0)
	Get roles a user is assigned to a task with. More...

	put ($id, $request_data=null)
	Update task general fields (won't touch time spent of task) More...

	delete ($id)
	Delete task. More...

	addTimeSpent ($id, $date, $duration, $user_id=0, $note='')
	Add time spent to a task of a project. More...

	putTimeSpent ($id, $timespent_id, $date, $duration, $user_id=0, $note='')
	Update time spent for a task of a project. More...

	deleteTimeSpent ($id, $timespent_id)
	Delete time spent for a task of a project. More...

Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor. More...

Protected Member Functions
	timespentRecordChecks ($id, $timespent_id)
	Validate task & timespent IDs for timespent API methods. More...

	_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...

	_checkFilters ($sqlfilters, &$error='')
	Return if a $sqlfilters parameter is valid Function no more used. 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 31 of file api_tasks.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Tasks::_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 679 of file api_tasks.class.php.

◆ _validate()

Tasks::_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 729 of file api_tasks.class.php.

◆ addTimeSpent()

Tasks::addTimeSpent	(	$id,
		$date,
		$duration,
		$user_id = `0`,
		$note = `''`
	)

Add time spent to a task of a project.

You can test this API with the following input message { "date": "2016-12-31 23:15:00", "duration": 1800, "user_id": 1, "note": "My time test" }

Parameters

int	$id	Task ID
datetime	$date	Date (YYYY-MM-DD HH:MI:SS in GMT)
int	$duration	Duration in seconds (3600 = 1h)
int	$user_id	User (Use 0 for connected user)
string	$note	Note

@url POST {id}/addtimespent NOTE: Should be "POST {id}/timespent", since POST already implies "add"

Returns: array

Definition at line 524 of file api_tasks.class.php.

◆ delete()

Tasks::delete ( $id )

Delete task.

Parameters

int $id Task ID

Returns: array

Definition at line 481 of file api_tasks.class.php.

◆ deleteTimeSpent()

Tasks::deleteTimeSpent	(	$id,
		$timespent_id
	)

Delete time spent for a task of a project.

Parameters

int	$id	Task ID
int	$timespent_id	Time spent ID (llx_projet_task_time.rowid)

@url DELETE {id}/timespent/{timespent_id}

Returns: array

Definition at line 628 of file api_tasks.class.php.

◆ get()

Tasks::get	(	$id,
		$includetimespent = `0`
	)

Get properties of a task object.

Return an array with task informations

Parameters

int	$id	ID of task
int	$includetimespent	0=Return only task. 1=Include a summary of time spent, 2=Include details of time spent lines

Returns: array|mixed data without useless information

Exceptions

RestException

Definition at line 68 of file api_tasks.class.php.

◆ getRoles()

Tasks::getRoles	(	$id,
		$userid = `0`
	)

Get roles a user is assigned to a task with.

Parameters

int	$id	Id of task
int	$userid	Id of user (0 = connected user)

Returns: array Array of roles

@url GET {id}/roles

Definition at line 276 of file api_tasks.class.php.

◆ index()

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

List tasks.

Get a list of tasks

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

Returns: array Array of project objects

Definition at line 107 of file api_tasks.class.php.

◆ post()

Tasks::post ( $request_data = null )

Create task object.

Parameters

array $request_data Request data

Returns: int ID of project

Definition at line 199 of file api_tasks.class.php.

◆ put()

Tasks::put	(	$id,
		$request_data = `null`
	)

Update task general fields (won't touch time spent of task)

Parameters

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

Returns: int

Definition at line 446 of file api_tasks.class.php.

◆ putTimeSpent()

Tasks::putTimeSpent	(	$id,
		$timespent_id,
		$date,
		$duration,
		$user_id = `0`,
		$note = `''`
	)

Update time spent for a task of a project.

You can test this API with the following input message { "date": "2016-12-31 23:15:00", "duration": 1800, "user_id": 1, "note": "My time test" }

Parameters

int	$id	Task ID
int	$timespent_id	Time spent ID (llx_projet_task_time.rowid)
datetime	$date	Date (YYYY-MM-DD HH:MI:SS in GMT)
int	$duration	Duration in seconds (3600 = 1h)
int	$user_id	User (Use 0 for connected user)
string	$note	Note

@url PUT {id}/timespent/{timespent_id}

Returns: array

Definition at line 583 of file api_tasks.class.php.

◆ timespentRecordChecks()

Tasks::timespentRecordChecks	(	$id,
		$timespent_id
	)

protected

Validate task & timespent IDs for timespent API methods.

Loads the selected task & timespent records.

Parameters

int	$id	Task ID
int	$timespent_id	Time spent ID (llx_projet_task_time.rowid)

Returns: void

Definition at line 660 of file api_tasks.class.php.

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

dolibarr_dev/htdocs/projet/class/api_tasks.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cleanObjectDatas()

◆ _validate()

◆ addTimeSpent()

◆ delete()

◆ deleteTimeSpent()

◆ get()

◆ getRoles()

◆ index()

◆ post()

◆ put()

◆ putTimeSpent()

◆ timespentRecordChecks()