/sources/ocf_polls_action.php

Description
Functions
ocf_make_poll (line 35)

Add a forum poll.

  • return: The ID of the newly created forum poll.
AUTO_LINK ocf_make_poll (AUTO_LINK $topic_id, SHORT_TEXT $question, BINARY $is_private, BINARY $is_open, integer $minimum_selections, integer $maximum_selections, BINARY $requires_reply, array $answers, [boolean $check_permissions = true])
  • AUTO_LINK $topic_id: The ID of the topic to add the poll to.
  • SHORT_TEXT $question: The question.
  • BINARY $is_private: Whether the result tallies are kept private until the poll is made non-private.
  • BINARY $is_open: Whether the poll is open for voting.
  • integer $minimum_selections: The minimum number of selections that may be made.
  • integer $maximum_selections: The maximum number of selections that may be made.
  • BINARY $requires_reply: Whether members must have a post in the topic before they made vote.
  • array $answers: A list of pairs of the potential voteable answers and the number of votes.
  • boolean $check_permissions: Whether to check there are permissions to make the poll.

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