Ticket Class Reference

Class to manage ticket. More...

Inheritance diagram for Ticket:

Collaboration diagram for Ticket:

Public Member Functions
	__construct ($db)
	Constructor.
	checkExistingRef (string $action, string $getRef)
	Check if ref exists or not.
	create ($user, $notrigger=0)
	Create object into database.
	fetch ($id=0, $ref='', $track_id='', $email_msgid='')
	Load object in memory from the database.
	fetchAll ($user, $sortorder='ASC', $sortfield='t.datec', $limit=0, $offset=0, $arch=0, $filter='')
	Load all objects in memory from database.
	update ($user, $notrigger=0)
	Update object into database.
	delete ($user, $notrigger=0)
	Delete object in database.
	createFromClone (User $user, $fromid)
	Load an object from its id and create a new one in database.
	initAsSpecimen ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	printSelectStatus ($selected="")
	Print selected status.
	loadCacheTypesTickets ()
	Load into a cache the types of tickets (setup done into dictionaries)
	loadCacheCategoriesTickets ($publicgroup=-1)
	Load into a cache array, the list of ticket categories (setup done into dictionary)
	loadCacheSeveritiesTickets ()
	Charge dans cache la liste des sévérité de tickets (paramétrable dans dictionnaire)
	getLibStatut ($mode=0)
	Return status label of object.
	LibStatut ($status, $mode=0, $notooltip=0, $progress=0)
	Return status label of object.
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
	Return a link to the object card (with optionally the picto)
	markAsRead ($user, $notrigger=0)
	Mark a message as read.
	assignUser ($user, $id_assign_user, $notrigger=0)
	Set an assigned user to a ticket.
	createTicketMessage ($user, $notrigger=0, $filename_list=array(), $mimetype_list=array(), $mimefilename_list=array(), $send_email=false, $public_area=0)
	Add message into database.
	loadCacheMsgsTicket ()
	Load the list of event on ticket into ->cache_msgs_ticket.
	close (User $user, $mode=0)
	Close a ticket.
	searchSocidByEmail ($email, $type=0, $filters=array(), $clause='AND')
	Search and fetch thirparties by email.
	searchContactByEmail ($email, $socid=0, $case='')
	Search and fetch contacts by email.
	setCustomer ($id)
	Define parent commany of current ticket.
	setProgression ($percent)
	Define progression of current ticket.
	setContract ($contractid)
	Link element with a contract.
	getIdTicketInternalContact ()
	Return id des contacts interne de suivi.
	getInfosTicketInternalContact ($status=-1)
	Retrieve information about internal contacts.
	getIdTicketCustomerContact ()
	Return id des contacts clients pour le suivi ticket.
	getInfosTicketExternalContact ($status=-1)
	Retrieve information about external contacts.
	getIdTicketInternalInvolvedContact ()
	Return id des contacts clients des intervenants.
	getIdTicketCustomerInvolvedContact ()
	Return id des contacts clients des intervenants.
	getTicketAllContacts ()
	Return id of all contacts for ticket.
	getTicketAllCustomerContacts ()
	Return id of all contacts for ticket.
	listeContact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1)
	Get array of all contacts for a ticket Override method of file commonobject.class.php to add phone number.
	getDefaultRef ($thirdparty=null)
	Get a default reference.
	is_photo_available ($sdir)
	Return if at least one photo is available.
	copyFilesForTicket ($forcetrackid=null)
	Copy files defined into $_SESSION array into the ticket directory of attached files.
	setCategories ($categories)
	Sets object to supplied categories.
	newMessage ($user, &$action, $private=1, $public_area=0)
	Add new message on a ticket (private/public area).
	sendTicketMessageByEmail ($subject, $message, $send_internal_cc=0, $array_receiver=array(), $filename_list=array(), $mimetype_list=array(), $mimefilename_list=array())
	Send ticket by email to linked contacts.
	load_board ($user, $mode)
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)
	loadStateBoard ()
	Load indicator this->nb of global stats widget.
	getKanbanView ($option='', $arraydata=null)
	Return clicable link of object (with eventually picto)
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
	Create a document onto disk according to template module.
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.
	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.
	setSignedStatusCommon ($user, $status, $notrigger=0, $triggercode='')
	Set to a signed 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 ($db, $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
	$subject
	var string Ticket subject
	$type_label
	Type label.
	$category_label
	Category label.
	$severity_label
	Severity label.
	$email_from
	Email from user.
	$origin_replyto
	Email to reply to.
	$origin_references
	References from origin email.
const	STATUS_NOT_READ = 0
	Status.
	$fields
	'type' field format ('integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter]]', 'sellist:TableName:LabelFieldName[:KeyFieldName[:KeyFieldParent[:Filter]]]', 'varchar(x)', 'double(24,8)', 'real', 'price', 'text', 'text:none', 'html', 'date', 'datetime', 'timestamp', 'duration', 'mail', 'phone', 'url', 'password') Note: Filter can be a string like "(t.ref:like:'SO-%') or (t.date_creation:<:'20160101') or (t.nature:is:NULL)" 'label' the translation key.
Public Attributes inherited from CommonObject
	$origin_object

Private Member Functions
	verify ()
	Check properties of ticket are ok (like ref, track_id, ...).

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 ticket.

Definition at line 40 of file ticket.class.php.

Constructor & Destructor Documentation

__construct()

Ticket::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 343 of file ticket.class.php.

References getDolGlobalString().

Member Function Documentation

assignUser()

Ticket::assignUser	(		$user,
			$id_assign_user,
			$notrigger = 0 )

Set an assigned user to a ticket.

Parameters

User	$user	Object user
int	$id_assign_user	ID of user assigned
int	$notrigger	Disable trigger

Returns

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

Definition at line 1761 of file ticket.class.php.

References dol_clone(), and dol_syslog().

checkExistingRef()

Ticket::checkExistingRef	(	string	$action,
		string	$getRef )

Check if ref exists or not.

Parameters

string	$action	Action
string	$getRef	Reference of object

Returns

bool

Definition at line 477 of file ticket.class.php.

References ref.

close()

Ticket::close	(	User	$user,
			$mode = 0 )

Close a ticket.

Parameters

User	$user	User that close
int	$mode	0=Close solved, 1=Close abandoned

Returns

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

Definition at line 1984 of file ticket.class.php.

References dol_now(), dol_syslog(), getDolGlobalString(), and status.

copyFilesForTicket()

Ticket::copyFilesForTicket

(

$forcetrackid = null

)

Copy files defined into $_SESSION array into the ticket directory of attached files.

Used for files linked into messages. Files may be renamed during copy to avoid overwriting existing files.

Parameters

string

$forcetrackid

Force trackid used for $keytoavoidconflict into get_attached_files()

Returns

array|int Array with final path/name/mime of files.

Definition at line 2535 of file ticket.class.php.

References dirbasename(), dol_is_dir(), dol_mkdir(), dol_move(), dol_now(), dol_print_date(), image_format_supported(), and vignette().

create()

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

Create object into database.

Parameters

User	$user	User that creates
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 498 of file ticket.class.php.

References CommonObject\add_contact(), CommonObject\call_trigger(), dol_now(), dol_strlen(), dol_syslog(), generate_random_id(), getDolGlobalInt(), getDolGlobalString(), CommonObject\insertExtraFields(), isDolTms(), ref, status, and verify().

createFromClone()

Ticket::createFromClone	(	User	$user,
			$fromid )

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

Parameters

User	$user	User that clone
int	$fromid	Id of object to clone

Returns

int New id of clone

Definition at line 1259 of file ticket.class.php.

References $object.

createTicketMessage()

Ticket::createTicketMessage	(		$user,
			$notrigger = 0,
			$filename_list = array(),
			$mimetype_list = array(),
			$mimefilename_list = array(),
			$send_email = false,
			$public_area = 0 )

Add message into database.

Parameters

User	$user	User that creates
int	$notrigger	0=launch triggers after, 1=disable triggers
array	$filename_list	List of files to attach (full path of filename on file system)
array	$mimetype_list	List of MIME type of attached files
array	$mimefilename_list	List of attached file name in message
boolean	$send_email	Whether the message is sent by email
int	$public_area	0=Default, 1 if we are creating the message from a public area (so we can search contact from email to add it as contact of ticket if TICKET_ASSIGN_CONTACT_TO_MESSAGE is set)

Returns

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

Definition at line 1820 of file ticket.class.php.

References dol_mkdir(), dol_move(), dol_now(), getDolGlobalString(), getRandomPassword(), and setEventMessages().

delete()

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

Delete object in database.

Parameters

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

Returns

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

Definition at line 1159 of file ticket.class.php.

References dol_delete_dir_recursive(), dol_is_dir(), and dol_syslog().

fetch()

Ticket::fetch	(		$id = 0,
			$ref = '',
			$track_id = '',
			$email_msgid = '' )

Load object in memory from the database.

Parameters

int	$id	Id object
string	$ref	Ref
string	$track_id	Track id, a hash like ref
string	$email_msgid	Email msgid

Returns

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

Definition at line 661 of file ticket.class.php.

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

fetchAll()

Ticket::fetchAll	(		$user,
			$sortorder = 'ASC',
			$sortfield = 't.datec',
			$limit = 0,
			$offset = 0,
			$arch = 0,
			$filter = '' )

Load all objects in memory from database.

Parameters

User	$user	User for action
string	$sortorder	Sort order
string	$sortfield	Sort field
int	$limit	Limit
int	$offset	Offset page
int	$arch	Archive or not (not used)
string | array	$filter	Filter for query

Returns

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

Definition at line 804 of file ticket.class.php.

References dol_syslog(), and forgeSQLFromUniversalSearchCriteria().

generateDocument()

Ticket::generateDocument	(		$modele,
			$outputlangs,
			$hidedetails = 0,
			$hidedesc = 0,
			$hideref = 0,
			$moreparams = null )

Create a document onto disk according to template module.

Parameters

string	$modele	Force template to use ('' to not force)
Translate	$outputlangs	object lang a utiliser pour traduction
int	$hidedetails	Hide details of lines
int	$hidedesc	Hide description
int	$hideref	Hide ref
null | array	$moreparams	Array to provide more information

Returns

int 0 if KO, 1 if OK

Definition at line 3292 of file ticket.class.php.

References dol_strlen(), and getDolGlobalString().

getDefaultRef()

Ticket::getDefaultRef

(

$thirdparty = null

)

Get a default reference.

Parameters

Societe

$thirdparty

Thirdparty

Returns

string Reference

Definition at line 2458 of file ticket.class.php.

References dol_buildpath(), dol_include_once(), and getDolGlobalString().

getIdTicketCustomerContact()

Ticket::getIdTicketCustomerContact

(

)

Return id des contacts clients pour le suivi ticket.

Returns

array Liste des id contacts suivi ticket

Definition at line 2262 of file ticket.class.php.

getIdTicketCustomerInvolvedContact()

Ticket::getIdTicketCustomerInvolvedContact

(

)

Return id des contacts clients des intervenants.

Returns

array Liste des id contacts intervenants

Definition at line 2293 of file ticket.class.php.

getIdTicketInternalContact()

Ticket::getIdTicketInternalContact

(

)

Return id des contacts interne de suivi.

Returns

array Liste des id contacts suivi ticket

Definition at line 2241 of file ticket.class.php.

getIdTicketInternalInvolvedContact()

Ticket::getIdTicketInternalInvolvedContact

(

)

Return id des contacts clients des intervenants.

Returns

array Liste des id contacts intervenants

Definition at line 2283 of file ticket.class.php.

getInfosTicketExternalContact()

Ticket::getInfosTicketExternalContact

(

$status = -1

)

Retrieve information about external contacts.

Parameters

int

$status

Status of user or company

Returns

array Array with datas : firstname, lastname, socid (-1 for internal users), email, code, libelle, status

Definition at line 2273 of file ticket.class.php.

getInfosTicketInternalContact()

Ticket::getInfosTicketInternalContact

(

$status = -1

)

Retrieve information about internal contacts.

Parameters

int

$status

Status of user or company array<array{id:int,email:string,firstname:string,lastname:string,libelle:string}>

Returns

array<array{id:int,email:string,firstname:string,lastname:string,libelle:string,socid:int,code:string,status:int}> Array with datas : firstname, lastname, socid (-1 for internal users), email, code, libelle, status

Definition at line 2252 of file ticket.class.php.

getKanbanView()

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

Return clicable link of object (with eventually picto)

Parameters

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

Returns

string HTML Code for Kanban thumb.

Definition at line 3248 of file ticket.class.php.

References img_picto().

getLibStatut()

Ticket::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, 6=Long label + Picto

Returns

string Label

Definition at line 1488 of file ticket.class.php.

References status.

getNomUrl()

Ticket::getNomUrl	(		$withpicto = 0,
			$option = '',
			$notooltip = 0,
			$morecss = '',
			$save_lastsearch_value = -1 )

Return a link to the object card (with optionally the picto)

Parameters

int	$withpicto	Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
string	$option	On what the link point to ('nolink', ...)
int	$notooltip	1=Disable tooltip
string	$morecss	Add more css on link
int	$save_lastsearch_value	-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking

Returns

string String with URL

Definition at line 1618 of file ticket.class.php.

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

getTicketAllContacts()

Ticket::getTicketAllContacts

(

)

Return id of all contacts for ticket.

Returns

array Array of contacts for tickets

Definition at line 2303 of file ticket.class.php.

getTicketAllCustomerContacts()

Ticket::getTicketAllCustomerContacts

(

)

Return id of all contacts for ticket.

Returns

array Array of contacts

Definition at line 2323 of file ticket.class.php.

getTooltipContentArray()

Ticket::getTooltipContentArray

(

$params

)

getTooltipContentArray

Parameters

array

$params

ex option, infologin

Since

v18

Returns

array

Reimplemented from CommonObject.

Definition at line 1579 of file ticket.class.php.

References dol_print_date(), and img_picto().

initAsSpecimen()

Ticket::initAsSpecimen

(

)

Initialise object with example values Id must be 0 if object instance is a specimen.

Returns

int

Definition at line 1306 of file ticket.class.php.

References dol_now(), ref, and status.

is_photo_available()

Ticket::is_photo_available

(

$sdir

)

Return if at least one photo is available.

Parameters

string

$sdir

Directory to scan

Returns

boolean True if at least one photo is available, False if not

Definition at line 2499 of file ticket.class.php.

References dol_is_file(), dol_osencode(), and utf8_check().

LibStatut()

Ticket::LibStatut	(		$status,
			$mode = 0,
			$notooltip = 0,
			$progress = 0 )

Return status label of object.

Parameters

string	$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
int	$notooltip	1=No tooltip
int	$progress	Progression (0 to 100)

Returns

string Label

Definition at line 1504 of file ticket.class.php.

listeContact()

Ticket::listeContact	(		$statusoflink = -1,
			$source = 'external',
			$list = 0,
			$code = '',
			$status = -1 )

Get array of all contacts for a ticket Override method of file commonobject.class.php to add phone number.

Parameters

int	$statusoflink	Status of lines to get (-1=all)
string	$source	Source of contact: external or thirdparty (llx_socpeople) or internal (llx_user)
int	$list	0:Return array contains all properties, 1:Return array contains just id
string	$code	Filter on this code of contact type ('SHIPPING', 'BILLING', ...)
int	$status	Status of user or company

Returns

array<int|array{source:string,id:int,rowid:int,email:string,civility:string,firstname:string,lastname:string,labeltype:string,libelle:string,socid:int,code:string,status:int,statuscontact:string,fk_c_typecontact:string,phone:string,phone_mobile:string,nom:string}>|int<-1,-1> Array of array('email'=>..., 'lastname'=>...)

Definition at line 2346 of file ticket.class.php.

References dol_print_error().

load_board()

Ticket::load_board	(		$user,
			$mode )

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

Parameters

User	$user	Object user
int	$mode	"opened" for askprice to close, "signed" for proposal to invoice

Returns

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

Definition at line 3128 of file ticket.class.php.

References dol_now(), getEntity(), and img_object().

loadCacheCategoriesTickets()

Ticket::loadCacheCategoriesTickets

(

$publicgroup = -1

)

Load into a cache array, the list of ticket categories (setup done into dictionary)

Parameters

int

$publicgroup

0=No public group, 1=Public group only, -1=All

Returns

int Number of lines loaded, 0 if already loaded, <0 if KO

Definition at line 1392 of file ticket.class.php.

References dol_print_error(), and dol_syslog().

loadCacheMsgsTicket()

Ticket::loadCacheMsgsTicket

(

)

Load the list of event on ticket into ->cache_msgs_ticket.

Returns

int Number of lines loaded, 0 if already loaded, <0 if KO

Definition at line 1936 of file ticket.class.php.

References dol_syslog().

loadCacheSeveritiesTickets()

Ticket::loadCacheSeveritiesTickets

(

)

Charge dans cache la liste des sévérité de tickets (paramétrable dans dictionnaire)

Returns

int Number of lines loaded, 0 if already loaded, <0 if KO

Definition at line 1445 of file ticket.class.php.

References dol_print_error(), and dol_syslog().

loadCacheTypesTickets()

Ticket::loadCacheTypesTickets

(

)

Load into a cache the types of tickets (setup done into dictionaries)

Returns

int Number of lines loaded, 0 if already loaded, <0 if KO

Definition at line 1351 of file ticket.class.php.

References dol_print_error(), and dol_syslog().

loadStateBoard()

Ticket::loadStateBoard

(

)

Load indicator this->nb of global stats widget.

Returns

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

Definition at line 3194 of file ticket.class.php.

References dol_print_error(), and getEntity().

markAsRead()

Ticket::markAsRead	(		$user,
			$notrigger = 0 )

Mark a message as read.

Parameters

User	$user	Object user
int	$notrigger	No trigger

Returns

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

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

References dol_clone(), dol_now(), dol_syslog(), ref, and status.

newMessage()

Ticket::newMessage	(		$user,
		&	$action,
			$private = 1,
			$public_area = 0 )

Add new message on a ticket (private/public area).

Can also send it by email if GETPOST('send_email', 'int') is set. For such email, header and footer is added.

Parameters

User	$user	User for action
string	$action	Action string
int	$private	1=Message is private (must not be visible by external users)
int	$public_area	0=Default, 1=If we are creating the message from a public area, so confirmation email will be sent to the author and we can search contact from email to add it as contact of ticket if TICKET_ASSIGN_CONTACT_TO_MESSAGE is set

Returns

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

Definition at line 2662 of file ticket.class.php.

References $object, dol_buildpath(), dol_nl2br(), dol_now(), dol_textishtml(), dolGetFirstLastname(), getDolGlobalInt(), getDolGlobalString(), GETPOST(), GETPOSTINT(), and setEventMessages().

printSelectStatus()

Ticket::printSelectStatus

(

$selected = ""

)

Print selected status.

Parameters

string

$selected

Selected status

Returns

void

Definition at line 1340 of file ticket.class.php.

References Form\selectarray().

replaceThirdparty()

static Ticket::replaceThirdparty ( $db, $origin_id, $dest_id )

static

Function used to replace a thirdparty id with another one.

Parameters

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

Returns

bool

Definition at line 3234 of file ticket.class.php.

References CommonObject\commonReplaceThirdparty().

searchContactByEmail()

Ticket::searchContactByEmail	(		$email,
			$socid = 0,
			$case = '' )

Search and fetch contacts by email.

Parameters

string	$email	Email
int	$socid	Limit to a thirdparty
string	$case	Respect case

Returns

array|int Array of contacts object

Definition at line 2126 of file ticket.class.php.

References dol_syslog().

searchSocidByEmail()

Ticket::searchSocidByEmail	(		$email,
			$type = 0,
			$filters = array(),
			$clause = 'AND' )

Search and fetch thirparties by email.

Parameters

string	$email	Email
int	$type	Type of thirdparties (0=any, 1=customer, 2=prospect, 3=supplier)
array	$filters	Array of couple field name/value to filter the companies with the same name
string	$clause	Clause for filters

Returns

array|int Array of thirdparties object

Definition at line 2062 of file ticket.class.php.

References dol_syslog().

sendTicketMessageByEmail()

Ticket::sendTicketMessageByEmail	(		$subject,
			$message,
			$send_internal_cc = 0,
			$array_receiver = array(),
			$filename_list = array(),
			$mimetype_list = array(),
			$mimefilename_list = array() )

Send ticket by email to linked contacts.

Parameters

string	$subject	Email subject
string	$message	Email message
int	$send_internal_cc	Receive a copy on internal email (getDolGlobalString('TICKET_NOTIFICATION_EMAIL_FROM')
array	$array_receiver	Array of receiver. Example array('name' => 'John Doe', 'email' => 'john@.nosp@m.doe..nosp@m.com', etc...)
array	$filename_list	List of files to attach (full path of filename on file system)
array	$mimetype_list	List of MIME type of attached files
array	$mimefilename_list	List of attached file name in message

Returns

boolean True if mail sent to at least one receiver, false otherwise

Definition at line 3020 of file ticket.class.php.

References dol_syslog(), getDolGlobalString(), and setEventMessages().

setCategories()

Ticket::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 2614 of file ticket.class.php.

setContract()

Ticket::setContract

(

$contractid

)

Link element with a contract.

Parameters

int

$contractid

Contract id to link element to

Returns

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

Definition at line 2216 of file ticket.class.php.

References dol_syslog().

setCustomer()

Ticket::setCustomer

(

$id

)

Define parent commany of current ticket.

Parameters

int

$id

Id of thirdparty to set or '' to remove

Returns

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

Definition at line 2168 of file ticket.class.php.

References dol_syslog().

setProgression()

Ticket::setProgression

(

$percent

)

Define progression of current ticket.

Parameters

int

$percent

Progression percent

Returns

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

Definition at line 2192 of file ticket.class.php.

References dol_syslog().

update()

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

Update object into database.

Parameters

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

Returns

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

Definition at line 997 of file ticket.class.php.

References dol_strlen(), dol_syslog(), ref, and status.

verify()

Ticket::verify ( )

private

Check properties of ticket are ok (like ref, track_id, ...).

All properties must be already loaded on object (this->ref, this->track_id, ...).

Returns

int 0 if OK, <0 if KO

Definition at line 384 of file ticket.class.php.

References dol_strlen(), dol_syslog(), ref, and status.

Referenced by create().

Member Data Documentation

$fields

Ticket::$fields

'type' field format ('integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter]]', 'sellist:TableName:LabelFieldName[:KeyFieldName[:KeyFieldParent[:Filter]]]', 'varchar(x)', 'double(24,8)', 'real', 'price', 'text', 'text:none', 'html', 'date', 'datetime', 'timestamp', 'duration', 'mail', 'phone', 'url', 'password') Note: Filter can be a string like "(t.ref:like:'SO-%') or (t.date_creation:<:'20160101') or (t.nature:is:NULL)" 'label' the translation key.

'picto' is code of a picto to show before value in forms 'enabled' is a condition when the field must be managed (Example: 1 or 'getDolGlobalString('MY_SETUP_PARAM')) 'position' is the sort order of field. 'notnull' is set to 1 if not null in database. Set to -1 if we must set data to null if empty ('' or 0). 'visible' says if field is visible in list (Examples: 0=Not visible, 1=Visible on list and create/update/view forms, 2=Visible on list only, 3=Visible on create/update/view form only (not list), 4=Visible on list and update/view form only (not create). 5=Visible on list and view only (not create/not update). Using a negative value means field is not shown by default on list but can be selected for viewing) 'noteditable' says if field is not editable (1 or 0) 'default' is a default value for creation (can still be overwrote by the Setup of Default Values if field is editable in creation form). Note: If default is set to '(PROV)' and field is 'ref', the default value will be set to '(PROVid)' where id is rowid when a new record is created. 'index' if we want an index in database. 'foreignkey'=>'tablename.field' if the field is a foreign key (it is recommended to name the field fk_...). 'searchall' is 1 if we want to search in this field when making a search from the quick search button. 'isameasure' must be set to 1 if you want to have a total on list for this field. Field type must be summable like integer or double(24,8). 'css' and 'cssview' and 'csslist' is the CSS style to use on field. 'css' is used in creation and update. 'cssview' is used in view mode. 'csslist' is used for columns in lists. For example: 'maxwidth200', 'wordbreak', 'tdoverflowmax200' 'help' is a 'TranslationString' to use to show a tooltip on field. You can also use 'TranslationString:keyfortooltiponlick' for a tooltip on click. 'showoncombobox' if value of the field must be visible into the label of the combobox that list record 'disabled' is 1 if we want to have the field locked by a 'disabled' attribute. In most cases, this is never set into the definition of $fields into class, but is set dynamically by some part of code. 'arrayofkeyval' to set list of value if type is a list of predefined values. For example: array("0"=>"Draft","1"=>"Active","-1"=>"Cancel") 'autofocusoncreate' to have field having the focus on a create form. Only 1 field should have this property set to 1. 'comment' is not used. You can store here any text of your choice. It is not used by application.

Note: To have value dynamic, you can set value to 0 in definition and edit the value on the fly into the constructor.

Definition at line 301 of file ticket.class.php.

---

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

• dolibarr_dev/htdocs/ticket/class/ticket.class.php