]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/UserFlag/User_flag_profile.php
pkeyGet is now static and more similar to getKV
[quix0rs-gnu-social.git] / plugins / UserFlag / User_flag_profile.php
index bc4251cf7f11010d62128c4d196e0cd9602c86c7..cd641fc53cc94185fc065e78b77ffc604b506db4 100644 (file)
@@ -44,8 +44,7 @@ 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
+class User_flag_profile extends Managed_DataObject
 {
     ###START_AUTOCODE
     /* the code below is auto generated do not remove the above tag */
@@ -56,9 +55,6 @@ class User_flag_profile extends Memcached_DataObject
     public $created;                         // datetime   not_null default_0000-00-00%2000%3A00%3A00
     public $cleared;                         // datetime   not_null default_0000-00-00%2000%3A00%3A00
 
-    /* Static get */
-    function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('User_flag_profile',$k,$v); }
-
     /* the code above is auto generated do not remove the tag below */
     ###END_AUTOCODE
 
@@ -67,7 +63,6 @@ class User_flag_profile extends Memcached_DataObject
      *
      * @return array array of column definitions
      */
-
     function table()
     {
         return array(
@@ -81,36 +76,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 key definitions
+     * @return array map of key definitions
      */
-
     function keyTypes()
     {
-        return $this->keys();
+        return array('profile_id' => 'K', 'user_id' => 'K');
     }
 
     /**
-     * Get a single object with multiple keys
+     * Magic formula for non-autoincrementing integer primary keys
      *
-     * @param array $kv Map of key-value pairs
+     * 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 User_flag_profile found object or null
+     * @return array magic three-false array that stops auto-incrementing.
      */
-
-    function pkeyGet($kv)
+    function sequenceKey()
     {
-        return Memcached_DataObject::pkeyGet('User_flag_profile', $kv);
+        return array(false, false, false);
     }
 
     /**
@@ -121,7 +116,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,
@@ -130,6 +124,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();
@@ -139,7 +141,9 @@ 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.
+            // TRANS: %d is a profile ID (number).
+            $msg = sprintf(_m('Could not flag profile "%d" for review.'),
                            $profile_id);
             throw new ServerException($msg);
         }