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 key
58 * This is a utility method to get a single instance with a given key value.
60 * @param string $k Key to use to lookup (usually 'user_id' for this class)
61 * @param mixed $v Value to lookup
63 * @return User_greeting_count object found, or null for no hits
66 function staticGet($k, $v=null)
68 return Memcached_DataObject::staticGet('Poll_response', $k, $v);
72 * Get an instance by compound key
74 * This is a utility method to get a single instance with a given set of
75 * key-value pairs. Usually used for the primary key for a compound key; thus
78 * @param array $kv array of key-value mappings
80 * @return Bookmark object found, or null for no hits
85 return Memcached_DataObject::pkeyGet('Poll_response', $kv);
89 * The One True Thingy that must be defined and declared.
91 public static function schemaDef()
94 'description' => 'Record of responses to polls',
96 'id' => array('type' => 'char', 'length' => 36, 'not null' => true, 'description' => 'UUID of the response'),
97 'uri' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'UUID to the response notice'),
98 'poll_id' => array('type' => 'char', 'length' => 36, 'not null' => true, 'description' => 'UUID of poll being responded to'),
99 'profile_id' => array('type' => 'int'),
100 'selection' => array('type' => 'int'),
101 'created' => array('type' => 'datetime', 'not null' => true),
103 'primary key' => array('id'),
104 'unique keys' => array(
105 'poll_uri_key' => array('uri'),
106 'poll_response_poll_id_profile_id_key' => array('poll_id', 'profile_id'),
109 'poll_response_profile_id_poll_id_index' => array('profile_id', 'poll_id'),
115 * Get a poll response based on a notice
117 * @param Notice $notice Notice to check for
119 * @return Poll_response found response or null
121 function getByNotice($notice)
123 return self::staticGet('uri', $notice->uri);
127 * Get the notice that belongs to this response...
133 return Notice::staticGet('uri', $this->uri);
138 return $this->getNotice()->bestUrl();
147 return Poll::staticGet('id', $this->poll_id);
150 * Save a new poll notice
152 * @param Profile $profile
153 * @param Poll $poll the poll being responded to
154 * @param int $selection (1-based)
155 * @param array $opts (poll responses)
157 * @return Notice saved notice
159 static function saveNew($profile, $poll, $selection, $options=null)
161 if (empty($options)) {
165 if (!$poll->isValidSelection($selection)) {
166 // TRANS: Client exception thrown when responding to a poll with an invalid option.
167 throw new ClientException(_m('Invalid poll selection.'));
169 $opts = $poll->getOptions();
170 $answer = $opts[$selection - 1];
172 $pr = new Poll_response();
173 $pr->id = UUID::gen();
174 $pr->profile_id = $profile->id;
175 $pr->poll_id = $poll->id;
176 $pr->selection = $selection;
178 if (array_key_exists('created', $options)) {
179 $pr->created = $options['created'];
181 $pr->created = common_sql_now();
184 if (array_key_exists('uri', $options)) {
185 $pr->uri = $options['uri'];
187 $pr->uri = common_local_url('showpollresponse',
188 array('id' => $pr->id));
191 common_log(LOG_DEBUG, "Saving poll response: $pr->id $pr->uri");
194 // TRANS: Notice content voting for a poll.
195 // TRANS: %s is the chosen option in the poll.
196 $content = sprintf(_m('voted for "%s"'),
198 $link = '<a href="' . htmlspecialchars($poll->uri) . '">' . htmlspecialchars($answer) . '</a>';
199 // TRANS: Rendered version of the notice content voting for a poll.
200 // TRANS: %s a link to the poll with the chosen option as link description.
201 $rendered = sprintf(_m('voted for "%s"'), $link);
205 $options = array_merge(array('urls' => array(),
206 'rendered' => $rendered,
208 'reply_to' => $poll->getNotice()->id,
209 'object_type' => PollPlugin::POLL_RESPONSE_OBJECT),
212 if (!array_key_exists('uri', $options)) {
213 $options['uri'] = $pr->uri;
216 $saved = Notice::saveNew($profile->id,
218 array_key_exists('source', $options) ?
219 $options['source'] : 'web',