ssi_shd_called()
ssi_shd_called()
Makes SMF hook system happy that it has a function to call for SSI.
SimpleDesk API
Navigation
Search
sd_sourceSimpleDesk-SSI.php
This file handles data gathering primarily for SSI.php purposes. It expects Subs-SimpleDesk.php to have been required as this will still be needed for helpdesk permissions checks and base functions.
The function names imply who is expected to be the target, ssi_user functions are those intended for users, ssi_staff for staff members, such as ssi_userTickets() is primarily for displaying the tickets started by a given user, ssi_staffAssignedTickets() for all the tickets assigned to a given member of staff.
No support for displaying these through SHTML is provided, nor is any planned.
Unlike other SimpleDesk functions, these use a SSI style camel casing.
Functions
ssi_userTickets()
ssi_userTickets(integer $started_by, $dept = array(), integer $limit = 10, string $output_method = 'echo') : array
Gets a list of the tickets currently open that are a given user's (subject to ticket visibility).
Parameters
| integer | $started_by | The user id whose tickets you want to examine, defaults to the current user. @param int $dept An array of department ids whose tickets you want to examine, defaults to all departments. |
| $dept | ||
| integer | $limit | The number of tickets to limit to, default 10. |
| string | $output_method | Set to 'echo' for displaying content, set to 'array' to simply return data. |
Returns
array —An array of data, more details under the underlying function {@link ssi_getSDTickets()}
ssi_staffAssignedTickets()
ssi_staffAssignedTickets(integer $assignee, $dept = array(), integer $limit = 10, string $output_method = 'echo') : array
Gets a list of the tickets currently open that are assigned to the current user (presumably staff, subject to ticket visibility).
Parameters
| integer | $assignee | The user id whose tickets whose assigned tickets you want to examine, defaults to the current user. @param int $dept An array of department ids whose tickets you want to examine, defaults to all departments. |
| $dept | ||
| integer | $limit | The number of tickets to limit to, default 10. |
| string | $output_method | Set to 'echo' for displaying content, set to 'array' to simply return data. |
Returns
array —An array of data, more details under the underlying function {@link ssi_getSDTickets()}
ssi_staffTicketsUrgency()
ssi_staffTicketsUrgency(integer $urgency, $dept = array(), integer $limit = 10, string $output_method = 'echo') : array
Gets a list of all tickets based on urgency criteria given (subject to ticket visibility)
Parameters
| integer | $urgency | The urgency of tickets you want to get. @param int $dept An array of department ids whose tickets you want to examine, defaults to all departments. |
| $dept | ||
| integer | $limit | The number of tickets to limit to, default 10. |
| string | $output_method | Set to 'echo' for displaying content, set to 'array' to simply return data. |
Returns
array —An array of data, more details under the underlying function {@link ssi_getSDTickets()}
ssi_getSDTickets()
ssi_getSDTickets(string $query_where, array $query_where_params = array(), integer $query_limit, string $query_order = 'hdt.id_ticket ASC', $output_method = 'echo') : array
Gets tickets based on supplied criteria; this is a helper function not really intended to be called directly.
Parameters
| string | $query_where | SQL clauses to be supplied to the query in addition to {query_see_ticket} - note 'AND' is not required at the start. |
| array | $query_where_params | Key/value associative array to be injected into the query, related to $query_where. |
| integer | $query_limit | Number of items to limit the query to. |
| string | $query_order | The clause to order tickets by, defaults to tickets by order of creation. |
| $output_method |
Returns
array —An array of arrays, each primary item containing the following:
- id: Main ticket id
- display_id: Formatted ticket id in [0000x] format
- subject: Ticket subject
- short_subject: Shortened version of ticket subject
- href: Ticket href
- opener: array of details about the ticket starter:
- id: user id of the person who opened the ticket
- name: username of the person who opened the ticket
- link: link to the profile of the person who opened the ticket
- replier: array of details about the last person to reply to the ticket:
- id: user id of the last person to reply to the ticket
- name: username of the last person to reply to the ticket
- link: link to the profile of the last person to reply to the ticket
- assigned: array of details about the person who the ticket is assigned to:
- id: user id of the person who the ticket is assigned to
- name: username of the person who the ticket is assigned to or 'Unassigned' otherwise
- link: link to the profile of the person who the ticket is assigned to or 'Unassigned' otherwise
- num_replies: Number of replies in the ticket
- start_time: Formatted string of time the ticket was opened
- start_timestamp: Raw timestamp (adjusted for timezones) of ticket being opened
- last_time: Formatted string of time the ticket was last replied to
- last_timestamp: Raw timestamp (adjusted for timezones) of ticket's last reply
- private: Whether the ticket is private or not
- urgency_id: Number representing ticket urgency
- urgency_string: String representing ticket urgency
- status_id: Number representing ticket status
- status_text: String representing ticket status
- department: Number representing ticket department ID
ssi_staffMembers()
ssi_staffMembers(boolean $honour_admin_setting = true, string $output_method = 'echo') : array
Gets a list of all staff members within the helpdesk.
Parameters
| boolean | $honour_admin_setting | Within the administration panel is the option to exclude forum admins from being considered staff (so can't assign tickets to them). If true (default), assume the outcome of that should be applied here too. |
| string | $output_method | Leave as default or explicitly set to 'echo' for this function to output a list of helpdesk staff members, set to 'array' to block output, and have the standard contents back. |
Returns
array —The return is always an array of members that are staff; contains many details about members since SMF's member context is loaded (including avatar, personal text and so on)
