3 * Data class to record responses to polls
9 * @author Brion Vibber <brion@status.net>
10 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
11 * @link http://status.net/
13 * StatusNet - the distributed open-source microblogging tool
14 * Copyright (C) 2011, StatusNet, Inc.
16 * This program is free software: you can redistribute it and/or modify
17 * it under the terms of the GNU Affero General Public License as published by
18 * the Free Software Foundation, either version 3 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU Affero General Public License for more details.
26 * You should have received a copy of the GNU Affero General Public License
27 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 if (!defined('STATUSNET')) {
35 * For storing the poll options and such
37 * @category PollPlugin
39 * @author Brion Vibber <brion@status.net>
40 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
41 * @link http://status.net/
45 class Poll_response extends Managed_DataObject
47 public $__table = 'poll_response'; // table name
48 public $id; // char(36) primary key not null -> UUID
49 public $uri; // varchar(255)
50 public $poll_id; // char(36) -> poll.id UUID
51 public $profile_id; // int -> profile.id
52 public $selection; // int -> choice #
53 public $created; // datetime
56 * Get an instance by compound key
58 * This is a utility method to get a single instance with a given set of
59 * key-value pairs. Usually used for the primary key for a compound key; thus
62 * @param array $kv array of key-value mappings
64 * @return Bookmark object found, or null for no hits
69 return Memcached_DataObject::pkeyGet('Poll_response', $kv);
73 * The One True Thingy that must be defined and declared.
75 public static function schemaDef()
78 'description' => 'Record of responses to polls',
80 'id' => array('type' => 'char', 'length' => 36, 'not null' => true, 'description' => 'UUID of the response'),
81 'uri' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'UUID to the response notice'),
82 'poll_id' => array('type' => 'char', 'length' => 36, 'not null' => true, 'description' => 'UUID of poll being responded to'),
83 'profile_id' => array('type' => 'int'),
84 'selection' => array('type' => 'int'),
85 'created' => array('type' => 'datetime', 'not null' => true),
87 'primary key' => array('id'),
88 'unique keys' => array(
89 'poll_uri_key' => array('uri'),
90 'poll_response_poll_id_profile_id_key' => array('poll_id', 'profile_id'),
93 'poll_response_profile_id_poll_id_index' => array('profile_id', 'poll_id'),
99 * Get a poll response based on a notice
101 * @param Notice $notice Notice to check for
103 * @return Poll_response found response or null
105 function getByNotice($notice)
107 return self::staticGet('uri', $notice->uri);
111 * Get the notice that belongs to this response...
117 return Notice::staticGet('uri', $this->uri);
122 return $this->getNotice()->bestUrl();
131 return Poll::staticGet('id', $this->poll_id);
134 * Save a new poll notice
136 * @param Profile $profile
137 * @param Poll $poll the poll being responded to
138 * @param int $selection (1-based)
139 * @param array $opts (poll responses)
141 * @return Notice saved notice
143 static function saveNew($profile, $poll, $selection, $options=null)
145 if (empty($options)) {
149 if (!$poll->isValidSelection($selection)) {
150 // TRANS: Client exception thrown when responding to a poll with an invalid option.
151 throw new ClientException(_m('Invalid poll selection.'));
153 $opts = $poll->getOptions();
154 $answer = $opts[$selection - 1];
156 $pr = new Poll_response();
157 $pr->id = UUID::gen();
158 $pr->profile_id = $profile->id;
159 $pr->poll_id = $poll->id;
160 $pr->selection = $selection;
162 if (array_key_exists('created', $options)) {
163 $pr->created = $options['created'];
165 $pr->created = common_sql_now();
168 if (array_key_exists('uri', $options)) {
169 $pr->uri = $options['uri'];
171 $pr->uri = common_local_url('showpollresponse',
172 array('id' => $pr->id));
175 common_log(LOG_DEBUG, "Saving poll response: $pr->id $pr->uri");
178 // TRANS: Notice content voting for a poll.
179 // TRANS: %s is the chosen option in the poll.
180 $content = sprintf(_m('voted for "%s"'),
182 $link = '<a href="' . htmlspecialchars($poll->uri) . '">' . htmlspecialchars($answer) . '</a>';
183 // TRANS: Rendered version of the notice content voting for a poll.
184 // TRANS: %s a link to the poll with the chosen option as link description.
185 $rendered = sprintf(_m('voted for "%s"'), $link);
189 $options = array_merge(array('urls' => array(),
190 'rendered' => $rendered,
192 'reply_to' => $poll->getNotice()->id,
193 'object_type' => PollPlugin::POLL_RESPONSE_OBJECT),
196 if (!array_key_exists('uri', $options)) {
197 $options['uri'] = $pr->uri;
200 $saved = Notice::saveNew($profile->id,
202 array_key_exists('source', $options) ?
203 $options['source'] : 'web',