/**
* Data class for favorites tally
*
- * A class representing a total number of times a notice has been favorited
+ * A class representing a total number of times a notice has been favored
*
* @category Action
* @package StatusNet
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://status.net/
*/
-
-class Fave_tally extends Memcached_DataObject
+class Fave_tally extends Managed_DataObject
{
###START_AUTOCODE
/* the code below is auto generated do not remove the above tag */
public $count; // int(4) not_null
public $modified; // datetime not_null default_0000-00-00%2000%3A00%3A00
- /* Static get */
- function staticGet($k, $v = NULL) { return Memcached_DataObject::staticGet('Fave_tally', $k, $v); }
-
/* the code above is auto generated do not remove the tag below */
###END_AUTOCODE
*
* @return array list of key field names
*/
-
function keys()
{
return array_keys($this->keyTypes());
* 'K' for primary key: for compound keys, add an entry for each component;
* 'U' for unique keys: compound keys are not well supported here.
*/
-
function keyTypes()
{
return array('notice_id' => 'K');
*
* @return array magic three-false array that stops auto-incrementing.
*/
-
-
function sequenceKey()
{
return array(false, false, false);
*
* @return User_flag_profile found object or null
*/
-
function pkeyGet($kv)
{
return Memcached_DataObject::pkeyGet('Fave_tally', $kv);
*
* @return Fave_tally $tally the tally data object
*/
-
static function increment($noticeID)
{
- common_debug("XXXXXXXXX Fave_tally::increment()");
$tally = Fave_tally::ensureTally($noticeID);
$orig = clone($tally);
if (!$result) {
$msg = sprintf(
- _m("Couldn't update favorite tally for notice ID %d."),
- $notice_id
+ // 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 Fave_tally $tally the tally data object
*/
-
static function decrement($noticeID)
{
- common_debug("XXXXXXXXX Fave_tally::decrement()");
-
$tally = Fave_tally::ensureTally($noticeID);
if ($tally->count > 0) {
if (!$result) {
$msg = sprintf(
- _m("Couldn't update favorite tally for notice ID %d."),
- $notice_id
+ // 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);
}
/**
* Ensure a tally exists for a given notice. If we can't find
- * one create one.
+ * 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::staticGet('notice_id', $notice_id);
+ $tally = Fave_tally::getKV('notice_id', $noticeID);
if (!$tally) {
- common_debug("Fave_tally::ensureTally - creating tally for notice " . $notice_id);
$tally = new Fave_tally();
- $tally->notice_id = $notice_id;
- $tally->count = 0;
+ $tally->notice_id = $noticeID;
+ $tally->count = Fave_tally::countExistingFaves($noticeID);
$result = $tally->insert();
if (!$result) {
$msg = sprintf(
- _m("Couldn't create favorite tally for notice ID %d."),
- $notice_id
+ // 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;
+ }
}