141 lines
4.3 KiB
PHP
141 lines
4.3 KiB
PHP
<?php
|
|
/**
|
|
* Data class to store local search subscriptions
|
|
*
|
|
* PHP version 5
|
|
*
|
|
* @category SearchSubPlugin
|
|
* @package StatusNet
|
|
* @author Brion Vibber <brion@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) 2011, 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);
|
|
}
|
|
|
|
/**
|
|
* For storing the search subscriptions
|
|
*
|
|
* @category PollPlugin
|
|
* @package StatusNet
|
|
* @author Brion Vibber <brion@status.net>
|
|
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
|
|
* @link http://status.net/
|
|
*
|
|
* @see DB_DataObject
|
|
*/
|
|
|
|
class SearchSub extends Managed_DataObject
|
|
{
|
|
public $__table = 'searchsub'; // table name
|
|
public $search; // text
|
|
public $profile_id; // int -> profile.id
|
|
public $created; // datetime
|
|
|
|
/**
|
|
* Get an instance by key
|
|
*
|
|
* This is a utility method to get a single instance with a given key value.
|
|
*
|
|
* @param string $k Key to use to lookup (usually 'user_id' for this class)
|
|
* @param mixed $v Value to lookup
|
|
*
|
|
* @return SearchSub object found, or null for no hits
|
|
*
|
|
*/
|
|
function staticGet($k, $v=null)
|
|
{
|
|
return Memcached_DataObject::staticGet('SearchSub', $k, $v);
|
|
}
|
|
|
|
/**
|
|
* Get an instance by compound key
|
|
*
|
|
* This is a utility method to get a single instance with a given set of
|
|
* key-value pairs. Usually used for the primary key for a compound key; thus
|
|
* the name.
|
|
*
|
|
* @param array $kv array of key-value mappings
|
|
*
|
|
* @return SearchSub object found, or null for no hits
|
|
*
|
|
*/
|
|
function pkeyGet($kv)
|
|
{
|
|
return Memcached_DataObject::pkeyGet('SearchSub', $kv);
|
|
}
|
|
|
|
/**
|
|
* The One True Thingy that must be defined and declared.
|
|
*/
|
|
public static function schemaDef()
|
|
{
|
|
return array(
|
|
'description' => 'SearchSubPlugin search subscription records',
|
|
'fields' => array(
|
|
'search' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'hash search associated with this subscription'),
|
|
'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'profile ID of subscribing user'),
|
|
'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
|
|
),
|
|
'primary key' => array('search', 'profile_id'),
|
|
'foreign keys' => array(
|
|
'searchsub_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
|
|
),
|
|
'indexes' => array(
|
|
'searchsub_created_idx' => array('created'),
|
|
'searchsub_profile_id_tag_idx' => array('profile_id', 'search'),
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Start a search subscription!
|
|
*
|
|
* @param profile $profile subscriber
|
|
* @param string $search subscribee
|
|
* @return SearchSub
|
|
*/
|
|
static function start(Profile $profile, $search)
|
|
{
|
|
$ts = new SearchSub();
|
|
$ts->search = $search;
|
|
$ts->profile_id = $profile->id;
|
|
$ts->created = common_sql_now();
|
|
$ts->insert();
|
|
return $ts;
|
|
}
|
|
|
|
/**
|
|
* End a search subscription!
|
|
*
|
|
* @param profile $profile subscriber
|
|
* @param string $search subscribee
|
|
*/
|
|
static function cancel(Profile $profile, $search)
|
|
{
|
|
$ts = SearchSub::pkeyGet(array('search' => $search,
|
|
'profile_id' => $profile->id));
|
|
if ($ts) {
|
|
$ts->delete();
|
|
}
|
|
}
|
|
}
|