dolibarr  20.0.0-beta
Functions
project.lib.php File Reference

Functions used by project module. More...

Go to the source code of this file.

Functions

 project_prepare_head (Project $project, $moreparam='')
 Prepare array with list of tabs. More...
 
 task_prepare_head ($object)
 Prepare array with list of tabs. More...
 
 project_timesheet_prepare_head ($mode, $fuser=null)
 Prepare array with list of tabs. More...
 
 project_admin_prepare_head ()
 Prepare array with list of tabs. More...
 
 projectLinesa (&$inc, $parent, &$lines, &$level, $var, $showproject, &$taskrole, $projectsListId='', $addordertick=0, $projectidfortotallink=0, $dummy='', $showbilltime=0, $arrayfields=array(), $arrayofselected=array())
 Show task lines with a particular parent. More...
 
 projectLinesPerAction (&$inc, $parent, $fuser, $lines, &$level, &$projectsrole, &$tasksrole, $mine, $restricteditformytask, $preselectedday, &$isavailable, $oldprojectforbreak=0)
 Output a task line into a pertime input mode. More...
 
 projectLinesPerDay (&$inc, $parent, $fuser, $lines, &$level, &$projectsrole, &$tasksrole, $mine, $restricteditformytask, $preselectedday, &$isavailable, $oldprojectforbreak=0, $arrayfields=array(), $extrafields=null)
 Output a task line into a pertime input mode. More...
 
 projectLinesPerWeek (&$inc, $firstdaytoshow, $fuser, $parent, $lines, &$level, &$projectsrole, &$tasksrole, $mine, $restricteditformytask, &$isavailable, $oldprojectforbreak=0, $arrayfields=array(), $extrafields=null)
 Output a task line into a perday input mode. More...
 
 projectLinesPerMonth (&$inc, $firstdaytoshow, $fuser, $parent, $lines, &$level, &$projectsrole, &$tasksrole, $mine, $restricteditformytask, &$isavailable, $oldprojectforbreak=0, $TWeek=array())
 Output a task line into a perday input mode. More...
 
 searchTaskInChild (&$inc, $parent, &$lines, &$taskrole)
 Search in task lines with a particular parent if there is a task for a particular user (in taskrole) More...
 
 print_projecttasks_array ($db, $form, $socid, $projectsListId, $mytasks=0, $status=-1, $listofoppstatus=array(), $hiddenfields=array(), $max=0)
 Return HTML table with list of projects and number of opened tasks. More...
 
 getTaskProgressView ($task, $label=true, $progressNumber=true, $hideOnProgressNull=false, $spaced=false)
 
 getTaskProgressBadge ($task, $label='', $tooltip='')
 

Detailed Description

Functions used by project module.

Definition in file project.lib.php.

Function Documentation

◆ getTaskProgressBadge()

getTaskProgressBadge (   $task,
  $label = '',
  $tooltip = '' 
)
Parameters
Task$taskthe task object
string$labelempty = auto (progress), string = replace output
string$tooltipempty = auto , string = replace output
Returns
string
See also
getTaskProgressView()

Definition at line 2972 of file project.lib.php.

◆ getTaskProgressView()

getTaskProgressView (   $task,
  $label = true,
  $progressNumber = true,
  $hideOnProgressNull = false,
  $spaced = false 
)
Parameters
Task$taskthe task object
bool | string$labeltrue = auto, false = don't display, string = replace output
bool | string$progressNumbertrue = auto, false = don't display, string = replace output
bool$hideOnProgressNullhide if progress is null
bool$spacedused to add space at bottom (made by css)
Returns
string
See also
getTaskProgressBadge()

Definition at line 2840 of file project.lib.php.

◆ print_projecttasks_array()

print_projecttasks_array (   $db,
  $form,
  $socid,
  $projectsListId,
  $mytasks = 0,
  $status = -1,
  $listofoppstatus = array(),
  $hiddenfields = array(),
  $max = 0 
)

Return HTML table with list of projects and number of opened tasks.

