]> git.mxchange.org Git - friendica.git/commitdiff
Forum class - rename Class CamelCase and rename some methods
authorrabuzarus <>
Thu, 4 Feb 2016 13:47:20 +0000 (14:47 +0100)
committerrabuzarus <>
Thu, 4 Feb 2016 13:47:20 +0000 (14:47 +0100)
include/Forum.php [new file with mode: 0644]
include/forum.php [deleted file]
include/identity.php
mod/network.php
mod/ping.php
view/theme/vier/theme.php

diff --git a/include/Forum.php b/include/Forum.php
new file mode 100644 (file)
index 0000000..847affa
--- /dev/null
@@ -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 Forum {
+
+       /**
+        * @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;
+       }
+
+}
\ No newline at end of file
diff --git a/include/forum.php b/include/forum.php
deleted file mode 100644 (file)
index 290f013..0000000
+++ /dev/null
@@ -1,190 +0,0 @@
-<?php
-
-/**
- * @file include/forum.php
- * @brief Functions related to forum functionality *
- */
-
-/**
- * @brief This class handles functions related to the forum functionality
- */
-class forum {
-
-       /**
-        * @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_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 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_forumlist($uid,$cid = 0) {
-
-               if(! intval(feature_enabled(local_user(),'forumlist_widget')))
-                       return;
-
-               $o = '';
-
-               //sort by last updated item
-               $lastitem = true;
-
-               $contacts = self::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 The ID of the User
-        * @return string
-        *
-        */
-       public static 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 = self::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
-        *
-        */
-       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;
-       }
-
-}
\ No newline at end of file
index 87c91e6dccc51adaec85f68fe3f52743b754ac8d..a6932f0911ecd511f6171fc6e9c0a03418c2649b 100644 (file)
@@ -3,7 +3,7 @@
  * @file include/identity.php
  */
 
-require_once('include/forum.php');
+require_once('include/Forum.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:'), forum::forumlist_profile_advanced($uid));
+                       $profile['forumlist'] = array( t('Forums:'), Forum::profile_advanced($uid));
                }
 
                if ($a->profile['uid'] == local_user())
index 151384cd67b25341ddba06ff3df88a5fa5bc8878..b72d72d78f6ffde334ad90f96d19b2615161ab9d 100644 (file)
@@ -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/forum.php');
+       require_once('include/Forum.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') ? forum::widget_forumlist(local_user(),$cid) : '');
+       $a->page['aside'] .= (feature_enabled(local_user(),'forumlist_widget') ? Forum::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);
index 3d34e2fe626ba9b175b9a57bad065299c0366e8a..2abad13b0ba7f1ec2a31f67ade07421257dbf022 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 require_once("include/datetime.php");
 require_once('include/bbcode.php');
-require_once('include/forum.php');
+require_once('include/Forum.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 = forum::count_unseen_items();
+                               $forums_unseen = Forum::count_unseen_items();
                        }
                }
 
index 93a6d5ce08be9aaea73c74e34fd5dd34d39cdca0..cd2c31f1880f9007539e62b2de49c75ed35df46b 100644 (file)
@@ -220,7 +220,7 @@ function vier_community_info() {
        //Community_Pages at right_aside
        if($show_pages AND local_user()) {
 
-               require_once('include/forum.php');
+               require_once('include/Forum.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 = forum::get_forumlist($a->user['uid'],true,$lastitem, true);
+               $contacts = Forum::get_list($a->user['uid'],true,$lastitem, true);
                $total = count($contacts);
                $visible_forums = 10;