Task Class Reference

Class to manage tasks. More...

Inheritance diagram for Task:

Collaboration diagram for Task:

Public Member Functions
	__construct ($db)
	Constructor.
	create ($user, $notrigger=0)
	Create into database.
	fetch ($id, $ref='', $loadparentdata=0)
	Load object in memory from database.
	update ($user=null, $notrigger=0)
	Update database.
	delete ($user, $notrigger=0)
	Delete task from database.
	hasChildren ()
	Return nb of children.
	hasTimeSpent ()
	Return nb of time spent.
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $option='', $mode='task', $addlabel=0, $sep=' - ', $notooltip=0, $save_lastsearch_value=-1)
	Return clickable name (with picto eventually)
	initAsSpecimen ()
	Initialise an instance with random values.
	getTasksArray ($usert=null, $userp=null, $projectid=0, $socid=0, $mode=0, $filteronproj='', $filteronprojstatus='-1', $morewherefilter='', $filteronprojuser=0, $filterontaskuser=0, $extrafields=null, $includebilltime=0, $search_array_options=array(), $loadextras=0, $loadRoleMode=1, $sortfield='', $sortorder='')
	Return list of tasks for all projects or for one particular project Sort order is on project, then on position of task, and last on start date of first level task.
	getUserRolesForProjectsOrTasks ($userp, $usert, $projectid='', $taskid=0, $filteronprojstatus=-1)
	Return list of roles for a user for each projects or each tasks (or a particular project or a particular task).
	getListContactId ($source='internal')
	Return list of id of contacts of task.
	mergeContactTask ($origin_id, $dest_id)
	Merge contact of tasks.
	mergeTimeSpentTask ($origin_id, $dest_id)
	Merge time spent of tasks.
	addTimeSpent ($user, $notrigger=0)
	Add time spent.
	fetchTimeSpentOnTask ($morewherefilter='')
	Fetch records of time spent of this task.
	getSummaryOfTimeSpent ($userobj=null, $morewherefilter='')
	Calculate total of time spent for task.
	getSumOfAmount ($fuser='', $dates='', $datee='')
	Calculate quantity and value of time consumed using the thm (hourly amount value of work for user entering time)
	fetchTimeSpent ($id)
	Load properties of timespent of a task from the time spent ID.
	fetchAllTimeSpent (User $userobj, $morewherefilter='')
	Load all records of time spent.
	updateTimeSpent ($user, $notrigger=0)
	Update time spent.
	delTimeSpent ($user, $notrigger=0)
	Delete time spent.
	createFromClone (User $user, $fromid, $project_id, $parent_task_id, $clone_change_dt=false, $clone_affectation=false, $clone_time=false, $clone_file=false, $clone_note=false, $clone_prog=false)
	Load an object from its id and create a new one in database.
	getLibStatut ($mode=0)
	Return status label of object.
	LibStatut ($status, $mode=0)
	Return status label for an object.
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
	Create an intervention document on disk using template defined into PROJECT_TASK_ADDON_PDF.
	load_board ($user)
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)
	loadStateBoard ()
	Load indicators this->nb for state board.
	hasDelay ()
	Is the task delayed?
	getKanbanView ($option='', $arraydata=null)
	Return clickable link of object (with eventually picto)
	mergeTask ($task_origin_id)
	Merge a task with another one, deleting the given task.
Public Member Functions inherited from CommonObjectLine
	getLabelOfUnit ($type='long')
	Returns the label, short_label or code found in units dictionary from ->fk_unit.
	fetchAll ($sortorder='', $sortfield='', $limit=0, $offset=0, $filter='', $filtermode='AND')
	Empty function to prevent errors on call of this function.
