SD-SimpleDesk

@@ -25,6 +25,14 @@

 if (!defined('SMF'))

 	die('Hacking attempt...');

+/**

+ *	Notification for new tickets

+ *

+ *	@since 2.0

+ *	@param int &$msgOptions The message options, similar to the createPost in Subs-Post.php

+ *	@param int &$ticketOptions The ticket options, similar to the createPost topicOptions in Subs-Post.php

+ *	@param int &$posterOptions The poster options, similar to the createPost in Subs-Post.php

+*/

 function shd_notifications_notify_newticket(&$msgOptions, &$ticketOptions, &$posterOptions)

 {

 	global $smcFunc, $context, $modSettings, $scripturl;

@@ -99,6 +107,14 @@ function shd_notifications_notify_newticket(&$msgOptions, &$ticketOptions, &$pos

 	shd_notify_users($notify_data);

 }

+/**

+ *	Notifications for new replies

+ *

+ *	@since 2.0

+ *	@param int &$msgOptions The message options, similar to the createPost in Subs-Post.php

+ *	@param int &$ticketOptions The ticket options, similar to the createPost topicOptions in Subs-Post.php

+ *	@param int &$posterOptions The poster options, similar to the createPost in Subs-Post.php

+*/

 function shd_notifications_notify_newreply(&$msgOptions, &$ticketOptions, &$posterOptions)

 {

 	global $smcFunc, $context, $modSettings, $scripturl;

@@ -270,6 +286,13 @@ function shd_notifications_notify_newreply(&$msgOptions, &$ticketOptions, &$post

 		shd_notify_users($notify_data);

 }

+/**

+ *	Notificaiton for assignments

+ *

+ *	@since 2.0

+ *	@param int &$ticket The ticket id

+ *	@param int &$assignment Who the ticket is being assigned to.

+*/

 function shd_notifications_notify_assign(&$ticket, &$assignment)

 {

 	global $smcFunc, $context, $modSettings, $scripturl;

@@ -353,7 +376,7 @@ function shd_notifications_notify_assign(&$ticket, &$assignment)

  *	Handle email notifications

  *

  *	@todo Finish documenting

- *	@since 2.0

+ *	@param mixed $notify_data Array of data containing notification informationt o be sent out.

 */

 function shd_notify_users($notify_data)

 {

@@ -595,6 +618,12 @@ function shd_notify_popup()

 	$context['help_text'] .= '<strong>' . $txt['subject'] . ':</strong> ' . $email_subject . '<br><br>' . $email_body;

 }

+/**

+ *	Notification ticket options..

+ *

+ *	@todo Finish documenting

+ *	@since 2.0

+*/

 function shd_notify_ticket_options()

 {

 	global $context, $txt, $smcFunc;

@@ -739,6 +768,12 @@ function shd_notify_ticket_options()

 	redirectexit('action=helpdesk;sa=ticket;ticket=' . $context['ticket_id']);

 }

+/**

+ *	Builds a list of who should be notified or not.

+ *

+ *	@todo Finish documenting

+ *	@since 2.0

+*/

 function shd_query_monitor_list($ticket_id)

 {

 	global $smcFunc;

@@ -31,6 +31,8 @@ if (!defined('SMF'))

 /**

  *	Create a new ticket

+ *

+ *	@since 1.0

 */

 function shd_post_ticket()

 {

@@ -210,7 +212,11 @@ function shd_post_ticket()

 	checkSubmitOnce('register');

 }

-// All the magically common posting stuff goes in here

+/**

+ *	All the magically common posting stuff goes in here

+ *

+ *	@since 1.0

+*/

 function shd_save_post()

 {

 	global $txt, $modSettings, $sourcedir, $context, $scripturl;

@@ -278,6 +284,11 @@ function shd_save_post()

 		$actions[$_REQUEST['sa']]();

 }

+/**

+ *	Saves the main ticket data.

+ *

+ *	@since 1.0

+*/

 function shd_save_ticket()

 {

 	global $txt, $modSettings, $sourcedir, $context, $scripturl;

@@ -677,6 +688,12 @@ function shd_save_ticket()

 	}

 }

+

+/**

+ *	Loads the Post a reply area

+ *

+ *	@since 1.0

+*/

 function shd_post_reply()

 {

 	global $context, $user_info, $sourcedir, $txt, $scripturl, $smcFunc, $reply_request, $modSettings, $settings, $options, $memberContext;

@@ -924,6 +941,11 @@ function shd_post_reply()

 	checkSubmitOnce('register');

 }

+/**

+ *	Saves the reply

+ *

+ *	@since 1.0

+*/

 function shd_save_reply()

 {

 	global $txt, $modSettings, $sourcedir, $context, $scripturl;

@@ -1337,6 +1359,12 @@ function shd_done_posting()

 	}

 }

+/**

+ *	Sets up the replies section data

+ *

+ *	@since 1.0

+ *	@param array $first_msg The first message for the ricket

+*/

 function shd_setup_replies($first_msg)

 {

 	global $reply_request, $context, $smcFunc, $sourcedir, $modSettings, $settings;

@@ -1442,6 +1470,15 @@ function shd_setup_replies($first_msg)

 	}

 }

+/**

+ *	Sets up the post box for tuckets

+ *

+ *	@since 1.0

+ *	@param array $id The id of the post box

+ *	@param array $message The message for the post box

+ *	@param array $buttons Buttons on the post box

+ *	@param array $width (optional) The width of the post box

+*/

 function shd_postbox($id, $message, $buttons, $width = '90%')

 {

 	global $context, $txt, $modSettings;

@@ -1490,6 +1527,11 @@ function shd_postbox($id, $message, $buttons, $width = '90%')

 		$context['attachment_restrictions'][] = sprintf($txt['attach_restrict_attachmentSizeLimit'], $modSettings['attachmentSizeLimit']);

 }

+/**

+ *	Prepares a reply section

+ *

+ *	@since 1.0

+*/

 function shd_prepare_reply_context()

 {

 	global $settings, $txt, $modSettings, $scripturl, $options, $user_info, $smcFunc;

@@ -1547,6 +1589,11 @@ function shd_prepare_reply_context()

 	return $output;

 }

+/**

+ *	Load up any and all attachments related to this ticket.

+ *

+ *	@since 1.0

+*/

 function shd_load_attachments()

 {

 	global $smcFunc, $context, $modSettings;

@@ -1582,6 +1629,11 @@ function shd_load_attachments()

 	$smcFunc['db_free_result']($query);

 }

+/**

+ *	Checks attachments are valid and allowed.

+ *

+ *	@since 1.0

+*/

 function shd_check_attachments()

 {

 	global $modSettings, $smcFunc, $context, $user_info, $txt;

@@ -1777,6 +1829,11 @@ function shd_check_attachments()

 	$context['ticket_form']['num_allowed_attachments'] = empty($modSettings['attachmentNumPerPostLimit']) || $modSettings['shd_attachments_mode'] == 'ticket' ? -1 : $modSettings['attachmentNumPerPostLimit'];

 }

+/**

+ *	Handles attachment actions such as adding or removing.

+ *

+ *	@since 1.0

+*/

 function shd_handle_attachments()

 {

 	global $modSettings, $smcFunc, $context, $user_info, $sourcedir, $txt;

@@ -27,6 +27,11 @@

 if (!defined('SMF'))

 	die('Hacking attempt...');

+/**

+ *	The main search handling for tickets, just sets up stuff.

+ *

+ *	@since 1.0

+*/

 function shd_search()

 {

 	global $context, $smcFunc, $txt, $modSettings, $scripturl;

@@ -62,6 +67,11 @@ function shd_search()

 	);

 }

+/**

+ *	All the heavy lifting for search is handled here.

+ *

+ *	@since 1.0

+*/

 function shd_search2()

 {

 	global $context, $smcFunc, $txt, $modSettings, $scripturl, $sourcedir;

@@ -493,6 +503,12 @@ function shd_search2()

 	}

 }

