3 * Data class for event RSVPs
9 * @author Evan Prodromou <evan@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 * Data class for event RSVPs
39 * @author Evan Prodromou <evan@status.net>
40 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
41 * @link http://status.net/
43 * @see Managed_DataObject
46 class RSVP extends Managed_DataObject
48 const POSITIVE = 'http://activitystrea.ms/schema/1.0/rsvp-yes';
49 const POSSIBLE = 'http://activitystrea.ms/schema/1.0/rsvp-maybe';
50 const NEGATIVE = 'http://activitystrea.ms/schema/1.0/rsvp-no';
52 public $__table = 'rsvp'; // table name
53 public $id; // varchar(36) UUID
54 public $uri; // varchar(255)
55 public $profile_id; // int
56 public $event_id; // varchar(36) UUID
57 public $result; // tinyint
58 public $created; // datetime
61 * Get an instance by key
63 * @param string $k Key to use to lookup (usually 'id' for this class)
64 * @param mixed $v Value to lookup
66 * @return RSVP object found, or null for no hits
69 function staticGet($k, $v=null)
71 return Memcached_DataObject::staticGet('RSVP', $k, $v);
75 * Get an instance by compound key
77 * @param array $kv array of key-value mappings
79 * @return Bookmark object found, or null for no hits
85 return Memcached_DataObject::pkeyGet('RSVP', $kv);
89 * Add the compound profile_id/event_id index to our cache keys
90 * since the DB_DataObject stuff doesn't understand compound keys
91 * except for the primary.
95 function _allCacheKeys() {
96 $keys = parent::_allCacheKeys();
97 $keys[] = self::multicacheKey('RSVP', array('profile_id' => $this->profile_id,
98 'event_id' => $this->event_id));
103 * The One True Thingy that must be defined and declared.
105 public static function schemaDef()
108 'description' => 'Plan to attend event',
110 'id' => array('type' => 'char',
113 'description' => 'UUID'),
114 'uri' => array('type' => 'varchar',
117 'profile_id' => array('type' => 'int'),
118 'event_id' => array('type' => 'char',
121 'description' => 'UUID'),
122 'result' => array('type' => 'tinyint',
123 'description' => '1, 0, or null for three-state yes, no, maybe'),
124 'created' => array('type' => 'datetime',
127 'primary key' => array('id'),
128 'unique keys' => array(
129 'rsvp_uri_key' => array('uri'),
130 'rsvp_profile_event_key' => array('profile_id', 'event_id'),
132 'foreign keys' => array('rsvp_event_id_key' => array('event', array('event_id' => 'id')),
133 'rsvp_profile_id__key' => array('profile', array('profile_id' => 'id'))),
134 'indexes' => array('rsvp_created_idx' => array('created')),
138 function saveNew($profile, $event, $result, $options=array())
140 if (array_key_exists('uri', $options)) {
141 $other = RSVP::staticGet('uri', $options['uri']);
142 if (!empty($other)) {
143 throw new ClientException(_('RSVP already exists.'));
147 $other = RSVP::pkeyGet(array('profile_id' => $profile->id,
148 'event_id' => $event->id));
150 if (!empty($other)) {
151 throw new ClientException(_('RSVP already exists.'));
156 $rsvp->id = UUID::gen();
157 $rsvp->profile_id = $profile->id;
158 $rsvp->event_id = $event->id;
159 $rsvp->result = self::codeFor($result);
161 if (array_key_exists('created', $options)) {
162 $rsvp->created = $options['created'];
164 $rsvp->created = common_sql_now();
167 if (array_key_exists('uri', $options)) {
168 $rsvp->uri = $options['uri'];
170 $rsvp->uri = common_local_url('showrsvp',
171 array('id' => $rsvp->id));
176 // XXX: come up with something sexier
178 $content = sprintf(_('RSVPed %s for an event.'),
179 ($result == RSVP::POSITIVE) ? _('positively') :
180 ($result == RSVP::NEGATIVE) ? _('negatively') : _('possibly'));
182 $rendered = $content;
184 $options = array_merge(array('object_type' => $result),
187 if (!array_key_exists('uri', $options)) {
188 $options['uri'] = $rsvp->uri;
191 $eventNotice = $event->getNotice();
193 if (!empty($eventNotice)) {
194 $options['reply_to'] = $eventNotice->id;
197 $saved = Notice::saveNew($profile->id,
199 array_key_exists('source', $options) ?
200 $options['source'] : 'web',
206 function codeFor($verb)
208 return ($verb == RSVP::POSITIVE) ? 1 :
209 ($verb == RSVP::NEGATIVE) ? 0 : null;
212 static function verbFor($code)
214 return ($code == 1) ? RSVP::POSITIVE :
215 ($code == 0) ? RSVP::NEGATIVE : null;
220 $notice = Notice::staticGet('uri', $this->uri);
221 if (empty($notice)) {
222 throw new ServerException("RSVP {$this->id} does not correspond to a notice in the DB.");
227 static function fromNotice($notice)
229 return RSVP::staticGet('uri', $notice->uri);
232 static function forEvent($event)
234 $rsvps = array(RSVP::POSITIVE => array(), RSVP::NEGATIVE => array(), RSVP::POSSIBLE => array());
238 $rsvp->event_id = $event->id;
241 while ($rsvp->fetch()) {
242 $verb = self::verbFor($rsvp->result);
243 $rsvps[$verb][] = clone($rsvp);