|
dolibarr 25.0.0-alpha
|
Class to manage ticket. More...


Public Member Functions | |
| __construct (DoliDB $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 () | |
| Load into cache the list of ticket severities (configurable in the dictionary) | |
| 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. | |
| setReadDate ($user, $notrigger=0) | |
| Set read date if not already set. | |
| 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, $summary='', $external_contacts=[]) | |
| 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(), $array_receiver_cc=array(), $email_from='', $replyto='') | |
| 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 clickable 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. | |
| sendReminderForStaleTickets () | |
| Send an email to the assigned user when a non-closed ticket has gone too long without a reply. | |
Public Member Functions inherited from CommonObject | |
| 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. | |
| fetchWarehouse ($force_warehouse_id=0) | |
| Load the warehouse of object, from id $this->warehouse_id or $this->fk_warehouse, into this->warehouse. | |
| 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. | |
| setFieldValue (User $user, $fieldKey, $value, $byPassUserPermission=false) | |
| Set a value for a dynamic field on the current object. | |
| getFieldUiValue ($field) | |
| Return the value of a field of $fields, read in the property holding it (see getFieldPropertyName()). | |
| updateFieldFromUi (User $user, $field, $value) | |
| Update a field from the user interface (ajax edition of cards...) and save it into database. | |
| getFieldValueFromAjaxPost ($field) | |
| Return the value of a field posted by the user interface (ajax edition of fields). | |
| ajaxOutputField ($field) | |
| Return the output html of a field for the user interface (ajax edition of fields). | |
| ajaxInputField ($field) | |
| Return the input html of a field for the user interface (ajax edition of fields). | |
| 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. | |
| 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. | |
| roundQtyToPackaging ($qty, $packaging) | |
| Round a quantity up to the next multiple of a packaging quantity (options PRODUCT_USE_CUSTOMER_PACKAGING and PRODUCT_USE_SUPPLIER_PACKAGING). | |
| 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='') | |
| 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. | |
| getObjectLinesDisplayContext () | |
| Return the display context of the lines, as defined by the card of the object before printObjectLines() and formAddObjectLine(). | |
| initObjectLinesDisplay () | |
| Init the display of the lines: set the global variables used by the line templates (objectline_xxx.tpl.php) from getObjectLinesDisplayContext() To call in the card before printObjectLines() and formAddObjectLine(). | |
| getObjectLineHtml ($lineid, $action='') | |
| Return the HTML of a line as printed in the card by printObjectLines(), hooks printObjectLine and printObjectSubLine included. | |
| 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, $notrigger=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, $quality=50) | |
| 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. | |
| 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) Used for example when PDF_USE_ALSO_LANGUAGE_CODE is set to a language for the name of a thirdparty. | |
| 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 languages 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. | |
| getRightsForUser (User $user) | |
| Returns the rights used for this class for a specific user. | |
| hasUserPermission (User $user, $mode='write') | |
| Check if user has a permission on this type of object. | |
| hasUserWritePermissionOnField (User $user, $field) | |
| Check if user has write permission on a field of this object. | |
| hasUserPermissionOnField (User $user, $field, $mode='write') | |
| Check if user has a permission on a field of this object. | |
| isFieldEditAllowed (User $user, $field, $byPassUserPermission=false) | |
| Check whether a given field is allowed to be edited on the current object. | |
| isFieldEditableFromUi (User $user, $field) | |
| Check whether a field can be edited from the user interface with generic tools (ajax edition of cards...), where the user chooses the field to modify. | |
| isFieldReadableFromUi (User $user, $field) | |
| Check whether the value of a field can be read from the user interface with generic tools (ajax refresh of the values displayed on a card...), by a user allowed to read the object. | |
| defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0, $qty=0) | |
| Get buy price to use for margin calculation. | |
| getLinkedBuyPriceDocuments ($user, $lineid, $oldbuyprice=null) | |
| Return the linked proposals, orders and invoices having, for the product of a line of this object, a cost price different from the one saved on the line (for a purchase order, the average net unit price of the product on the ordered purchase orders linked to the same documents, weighted by the quantities). | |
| updateLinkedBuyPrice ($user, $lineid, $elements) | |
| Apply the cost price of a line of this object to the lines of the same product of some linked documents. | |
| 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. | |
| isLineOfObject ($lineid) | |
| Check that a line belongs to this object, using $this->table_element_line and $this->fk_element. | |
| 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. | |
| checkActiveProductInLines ($status='onsale') | |
| Check if all products have the right status (on sale, on buy) called during validation of propal, order, supplier proposal, supplier order. | |
| setErrorWithoutLog ($message) | |
| Set the error message for the object without logging it. | |
| setErrorWithLog ($message, $loglevel=LOG_ERR) | |
| Set the error message for the object and logs it, including the file name and line number. | |
| showLastFilePreview ($rootdir='', $relativepath='') | |
| Show preview link of the element (last generate or *<ref>*.pdf) if found and authorized to show the preview (file type) | |
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. | |
| static | commonReplaceContact (DoliDB $dbs, $origin_id, $dest_id, array $tables, $fieldname='fk_socpeople', $ignoreerrors=0) |
| Function used to replace a contact id with another one. | |
Public Attributes | |
| 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. | |
| onFieldValueChanged ($fieldKey, $value) | |
| Hook called by setFieldValue() after a field has been successfully assigned. | |
| getFieldPropertyName ($field) | |
| Return the name of the property of the object holding the value of a field of $fields. | |
| persistFieldValue (User $user, $field) | |
| Save into database the current value of one field, called by updateFieldFromUi(). | |
| prepareObjectLinesDisplay () | |
| Prepare the display of the lines: global $usemargins and line extrafields used by the line templates (objectline_xxx.tpl.php) Used by printObjectLines() and getObjectLineHtml() | |
| printObjectLineWithHooks ($action, $line, $num, $i, $dateSelector, $seller, $buyer, $selected, $extrafields, $defaulttpldir) | |
| Print a line of the lines table: hooks printObjectLine or printObjectSubLine, then printObjectLine() if no hook replaced it Used by printObjectLines() and getObjectLineHtml() | |
| commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null) | |
| Common function for all objects extending CommonObject for generating documents. | |
| isFieldDefined ($field) | |
| Check if the field is defined in the object's field metadata. | |
| isFieldDisabled ($field) | |
| Check if the field is explicitly marked as disabled. | |
| isFieldValidationRequired ($field) | |
| Check if the field requires validation. | |
| isFieldEnabled ($field) | |
| Check if the field is enabled. | |
| isFieldMarkedNotEditable ($field) | |
| Check if the field is explicitly marked as not editable. | |
| isFieldBlockedByObjectState ($field) | |
| Check if the field is blocked by the current object state. | |
| 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. | |
Class to manage ticket.
Definition at line 41 of file ticket.class.php.
| Ticket::__construct | ( | DoliDB | $db | ) |
Constructor.
Reimplemented in WebPortalTicket.
Definition at line 334 of file ticket.class.php.
References getDolGlobalString().
| Ticket::assignUser | ( | $user, | |
| $id_assign_user, | |||
| $notrigger = 0 ) |
Set an assigned user to a ticket.
| User | $user | Object user |
| int | $id_assign_user | ID of user assigned |
| int<0,1> | $notrigger Disable trigger |
Definition at line 1906 of file ticket.class.php.
References dol_clone(), dol_syslog(), and getDolGlobalString().
| Ticket::checkExistingRef | ( | string | $action, |
| string | $getRef ) |
Check if ref exists or not.
| string | $action | Action |
| string | $getRef | Reference of object |
Definition at line 470 of file ticket.class.php.
References ref.
| Ticket::close | ( | User | $user, |
| $mode = 0 ) |
Close a ticket.
Definition at line 2165 of file ticket.class.php.
References dol_clone(), dol_now(), dol_syslog(), getDolGlobalString(), isModEnabled(), and status.
| 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.
| string | $forcetrackid | Force trackid used for $keytoavoidconflict into get_attached_files() |
Definition at line 2741 of file ticket.class.php.
References $conf, dirbasename(), dol_is_dir(), dol_mkdir(), dol_move(), dol_now(), dol_print_date(), image_format_supported(), and vignette().
| Ticket::create | ( | $user, | |
| $notrigger = 0 ) |
Create object into database.
Definition at line 491 of file ticket.class.php.
References $conf, $id, CommonObject\add_contact(), dol_now(), dol_strlen(), dol_syslog(), generate_random_id(), getDolGlobalInt(), getDolGlobalString(), CommonObject\insertExtraFields(), isDolTms(), ref, setEntity(), status, and verify().
| Ticket::createFromClone | ( | User | $user, |
| $fromid ) |
Load an object from its id and create a new one in database.
Definition at line 1270 of file ticket.class.php.
References $object, and generate_random_id().
| Ticket::createTicketMessage | ( | $user, | |
| $notrigger = 0, | |||
| $filename_list = array(), | |||
| $mimetype_list = array(), | |||
| $mimefilename_list = array(), | |||
| $send_email = false, | |||
| $public_area = 0, | |||
| $summary = '', | |||
| $external_contacts = [] ) |
Add message into database.
| User | $user | User that creates |
| int<0,1> | $notrigger 0=launch triggers after, 1=disable triggers | |
| string[] | $filename_list | List of files to attach (full path of filename on file system) |
| string[] | $mimetype_list | List of MIME type of attached files |
| string[] | $mimefilename_list | List of attached file name in message |
| bool | $send_email | Whether the message is sent by email |
| int<0,1> | $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) | |
| string | $summary | ''=Default means using subject, else insert the summary as label |
| array<int,array{id:int,mandatory:int<0,1>,answer_status:int,transparency:int<0,1>}|int> | $external_contacts List of external contacts associated with the ticket |
Definition at line 1971 of file ticket.class.php.
References $conf, $id, dol_now(), and getDolGlobalString().
| Ticket::delete | ( | $user, | |
| $notrigger = 0 ) |
Delete object in database.
Definition at line 1172 of file ticket.class.php.
References dol_delete_dir_recursive(), dol_is_dir(), and dol_syslog().
| Ticket::fetch | ( | $id = 0, | |
| $ref = '', | |||
| $track_id = '', | |||
| $email_msgid = '' ) |
Load object in memory from the database.
| int | $id | Id object |
| string | $ref | Ref |
| string | $track_id | Track id, a hash like ref |
| string | $email_msgid | Email msgid |
Definition at line 660 of file ticket.class.php.
References $id, dol_syslog(), CommonObject\fetch_optionals(), ref, and status.
| Ticket::fetchAll | ( | $user, | |
| $sortorder = 'ASC', | |||
| $sortfield = 't.datec', | |||
| $limit = 0, | |||
| $offset = 0, | |||
| $arch = 0, | |||
| $filter = '' ) |
Load all objects in memory from database.
| 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<string,int> | $filter Filter for query |
Definition at line 808 of file ticket.class.php.
References dol_syslog(), and forgeSQLFromUniversalSearchCriteria().
| Ticket::generateDocument | ( | $modele, | |
| $outputlangs, | |||
| $hidedetails = 0, | |||
| $hidedesc = 0, | |||
| $hideref = 0, | |||
| $moreparams = null ) |
Create a document onto disk according to template module.
| string | $modele | Force template to use ('' to not force) |
| Translate | $outputlangs | object lang a utiliser pour traduction |
| int<0,1> | $hidedetails Hide details of lines | |
| int<0,1> | $hidedesc Hide description | |
| int<0,1> | $hideref Hide ref | |
| ?array<string,mixed> | $moreparams Array to provide more information |
Definition at line 3708 of file ticket.class.php.
References dol_strlen(), and getDolGlobalString().
| Ticket::getDefaultRef | ( | $thirdparty = null | ) |
Get a default reference.
| Societe | $thirdparty | Thirdparty |
Definition at line 2665 of file ticket.class.php.
References $conf, dol_buildpath(), dol_include_once(), and getDolGlobalString().
| Ticket::getIdTicketCustomerContact | ( | ) |
Return id des contacts clients pour le suivi ticket.
Definition at line 2468 of file ticket.class.php.
| Ticket::getIdTicketCustomerInvolvedContact | ( | ) |
Return id des contacts clients des intervenants.
Definition at line 2499 of file ticket.class.php.
| Ticket::getIdTicketInternalContact | ( | ) |
Return id des contacts interne de suivi.
Definition at line 2447 of file ticket.class.php.
| Ticket::getIdTicketInternalInvolvedContact | ( | ) |
Return id des contacts clients des intervenants.
Definition at line 2489 of file ticket.class.php.
| Ticket::getInfosTicketExternalContact | ( | $status = -1 | ) |
Retrieve information about external contacts.
| int | $status | Status of user or company |
Definition at line 2479 of file ticket.class.php.
| Ticket::getInfosTicketInternalContact | ( | $status = -1 | ) |
Retrieve information about internal contacts.
| int | $status | Status of user or company array<array{id:int,email:string,firstname:string,lastname:string,libelle:string}> |
Definition at line 2458 of file ticket.class.php.
| Ticket::getKanbanView | ( | $option = '', | |
| $arraydata = null ) |
Return clickable link of object (with eventually picto)
| string | $option | Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link) |
| ?array<string,mixed> | $arraydata Array of data |
Definition at line 3664 of file ticket.class.php.
| Ticket::getLibStatut | ( | $mode = 0 | ) |
Return status label of object.
| 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 |
Definition at line 1560 of file ticket.class.php.
References status.
| Ticket::getNomUrl | ( | $withpicto = 0, | |
| $option = '', | |||
| $notooltip = 0, | |||
| $morecss = '', | |||
| $save_lastsearch_value = -1 ) |
Return a link to the object card (with optionally the picto)
| 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 |
Definition at line 1696 of file ticket.class.php.
References $conf, $id, dolBuildUrl(), getDolGlobalInt(), and getDolGlobalString().
| Ticket::getTicketAllContacts | ( | ) |
Return id of all contacts for ticket.
Definition at line 2509 of file ticket.class.php.
| Ticket::getTicketAllCustomerContacts | ( | ) |
Return id of all contacts for ticket.
Definition at line 2527 of file ticket.class.php.
| Ticket::getTooltipContentArray | ( | $params | ) |
getTooltipContentArray
| array<string,mixed> | $params params to construct tooltip data |
Reimplemented from CommonObject.
Definition at line 1657 of file ticket.class.php.
References dol_print_date(), and isModEnabled().
| Ticket::initAsSpecimen | ( | ) |
Initialise object with example values Id must be 0 if object instance is a specimen.
Definition at line 1330 of file ticket.class.php.
| Ticket::is_photo_available | ( | $sdir | ) |
Return if at least one photo is available.
| string | $sdir | Directory to scan |
Definition at line 2708 of file ticket.class.php.
References dol_is_file(), dol_osencode(), and utf8_check().
| Ticket::LibStatut | ( | $status, | |
| $mode = 0, | |||
| $notooltip = 0, | |||
| $progress = 0 ) |
Return status label of object.
| 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 |
| int | $notooltip | 1=No tooltip |
| int | $progress | Progression (0 to 100) |
Definition at line 1576 of file ticket.class.php.
| 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.
| 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 |
Definition at line 2550 of file ticket.class.php.
| Ticket::load_board | ( | $user, | |
| $mode ) |
Load indicators for dashboard (this->nbtodo and this->nbtodolate)
| User | $user | Object user |
| 'opened'|'signed' | $mode "opened" for askprice to close, "signed" for proposal to invoice |
Definition at line 3547 of file ticket.class.php.
References dol_now(), getEntity(), and isModEnabled().
| Ticket::loadCacheCategoriesTickets | ( | $publicgroup = -1 | ) |
Load into a cache array, the list of ticket categories (setup done into dictionary)
| int<-1,1> | $publicgroup 0=No public group, 1=Public group only, -1=All |
Definition at line 1430 of file ticket.class.php.
References $conf, and dol_syslog().
| Ticket::loadCacheMsgsTicket | ( | ) |
Load the list of event on ticket into ->cache_msgs_ticket.
Definition at line 2116 of file ticket.class.php.
References dol_syslog().
| Ticket::loadCacheSeveritiesTickets | ( | ) |
Load into cache the list of ticket severities (configurable in the dictionary)
Definition at line 1500 of file ticket.class.php.
References $conf, and dol_syslog().
| Ticket::loadCacheTypesTickets | ( | ) |
Load into a cache the types of tickets (setup done into dictionaries)
Definition at line 1375 of file ticket.class.php.
References dol_syslog().
| Ticket::loadStateBoard | ( | ) |
Load indicator this->nb of global stats widget.
Definition at line 3610 of file ticket.class.php.
References getEntity().
| Ticket::markAsRead | ( | $user, | |
| $notrigger = 0 ) |
Mark a message as read.
| User | $user | Object user |
| int | $notrigger | No trigger |
Definition at line 1782 of file ticket.class.php.
References dol_clone(), dol_now(), dol_syslog(), ref, and status.
| 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.
| 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 |
Definition at line 2875 of file ticket.class.php.
References $id, $mysoc, $object, dol_buildpath(), dol_nl2br(), dol_now(), dol_syslog(), dol_textishtml(), dolGetFirstLastname(), getDolGlobalInt(), getDolGlobalString(), GETPOST(), GETPOSTINT(), and GETPOSTISSET().
| Ticket::printSelectStatus | ( | $selected = "" | ) |
Print selected status.
| string | $selected | Selected status |
Definition at line 1364 of file ticket.class.php.
References Form\selectarray().
|
static |
Function used to replace a thirdparty id with another one.
Definition at line 3650 of file ticket.class.php.
References CommonObject\commonReplaceThirdparty().
| Ticket::searchContactByEmail | ( | $email, | |
| $socid = 0, | |||
| $case = '' ) |
Search and fetch contacts by email.
| string | ||
| int | $socid | Limit to a thirdparty |
| string | $case | Respect case |
Definition at line 2309 of file ticket.class.php.
References dol_syslog().
| Ticket::searchSocidByEmail | ( | $email, | |
| $type = 0, | |||
| $filters = array(), | |||
| $clause = 'AND' ) |
Search and fetch thirparties by email.
| string | ||
| int<0,3> | $type Type of thirdparties (0=any, 1=customer, 2=prospect, 3=supplier) | |
| array<string,mixed> | $filters Array of couple field name/value to filter the companies with the same name | |
| string | $clause | Clause for filters |
Definition at line 2245 of file ticket.class.php.
References dol_syslog().
| Ticket::sendReminderForStaleTickets | ( | ) |
Send an email to the assigned user when a non-closed ticket has gone too long without a reply.
CAN BE A CRON TASK
The "too long" thresholds are the same ones already used to show the "Late" warning icon on the ticket list (TICKET_DELAY_BEFORE_FIRST_RESPONSE and TICKET_DELAY_SINCE_LAST_RESPONSE, both in hours): this method does not add new setup, it just acts by email on what that existing warning already detects. A ticket is only ever reminded once per calendar day (same dedup convention as the other automated reminder emails in the application, via the AC_EMAIL agenda event it logs on success), so it keeps being reminded once a day for as long as it stays late, which is the point of an escalation. A failure on one ticket (ex: no email template found, assigned user has no email) is counted and does not prevent the other late tickets from being processed.
Definition at line 3745 of file ticket.class.php.
References $conf, complete_substitutions_array(), dol_get_first_hour(), dol_now(), getDolGlobalInt(), getDolGlobalString(), isModEnabled(), and make_substitutions().
| Ticket::sendTicketMessageByEmail | ( | $subject, | |
| $message, | |||
| $send_internal_cc = 0, | |||
| $array_receiver = array(), | |||
| $filename_list = array(), | |||
| $mimetype_list = array(), | |||
| $mimefilename_list = array(), | |||
| $array_receiver_cc = array(), | |||
| $email_from = '', | |||
| $replyto = '' ) |
Send ticket by email to linked contacts.
| string | $subject | Email subject |
| string | $message | Email message |
| int<0,1> | $send_internal_cc Receive a copy on internal email at getDolGlobalString('TICKET_NOTIFICATION_EMAIL_FROM') | |
| array<string> | $array_receiver Array of receiver. Example array('name' => 'John Doe', 'email' => 'john@.nosp@m.doe..nosp@m.com', etc...) | |
| string[] | $filename_list | List of files to attach (full path of filename on file system) |
| string[] | $mimetype_list | List of MIME type of attached files |
| string[] | $mimefilename_list | List of attached file name in message |
| array<string> | $array_receiver_cc Array of receiver in CC. Example array('john@.nosp@m.doe..nosp@m.com') | |
| string | $email_from | Email from |
| string | $replyto | Reply to |
Definition at line 3406 of file ticket.class.php.
References $conf, dol_syslog(), and getDolGlobalString().
| 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.
| int[] | int | $categories | Category or categories IDs |
Definition at line 2827 of file ticket.class.php.
References $c.
| Ticket::setContract | ( | $contractid | ) |
Link element with a contract.
| int | $contractid | Contract id to link element to |
Definition at line 2422 of file ticket.class.php.
References dol_syslog().
| Ticket::setCustomer | ( | $id | ) |
Define parent commany of current ticket.
| int | $id | Id of thirdparty to set or '' to remove |
Definition at line 2351 of file ticket.class.php.
References $id, and dol_syslog().
| Ticket::setProgression | ( | $percent | ) |
Define progression of current ticket.
| int | $percent | Progression percent |
Definition at line 2398 of file ticket.class.php.
References dol_syslog().
| Ticket::setReadDate | ( | $user, | |
| $notrigger = 0 ) |
Set read date if not already set.
Definition at line 1847 of file ticket.class.php.
References dol_clone(), dol_now(), and dol_syslog().
| Ticket::update | ( | $user, | |
| $notrigger = 0 ) |
Update object into database.
Definition at line 1005 of file ticket.class.php.
References dol_syslog(), getDolGlobalInt(), ref, and status.
|
private |
Check properties of ticket are ok (like ref, track_id, ...).
All properties must be already loaded on object (this->ref, this->track_id, ...).
Definition at line 375 of file ticket.class.php.
References dol_syslog(), getDolGlobalInt(), ref, and status.
Referenced by create().
| 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 overwritten by the Setup of Default Values if the 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 290 of file ticket.class.php.