SimpleDesk API

\

sd_sourceSimpleDesk-Admin.php

This file handles the core of SimpleDesk's administrative information and options from within SMF's own admin panel.

Functions

shd_admin_main()

shd_admin_main()

The start point for all interaction with the SimpleDesk administration area.

Enforces that users attempting to access the area have either forum or helpdesk administrative privileges, loads the SimpleDesk administrative CSS and Javascript and promptly directs users to the specific function for the task they are performing.

shd_admin_info()

shd_admin_info()

Loads the main SimpleDesk information page for forum administrators.

This function is the main focus point for information about SimpleDesk in the admin panel, primarily it collects the following for the template:

  • list of helpdesk staff
  • totals of tickets in the system (open/closed/deleted)
  • credits
  • also, in the template, whether this is a current or outdated version of SimpleDesk

Since 1.1, it also receives the requests for subactions for action log and support page (since these are sub menu items) but simply directs them onward.

shd_admin_options()

shd_admin_options(  $return_config)

Configuration options and save functions generally for SimpleDesk.

This function handles all the sub areas under General Options, and adds the options listed in the relevant functions. In 1.0, all the options were stored in here, but in 1.1 they have been moved into their own functions.

Parameters

$return_config

shd_modify_display_options()

shd_modify_display_options(boolean  $return_config) : array

Sets up display options for SimpleDesk.

  • 'shd_staff_badge' (dropdown) - selects the type of badge(s) to display:
    • nobadge (default): Display no badges, just a small staff icon for staff members
    • staffbadge: Display nothing for normal users, and badge/stars for staff
    • userbadge: Display nothing for staff and normal badge/staff for regular users
    • bothbadge: Display regular badges/stars for both staff and users
  • 'shd_display_avatar' (checkbox) - whether to display avatars in the replies area or not
  • 'shd_ticketnav_style' (dropdown) - selects the type of navigation in the ticket area:
    • sd (default): use the original SimpleDesk style, icons+text in the bar just above the main ticket area
    • sdcompact: use the SimpleDesk icons, in the bar just above the main ticket area, but no captions
    • smf: use an SMF style button-strip above the ticket menu
  • 'shd_theme' (dropdown) - selects the theme id to be used in the helpdesk, or 0 for the forum default
  • 'shd_hidemenuitem' (checkbox) - whether to show or hide the menu item, typically used with multiple departments
  • 'shd_disable_unread' (checkbox) - if checked, the integration of outstanding helpdesk tickets into the unread page is disabled

    • Parameters

    boolean $return_config

    Whether to return configuration items or not; this is provided solely for SMF ACP compatibility (it expects to pass bool true in to get a list of options)

    Returns

    array —

    An array of items that make up the search options on the given admin page, each item is itself an array of (type, option name/language string, [other related information])

shd_modify_posting_options()

shd_modify_posting_options(boolean  $return_config) : array

