Merge pull request #2313 from rabuzarus/0302_forum_class

forums.php is now ForumManager.php and providing class ForumManager

include/ForumManager.php

@@ -0,0 +1,190 @@
+<?php
+
+/**
+ * @file include/forum.php
+ * @brief Functions related to forum functionality *
+ */
+
+/**
+ * @brief This class handles functions 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(count($contacts)) {
+
+			$id = 0;
+
+			foreach($contacts as $contact) {
+
+				$selected = (($cid == $contact['id']) ? ' forum-selected' : '');
+
+				$entry = array(
+					'url' => z_root() . '/network?f=&cid=' . $contact['id'],
+					'external_url' => z_root() . '/redir/' . $contact['id'],
+					'name' => $contact['name'],
+					'cid' => $contact['id'],
+					'selected' 	=> $selected,
+					'micro' => 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;
+	}
+
+}

include/forums.php

@@ -1,185 +0,0 @@
-<?php
-
-/**
- * @file include/forums.php
- * @brief Functions related to forum functionality *
- */
-
-
-/**
- * @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
- */
-function get_forumlist($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
- * @param int $cid
- *	The contact id which is used to mark a forum as "selected"
- * @return string
- */
-function widget_forumlist($uid,$cid = 0) {
-
-	if(! intval(feature_enabled(local_user(),'forumlist_widget')))
-		return;
-
-	$o = '';
-
-	//sort by last updated item
-	$lastitem = true;
-
-	$contacts = get_forumlist($uid,true,$lastitem, true);
-	$total = count($contacts);
-	$visible_forums = 10;
-
-	if(count($contacts)) {
-
-		$id = 0;
-
-		foreach($contacts as $contact) {
-
-			$selected = (($cid == $contact['id']) ? ' forum-selected' : '');
-
-			$entry = array(
-				'url' => z_root() . '/network?f=&cid=' . $contact['id'],
-				'external_url' => z_root() . '/redir/' . $contact['id'],
-				'name' => $contact['name'],
-				'cid' => $contact['id'],
-				'selected' 	=> $selected,
-				'micro' => 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
- * @return string
- *
- */
-function forumlist_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 = get_forumlist($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
- *
- */
-
-function forums_count_unseen() {
-	$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;
-}

include/identity.php

@@ -3,7 +3,7 @@
  * @file include/identity.php
  */
 
-require_once('include/forums.php');
+require_once('include/ForumManager.php');
 require_once('include/bbcode.php');
 require_once("mod/proxy.php");
 
@@ -655,7 +655,7 @@ function advanced_profile(&$a) {
 	
 		//show subcribed forum if it is enabled in the usersettings
 		if (feature_enabled($uid,'forumlist_profile')) {
-			$profile['forumlist'] = array( t('Forums:'), forumlist_profile_advanced($uid));
+			$profile['forumlist'] = array( t('Forums:'), ForumManager::profile_advanced($uid));
 		}
 
 		if ($a->profile['uid'] == local_user())

mod/network.php

@@ -114,7 +114,7 @@ function network_init(&$a) {
 	require_once('include/group.php');
 	require_once('include/contact_widgets.php');
 	require_once('include/items.php');
-	require_once('include/forums.php');
+	require_once('include/ForumManager.php');
 
 	if(! x($a->page,'aside'))
 		$a->page['aside'] = '';
@@ -148,7 +148,7 @@ function network_init(&$a) {
 	}
 
 	$a->page['aside'] .= (feature_enabled(local_user(),'groups') ? group_side('network/0','network','standard',$group_id) : '');
-	$a->page['aside'] .= (feature_enabled(local_user(),'forumlist_widget') ? widget_forumlist(local_user(),$cid) : '');
+	$a->page['aside'] .= (feature_enabled(local_user(),'forumlist_widget') ? ForumManager::widget(local_user(),$cid) : '');
 	$a->page['aside'] .= posted_date_widget($a->get_baseurl() . '/network',local_user(),false);
 	$a->page['aside'] .= networks_widget($a->get_baseurl(true) . '/network',(x($_GET, 'nets') ? $_GET['nets'] : ''));
 	$a->page['aside'] .= saved_searches($search);

mod/ping.php

@@ -1,7 +1,7 @@
 <?php
 require_once("include/datetime.php");
 require_once('include/bbcode.php');
-require_once('include/forums.php');
+require_once('include/ForumManager.php');
 require_once('include/group.php');
 require_once("mod/proxy.php");
 
@@ -96,7 +96,7 @@ function ping_init(&$a) {
 			}
 
 			if(intval(feature_enabled(local_user(),'forumlist_widget'))) {
-				$forums_unseen = forums_count_unseen();
+				$forums_unseen = ForumManager::count_unseen_items();
 			}
 		}
 

view/theme/vier/theme.php

@@ -220,7 +220,7 @@ function vier_community_info() {
 	//Community_Pages at right_aside
 	if($show_pages AND local_user()) {
 
-		require_once('include/forums.php');
+		require_once('include/ForumManager.php');
 
 		if(x($_GET['cid']) && intval($_GET['cid']) != 0)
 			$cid = $_GET['cid'];
@@ -228,7 +228,7 @@ function vier_community_info() {
 		//sort by last updated item
 		$lastitem = true;
 
-		$contacts = get_forumlist($a->user['uid'],true,$lastitem, true);
+		$contacts = ForumManager::get_list($a->user['uid'],true,$lastitem, true);
 		$total = count($contacts);
 		$visible_forums = 10;