SimpleDesk API
Procedural File: Subs-SimpleDeskAdmin.php
Source Location: /source/Subs-SimpleDeskAdmin.phpThis 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.
Tags:
- since
- 1.0
Contains the following functions:
shd_count_action_log_entries [line 159]
int shd_count_action_log_entries (
)
Returns the total number of items in the helpdesk log.
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.
Tags:
- see
- shd_load_action_log_entries()
- since
- 1.0
Return value
Returns a type int. Number of entries in the helpdesk action log table.[ Top ]
shd_load_action_log_entries [line 66]
array shd_load_action_log_entries (
int $start, int $items_per_page, string $sort, string $order )
Load the items from the helpdesk action log
It is subject to given parameters (start, number of items, order/sorting), parses the language strings and adds the parameter information provided.
Tags:
- see
- shd_log_action()
- see
- shd_count_action_log_entries()
- since
- 1.0
Parameters
- int $start
- Number of items into the log to start (for pagination)
- int $items_per_page
- How many items to load
- string $sort
- SQL clause to state which column(s) to order the data by
- string $order
- SQL clause to state whether the order is ascending or descending
Return value
Returns a type array. A hash array of the log items, with the auto-incremented id being the key:- id: Numeric identifier of the log item
- time: Formatted time of the event (as per usual for SMF, formatted for user's timezone)
- member: hash array:
- id: Id of the user that committed the action
- name: Name of the user
- link: Link to the profile of the user that committed the action
- ip: User IP address recorded when the action was carried out
- group: Name of the group of the user (uses primary group, failing that post count group)
- action: Raw name of the action (for use with collecting the image later)
- id_ticket: Numeric id of the ticket this action refers to
- id_msg: Numeric id of the individual reply this action refers to
- extra: Array of extra parameters for the log action
- action_text: Formatted text of the log item (parsed with parameters)
[ Top ]



