plugins/EmailRegistration/Email_confirmation.php

   1 <?php
   2 /**
   3  * Data class for counting greetings
   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) 2009, 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 counting greetings
  38  *
  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
  41  * data.
  42  *
  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.
  46  *
  47  * @category Action
  48  * @package  StatusNet
  49  * @author   Evan Prodromou <evan@status.net>
  50  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  51  * @link     http://status.net/
  52  *
  53  * @see      DB_DataObject
  54  */
  55 class User_greeting_count extends Memcached_DataObject
  56 {
  57     public $__table = 'user_greeting_count'; // table name
  58     public $user_id;                         // int(4)  primary_key not_null
  59     public $greeting_count;                  // int(4)
  60
  61     /**
  62      * Get an instance by key
  63      *
  64      * This is a utility method to get a single instance with a given key value.
  65      *
  66      * @param string $k Key to use to lookup (usually 'user_id' for this class)
  67      * @param mixed  $v Value to lookup
  68      *
  69      * @return User_greeting_count object found, or null for no hits
  70      *
  71      */
  72     function staticGet($k, $v=null)
  73     {
  74         return Memcached_DataObject::staticGet('User_greeting_count', $k, $v);
  75     }
  76
  77     /**
  78      * return table definition for DB_DataObject
  79      *
  80      * DB_DataObject needs to know something about the table to manipulate
  81      * instances. This method provides all the DB_DataObject needs to know.
  82      *
  83      * @return array array of column definitions
  84      */
  85     function table()
  86     {
  87         return array('user_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  88                      'greeting_count' => DB_DATAOBJECT_INT);
  89     }
  90
  91     /**
  92      * return key definitions for DB_DataObject
  93      *
  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.
  97      *
  98      * @return array list of key field names
  99      */
 100     function keys()
 101     {
 102         return array_keys($this->keyTypes());
 103     }
 104
 105     /**
 106      * return key definitions for Memcached_DataObject
 107      *
 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
 111      * lookups.
 112      *
 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.
 116      */
 117     function keyTypes()
 118     {
 119         return array('user_id' => 'K');
 120     }
 121
 122     /**
 123      * Magic formula for non-autoincrementing integer primary keys
 124      *
 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.
 129      *
 130      * @return array magic three-false array that stops auto-incrementing.
 131      */
 132     function sequenceKey()
 133     {
 134         return array(false, false, false);
 135     }
 136
 137     /**
 138      * Increment a user's greeting count and return instance
 139      *
 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.
 142      *
 143      * @param integer $user_id ID of the user to get a count for
 144      *
 145      * @return User_greeting_count instance for this user, with count already incremented.
 146      */
 147     static function inc($user_id)
 148     {
 149         $gc = User_greeting_count::staticGet('user_id', $user_id);
 150
 151         if (empty($gc)) {
 152
 153             $gc = new User_greeting_count();
 154
 155             $gc->user_id        = $user_id;
 156             $gc->greeting_count = 1;
 157
 158             $result = $gc->insert();
 159
 160             if (!$result) {
 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."),
 164                                         $user_id));
 165             }
 166         } else {
 167             $orig = clone($gc);
 168
 169             $gc->greeting_count++;
 170
 171             $result = $gc->update($orig);
 172
 173             if (!$result) {
 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.'),
 177                                         $user_id));
 178             }
 179         }
 180
 181         return $gc;
 182     }
 183 }