Inheritance diagram for Projects:

Collaboration diagram for Projects:

Public Member Functions
	__construct ()
	Constructor.

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

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

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

	getLines ($id, $includetimespent=0)
	Get tasks of a project. More...

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

	put ($id, $request_data=null)
	Add a task to given project. More...

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

	validate ($id, $notrigger=0)
	Validate a project. 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
	_cleanObjectDatas ($object)
	Executed method when API is called without parameter. More...

	_checkFilters ($sqlfilters)
	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 user access to a resource. More...

static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria. More...

Detailed Description

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

Member Function Documentation

Projects::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties

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

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

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 599 of file api_projects.class.php.

Referenced by post().

Projects::delete ( $id )

Delete project.

Parameters

int $id Project ID

Returns: array

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

References DolibarrApi\_checkAccessToResource().

Projects::get ( $id )

Get properties of a project object.

Return an array with project informations

Parameters

int $id ID of project

Returns: array|mixed data without useless information

Exceptions

RestException

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

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

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 (2 is no implemented yet)

Returns: int

GET {id}/tasks

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

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

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)

GET {id}/roles

Returns: int

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

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

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') { /^[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 102 of file api_projects.class.php.

References DolibarrApi\_checkFilters(), _cleanObjectDatas(), db, and dol_syslog().

Projects::post ( $request_data = null )

Create project object.

Parameters

array $request_data Request data

Returns: int ID of project

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

References _validate().

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

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

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 431 of file api_projects.class.php.

References DolibarrApi\_checkAccessToResource().

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

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 509 of file api_projects.class.php.

References DolibarrApi\_checkAccessToResource().

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

htdocs/projet/class/api_projects.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation