Project Class Reference

Class to manage projects. More...

Inheritance diagram for Project:

Collaboration diagram for Project:

Public Member Functions
	__construct ($db)
	Constructor.
	create ($user, $notrigger=0)
	Create a project into database.
	update ($user, $notrigger=0)
	Update a project.
	fetch ($id, $ref='', $ref_ext='', $email_msgid='')
	Get object from database.
	fetchAndSetSubstitution ($id, $key, $fetched=false)
	Fetch object and substitute key.
	get_element_list ($type, $tablename, $datefieldname='', $date_start=null, $date_end=null, $projectkey='fk_projet')
	Return list of elements for type, linked to a project.
	delete ($user, $notrigger=0)
	Delete a project from database.
	getElementCount ($type, $tablename, $projectkey='fk_projet')
	Return the count of a type of linked elements of this project.
	deleteTasks ($user)
	Delete tasks with no children first, then task with children recursively.
	setValid ($user, $notrigger=0)
	Validate a project.
	setClose ($user)
	Close a project.
	getLibStatut ($mode=0)
	Return status label of object.
	LibStatut ($status, $mode=0)
	Renvoi status label for a status.
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $option='', $addlabel=0, $moreinpopup='', $sep=' - ', $notooltip=0, $save_lastsearch_value=-1, $morecss='', $save_pageforbacktolist='')
	Return clickable name (with picto eventually)
	initAsSpecimen ()
	Initialise an instance with random values.
	restrictedProjectArea (User $user, $mode='read')
	Check if user has permission on current project.
	getProjectsAuthorizedForUser ($user, $mode=0, $list=0, $socid=0, $filter='')
	Return array of projects a user has permission on, is affected to, or all projects.
	createFromClone (User $user, $fromid, $clone_contact=false, $clone_task=true, $clone_project_file=false, $clone_task_file=false, $clone_note=true, $move_date=true, $notrigger=0, $newthirdpartyid=0)
	Load an object from its id and create a new one in database.
	shiftTaskDate ($old_project_dt_start)
	Shift project task date from current date to delta.
	update_element ($tableName, $elementSelectId)
	Associate element to a project.
	remove_element ($tableName, $elementSelectId, $projectfield='fk_projet')
	Associate element to a project.
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
	Create an intervention document on disk using template defined into PROJECT_ADDON_PDF.
	loadTimeSpent ($datestart, $taskid=0, $userid=0)
	Load time spent into this->weekWorkLoad and this->weekWorkLoadPerTask for all day of a week of project.
	loadTimeSpentMonth ($datestart, $taskid=0, $userid=0)
	Load time spent into this->weekWorkLoad and this->weekWorkLoadPerTask for all day of a week of project.
	load_board ($user)
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)
	loadStateBoard ()
	Load indicators this->nb for the state board.
	hasDelay ()
	Is the project delayed?
	info ($id)
	Charge les information d'ordre info dans l'objet commande.
	setCategories ($categories)
	Sets object to supplied categories.
	getLinesArray ($user, $loadRoleMode=1)
	Create an array of tasks of current project.
	sendEmail ($text, $subject, $filename_list=array(), $mimetype_list=array(), $mimefilename_list=array(), $addr_cc="", $addr_bcc="", $deliveryreceipt=0, $msgishtml=-1, $errors_to='', $moreinheader='')
	Function sending an email to the current project with the text supplied in parameter.
	getKanbanView ($option='', $arraydata=null, $size='')
	Return clickable link of object (with eventually picto)
	getChildren ()
	Return array of sub-projects of the current project.
	createWeeklyReport ()
	Method for calculating weekly hours worked and generating a report.
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.
	fetchBarCode ()
	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.
	getListContactId ($source='external')
	Return list of id of contacts of object.
	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.

Static Public Member Functions
static	replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
	Function used to replace a thirdparty id with another one.
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.

Public Attributes
const	STATUS_DRAFT = 0
	Draft status.
const	STATUS_VALIDATED = 1
	Open/Validated status.
const	STATUS_CLOSED = 2
	Closed status.
Public Attributes inherited from CommonObject
	$origin_object

Protected Attributes
	$table_ref_field = 'ref'
	{}

Additional Inherited Members
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 projects.

Definition at line 39 of file project.class.php.

Constructor & Destructor Documentation

__construct()

Project::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 409 of file project.class.php.

References $conf, and getDolGlobalString().

Member Function Documentation

create()

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

Create a project into database.

Parameters

User	$user	User making creation
int	$notrigger	Disable triggers

Returns

int Return integer <0 if KO, id of created project if OK

Definition at line 456 of file project.class.php.

References CommonObject\call_trigger(), description, dol_now(), dol_substr(), dol_syslog(), getDolGlobalString(), CommonObject\insertExtraFields(), price2num(), ref, setValid(), and status.

createFromClone()

Project::createFromClone	(	User	$user,
			$fromid,
			$clone_contact = false,
			$clone_task = true,
			$clone_project_file = false,
			$clone_task_file = false,
			$clone_note = true,
			$move_date = true,
			$notrigger = 0,
			$newthirdpartyid = 0 )

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
bool	$clone_contact	Clone contact of project
bool	$clone_task	Clone task of project
bool	$clone_project_file	Clone file of project
bool	$clone_task_file	Clone file of task (if task are copied)
bool	$clone_note	Clone note of project
bool	$move_date	Move task date on clone
int	$notrigger	No trigger flag
int	$newthirdpartyid	New thirdparty id

Returns

int New id of clone

Definition at line 1755 of file project.class.php.

References $conf, dol_buildpath(), dol_copy(), dol_dir_list(), dol_html_entity_decode(), dol_include_once(), dol_mkdir(), dol_mktime(), dol_now(), dol_sanitizeFileName(), dol_syslog(), and getDolGlobalString().

createWeeklyReport()

Project::createWeeklyReport

(

)

Method for calculating weekly hours worked and generating a report.

Returns

int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)

Definition at line 2644 of file project.class.php.

References dol_get_first_day_week(), dol_getdate(), dol_mktime(), dol_now(), dol_print_date(), dol_print_error(), dol_syslog(), dol_time_plus_duree(), getDolGlobalString(), and num_public_holiday().

delete()

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

Delete a project from database.

Parameters

User	$user	User
int	$notrigger	Disable triggers

Returns

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

Definition at line 979 of file project.class.php.

References $conf, CommonObject\call_trigger(), CommonObject\delete_linked_contact(), deleteTasks(), dol_delete_dir_recursive(), dol_sanitizeFileName(), dol_syslog(), getLinesArray(), and ref.

deleteTasks()

Project::deleteTasks

(

$user

)

Delete tasks with no children first, then task with children recursively.

Parameters

User

$user

User

Returns

int Return integer <0 if KO, 1 if OK

Definition at line 1186 of file project.class.php.

References deleteTasks(), and getLinesArray().

Referenced by delete(), and deleteTasks().

fetch()

Project::fetch	(		$id,
			$ref = '',
			$ref_ext = '',
			$email_msgid = '' )

Get object from database.

Parameters

int	$id	Id of object to load
string	$ref	Ref of project
string	$ref_ext	Ref ext of project
string	$email_msgid	Email msgid

Returns

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

Definition at line 734 of file project.class.php.

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

Referenced by fetchAndSetSubstitution().

fetchAndSetSubstitution()

Project::fetchAndSetSubstitution	(		$id,
			$key,
			$fetched = false )

Fetch object and substitute key.

Parameters

int	$id	Project id
string	$key	Key to substitute
bool	$fetched	[=false] Not already fetched

Returns

string Substitute key

Definition at line 836 of file project.class.php.

References fetch().

generateDocument()

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

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

Parameters

string	$modele	Force template to use ('' by default)
Translate	$outputlangs	Object lang to use for translation
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 2119 of file project.class.php.

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

get_element_list()

Project::get_element_list	(		$type,
			$tablename,
			$datefieldname = '',
			$date_start = null,
			$date_end = null,
			$projectkey = 'fk_projet' )

Return list of elements for type, linked to a project.

Parameters

string	$type	'propal','order','invoice','order_supplier','invoice_supplier',...
string	$tablename	name of table associated of the type
string	$datefieldname	name of date field for filter
int	$date_start	Start date
int	$date_end	End date
string	$projectkey	Equivalent key to fk_projet for actual type

Returns

mixed Array list of object ids linked to project, < 0 or string if error

Definition at line 872 of file project.class.php.

References dol_print_error(), dol_syslog(), getEntity(), and isDolTms().

getChildren()

Project::getChildren

(

)

Return array of sub-projects of the current project.

Returns

stdClass[] Children of this project as objects with rowid & title as members

Definition at line 2618 of file project.class.php.

References dol_print_error().

getElementCount()

Project::getElementCount	(		$type,
			$tablename,
			$projectkey = 'fk_projet' )

Return the count of a type of linked elements of this project.

Parameters

string	$type	The type of the linked elements (e.g. 'propal', 'order', 'invoice', 'order_supplier', 'invoice_supplier')
string	$tablename	The name of table associated of the type
string	$projectkey	(optional) Equivalent key to fk_projet for actual type

Returns

integer The count of the linked elements (the count is zero on request error too)

Definition at line 1145 of file project.class.php.

References getEntity().

getKanbanView()

Project::getKanbanView	(		$option = '',
			$arraydata = null,
			$size = '' )

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
string	$size	Size of thumb (''=auto, 'large'=large, 'small'=small)

Returns

string HTML Code for Kanban thumb.

Definition at line 2522 of file project.class.php.

References $conf, dol_print_email(), dol_print_phone(), getNomUrl(), hasDelay(), img_picto(), and img_warning().

getLibStatut()

Project::getLibStatut

(

$mode = 0

)

Return status label of object.

Parameters

int

$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 1334 of file project.class.php.

References LibStatut(), and status.

getLinesArray()

Project::getLinesArray	(		$user,
			$loadRoleMode = 1 )

Create an array of tasks of current project.

Parameters

?User	$user	Object user we want project allowed to
int	$loadRoleMode	1= will test Roles on task; 0 used in delete project action

Returns

int >0 if OK, <0 if KO

Definition at line 2480 of file project.class.php.

Referenced by delete(), and deleteTasks().

getNomUrl()

Project::getNomUrl	(		$withpicto = 0,
			$option = '',
			$addlabel = 0,
			$moreinpopup = '',
			$sep = ' - ',
			$notooltip = 0,
			$save_lastsearch_value = -1,
			$morecss = '',
			$save_pageforbacktolist = '' )

Return clickable name (with picto eventually)

Parameters

int	$withpicto	0=No picto, 1=Include picto into link, 2=Only picto
string	$option	Variant where the link point to ('', 'nolink')
int	$addlabel	0=Default, 1=Add label into string, >1=Add first chars into string
string	$moreinpopup	Text to add into popup
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
string	$morecss	More css on a link
string	$save_pageforbacktolist	Back to this page 'context:url'

Returns

string String with URL

Definition at line 1427 of file project.class.php.

References $conf, dol_buildpath(), getDolGlobalInt(), getDolGlobalString(), getTooltipContentArray(), and img_object().

Referenced by getKanbanView().

getProjectsAuthorizedForUser()

Project::getProjectsAuthorizedForUser	(		$user,
			$mode = 0,
			$list = 0,
			$socid = 0,
			$filter = '' )

Return array of projects a user has permission on, is affected to, or all projects.

Parameters

User	$user	User object
int	$mode	0=All project I have permission on (assigned to me or public), 1=Projects assigned to me only, 2=Will return list of all projects with no test on contacts
int	$list	0=Return array, 1=Return string list
int	$socid	0=No filter on third party, id of third party
string	$filter	Additional filter on project (statut, ref, ...). TODO Use USF syntax here.

Returns

int[]|string Array of projects id, or string with projects id separated with "," if list is 1

Definition at line 1649 of file project.class.php.

References dol_print_error(), dol_syslog(), and forgeSQLFromUniversalSearchCriteria().

Referenced by load_board(), and loadStateBoard().

getTooltipContentArray()

Project::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 1376 of file project.class.php.

References $conf, dol_print_date(), img_picto(), and status.

Referenced by getNomUrl().

hasDelay()

Project::hasDelay

(

)

Is the project delayed?

Returns

bool

Definition at line 2405 of file project.class.php.

References $conf, dol_now(), and status.

Referenced by getKanbanView().

info()

Project::info

(

$id

)

Charge les information d'ordre info dans l'objet commande.

Parameters

int

$id

Id of order

Returns

void

Definition at line 2428 of file project.class.php.

References dol_print_error().

initAsSpecimen()

Project::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 1535 of file project.class.php.

References $conf, dol_now(), and ref.

LibStatut()

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

Renvoi status label for a status.

Parameters

int	$status	id status
int	$mode	0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto

Returns

string Label

Definition at line 1347 of file project.class.php.

References dolGetStatus().

Referenced by getLibStatut().

load_board()

Project::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 2276 of file project.class.php.

References $conf, getProjectsAuthorizedForUser(), and img_object().

loadStateBoard()

Project::loadStateBoard

(

)

Load indicators this->nb for the state board.

Returns

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

Definition at line 2370 of file project.class.php.

References dol_print_error(), and getProjectsAuthorizedForUser().

loadTimeSpent()

Project::loadTimeSpent	(		$datestart,
			$taskid = 0,
			$userid = 0 )

Load time spent into this->weekWorkLoad and this->weekWorkLoadPerTask for all day of a week of project.

Note: array weekWorkLoad and weekWorkLoadPerTask are reset and filled at each call.

Parameters

int	$datestart	First day of week (use dol_get_first_day to find this date)
int	$taskid	Filter on a task id
int	$userid	Time spent by a particular user

Returns

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

Definition at line 2150 of file project.class.php.

References dol_print_error(), dol_syslog(), and dol_time_plus_duree().

loadTimeSpentMonth()

