3 * Data class to mark notices as bookmarks
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/
46 class Poll extends Managed_DataObject
48 public $__table = 'poll'; // table name
49 public $id; // char(36) primary key not null -> UUID
51 public $profile_id; // int -> profile.id
52 public $question; // text
53 public $options; // text; newline(?)-delimited
54 public $created; // datetime
57 * Get an instance by compound key
59 * This is a utility method to get a single instance with a given set of
60 * key-value pairs. Usually used for the primary key for a compound key; thus
63 * @param array $kv array of key-value mappings
65 * @return Bookmark object found, or null for no hits
70 return Memcached_DataObject::pkeyGet('Poll', $kv);
74 * The One True Thingy that must be defined and declared.
76 public static function schemaDef()
79 'description' => 'Per-notice poll data for Poll plugin',
81 'id' => array('type' => 'char', 'length' => 36, 'not null' => true, 'description' => 'UUID'),
82 'uri' => array('type' => 'varchar', 'length' => 255, 'not null' => true),
83 'profile_id' => array('type' => 'int'),
84 'question' => array('type' => 'text'),
85 'options' => array('type' => 'text'),
86 'created' => array('type' => 'datetime', 'not null' => true),
88 'primary key' => array('id'),
89 'unique keys' => array(
90 'poll_uri_key' => array('uri'),
96 * Get a bookmark based on a notice
98 * @param Notice $notice Notice to check for
100 * @return Poll found poll or null
102 static function getByNotice($notice)
104 return self::getKV('uri', $notice->uri);
107 function getOptions()
109 return explode("\n", $this->options);
113 * Is this a valid selection index?
115 * @param numeric $selection (1-based)
118 function isValidSelection($selection)
120 if ($selection != intval($selection)) {
123 if ($selection < 1 || $selection > count($this->getOptions())) {
131 return Notice::getKV('uri', $this->uri);
136 return $this->getNotice()->bestUrl();
140 * Get the response of a particular user to this poll, if any.
142 * @param Profile $profile
143 * @return Poll_response object or null
145 function getResponse(Profile $profile)
147 $pr = Poll_response::pkeyGet(array('poll_id' => $this->id,
148 'profile_id' => $profile->id));
152 function countResponses()
154 $pr = new Poll_response();
155 $pr->poll_id = $this->id;
156 $pr->groupBy('selection');
157 $pr->selectAdd('count(profile_id) as votes');
161 while ($pr->fetch()) {
162 // Votes list 1-based
163 // Array stores 0-based
164 $raw[$pr->selection - 1] = $pr->votes;
168 foreach (array_keys($this->getOptions()) as $key) {
169 if (isset($raw[$key])) {
170 $counts[$key] = $raw[$key];
179 * Save a new poll notice
181 * @param Profile $profile
182 * @param string $question
183 * @param array $opts (poll responses)
185 * @return Notice saved notice
187 static function saveNew($profile, $question, $opts, $options=null)
189 if (empty($options)) {
195 $p->id = UUID::gen();
196 $p->profile_id = $profile->id;
197 $p->question = $question;
198 $p->options = implode("\n", $opts);
200 if (array_key_exists('created', $options)) {
201 $p->created = $options['created'];
203 $p->created = common_sql_now();
206 if (array_key_exists('uri', $options)) {
207 $p->uri = $options['uri'];
209 $p->uri = common_local_url('showpoll',
210 array('id' => $p->id));
213 common_log(LOG_DEBUG, "Saving poll: $p->id $p->uri");
216 // TRANS: Notice content creating a poll.
217 // TRANS: %1$s is the poll question, %2$s is a link to the poll.
218 $content = sprintf(_m('Poll: %1$s %2$s'),
221 $link = '<a href="' . htmlspecialchars($p->uri) . '">' . htmlspecialchars($question) . '</a>';
222 // TRANS: Rendered version of the notice content creating a poll.
223 // TRANS: %s is a link to the poll with the question as link description.
224 $rendered = sprintf(_m('Poll: %s'), $link);
226 $tags = array('poll');
229 $options = array_merge(array('urls' => array(),
230 'rendered' => $rendered,
232 'replies' => $replies,
233 'object_type' => PollPlugin::POLL_OBJECT),
236 if (!array_key_exists('uri', $options)) {
237 $options['uri'] = $p->uri;
240 $saved = Notice::saveNew($profile->id,
242 array_key_exists('source', $options) ?
243 $options['source'] : 'web',