226 lines
7.3 KiB
PHP
226 lines
7.3 KiB
PHP
<?php
|
|
/**
|
|
* Data class to record responses to polls
|
|
*
|
|
* PHP version 5
|
|
*
|
|
* @category PollPlugin
|
|
* @package StatusNet
|
|
* @author Brion Vibber <brion@status.net>
|
|
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
|
|
* @link http://status.net/
|
|
*
|
|
* StatusNet - the distributed open-source microblogging tool
|
|
* Copyright (C) 2011, StatusNet, Inc.
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
if (!defined('STATUSNET')) {
|
|
exit(1);
|
|
}
|
|
|
|
/**
|
|
* For storing the poll options and such
|
|
*
|
|
* @category PollPlugin
|
|
* @package StatusNet
|
|
* @author Brion Vibber <brion@status.net>
|
|
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
|
|
* @link http://status.net/
|
|
*
|
|
* @see DB_DataObject
|
|
*/
|
|
class Poll_response extends Managed_DataObject
|
|
{
|
|
public $__table = 'poll_response'; // table name
|
|
public $id; // char(36) primary key not null -> UUID
|
|
public $poll_id; // char(36) -> poll.id UUID
|
|
public $profile_id; // int -> profile.id
|
|
public $selection; // int -> choice #
|
|
public $created; // datetime
|
|
|
|
/**
|
|
* Get an instance by key
|
|
*
|
|
* This is a utility method to get a single instance with a given key value.
|
|
*
|
|
* @param string $k Key to use to lookup (usually 'user_id' for this class)
|
|
* @param mixed $v Value to lookup
|
|
*
|
|
* @return User_greeting_count object found, or null for no hits
|
|
*
|
|
*/
|
|
function staticGet($k, $v=null)
|
|
{
|
|
return Memcached_DataObject::staticGet('Poll_response', $k, $v);
|
|
}
|
|
|
|
/**
|
|
* Get an instance by compound key
|
|
*
|
|
* This is a utility method to get a single instance with a given set of
|
|
* key-value pairs. Usually used for the primary key for a compound key; thus
|
|
* the name.
|
|
*
|
|
* @param array $kv array of key-value mappings
|
|
*
|
|
* @return Bookmark object found, or null for no hits
|
|
*
|
|
*/
|
|
function pkeyGet($kv)
|
|
{
|
|
return Memcached_DataObject::pkeyGet('Poll_response', $kv);
|
|
}
|
|
|
|
/**
|
|
* The One True Thingy that must be defined and declared.
|
|
*/
|
|
public static function schemaDef()
|
|
{
|
|
return array(
|
|
'description' => 'Record of responses to polls',
|
|
'fields' => array(
|
|
'id' => array('type' => 'char', 'length' => 36, 'not null' => true, 'description' => 'UUID of the response'),
|
|
'uri' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'UUID to the response notice'),
|
|
'poll_id' => array('type' => 'char', 'length' => 36, 'not null' => true, 'description' => 'UUID of poll being responded to'),
|
|
'profile_id' => array('type' => 'int'),
|
|
'selection' => array('type' => 'int'),
|
|
'created' => array('type' => 'datetime', 'not null' => true),
|
|
),
|
|
'primary key' => array('id'),
|
|
'unique keys' => array(
|
|
'poll_uri_key' => array('uri'),
|
|
'poll_response_poll_id_profile_id_key' => array('poll_id', 'profile_id'),
|
|
),
|
|
'indexes' => array(
|
|
'poll_response_profile_id_poll_id_index' => array('profile_id', 'poll_id'),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get a poll response based on a notice
|
|
*
|
|
* @param Notice $notice Notice to check for
|
|
*
|
|
* @return Poll_response found response or null
|
|
*/
|
|
function getByNotice($notice)
|
|
{
|
|
return self::staticGet('uri', $notice->uri);
|
|
}
|
|
|
|
/**
|
|
* Get the notice that belongs to this response...
|
|
*
|
|
* @return Notice
|
|
*/
|
|
function getNotice()
|
|
{
|
|
return Notice::staticGet('uri', $this->uri);
|
|
}
|
|
|
|
function bestUrl()
|
|
{
|
|
return $this->getNotice()->bestUrl();
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @return Poll
|
|
*/
|
|
function getPoll()
|
|
{
|
|
return Poll::staticGet('id', $this->poll_id);
|
|
}
|
|
/**
|
|
* Save a new poll notice
|
|
*
|
|
* @param Profile $profile
|
|
* @param Poll $poll the poll being responded to
|
|
* @param int $selection (1-based)
|
|
* @param array $opts (poll responses)
|
|
*
|
|
* @return Notice saved notice
|
|
*/
|
|
static function saveNew($profile, $poll, $selection, $options=null)
|
|
{
|
|
if (empty($options)) {
|
|
$options = array();
|
|
}
|
|
|
|
if (!$poll->isValidSelection($selection)) {
|
|
// TRANS: Client exception thrown when responding to a poll with an invalid option.
|
|
throw new ClientException(_m('Invalid poll selection.'));
|
|
}
|
|
$opts = $poll->getOptions();
|
|
$answer = $opts[$selection - 1];
|
|
|
|
$pr = new Poll_response();
|
|
$pr->id = UUID::gen();
|
|
$pr->profile_id = $profile->id;
|
|
$pr->poll_id = $poll->id;
|
|
$pr->selection = $selection;
|
|
|
|
if (array_key_exists('created', $options)) {
|
|
$pr->created = $options['created'];
|
|
} else {
|
|
$pr->created = common_sql_now();
|
|
}
|
|
|
|
if (array_key_exists('uri', $options)) {
|
|
$pr->uri = $options['uri'];
|
|
} else {
|
|
$pr->uri = common_local_url('showpollresponse',
|
|
array('id' => $pr->id));
|
|
}
|
|
|
|
common_log(LOG_DEBUG, "Saving poll response: $pr->id $pr->uri");
|
|
$pr->insert();
|
|
|
|
// TRANS: Notice content voting for a poll.
|
|
// TRANS: %s is the chosen option in the poll.
|
|
$content = sprintf(_m('voted for "%s"'),
|
|
$answer);
|
|
$link = '<a href="' . htmlspecialchars($poll->uri) . '">' . htmlspecialchars($answer) . '</a>';
|
|
// TRANS: Rendered version of the notice content voting for a poll.
|
|
// TRANS: %s a link to the poll with the chosen option as link description.
|
|
$rendered = sprintf(_m('voted for "%s"'), $link);
|
|
|
|
$tags = array();
|
|
$replies = array();
|
|
|
|
$options = array_merge(array('urls' => array(),
|
|
'rendered' => $rendered,
|
|
'tags' => $tags,
|
|
'replies' => $replies,
|
|
'reply_to' => $poll->getNotice()->id,
|
|
'object_type' => PollPlugin::POLL_RESPONSE_OBJECT),
|
|
$options);
|
|
|
|
if (!array_key_exists('uri', $options)) {
|
|
$options['uri'] = $pr->uri;
|
|
}
|
|
|
|
$saved = Notice::saveNew($profile->id,
|
|
$content,
|
|
array_key_exists('source', $options) ?
|
|
$options['source'] : 'web',
|
|
$options);
|
|
|
|
return $saved;
|
|
}
|
|
}
|