Public Member Functions inherited from CommonObject
	isEmpty ()
	isEmpty We consider CommonObject isEmpty if this->id is empty
	setErrorsFromObject ($object)
	setErrorsFromObject
	getTooltipContent ($params)
	getTooltipContent
	errorsToString ()
	Method to output saved errors.
	getFormatedCustomerRef ($objref)
	Return customer ref for screen output.
	getFormatedSupplierRef ($objref)
	Return supplier ref for screen output.
	getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
	Return full address of contact.
	getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
	Return the link of last main doc file for direct public download.
	add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
	Add a link between element $this->element and a contact.
	copy_linked_contact ($objFrom, $source='internal')
	Copy contact from one element to current.
	update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
	Update a link to contact line.
	delete_contact ($rowid, $notrigger=0)
	Delete a link to contact line.
	delete_linked_contact ($source='', $code='')
	Delete all links between an object $this and all its contacts in llx_element_contact.
	liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
	Get array of all contacts for an object.
	swapContactStatus ($rowid)
	Update status of a contact linked to object.
	liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
	Return array with list of possible values for type of contacts.
	listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
	Return array with list of possible values for type of contacts.
	getIdContact ($source, $code, $status=0)
	Return id of contacts for a source and a contact code.
	fetch_contact ($contactid=null)
	Load object contact with id=$this->contact_id into $this->contact.
	fetch_thirdparty ($force_thirdparty_id=0)
	Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
	fetchOneLike ($ref)
	Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set.
	fetch_barcode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
	fetchProject ()
	Load the project with id $this->fk_project into this->project.
	fetch_project ()
	Load the project with id $this->fk_project into this->project.
	fetch_projet ()
	Load the project with id $this->fk_project into this->project.
	fetch_product ()
	Load the product with id $this->fk_product into this->product.
	fetch_user ($userid)
	Load the user with id $userid into this->user.
	fetch_origin ()
	Read linked origin object.
	fetchObjectFrom ($table, $field, $key, $element=null)
	Load object from specific field.
	getValueFrom ($table, $id, $field)
	Getter generic.
	setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
	Setter generic.
	load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
	Load properties id_previous and id_next by comparing $fieldid with $this->ref.
	setProject ($projectid, $notrigger=0)
	Link element with a project.
	setPaymentMethods ($id)
	Change the payments methods.
	setMulticurrencyCode ($code)
	Change the multicurrency code.
	setPaymentTerms ($id, $deposit_percent=null)
	Change the payments terms.
	setTransportMode ($id)
	Change the transport mode methods.
	setRetainedWarrantyPaymentTerms ($id)
	Change the retained warranty payments terms.
	setDeliveryAddress ($id)
	Define delivery address.
	setShippingMethod ($shipping_method_id, $notrigger=0, $userused=null)
	Change the shipping method.
	setWarehouse ($warehouse_id)
	Change the warehouse.
	setDocModel ($user, $modelpdf)
	Set last model used by doc generator.
	setBankAccount ($fk_account, $notrigger=0, $userused=null)
	Change the bank account.
	line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
	Save a new position (field rang) for details lines.
	getChildrenOfLine ($id, $includealltree=0)
	Get children of line.
	line_up ($rowid, $fk_parent_line=true)
	Update a line to have a lower rank.
	line_down ($rowid, $fk_parent_line=true)
	Update a line to have a higher rank.
	updateRangOfLine ($rowid, $rang)
	Update position of line (rang)
	line_ajaxorder ($rows)
	Update position of line with ajax (rang)
	updateLineUp ($rowid, $rang)
	Update position of line up (rang)
	updateLineDown ($rowid, $rang, $max)
	Update position of line down (rang)
	getRangOfLine ($rowid)
	Get position of line (rang)
	getIdOfLine ($rang)
	Get rowid of the line relative to its position.
	line_max ($fk_parent_line=0)
	Get max value used for position of line (rang)
	update_ref_ext ($ref_ext)
	Update external ref of element.
	update_note ($note, $suffix='', $notrigger=0)
	Update note of element.
	update_note_public ($note)
	Update public note (kept for backward compatibility)
	update_price ($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null)
	Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
	add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
	Add an object link into llx_element_element.
	getElementType ()
	Return an element type string formatted like element_element target_type and source_type.
	fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
	Fetch array of objects linked to current object (object of enabled modules only).
	clearObjectLinkedCache ()
	Clear the cache saying that all linked object were already loaded.
	updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
	Update object linked of a current object.
	deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
	Delete all links between an object $this.
	setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
	Set status of an object.
	getCanvas ($id=0, $ref='')
	Load type of canvas of an object if it exists.
	getSpecialCode ($lineid)
	Get special code of a line.
	isObjectUsed ($id=0, $entity=0)
	Function to check if an object is used by others (by children).
	hasProductsOrServices ($predefined=-1)
	Function to say how many lines object contains.
	getTotalDiscount ()
	Function that returns the total amount HT of discounts applied for all lines.
	getTotalWeightVolume ()
	Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line.
	setExtraParameters ()
	Set extra parameters.
	formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
	Show add free and predefined products/services form.
	printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
	Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects.
	printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl')
	Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php)
	printOriginLinesList ($restrictlist='', $selectedLines=array())
	Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	printOriginLine ($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array())
	Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
	Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id.
	delete_resource ($rowid, $element, $notrigger=0)
	Delete a link to resource line.
	__clone ()
	Overwrite magic function to solve problem of cloning object that are kept as references.
	indexFile ($destfull, $update_main_doc_field)
	Index a file into the ECM database.
	addThumbs ($file)
	Build thumb.
	delThumbs ($file)
	Delete thumbs.
	getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
	Return the default value to use for a field when showing the create form of object.
	call_trigger ($triggerName, $user)
	Call trigger based on this instance.
	fetchValuesForExtraLanguages ()
	Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately.
	setValuesForExtraLanguages ($onlykey='')
	Fill array_options property of object by extrafields value (using for data sent by forms)
	fetchNoCompute ($id)
	Function to make a fetch but set environment to avoid to load computed values before.
	fetch_optionals ($rowid=null, $optionsArray=null)
	Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately.
	deleteExtraFields ()
	Delete all extra fields values for the current object.
	insertExtraFields ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	insertExtraLanguages ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	updateExtraField ($key, $trigger=null, $userused=null)
	Update 1 extra field value for the current object.
	getExtraField ($key)
	Convenience method for retrieving the value of an extrafield without actually fetching it from the database.
	setExtraField ($key, $value)
	Convenience method for setting the value of an extrafield without actually updating it in the database.
	updateExtraLanguages ($key, $trigger=null, $userused=null)
	Update an extra language value for the current object.
	showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
	Return HTML string to put an input field into a page Code very similar with showInputField of extra fields.
	clearFieldError ($fieldKey)
	clear validation message result for a field
	setFieldError ($fieldKey, $msg='')
	set validation error message a field
	getFieldError ($fieldKey)
	get field error message
	validateField ($fields, $fieldKey, $fieldValue)
	Return validation test result for a field.
	showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
	Function to show lines of extrafields with output data.
	getJSListDependancies ($type='_extra')
	getRights ()
	Returns the rights used for this class.
	defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
	Get buy price to use for margin calculation.
	getDataToShowPhoto ($modulepart, $imagesize)
	Function used to get the logos or photos of an object.
	show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
	Show photos of an object (nbmax maximum), into several columns.
	isDate ($info)
	Function test if type is date.
	isDuration ($info)
	Function test if type is duration.
	isInt ($info)
	Function test if type is integer.
	isFloat ($info)
	Function test if type is float.
	isText ($info)
	Function test if type is text.
	setVarsFromFetchObj (&$obj)
	Function to load data from a SQL pointer into properties of current object $this.
	emtpyObjectVars ()
	Sets all object fields to null.
	getFieldList ($alias='', $excludefields=array())
	Function to concat keys of fields.
	createCommon (User $user, $notrigger=0)
	Create object in the database.
	fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
	Load object in memory from the database.
	fetchLinesCommon ($morewhere='', $noextrafields=0)
	Load object in memory from the database.
	updateCommon (User $user, $notrigger=0)
	Update object into database.
	deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
	Delete object in database.
	deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
	Delete all child object from a parent ID.
	deleteLineCommon (User $user, $idline, $notrigger=0)
	Delete a line of object in database.
	setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
	Set to a status.
	initAsSpecimenCommon ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	fetchComments ()
	Load comments linked with current task.
	getNbComments ()
	Return nb comments already posted.
	trimParameters ($parameters)
	Trim object parameters.
	getCategoriesCommon ($type_categ)
	Sets object to given categories.
	setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
	Sets object to given categories.
	cloneCategories ($fromId, $toId, $type='')
	Copy related categories to another object.
	deleteEcmFiles ($mode=0)
	Delete related files of object in database.

