/sources/ocf_topics_action2.php

Description
Functions
handle_topic_ticket_reply (line 497)

If necessary, send out a support ticket reply

void handle_topic_ticket_reply (AUTO_LINK $forum_id, AUTO_LINK $topic_id, SHORT_TEXT $topic_title, LONG_TEXT $post)
  • AUTO_LINK $forum_id: Forum ID
  • AUTO_LINK $topic_id: Topic ID
  • SHORT_TEXT $topic_title: Topic title
  • LONG_TEXT $post: Post made
ocf_delete_topic (line 105)

Delete a topic.

  • return: The forum ID the topic is in (could be found without calling the function, but as we've looked it up, it is worth keeping).
AUTO_LINK ocf_delete_topic (AUTO_LINK $topic_id, [LONG_TEXT $reason = ''], [?AUTO_LINK $post_target_topic_id = NULL])
  • AUTO_LINK $topic_id: The ID of the topic to delete.
  • LONG_TEXT $reason: The reason for this action .
  • ?AUTO_LINK $post_target_topic_id: Where topic to move posts in this topic to (NULL: delete the posts).
ocf_edit_topic (line 35)

Edit a topic.

void ocf_edit_topic (?AUTO_LINK $topic_id, [?SHORT_TEXT $description = NULL], [?SHORT_TEXT $emoticon = NULL], [?BINARY $validated = NULL], [?BINARY $open = NULL], [?BINARY $pinned = NULL], [?BINARY $sunk = NULL], [?BINARY $cascading = NULL], [LONG_TEXT $reason = ''], [?string $title = NULL])
  • ?AUTO_LINK $topic_id: The ID of the topic to edit (NULL: personal topic).
  • ?SHORT_TEXT $description: Description of the topic (NULL: do not change).
  • ?SHORT_TEXT $emoticon: The image code of the emoticon for the topic (NULL: do not change).
  • ?BINARY $validated: Whether the topic is validated (NULL: do not change).
  • ?BINARY $open: Whether the topic is open (NULL: do not change).
  • ?BINARY $pinned: Whether the topic is pinned (NULL: do not change).
  • ?BINARY $sunk: Whether the topic is sunk (NULL: do not change).
  • ?BINARY $cascading: Whether the topic is cascading (NULL: do not change).
  • LONG_TEXT $reason: The reason for this action.
  • ?string $title: New title for the topic (NULL: do not change).
ocf_invite_to_pt (line 419)

Invite a member to a PT.

void ocf_invite_to_pt (MEMBER $member_id, AUTO_LINK $topic_id)
  • MEMBER $member_id: Member getting access
  • AUTO_LINK $topic_id: The topic
ocf_move_topics (line 232)

Move some topics.

void ocf_move_topics (AUTO_LINK $from, AUTO_LINK $to, [?array $topics = NULL])
  • AUTO_LINK $from: The forum the topics are currently in.
  • AUTO_LINK $to: The forum the topics are being moved to.
  • ?array $topics: A list of the topic IDs to move (NULL: move all topics from source forum).
sent_pt_notification (line 470)

Send a new-PT notification.

void sent_pt_notification (AUTO_LINK $post_id, SHORT_TEXT $subject, AUTO_LINK $topic_id, MEMBER $to_id, [?MEMBER $from_id = NULL], [?mixed $post = NULL], [boolean $mark_unread = false])
  • AUTO_LINK $post_id: The ID of the post made
  • SHORT_TEXT $subject: PT title
  • AUTO_LINK $topic_id: ID of the topic
  • MEMBER $to_id: Member getting the PT
  • ?MEMBER $from_id: Member posting the PT (NULL: current member)
  • ?mixed $post: Post language ID or post text (NULL: unknown, lookup from $post_id)
  • boolean $mark_unread: Whether to also mark the topic as unread

Documentation generated on Sun, 02 Jan 2011 23:20:17 +0000 by phpDocumentor 1.4.3