3 * Data class for favorites talley
9 * @author Zach Copley <zach@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) 2010, 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')) {
34 require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
37 * Data class for favorites tally
39 * A class representing a total number of times a notice has been favored
43 * @author Zach Copley <zach@status.net>
44 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
45 * @link http://status.net/
47 class Fave_tally extends Memcached_DataObject
50 /* the code below is auto generated do not remove the above tag */
52 public $__table = 'fave_tally'; // table name
53 public $notice_id; // int(4) primary_key not_null
54 public $count; // int(4) not_null
55 public $modified; // datetime not_null default_0000-00-00%2000%3A00%3A00
58 function staticGet($k, $v = NULL) { return Memcached_DataObject::staticGet('Fave_tally', $k, $v); }
60 /* the code above is auto generated do not remove the tag below */
64 * return table definition for DB_DataObject
66 * @return array array of column definitions
72 'notice_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
73 'count' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
74 'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL
79 * return key definitions for DB_DataObject
81 * DB_DataObject needs to know about keys that the table has, since it
82 * won't appear in StatusNet's own keys list. In most cases, this will
83 * simply reference your keyTypes() function.
85 * @return array list of key field names
89 return array_keys($this->keyTypes());
93 * return key definitions for Memcached_DataObject
95 * Our caching system uses the same key definitions, but uses a different
96 * method to get them. This key information is used to store and clear
97 * cached data, so be sure to list any key that will be used for static
100 * @return array associative array of key definitions, field name to type:
101 * 'K' for primary key: for compound keys, add an entry for each component;
102 * 'U' for unique keys: compound keys are not well supported here.
106 return array('notice_id' => 'K');
110 * Magic formula for non-autoincrementing integer primary keys
112 * If a table has a single integer column as its primary key, DB_DataObject
113 * assumes that the column is auto-incrementing and makes a sequence table
114 * to do this incrementation. Since we don't need this for our class, we
115 * overload this method and return the magic formula that DB_DataObject needs.
117 * @return array magic three-false array that stops auto-incrementing.
119 function sequenceKey()
121 return array(false, false, false);
125 * Get a single object with multiple keys
127 * @param array $kv Map of key-value pairs
129 * @return User_flag_profile found object or null
131 function pkeyGet($kv)
133 return Memcached_DataObject::pkeyGet('Fave_tally', $kv);
137 * Increment a notice's tally
139 * @param integer $noticeID ID of notice we're tallying
141 * @return Fave_tally $tally the tally data object
143 static function increment($noticeID)
145 $tally = Fave_tally::ensureTally($noticeID);
147 $orig = clone($tally);
149 $result = $tally->update($orig);
153 // TRANS: Server exception.
154 // TRANS: %d is the notice ID (number).
155 _m("Couldn't update favorite tally for notice ID %d."),
158 throw new ServerException($msg);
165 * Decrement a notice's tally
167 * @param integer $noticeID ID of notice we're tallying
169 * @return Fave_tally $tally the tally data object
171 static function decrement($noticeID)
173 $tally = Fave_tally::ensureTally($noticeID);
175 if ($tally->count > 0) {
176 $orig = clone($tally);
178 $result = $tally->update($orig);
182 // TRANS: Server exception.
183 // TRANS: %d is the notice ID (number).
184 _m("Couldn't update favorite tally for notice ID %d."),
187 throw new ServerException($msg);
195 * Ensure a tally exists for a given notice. If we can't find
196 * one create one with the total number of existing faves
198 * @param integer $noticeID
200 * @return Fave_tally the tally data object
202 static function ensureTally($noticeID)
204 $tally = Fave_tally::staticGet('notice_id', $noticeID);
207 $tally = new Fave_tally();
208 $tally->notice_id = $noticeID;
209 $tally->count = Fave_tally::countExistingFaves($noticeID);
210 $result = $tally->insert();
213 // TRANS: Server exception.
214 // TRANS: %d is the notice ID (number).
215 _m("Couldn't create favorite tally for notice ID %d."),
218 throw new ServerException($msg);
226 * Count the number of faves a notice already has. Used to initalize
227 * a tally for a notice.
229 * @param integer $noticeID ID of the notice to count faves for
231 * @return integer $total total number of time the notice has been favored
233 static function countExistingFaves($noticeID)
236 $fave->notice_id = $noticeID;
237 $total = $fave->count();