plugins/EmailSummary/Email_summary_status.php

   1 <?php
   2 /**
   3  * Data class for email summary status
   4  *
   5  * PHP version 5
   6  *
   7  * @category Data
   8  * @package  StatusNet
   9  * @author   Evan Prodromou <evan@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) 2010, 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 require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
  35
  36 /**
  37  * Data class for email summaries
  38  *
  39  * Email summary information for users
  40  *
  41  * @category Action
  42  * @package  StatusNet
  43  * @author   Evan Prodromou <evan@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  45  * @link     http://status.net/
  46  *
  47  * @see      DB_DataObject
  48  */
  49 class Email_summary_status extends Memcached_DataObject
  50 {
  51     public $__table = 'email_summary_status'; // table name
  52     public $user_id;                         // int(4)  primary_key not_null
  53     public $send_summary;                    // tinyint not_null
  54     public $last_summary_id;                 // int(4)  null
  55     public $created;                         // datetime not_null
  56     public $modified;                        // datetime not_null
  57
  58     /**
  59      * Get an instance by key
  60      *
  61      * @param string $k Key to use to lookup (usually 'user_id' for this class)
  62      * @param mixed  $v Value to lookup
  63      *
  64      * @return Email_summary_status object found, or null for no hits
  65      *
  66      */
  67     function staticGet($k, $v=null)
  68     {
  69         return Memcached_DataObject::staticGet('email_summary_status', $k, $v);
  70     }
  71
  72     /**
  73      * return table definition for DB_DataObject
  74      *
  75      * DB_DataObject needs to know something about the table to manipulate
  76      * instances. This method provides all the DB_DataObject needs to know.
  77      *
  78      * @return array array of column definitions
  79      */
  80     function table()
  81     {
  82         return array('user_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  83                      'send_summary' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  84                      'last_summary_id' => DB_DATAOBJECT_INT,
  85                      'created' => DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
  86                      'modified' => DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
  87     }
  88
  89     /**
  90      * return key definitions for DB_DataObject
  91      *
  92      * @return array list of key field names
  93      */
  94     function keys()
  95     {
  96         return array_keys($this->keyTypes());
  97     }
  98
  99     /**
 100      * return key definitions for Memcached_DataObject
 101      *
 102      * Our caching system uses the same key definitions, but uses a different
 103      * method to get them. This key information is used to store and clear
 104      * cached data, so be sure to list any key that will be used for static
 105      * lookups.
 106      *
 107      * @return array associative array of key definitions, field name to type:
 108      *         'K' for primary key: for compound keys, add an entry for each component;
 109      *         'U' for unique keys: compound keys are not well supported here.
 110      */
 111     function keyTypes()
 112     {
 113         return array('user_id' => 'K');
 114     }
 115
 116     /**
 117      * Magic formula for non-autoincrementing integer primary keys
 118      *
 119      * @return array magic three-false array that stops auto-incrementing.
 120      */
 121     function sequenceKey()
 122     {
 123         return array(false, false, false);
 124     }
 125
 126     /**
 127      * Helper function
 128      *
 129      * @param integer $user_id ID of the user to get a count for
 130      *
 131      * @return int flag for whether to send this user a summary email
 132      */
 133     static function getSendSummary($user_id)
 134     {
 135         $ess = Email_summary_status::staticGet('user_id', $user_id);
 136
 137         if (!empty($ess)) {
 138             return $ess->send_summary;
 139         } else {
 140             return 1;
 141         }
 142     }
 143
 144     /**
 145      * Get email summary status for a user
 146      *
 147      * @param integer $user_id ID of the user to get a count for
 148      *
 149      * @return Email_summary_status instance for this user, with count already incremented.
 150      */
 151     static function getLastSummaryID($user_id)
 152     {
 153         $ess = Email_summary_status::staticGet('user_id', $user_id);
 154
 155         if (!empty($ess)) {
 156             return $ess->last_summary_id;
 157         } else {
 158             return null;
 159         }
 160     }
 161 }