plugins/Poll/classes/Poll_response.php

   1 <?php
   2 /**
   3  * Data class to record responses to polls
   4  *
   5  * PHP version 5
   6  *
   7  * @category PollPlugin
   8  * @package  StatusNet
   9  * @author   Brion Vibber <brion@status.net>
  10  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  11  * @link     http://status.net/
  12  *
  13  * StatusNet - the distributed open-source microblogging tool
  14  * Copyright (C) 2011, StatusNet, Inc.
  15  *
  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.
  20  *
  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.
  25  *
  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/>.
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * For storing the poll options and such
  36  *
  37  * @category PollPlugin
  38  * @package  StatusNet
  39  * @author   Brion Vibber <brion@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  41  * @link     http://status.net/
  42  *
  43  * @see      DB_DataObject
  44  */
  45 class Poll_response extends Managed_DataObject
  46 {
  47     public $__table = 'poll_response'; // table name
  48     public $id;          // char(36) primary key not null -> UUID
  49     public $uri;         // varchar(191)   not 255 because utf8mb4 takes more space
  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
  54
  55     /**
  56      * The One True Thingy that must be defined and declared.
  57      */
  58     public static function schemaDef()
  59     {
  60         return array(
  61             'description' => 'Record of responses to polls',
  62             'fields' => array(
  63                 'id' => array('type' => 'char', 'length' => 36, 'not null' => true, 'description' => 'UUID of the response'),
  64                 'uri' => array('type' => 'varchar', 'length' => 191, 'not null' => true, 'description' => 'UUID to the response notice'),
  65                 'poll_id' => array('type' => 'char', 'length' => 36, 'not null' => true, 'description' => 'UUID of poll being responded to'),
  66                 'profile_id' => array('type' => 'int'),
  67                 'selection' => array('type' => 'int'),
  68                 'created' => array('type' => 'datetime', 'not null' => true),
  69             ),
  70             'primary key' => array('id'),
  71             'unique keys' => array(
  72                 'poll_uri_key' => array('uri'),
  73                 'poll_response_poll_id_profile_id_key' => array('poll_id', 'profile_id'),
  74             ),
  75             'indexes' => array(
  76                 'poll_response_profile_id_poll_id_index' => array('profile_id', 'poll_id'),
  77             )
  78         );
  79     }
  80
  81     /**
  82      * Get a poll response based on a notice
  83      *
  84      * @param Notice $notice Notice to check for
  85      *
  86      * @return Poll_response found response or null
  87      */
  88     static function getByNotice(Notice $notice)
  89     {
  90         return self::getKV('uri', $notice->uri);
  91     }
  92
  93     /**
  94      * Get the notice that belongs to this response...
  95      *
  96      * @return Notice
  97      */
  98     function getNotice()
  99     {
 100         return Notice::getKV('uri', $this->uri);
 101     }
 102
 103     function getUrl()
 104     {
 105         return $this->getNotice()->getUrl();
 106     }
 107
 108     /**
 109      *
 110      * @return Poll
 111      */
 112     function getPoll()
 113     {
 114         return Poll::getKV('id', $this->poll_id);
 115     }
 116     /**
 117      * Save a new poll notice
 118      *
 119      * @param Profile $profile
 120      * @param Poll    $poll the poll being responded to
 121      * @param int     $selection (1-based)
 122      * @param array   $opts (poll responses)
 123      *
 124      * @return Notice saved notice
 125      */
 126     static function saveNew(Profile $profile, $poll, $selection, array $options=array())
 127     {
 128         if (!$poll->isValidSelection($selection)) {
 129             // TRANS: Client exception thrown when responding to a poll with an invalid option.
 130             throw new ClientException(_m('Invalid poll selection.'));
 131         }
 132         $opts = $poll->getOptions();
 133         $answer = $opts[$selection - 1];
 134
 135         $pr = new Poll_response();
 136         $pr->id          = UUID::gen();
 137         $pr->profile_id  = $profile->id;
 138         $pr->poll_id     = $poll->id;
 139         $pr->selection   = $selection;
 140
 141         if (array_key_exists('created', $options)) {
 142             $pr->created = $options['created'];
 143         } else {
 144             $pr->created = common_sql_now();
 145         }
 146
 147         if (array_key_exists('uri', $options)) {
 148             $pr->uri = $options['uri'];
 149         } else {
 150             $pr->uri = common_local_url('showpollresponse',
 151                                         array('id' => $pr->id));
 152         }
 153
 154         common_debug("Saving poll response: $pr->id $pr->uri");
 155         $pr->insert();
 156
 157         // TRANS: Notice content voting for a poll.
 158         // TRANS: %s is the chosen option in the poll.
 159         $content  = sprintf(_m('voted for "%s"'),
 160                             $answer);
 161         $link = '<a href="' . htmlspecialchars($poll->uri) . '">' . htmlspecialchars($answer) . '</a>';
 162         // TRANS: Rendered version of the notice content voting for a poll.
 163         // TRANS: %s a link to the poll with the chosen option as link description.
 164         $rendered = sprintf(_m('voted for "%s"'), $link);
 165
 166         $tags    = array();
 167
 168         $options = array_merge(array('urls' => array(),
 169                                      'rendered' => $rendered,
 170                                      'tags' => $tags,
 171                                      'reply_to' => $poll->getNotice()->id,
 172                                      'object_type' => PollPlugin::POLL_RESPONSE_OBJECT),
 173                                $options);
 174
 175         if (!array_key_exists('uri', $options)) {
 176             $options['uri'] = $pr->uri;
 177         }
 178
 179         $saved = Notice::saveNew($profile->id,
 180                                  $content,
 181                                  array_key_exists('source', $options) ?
 182                                  $options['source'] : 'web',
 183                                  $options);
 184
 185         return $saved;
 186     }
 187 }