dolibarr 20.0.0
Projects Class Reference
Inheritance diagram for Projects:
Collaboration diagram for Projects:

Public Member Functions

 __construct ()
 Constructor.
 
 get ($id)
 Get properties of a project object.
 
 getByRef ($ref)
 Get properties of a project object.
 
 getByRefExt ($ref_ext)
 Get properties of a project object.
 
 getByMsgId ($email_msgid)
 Get properties of a project object.
 
 index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $thirdparty_ids='', $category=0, $sqlfilters='', $properties='')
 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.
 
 _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_projects.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Projects::_cleanObjectDatas ( $object)
protected

Clean sensible object datas.

Parameters
Object$objectObject to clean
Returns
Object Object with cleaned properties

Reimplemented from DolibarrApi.

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

References $object.

Referenced by get(), getByMsgId(), getByRef(), getByRefExt(), getLines(), getRoles(), and index().

◆ _validate()

Projects::_validate ( $data)
private

Validate fields before create or update object.

Parameters
array$dataArray with data to verify
Returns
array
Exceptions
RestException

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

References $object.

Referenced by post().

◆ delete()

Projects::delete ( $id)

Delete project.

Parameters
int$idProject ID
Returns
array

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

References DolibarrApi\_checkAccessToResource().

◆ get()

Projects::get ( $id)

Get properties of a project object.

Return an array with project information

Parameters
int$idID of project
Returns
Object Object with cleaned properties
Exceptions
RestException

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

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

◆ getByMsgId()

Projects::getByMsgId ( $email_msgid)

Get properties of a project object.

Return an array with project information

Parameters
string$email_msgidEmail msgid of project
Returns
Object Object with cleaned properties

@url GET email_msgid/{email_msgid}

Exceptions
RestException

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

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

◆ getByRef()

Projects::getByRef ( $ref)

Get properties of a project object.

Return an array with project information

Parameters
string$refRef of project
Returns
Object Object with cleaned properties

@url GET ref/{ref}

Exceptions
RestException

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

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

◆ getByRefExt()

Projects::getByRefExt ( $ref_ext)

Get properties of a project object.

Return an array with project information

Parameters
string$ref_extRef_Ext of project
Returns
Object Object with cleaned properties

@url GET ref_ext/{ref_ext}

Exceptions
RestException

Definition at line 134 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$idId of project
int$includetimespent0=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 326 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$idId of project
int$useridId of user (0 = connected user)
Returns
array

@url GET {id}/roles

Definition at line 364 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 = '',
$properties = '' )

List projects.

Get a list of projects

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$thirdparty_idsThirdparty ids to filter projects of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
int$categoryUse this param to filter list by category
string$sqlfiltersOther criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
string$propertiesRestrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
Returns
array Array of project objects

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

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

◆ post()

Projects::post ( $request_data = null)

Create project object.

Parameters
array$request_dataRequest data
Returns
int ID of project

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

References DolibarrApi\_checkValForAPI(), _validate(), and sanitizeVal().

◆ put()

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

Add a task to given project.

Parameters
int$idId of project to update
array$request_dataProjectline data

@url POST {id}/tasks

Returns
int Update a task to given project
Parameters
int$idId of project to update
int$taskidId of task to update
array$request_dataProjectline data

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

Returns
object Update project general fields (won't touch lines of project)
Parameters
int$idId of project to update
array$request_dataDatas
Returns
Object Updated object

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

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

◆ validate()

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

Validate a project.

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

Parameters
int$idProject ID
int$notrigger1=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 627 of file api_projects.class.php.

References DolibarrApi\_checkAccessToResource().


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