SimpleDesk API v2.1 - Source files - SimpleDesk-SSI
Navigation
Search
- Home
- Installer
- Language files
-
Source files
- SimpleDesk-Admin
- SimpleDesk-AdminCannedReplies
- SimpleDesk-AdminCustomField
- SimpleDesk-AdminDepartments
- SimpleDesk-AdminMaint
- SimpleDesk-AdminPermissions
- SimpleDesk-AdminPlugins
- SimpleDesk-AjaxHandler
- SimpleDesk-Assign
- SimpleDesk-Delete
- SimpleDesk-Display
- SimpleDesk-MiscActions
- SimpleDesk-MoveDept
- SimpleDesk-Notifications
- SimpleDesk-Post
- SimpleDesk-Profile
- SimpleDesk-Scheduled
- SimpleDesk-Search
- SimpleDesk-SSI
- SimpleDesk-TicketTopicMove
- SimpleDesk-Unread
- SimpleDesk
- Support files
-
Template files
- SimpleDesk-Admin
- SimpleDesk-AdminCannedReplies
- SimpleDesk-AdminCustomField
- SimpleDesk-AdminDepartments
- SimpleDesk-AdminMaint
- SimpleDesk-AdminPermissions
- SimpleDesk-AdminPlugins
- SimpleDesk-Assign
- SimpleDesk-BoardIndex
- SimpleDesk-Display
- SimpleDesk-MoveDept
- SimpleDesk-Post
- SimpleDesk-Profile
- SimpleDesk-Search
- SimpleDesk-TicketTopicMove
- SimpleDesk-Unread
- SimpleDesk
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.
- since: 2.0
ssi_shd_called()
Makes SMF hook system happy that it has a function to call for SSI.
- since: 2.1
ssi_userTickets(int $started_by, array|int $dept = array(), int $limit = 10, string $output_method = 'echo')
Gets a list of the tickets currently open that are a given user's (subject to ticket visibility).
- since: 2.0
Parameter: $started_by
Expected type: int
The user id whose tickets you want to examine, defaults to the current user.
Parameter: $dept
Expected type: array|int
Default: array()
An array of department ids whose tickets you want to examine, defaults to all departments.
Parameter: $limit
Expected type: int
Default: 10
The number of tickets to limit to, default 10.
Parameter: $output_method
Expected type: string
Default: 'echo'
Set to 'echo' for displaying content, set to 'array' to simply return data.
ssi_staffAssignedTickets(int $assignee, int|array $dept = array(), int $limit = 10, string $output_method = 'echo')
Gets a list of the tickets currently open that are assigned to the current user (presumably staff, subject to ticket visibility).
- since: 2.0
Parameter: $assignee
Expected type: int
The user id whose tickets whose assigned tickets you want to examine, defaults to the current user.
Parameter: $dept
Expected type: int|array
Default: array()
An array of department ids whose tickets you want to examine, defaults to all departments.
Parameter: $limit
Expected type: int
Default: 10
The number of tickets to limit to, default 10.
Parameter: $output_method
Expected type: string
Default: 'echo'
Set to 'echo' for displaying content, set to 'array' to simply return data.
ssi_staffTicketsUrgency(int $urgency, int|array $dept = array(), int $limit = 10, string $output_method = 'echo')
Gets a list of all tickets based on urgency criteria given (subject to ticket visibility)
- since: 2.0
Parameter: $urgency
Expected type: int
The urgency of tickets you want to get.
Parameter: $dept
Expected type: int|array
Default: array()
An array of department ids whose tickets you want to examine, defaults to all departments.
Parameter: $limit
Expected type: int
Default: 10
The number of tickets to limit to, default 10.
Parameter: $output_method
Expected type: string
Default: 'echo'
Set to 'echo' for displaying content, set to 'array' to simply return data.
ssi_getSDTickets(string $query_where, array $query_where_params = array(), int $query_limit, string $query_order = 'hdt.id_ticket ASC', mixed $output_method = 'echo')
Gets tickets based on supplied criteria; this is a helper function not really intended to be called directly.
- since: 2.0
Parameter: $query_where
Expected type: string
SQL clauses to be supplied to the query in addition to {query_see_ticket} - note 'AND' is not required at the start.
Parameter: $query_where_params
Expected type: array
Default: array()
Key/value associative array to be injected into the query, related to $query_where.
Parameter: $query_limit
Expected type: int
Number of items to limit the query to.
Parameter: $query_order
Expected type: string
Default: 'hdt.id_ticket ASC'
The clause to order tickets by, defaults to tickets by order of creation.
Parameter: $output_method
Expected type: mixed
Default: 'echo'
ssi_staffMembers(bool $honour_admin_setting = true, string $output_method = 'echo')
Gets a list of all staff members within the helpdesk.
- since: 2.0
Parameter: $honour_admin_setting
Expected type: bool
Default: true
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.
Parameter: $output_method
Expected type: string
Default: 'echo'
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.