Public Attributes
const	STATUS_DRAFT = 0
	Draft status.
const	STATUS_VALIDATED = 1
	Validated status (To do).
const	STATUS_CLOSED = 3
	Finished status.
const	STATUS_TRANSFERRED = 4
	Transferred status.
const	STATUS_CANCELED = 9
	status canceled
Public Attributes inherited from CommonObject
	$origin_object

Additional Inherited Members
Static Public Member Functions inherited from CommonObject
static	isExistingObject ($element, $id, $ref='', $ref_ext='')
	Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch.
static	getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element)
	Function used to get an array with all items linked to an object id in association table.
static	getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Count items linked to an object id in association table.
static	deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Function used to remove all items linked to an object id in association table.
static	commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a thirdparty id with another one.
static	commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a product id with another one.
Protected Member Functions inherited from CommonObject
	deprecatedProperties ()
	Provide list of deprecated properties and replacements.
	commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
	Common function for all objects extending CommonObject for generating documents.
	isArray ($info)
	Function test if type is array.
	canBeNull ($info)
	Function test if field can be null.
	isForcedToNullIfZero ($info)
	Function test if field is forced to null if zero or empty.
	isIndex ($info)
	Function test if is indexed.
	setSaveQuery ()
	Function to return the array of data key-value from the ->fields and all the ->properties of an object.
	quote ($value, $fieldsentry)
	Add quote to field value if necessary.