Project::loadTimeSpentMonth	(		$datestart,
			$taskid = 0,
			$userid = 0 )

Load time spent into this->weekWorkLoad and this->weekWorkLoadPerTask for all day of a week of project.

Note: array weekWorkLoad and weekWorkLoadPerTask are reset and filled at each call.

Parameters

int	$datestart	First day of week (use dol_get_first_day to find this date)
int	$taskid	Filter on a task id
int	$userid	Time spent by a particular user

Returns

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

Definition at line 2212 of file project.class.php.

References dol_print_error(), dol_syslog(), dol_time_plus_duree(), and getWeekNumber().

remove_element()

Project::remove_element	(		$tableName,
			$elementSelectId,
			$projectfield = 'fk_projet' )

Associate element to a project.

Parameters

string	$tableName	Table of the element to update
int	$elementSelectId	Key-rowid of the line of the element to update
string	$projectfield	The column name that stores the link with the project

Returns

int 1 if OK or < 0 if KO

Definition at line 2086 of file project.class.php.

References dol_syslog().

replaceThirdparty()

static Project::replaceThirdparty ( DoliDB $dbs, $origin_id, $dest_id )

static

Function used to replace a thirdparty id with another one.

Parameters

DoliDB	$dbs	Database handler
int	$origin_id	Old thirdparty id
int	$dest_id	New thirdparty id

Returns

bool

Definition at line 2355 of file project.class.php.

References CommonObject\commonReplaceThirdparty().

restrictedProjectArea()

Project::restrictedProjectArea	(	User	$user,
			$mode = 'read' )

Check if user has permission on current project.

Parameters

User	$user	Object user to evaluate
string	$mode	Type of permission we want to know: 'read', 'write'

Returns

int >0 if user has permission, <0 if user has no permission

Definition at line 1587 of file project.class.php.

References CommonObject\liste_contact().

sendEmail()

Project::sendEmail	(		$text,
			$subject,
			$filename_list = array(),
			$mimetype_list = array(),
			$mimefilename_list = array(),
			$addr_cc = "",
			$addr_bcc = "",
			$deliveryreceipt = 0,
			$msgishtml = -1,
			$errors_to = '',
			$moreinheader = '' )

Function sending an email to the current project with the text supplied in parameter.

TODO When this is used ?

Parameters

string	$text	Content of message (not html entities encoded)
string	$subject	Subject of message
string[]	$filename_list	Array of attached files
string[]	$mimetype_list	Array of mime types of attached files
string[]	$mimefilename_list	Array of public names of attached files
string	$addr_cc	Email cc
string	$addr_bcc	Email bcc
int	$deliveryreceipt	Ask a delivery receipt
int	$msgishtml	1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection
string	$errors_to	errors to
string	$moreinheader	Add more html headers

Since

V18

Returns

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

Definition at line 2507 of file project.class.php.

setCategories()

Project::setCategories

(

$categories

)

Sets object to supplied categories.

Deletes object from existing categories not supplied. Adds it to non existing supplied categories. Existing categories are left untouch.

Parameters

int[] | int

$categories

Category or categories IDs

Returns

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

Definition at line 2466 of file project.class.php.

setClose()

Project::setClose

(

$user

)

Close a project.

Parameters

User

$user

User that close project

Returns

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

Definition at line 1280 of file project.class.php.

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

setValid()

Project::setValid	(		$user,
			$notrigger = 0 )

Validate a project.

Parameters

User	$user	User that validate
int	$notrigger	1=Disable triggers

Returns

int Return integer <0 if KO, 0=Nothing done, >0 if KO

Definition at line 1219 of file project.class.php.

References CommonObject\call_trigger(), dol_syslog(), and status.

Referenced by create().

shiftTaskDate()

Project::shiftTaskDate

(

$old_project_dt_start

)

Shift project task date from current date to delta.

Parameters

integer

$old_project_dt_start

Old project start date

Returns

int 1 if OK or < 0 if KO

Definition at line 1983 of file project.class.php.

References $conf.

update()

Project::update	(		$user,
			$notrigger = 0 )

Update a project.

Parameters

User	$user	User object of making update
int	$notrigger	1=Disable all triggers

Returns

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

Definition at line 600 of file project.class.php.

References $conf, CommonObject\call_trigger(), description, dol_sanitizeFileName(), dol_strlen(), dol_syslog(), CommonObject\insertExtraFields(), price2num(), ref, and status.

update_element()

Project::update_element	(		$tableName,
			$elementSelectId )

Associate element to a project.

Parameters

string	$tableName	Table of the element to update
int	$elementSelectId	Key-rowid of the line of the element to update

Returns

int 1 if OK or < 0 if KO

Definition at line 2050 of file project.class.php.

References dol_syslog().

---

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

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