Changeset 4088

Timestamp:

03/08/2011 06:35:03 AM (14 years ago)

Author:

johnjamesjacoby

Message:

More auditing of _slug and _root_slug functions.

Introduce functions for updating '$bp->is_' globals to prevent loading $bp global in several functions.

Various phpDoc fixes and whitespace clean-up. (1.3 trunk)

Location:

trunk

Files:

• bp-activity/bp-activity-screens.php (modified) (6 diffs)
• bp-blogs/bp-blogs-screens.php (modified) (2 diffs)
• bp-core/admin/bp-core-update.php (modified) (4 diffs)
• bp-core/bp-core-functions.php (modified) (1 diff)
• bp-core/bp-core-widgets.php (modified) (1 diff)
• bp-forums/bp-forums-filters.php (modified) (1 diff)
• bp-forums/bp-forums-screens.php (modified) (1 diff)
• bp-forums/bp-forums-template.php (modified) (3 diffs)
• bp-groups/bp-groups-loader.php (modified) (1 diff)
• bp-groups/bp-groups-screens.php (modified) (1 diff)
• bp-members/bp-members-functions.php (modified) (2 diffs)
• bp-members/bp-members-loader.php (modified) (3 diffs)
• bp-members/bp-members-notifications.php (modified) (1 diff)
• bp-members/bp-members-screens.php (modified) (2 diffs)
• bp-members/bp-members-signup.php (modified) (6 diffs)
• bp-members/bp-members-template.php (modified) (4 diffs)
• bp-xprofile/bp-xprofile-filters.php (modified) (1 diff)

trunk/bp-activity/bp-activity-screens.php

@@ -1 +1 @@
 <?php
