2016-11-09 22:54:51 +01:00
< ? php
/* Copyright ( C ) 2015 Jean - François Ferry < jfefe @ aternatik . fr >
* Copyright ( C ) 2016 Laurent Destailleur < eldy @ users . sourceforge . net >
2025-02-10 21:20:09 +01:00
* Copyright ( C ) 2024 - 2025 MDW < mdeweerd @ users . noreply . github . com >
2016-11-09 22:54:51 +01:00
*
* This program is free software ; you can redistribute it and / or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation ; either version 3 of the License , or
* ( at your option ) any later version .
*
* This program is distributed in the hope that it will be useful ,
* but WITHOUT ANY WARRANTY ; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
* GNU General Public License for more details .
*
* You should have received a copy of the GNU General Public License
2019-09-23 21:55:30 +02:00
* along with this program . If not , see < https :// www . gnu . org / licenses />.
2016-11-09 22:54:51 +01:00
*/
2024-09-23 00:37:30 +02:00
use Luracast\Restler\RestException ;
2016-11-09 22:54:51 +01:00
2024-09-23 00:37:30 +02:00
require_once DOL_DOCUMENT_ROOT . '/projet/class/project.class.php' ;
require_once DOL_DOCUMENT_ROOT . '/projet/class/task.class.php' ;
2017-06-01 18:18:57 +02:00
2016-11-09 22:54:51 +01:00
/**
* API class for projects
*
* @ access protected
* @ class DolibarrApiAccess { @ requires user , external }
*/
class Projects extends DolibarrApi
{
2020-10-31 18:51:30 +01:00
/**
2025-02-10 21:20:09 +01:00
* @ var string [] Mandatory fields , checked when create and update object
2020-10-31 18:51:30 +01:00
*/
2021-02-26 18:49:22 +01:00
public static $FIELDS = array (
2020-10-31 18:51:30 +01:00
'ref' ,
'title'
);
2016-11-09 22:54:51 +01:00
2020-10-31 18:51:30 +01:00
/**
2025-02-10 21:20:09 +01:00
* @ var Project { @ type Project }
2020-10-31 18:51:30 +01:00
*/
public $project ;
2016-11-09 22:54:51 +01:00
2023-08-23 19:29:14 +02:00
/**
2025-02-10 21:20:09 +01:00
* @ var Task { @ type Task }
2023-08-23 19:29:14 +02:00
*/
public $task ;
2020-10-31 18:51:30 +01:00
/**
* Constructor
*/
public function __construct ()
{
global $db , $conf ;
$this -> db = $db ;
$this -> project = new Project ( $this -> db );
$this -> task = new Task ( $this -> db );
}
2016-11-09 22:54:51 +01:00
2020-10-31 18:51:30 +01:00
/**
* Get properties of a project object
*
2024-01-12 17:55:52 +01:00
* Return an array with project information
2020-10-31 18:51:30 +01:00
*
2023-06-19 00:52:43 +02:00
* @ param int $id ID of project
2023-09-26 18:43:25 +02:00
* @ return Object Object with cleaned properties
2020-10-31 18:51:30 +01:00
*
2023-09-26 18:43:25 +02:00
* @ throws RestException
2020-10-31 18:51:30 +01:00
*/
public function get ( $id )
{
2024-02-09 15:58:49 +01:00
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'projet' , 'lire' )) {
2024-02-01 19:16:58 +01:00
throw new RestException ( 403 );
2020-10-31 18:51:30 +01:00
}
2016-11-09 22:54:51 +01:00
2020-10-31 18:51:30 +01:00
$result = $this -> project -> fetch ( $id );
if ( ! $result ) {
2024-04-01 21:57:47 +02:00
throw new RestException ( 404 , 'Project with supplied id not found' );
2020-10-31 18:51:30 +01:00
}
if ( ! DolibarrApi :: _checkAccessToResource ( 'project' , $this -> project -> id )) {
2024-04-02 14:47:49 +02:00
throw new RestException ( 403 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
2020-10-31 18:51:30 +01:00
}
$this -> project -> fetchObjectLinked ();
return $this -> _cleanObjectDatas ( $this -> project );
}
2016-11-09 22:54:51 +01:00
2024-04-01 21:57:47 +02:00
/**
* Get properties of a project object
*
* Return an array with project information
*
* @ param string $ref Ref of project
* @ return Object Object with cleaned properties
*
* @ url GET ref / { ref }
*
* @ throws RestException
*/
public function getByRef ( $ref )
{
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'projet' , 'lire' )) {
throw new RestException ( 403 );
}
2024-09-23 00:37:30 +02:00
$result = $this -> project -> fetch ( 0 , $ref );
2024-04-01 21:57:47 +02:00
if ( ! $result ) {
throw new RestException ( 404 , 'Project with supplied ref not found' );
2020-10-31 18:51:30 +01:00
}
if ( ! DolibarrApi :: _checkAccessToResource ( 'project' , $this -> project -> id )) {
2024-04-02 14:47:49 +02:00
throw new RestException ( 403 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
2020-10-31 18:51:30 +01:00
}
$this -> project -> fetchObjectLinked ();
return $this -> _cleanObjectDatas ( $this -> project );
}
2016-11-09 22:54:51 +01:00
2024-04-04 22:46:54 +02:00
/**
* Get properties of a project object
*
* Return an array with project information
*
* @ param string $ref_ext Ref_Ext of project
* @ return Object Object with cleaned properties
*
* @ url GET ref_ext / { ref_ext }
*
* @ throws RestException
*/
public function getByRefExt ( $ref_ext )
{
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'projet' , 'lire' )) {
throw new RestException ( 403 );
}
2024-09-23 00:37:30 +02:00
$result = $this -> project -> fetch ( 0 , '' , $ref_ext );
2024-04-04 22:46:54 +02:00
if ( ! $result ) {
throw new RestException ( 404 , 'Project with supplied ref_ext not found' );
}
if ( ! DolibarrApi :: _checkAccessToResource ( 'project' , $this -> project -> id )) {
throw new RestException ( 403 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
}
$this -> project -> fetchObjectLinked ();
return $this -> _cleanObjectDatas ( $this -> project );
}
2024-04-01 21:57:47 +02:00
/**
* Get properties of a project object
*
* Return an array with project information
*
* @ param string $email_msgid Email msgid of project
* @ return Object Object with cleaned properties
*
* @ url GET email_msgid / { email_msgid }
*
* @ throws RestException
*/
public function getByMsgId ( $email_msgid )
{
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'projet' , 'lire' )) {
throw new RestException ( 403 );
}
2024-09-23 00:37:30 +02:00
$result = $this -> project -> fetch ( 0 , '' , '' , $email_msgid );
2024-04-01 21:57:47 +02:00
if ( ! $result ) {
throw new RestException ( 404 , 'Project with supplied email_msgid not found' );
}
2017-06-01 18:18:57 +02:00
2024-04-01 21:57:47 +02:00
if ( ! DolibarrApi :: _checkAccessToResource ( 'project' , $this -> project -> id )) {
2024-04-02 14:47:49 +02:00
throw new RestException ( 403 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
2024-04-01 21:57:47 +02:00
}
$this -> project -> fetchObjectLinked ();
return $this -> _cleanObjectDatas ( $this -> project );
}
2017-06-01 18:18:57 +02:00
2020-10-31 18:51:30 +01:00
/**
* List projects
*
* Get a list of projects
*
2023-09-26 18:43:25 +02:00
* @ param string $sortfield Sort field
* @ param string $sortorder Sort order
* @ param int $limit Limit for list
* @ param int $page Page number
* @ param string $thirdparty_ids Thirdparty ids to filter projects of ( example '1' or '1,2,3' ) { @ pattern /^ [ 0 - 9 ,] * $ / i }
2020-04-15 19:29:00 +02:00
* @ param int $category Use this param to filter list by category
* @ param string $sqlfilters Other criteria to filter answers separated by a comma . Syntax example " (t.ref:like:'SO-%') and (t.date_creation:<:'20160101') "
2024-01-12 17:55:52 +01:00
* @ param string $properties Restrict the data returned to these properties . Ignored if empty . Comma separated list of properties names
2024-09-10 02:09:35 +02:00
* @ param bool $pagination_data If this parameter is set to true the response will include pagination data . Default value is false . Page starts from 0 *
2020-10-31 18:51:30 +01:00
* @ return array Array of project objects
2024-10-06 13:03:43 +02:00
* @ phan - return array { data : Project [], pagination : array { total : int , page : int , page_count : int , limit : int }}
* @ phpstan - return array { data : Project [], pagination : array { total : int , page : int , page_count : int , limit : int }}
2020-10-31 18:51:30 +01:00
*/
2024-09-10 02:09:35 +02:00
public function index ( $sortfield = " t.rowid " , $sortorder = 'ASC' , $limit = 100 , $page = 0 , $thirdparty_ids = '' , $category = 0 , $sqlfilters = '' , $properties = '' , $pagination_data = false )
2020-10-31 18:51:30 +01:00
{
2024-02-09 15:58:49 +01:00
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'projet' , 'lire' )) {
2024-02-01 19:16:58 +01:00
throw new RestException ( 403 );
2021-04-08 19:05:28 +02:00
}
2020-10-31 18:51:30 +01:00
$obj_ret = array ();
2017-06-01 18:18:57 +02:00
2020-10-31 18:51:30 +01:00
// case of external user, $thirdparty_ids param is ignored and replaced by user's socid
$socids = DolibarrApiAccess :: $user -> socid ? DolibarrApiAccess :: $user -> socid : $thirdparty_ids ;
2016-11-09 22:54:51 +01:00
2020-10-31 18:51:30 +01:00
// If the internal user must only see his customers, force searching by him
$search_sale = 0 ;
2024-02-09 15:58:49 +01:00
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'societe' , 'client' , 'voir' ) && ! $socids ) {
2021-02-26 18:49:22 +01:00
$search_sale = DolibarrApiAccess :: $user -> id ;
}
2016-11-09 22:54:51 +01:00
2020-10-31 18:51:30 +01:00
$sql = " SELECT t.rowid " ;
$sql .= " FROM " . MAIN_DB_PREFIX . " projet as t " ;
2023-01-29 23:05:39 +01:00
$sql .= " LEFT JOIN " . MAIN_DB_PREFIX . " projet_extrafields AS ef ON ef.fk_object = t.rowid " ; // So we will be able to filter on extrafields
2020-10-31 18:51:30 +01:00
if ( $category > 0 ) {
2020-04-15 19:30:39 +02:00
$sql .= " , " . MAIN_DB_PREFIX . " categorie_project as c " ;
2020-10-31 18:51:30 +01:00
}
$sql .= ' WHERE t.entity IN (' . getEntity ( 'project' ) . ')' ;
2021-02-26 18:49:22 +01:00
if ( $socids ) {
2021-03-22 11:30:18 +01:00
$sql .= " AND t.fk_soc IN ( " . $this -> db -> sanitize ( $socids ) . " ) " ;
2021-02-26 18:49:22 +01:00
}
2024-01-09 10:44:50 +01:00
// Search on sale representative
if ( $search_sale && $search_sale != '-1' ) {
if ( $search_sale == - 2 ) {
$sql .= " AND NOT EXISTS (SELECT sc.fk_soc FROM " . MAIN_DB_PREFIX . " societe_commerciaux as sc WHERE sc.fk_soc = t.fk_soc) " ;
} elseif ( $search_sale > 0 ) {
$sql .= " AND EXISTS (SELECT sc.fk_soc FROM " . MAIN_DB_PREFIX . " societe_commerciaux as sc WHERE sc.fk_soc = t.fk_soc AND sc.fk_user = " . (( int ) $search_sale ) . " ) " ;
}
2020-10-31 18:51:30 +01:00
}
// Select projects of given category
if ( $category > 0 ) {
2021-06-09 15:36:47 +02:00
$sql .= " AND c.fk_categorie = " . (( int ) $category ) . " AND c.fk_project = t.rowid " ;
2020-10-31 18:51:30 +01:00
}
// Add sql filters
2021-02-26 18:49:22 +01:00
if ( $sqlfilters ) {
2021-12-20 20:49:32 +01:00
$errormessage = '' ;
2023-02-25 19:48:33 +01:00
$sql .= forgeSQLFromUniversalSearchCriteria ( $sqlfilters , $errormessage );
if ( $errormessage ) {
throw new RestException ( 400 , 'Error when validating parameter sqlfilters -> ' . $errormessage );
2020-10-31 18:51:30 +01:00
}
}
2024-09-10 02:09:35 +02:00
//this query will return total orders with the filters given
$sqlTotals = str_replace ( 'SELECT t.rowid' , 'SELECT count(t.rowid) as total' , $sql );
2020-10-31 18:51:30 +01:00
$sql .= $this -> db -> order ( $sortfield , $sortorder );
if ( $limit ) {
if ( $page < 0 ) {
$page = 0 ;
}
$offset = $limit * $page ;
$sql .= $this -> db -> plimit ( $limit + 1 , $offset );
}
dol_syslog ( " API Rest request " );
$result = $this -> db -> query ( $sql );
2021-02-26 18:49:22 +01:00
if ( $result ) {
2020-10-31 18:51:30 +01:00
$num = $this -> db -> num_rows ( $result );
$min = min ( $num , ( $limit <= 0 ? $num : $limit ));
2020-10-31 09:40:15 +01:00
$i = 0 ;
2020-10-31 18:51:30 +01:00
while ( $i < $min ) {
$obj = $this -> db -> fetch_object ( $result );
$project_static = new Project ( $this -> db );
if ( $project_static -> fetch ( $obj -> rowid )) {
2023-09-26 18:04:48 +02:00
$obj_ret [] = $this -> _filterObjectProperties ( $this -> _cleanObjectDatas ( $project_static ), $properties );
2020-10-31 18:51:30 +01:00
}
$i ++ ;
}
} else {
throw new RestException ( 503 , 'Error when retrieve project list : ' . $this -> db -> lasterror ());
}
2023-12-31 14:05:21 +01:00
2024-09-10 02:09:35 +02:00
//if $pagination_data is true the response will contain element data with all values and element pagination with pagination data(total,page,limit)
if ( $pagination_data ) {
$totalsResult = $this -> db -> query ( $sqlTotals );
$total = $this -> db -> fetch_object ( $totalsResult ) -> total ;
$tmp = $obj_ret ;
$obj_ret = [];
$obj_ret [ 'data' ] = $tmp ;
$obj_ret [ 'pagination' ] = [
'total' => ( int ) $total ,
'page' => $page , //count starts from 0
'page_count' => ceil (( int ) $total / $limit ),
'limit' => $limit
];
}
2020-10-31 18:51:30 +01:00
return $obj_ret ;
}
2016-11-09 22:54:51 +01:00
2020-10-31 18:51:30 +01:00
/**
* Create project object
*
* @ param array $request_data Request data
2024-10-06 13:03:43 +02:00
* @ phan - param array < string , mixed > $request_data
* @ phpstan - param array < string , mixed > $request_data
2020-10-31 18:51:30 +01:00
* @ return int ID of project
*/
public function post ( $request_data = null )
{
2024-08-15 16:48:28 +02:00
global $conf ;
2024-02-09 15:58:49 +01:00
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'projet' , 'creer' )) {
2024-04-07 14:59:25 +02:00
throw new RestException ( 403 , " Insuffisant rights " );
2020-10-31 18:51:30 +01:00
}
// Check mandatory fields
$result = $this -> _validate ( $request_data );
foreach ( $request_data as $field => $value ) {
2023-12-15 12:15:33 +01:00
if ( $field === 'caller' ) {
2024-01-12 17:55:52 +01:00
// Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
2024-04-02 12:28:55 +02:00
$this -> project -> context [ 'caller' ] = sanitizeVal ( $request_data [ 'caller' ], 'aZ09' );
2023-12-15 12:15:33 +01:00
continue ;
}
2024-04-02 12:28:55 +02:00
$this -> project -> $field = $this -> _checkValForAPI ( $field , $value , $this -> project );
2020-10-31 18:51:30 +01:00
}
/* if ( isset ( $request_data [ " lines " ])) {
2021-02-26 18:49:22 +01:00
$lines = array ();
foreach ( $request_data [ " lines " ] as $line ) {
array_push ( $lines , ( object ) $line );
}
$this -> project -> lines = $lines ;
} */
2024-08-15 16:48:28 +02:00
// Auto-generate the "ref" field if it is set to "auto"
if ( $this -> project -> ref == - 1 || $this -> project -> ref === 'auto' ) {
$reldir = '' ;
$defaultref = '' ;
$file = '' ;
$classname = '' ;
$filefound = 0 ;
2024-08-15 16:53:49 +02:00
$modele = getDolGlobalString ( 'PROJECT_ADDON' , 'mod_project_simple' );
2024-08-15 16:48:28 +02:00
$dirmodels = array_merge ( array ( '/' ), ( array ) $conf -> modules_parts [ 'models' ]);
foreach ( $dirmodels as $reldir ) {
$file = dol_buildpath ( $reldir . " core/modules/project/ " . $modele . '.php' , 0 );
if ( file_exists ( $file )) {
$filefound = 1 ;
$classname = $modele ;
break ;
}
}
if ( $filefound && ! empty ( $classname )) {
$result = dol_include_once ( $reldir . " core/modules/project/ " . $modele . '.php' );
if ( $result !== false && class_exists ( $classname )) {
$modProject = new $classname ();
2024-10-06 13:03:43 +02:00
'@phan-var-force ModeleNumRefProjects $modProject' ;
2024-08-15 16:48:28 +02:00
$defaultref = $modProject -> getNextValue ( null , $this -> project );
} else {
dol_syslog ( " Failed to include module file or invalid classname: " . $reldir . " core/modules/project/ " . $modele . '.php' , LOG_ERR );
}
} else {
dol_syslog ( " Module file not found or classname is empty: " . $modele , LOG_ERR );
}
if ( is_numeric ( $defaultref ) && $defaultref <= 0 ) {
$defaultref = '' ;
}
if ( empty ( $defaultref )) {
$defaultref = 'PJ' . dol_print_date ( dol_now (), 'dayrfc' );
}
$this -> project -> ref = $defaultref ;
}
2020-10-31 18:51:30 +01:00
if ( $this -> project -> create ( DolibarrApiAccess :: $user ) < 0 ) {
throw new RestException ( 500 , " Error creating project " , array_merge ( array ( $this -> project -> error ), $this -> project -> errors ));
}
2016-11-09 22:54:51 +01:00
2020-10-31 18:51:30 +01:00
return $this -> project -> id ;
}
2017-06-01 18:18:57 +02:00
2020-10-31 18:51:30 +01:00
/**
* Get tasks of a project .
* See also API / tasks
*
* @ param int $id Id of project
2022-01-28 22:59:32 +01:00
* @ param int $includetimespent 0 = Return only list of tasks . 1 = Include a summary of time spent , 2 = Include details of time spent lines
2023-02-08 19:09:05 +01:00
* @ return array
2024-10-06 13:03:43 +02:00
* @ phan - return Object []
* @ phpstan - return Object []
2020-10-31 18:51:30 +01:00
*
* @ url GET { id } / tasks
*/
public function getLines ( $id , $includetimespent = 0 )
{
2024-02-09 15:58:49 +01:00
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'projet' , 'lire' )) {
2024-02-01 19:16:58 +01:00
throw new RestException ( 403 );
2020-10-31 18:51:30 +01:00
}
$result = $this -> project -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Project not found' );
}
if ( ! DolibarrApi :: _checkAccessToResource ( 'project' , $this -> project -> id )) {
2024-04-02 14:47:49 +02:00
throw new RestException ( 403 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
2020-10-31 18:51:30 +01:00
}
$this -> project -> getLinesArray ( DolibarrApiAccess :: $user );
$result = array ();
2021-02-26 18:49:22 +01:00
foreach ( $this -> project -> lines as $line ) { // $line is a task
if ( $includetimespent == 1 ) {
2020-10-31 18:51:30 +01:00
$timespent = $line -> getSummaryOfTimeSpent ( 0 );
}
2022-01-28 22:59:32 +01:00
if ( $includetimespent == 2 ) {
2022-01-28 23:03:08 +01:00
$timespent = $line -> fetchTimeSpentOnTask ();
2020-10-31 18:51:30 +01:00
}
array_push ( $result , $this -> _cleanObjectDatas ( $line ));
}
return $result ;
}
2017-06-01 18:18:57 +02:00
2020-10-31 18:51:30 +01:00
/**
* Get roles a user is assigned to a project with
*
* @ param int $id Id of project
* @ param int $userid Id of user ( 0 = connected user )
2023-01-04 18:34:54 +01:00
* @ return array
2024-10-06 13:03:43 +02:00
* @ phan - return Object []
* @ phpstan - return Object []
2020-10-31 18:51:30 +01:00
*
* @ url GET { id } / roles
*/
public function getRoles ( $id , $userid = 0 )
{
global $db ;
2024-02-09 15:58:49 +01:00
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'projet' , 'lire' )) {
2024-02-01 19:16:58 +01:00
throw new RestException ( 403 );
2020-10-31 18:51:30 +01:00
}
$result = $this -> project -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Project not found' );
}
if ( ! DolibarrApi :: _checkAccessToResource ( 'project' , $this -> project -> id )) {
2024-04-02 14:47:49 +02:00
throw new RestException ( 403 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
2020-10-31 18:51:30 +01:00
}
require_once DOL_DOCUMENT_ROOT . '/projet/class/task.class.php' ;
$taskstatic = new Task ( $this -> db );
$userp = DolibarrApiAccess :: $user ;
2021-02-26 18:49:22 +01:00
if ( $userid > 0 ) {
2020-10-31 18:51:30 +01:00
$userp = new User ( $this -> db );
$userp -> fetch ( $userid );
}
2025-02-10 21:20:09 +01:00
$this -> project -> roles = $taskstatic -> getUserRolesForProjectsOrTasks ( $userp , null , ( string ) $id , 0 );
2020-10-31 18:51:30 +01:00
$result = array ();
foreach ( $this -> project -> roles as $line ) {
array_push ( $result , $this -> _cleanObjectDatas ( $line ));
}
2023-01-04 18:34:54 +01:00
2020-10-31 18:51:30 +01:00
return $result ;
}
2017-06-01 18:18:57 +02:00
2020-10-31 18:51:30 +01:00
/**
* Add a task to given project
*
* @ param int $id Id of project to update
* @ param array $request_data Projectline data
2024-10-06 13:03:43 +02:00
* @ phan - param array < string , mixed > $request_data
* @ phpstan - param array < string , mixed > $request_data
2020-10-31 18:51:30 +01:00
*
* @ url POST { id } / tasks
*
* @ return int
*/
/*
2021-02-26 18:49:22 +01:00
public function postLine ( $id , $request_data = null )
{
2024-02-09 15:58:49 +01:00
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'projet' , 'creer' )) {
2024-02-01 19:16:58 +01:00
throw new RestException ( 403 );
2021-02-26 18:49:22 +01:00
}
$result = $this -> project -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Project not found' );
}
if ( ! DolibarrApi :: _checkAccessToResource ( 'project' , $this -> project -> id )) {
2024-04-02 14:47:49 +02:00
throw new RestException ( 403 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
2021-02-26 18:49:22 +01:00
}
2021-04-25 19:21:48 +02:00
2021-02-26 18:49:22 +01:00
$request_data = ( object ) $request_data ;
2021-04-25 19:21:48 +02:00
2022-03-30 12:16:17 +02:00
$request_data -> desc = sanitizeVal ( $request_data -> desc , 'restricthtml' );
2021-04-25 19:21:48 +02:00
2021-02-26 18:49:22 +01:00
$updateRes = $this -> project -> addline (
$request_data -> desc ,
$request_data -> subprice ,
$request_data -> qty ,
$request_data -> tva_tx ,
$request_data -> localtax1_tx ,
$request_data -> localtax2_tx ,
$request_data -> fk_product ,
$request_data -> remise_percent ,
$request_data -> info_bits ,
$request_data -> fk_remise_except ,
'HT' ,
0 ,
$request_data -> date_start ,
$request_data -> date_end ,
$request_data -> product_type ,
$request_data -> rang ,
$request_data -> special_code ,
$fk_parent_line ,
$request_data -> fk_fournprice ,
$request_data -> pa_ht ,
$request_data -> label ,
$request_data -> array_options ,
$request_data -> fk_unit ,
$this -> element ,
$request_data -> id
);
if ( $updateRes > 0 ) {
return $updateRes ;
}
return false ;
}
*/
2017-06-01 18:18:57 +02:00
2020-10-31 14:32:18 +01:00
/**
* Update a task to given project
*
* @ param int $id Id of project to update
* @ param int $taskid Id of task to update
* @ param array $request_data Projectline data
2024-10-06 13:03:43 +02:00
* @ phan - param array < string , mixed > $request_data
* @ phpstan - param array < string , mixed > $request_data
2020-10-31 14:32:18 +01:00
*
* @ url PUT { id } / tasks / { taskid }
*
* @ return object
*/
/*
2021-02-26 18:49:22 +01:00
public function putLine ( $id , $lineid , $request_data = null )
{
2024-02-09 15:58:49 +01:00
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'projet' , 'creer' )) {
2024-02-01 19:16:58 +01:00
throw new RestException ( 403 );
2021-02-26 18:49:22 +01:00
}
$result = $this -> project -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Project not found' );
}
if ( ! DolibarrApi :: _checkAccessToResource ( 'project' , $this -> project -> id )) {
2024-04-02 14:47:49 +02:00
throw new RestException ( 403 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
2021-02-26 18:49:22 +01:00
}
2021-04-25 19:21:48 +02:00
2021-02-26 18:49:22 +01:00
$request_data = ( object ) $request_data ;
2021-04-25 19:21:48 +02:00
2022-03-30 12:16:17 +02:00
$request_data -> desc = sanitizeVal ( $request_data -> desc , 'restricthtml' );
2021-04-25 19:21:48 +02:00
2021-02-26 18:49:22 +01:00
$updateRes = $this -> project -> updateline (
$lineid ,
$request_data -> desc ,
$request_data -> subprice ,
$request_data -> qty ,
$request_data -> remise_percent ,
$request_data -> tva_tx ,
$request_data -> localtax1_tx ,
$request_data -> localtax2_tx ,
'HT' ,
$request_data -> info_bits ,
$request_data -> date_start ,
$request_data -> date_end ,
$request_data -> product_type ,
$request_data -> fk_parent_line ,
0 ,
$request_data -> fk_fournprice ,
$request_data -> pa_ht ,
$request_data -> label ,
$request_data -> special_code ,
$request_data -> array_options ,
$request_data -> fk_unit
);
if ( $updateRes > 0 ) {
$result = $this -> get ( $id );
unset ( $result -> line );
return $this -> _cleanObjectDatas ( $result );
}
return false ;
} */
2016-11-09 22:54:51 +01:00
2017-06-01 18:18:57 +02:00
2020-10-31 18:51:30 +01:00
/**
* Update project general fields ( won ' t touch lines of project )
*
2024-02-22 01:32:55 +01:00
* @ param int $id Id of project to update
* @ param array $request_data Datas
2024-10-06 13:03:43 +02:00
* @ phan - param ? array < string , mixed > $request_data
* @ phpstan - param ? array < string , mixed > $request_data
2024-02-22 01:32:55 +01:00
* @ return Object Updated object
2024-10-06 13:03:43 +02:00
* @ phan - return Object | false
* @ phpstan - return Object | false
2020-10-31 18:51:30 +01:00
*/
public function put ( $id , $request_data = null )
{
2024-02-09 15:58:49 +01:00
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'projet' , 'creer' )) {
2024-02-01 19:16:58 +01:00
throw new RestException ( 403 );
2020-10-31 18:51:30 +01:00
}
$result = $this -> project -> fetch ( $id );
if ( $result <= 0 ) {
throw new RestException ( 404 , 'Project not found' );
}
if ( ! DolibarrApi :: _checkAccessToResource ( 'project' , $this -> project -> id )) {
2024-04-02 14:47:49 +02:00
throw new RestException ( 403 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
2020-10-31 18:51:30 +01:00
}
foreach ( $request_data as $field => $value ) {
2021-02-26 18:49:22 +01:00
if ( $field == 'id' ) {
continue ;
}
2023-12-15 12:15:33 +01:00
if ( $field === 'caller' ) {
2024-01-12 17:55:52 +01:00
// Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
2024-04-02 12:28:55 +02:00
$this -> project -> context [ 'caller' ] = sanitizeVal ( $request_data [ 'caller' ], 'aZ09' );
2023-12-15 12:15:33 +01:00
continue ;
}
2024-04-01 11:29:03 +02:00
if ( $field == 'array_options' && is_array ( $value )) {
foreach ( $value as $index => $val ) {
2024-04-02 13:53:53 +02:00
$this -> project -> array_options [ $index ] = $this -> _checkValForAPI ( $field , $val , $this -> project );
2024-04-01 11:29:03 +02:00
}
continue ;
}
2023-12-15 12:15:33 +01:00
2024-04-02 12:28:55 +02:00
$this -> project -> $field = $this -> _checkValForAPI ( $field , $value , $this -> project );
2020-10-31 18:51:30 +01:00
}
2021-02-26 18:49:22 +01:00
if ( $this -> project -> update ( DolibarrApiAccess :: $user ) >= 0 ) {
2020-10-31 18:51:30 +01:00
return $this -> get ( $id );
} else {
throw new RestException ( 500 , $this -> project -> error );
}
}
2017-06-01 18:18:57 +02:00
2020-10-31 18:51:30 +01:00
/**
* Delete project
*
* @ param int $id Project ID
*
* @ return array
2024-10-06 13:03:43 +02:00
* @ phan - return array { success : array { code : int , message : string }}
* @ phpstan - return array { success : array { code : int , message : string }}
2020-10-31 18:51:30 +01:00
*/
public function delete ( $id )
{
2024-02-09 15:58:49 +01:00
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'projet' , 'supprimer' )) {
2024-02-01 19:16:58 +01:00
throw new RestException ( 403 );
2020-10-31 18:51:30 +01:00
}
$result = $this -> project -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Project not found' );
}
if ( ! DolibarrApi :: _checkAccessToResource ( 'project' , $this -> project -> id )) {
2024-04-02 14:47:49 +02:00
throw new RestException ( 403 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
2020-10-31 18:51:30 +01:00
}
if ( ! $this -> project -> delete ( DolibarrApiAccess :: $user )) {
throw new RestException ( 500 , 'Error when delete project : ' . $this -> project -> error );
}
return array (
'success' => array (
'code' => 200 ,
'message' => 'Project deleted'
)
);
}
2017-06-01 18:18:57 +02:00
2020-10-31 18:51:30 +01:00
/**
* Validate a project .
* You can test this API with the following input message
* { " notrigger " : 0 }
*
* @ param int $id Project ID
* @ param int $notrigger 1 = Does not execute triggers , 0 = execute triggers
2024-10-06 13:03:43 +02:00
* @ phan - param int < 0 , 1 > $notrigger
* @ phpstan - param int < 0 , 1 > $notrigger
2020-10-31 18:51:30 +01:00
*
* @ url POST { id } / validate
*
* @ return array
2024-10-06 13:03:43 +02:00
* @ phan - return array { success : array { code : int , message : string }}
* @ phpstan - return array { success : array { code : int , message : string }}
2020-10-31 18:51:30 +01:00
* 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
* }
*/
public function validate ( $id , $notrigger = 0 )
{
2024-02-09 15:58:49 +01:00
if ( ! DolibarrApiAccess :: $user -> hasRight ( 'projet' , 'creer' )) {
2024-02-01 19:16:58 +01:00
throw new RestException ( 403 );
2020-10-31 18:51:30 +01:00
}
$result = $this -> project -> fetch ( $id );
if ( ! $result ) {
throw new RestException ( 404 , 'Project not found' );
}
if ( ! DolibarrApi :: _checkAccessToResource ( 'project' , $this -> project -> id )) {
2024-04-02 14:47:49 +02:00
throw new RestException ( 403 , 'Access not allowed for login ' . DolibarrApiAccess :: $user -> login );
2020-10-31 18:51:30 +01:00
}
$result = $this -> project -> setValid ( DolibarrApiAccess :: $user , $notrigger );
if ( $result == 0 ) {
throw new RestException ( 304 , 'Error nothing done. May be object is already validated' );
}
if ( $result < 0 ) {
throw new RestException ( 500 , 'Error when validating Project: ' . $this -> project -> error );
}
return array (
'success' => array (
'code' => 200 ,
'message' => 'Project validated'
)
);
}
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
/**
* Clean sensible object datas
*
* @ param Object $object Object to clean
* @ return Object Object with cleaned properties
*/
protected function _cleanObjectDatas ( $object )
{
// phpcs:enable
$object = parent :: _cleanObjectDatas ( $object );
unset ( $object -> datec );
unset ( $object -> datem );
unset ( $object -> barcode_type );
unset ( $object -> barcode_type_code );
unset ( $object -> barcode_type_label );
unset ( $object -> barcode_type_coder );
unset ( $object -> cond_reglement_id );
unset ( $object -> cond_reglement );
unset ( $object -> fk_delivery_address );
unset ( $object -> shipping_method_id );
unset ( $object -> fk_account );
unset ( $object -> note );
unset ( $object -> fk_incoterms );
unset ( $object -> label_incoterms );
unset ( $object -> location_incoterms );
unset ( $object -> name );
unset ( $object -> lastname );
unset ( $object -> firstname );
unset ( $object -> civility_id );
unset ( $object -> mode_reglement_id );
unset ( $object -> country );
unset ( $object -> country_id );
unset ( $object -> country_code );
unset ( $object -> weekWorkLoad );
unset ( $object -> weekWorkLoad );
//unset($object->lines); // for task we use timespent_lines, but for project we use lines
unset ( $object -> total_ht );
unset ( $object -> total_tva );
unset ( $object -> total_localtax1 );
unset ( $object -> total_localtax2 );
unset ( $object -> total_ttc );
unset ( $object -> comments );
return $object ;
}
2017-06-01 18:18:57 +02:00
2020-10-31 18:51:30 +01:00
/**
* Validate fields before create or update object
*
2024-10-06 13:03:43 +02:00
* @ param array < string , mixed > $data Array with data to verify
* @ return array < string , mixed >
2020-10-31 18:51:30 +01:00
* @ throws RestException
*/
private function _validate ( $data )
{
$object = array ();
foreach ( self :: $FIELDS as $field ) {
2021-02-26 18:49:22 +01:00
if ( ! isset ( $data [ $field ])) {
2020-10-31 18:51:30 +01:00
throw new RestException ( 400 , " $field field missing " );
2021-02-26 18:49:22 +01:00
}
2020-10-31 18:51:30 +01:00
$object [ $field ] = $data [ $field ];
}
return $object ;
}
// TODO
// getSummaryOfTimeSpent
2016-11-09 22:54:51 +01:00
}