Projects Class Reference

Inheritance diagram for Projects:

Collaboration diagram for Projects:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get properties of a project object.
	index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $thirdparty_ids='', $category=0, $sqlfilters='')
	List projects.
	post ($request_data=null)
	Create project object.
	getLines ($id, $includetimespent=0)
	Get tasks of a project.
	getRoles ($id, $userid=0)
	Get roles a user is assigned to a project with.
	put ($id, $request_data=null)
	Add a task to given project.
	delete ($id)
	Delete project.
	validate ($id, $notrigger=0)
	Validate a project.
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.
	_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_projects.class.php.

Member Function Documentation

_cleanObjectDatas()

Projects::_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 569 of file api_projects.class.php.

Referenced by get(), getLines(), getRoles(), and index().

_validate()

Projects::_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 621 of file api_projects.class.php.

Referenced by post().

delete()

Projects::delete

(

$id

)

Delete project.

Parameters

int

$id

Project ID

Returns

array

Definition at line 487 of file api_projects.class.php.

References DolibarrApi\_checkAccessToResource().

get()

Projects::get

(

$id

)

Get properties of a project object.

Return an array with project informations

Parameters

int

$id

ID of project

Returns

Object Object with cleaned properties

Exceptions

RestException

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

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

getLines()

Projects::getLines	(		$id,
			$includetimespent = 0 )

Get tasks of a project.

See also API /tasks

Parameters

int	$id	Id of project
int	$includetimespent	0=Return only list of tasks. 1=Include a summary of time spent, 2=Include details of time spent lines

Returns

array

@url GET {id}/tasks

Definition at line 235 of file api_projects.class.php.

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

getRoles()

Projects::getRoles	(		$id,
			$userid = 0 )

Get roles a user is assigned to a project with.

Parameters

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

Returns

array

@url GET {id}/roles

Definition at line 273 of file api_projects.class.php.

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

index()

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

List projects.

Get a list of projects

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 projects of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
int	$category	Use this param to filter list by category
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 101 of file api_projects.class.php.

References _cleanObjectDatas(), dol_syslog(), and forgeSQLFromUniversalSearchCriteria().

post()

Projects::post

(

$request_data = null

)

Create project object.

Parameters

array

$request_data

Request data

Returns

int ID of project

Definition at line 200 of file api_projects.class.php.

References _validate().

put()

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

Add a task to given project.

Parameters

int	$id	Id of project to update
array	$request_data	Projectline data

@url POST {id}/tasks

Returns

int Update a task to given project

Parameters

int	$id	Id of project to update
int	$taskid	Id of task to update
array	$request_data	Projectline data

@url PUT {id}/tasks/{taskid}

Returns

object Update project general fields (won't touch lines of project)

Parameters

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

Returns

int

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

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

validate()

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

Validate a project.

You can test this API with the following input message { "notrigger": 0 }

Parameters

int	$id	Project 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 531 of file api_projects.class.php.

References DolibarrApi\_checkAccessToResource().

---

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

• dolibarr_18.0/htdocs/projet/class/api_projects.class.php