f2b690f876
fix some doxygen description
190 lines
4.6 KiB
PHP
190 lines
4.6 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @file include/ForumManager.php
|
|
* @brief ForumManager class with it's methods related to forum functionality *
|
|
*/
|
|
|
|
/**
|
|
* @brief This class handles metheods related to the forum functionality
|
|
*/
|
|
class ForumManager {
|
|
|
|
/**
|
|
* @brief Function to list all forums a user is connected with
|
|
*
|
|
* @param int $uid of the profile owner
|
|
* @param boolean $showhidden
|
|
* Show frorums which are not hidden
|
|
* @param boolean $lastitem
|
|
* Sort by lastitem
|
|
* @param boolean $showprivate
|
|
* Show private groups
|
|
*
|
|
* @returns array
|
|
* 'url' => forum url
|
|
* 'name' => forum name
|
|
* 'id' => number of the key from the array
|
|
* 'micro' => contact photo in format micro
|
|
*/
|
|
public static function get_list($uid, $showhidden = true, $lastitem, $showprivate = false) {
|
|
|
|
$forumlist = array();
|
|
|
|
$order = (($showhidden) ? '' : ' AND NOT `hidden` ');
|
|
$order .= (($lastitem) ? ' ORDER BY `last-item` DESC ' : ' ORDER BY `name` ASC ');
|
|
$select = '`forum` ';
|
|
if ($showprivate) {
|
|
$select = '(`forum` OR `prv`)';
|
|
}
|
|
|
|
$contacts = q("SELECT `contact`.`id`, `contact`.`url`, `contact`.`name`, `contact`.`micro` FROM `contact`
|
|
WHERE `network`= 'dfrn' AND $select AND `uid` = %d
|
|
AND NOT `blocked` AND NOT `hidden` AND NOT `pending` AND NOT `archive`
|
|
AND `success_update` > `failure_update`
|
|
$order ",
|
|
intval($uid)
|
|
);
|
|
|
|
if (!$contacts)
|
|
return($forumlist);
|
|
|
|
foreach($contacts as $contact) {
|
|
$forumlist[] = array(
|
|
'url' => $contact['url'],
|
|
'name' => $contact['name'],
|
|
'id' => $contact['id'],
|
|
'micro' => $contact['micro'],
|
|
);
|
|
}
|
|
return($forumlist);
|
|
}
|
|
|
|
|
|
/**
|
|
* @brief Forumlist widget
|
|
*
|
|
* Sidebar widget to show subcribed friendica forums. If activated
|
|
* in the settings, it appears at the notwork page sidebar
|
|
*
|
|
* @param int $uid The ID of the User
|
|
* @param int $cid
|
|
* The contact id which is used to mark a forum as "selected"
|
|
* @return string
|
|
*/
|
|
public static function widget($uid,$cid = 0) {
|
|
|
|
if(! intval(feature_enabled(local_user(),'forumlist_widget')))
|
|
return;
|
|
|
|
$o = '';
|
|
|
|
//sort by last updated item
|
|
$lastitem = true;
|
|
|
|
$contacts = self::get_list($uid,true,$lastitem, true);
|
|
$total = count($contacts);
|
|
$visible_forums = 10;
|
|
|
|
if(dba::is_result($contacts)) {
|
|
|
|
$id = 0;
|
|
|
|
foreach($contacts as $contact) {
|
|
|
|
$selected = (($cid == $contact['id']) ? ' forum-selected' : '');
|
|
|
|
$entry = array(
|
|
'url' => 'network?f=&cid=' . $contact['id'],
|
|
'external_url' => 'redir/' . $contact['id'],
|
|
'name' => $contact['name'],
|
|
'cid' => $contact['id'],
|
|
'selected' => $selected,
|
|
'micro' => App::remove_baseurl(proxy_url($contact['micro'], false, PROXY_SIZE_MICRO)),
|
|
'id' => ++$id,
|
|
);
|
|
$entries[] = $entry;
|
|
}
|
|
|
|
$tpl = get_markup_template('widget_forumlist.tpl');
|
|
|
|
$o .= replace_macros($tpl,array(
|
|
'$title' => t('Forums'),
|
|
'$forums' => $entries,
|
|
'$link_desc' => t('External link to forum'),
|
|
'$total' => $total,
|
|
'$visible_forums' => $visible_forums,
|
|
'$showmore' => t('show more'),
|
|
));
|
|
}
|
|
|
|
return $o;
|
|
}
|
|
|
|
/**
|
|
* @brief Format forumlist as contact block
|
|
*
|
|
* This function is used to show the forumlist in
|
|
* the advanced profile.
|
|
*
|
|
* @param int $uid The ID of the User
|
|
* @return string
|
|
*
|
|
*/
|
|
public static function profile_advanced($uid) {
|
|
|
|
$profile = intval(feature_enabled($uid,'forumlist_profile'));
|
|
if(! $profile)
|
|
return;
|
|
|
|
$o = '';
|
|
|
|
// place holder in case somebody wants configurability
|
|
$show_total = 9999;
|
|
|
|
//don't sort by last updated item
|
|
$lastitem = false;
|
|
|
|
$contacts = self::get_list($uid,false,$lastitem,false);
|
|
|
|
$total_shown = 0;
|
|
|
|
foreach($contacts as $contact) {
|
|
$forumlist .= micropro($contact,false,'forumlist-profile-advanced');
|
|
$total_shown ++;
|
|
if($total_shown == $show_total)
|
|
break;
|
|
}
|
|
|
|
if(count($contacts) > 0)
|
|
$o .= $forumlist;
|
|
return $o;
|
|
}
|
|
|
|
/**
|
|
* @brief count unread forum items
|
|
*
|
|
* Count unread items of connected forums and private groups
|
|
*
|
|
* @return array
|
|
* 'id' => contact id
|
|
* 'name' => contact/forum name
|
|
* 'count' => counted unseen forum items
|
|
*
|
|
*/
|
|
public static function count_unseen_items() {
|
|
$r = q("SELECT `contact`.`id`, `contact`.`name`, COUNT(*) AS `count` FROM `item`
|
|
INNER JOIN `contact` ON `item`.`contact-id` = `contact`.`id`
|
|
WHERE `item`.`uid` = %d AND `item`.`visible` AND NOT `item`.`deleted` AND `item`.`unseen`
|
|
AND `contact`.`network`= 'dfrn' AND (`contact`.`forum` OR `contact`.`prv`)
|
|
AND NOT `contact`.`blocked` AND NOT `contact`.`hidden`
|
|
AND NOT `contact`.`pending` AND NOT `contact`.`archive`
|
|
AND `contact`.`success_update` > `failure_update`
|
|
GROUP BY `contact`.`id` ",
|
|
intval(local_user())
|
|
);
|
|
|
|
return $r;
|
|
}
|
|
|
|
}
|