3 * Data class for counting greetings
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) 2009, 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 counting greetings
39 * We use the DB_DataObject framework for data classes in StatusNet. Each
40 * table maps to a particular data class, making it easier to manipulate
43 * Data classes should extend Memcached_DataObject, the (slightly misnamed)
44 * extension of DB_DataObject that provides caching, internationalization,
45 * and other bits of good functionality to StatusNet-specific data classes.
49 * @author Evan Prodromou <evan@status.net>
50 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
51 * @link http://status.net/
55 class User_greeting_count extends Memcached_DataObject
57 public $__table = 'user_greeting_count'; // table name
58 public $user_id; // int(4) primary_key not_null
59 public $greeting_count; // int(4)
62 * Get an instance by key
64 * This is a utility method to get a single instance with a given key value.
66 * @param string $k Key to use to lookup (usually 'user_id' for this class)
67 * @param mixed $v Value to lookup
69 * @return User_greeting_count object found, or null for no hits
72 function staticGet($k, $v=null)
74 return Memcached_DataObject::staticGet('User_greeting_count', $k, $v);
78 * return table definition for DB_DataObject
80 * DB_DataObject needs to know something about the table to manipulate
81 * instances. This method provides all the DB_DataObject needs to know.
83 * @return array array of column definitions
87 return array('user_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
88 'greeting_count' => DB_DATAOBJECT_INT);
92 * return key definitions for DB_DataObject
94 * DB_DataObject needs to know about keys that the table has, since it
95 * won't appear in StatusNet's own keys list. In most cases, this will
96 * simply reference your keyTypes() function.
98 * @return array list of key field names
102 return array_keys($this->keyTypes());
106 * return key definitions for Memcached_DataObject
108 * Our caching system uses the same key definitions, but uses a different
109 * method to get them. This key information is used to store and clear
110 * cached data, so be sure to list any key that will be used for static
113 * @return array associative array of key definitions, field name to type:
114 * 'K' for primary key: for compound keys, add an entry for each component;
115 * 'U' for unique keys: compound keys are not well supported here.
119 return array('user_id' => 'K');
123 * Magic formula for non-autoincrementing integer primary keys
125 * If a table has a single integer column as its primary key, DB_DataObject
126 * assumes that the column is auto-incrementing and makes a sequence table
127 * to do this incrementation. Since we don't need this for our class, we
128 * overload this method and return the magic formula that DB_DataObject needs.
130 * @return array magic three-false array that stops auto-incrementing.
132 function sequenceKey()
134 return array(false, false, false);
138 * Increment a user's greeting count and return instance
140 * This method handles the ins and outs of creating a new greeting_count for a
141 * user or fetching the existing greeting count and incrementing its value.
143 * @param integer $user_id ID of the user to get a count for
145 * @return User_greeting_count instance for this user, with count already incremented.
147 static function inc($user_id)
149 $gc = User_greeting_count::staticGet('user_id', $user_id);
153 $gc = new User_greeting_count();
155 $gc->user_id = $user_id;
156 $gc->greeting_count = 1;
158 $result = $gc->insert();
161 // TRANS: Exception thrown when the user greeting count could not be saved in the database.
162 // TRANS: %d is a user ID (number).
163 throw Exception(sprintf(_m("Could not save new greeting count for %d."),
169 $gc->greeting_count++;
171 $result = $gc->update($orig);
174 // TRANS: Exception thrown when the user greeting count could not be saved in the database.
175 // TRANS: %d is a user ID (number).
176 throw Exception(sprintf(_m('Could not increment greeting count for %d.'),