plugins onAutoload now only overloads if necessary (extlibs etc.)

[quix0rs-gnu-social.git] / plugins / AnonymousFave / classes / Fave_tally.php

diff --git a/plugins/AnonymousFave/classes/Fave_tally.php b/plugins/AnonymousFave/classes/Fave_tally.php
new file mode 100644 (file)
index 0000000..c9fe181
--- /dev/null
+++ b/plugins/AnonymousFave/classes/Fave_tally.php
@@ -0,0 +1,181 @@
+<?php
+/**
+ * Data class for favorites talley
+ *
+ * PHP version 5
+ *
+ * @category Data
+ * @package  StatusNet
+ * @author   Zach Copley <zach@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ *
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, StatusNet, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
+
+/**
+ * Data class for favorites tally
+ *
+ * A class representing a total number of times a notice has been favored
+ *
+ * @category Action
+ * @package  StatusNet
+ * @author   Zach Copley <zach@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ */
+class Fave_tally extends Managed_DataObject
+{
+    ###START_AUTOCODE
+    /* the code below is auto generated do not remove the above tag */
+
+    public $__table = 'fave_tally';          // table name
+    public $notice_id;                       // int(4)  primary_key not_null
+    public $count;                           // int(4)  not_null
+    public $created;                         // datetime()   not_null
+    public $modified;                        // datetime   not_null default_0000-00-00%2000%3A00%3A00
+
+    /* the code above is auto generated do not remove the tag below */
+    ###END_AUTOCODE
+
+    public static function schemaDef()
+    {
+        return array(
+            'fields' => array(
+                'notice_id' => array('type' => 'int', 'not null' => true, 'description' => 'notice id'),
+                'count' => array('type' => 'int', 'not null' => true, 'description' => 'the fave tally count'),
+                'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
+                'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
+            ),
+            'primary key' => array('notice_id'),
+            'foreign keys' => array(
+                'fave_tally_notice_id_fkey' => array('notice', array('notice_id' => 'id')),
+            ),
+        );
+    }
+
+    /**
+     * Increment a notice's tally
+     *
+     * @param integer $noticeID ID of notice we're tallying
+     *
+     * @return Fave_tally $tally the tally data object
+     */
+    static function increment($noticeID)
+    {
+        $tally = Fave_tally::ensureTally($noticeID);
+
+        $orig = clone($tally);
+        $tally->count++;
+        $result = $tally->update($orig);
+
+        if (!$result) {
+            $msg = sprintf(
+                // TRANS: Server exception.
+                // TRANS: %d is the notice ID (number).
+                _m("Could not update favorite tally for notice ID %d."),
+                $noticeID
+            );
+            throw new ServerException($msg);
+        }
+
+        return $tally;
+    }
+
+    /**
+     * Decrement a notice's tally
+     *
+     * @param integer $noticeID ID of notice we're tallying
+     *
+     * @return Fave_tally $tally the tally data object
+     */
+    static function decrement($noticeID)
+    {
+        $tally = Fave_tally::ensureTally($noticeID);
+
+        if ($tally->count > 0) {
+            $orig = clone($tally);
+            $tally->count--;
+            $result = $tally->update($orig);
+
+            if (!$result) {
+                $msg = sprintf(
+                    // TRANS: Server exception.
+                    // TRANS: %d is the notice ID (number).
+                    _m("Could not update favorite tally for notice ID %d."),
+                    $noticeID
+                );
+                throw new ServerException($msg);
+            }
+        }
+
+        return $tally;
+    }
+
+    /**
+     * Ensure a tally exists for a given notice. If we can't find
+     * one create one with the total number of existing faves
+     *
+     * @param integer $noticeID
+     *
+     * @return Fave_tally the tally data object
+     */
+    static function ensureTally($noticeID)
+    {
+        $tally = Fave_tally::getKV('notice_id', $noticeID);
+
+        if (!$tally) {
+            $tally = new Fave_tally();
+            $tally->notice_id = $noticeID;
+            $tally->count = Fave_tally::countExistingFaves($noticeID);
+            $result = $tally->insert();
+            if (!$result) {
+                $msg = sprintf(
+                    // TRANS: Server exception.
+                    // TRANS: %d is the notice ID (number).
+                    _m("Could not create favorite tally for notice ID %d."),
+                    $noticeID
+                );
+                throw new ServerException($msg);
+            }
+        }
+
+        return $tally;
+    }
+
+    /**
+     * Count the number of faves a notice already has. Used to initalize
+     * a tally for a notice.
+     *
+     * @param integer $noticeID ID of the notice to count faves for
+     *
+     * @return integer $total total number of time the notice has been favored
+     */
+    static function countExistingFaves($noticeID)
+    {
+        $fave = new Fave();
+        $fave->notice_id = $noticeID;
+        $total = $fave->count();
+        return $total;
+    }
+}