Detailed Description

Class to manage tasks.

Definition at line 41 of file task.class.php.

Constructor & Destructor Documentation

__construct()

Task::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from CommonObjectLine.

Definition at line 381 of file task.class.php.

Member Function Documentation

addTimeSpent()

Task::addTimeSpent	(		$user,
			$notrigger = 0 )

Add time spent.

Parameters

User	$user	User object
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

int Return integer <=0 if KO, >0 if OK

Definition at line 1592 of file task.class.php.

References CommonObject\call_trigger(), dol_now(), dol_print_error(), dol_syslog(), dol_time_plus_duree(), getDolGlobalInt(), and getDolGlobalString().

create()

Task::create	(		$user,
			$notrigger = 0 )

Create into database.

Parameters

User	$user	User that create
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

int Return integer <0 if KO, Id of created object if OK

Definition at line 394 of file task.class.php.

References CommonObject\call_trigger(), description, dol_now(), dol_syslog(), CommonObject\insertExtraFields(), and ref.

createFromClone()

Task::createFromClone	(	User	$user,
			$fromid,
			$project_id,
			$parent_task_id,
			$clone_change_dt = false,
			$clone_affectation = false,
			$clone_time = false,
			$clone_file = false,
			$clone_note = false,
			$clone_prog = false )

Load an object from its id and create a new one in database.

Parameters

User	$user	User making the clone
int	$fromid	Id of object to clone
int	$project_id	Id of project to attach clone task
int	$parent_task_id	Id of task to attach clone task
bool	$clone_change_dt	recalculate date of task regarding new project start date
bool	$clone_affectation	clone affectation of project
bool	$clone_time	clone time of project
bool	$clone_file	clone file of project
bool	$clone_note	clone note of project
bool	$clone_prog	clone progress of project

Returns

int New id of clone

Definition at line 2231 of file task.class.php.

References dol_copy(), dol_dir_list(), dol_html_entity_decode(), dol_mkdir(), dol_mktime(), dol_now(), dol_print_date(), dol_sanitizeFileName(), dol_syslog(), and getDolGlobalString().

delete()

Task::delete	(		$user,
			$notrigger = 0 )

Delete task from database.

Parameters

User	$user	User that delete
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 775 of file task.class.php.

References CommonObject\call_trigger(), CommonObject\delete_linked_contact(), dol_delete_dir_recursive(), dol_sanitizeFileName(), dol_syslog(), hasChildren(), and CommonObject\isObjectUsed().

delTimeSpent()

Task::delTimeSpent	(		$user,
			$notrigger = 0 )

Delete time spent.

Parameters

User	$user	User that delete
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 2149 of file task.class.php.

References CommonObject\call_trigger(), dol_now(), dol_syslog(), dol_time_plus_duree(), and getDolGlobalString().