Parameters
DoliDB$dbDatabase handler
Form$formObject form
int$socidId thirdparty
int$projectsListIdId of project I have permission on
int$mytasksLimited to task I am contact to
int$status-1=No filter on statut, 0 or 1 = Filter on status
array$listofoppstatusList of opportunity status
array$hiddenfieldsList of info to not show ('projectlabel', 'declaredprogress', '...', )
int$maxMax nb of record to show in HTML list
Returns
void

Definition at line 2498 of file project.lib.php.

◆ project_admin_prepare_head()

project_admin_prepare_head ( )

Prepare array with list of tabs.

Returns
array Array of tabs to show

Definition at line 527 of file project.lib.php.

◆ project_prepare_head()

project_prepare_head ( Project  $project,
  $moreparam = '' 
)

Prepare array with list of tabs.

Parameters
Project$projectObject related to tabs
string$moreparamMore param on url
Returns
array Array of tabs to show

Definition at line 40 of file project.lib.php.

◆ project_timesheet_prepare_head()

project_timesheet_prepare_head (   $mode,
  $fuser = null 
)

Prepare array with list of tabs.

Parameters
string$modeMode
string$fuserFilter on user
Returns
array Array of tabs to show

Definition at line 481 of file project.lib.php.

◆ projectLinesa()

projectLinesa ( $inc,
  $parent,
$lines,
$level,
  $var,
  $showproject,
$taskrole,
  $projectsListId = '',
  $addordertick = 0,
  $projectidfortotallink = 0,
  $dummy = '',
  $showbilltime = 0,
  $arrayfields = array(),
  $arrayofselected = array() 
)

Show task lines with a particular parent.

Parameters
string$incLine number (start to 0, then increased by recursive call)
string$parentId of parent task to show (0 to show all)
Task[]$linesArray of lines
int$levelLevel (start to 0, then increased/decrease by recursive call), or -1 to show all level in order of $lines without the recursive groupment feature.
string$varColor
int$showprojectShow project columns
int$taskroleArray of roles of user for each tasks
string$projectsListIdList of id of project allowed to user (string separated with comma)
int$addordertickAdd a tick to move task
int$projectidfortotallink0 or Id of project to use on total line (link to see all time consumed for project)
string$dummyNot used.
int$showbilltimeAdd the column 'TimeToBill' and 'TimeBilled'
array$arrayfieldsArray with displayed column information
array$arrayofselectedArray with selected fields
Returns
int Nb of tasks shown

Definition at line 599 of file project.lib.php.

◆ projectLinesPerAction()

projectLinesPerAction ( $inc,
  $parent,
  $fuser,
  $lines,
$level,
$projectsrole,
$tasksrole,
  $mine,
  $restricteditformytask,
  $preselectedday,
$isavailable,
  $oldprojectforbreak = 0 
)

Output a task line into a pertime input mode.

Parameters
string$incLine number (start to 0, then increased by recursive call)
string$parentId of parent task to show (0 to show all)
User | null$fuserRestrict list to user if defined
Task[]$linesArray of lines
int$levelLevel (start to 0, then increased/decrease by recursive call)
string$projectsroleArray of roles user has on project
string$tasksroleArray of roles user has on task
string$mineShow only task lines I am assigned to
int$restricteditformytask0=No restriction, 1=Enable add time only if task is a task i am affected to
int$preselecteddayPreselected day
array$isavailableArray with data that say if user is available for several days for morning and afternoon
int$oldprojectforbreakOld project id of last project break
Returns
array Array with time spent for $fuser for each day of week on tasks in $lines and subtasks

Definition at line 1160 of file project.lib.php.

◆ projectLinesPerDay()

projectLinesPerDay ( $inc,
  $parent,
  $fuser,
  $lines,
$level,
$projectsrole,
$tasksrole,
  $mine,
  $restricteditformytask,
  $preselectedday,
$isavailable,
  $oldprojectforbreak = 0,
  $arrayfields = array(),
  $extrafields = null 
)

Output a task line into a pertime input mode.

