3 * Data class for email summary status
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) 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 email summaries
39 * Email summary information for users
43 * @author Evan Prodromou <evan@status.net>
44 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
45 * @link http://status.net/
50 class Email_summary_status extends Memcached_DataObject
52 public $__table = 'email_summary_status'; // table name
53 public $user_id; // int(4) primary_key not_null
54 public $send_summary; // tinyint not_null
55 public $last_summary_id; // int(4) null
56 public $created; // datetime not_null
57 public $modified; // datetime not_null
60 * Get an instance by key
62 * @param string $k Key to use to lookup (usually 'user_id' for this class)
63 * @param mixed $v Value to lookup
65 * @return Email_summary_status object found, or null for no hits
68 function staticGet($k, $v=null)
70 return Memcached_DataObject::staticGet('email_summary_status', $k, $v);
74 * return table definition for DB_DataObject
76 * DB_DataObject needs to know something about the table to manipulate
77 * instances. This method provides all the DB_DataObject needs to know.
79 * @return array array of column definitions
84 return array('user_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
85 'send_summary' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
86 'last_summary_id' => DB_DATAOBJECT_INT,
87 'created' => DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
88 'modified' => DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
92 * return key definitions for DB_DataObject
94 * @return array list of key field names
99 return array_keys($this->keyTypes());
103 * return key definitions for Memcached_DataObject
105 * Our caching system uses the same key definitions, but uses a different
106 * method to get them. This key information is used to store and clear
107 * cached data, so be sure to list any key that will be used for static
110 * @return array associative array of key definitions, field name to type:
111 * 'K' for primary key: for compound keys, add an entry for each component;
112 * 'U' for unique keys: compound keys are not well supported here.
116 return array('user_id' => 'K');
120 * Magic formula for non-autoincrementing integer primary keys
122 * @return array magic three-false array that stops auto-incrementing.
125 function sequenceKey()
127 return array(false, false, false);
133 * @param integer $user_id ID of the user to get a count for
135 * @return int flag for whether to send this user a summary email
138 static function getSendSummary($user_id)
140 $ess = Email_summary_status::staticGet('user_id', $user_id);
143 return $ess->send_summary;
150 * Get email summary status for a user
152 * @param integer $user_id ID of the user to get a count for
154 * @return Email_summary_status instance for this user, with count already incremented.
157 static function getLastSummaryID($user_id)
159 $ess = Email_summary_status::staticGet('user_id', $user_id);
162 return $ess->last_summary_id;