fetch()

Task::fetch	(		$id,
			$ref = '',
			$loadparentdata = 0 )

Load object in memory from database.

Parameters

int	$id	Id object
string	$ref	ref object
int	$loadparentdata	Also load parent data

Returns

int Return integer <0 if KO, 0 if not found, >0 if OK

Definition at line 505 of file task.class.php.

References description, dol_syslog(), CommonObject\fetch_optionals(), ref, and status.

fetchAllTimeSpent()

Task::fetchAllTimeSpent	(	User	$userobj,
			$morewherefilter = '' )

Load all records of time spent.

Parameters

User	$userobj	User object
string	$morewherefilter	Add more filter into where SQL request (must start with ' AND ...')

Returns

stdClass[]|int Return integer <0 if KO, array of time spent if OK

Definition at line 1941 of file task.class.php.

References dol_print_error(), and dol_syslog().

fetchTimeSpent()

Task::fetchTimeSpent

(

$id

)

Load properties of timespent of a task from the time spent ID.

Parameters

int

$id

Id in time spent table

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 1909 of file task.class.php.

References dol_syslog().

fetchTimeSpentOnTask()

Task::fetchTimeSpentOnTask

(

$morewherefilter = ''

)

Fetch records of time spent of this task.

Parameters

string

$morewherefilter

Add more filter into where SQL request (must start with ' AND ...')

Returns

int Return integer <0 if KO, array of time spent if OK

Definition at line 1703 of file task.class.php.

References dol_print_error(), and dol_syslog().

generateDocument()

Task::generateDocument	(		$modele,
			$outputlangs,
			$hidedetails = 0,
			$hidedesc = 0,
			$hideref = 0 )

Create an intervention document on disk using template defined into PROJECT_TASK_ADDON_PDF.

Parameters

string	$modele	force le modele a utiliser ('' par default)
Translate	$outputlangs	object lang a utiliser pour traduction
int	$hidedetails	Hide details of lines
int	$hidedesc	Hide description
int	$hideref	Hide ref

Returns

int 0 if KO, 1 if OK

Definition at line 2536 of file task.class.php.

References CommonObject\commonGenerateDocument(), dol_strlen(), and getDolGlobalString().

getKanbanView()

Task::getKanbanView	(		$option = '',
			$arraydata = null )

Return clickable link of object (with eventually picto)

Parameters

string	$option	Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
	array{string,mixed}	$arraydata Array of data

Returns

string HTML Code for Kanban thumb.

Definition at line 2713 of file task.class.php.

References getNomUrl(), and img_picto().

getLibStatut()

Task::getLibStatut

(

$mode = 0

)

Return status label of object.

Parameters

integer

$mode

0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto

Returns

string Label

Definition at line 2426 of file task.class.php.

References LibStatut(), and status.

getListContactId()

Task::getListContactId

(

$source = 'internal'

)

Return list of id of contacts of task.

Parameters

string

$source

Source

Returns

array<int,int> Array of id of contacts

Reimplemented from CommonObject.

Definition at line 1494 of file task.class.php.

References CommonObject\liste_contact().

getNomUrl()

Task::getNomUrl	(		$withpicto = 0,
			$option = '',
			$mode = 'task',
			$addlabel = 0,
			$sep = ' - ',
			$notooltip = 0,
			$save_lastsearch_value = -1 )

Return clickable name (with picto eventually)

Parameters

int	$withpicto	0=No picto, 1=Include picto into link, 2=Only picto
string	$option	'withproject' or ''
string	$mode	Mode 'task', 'time', 'contact', 'note', document' define page to link to.
int	$addlabel	0=Default, 1=Add label into string, >1=Add first chars into string
string	$sep	Separator between ref and label if option addlabel is set
int	$notooltip	1=Disable tooltip
int	$save_lastsearch_value	-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking

Returns

string Chaine avec URL

Definition at line 996 of file task.class.php.

References getDolGlobalInt(), getDolGlobalString(), getTooltipContentArray(), and img_object().

Referenced by getKanbanView().

getSummaryOfTimeSpent()

Task::getSummaryOfTimeSpent	(		$userobj = null,
			$morewherefilter = '' )

Calculate total of time spent for task.