+/**

+ *	Finds all members specified in a input field and returns their id_member.

+ *

+ *	@since 1.0

+ *	@param array $field The input field containing the names from a SMF autocomplete member box

+*/

 function shd_get_named_people($field)

 {

 	global $smcFunc, $sourcedir, $context, $user_profile;

@@ -860,6 +860,9 @@ function shd_format_text($text, $smileys = true, $cache = '')

  *	Processes the incoming message for wiki-links.

  *

  *	@param string &$message The message to be parsed.

+ *	@param string &$smileys The Smileys sets.

+ *	@param array $cache_id Cache ids used by messages, currently not used.

+ *	@param array $parse_tags Tags to parse, currently not used.

  *	@since 2.0

 */

 function shd_parse_wikilinks(&$message, &$smileys = array(), &$cache_id = array(), &$parse_tags = array())

@@ -1978,6 +1981,12 @@ function shd_main_menu(&$menu_buttons)

 	call_integration_hook('shd_hook_mainmenu', array(&$menu_buttons));

 }

+/**

+ *	Adds to the Admin Center menu the helpdesk section buttons.

+ *

+ *	@since 2.1

+ *  @param bool $helpdesk_admin If they are a helpdesk admin or not.

+*/

 function shd_main_menu_admin($helpdesk_admin)

 {

 	global $txt, $scripturl;