Class to manage ticket. More...
Inheritance diagram for Ticket:
Collaboration diagram for Ticket:
Public Member Functions | |
| __construct ($db) | |
| Constructor. More... | |
| create ($user, $notrigger=0) | |
| Create object into database. More... | |
| fetch ($id= '', $ref= '', $track_id= '', $email_msgid= '') | |
| Load object in memory from the database. More... | |
| fetchAll ($user, $sortorder= 'ASC', $sortfield= 't.datec', $limit= '', $offset=0, $arch= '', $filter= '') | |
| Load all objects in memory from database. More... | |
| update ($user=0, $notrigger=0) | |
| Update object into database. More... | |
| delete ($user, $notrigger=0) | |
| Delete object in database. More... | |
| createFromClone (User $user, $fromid) | |
| Load an object from its id and create a new one in database. More... | |
| initAsSpecimen () | |
| Initialise object with example values Id must be 0 if object instance is a specimen. More... | |
| printSelectStatus ($selected="") | |
| print selected status More... | |
| loadCacheTypesTickets () | |
| Charge dans cache la liste des types de tickets (paramétrable dans dictionnaire) More... | |
| loadCacheCategoriesTickets () | |
| Charge dans cache la liste des catégories de tickets (paramétrable dans dictionnaire) More... | |
| loadCacheSeveritiesTickets () | |
| Charge dans cache la liste des sévérité de tickets (paramétrable dans dictionnaire) More... | |
| getLibStatut ($mode=0) | |
| Return status label of object. More... | |
| LibStatut ($status, $mode=0, $notooltip=0) | |
| Return status label of object. More... | |
| getNomUrl ($withpicto=0, $option= '', $notooltip=0, $morecss= '', $save_lastsearch_value=-1) | |
| Return a link to the object card (with optionaly the picto) More... | |
| markAsRead ($user, $notrigger=0) | |
| Mark a message as read. More... | |
| assignUser ($user, $id_assign_user, $notrigger=0) | |
| Mark a message as read. More... | |
| loadCacheLogsTicket () | |
| Charge la liste des actions sur le ticket. More... | |
| createTicketMessage ($user, $notrigger=0, $filename_list=array(), $mimetype_list=array(), $mimefilename_list=array()) | |
| Add message into database. More... | |
| loadCacheMsgsTicket () | |
| Load the list of event on ticket into ->cache_msgs_ticket. More... | |
| close (User $user) | |
| Close a ticket. More... | |
| searchSocidByEmail ($email, $type= '0', $filters=array(), $clause= 'AND') | |
| Search and fetch thirparties by email. More... | |
| searchContactByEmail ($email, $socid= '', $case= '') | |
| Search and fetch contacts by email. More... | |
| setCustomer ($id) | |
| Define parent commany of current ticket. More... | |
| setProgression ($percent) | |
| Define progression of current ticket. More... | |
| setProject ($projectid) | |
| Link element with a project Override core function because of key name 'fk_project' used for this module. More... | |
| setContract ($contractid) | |
| Link element with a contract. More... | |
| getIdTicketInternalContact () | |
| Return id des contacts interne de suivi. More... | |
| getInfosTicketInternalContact () | |
| Retrieve informations about internal contacts. More... | |
| getIdTicketCustomerContact () | |
| Return id des contacts clients pour le suivi ticket. More... | |
| getInfosTicketExternalContact () | |
| Retrieve informations about external contacts. More... | |
| getIdTicketInternalInvolvedContact () | |
| Return id des contacts clients des intervenants. More... | |
| getIdTicketCustomerInvolvedContact () | |
| Return id des contacts clients des intervenants. More... | |
| getTicketAllContacts () | |
| Return id of all contacts for ticket. More... | |
| getTicketAllCustomerContacts () | |
| Return id of all contacts for ticket. More... | |
| messageSend ($subject, $texte) | |
| Send message. More... | |
| listeContact ($status=-1, $source= 'external', $list=0, $code= '') | |
| Get array of all contacts for a ticket Override method of file commonobject.class.php to add phone number. More... | |
| getDefaultRef ($thirdparty= '') | |
| Get a default reference. More... | |
| is_photo_available ($sdir) | |
| Return if at least one photo is available. More... | |
| copyFilesForTicket () | |
| Copy files defined into $_SESSION array into the ticket directory of attached files. More... | |
| newMessage ($user, &$action, $private=1, $public_area=0) | |
| Add new message on a ticket (private/public area). More... | |
| 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. More... | |
| load_board ($user, $mode) | |
| Load indicators for dashboard (this->nbtodo and this->nbtodolate) More... | |
| load_state_board () | |
| Load indicator this->nb of global stats widget. More... | |
| Public Member Functions inherited from CommonObject | |
| errorsToString () | |
| Method to output saved errors. More... | |
| getFormatedCustomerRef ($objref) | |
| Return customer ref for screen output. More... | |
| getFormatedSupplierRef ($objref) | |
| Return supplier ref for screen output. More... | |
| getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0) | |
| Return full name (civility+' '+name+' '+lastname) More... | |
| setUpperOrLowerCase () | |
| Set to upper or ucwords/lower if needed. More... | |
| getKanbanView ($option= '') | |
| Return clicable link of object (with eventually picto) More... | |
| getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode= '') | |
| Return full address of contact. More... | |
| getBannerAddress ($htmlkey, $object) | |
| Return full address for banner. More... | |
| getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0) | |
| Return the link of last main doc file for direct public download. More... | |
| add_contact ($fk_socpeople, $type_contact, $source= 'external', $notrigger=0) | |
| Add a link between element $this->element and a contact. More... | |
| copy_linked_contact ($objFrom, $source= 'internal') | |
| Copy contact from one element to current. More... | |
| update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0) | |
| Update a link to contact line. More... | |
| delete_contact ($rowid, $notrigger=0) | |
| Delete a link to contact line. More... | |
| delete_linked_contact ($source= '', $code= '') | |
| Delete all links between an object $this and all its contacts. More... | |
| liste_contact ($status=-1, $source= 'external', $list=0, $code= '') | |
| Get array of all contacts for an object. More... | |
| swapContactStatus ($rowid) | |
| Update status of a contact linked to object. More... | |
| liste_type_contact ($source= 'internal', $order= 'position', $option=0, $activeonly=0, $code= '') | |
| Return array with list of possible values for type of contacts. More... | |
| listeTypeContacts ($source= 'internal', $option=0, $activeonly=0, $code= '', $element= '', $excludeelement= '') | |
| Return array with list of possible values for type of contacts. More... | |
| getIdContact ($source, $code, $status=0) | |
| Return id of contacts for a source and a contact code. More... | |
| fetch_contact ($contactid=null) | |
| Load object contact with id=$this->contact_id into $this->contact. More... | |
| fetch_thirdparty ($force_thirdparty_id=0) | |
| Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More... | |
| fetchOneLike ($ref) | |
| Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More... | |
| fetch_barcode () | |
| Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More... | |
| fetch_projet () | |
| Load the project with id $this->fk_project into this->project. More... | |
| fetch_product () | |
| Load the product with id $this->fk_product into this->product. More... | |
| fetch_user ($userid) | |
| Load the user with id $userid into this->user. More... | |
| fetch_origin () | |
| Read linked origin object. More... | |
| fetchObjectFrom ($table, $field, $key, $element=null) | |
| Load object from specific field. More... | |
| getValueFrom ($table, $id, $field) | |
| Getter generic. More... | |
| setValueFrom ($field, $value, $table= '', $id=null, $format= '', $id_field= '', $fuser=null, $trigkey= '', $fk_user_field= 'fk_user_modif') | |
| Setter generic. More... | |
| load_previous_next_ref ($filter, $fieldid, $nodbprefix=0) | |
| Load properties id_previous and id_next by comparing $fieldid with $this->ref. More... | |
| getListContactId ($source= 'external') | |
| Return list of id of contacts of object. More... | |
| setProject ($projectid) | |
| Link element with a project. More... | |
| setPaymentMethods ($id) | |
| Change the payments methods. More... | |
| setMulticurrencyCode ($code) | |
| Change the multicurrency code. More... | |
| setMulticurrencyRate ($rate, $mode=1) | |
| Change the multicurrency rate. More... | |
| setPaymentTerms ($id) | |
| Change the payments terms. More... | |
| setTransportMode ($id) | |
| Change the transport mode methods. More... | |
| setRetainedWarrantyPaymentTerms ($id) | |
| Change the retained warranty payments terms. More... | |
| setDeliveryAddress ($id) | |
| Define delivery address. More... | |
| setShippingMethod ($shipping_method_id, $notrigger=false, $userused=null) | |
| Change the shipping method. More... | |
| setWarehouse ($warehouse_id) | |
| Change the warehouse. More... | |
| setDocModel ($user, $modelpdf) | |
| Set last model used by doc generator. More... | |
| setBankAccount ($fk_account, $notrigger=false, $userused=null) | |
| Change the bank account. More... | |
| line_order ($renum=false, $rowidorder= 'ASC', $fk_parent_line=true) | |
| Save a new position (field rang) for details lines. More... | |
| getChildrenOfLine ($id, $includealltree=0) | |
| Get children of line. More... | |
| line_up ($rowid, $fk_parent_line=true) | |
| Update a line to have a lower rank. More... | |
| line_down ($rowid, $fk_parent_line=true) | |
| Update a line to have a higher rank. More... | |
| updateRangOfLine ($rowid, $rang) | |
| Update position of line (rang) More... | |
| line_ajaxorder ($rows) | |
| Update position of line with ajax (rang) More... | |
| updateLineUp ($rowid, $rang) | |
| Update position of line up (rang) More... | |
| updateLineDown ($rowid, $rang, $max) | |
| Update position of line down (rang) More... | |
| getRangOfLine ($rowid) | |
| Get position of line (rang) More... | |
| getIdOfLine ($rang) | |
| Get rowid of the line relative to its position. More... | |
| line_max ($fk_parent_line=0) | |
| Get max value used for position of line (rang) More... | |
| update_ref_ext ($ref_ext) | |
| Update external ref of element. More... | |
| update_note ($note, $suffix= '') | |
| Update note of element. More... | |
| update_note_public ($note) | |
| Update public note (kept for backward compatibility) More... | |
| update_price ($exclspec=0, $roundingadjust= 'none', $nodatabaseupdate=0, $seller=null) | |
| Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More... | |
| add_object_linked ($origin=null, $origin_id=null) | |
| Add objects linked in llx_element_element. More... | |
| 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). More... | |
| updateObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '') | |
| Update object linked of a current object. More... | |
| deleteObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '', $rowid= '') | |
| Delete all links between an object $this. More... | |
| setStatut ($status, $elementId=null, $elementType= '', $trigkey= '') | |
| Set status of an object. More... | |
| getCanvas ($id=0, $ref= '') | |
| Load type of canvas of an object if it exists. More... | |
| getSpecialCode ($lineid) | |
| Get special code of a line. More... | |
| isObjectUsed ($id=0) | |
| Function to check if an object is used by others. More... | |
| hasProductsOrServices ($predefined=-1) | |
| Function to say how many lines object contains. More... | |
| getTotalDiscount () | |
| Function that returns the total amount HT of discounts applied for all lines. More... | |
| 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. More... | |
| setExtraParameters () | |
| Set extra parameters. More... | |
| formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir= '/core/tpl') | |
| Show add free and predefined products/services form. More... | |
| 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. More... | |
| 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) More... | |
| 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). More... | |
| 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). More... | |
| 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. More... | |
| delete_resource ($rowid, $element, $notrigger=0) | |
| Delete a link to resource line. More... | |
| __clone () | |
| Overwrite magic function to solve problem of cloning object that are kept as references. More... | |
| addThumbs ($file) | |
| Build thumb. More... | |
| getDefaultCreateValueFor ($fieldname, $alternatevalue=null) | |
| Return the default value to use for a field when showing the create form of object. More... | |
| call_trigger ($triggerName, $user) | |
| Call trigger based on this instance. More... | |
| 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. More... | |
| setValuesForExtraLanguages ($onlykey= '') | |
| Fill array_options property of object by extrafields value (using for data sent by forms) More... | |
| fetchNoCompute ($id) | |
| Function to make a fetch but set environment to avoid to load computed values before. More... | |
| 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. More... | |
| deleteExtraFields () | |
| Delete all extra fields values for the current object. More... | |
| insertExtraFields ($trigger= '', $userused=null) | |
| Add/Update all extra fields values for the current object. More... | |
| insertExtraLanguages ($trigger= '', $userused=null) | |
| Add/Update all extra fields values for the current object. More... | |
| updateExtraField ($key, $trigger=null, $userused=null) | |
| Update 1 extra field value for the current object. More... | |
| updateExtraLanguages ($key, $trigger=null, $userused=null) | |
| Update an extra language value for the current object. More... | |
| 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. More... | |
| showOutputField ($val, $key, $value, $moreparam= '', $keysuffix= '', $keyprefix= '', $morecss= '') | |
| Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More... | |
| showOptionals ($extrafields, $mode= 'view', $params=null, $keysuffix= '', $keyprefix= '', $onetrtd=0) | |
| Function to show lines of extrafields with output datas. More... | |
| getJSListDependancies ($type= '_extra') | |
| getRights () | |
| Returns the rights used for this class. More... | |
| defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0) | |
| Get buy price to use for margin calculation. More... | |
| show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0) | |
| Show photos of an object (nbmax maximum), into several columns. More... | |
| isDate ($info) | |
| Function test if type is date. More... | |
| isDuration ($info) | |
| Function test if type is duration. More... | |
| isInt ($info) | |
| Function test if type is integer. More... | |
| isFloat ($info) | |
| Function test if type is float. More... | |
| isText ($info) | |
| Function test if type is text. More... | |
| setVarsFromFetchObj (&$obj) | |
| Function to load data from a SQL pointer into properties of current object $this. More... | |
| createCommon (User $user, $notrigger=false) | |
| Create object into database. More... | |
| fetchCommon ($id, $ref=null, $morewhere= '') | |
| Load object in memory from the database. More... | |
| fetchLinesCommon ($morewhere= '') | |
| Load object in memory from the database. More... | |
| updateCommon (User $user, $notrigger=false) | |
| Update object into database. More... | |
| deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0) | |
| Delete object in database. More... | |
| deleteByParentField ($parentId=0, $parentField= '') | |
| Delete all child object from a parent ID. More... | |
| deleteLineCommon (User $user, $idline, $notrigger=false) | |
| Delete a line of object in database. More... | |
| setStatusCommon ($user, $status, $notrigger=0, $triggercode= '') | |
| Set to a status. More... | |
| initAsSpecimenCommon () | |
| Initialise object with example values Id must be 0 if object instance is a specimen. More... | |
| fetchComments () | |
| Load comments linked with current task. More... | |
| getNbComments () | |
| Return nb comments already posted. More... | |
| trimParameters ($parameters) | |
| Trim object parameters. More... | |
| getCategoriesCommon ($type_categ) | |
| Sets object to given categories. More... | |
| setCategoriesCommon ($categories, $type_categ) | |
| Sets object to given categories. More... | |
| cloneCategories ($fromId, $toId, $type= '') | |
| Copy related categories to another object. More... | |
| deleteEcmFiles ($mode=0) | |
| Delete related files of object in database. More... | |
Static Public Member Functions | |
| static | replaceThirdparty ($db, $origin_id, $dest_id) |
| Function used to replace a thirdparty id with another one. More... | |
| Static Public Member Functions inherited from CommonObject | |
| static | isExistingObject ($element, $id, $ref= '', $ref_ext= '') |
| Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch. More... | |
| static | commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0) |
| Function used to replace a thirdparty id with another one. More... | |
Public Attributes | |
| $subject | |
| var string Ticket subject | |
| $type_label | |
| Type label. | |
| $category_label | |
| Category label. | |
| $severity_label | |
| Severity label. | |
| $email_from | |
| Email from user. | |
| 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. More... | |
| Public Attributes inherited from CommonObject | |
| $projet | |
| $note | |
Private Member Functions | |
| verify () | |
| Check properties of ticket are ok (like ref, track_id, ...). More... | |
| sendLogByEmail ($user, $message) | |
| Send notification of changes by email. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from CommonObject | |
| commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null) | |
| Common function for all objects extending CommonObject for generating documents. More... | |
| isArray ($info) | |
| Function test if type is array. More... | |
| canBeNull ($info) | |
| Function test if field can be null. More... | |
| isForcedToNullIfZero ($info) | |
| Function test if field is forced to null if zero or empty. More... | |
| isIndex ($info) | |
| Function test if is indexed. More... | |
| setSaveQuery () | |
| Function to prepare a part of the query for insert. More... | |
| getFieldList () | |
| Function to concat keys of fields. More... | |
| quote ($value, $fieldsentry) | |
| Add quote to field value if necessary. More... | |
Detailed Description
Class to manage ticket.
Definition at line 36 of file ticket.class.php.
Constructor & Destructor Documentation
| Ticket::__construct | ( | $db | ) |
Constructor.
- Parameters
-
DoliDb $db Database handler
Definition at line 287 of file ticket.class.php.
References db.
Member Function Documentation
| Ticket::assignUser | ( | $user, | |
| $id_assign_user, | |||
$notrigger = 0 |
|||
| ) |
Mark a message as read.
- Parameters
-
User $user Object user int $id_assign_user ID of user assigned int $notrigger Disable trigger
- Returns
- int <0 if KO, 0=Nothing done, >0 if OK
Definition at line 1430 of file ticket.class.php.
References $resql, db, dol_clone(), and dol_syslog().
| Ticket::close | ( | User | $user | ) |
Close a ticket.
- Returns
- int <0 if KO, >0 if OK
Definition at line 1743 of file ticket.class.php.
References $resql, db, dol_now(), and dol_syslog().
| Ticket::copyFilesForTicket | ( | ) |
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.
- Returns
- array Array with final path/name/mime of files.
Definition at line 2434 of file ticket.class.php.
References db, dol_is_dir(), dol_mkdir(), dol_move(), dol_now(), dol_print_date(), image_format_supported(), and vignette().
| int Notify thirdparty at Ticket::create | ( | $user, | |
$notrigger = 0 |
|||
| ) |
Create object into database.
- Returns
- int <0 if KO, Id of created object if OK
Definition at line 406 of file ticket.class.php.
References $resql, CommonObject\call_trigger(), db, dol_now(), dol_strlen(), dol_syslog(), generate_random_id(), CommonObject\insertExtraFields(), and verify().
| Ticket::createFromClone | ( | User | $user, |
| $fromid | |||
| ) |
Load an object from its id and create a new one in database.
- Returns
- int New id of clone
Definition at line 1039 of file ticket.class.php.
References db.
| Ticket::createTicketMessage | ( | $user, | |
$notrigger = 0, |
|||
$filename_list = array(), |
|||
$mimetype_list = array(), |
|||
$mimefilename_list = array() |
|||
| ) |
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
- Returns
- int <0 if KO, >0 if OK
Definition at line 1628 of file ticket.class.php.
References db, dol_concatdesc(), and dol_now().
| Ticket::delete | ( | $user, | |
$notrigger = 0 |
|||
| ) |
Delete object in database.
- Returns
- int <0 if KO, >0 if OK
Definition at line 964 of file ticket.class.php.
References $resql, db, and dol_syslog().
| Ticket::fetch | ( | $id = '', |
|
$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 <0 if KO, >0 if OK
Definition at line 527 of file ticket.class.php.
References $resql, db, dol_print_error(), dol_syslog(), and CommonObject\fetch_optionals().
| Ticket::fetchAll | ( | $user, | |
$sortorder = 'ASC', |
|||
$sortfield = 't.datec', |
|||
$limit = '', |
|||
$offset = 0, |
|||
$arch = '', |
|||
$filter = '' |
|||
| ) |
Load all objects in memory from database.
- Parameters
-
User $user User for action string $sortorder Sort order string $sortfield Sort field int $limit page number int $offset Offset for query int $arch archive or not (not used) array $filter Filter for query output
- Returns
- int <0 if KO, >0 if OK
Definition at line 658 of file ticket.class.php.
References $resql, db, and dol_syslog().
| Ticket::getDefaultRef | ( | $thirdparty = '' | ) |
Get a default reference.
- Parameters
-
Societe $thirdparty Thirdparty
- Returns
- string Reference
Definition at line 2355 of file ticket.class.php.
References dol_buildpath(), and dol_include_once().
| Ticket::getIdTicketCustomerContact | ( | ) |
Return id des contacts clients pour le suivi ticket.
- Returns
- array Liste des id contacts suivi ticket
Definition at line 2055 of file ticket.class.php.
| Ticket::getIdTicketCustomerInvolvedContact | ( | ) |
Return id des contacts clients des intervenants.
- Returns
- array Liste des id contacts intervenants
Definition at line 2085 of file ticket.class.php.
| Ticket::getIdTicketInternalContact | ( | ) |
Return id des contacts interne de suivi.
- Returns
- array Liste des id contacts suivi ticket
Definition at line 2035 of file ticket.class.php.
| Ticket::getIdTicketInternalInvolvedContact | ( | ) |
Return id des contacts clients des intervenants.
- Returns
- array Liste des id contacts intervenants
Definition at line 2075 of file ticket.class.php.
| Ticket::getInfosTicketExternalContact | ( | ) |
Retrieve informations about external contacts.
- Returns
- array Array with datas : firstname, lastname, socid (-1 for internal users), email, code, libelle, status
Definition at line 2065 of file ticket.class.php.
| Ticket::getInfosTicketInternalContact | ( | ) |
Retrieve informations about internal contacts.
- Returns
- array Array with datas : firstname, lastname, socid (-1 for internal users), email, code, libelle, status
Definition at line 2045 of file ticket.class.php.
| 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 1251 of file ticket.class.php.
| Ticket::getNomUrl | ( | $withpicto = 0, |
|
$option = '', |
|||
$notooltip = 0, |
|||
$morecss = '', |
|||
$save_lastsearch_value = -1 |
|||
| ) |
Return a link to the object card (with optionaly 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 1316 of file ticket.class.php.
References $_SERVER, dol_buildpath(), img_object(), and img_picto().
| Ticket::getTicketAllContacts | ( | ) |
Return id of all contacts for ticket.
- Returns
- array Array of contacts for tickets
Definition at line 2095 of file ticket.class.php.
| Ticket::getTicketAllCustomerContacts | ( | ) |
Return id of all contacts for ticket.
- Returns
- array Array of contacts
Definition at line 2114 of file ticket.class.php.
| Ticket::initAsSpecimen | ( | ) |
Initialise object with example values Id must be 0 if object instance is a specimen.
- Returns
- int
Definition at line 1085 of file ticket.class.php.
| 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 2398 of file ticket.class.php.
References dol_is_file(), dol_osencode(), and utf8_check().
| Ticket::LibStatut | ( | $status, | |
$mode = 0, |
|||
$notooltip = 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
- Returns
- string Label
Definition at line 1266 of file ticket.class.php.
References dolGetStatus().
Referenced by ActionsTicket\viewStatusActions().
| Ticket::listeContact | ( | $status = -1, |
|
$source = 'external', |
|||
$list = 0, |
|||
$code = '' |
|||
| ) |
Get array of all contacts for a ticket Override method of file commonobject.class.php to add phone number.
- Parameters
-
int $status 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', ...)
- Returns
- array Array of contacts
Definition at line 2254 of file ticket.class.php.
References $resql, db, and dol_print_error().
| 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
- int <0 if KO, >0 if OK
Definition at line 2894 of file ticket.class.php.
References $resql, db, dol_now(), getEntity(), and img_object().
| Ticket::load_state_board | ( | ) |
Load indicator this->nb of global stats widget.
- Returns
- int <0 if ko, >0 if ok
Definition at line 2962 of file ticket.class.php.
References $resql, db, dol_print_error(), and getEntity().
| Ticket::loadCacheCategoriesTickets | ( | ) |
Charge dans cache la liste des catégories de tickets (paramétrable dans dictionnaire)
- Returns
- int Number of lines loaded, 0 if already loaded, <0 if KO
Definition at line 1168 of file ticket.class.php.
References $resql, db, dol_print_error(), and dol_syslog().
| Ticket::loadCacheLogsTicket | ( | ) |
Charge la liste des actions sur le ticket.
- Returns
- int Number of lines loaded, 0 if already loaded, <0 if KO
Definition at line 1580 of file ticket.class.php.
| 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 1700 of file ticket.class.php.
References $resql, db, and dol_syslog().
Referenced by ActionsTicket\viewTicketTimelineMessages().
| 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 1208 of file ticket.class.php.
References $resql, db, dol_print_error(), and dol_syslog().
| Ticket::loadCacheTypesTickets | ( | ) |
Charge dans cache la liste des types de tickets (paramétrable dans dictionnaire)
- Returns
- int Number of lines loaded, 0 if already loaded, <0 if KO
Definition at line 1128 of file ticket.class.php.
References $resql, db, dol_print_error(), and dol_syslog().
| Ticket::markAsRead | ( | $user, | |
$notrigger = 0 |
|||
| ) |
Mark a message as read.
- Parameters
-
User $user Object user int $notrigger No trigger
- Returns
- int <0 if KO, >0 if OK
Definition at line 1376 of file ticket.class.php.
References $resql, db, dol_now(), dol_syslog(), and statut.
| Ticket::messageSend | ( | $subject, | |
| $texte | |||
| ) |
Send message.
- Parameters
-
string $subject Subject string $texte Message to send
- Returns
- int <0 if KO, or number of changes if OK
Definition at line 2131 of file ticket.class.php.
References db, dol_mimetype(), dol_nl2br(), dol_now(), dol_print_error(), dol_strlen(), and dol_syslog().
| Ticket::newMessage | ( | $user, | |
| & | $action, | ||
$private = 1, |
|||
$public_area = 0 |
|||
| ) |
Add new message on a ticket (private/public area).
Can also send it be email if GETPOST('send_email', 'int') is set.
- Parameters
-
User $user User for action string $action Action string int $private 1=Message is private. TODO Implement this. What does this means ? int $public_area 1=Is the public area
- Returns
- int
Definition at line 2506 of file ticket.class.php.
References db, dol_buildpath(), dol_nl2br(), dol_textishtml(), dolGetFirstLastname(), GETPOST(), and setEventMessages().
| Ticket::printSelectStatus | ( | $selected = "" | ) |
print selected status
- Parameters
-
string $selected selected status
- Returns
- void
Definition at line 1117 of file ticket.class.php.
References print, and Form\selectarray().
|
static |
Function used to replace a thirdparty id with another one.
- Returns
- bool
Definition at line 3006 of file ticket.class.php.
References CommonObject\commonReplaceThirdparty().
| Ticket::searchContactByEmail | ( | $email, | |
$socid = '', |
|||
$case = '' |
|||
| ) |
Search and fetch contacts by email.
- Parameters
-
string $email Email array $socid Limit to a thirdparty string $case Respect case
- Returns
- array Array of contacts object
Definition at line 1886 of file ticket.class.php.
References db, and dol_syslog().
| 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 Array of thirdparties object
Definition at line 1820 of file ticket.class.php.
References db, and dol_syslog().
|
private |
Send notification of changes by email.
- Returns
- int <0 if KO, >0 if OK (number of emails sent)
Definition at line 1488 of file ticket.class.php.
References dol_buildpath(), dol_html_entity_decode(), dol_nl2br(), dolGetFirstLastname(), and setEventMessages().
| 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 ($conf->global->TICKET_NOTIFICATION_EMAIL_FROM) array $array_receiver Array of receiver. exemple array('name' => 'John Doe', 'email' => 'john@doe.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
- void
Definition at line 2819 of file ticket.class.php.
References dol_syslog(), and setEventMessages().
| Ticket::setContract | ( | $contractid | ) |
Link element with a contract.
- Parameters
-
int $contractid Contract id to link element to
- Returns
- int <0 if KO, >0 if OK
Definition at line 2011 of file ticket.class.php.
References db, dol_print_error(), and dol_syslog().
| Ticket::setCustomer | ( | $id | ) |
Define parent commany of current ticket.
- Parameters
-
int $id Id of thirdparty to set or '' to remove
- Returns
- int <0 if KO, >0 if OK
Definition at line 1930 of file ticket.class.php.
References $resql, db, and dol_syslog().
| Ticket::setProgression | ( | $percent | ) |
Define progression of current ticket.
- Parameters
-
int $percent Progression percent
- Returns
- int <0 if KO, >0 if OK
Definition at line 1954 of file ticket.class.php.
References $resql, db, and dol_syslog().
| Ticket::setProject | ( | $projectid | ) |
Link element with a project Override core function because of key name 'fk_project' used for this module.
- Parameters
-
int $projectid Project id to link element to
- Returns
- int <0 if KO, >0 if OK
Definition at line 1979 of file ticket.class.php.
References db, dol_print_error(), and dol_syslog().
| Ticket::update | ( | $user = 0, |
|
$notrigger = 0 |
|||
| ) |
Update object into database.
- Returns
- int <0 if KO, >0 if OK
Definition at line 823 of file ticket.class.php.
References $resql, db, and dol_syslog().
|
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 319 of file ticket.class.php.
References dol_syslog().
Referenced by create().
Member Data Documentation
| 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 '$conf->global->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 recommanded 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. 'arraykeyval' 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 252 of file ticket.class.php.
The documentation for this class was generated from the following file:
- htdocs/ticket/class/ticket.class.php