]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/UserFlag/User_flag_profile.php
fix indentation in sendemailsummary.php
[quix0rs-gnu-social.git] / plugins / UserFlag / User_flag_profile.php
index 658259452436aae780d56956ffe9841c7bf79391..f4e9844dfc9ddf67ba89c3e43e188c629aabe1b3 100644 (file)
@@ -44,7 +44,6 @@ require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  * @link     http://status.net/
  */
-
 class User_flag_profile extends Memcached_DataObject
 {
     ###START_AUTOCODE
@@ -67,7 +66,6 @@ class User_flag_profile extends Memcached_DataObject
      *
      * @return array array of column definitions
      */
-
     function table()
     {
         return array(
@@ -81,12 +79,36 @@ class User_flag_profile extends Memcached_DataObject
     /**
      * return key definitions for DB_DataObject
      *
-     * @return array key definitions
+     * @return array of key names
      */
-
     function keys()
     {
-        return array('profile_id' => 'N', 'user_id' => 'N');
+        return array_keys($this->keyTypes());
+    }
+
+    /**
+     * return key definitions for DB_DataObject
+     *
+     * @return array map of key definitions
+     */
+    function keyTypes()
+    {
+        return array('profile_id' => 'K', 'user_id' => 'K');
+    }
+
+    /**
+     * Magic formula for non-autoincrementing integer primary keys
+     *
+     * If a table has a single integer column as its primary key, DB_DataObject
+     * assumes that the column is auto-incrementing and makes a sequence table
+     * to do this incrementation. Since we don't need this for our class, we
+     * overload this method and return the magic formula that DB_DataObject needs.
+     *
+     * @return array magic three-false array that stops auto-incrementing.
+     */
+    function sequenceKey()
+    {
+        return array(false, false, false);
     }
 
     /**
@@ -96,8 +118,7 @@ class User_flag_profile extends Memcached_DataObject
      *
      * @return User_flag_profile found object or null
      */
-
-    function &pkeyGet($kv)
+    function pkeyGet($kv)
     {
         return Memcached_DataObject::pkeyGet('User_flag_profile', $kv);
     }
@@ -110,7 +131,6 @@ class User_flag_profile extends Memcached_DataObject
      *
      * @return boolean true if exists, else false
      */
-
     static function exists($profile_id, $user_id)
     {
         $ufp = User_flag_profile::pkeyGet(array('profile_id' => $profile_id,
@@ -119,6 +139,14 @@ class User_flag_profile extends Memcached_DataObject
         return !empty($ufp);
     }
 
+    /**
+     * Create a new flag
+     *
+     * @param integer $user_id    ID of user who's flagging
+     * @param integer $profile_id ID of profile being flagged
+     *
+     * @return boolean success flag
+     */
     static function create($user_id, $profile_id)
     {
         $ufp = new User_flag_profile();
@@ -128,7 +156,8 @@ class User_flag_profile extends Memcached_DataObject
         $ufp->created    = common_sql_now();
 
         if (!$ufp->insert()) {
-            $msg = sprintf(_("Couldn't flag profile '%d' for review."),
+            // TRANS: Server exception.
+            $msg = sprintf(_m('Couldn\'t flag profile "%d" for review.'),
                            $profile_id);
             throw new ServerException($msg);
         }