/sources/ocf_polls.php

Description
Functions
ocf_may_attach_poll (line 50)

Find whether a member may attach a poll to a detailed topic.

  • return: The answer.
boolean ocf_may_attach_poll (AUTO_LINK $topic_id, [?MEMBER $topic_owner = NULL], [?boolean $has_poll_already = NULL], [?MEMBER $forum_id = NULL], [?MEMBER $member_id = NULL])
  • AUTO_LINK $topic_id: The topic.
  • ?MEMBER $topic_owner: The topic owner (NULL: ask the DB for it).
  • ?boolean $has_poll_already: Whether the topic already has a poll (NULL: ask the DB for it).
  • ?MEMBER $forum_id: The forum the topic is in (NULL: ask the DB for it).
  • ?MEMBER $member_id: The member we are checking for (NULL: current member).
ocf_may_delete_poll_by (line 78)

Find whether a member can delete a poll owned by a certain member in a certain forum.

  • return: The answer.
boolean ocf_may_delete_poll_by (AUTO_LINK $forum_id, MEMBER $poll_owner, [?MEMBER $member_id = NULL])
  • AUTO_LINK $forum_id: The forum.
  • MEMBER $poll_owner: The poll owner.
  • ?MEMBER $member_id: The member we are checking for (NULL: current member).
ocf_may_edit_poll_by (line 29)

Find whether a member can alter a poll owned by a certain member in a certain forum.

  • return: The answer.
boolean ocf_may_edit_poll_by (AUTO_LINK $forum_id, MEMBER $poll_owner, [?MEMBER $member_id = NULL])
  • AUTO_LINK $forum_id: The forum.
  • MEMBER $poll_owner: The poll owner.
  • ?MEMBER $member_id: The member we are checking for (NULL: current member).
ocf_poll_get_results (line 96)

Find a map of results relating to a certain poll.

  • return: The map of results.
array ocf_poll_get_results (AUTO_LINK $poll_id, [boolean $request_results = true])
  • AUTO_LINK $poll_id: The poll.
  • boolean $request_results: Whether we must record that the current member is requesting the results, blocking future voting for them.

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