Parameters

	null|User|int<0,0>	$userobj Filter on user. null or 0=No filter
string	$morewherefilter	Add more filter into where SQL request (must start with ' AND ...')

Returns

int<-1,-1>|array{}|array{min_date:int|string,max_date:int|string,total_duration:int} Array of info for task array('min_date', 'max_date', 'total_duration', 'total_amount', 'nblines', 'nblinesnull')

Definition at line 1796 of file task.class.php.

References dol_print_error(), and dol_syslog().

getSumOfAmount()

Task::getSumOfAmount	(		$fuser = '',
			$dates = '',
			$datee = '' )

Calculate quantity and value of time consumed using the thm (hourly amount value of work for user entering time)

Parameters

User | string	$fuser	Filter on a dedicated user
string	$dates	Start date (ex 00:00:00)
string	$datee	End date (ex 23:59:59)

Returns

array{}|array{amount:float,nbseconds:int,nblinesnull:int} Array of info for task array('amount','nbseconds','nblinesnull')

Definition at line 1862 of file task.class.php.

References dol_print_error(), and dol_syslog().

getTasksArray()

Task::getTasksArray	(		$usert = null,
			$userp = null,
			$projectid = 0,
			$socid = 0,
			$mode = 0,
			$filteronproj = '',
			$filteronprojstatus = '-1',
			$morewherefilter = '',
			$filteronprojuser = 0,
			$filterontaskuser = 0,
			$extrafields = null,
			$includebilltime = 0,
			$search_array_options = array(),
			$loadextras = 0,
			$loadRoleMode = 1,
			$sortfield = '',
			$sortorder = '' )

Return list of tasks for all projects or for one particular project Sort order is on project, then on position of task, and last on start date of first level task.

Parameters

?User	$usert	Object user to limit tasks affected to a particular user
?User	$userp	Object user to limit projects of a particular user and public projects
int	$projectid	Project id
int	$socid	Third party id
int	$mode	0=Return list of tasks and their projects, 1=Return projects and tasks if exists
string	$filteronproj	Filter on project ref or label
string	$filteronprojstatus	Filter on project status ('-1'=no filter, '0,1'=Draft+Validated only)
string	$morewherefilter	Add more filter into where SQL request (must start with ' AND ...')
int	$filteronprojuser	Filter on user that is a contact of project
int	$filterontaskuser	Filter on user assigned to task
?Extrafields	$extrafields	Show additional column from project or task
int	$includebilltime	Calculate also the time to bill and billed
	array<string,string>	$search_array_options Array of search filters. Not Used yet.
int	$loadextras	Fetch all Extrafields on each project and task
int	$loadRoleMode	1= will test Roles on task; 0 used in delete project action
string	$sortfield	Sort field
string	$sortorder	Sort order

Returns

Task[]|string Array of tasks

Definition at line 1122 of file task.class.php.

References dol_print_error(), dol_syslog(), getUserRolesForProjectsOrTasks(), and natural_search().

getTooltipContentArray()

Task::getTooltipContentArray

(

$params

)

getTooltipContentArray

Parameters

array<string,mixed>

$params params to construct tooltip data

Since

v18

Returns

array{picto?:string,ref?:string,refsupplier?:string,label?:string,date?:string,date_echeance?:string,amountht?:string,total_ht?:string,totaltva?:string,amountlt1?:string,amountlt2?:string,amountrevenustamp?:string,totalttc?:string}|array{optimize:string}

Reimplemented from CommonObject.

Definition at line 963 of file task.class.php.

References img_picto(), and ref.

Referenced by getNomUrl().

getUserRolesForProjectsOrTasks()

Task::getUserRolesForProjectsOrTasks	(		$userp,
			$usert,
			$projectid = '',
			$taskid = 0,
			$filteronprojstatus = -1 )

Return list of roles for a user for each projects or each tasks (or a particular project or a particular task).

Parameters

?User	$userp	Return roles on project for this internal user. If set, usert and taskid must not be defined.
?User	$usert	Return roles on task for this internal user. If set userp must NOT be defined. -1 means no filter.
string	$projectid	Project id list separated with , to filter on project
int	$taskid	Task id to filter on a task
int	$filteronprojstatus	Filter on project status if userp is set. Not used if userp not defined.

