/sources/ocf_posts_action3.php

Description
Description | Functions
Functions
Description | Functions
ocf_delete_posts_topic (line 181)

Delete posts from a topic.

  • return: Whether the topic was deleted, due to all posts in said topic being deleted.
boolean ocf_delete_posts_topic (AUTO_LINK $topic_id, array $posts, LONG_TEXT $reason)
  • AUTO_LINK $topic_id: The ID of the topic we're deleting posts from.
  • array $posts: A list of posts to delete.
  • LONG_TEXT $reason: The reason for this action.
ocf_edit_post (line 85)

Edit a post.

  • return: The ID of the topic (whilst this could be known without calling this function, as we've gone to effort and grabbed it from the DB, it might turn out useful for something).
AUTO_LINK ocf_edit_post (AUTO_LINK $post_id, BINARY $validated, SHORT_TEXT $title, LONG_TEXT $post, BINARY $skip_sig, BINARY $is_emphasised, MEMBER $intended_solely_for, boolean $show_as_edited, boolean $mark_as_unread, LONG_TEXT $reason)
  • AUTO_LINK $post_id: The ID of the post that we're editing.
  • BINARY $validated: Whether the post is validated.
  • SHORT_TEXT $title: The title of the post (may be blank).
  • LONG_TEXT $post: The post.
  • BINARY $skip_sig: Whether to skip showing the posters signature in the post.
  • BINARY $is_emphasised: Whether the post is marked emphasised.
  • MEMBER $intended_solely_for: The member that this post is intended solely for.
  • boolean $show_as_edited: Whether to show the post as edited.
  • boolean $mark_as_unread: Whether to mark the topic as unread by those previous having read this post.
  • LONG_TEXT $reason: The reason for this action.
ocf_move_posts (line 288)

Move posts from one topic to another.

  • return: Whether the topic was deleted.
boolean ocf_move_posts (AUTO_LINK $from_topic_id, AUTO_LINK $to_topic_id, array $posts, LONG_TEXT $reason, [?AUTO_LINK $to_forum_id = NULL], [boolean $delete_if_empty = false], [?SHORT_TEXT $title = NULL])
  • AUTO_LINK $from_topic_id: The ID of the source topic.
  • AUTO_LINK $to_topic_id: The ID of the destination topic.
  • array $posts: A list of post IDs to move.
  • LONG_TEXT $reason: The reason for this action.
  • ?AUTO_LINK $to_forum_id: The forum the destination topic is in (NULL: find from DB).
  • boolean $delete_if_empty: Whether to delete the topic if all posts in it have been moved.
  • ?SHORT_TEXT $title: The title for the new topic (NULL: work out / irrelevant).
ocf_validate_post (line 31)

Validate a post.

  • return: The ID of the topic (whilst this could be known without calling this function, as we've gone to effort and grabbed it from the DB, it might turn out useful for something).
AUTO_LINK ocf_validate_post (AUTO_LINK $post_id, [?AUTO_LINK $topic_id = NULL], [?AUTO_LINK $forum_id = NULL], [?MEMBER $poster = NULL], [?LONG_TEXT $post = NULL])
  • AUTO_LINK $post_id: The ID of the post.
  • ?AUTO_LINK $topic_id: The ID of the topic that contains the post (NULL: find out from the DB).
  • ?AUTO_LINK $forum_id: The forum that the topic containing the post is in (NULL: find out from the DB).
  • ?MEMBER $poster: The member that made the post being validated (NULL: find out from the DB).
  • ?LONG_TEXT $post: The post, in Comcode format (NULL: It'll have to be looked-up).

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