Parameters
string$incLine number (start to 0, then increased by recursive call)
string$parentId of parent task to show (0 to show all)
User | null$fuserRestrict list to user if defined
Task[]$linesArray of lines
int$levelLevel (start to 0, then increased/decrease by recursive call)
string$projectsroleArray of roles user has on project
string$tasksroleArray of roles user has on task
string$mineShow only task lines I am assigned to
int$restricteditformytask0=No restriction, 1=Enable add time only if task is assigned to me, 2=Enable add time only if tasks is assigned to me and hide others
int$preselecteddayPreselected day
array$isavailableArray with data that say if user is available for several days for morning and afternoon
int$oldprojectforbreakOld project id of last project break
array$arrayfieldsArray of additional column
Extrafields$extrafieldsObject extrafields
Returns
array Array with time spent for $fuser for each day of week on tasks in $lines and subtasks

Definition at line 1383 of file project.lib.php.

◆ projectLinesPerMonth()

projectLinesPerMonth ( $inc,
  $firstdaytoshow,
  $fuser,
  $parent,
  $lines,
$level,
$projectsrole,
$tasksrole,
  $mine,
  $restricteditformytask,
$isavailable,
  $oldprojectforbreak = 0,
  $TWeek = array() 
)

Output a task line into a perday input mode.

Parameters
string$incLine output identificator (start to 0, then increased by recursive call)
int$firstdaytoshowFirst day to show
User | null$fuserRestrict list to user if defined
string$parentId of parent task to show (0 to show all)
Task[]$linesArray of lines (list of tasks but we will show only if we have a specific role on task)
int$levelLevel (start to 0, then increased/decrease by recursive call)
string$projectsroleArray of roles user has on project
string$tasksroleArray of roles user has on task
string$mineShow only task lines I am assigned to
int$restricteditformytask0=No restriction, 1=Enable add time only if task is a task i am affected to
array$isavailableArray with data that say if user is available for several days for morning and afternoon
int$oldprojectforbreakOld project id of last project break
array$TWeekArray of week numbers
Returns
array Array with time spent for $fuser for each day of week on tasks in $lines and subtasks

Definition at line 2177 of file project.lib.php.

◆ projectLinesPerWeek()

projectLinesPerWeek ( $inc,
  $firstdaytoshow,
  $fuser,
  $parent,
  $lines,
$level,
$projectsrole,
$tasksrole,
  $mine,
  $restricteditformytask,
$isavailable,
  $oldprojectforbreak = 0,
  $arrayfields = array(),
  $extrafields = null 
)

Output a task line into a perday input mode.

Parameters
string$incLine output identificator (start to 0, then increased by recursive call)
int$firstdaytoshowFirst day to show
User | null$fuserRestrict list to user if defined
string$parentId of parent task to show (0 to show all)
Task[]$linesArray of lines (list of tasks but we will show only if we have a specific role on task)
int$levelLevel (start to 0, then increased/decrease by recursive call)
string$projectsroleArray of roles user has on project
string$tasksroleArray of roles user has on task
string$mineShow only task lines I am assigned to
int$restricteditformytask0=No restriction, 1=Enable add time only if task is assigned to me, 2=Enable add time only if tasks is assigned to me and hide others
array$isavailableArray with data that say if user is available for several days for morning and afternoon
int$oldprojectforbreakOld project id of last project break
array$arrayfieldsArray of additional column
Extrafields$extrafieldsObject extrafields
Returns
array Array with time spent for $fuser for each day of week on tasks in $lines and subtasks

Definition at line 1780 of file project.lib.php.

◆ searchTaskInChild()

searchTaskInChild ( $inc,
  $parent,
$lines,
$taskrole 
)

Search in task lines with a particular parent if there is a task for a particular user (in taskrole)

Parameters
int$incCounter that count number of lines legitimate to show (for return)
int$parentId of parent task to start
Task[]$linesArray of all tasks
string$taskroleArray of task filtered on a particular user
Returns
int 1 if there is

Definition at line 2458 of file project.lib.php.

◆ task_prepare_head()

task_prepare_head (   $object)

Prepare array with list of tabs.

Parameters
Object$objectObject related to tabs
Returns
array Array of tabs to show

Definition at line 374 of file project.lib.php.