Returns

array<int,string>|int<-1,-1> Array (projectid => 'list of roles for project' or taskid => 'list of roles for task')

Definition at line 1386 of file task.class.php.

References dol_print_error(), and dol_syslog().

Referenced by getTasksArray().

hasChildren()

Task::hasChildren

(

)

Return nb of children.

Returns

int Return integer <0 if KO, 0 if no children, >0 if OK

Definition at line 892 of file task.class.php.

References dol_syslog().

Referenced by delete().

hasDelay()

Task::hasDelay

(

)

Is the task delayed?

Returns

bool

Definition at line 2691 of file task.class.php.

References dol_now().

hasTimeSpent()

Task::hasTimeSpent

(

)

Return nb of time spent.

Returns

int Return integer <0 if KO, 0 if no children, >0 if OK

Definition at line 926 of file task.class.php.

References dol_syslog().

initAsSpecimen()

Task::initAsSpecimen

(

)

Initialise an instance with random values.

Used to build previews or test instances. id must be 0 if object instance is a specimen.

Returns

int

Definition at line 1077 of file task.class.php.

References ref, and status.

LibStatut()

Task::LibStatut	(		$status,
			$mode = 0 )

Return status label for an object.

Parameters

int	$status	Id status
integer	$mode	0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto

Returns

string Label

Definition at line 2439 of file task.class.php.

References img_picto().

Referenced by getLibStatut().

load_board()

Task::load_board

(

$user

)

Load indicators for dashboard (this->nbtodo and this->nbtodolate)

Parameters

User

$user

Object user

Returns

WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK

Definition at line 2563 of file task.class.php.

References img_object().

loadStateBoard()

Task::loadStateBoard

(

)

Load indicators this->nb for state board.

Returns

int Return integer <0 if ko, >0 if ok

Definition at line 2639 of file task.class.php.

References dol_print_error().

mergeContactTask()

Task::mergeContactTask	(		$origin_id,
			$dest_id )

Merge contact of tasks.

Parameters

int	$origin_id	Old task id
int	$dest_id	New task id

Returns

bool

Definition at line 1519 of file task.class.php.

References CommonObject\add_contact().

Referenced by mergeTask().

mergeTask()

Task::mergeTask

(

$task_origin_id

)

Merge a task with another one, deleting the given task.

The task given in parameter will be removed.

Parameters

int

$task_origin_id

Task to merge the data from

Returns

int -1 if error

Definition at line 2753 of file task.class.php.

References CommonObject\call_trigger(), dol_concatdesc(), dol_syslog(), mergeContactTask(), mergeTimeSpentTask(), and update().

mergeTimeSpentTask()

Task::mergeTimeSpentTask	(		$origin_id,
			$dest_id )

Merge time spent of tasks.

Parameters

int	$origin_id	Old task id
int	$dest_id	New task id

Returns

bool

Definition at line 1548 of file task.class.php.

References dol_syslog().

Referenced by mergeTask().

update()

Task::update	(		$user = null,
			$notrigger = 0 )

Update database.

Parameters

User	$user	User that modify
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

int Return integer <=0 if KO, >0 if OK

Parameters

bool	$allTasksCompleted
Task	$task

Returns

bool

Definition at line 608 of file task.class.php.

References CommonObject\call_trigger(), description, dol_move_dir(), dol_sanitizeFileName(), dol_syslog(), getDolGlobalString(), CommonObject\insertExtraFields(), ref, and Project\STATUS_VALIDATED.

Referenced by mergeTask().

updateTimeSpent()

Task::updateTimeSpent	(		$user,
			$notrigger = 0 )

Update time spent.

Parameters

User	$user	User id
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 2030 of file task.class.php.

References CommonObject\call_trigger(), dol_now(), dol_syslog(), dol_time_plus_duree(), and getDolGlobalString().

Member Data Documentation

STATUS_VALIDATED

const Task::STATUS_VALIDATED = 1

Validated status (To do).

Note: We also have the field progress to know the progression from 0 to 100%.

Definition at line 358 of file task.class.php.

---

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

• dolibarr_dev/htdocs/projet/class/task.class.php