/sources/ocf_polls_action2.php

Description
Functions
ocf_delete_poll (line 97)

Delete a forum poll.

  • return: The ID of the topic the poll is on.
AUTO_LINK ocf_delete_poll (AUTO_LINK $poll_id, LONG_TEXT $reason)
  • AUTO_LINK $poll_id: The ID of the poll we're deleting.
  • LONG_TEXT $reason: The reason for deleting the poll.
ocf_edit_poll (line 36)

Edit a forum poll.

  • return: The ID of the topic the poll is on.
AUTO_LINK ocf_edit_poll (AUTO_LINK $poll_id, SHORT_TEXT $question, BINARY $is_private, BINARY $is_open, integer $minimum_selections, integer $maximum_selections, BINARY $requires_reply, array $answers, LONG_TEXT $reason)
  • AUTO_LINK $poll_id: The ID of the poll we're editing.
  • 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 the potential voteable answers.
  • LONG_TEXT $reason: The reason for editing the poll.
ocf_vote_in_poll (line 128)

Place a vote on a specified poll.

void ocf_vote_in_poll (AUTO_LINK $poll_id, array $votes, [?MEMBER $member_id = NULL], [?array $topic_info = NULL])
  • AUTO_LINK $poll_id: The ID of the poll we're voting in.
  • array $votes: A list of poll answers that are being voted for.
  • ?MEMBER $member_id: The member that's voting (NULL: current member).
  • ?array $topic_info: The row of the topic the poll is for (NULL: get it from the DB).

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