General posting options for SimpleDesk.

  • 'shd_thank_you_post' (checkbox) - if checked, use $txt['shd_ticket_posted_body'] (in SimpleDesk.english.php) as a template of a message to display to the user thanking them for their ticket - and advising what's to come later.
  • 'shd_thank_you_nonstaff' (checkbox) - if checked, when the above option is invoked, only display the message to non staff members when they create their tickets.
  • 'shd_allow_wikilinks' (checkbox) - enable conversion of [[ticket:123]] into a regular link
  • 'shd_allow_ticket_bbc' (checkbox) - one-stop enable/disable of bbcode in tickets (see [shd_format_text()](namespaces/default.html#function_shd_format_text) for where this is used)
  • 'shd_allow_ticket_smileys' (checkbox) - one-stop enable/disable of smileys in tickets (see [shd_format_text()](namespaces/default.html#function_shd_format_text) for where this is used)
  • 'shd_attachments_mode' (dropdown) - selects the presentation of attachments to users:
    • ticket (default): treat attachments as if they are attached to the ticket overall; do not enforce max number per ticket
    • reply: treat all attachments as attached to replies; enforce same limit per reply as with posts normally
  • 'shd_bbc' (bbc) - enable/disable individual BBC tags around the helpdesk (see [shd_format_text()](namespaces/default.html#function_shd_format_text) for where this is used)

Parameters

boolean $return_config

Whether to return configuration items or not; this is provided solely for SMF ACP compatibility (it expects to pass bool true in to get a list of options)

Returns

array —

An array of items that make up the search options on the given admin page, each item is itself an array of (type, option name/language string, [other related information])

shd_modify_admin_options()

shd_modify_admin_options(boolean  $return_config) : array

General administrative options for SimpleDesk.

  • 'shd_maintenance_mode' (checkbox) - if checked, only forum adminstrators (group 1) and helpdesk admins can see the helpdesk
  • 'shd_staff_ticket_self' (checkbox) - if checked, a ticket opened by a staff member can be assigned to them to action.
  • 'shd_admins_not_assignable' (checkbox) - if checked, forum admins are not considered part of staff - a ticket cannot be assigned to them and they can't receive one-off notifications (since 2.0 only)
  • 'shd_privacy_display' (dropdown) - whether to display privacy or not:
    • smart (default): Display ticket privacy if it's likely to be relevant (if users can alter ticket privacy, and/or see private tickets AND the ticket is private, show it)
    • always: Always display ticket privacy; likely to be confusing
  • 'shd_disable_tickettotopic' (checkbox) - if checked, ticket to topic mode is entirely disabled.
  • 'shd_disable_relationships' (checkbox) - if checked, relationships are entirely disabled.

Parameters

boolean $return_config

Whether to return configuration items or not; this is provided solely for SMF ACP compatibility (it expects to pass bool true in to get a list of options)

Returns

array —

An array of items that make up the search options on the given admin page, each item is itself an array of (type, option name/language string, [other related information])

shd_modify_standalone_options()

shd_modify_standalone_options(boolean  $return_config) : array

Configuration options for Standalone mode.

  • 'shd_helpdesk_only' (checkbox) - if checked, Standalone mode is active.
  • 'shd_disable_pm' (checkbox) - if checked, personal messages will not be available at all when SimpleDesk is in (active) Standalone mode
  • 'shd_disable_mlist' (checkbox) - if checked, the memberlist will not be available at all when SimpleDesk is in (active) Standalone mode

Parameters

boolean $return_config

Whether to return configuration items or not; this is provided solely for SMF ACP compatibility (it expects to pass bool true in to get a list of options)

Returns

array —

An array of items that make up the search options on the given admin page, each item is itself an array of (type, option name/language string, [other related information])

shd_modify_actionlog_options()

shd_modify_actionlog_options(boolean  $return_config) : array

Provides configuration options for the action log.

  • 'shd_disable_action_log' (checkbox) - if checked, no actions are added to the action log.
  • 'shd_display_ticket_logs' (checkbox) - if checked, a ticket's specific log is displayed at the foot of the ticket.
  • 'shd_logopt_newposts' (checkbox) - if checked, a ticket's being creation and subsequent replies will be logged.
  • 'shd_logopt_editposts' (checkbox) - if checked, a ticket or its replies being edited will be logged.
  • 'shd_logopt_resolve' (checkbox) - if checked, a ticket's being closed and/or reopened will be logged.
  • 'shd_logopt_autoclose' (checkbox) - if checked, tickets being closed by the helpdesk due to age will be logged.
  • 'shd_logopt_assign' (checkbox) - if checked, a ticket being assigned/reassigned/unassigned will be logged.
  • 'shd_logopt_privacy' (checkbox) - if checked, ticket privacy changes will be logged.
  • 'shd_logopt_urgency' (checkbox) - if checked, ticket urgency changes will be logged.
  • 'shd_logopt_tickettopicmove' (checkbox) - if checked, ticket to topic moves and back will be logged.
  • 'shd_logopt_cfchanges' (checkbox) - if checked, changes to custom fields will be logged.
  • 'shd_logopt_delete' (checkbox) - if checked, ticket/reply deletions (not permadelete) will be logged.
  • 'shd_logopt_restore' (checkbox) - if checked, ticket/reply restores will be logged.
  • 'shd_logopt_permadelete' (checkbox) - if checked, permadeletes will be logged.
  • 'shd_logopt_relationships' (checkbox) - if checked, ticket relationship changes will be logged.
  • 'shd_logopt_move_dept' (checkbox) - if checked, ticket moves between departments will be logged.
  • 'shd_logopt_monitor' (checkbox) - if checked, users adding/removing tickets to/from their monitor lists will be logged.

Parameters

boolean $return_config

Whether to return configuration items or not; this is provided solely for SMF ACP compatibility (it expects to pass bool true in to get a list of options)

Returns

array —

An array of items that make up the search options on the given admin page, each item is itself an array of (type, option name/language string, [other related information])

shd_modify_notifications_options()

shd_modify_notifications_options(boolean  $return_config) : array

Displays notifications options within SD ACP / Options / Notifications

  • 'shd_notify_email' (text) - if specified, an email address to set as the reply-to address on any email notifications
  • 'shd_notify_log' (checkbox) - if checked, a log will be kept of outgoing notification
  • 'shd_notify_with_body' (checkbox) - if checked, the outgoing emails will have the email body where appropriate
  • 'shd_notify_new_ticket' (checkbox) - if checked, staff have the option of being notified when a new ticket is posted
  • 'shd_notify_new_reply_own' (checkbox) - if checked, users have the option to have notifications upon reply to any ticket they started
  • 'shd_notify_new_reply_assigned' (checkbox) - if checked, staff have the option to select notifications upon reply to any ticket assigned to them
  • 'shd_notify_new_reply_previous' (checkbox) - if checked, staff have the option to select notifications upon reply to any ticket they already replied to
  • 'shd_notify_new_reply_any' (checkbox) - if checked, staff have the option to select notifications upon any reply to any ticket they can see
  • 'shd_notify_assign_me' (checkbox) - if checked, staff have the option to have notifications sent to them when tickets are assigned to them
  • 'shd_notify_assign_own' (checkbox) - if checked, users have the option to be notified when one of their tickets is assigned to a staff member

Parameters

boolean $return_config

Whether to return configuration items or not; this is provided solely for SMF ACP compatibility (it expects to pass bool true in to get a list of options)

Returns

array —

An array of items that make up the search options on the given admin page, each item is itself an array of (type, option name/language string, [other related information])

shd_admin_action_log()

shd_admin_action_log()

Initialises the helpdesk action log.

This function loads the language strings, and hands off to shd_load_action_log_entries() to perform the actual log generation.

Before doing so, however, this function will also prepare for deletion of old entries, as well as sorting out the columns and ordering rules before handing control to the other function.

shd_admin_admin_log()

shd_admin_admin_log()

Initialises the helpdesk admin log.

shd_admin_support()

shd_admin_support()

Loads the support page for users to submit support requests directly to SimpleDesk.net

Very small function because essentially it just loads a template; there is no logic or processing to actually perform.

shd_credits()

shd_credits()

Loads the list of credits of people who've worked on SimpleDesk.

This defines the list of peoples' names, and none of it will be in language strings; the actual category titles and positions will be, but the names themselves can live in this file normally.