/sources/ocf_topics.php

Description
Description | Functions
Functions
Description | Functions
ocf_get_topic_where (line 27)

Get an SQL 'WHERE' clause for the posts in a topic.

  • return: The WHERE clause.
string ocf_get_topic_where (AUTO_LINK $topic_id)
  • AUTO_LINK $topic_id: The ID of the topic we are getting details of.
ocf_has_read_topic (line 194)

Find whether a member has read a certain topic, such that they have possibly read all posts within it already.

  • return: They have read it as such, yes.
boolean ocf_has_read_topic (AUTO_LINK $topic_id, [?TIME $topic_last_time = NULL], [?MEMBER $member_id = NULL], [?TIME $member_last_time = NULL])
  • AUTO_LINK $topic_id: The ID of the topic.
  • ?TIME $topic_last_time: The time of the last post in the topic (NULL: get it from the DB).
  • ?MEMBER $member_id: The member (NULL: current member).
  • ?TIME $member_last_time: The time the member last viewed the topic (NULL: get it from the DB).
ocf_has_replied_topic (line 93)

Find whether a member has replied to a certain topic.

  • return: The answer.
boolean ocf_has_replied_topic (AUTO_LINK $topic_id, [?MEMBER $member_id = NULL])
  • AUTO_LINK $topic_id: The topic.
  • ?MEMBER $member_id: The member (NULL: current member).
ocf_has_special_pt_access (line 225)

Find whether a member has special access to a certain PT.

  • return: Whether they have special access.
boolean ocf_has_special_pt_access (AUTO_LINK $topic_id, [?MEMBER $member_id = NULL])
  • AUTO_LINK $topic_id: The ID of the topic.
  • ?MEMBER $member_id: The member (NULL: current member).
ocf_is_tracking_topic (line 140)

Find whether a member is tracking a certain topic.

  • return: The answer.
boolean ocf_is_tracking_topic (AUTO_LINK $topic_id, [?MEMBER $member_id = NULL])
  • AUTO_LINK $topic_id: The ID of the topic.
  • ?MEMBER $member_id: The member (NULL: current member).
ocf_may_delete_topics_by (line 124)

Find whether a member may delete topics in a certain forum.

  • return: The answer.
boolean ocf_may_delete_topics_by (AUTO_LINK $forum_id, MEMBER $member_id, MEMBER $resource_owner)
  • AUTO_LINK $forum_id: The forum the topic would be in.
  • MEMBER $member_id: The member checking access for.
  • MEMBER $resource_owner: The member that owns this resource
ocf_may_edit_topics_by (line 107)

Find whether a member may edit topics in a certain forum.

  • return: The answer.
boolean ocf_may_edit_topics_by (AUTO_LINK $forum_id, MEMBER $member_id, MEMBER $resource_owner)
  • AUTO_LINK $forum_id: The forum the topic would be in.
  • MEMBER $member_id: The member checking access for.
  • MEMBER $resource_owner: The member that owns this resource
ocf_may_make_personal_topic (line 44)

Find whether a member may make a personal topic.

  • return: The answer.
boolean ocf_may_make_personal_topic ([?MEMBER $member_id = NULL])
  • ?MEMBER $member_id: The member (NULL: current member).
ocf_may_post_topic (line 60)

Find whether a member may post a topic in a certain forum.

  • return: The answer.
boolean ocf_may_post_topic (AUTO_LINK $forum_id, [?MEMBER $member_id = NULL])
  • AUTO_LINK $forum_id: The forum the topic would be in.
  • ?MEMBER $member_id: The member (NULL: current member).
ocf_may_report_post (line 79)

Find whether a member may report a post.

  • return: The answer.
boolean ocf_may_report_post ([?MEMBER $member_id = NULL])
  • ?MEMBER $member_id: The member (NULL: current member).
ocf_ping_topic_read (line 178)

Mark a topic as read by the current member.

void ocf_ping_topic_read (AUTO_LINK $topic_id)
  • AUTO_LINK $topic_id: The Id of the topic to mark as read.
ocf_track_topic (line 155)

Change a members tracking settings with respect to a certain topic.

void ocf_track_topic (AUTO_LINK $topic_id, [?MEMBER $member_id = NULL], [boolean $untrack = false], [boolean $check_permissions = true])
  • AUTO_LINK $topic_id: The topic.
  • ?MEMBER $member_id: The member (NULL: current member).
  • boolean $untrack: Whether we are untracking the topic.
  • boolean $check_permissions: Whether we are checking permissions for the member to actually track this topic.

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