SimpleDesk API v2.1 - Support files - Subs-SimpleDeskAdmin
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
This file deals with some of the items required by the helpdesk, but are primarily supporting functions; they're not the principle functions that drive the admin area.
- since: 1.0
shd_load_action_log_entries(int $start, int $items_per_page = 10, string $sort = 'la.log_time', string $order = 'DESC', string $clause = '')
It is subject to given parameters (start, number of items, order/sorting), parses the language strings and adds the parameter information provided.
- see: \shd_count_action_log_entries()
- since: 1.0
Parameter: $start
Expected type: int
Number of items into the log to start (for pagination). If -1, return everything. If nothing is given, fall back to 0, i.e the first log item.
Parameter: $items_per_page
Expected type: int
Default: 10
How many items to load. Default to 10 items.
Parameter: $sort
Expected type: string
Default: 'la.log_time'
SQL clause to state which column(s) to order the data by. By default it orders by log_time.
Parameter: $order
Expected type: string
Default: 'DESC'
SQL clause to state whether the order is ascending or descending. Defaults to descending.
Parameter: $clause
Expected type: string
Default: ''
An SQL fragment that forms a WHERE clause to limit log items, e.g. to load a specific ticket or specific member's log items.
shd_count_action_log_entries(string $clause = '')
This function gets the total number of items logged in the helpdesk log, for the purposes of establishing the number of pages there should be in the page-index.
- see: \shd_load_action_log_entries()
- since: 1.0
Parameter: $clause
Expected type: string
Default: ''
An SQL fragment that forms a WHERE clause to limit log items, e.g. to load a specific ticket or specific member's log items.
shd_action_log_exclusions()
shd_admin_bootstrap(array $admin_areas)
Perform all the operations required for SimpleDesk to safely start operations inside the admin panel.
- since: 2.0
Parameter: $admin_areas
Expected type: array
The full admin area array from SMF's Admin.php.
shd_admin_core_features(array $core_features)
Add the SimpleDesk option into the Core Features page inside the admin panel.
Parameter: $core_features
Expected type: array
The array of Core Features as provided by ManageSettings.php
shd_admin_smf_perms(array $permissionGroups, array $permissionList, array $leftPermissionGroups, array $hiddenPermissions, array $relabelPermissions)
All of the parameters are the normal variables provided by ManagePermissions.php to its integration hook.
- since: 2.0
Parameter: $permissionGroups
Expected type: array
The array of groups of permissions
Parameter: $permissionList
Expected type: array
The master list of permissions themselves
Parameter: $leftPermissionGroups
Expected type: array
The list of permission groups that are displayed on the left hand side of the screen in Classic Mode
Parameter: $hiddenPermissions
Expected type: array
A list of permissions to be hidden in the event of features being disabled
Parameter: $relabelPermissions
Expected type: array
A list of permissions to be renamed depending on features being active
shd_admin_search(array $language_files, array $include_files, array $settings_search)
Intergrates into SMF's admin search.
- since: 2.0
Parameter: $language_files
Expected type: array
language files to include.
Parameter: $include_files
Expected type: array
Files to load.
Parameter: $settings_search
Expected type: array
Settings to search.
shd_remove_attachments(array $attach)
Removes an attachment when removed from SMF.
- since: 2.1
Parameter: $attach
Expected type: array
All attachment IDs removed.
shd_convert_msgbody(array $body_type = 'null')
Converts helpdesk body length to match SMF's.
- since: 2.1
Parameter: $body_type
Expected type: array
Default: 'null'
Either text or other.
shd_modifylanguages(array $themes, mixed $lang_dirs)
Adds SimpleDesk language files into our search location.
- since: 2.1
Parameter: $themes
Expected type: array
all the language directories avaiable.
Parameter: $lang_dirs
Expected type: mixed
shd_admin_log_configvar(array $save_vars)
Tracks a change to our options/configvars.
- since: 2.1
Parameter: $save_vars
Expected type: array
Passed before we do the updateDBSettings but after everything else is ready.
shd_admin_log(string $action, array $extra)
Logs a change in our admin area.
- since: 2.1
Parameter: $action
Expected type: string
The area this was from.
Parameter: $extra
Expected type: array
An array of extra elements, in the following format. (required) string $action The action performed. (optional) string $setting During a setting update, this is the variable we changed. (optional) string $type The subaction peformed or during a setting update, int/string/etc. (optional) int $id The ID of the item we performed the action on. (optional) string $direction During a reorder up/down operation which way we moved. (optional) int $to The ID of the destination item used during copy/move operation. (optional) int $from The ID of the source item used during the copy/move operation
shd_load_admin_log_entries(int $start, int $items_per_page = 10, string $sort = 'la.log_time', string $order = 'DESC')
It is subject to given parameters (start, number of items, order/sorting), parses the language strings and adds the parameter information provided.
- see: \shd_count_action_log_entries()
- since: 1.0
Parameter: $start
Expected type: int
Number of items into the log to start (for pagination). If -1, return everything. If nothing is given, fall back to 0, i.e the first log item.
Parameter: $items_per_page
Expected type: int
Default: 10
How many items to load. Default to 10 items.
Parameter: $sort
Expected type: string
Default: 'la.log_time'
SQL clause to state which column(s) to order the data by. By default it orders by log_time.
Parameter: $order
Expected type: string
Default: 'DESC'
SQL clause to state whether the order is ascending or descending. Defaults to descending.
shd_count_admin_log_entries()
This function gets the total number of items logged in the helpdesk admin log, for the purposes of establishing the number of pages there should be in the page-index.
- see: \shd_load_admin_log_entries()
- since: 2.1