-
-/*******************************************************************************
- * Screen Functions
- *
- * Screen functions are the controllers of BuddyPress. They will execute when
- * their specific URL is caught. They will first save or manipulate data using
- * business functions, then pass on the user to a template file.
- */
 
 /**
@@ -15 +7 @@
  */
 function bp_activity_screen_index() {
-    global $bp;
-
-    if ( !bp_displayed_user_id() && bp_is_current_component( 'activity' ) && !bp_current_action() ) {
-        $bp->is_directory = true;
+    if ( !bp_displayed_user_id() && bp_is_activity_component() && !bp_current_action() ) {
+        bp_update_is_directory( true, 'activity' );
 
         do_action( 'bp_activity_screen_index' );
@@ -33 +23 @@
 
 function bp_activity_screen_friends() {
-    global $bp;
-
     if ( !bp_is_active( 'friends' ) )
         return false;
 
-    if ( !is_super_admin() )
-        $bp->is_item_admin = false;
-
+    bp_update_is_item_admin( is_super_admin(), 'activity' );
     do_action( 'bp_activity_screen_friends' );
     bp_core_load_template( apply_filters( 'bp_activity_template_friends_activity', 'members/single/home' ) );
@@ -46 +32 @@
 
 function bp_activity_screen_groups() {
-    global $bp;
-
     if ( !bp_is_active( 'groups' ) )
         return false;
 
-    if ( !is_super_admin() )
-        $bp->is_item_admin = false;
-
+    bp_update_is_item_admin( is_super_admin(), 'activity' );
     do_action( 'bp_activity_screen_groups' );
     bp_core_load_template( apply_filters( 'bp_activity_template_groups_activity', 'members/single/home' ) );
@@ -59 +41 @@
 
 function bp_activity_screen_favorites() {
-    global $bp;
-
-    if ( !is_super_admin() )
-        $bp->is_item_admin = false;
-
+    bp_update_is_item_admin( is_super_admin(), 'activity' );
     do_action( 'bp_activity_screen_favorites' );
     bp_core_load_template( apply_filters( 'bp_activity_template_favorite_activity', 'members/single/home' ) );
@@ -69 +47 @@
 
 function bp_activity_screen_mentions() {
-    global $bp;
-
-    if ( !is_super_admin() )
-        $bp->is_item_admin = false;
-
+    bp_update_is_item_admin( is_super_admin(), 'activity' );
     do_action( 'bp_activity_screen_mentions' );
     bp_core_load_template( apply_filters( 'bp_activity_template_mention_activity', 'members/single/home' ) );

trunk/bp-blogs/bp-blogs-screens.php

@@ -1 +1 @@
 <?php
-
-/******************************************************************************
- * Screen functions are the controllers of BuddyPress. They will execute when their
- * specific URL is caught. They will first save or manipulate data using business
- * functions, then pass on the user to a template file.
- */
 
 function bp_blogs_screen_my_blogs() {
@@ -30 +24 @@
 
 function bp_blogs_screen_index() {
-    global $bp;
-
     if ( is_multisite() && bp_is_blogs_component() && !bp_current_action() ) {
-        $bp->is_directory = true;
+        bp_update_is_directory( true, 'blogs' );
 
         do_action( 'bp_blogs_screen_index' );

trunk/bp-core/admin/bp-core-update.php

@@ -332 +332 @@
 
         // Check for defined slugs
-        if ( isset( $bp->members->slug ) )
+        if ( !empty( $bp->members->slug ) )
             $members_slug = $bp->members->slug;
         else
-            $members_slug = __( 'Members', 'buddypress' );
+            $members_slug = __( 'members', 'buddypress' );
 
         // Groups
-        if ( isset( $bp->groups->slug ) )
-            $groups_slug = constant( 'BP_GROUPS_SLUG' );
+        if ( !empty( $bp->groups->slug ) )
+            $groups_slug = $bp->groups->slug;
         else
-            $groups_slug = __( 'Groups', 'buddypress' );
+            $groups_slug = __( 'groups', 'buddypress' );
 
         // Activity
-        if ( isset( $bp->activity->slug ) )
+        if ( !empty( $bp->activity->slug ) )
             $activity_slug = $bp->activity->slug;
         else
@@ -350 +350 @@
 
         // Forums
-        if ( isset( $bp->forums->slug ) )
+        if ( !empty( $bp->forums->slug ) )
             $forums_slug = $bp->forums->slug;
         else
@@ -356 +356 @@
 
         // Blogs
-        if ( isset( $bp->blogs->slug ) )
+        if ( !empty( $bp->blogs->slug ) )
             $blogs_slug = $bp->blogs->slug;
         else
@@ -362 +362 @@
 
         // Register
-        if ( isset( $bp->register->slug ) )
+        if ( !empty( $bp->register->slug ) )
             $register_slug = $bp->register->slug;
         else
             $register_slug = __( 'register', 'buddypress' );
 
-        if ( isset( $bp->activation->slug ) )
+        if ( !empty( $bp->activation->slug ) )
             $activation_slug = $bp->activation->slug;
         else

trunk/bp-core/bp-core-functions.php

@@ -762 +762 @@
     bp_core_update_page_meta( $page_ids );
 }
+
+/** Global Manipulators *******************************************************/
+
+/**
+ * Set the $bp->is_directory global
+ *
+ * @global obj $bp
+ * @param bool $is_directory
+ * @param str $component
+ */
+function bp_update_is_directory( $is_directory = false, $component = '' ) {
+    global $bp;
+
+    if ( empty( $component ) )
+        $component = bp_current_component();
+
+    $bp->is_directory = apply_filters( 'bp_update_is_directory', $is_directory, $component );
+}
+
+/**
+ * Set the $bp->is_item_admin global
+ *
+ * @global obj $bp
+ * @param bool $is_item_admin
+ * @param str $component
+ */
+function bp_update_is_item_admin( $is_item_admin = false, $component = '' ) {
+    global $bp;
+
+    if ( empty( $component ) )
+        $component = bp_current_component();
+
+    $bp->is_item_admin = apply_filters( 'bp_update_is_item_admin', $is_item_admin, $component );
+}
+
+/**
+ * Set the $bp->is_item_mod global
+ *
+ * @global obj $bp
+ * @param bool $is_item_mod
+ * @param str $component
+ */
+function bp_update_is_item_mod( $is_item_mod = false, $component = '' ) {
+    global $bp;
+
+    if ( empty( $component ) )
+        $component = bp_current_component();
+
+    $bp->is_item_mod = apply_filters( 'bp_update_is_item_mod', $is_item_mod, $component );
+}
+
 ?>

trunk/bp-core/bp-core-widgets.php

@@ -39 +39 @@
         <?php if ( bp_has_members( 'user_id=0&type=' . $instance['member_default'] . '&max=' . $instance['max_members'] . '&populate_extras=0' ) ) : ?>
             <div class="item-options" id="members-list-options">
-                <a href="<?php echo site_url() . '/' . $bp->members->slug ?>" id="newest-members" <?php if ( $instance['member_default'] == 'newest' ) : ?>class="selected"<?php endif; ?>><?php _e( 'Newest', 'buddypress' ) ?></a>
-                |  <a href="<?php echo site_url() . '/' . $bp->members->slug ?>" id="recently-active-members" <?php if ( $instance['member_default'] == 'active' ) : ?>class="selected"<?php endif; ?>><?php _e( 'Active', 'buddypress' ) ?></a>
+                <a href="<?php echo site_url( bp_get_members_root_slug() ); ?>" id="newest-members" <?php if ( $instance['member_default'] == 'newest' ) : ?>class="selected"<?php endif; ?>><?php _e( 'Newest', 'buddypress' ) ?></a>
+                |  <a href="<?php echo site_url( bp_get_members_root_slug() ); ?>" id="recently-active-members" <?php if ( $instance['member_default'] == 'active' ) : ?>class="selected"<?php endif; ?>><?php _e( 'Active', 'buddypress' ) ?></a>
 
                 <?php if ( bp_is_active( 'friends' ) ) : ?>
 
-                    | <a href="<?php echo site_url() . '/' . $bp->members->slug ?>" id="popular-members" <?php if ( $instance['member_default'] == 'popular' ) : ?>class="selected"<?php endif; ?>><?php _e( 'Popular', 'buddypress' ) ?></a>
+                    | <a href="<?php echo site_url( bp_get_members_root_slug() ); ?>" id="popular-members" <?php if ( $instance['member_default'] == 'popular' ) : ?>class="selected"<?php endif; ?>><?php _e( 'Popular', 'buddypress' ) ?></a>
 
                 <?php endif; ?>

trunk/bp-forums/bp-forums-filters.php

@@ -124 +124 @@
     $content = htmlspecialchars_decode( $content );
 
-    $pattern = "|<a href=&#039;" . bp_get_root_domain() . "/" . $bp->members->slug . "/[A-Za-z0-9-_\.]+/&#039; rel=&#039;nofollow&#039;>(@[A-Za-z0-9-_\.]+)</a>|";
+    $pattern = "|<a href=&#039;" . bp_get_root_domain() . "/" . bp_get_members_root_slug() . "/[A-Za-z0-9-_\.]+/&#039; rel=&#039;nofollow&#039;>(@[A-Za-z0-9-_\.]+)</a>|";
 
     $content = preg_replace( $pattern, "$1", $content );

trunk/bp-forums/bp-forums-screens.php

@@ -13 +13 @@
         }
 
-        $bp->is_directory = true;
+        bp_update_is_directory( true, 'forums' );
 
         do_action( 'bbpress_init' );

trunk/bp-forums/bp-forums-template.php

@@ -240 +240 @@
 
     // If $_GET['fs'] is set, let's auto populate the search_terms var
-    if ( isset( $bp->is_directory ) && !empty( $_GET['fs'] ) )
+    if ( bp_is_directory() && !empty( $_GET['fs'] ) )
         $search_terms = $_GET['fs'];
 
@@ -713 +713 @@
         global $bp;
 
-        if ( !$bp->is_directory || !$bp->current_action )
+        if ( !bp_is_directory() || !$bp->current_action )
             return 'newest';
 
@@ -726 +726 @@
         global $bp;
 
-        if ( $bp->is_directory && $bp->forums->slug == $bp->current_component )
+        if ( bp_is_directory() && $bp->forums->slug == $bp->current_component )
             return apply_filters( 'bp_get_forums_tag_name', $bp->action_variables[0] );
     }

trunk/bp-groups/bp-groups-loader.php

@@ -99 +99 @@
             // Using "item" not "group" for generic support in other components.
             if ( is_super_admin() )
-                $bp->is_item_admin = 1;
+                bp_update_is_item_admin( true, 'groups' );
             else
-                $bp->is_item_admin = groups_is_user_admin( $bp->loggedin_user->id, $this->current_group->id );
+                bp_update_is_item_admin( groups_is_user_admin( $bp->loggedin_user->id, $this->current_group->id ), 'groups' );
 
             // If the user is not an admin, check if they are a moderator
-            if ( empty( $bp->is_item_admin ) )
-                $bp->is_item_mod = groups_is_user_mod( $bp->loggedin_user->id, $this->current_group->id );
+            if ( !bp_is_item_admin() )
+                bp_update_is_item_mod  ( groups_is_user_mod  ( $bp->loggedin_user->id, $this->current_group->id ), 'groups' );
 
             // Is the logged in user a member of the group?

trunk/bp-groups/bp-groups-screens.php

@@ -10 +10 @@
 
 function groups_directory_groups_setup() {
-    global $bp;
-
     if ( bp_is_groups_component() && !bp_current_action() && !bp_current_item() ) {
-        $bp->is_directory = true;
+        bp_update_is_directory( true, 'groups' );
 
         do_action( 'groups_directory_groups_setup' );

trunk/bp-members/bp-members-functions.php

@@ -1 +1 @@
 <?php
 
-/********************************************************************************
- * Business Functions
- *
- * Business functions are where all the magic happens in BuddyPress. They will
- * handle the actual saving or manipulation of information. Usually they will
- * hand off to a database class for data access, then return
- * true or false on success or failure.
- */
+/**
+ * BuddyPress Member Functions
+ *
+ * Functions specific to the members component.
+ *
+ * @package BuddyPress
+ * @subpackage Members
+ */
+
 
 /**
@@ -23 +24 @@
     global $bp;
 
-    if ( !defined( 'BP_MEMBERS_SLUG' ) && !empty( $bp->pages->members ) )
-        define( 'BP_MEMBERS_SLUG', $bp->pages->members->slug );
-    else if ( !defined( 'BP_MEMBERS_SLUG' ) )
-        define( 'BP_MEMBERS_SLUG', 'members' );
-
-    if ( !defined( 'BP_REGISTER_SLUG' ) && !empty( $bp->pages->register ) )
-        define( 'BP_REGISTER_SLUG', $bp->pages->register->slug );
-    else if ( !defined( 'BP_REGISTER_SLUG' ) )
-        define( 'BP_REGISTER_SLUG', 'register' );
-
-    if ( !defined( 'BP_ACTIVATION_SLUG' ) && !empty( $bp->pages->activate ) )
-        define( 'BP_ACTIVATION_SLUG', $bp->pages->activate->slug );
-    else if ( !defined( 'BP_ACTIVATION_SLUG' ) )
-        define( 'BP_ACTIVATION_SLUG', 'activate' );
+    // No custom members slug
+    if ( !defined( 'BP_MEMBERS_SLUG' ) )
+        if ( !empty( $bp->pages->members ) )
+            define( 'BP_MEMBERS_SLUG', $bp->pages->members->slug );
+        else
+            define( 'BP_MEMBERS_SLUG', 'members' );
+
+    // No custom registration slug
+    if ( !defined( 'BP_REGISTER_SLUG' ) )
+        if ( !empty( $bp->pages->register ) )
+            define( 'BP_REGISTER_SLUG', $bp->pages->register->slug );
+        else
+            define( 'BP_REGISTER_SLUG', 'register' );
+
+    // No custom activation slug
+    if ( !defined( 'BP_ACTIVATION_SLUG' ) )
+        if ( !empty( $bp->pages->activate ) )
+            define( 'BP_ACTIVATION_SLUG', $bp->pages->activate->slug );
+        else
+            define( 'BP_ACTIVATION_SLUG', 'activate' );
 
 }

trunk/bp-members/bp-members-loader.php

@@ -7 +7 @@
  *
  * @package BuddyPress
- * @subpackage Member Core
+ * @subpackage Members
  */
 
@@ -73 +73 @@
         $bp->loggedin_user->fullname       = bp_core_get_user_displayname( $bp->loggedin_user->id );
 
-        // is_super_admin() hits the DB on single WP installs, so we need to get this separately so we can call it in a loop.
-        $bp->loggedin_user->is_super_admin = is_super_admin();
-        $bp->loggedin_user->is_site_admin  = $bp->loggedin_user->is_super_admin; // deprecated 1.2.6
+        // Hits the DB on single WP installs so get this separately
+        $bp->loggedin_user->is_super_admin = $bp->loggedin_user->is_site_admin = is_super_admin();
 
         // The domain for the user currently logged in. eg: http://domain.com/members/andy
@@ -88 +87 @@
          * something, is_item_admin is used. This is a generic variable so it
          * can be used by other components. It can also be modified, so when
-         * viewing a group 'is_item_admin' would be 1 if they are a group
-         * admin, 0 if they are not.
+         * viewing a group 'is_item_admin' would be 'true' if they are a group
+         * admin, and 'false' if they are not.
          */
-        $bp->is_item_admin = bp_user_has_access();
+        bp_update_is_item_admin( bp_user_has_access(), 'members' );
 
-        // Used to determine if the logged in user is a moderator for
-        // the current content.
-        $bp->is_item_mod = false;
+        // Is the logged in user is a mod for the current item?
+        bp_update_is_item_mod  ( false,                'members' );
 
         /** Displayed user ****************************************************/

trunk/bp-members/bp-members-notifications.php

@@ -1 +1 @@
 <?php
+
+/**
+ * BuddyPress Member Notifications
+ *
+ * Functions and filters used for member notification
+ *
+ * @package BuddyPress
+ * @subpackage Members
+ */
 
 function bp_members_add_notification( $item_id, $user_id, $component_name, $component_action, $secondary_item_id = 0, $date_notified = false ) {

trunk/bp-members/bp-members-screens.php

@@ -1 +1 @@
 <?php
+
+/**
+ * BuddyPress Member Screens
+ *
+ * Handlers for member screens that aren't handled elsewhere
+ *
+ * @package BuddyPress
+ * @subpackage Members
+ */
 
 /**
@@ -12 +21 @@
 }
 
+/**
+ * Handles the display of the members directory index
+ *
+ * @global object $bp
+ *
+ * @uses bp_is_user()
+ * @uses bp_is_current_component()
+ * @uses do_action()
+ * @uses bp_core_load_template()
+ * @uses apply_filters()
+ */
 function bp_members_screen_index() {
-    global $bp;
-
     if ( !bp_is_user() && bp_is_current_component( 'members' ) ) {
-        $bp->is_directory = true;
+        bp_update_is_directory( true, 'members' );
 
         do_action( 'bp_members_screen_index' );

trunk/bp-members/bp-members-signup.php

@@ -1 +1 @@
 <?php
+
+/**
+ * BuddyPress Member Sign-up
+ *
+ * Functions and filters specific to the member sign-up process
+ *
+ * @package BuddyPress
+ * @subpackage Members
+ */
 
 
@@ -5 +14 @@
     global $bp, $wpdb;
 
-    if ( $bp->current_component != BP_REGISTER_SLUG )
-        return false;
-
-    $bp->is_directory = false;
+    if ( !bp_is_current_component( 'register' ) )
+        return false;
+
+    // Not a directory
+    bp_update_is_directory( false, 'register' );
 
     if ( bp_is_component_front_page( 'register' ) && ( is_user_logged_in() || !bp_get_signup_allowed() ) )
-        bp_core_redirect( bp_get_root_domain() . '/' . $bp->members->slug );
+        bp_core_redirect( bp_get_root_domain() . '/' . bp_get_members_root_slug() );
 
     // If the user is logged in, redirect away from here
@@ -155 +165 @@
     global $bp, $wpdb;
 
-    if ( BP_ACTIVATION_SLUG != $bp->current_component )
+    if ( bp_is_current_component( 'activate' ) )
         return false;
 
@@ -167 +177 @@
         if ( !empty( $user->errors ) ) {
             bp_core_add_message( $user->get_error_message(), 'error' );
-            bp_core_redirect( bp_get_root_domain() . '/' . BP_ACTIVATION_SLUG );
+            bp_core_redirect( trailingslashit( bp_get_root_domain() . '/' . $bp->pages->activate->slug ) );
         }
 
@@ -593 +603 @@
 // Kill the wp-signup.php if custom registration signup templates are present
 function bp_members_wpsignup_redirect() {
+    global $bp;
+
     $action = '';
     if ( isset( $_GET['action'] ) )
@@ -601 +613 @@
 
     if ( locate_template( array( 'registration/register.php' ), false ) || locate_template( array( 'register.php' ), false ) )
-        bp_core_redirect( bp_get_root_domain() . '/' . BP_REGISTER_SLUG . '/' );
+        bp_core_redirect( bp_get_root_domain() . '/' . $bp->pages->register->slug . '/' );
 }
 if ( is_multisite() )

trunk/bp-members/bp-members-template.php

@@ -1 +1 @@
 <?php
+
+/**
+ * BuddyPress Member Template Tags
+ *
+ * Functions that are safe to use inside your template files and themes
+ *
+ * @package BuddyPress
+ * @subpackage Members
+ */
 
 /**
@@ -47 +56 @@
         global $bp;
         return apply_filters( 'bp_get_members_root_slug', $bp->members->root_slug );
+    }
+
+/**
+ * Output the sign-up slug
+ *
+ * @package BuddyPress
+ * @subpackage Members Template
+ * @since BuddyPress {unknown}
+ *
+ * @uses bp_get_members_slug()
+ */
+function bp_signup_slug() {
+    echo bp_get_signup_slug();
+}
+    /**
+     * Return the sign-up slug
+     *
+     * @package BuddyPress
+     * @subpackage Members Template
+     * @since BuddyPress {unknown}
+     */
+    function bp_get_signup_slug() {
+        global $bp;
+
+        if ( !empty( $bp->pages->register->slug ) )
+            $slug = $bp->pages->register->slug;
+        elseif ( defined( 'BP_REGISTER_SLUG' ) )
+            $slug = BP_REGISTER_SLUG;
+        else
+            $slug = 'register';
+
+        return apply_filters( 'bp_get_signup_slug', $bp->pages->register->slug );
+    }
+
+/**
+ * Output the activation slug
+ *
+ * @package BuddyPress
+ * @subpackage Members Template
+ * @since BuddyPress {unknown}
+ *
+ * @uses bp_get_members_slug()
+ */
+function bp_activate_slug() {
+    echo bp_get_activate_slug();
+}
+    /**
+     * Return the activation slug
+     *
+     * @package BuddyPress
+     * @subpackage Members Template
+     * @since BuddyPress {unknown}
+     */
+    function bp_get_activate_slug() {
+        global $bp;
+
+        if ( !empty( $bp->pages->activate->slug ) )
+            $slug = $bp->pages->activate->slug;
+        elseif ( defined( 'BP_ACTIVATION_SLUG' ) )
+            $slug = BP_ACTIVATION_SLUG;
+        else
+            $slug = 'activate';
+
+        return apply_filters( 'bp_get_activate_slug', $bp->pages->activate->slug );
     }
 
@@ -802 +875 @@
 
         if ( bp_has_custom_signup_page() )
-            $page = bp_get_root_domain() . '/' . BP_REGISTER_SLUG;
+            $page = trailingslashit( bp_get_root_domain() . '/' . $bp->pages->register->slug );
         else
             $page = bp_get_root_domain() . '/wp-signup.php';
@@ -823 +896 @@
 
         if ( bp_has_custom_activation_page() )
-            $page = trailingslashit( bp_get_root_domain() ) . BP_ACTIVATION_SLUG;
+            $page = trailingslashit( bp_get_root_domain() . '/' . $bp->pages->activate->slug );
         else
             $page = trailingslashit( bp_get_root_domain() ) . 'wp-activate.php';

trunk/bp-xprofile/bp-xprofile-filters.php

@@ -131 +131 @@
                     $new_values[] = $value;
                 } else {
-                    $new_values[] = '<a href="' . site_url( BP_MEMBERS_SLUG ) . '/?s=' . strip_tags( $value ) . '" rel="nofollow">' . $value . '</a>';
+                    $new_values[] = '<a href="' . site_url( bp_get_members_root_slug() ) . '/?s=' . strip_tags( $value ) . '" rel="nofollow">' . $value . '</a>';
                 }
             }