diff --git a/htdocs/core/class/html.formticketsup.class.php b/htdocs/core/class/html.formticketsup.class.php index 0c10c256e83..52b470c0929 100644 --- a/htdocs/core/class/html.formticketsup.class.php +++ b/htdocs/core/class/html.formticketsup.class.php @@ -31,9 +31,11 @@ if (!class_exists('FormCompany')) { /** * Classe permettant la generation du formulaire d'un nouveau ticket. * - * Utilisation: $formticketsup = new FormTicketsup($db) - * $formticketsup->proprietes=1 ou chaine ou tableau de valeurs - * $formticketsup->show_form() affiche le formulaire + * @package Ticketsup + + * \remarks Utilisation: $formticketsup = new FormTicketsup($db) + * \remarks $formticketsup->proprietes=1 ou chaine ou tableau de valeurs + * \remarks $formticketsup->show_form() affiche le formulaire */ class FormTicketsup { @@ -72,6 +74,7 @@ class FormTicketsup public $withcancel; /** + * * @var array $substit Substitutions */ public $substit = array(); @@ -526,7 +529,7 @@ class FormTicketsup $filterarray = explode(',', $filtertype); } - $ticketstat->load_cache_categories_tickets(); + $ticketstat->loadCacheCategoriesTickets(); print ''; if ($empty) { diff --git a/htdocs/core/lib/ticketsup.lib.php b/htdocs/core/lib/ticketsup.lib.php index c3063783a6f..c8bfb006091 100644 --- a/htdocs/core/lib/ticketsup.lib.php +++ b/htdocs/core/lib/ticketsup.lib.php @@ -1,6 +1,6 @@ - * Copyright (C) 2013-2016 Jean-François FERRY +/* + * Copyright (C) 2013-2018 Jean-François FERRY * 2016 Christophe Battarel * * This program is free software: you can redistribute it and/or modify @@ -20,7 +20,13 @@ /** * \file core/lib/ticketsup.lib.php * \ingroup ticketsup - * \brief This file is an example module library + * \brief This file is a library for TicketSup module + */ + +/** + * Build tabs for admin page + * + * @return array */ function ticketsupAdminPrepareHead() { @@ -58,10 +64,9 @@ function ticketsupAdminPrepareHead() } /** - * Prepare head for ticket card - * - * @param Object $object Object Ticket - * @return array Array of tabs + * Build tabs for a Ticketsup object + * @param Ticketsup $object Ticketsup object + * @return array */ function ticketsup_prepare_head($object) { diff --git a/htdocs/ticketsup/card.php b/htdocs/ticketsup/card.php index 5d005063b8b..4b082945c4a 100644 --- a/htdocs/ticketsup/card.php +++ b/htdocs/ticketsup/card.php @@ -533,7 +533,7 @@ if ($action == 'view' || $action == 'add_message' || $action == 'close' || $acti $userstatic = new User($db); foreach (array('internal', 'external') as $source) { $tmpobject = $object->dao; - $tab = $tmpobject->liste_contact(-1, $source); + $tab = $tmpobject->listeContact(-1, $source); $num = count($tab); $i = 0; while ($i < $num) { diff --git a/htdocs/ticketsup/class/actions_ticketsup.class.php b/htdocs/ticketsup/class/actions_ticketsup.class.php index bc532619ce5..94ef7db5849 100644 --- a/htdocs/ticketsup/class/actions_ticketsup.class.php +++ b/htdocs/ticketsup/class/actions_ticketsup.class.php @@ -343,7 +343,7 @@ class ActionsTicketsup if ($ret) { // Si déjà un user assigné on le supprime des contacts if ($useroriginassign > 0) { - $internal_contacts = $this->dao->liste_contact(-1, 'internal'); + $internal_contacts = $this->dao->listeContact(-1, 'internal'); foreach ($internal_contacts as $key => $contact) { if ($contact['code'] == "SUPPORTTEC" && $contact['id'] == $useroriginassign) { @@ -475,7 +475,7 @@ class ActionsTicketsup // Set parent company if ($action == 'set_thirdparty' && $user->rights->societe->creer) { if ($this->fetch(GETPOST('id', 'int'), GETPOST('track_id', 'alpha')) >= 0) { - $result = $this->dao->set_customer(GETPOST('editcustomer', 'int')); + $result = $this->dao->setCustomer(GETPOST('editcustomer', 'int')); $url = 'card.php?action=view&track_id=' . GETPOST('track_id', 'alpha'); header("Location: " . $url); exit(); @@ -609,8 +609,8 @@ class ActionsTicketsup /** * Add new message on a ticket (private area) * - * @param User $user Object user - * @param string $action Action + * @param User $user + * @param string $action */ private function newMessage($user, &$action) { @@ -820,8 +820,8 @@ class ActionsTicketsup /** * Add new message on a ticket (public area) * - * @param User $user Object user - * @param string $action Action + * @param User $user + * @param string $action */ private function newMessagePublic($user, &$action) { @@ -964,9 +964,9 @@ class ActionsTicketsup /** * Fetch object * - * @param int $id Id - * @param int $track_id Track id - * @param string $ref Ref + * @param string $id + * @param string $track_id + * @param string $ref * @return void */ public function fetch($id = 0, $track_id = 0, $ref = '') @@ -977,8 +977,7 @@ class ActionsTicketsup /** * print statut - * - * @param int $mode Mode + * @param int $mode Display mode * @return void */ public function getLibStatut($mode = 0) @@ -989,10 +988,9 @@ class ActionsTicketsup } /** - * Get ticket info + * Get ticket info * - * @param int $id Object id - * @return void + * @param int $id Object id */ public function getInfo($id) { @@ -1004,10 +1002,9 @@ class ActionsTicketsup } /** - * Get action title + * Get action title * - * @param string $action Type of action - * @return string Label + * @param string $action Type of action */ public function getTitle($action = '') { @@ -1029,8 +1026,7 @@ class ActionsTicketsup /** * View html list of logs * - * @param boolean $show_user Show user who make action - * @return void + * @param boolean $show_user Show user who make action */ public function viewTicketLogs($show_user = true) { @@ -1092,8 +1088,7 @@ class ActionsTicketsup /** * View list of logs with timeline view * - * @param boolean $show_user Show user who make action - * @return void + * @param boolean $show_user Show user who make action */ public function viewTimelineTicketLogs($show_user = true) { @@ -1139,9 +1134,8 @@ class ActionsTicketsup /** * Show ticket original message * - * @param User $user Object user - * @param string $action Action - * @return void + * @param User $user $user wich display + * @param string $action Action mode */ public function viewTicketOriginalMessage($user, $action = '') { @@ -1196,9 +1190,8 @@ class ActionsTicketsup /** * View html list of message for ticket * - * @param boolean $show_private Show private messages - * @param boolean $show_user Show user who make action - * @return void + * @param boolean $show_private Show private messages + * @param boolean $show_user Show user who make action */ public function viewTicketMessages($show_private, $show_user = true) { @@ -1268,9 +1261,8 @@ class ActionsTicketsup /** * View list of message for ticket with timeline display * - * @param boolean $show_private Show private messages - * @param boolean $show_user Show user who make action - * @return void + * @param boolean $show_private Show private messages + * @param boolean $show_user Show user who make action */ public function viewTicketTimelineMessages($show_private, $show_user = true) { @@ -1419,12 +1411,12 @@ class ActionsTicketsup /** * Copy files into ticket directory + * * Used for files linked into messages - * - * @return void */ public function copyFilesForTicket() { + global $conf; // Create form object @@ -1466,9 +1458,8 @@ class ActionsTicketsup /** * Print html navbar with link to set ticket status - * $selected : 0=>'NotRead', 1=>'Read', 3=>'Answered', 4=>'Assigned', 5 => 'InProgress', 6=> 'Waiting', 8=>'Closed', 9=>'Deleted' - * - * @return void + * + * @global type $langs */ public function viewStatusActions() { @@ -1520,10 +1511,10 @@ class ActionsTicketsup /** * Hook to add email element template * - * @param array $parameters Parameters - * @param Object $object Object - * @param string $action Action - * @param HookManager $hookmanager Hookmanager + * @param array $parameters Parameters + * @param Ticketsup $object Object for action + * @param string $action Action string + * @param HookManager $hookmanager Hookmanager object * @return int */ public function emailElementlist($parameters, &$object, &$action, $hookmanager) diff --git a/htdocs/ticketsup/class/ticketsup.class.php b/htdocs/ticketsup/class/ticketsup.class.php index 531ebec308a..0dfe7907f71 100644 --- a/htdocs/ticketsup/class/ticketsup.class.php +++ b/htdocs/ticketsup/class/ticketsup.class.php @@ -533,14 +533,15 @@ class Ticketsup extends CommonObject /** * Load all objects in memory from database * - * @param User $user Object user - * @param string $sortorder Sort order - * @param string $sortfield Sort field - * @param int $limit page number - * @param int $offset Offset - * @param int $arch archive or not (not used) - * @param array $filter Filter - * @return int <0 if KO, >0 if OK + * @param User $user User for action + * @param string $sortorder Sort order + * @param string $sortfield Sort field + * @param int $limit page number + * @param int $offset Offset for query + * @param int $arch archive or not (not used) + * @param array $filter Filter for query + * output + * @return int <0 if KO, >0 if OK */ public function fetchAll($user, $sortorder = 'ASC', $sortfield = 't.datec', $limit = '', $offset = 0, $arch = '', $filter = '') { @@ -1052,7 +1053,7 @@ class Ticketsup extends CommonObject * * @return int Nb lignes chargees, 0 si deja chargees, <0 si ko */ - public function load_cache_categories_tickets() + public function loadCacheCategoriesTickets() { global $langs; @@ -1092,7 +1093,7 @@ class Ticketsup extends CommonObject * * @return int Nb lignes chargees, 0 si deja chargees, <0 si ko */ - public function load_cache_severities_tickets() + public function loadCacheSeveritiesTickets() { global $langs; @@ -1135,7 +1136,7 @@ class Ticketsup extends CommonObject */ public function getLibStatut($mode = 0) { - return $this->LibStatut($this->fk_statut, $mode); + return $this->libStatut($this->fk_statut, $mode); } /** @@ -1144,7 +1145,7 @@ class Ticketsup extends CommonObject * \param mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto * \return string Label */ - public function LibStatut($statut, $mode = 0) + public function libStatut($statut, $mode = 0) { global $langs; @@ -1289,11 +1290,10 @@ class Ticketsup extends CommonObject } /** - * Renvoie nom clicable (avec eventuellement le picto) - * - * @param int $withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul - * @param string $option Sur quoi pointe le lien - * @return string Chaine avec URL + * Return clckable link to object + * @param int $withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul + * @param string $option Where to point the link + * @return string */ public function getNomUrl($withpicto = 0, $option = '') { @@ -1326,10 +1326,11 @@ class Ticketsup extends CommonObject } /** - * Mark a message as read - * - * @param User $user Object user - * @return int <0 if KO, >0 if OK + * Mark a message as read + * + * @param User $user User for action + * @param int $notrigger Lauch trigger or not + * @return int 1 if ok, -1 otherwise */ public function markAsRead($user, $notrigger = 0) { @@ -1374,12 +1375,12 @@ class Ticketsup extends CommonObject } /** - * Mark a message as read - * - * @param User $user Object user - * @param int $id_assign_user ID of user assigned - * @param int $notrigger Disable trigger - * @return int <0 if KO, >0 if OK + * Assign ticket to an user + * + * @param User $user User for action + * @param int $id_assign_user IP user assigned + * @param int $notrigger Disable trigger if 1 + * @return number */ public function assignUser($user, $id_assign_user, $notrigger = 0) { @@ -1428,10 +1429,10 @@ class Ticketsup extends CommonObject * 1- create entry into database for message storage * 2- if trigger, send an email to ticket contacts * - * @param User $user User that create - * @param string $message Log message - * @param int $noemail 0=send email after, 1=disable emails - * @return int <0 if KO, >0 if OK + * @param User $user User that create + * @param string $message Log message + * @param int $noemail 0=send email after, 1=disable emails + * @return int <0 if KO, >0 if OK */ public function createTicketLog(User $user, $message, $noemail = 0) { @@ -1489,7 +1490,7 @@ class Ticketsup extends CommonObject * @param string $message Log message * @return int <0 if KO, >0 if OK (number of emails sent) */ - private function sendLogByEmail($user, $log_message) + private function sendLogByEmail($user, $message) { global $conf, $langs; @@ -1498,8 +1499,8 @@ class Ticketsup extends CommonObject $langs->load('ticketsup@ticketsup'); // Retrieve email of all contacts (internal and external) - $contacts = $this->liste_contact(-1, 'internal'); - $contacts = array_merge($contacts, $this->liste_contact(-1, 'external')); + $contacts = $this->listeContact(-1, 'internal'); + $contacts = array_merge($contacts, $this->listeContact(-1, 'external')); /* If origin_email and no socid, we add email to the list * */ if (!empty($this->origin_email) && empty($this->fk_soc)) { @@ -1914,7 +1915,7 @@ class Ticketsup extends CommonObject * @param int $id Id of thirdparty to set or '' to remove * @return int <0 if KO, >0 if OK */ - public function set_customer($id) + public function setCustomer($id) { if ($this->id) { $sql = "UPDATE " . MAIN_DB_PREFIX . "ticketsup"; @@ -2031,7 +2032,7 @@ class Ticketsup extends CommonObject */ public function getInfosTicketInternalContact() { - return $this->liste_contact(-1, 'internal'); + return $this->listeContact(-1, 'internal'); } /** @@ -2051,7 +2052,7 @@ class Ticketsup extends CommonObject */ public function getInfosTicketExternalContact() { - return $this->liste_contact(-1, 'external'); + return $this->listeContact(-1, 'external'); } /** @@ -2077,7 +2078,6 @@ class Ticketsup extends CommonObject /** * Return id of all contacts for ticket * - * @param int $exclude_self exclude_self Exclude current user form list */ public function getTicketAllContacts() { @@ -2096,7 +2096,6 @@ class Ticketsup extends CommonObject /** * Return id of all contacts for ticket * - * @param int $exclude_self exclude_self Exclude current user form list */ public function getTicketAllCustomerContacts() { @@ -2109,11 +2108,10 @@ class Ticketsup extends CommonObject } /** - * Check if contact are linked to the ticket. If yes, send mail and save trace into llx_notify. - * - * @param string $subject Subject - * @param string $texte Message to send - * @return int <0 if KO, or number of changes if OK + * Send message + * @param string $subject Subject for message + * @param string $texte Text for message + * @return int 1 if ok, -1 otherwise */ public function messageSend($subject, $texte) { @@ -2241,7 +2239,7 @@ class Ticketsup extends CommonObject * @param int $list 0:Return array contains all properties, 1:Return array contains just id * @return array Array of contacts */ - public function liste_contact($statut = -1, $source = 'external', $list = 0, $code = '') + public function listeContact($statut = -1, $source = 'external', $list = 0) { global $langs; @@ -2293,8 +2291,7 @@ class Ticketsup extends CommonObject } $sql .= " ORDER BY t.lastname ASC"; - //echo $sql; exit; - dol_syslog(get_class($this) . "::liste_contact sql=" . $sql); + $resql = $this->db->query($sql); if ($resql) { $num = $this->db->num_rows($resql);