gnu-social/plugins/EmailSummary/classes/Email_summary_status.php

102 lines
3.5 KiB
PHP
Raw Normal View History

2010-11-08 15:36:19 +00:00
<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
2010-11-08 15:36:19 +00:00
/**
* Data class for email summary status
*
* @category Data
* @package GNUsocial
* @author Evan Prodromou <evan@status.net>
* @copyright 2010 StatusNet, Inc.
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
2010-11-08 15:36:19 +00:00
*/
defined('GNUSOCIAL') || die();
2010-11-08 15:36:19 +00:00
/**
* Data class for email summaries
*
2010-11-08 15:36:19 +00:00
* Email summary information for users
*
* @category Action
* @copyright 2010 StatusNet, Inc.
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
2010-11-08 15:36:19 +00:00
*
* @see DB_DataObject
2010-11-08 15:36:19 +00:00
*/
class Email_summary_status extends Managed_DataObject
2010-11-08 15:36:19 +00:00
{
public $__table = 'email_summary_status'; // table name
public $user_id; // int(4) primary_key not_null
public $send_summary; // bool not_null default_true
public $last_summary_id; // int(4) null
public $created; // datetime not_null
public $modified; // timestamp not_null
2010-11-08 15:36:19 +00:00
public static function schemaDef()
2010-11-08 15:36:19 +00:00
{
return array(
'fields' => array(
'user_id' => array('type' => 'int', 'not null' => true, 'description' => 'user id'),
'send_summary' => array('type' => 'bool', 'default' => true, 'not null' => true, 'description' => 'whether to send a summary or not'),
'last_summary_id' => array('type' => 'int', 'description' => 'last summary id'),
'created' => array('type' => 'datetime', 'description' => 'date this record was created'),
'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
),
'primary key' => array('user_id'),
'foreign keys' => array(
'email_summary_status_user_id_fkey' => array('user', array('user_id' => 'id')),
),
);
2010-11-08 15:36:19 +00:00
}
/**
* Helper function
*
* @param integer $user_id ID of the user to get a count for
*
* @return int flag for whether to send this user a summary email
*/
public static function getSendSummary($user_id)
2010-11-08 15:36:19 +00:00
{
$ess = Email_summary_status::getKV('user_id', $user_id);
2010-11-08 15:36:19 +00:00
if (!empty($ess)) {
return $ess->send_summary;
} else {
return 1;
}
2010-11-08 15:36:19 +00:00
}
/**
* Get email summary status for a user
*
* @param integer $user_id ID of the user to get a count for
*
* @return Email_summary_status instance for this user, with count already incremented.
*/
public static function getLastSummaryID($user_id)
2010-11-08 15:36:19 +00:00
{
$ess = Email_summary_status::getKV('user_id', $user_id);
if (!empty($ess)) {
return $ess->last_summary_id;
} else {
return null;
}
2010-11-08 15:36:19 +00:00
}
}