plugins/UserFlag/User_flag_profile.php

   1 <?php
   2 /**
   3  * Data class for profile flags
   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 profile flags
  38  *
  39  * A class representing a user flagging another profile for review.
  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 class User_flag_profile extends Managed_DataObject
  48 {
  49     ###START_AUTOCODE
  50     /* the code below is auto generated do not remove the above tag */
  51
  52     public $__table = 'user_flag_profile';               // table name
  53     public $profile_id;                      // int(4)  primary_key not_null
  54     public $user_id;                         // int(4)  primary_key not_null
  55     public $created;                         // datetime   not_null default_0000-00-00%2000%3A00%3A00
  56     public $cleared;                         // datetime   not_null default_0000-00-00%2000%3A00%3A00
  57
  58     /* the code above is auto generated do not remove the tag below */
  59     ###END_AUTOCODE
  60
  61     /**
  62      * return table definition for DB_DataObject
  63      *
  64      * @return array array of column definitions
  65      */
  66     function table()
  67     {
  68         return array(
  69                      'profile_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  70                      'user_id'    => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
  71                      'created'    => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
  72                      'cleared'    => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME
  73                      );
  74     }
  75
  76     /**
  77      * return key definitions for DB_DataObject
  78      *
  79      * @return array of key names
  80      */
  81     function keys()
  82     {
  83         return array_keys($this->keyTypes());
  84     }
  85
  86     /**
  87      * return key definitions for DB_DataObject
  88      *
  89      * @return array map of key definitions
  90      */
  91     function keyTypes()
  92     {
  93         return array('profile_id' => 'K', 'user_id' => 'K');
  94     }
  95
  96     /**
  97      * Magic formula for non-autoincrementing integer primary keys
  98      *
  99      * If a table has a single integer column as its primary key, DB_DataObject
 100      * assumes that the column is auto-incrementing and makes a sequence table
 101      * to do this incrementation. Since we don't need this for our class, we
 102      * overload this method and return the magic formula that DB_DataObject needs.
 103      *
 104      * @return array magic three-false array that stops auto-incrementing.
 105      */
 106     function sequenceKey()
 107     {
 108         return array(false, false, false);
 109     }
 110
 111     /**
 112      * Get a single object with multiple keys
 113      *
 114      * @param array $kv Map of key-value pairs
 115      *
 116      * @return User_flag_profile found object or null
 117      */
 118     function pkeyGet($kv)
 119     {
 120         return Memcached_DataObject::pkeyGet('User_flag_profile', $kv);
 121     }
 122
 123     /**
 124      * Check if a flag exists for given profile and user
 125      *
 126      * @param integer $profile_id Profile to check for
 127      * @param integer $user_id    User to check for
 128      *
 129      * @return boolean true if exists, else false
 130      */
 131     static function exists($profile_id, $user_id)
 132     {
 133         $ufp = User_flag_profile::pkeyGet(array('profile_id' => $profile_id,
 134                                                 'user_id' => $user_id));
 135
 136         return !empty($ufp);
 137     }
 138
 139     /**
 140      * Create a new flag
 141      *
 142      * @param integer $user_id    ID of user who's flagging
 143      * @param integer $profile_id ID of profile being flagged
 144      *
 145      * @return boolean success flag
 146      */
 147     static function create($user_id, $profile_id)
 148     {
 149         $ufp = new User_flag_profile();
 150
 151         $ufp->profile_id = $profile_id;
 152         $ufp->user_id    = $user_id;
 153         $ufp->created    = common_sql_now();
 154
 155         if (!$ufp->insert()) {
 156             // TRANS: Server exception.
 157             // TRANS: %d is a profile ID (number).
 158             $msg = sprintf(_m('Could not flag profile "%d" for review.'),
 159                            $profile_id);
 160             throw new ServerException($msg);
 161         }
 162
 163         $ufp->free();
 164
 165         return true;
 166     }
 167 }