This function handles all of the creation of posts and tickets within SimpleDesk, even with respect to managing tickets spawned from forum topics being moved. New tickets' contents as well as replies to tickets generally hold the same format. All three parameters are by reference meaning they WILL be updated if things change. Note that this function is not validating that they are sensible values; it is up to the calling function to ascertain that.

• since: 1.0

Parameter: $msgOptions

Expected type: array

A hash array by reference, containing details of the post you wish to add.

• id: Not required on input (and is ignored) - and will be overwritten with the new message id when the function completes.
• body: Required string, the principle body content of the message to post. Assumed to have been cleaned already (with $smcFunc['htmlspecialchars'] and preparsecode)
• smileys_enabled: Optional, boolean denoting whether smileys should be active on this post; defaults to false
• time: Optional, timestamp of the post. If omitted, time() will be used instead (for "now" based on server clock)
• modified: Optional, hash array containing items relating to modification (if 'modified' key exists, all of these should be set)
  • time: Unsigned int timestamp of the change
  • name: String; user name of the user making the change; if omitted, modified will be ignored
  • id: Unsigned int user id of the user making the change; if not provided, id MUST be. If id isn't, or it doesn't exist, modified will be ignored entirely
• attachments: Optional, array of attachment ids that need attaching to this message; if omitted no changes will occur

Parameter: $ticketOptions

Expected type: array

A hash array by reference, containing details of the ticket as a whole.

• id: Required if replying to a ticket, 0 if a new ticket (will default to 0 if not specified)
• mark_as_read: Optional boolean, whether to mark the ticket as read by the person posting it ($posterOptions['id'] is required to use this)
• mark_as_read_proxy: Optional integer for proxy tickets, if $ticketOptions['mark_as_read'] is true. Mark the ticket as read for the user with this id.
• subject: Semi-optional string with the new subject in; required for a new ticket, ignored if adding a reply. If set, assumed to have been cleaned already (with $smcFunc['htmlspecialchars'] and strtr)
• private: Semi-optional boolean with ticket privacy (true = private); required for a new ticket, ignored if adding a reply.
• status: Integer to denote new status of the ticket, defaults to TICKET_STATUS_NEW. Calling function to determine new status.
• urgency: Semi-optional integer with the ticket urgency; required for a new ticket, ignored if adding a reply. If not stated on a new ticket, TICKET_URGENCY_LOW will be used.
• assigned: Optional integer of user id, used to create a ticket with assignment, ignored if not a new ticket.
• dept: Required if creating a new ticket, to indicate which department the ticket should belong to.

Parameter: $posterOptions

Expected type: array

A hash array by reference, containing details of the person the reply is written by.

• id: User id to credit the post to. Uses 0 if not specified.
• ip: IP address the post came from. Uses the current user's IP address if not specified.
• name: Name to credit against the post. If not specified, and a user id was supplied, look that up in the member table, otherwise just use 'Guest'.
• email: Email address to list against the post. If not specified, and a user id was supplied, look that up in the member table, otherwise just use ''.

This function allows modification of all post/ticket details - and can be used independently; it is possible (and even done in SimpleDesk) to update just a ticket or just a post from this function. All three parameters are by reference meaning they WILL be updated if things change. Note that this function is not validating that they are sensible values; it is up to the calling function to ascertain that.

• since: 1.0

Parameter: $msgOptions

Expected type: array

- a hash array by reference, stating zero or more details to change on a message (if the change is strictly ticket-only, the entire $msgOptions array can be an empty array):

• id: Required if changing a message; the principle numeric id of the message to modify
• body: Optional, the principle body content of the message to change; if omitted, no change will occur. If set, assumed to have been cleaned already (with $smcFunc['htmlspecialchars'] and preparsecode)
• modified: Optional, hash array containing items relating to modification (if 'modified' key exists, all of these should be set)
  • time: Unsigned int timestamp of the change
  • name: String; user name of the user making the change
  • id: Unsigned int user id of the user making the change
• smileys_enabled: Optional, boolean denoting whether smileys should be active on this post; if omitted no change will occur
• attachments: Optional, array of attachment ids that need attaching to this message; if omitted no changes will occur

Parameter: $ticketOptions

Expected type: array

- a hash array by reference, stating one or more details necessary to change on a ticket:

• id: Required in all cases, numeric ticket id that the edit relates to
• subject: Optional string with the new subject in; if omitted no change will occur. If set, assumed to have been cleaned already (with $smcFunc['htmlspecialchars'] and strtr)
• urgency: Optional integer with the new urgency in; if omitted no change will occur
• status: Optional integer with the new status in; if omitted no change will occur
• ssigned: Optional integer with the user id of assigned user; if omitted no change will occur (note, you would declare this as 0 to unassign a ticket - set to 0 is not omitted)
• private: Optional boolean as to privacy of ticket: true = private, false = not private (note, you still declare this to change it)

Parameter: $posterOptions

Expected type: array

- a hash array by reference of details to change on the poster of a message:

• name: Optional string, name of credited poster (in absence of id, this will be used); if omitted no change will occur
• email: Optional string, email address of poster; if omitted no change will occur

Ticket urgency permissions are checked, and an array is built suitable for $context['ticket_form'], which is the principle format used in the ticket posting/reply posting functions in SimpleDesk-Post.php. There is no return function; $context['ticket_form']['urgency'] is updated, both the ['options'] and ['can_change'] keys may be modified.

• since: 1.0

Parameter: $self_ticket

Expected type: bool

Default: false

(default false) Permissions will be different for many users depending on whether it is one of their own tickets or not. This allows the code to state whether it is a ticket owned by the current user or not.

Parameter: $dept

Expected type: mixed

Loads any custom fields that are active

• since: 2.0

Parameter: $is_ticket

Expected type: bool

Default: true

(default true) Whether to load custom fields based on editing a ticket or a message.

Parameter: $ticketContext

Expected type: int

The appropriate value to load for; if editing a ticket this represents the ticket id, if editing a reply this represents the message id, if empty this is a new instance of either so no need to attempt loading data.

Parameter: $dept

Expected type: mixed

Parameter: $scope

Expected type: mixed

Parameter: $dept

Expected type: mixed

Set a ticket to on hold or restore to the proper status.

• since: 2.1

Parameter: $on_hold

Expected type: bool

Default: false

(default true) Whether this ticket should be on hold or not.

Parameter: $ticketOptions

Expected type: array

- a hash array by reference, stating one or more details necessary to change on a ticket:

• id: Required in all cases, numeric ticket id that the edit relates to
• subject: Optional string with the new subject in; if omitted no change will occur. If set, assumed to have been cleaned already (with $smcFunc['htmlspecialchars'] and strtr)
• urgency: Optional integer with the new urgency in; if omitted no change will occur
• status: Optional integer with the new status in; if omitted no change will occur
• ssigned: Optional integer with the user id of assigned user; if omitted no change will occur (note, you would declare this as 0 to unassign a ticket - set to 0 is not omitted)
• private: Optional boolean as to privacy of ticket: true = private, false = not private (note, you still declare this to change it)