vignesh/dolibarr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated PHPDoc with since tag (#37300)

Browse source 
Co-authored-by: Laurent Destailleur <eldy@destailleur.fr>
This commit is contained in:
William Mead 2026-02-23 01:03:57 +01:00 committed by GitHub
parent 7de8680a37
commit ff7e2c4292
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 29 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
htdocs/projet/class/api_tasks.class.php
View file

@ -29,6 +29,7 @@ require_once DOL_DOCUMENT_ROOT.'/core/class/timespent.class.php';
/**
* API class for projects
*
* @since 5.0.0 Initial implementation
* @access protected
* @class DolibarrApiAccess {@requires user,external}
*/
@ -63,6 +64,8 @@ class Tasks extends DolibarrApi
*
* Return an array with task information
*
* @since 5.0.0 Initial implementation
*
* @param int $id ID of task
* @param int $includetimespent 0=Return only task. 1=Include a summary of time spent, 2=Include details of time spent lines
* @return array|mixed data without useless information
@ -101,6 +104,8 @@ class Tasks extends DolibarrApi
*
* Get a list of tasks
*
* @since 5.0.0 Initial implementation
*
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @param int $limit Limit for list
@ -190,6 +195,8 @@ class Tasks extends DolibarrApi
/**
* Create task object
*
* @since 5.0.0 Initial implementation
*
* @param array $request_data Request data
* @phan-param ?array<string,string> $request_data
* @phpstan-param ?array<string,string> $request_data
@ -273,6 +280,8 @@ class Tasks extends DolibarrApi
/**
* Get time spent of a task
*
* @since 23.0.0 Initial implementation
*
* @param int $id Id of task
* @return array<int,mixed> Array of timespent lines
*
@ -306,6 +315,8 @@ class Tasks extends DolibarrApi
/**
* Get roles a user is assigned to a task with
*
* @since 5.0.0 Initial implementation
*
* @param int $id Id of task
* @param int $userid Id of user (0 = connected user)
* @return array Array of roles
@ -483,6 +494,8 @@ class Tasks extends DolibarrApi
/**
* Update task general fields (won't touch time spent of task)
*
* @since 5.0.0 Initial implementation
*
* @param int $id Id of task to update
* @param array $request_data Data
* @phan-param ?array<string,string> $request_data
@ -532,6 +545,8 @@ class Tasks extends DolibarrApi
/**
* Delete task
*
* @since 5.0.0 Initial implementation
*
* @param int $id Task ID
*
* @return array
@ -568,6 +583,8 @@ class Tasks extends DolibarrApi
/**
* Get time spent of a task
*
* @since 23.0.0 Initial implementation
*
* @param int $id Id of task
* @param int $timespent_id Id of timespent
*
@ -609,6 +626,8 @@ class Tasks extends DolibarrApi
* 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" }
*
* @since 5.0.0 Initial implementation
*
* @param int $id Task ID
* @param datetime|string $date Date (YYYY-MM-DD HH:MI:SS in GMT)
* @param int $duration Duration in seconds (3600 = 1h)
@ -677,6 +696,8 @@ class Tasks extends DolibarrApi
* 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" }
*
* @since 17.0.0 Initial implementation
*
* @param int $id Task ID
* @param int $timespent_id Time spent ID (llx_element_time.rowid)
* @param datetime $date Date (YYYY-MM-DD HH:MI:SS in GMT)
@ -731,6 +752,8 @@ class Tasks extends DolibarrApi
/**
* Delete time spent for a task of a project.
*
* @since 17.0.0 Initial implementation
*
* @param int $id Task ID
* @param int $timespent_id Time spent ID (llx_element_time.rowid)
*
@ -992,6 +1015,8 @@ class Tasks extends DolibarrApi
*
* Return an array with contact information
*
* @since 23.0.0 Initial implementation
*
* @param int $id ID of task
* @param string $type Type of the contact
* @return array<int,mixed> Array with cleaned properties
@ -1026,6 +1051,8 @@ class Tasks extends DolibarrApi
/**
* Adds a contact to a task
*
* @since 23.0.0 Initial implementation
*
* @param int $id Task ID
* @param int $fk_socpeople Id of thirdparty contact (if source = 'external') or id of user (if source = 'internal') to link
* @param string $type_contact Type of contact (code). Must a code found into table llx_c_type_contact. For example: BILLING
@ -1073,6 +1100,8 @@ class Tasks extends DolibarrApi
/**
* Delete a contact type of given task
*
* @since 23.0.0 Initial implementation
*
* @param int $id Id of task to update
* @param int $contactid Row key of the contact in the array contact_ids.
* @param string $type Type of the contact (BILLING, SHIPPING, CUSTOMER).