Changeset 4775 for trunk/bp-core/bp-core-component.php

Timestamp:

07/22/2011 07:32:48 AM (14 years ago)

Author:

johnjamesjacoby

Message:

Prebeta code clean-up - see #3367:

• Remove PHP4 constructors on loader classes
• Remove class functions that start with underscores
• Use require() rather than require_once() where appropriate
• Remove background color on messages activity time

File:

• trunk/bp-core/bp-core-component.php (modified) (14 diffs)

trunk/bp-core/bp-core-component.php

@@ -69 +69 @@
      *  - query: The loop for this component (WP_Query)
      *  - current_id: The current ID of the queried object
-     * @uses bp_Component::_setup_globals() Setup the globals needed
-     * @uses bp_Component::_includes() Include the required files
-     * @uses bp_Component::_setup_actions() Setup the hooks and actions
+     * @uses bp_Component::setup_globals() Setup the globals needed
+     * @uses bp_Component::includes() Include the required files
+     * @uses bp_Component::setup_actions() Setup the hooks and actions
      */
     function start( $id, $name, $path ) {
@@ -84 +84 @@
 
         // Move on to the next step
-        $this->_setup_actions();
+        $this->setup_actions();
     }
 
@@ -98 +98 @@
      * @param arr $args Used to
      */
-    function _setup_globals( $args = '' ) {
+    function setup_globals( $args = '' ) {
         global $bp;
 
@@ -135 +135 @@
 
         // Call action
-        do_action( 'bp_' . $this->id . '_setup_globals' );
+        do_action( 'bp_' . $this->id . 'setup_globals' );
     }
 
@@ -144 +144 @@
      * @access private
      *
-     * @uses do_action() Calls 'bp_{@link bp_Component::name}_includes'
-     */
-    function _includes( $includes = '' ) {
+     * @uses do_action() Calls 'bp_{@link bp_Component::name}includes'
+     */
+    function includes( $includes = '' ) {
         if ( empty( $includes ) )
             return;
@@ -155 +155 @@
             // Check path + file
             if ( @is_file( $this->path . '/' . $file ) )
-                require_once( $this->path . '/' . $file );
+                require( $this->path . '/' . $file );
 
             // Check path + /bp-component/ + file
             elseif ( @is_file( $this->path . '/bp-' . $this->id . '/' . $file ) )
-                require_once( $this->path . '/bp-' . $this->id . '/' . $file );
+                require( $this->path . '/bp-' . $this->id . '/' . $file );
 
             // Check buddypress/bp-component/bp-component-$file.php
             elseif ( @is_file( $this->path . '/bp-' . $this->id . '/bp-' . $this->id . '-' . $file  . '.php' ) )
-                require_once( $this->path . '/bp-' . $this->id . '/bp-' . $this->id . '-' . $file . '.php' );
+                require( $this->path . '/bp-' . $this->id . '/bp-' . $this->id . '-' . $file . '.php' );
 
         }
 
         // Call action
-        do_action( 'bp_' . $this->id . '_includes' );
+        do_action( 'bp_' . $this->id . 'includes' );
     }
 
@@ -178 +178 @@
      *
      * @uses add_action() To add various actions
-     * @uses do_action() Calls 'bp_{@link BP_Component::name}_setup_actions'
-     */
-    function _setup_actions() {
-        // Register post types
-        add_action( 'bp_setup_globals',            array ( $this, '_setup_globals'           ), 10 );
+     * @uses do_action() Calls 'bp_{@link BP_Component::name}setup_actions'
+     */
+    function setup_actions() {
+        // Register post types
+        add_action( 'bp_setup_globals',            array ( $this, 'setup_globals'            ), 10 );
 
         // Include required files. Called early to ensure that BP core components are
@@ -188 +188 @@
         // the default priority of 10. This is for backwards compatibility; henceforth,
         // plugins should register themselves by extending this base class.
-        add_action( 'bp_include',                  array ( $this, '_includes'                ), 8 );
-
-        // Register post types
-        add_action( 'bp_setup_nav',                array ( $this, '_setup_nav'               ), 10 );
-
-        // Register post types
-        add_action( 'bp_setup_admin_bar',          array ( $this, '_setup_admin_bar'         ), 10 );
-
-        // Register post types
-        add_action( 'bp_setup_title',              array ( $this, '_setup_title'             ), 10 );
+        add_action( 'bp_include',                  array ( $this, 'includes'                 ), 8 );
+
+        // Register post types
+        add_action( 'bp_setup_nav',                array ( $this, 'setup_nav'                ), 10 );
+
+        // Register post types
+        add_action( 'bp_setup_admin_bar',          array ( $this, 'setup_admin_bar'          ), 10 );
+
+        // Register post types
+        add_action( 'bp_setup_title',              array ( $this, 'setup_title'              ), 10 );
 
         // Register post types
@@ -212 +212 @@
 
         // Additional actions can be attached here
-        do_action( 'bp_' . $this->id . '_setup_actions' );
+        do_action( 'bp_' . $this->id . 'setup_actions' );
     }
 
@@ -221 +221 @@
      * @param arr $sub_nav Optional
      */
-    function _setup_nav( $main_nav = '', $sub_nav = '' ) {
+    function setup_nav( $main_nav = '', $sub_nav = '' ) {
 
         // No sub nav items without a main nav item
@@ -236 +236 @@
 
         // Call action
-        do_action( 'bp_' . $this->id . '_setup_nav' );
+        do_action( 'bp_' . $this->id . 'setup_nav' );
     }
 
@@ -245 +245 @@
      * @param array $wp_admin_menus
      */
-    function _setup_admin_bar( $wp_admin_nav = '' ) {
+    function setup_admin_bar( $wp_admin_nav = '' ) {
 
         // Bail if this is an ajax request
@@ -270 +270 @@
 
         // Call action
-        do_action( 'bp_' . $this->id . '_setup_admin_bar' );
+        do_action( 'bp_' . $this->id . 'setup_admin_bar' );
     }
 
@@ -278 +278 @@
      * @since Buddypress {unknown}
      *
-     * @uses do_action() Calls 'bp_{@link bp_Component::name}_setup_title'
-     */
-    function _setup_title( ) {
-        do_action(  'bp_' . $this->id . '_setup_title' );
+     * @uses do_action() Calls 'bp_{@link bp_Component::name}setup_title'
+     */
+    function setup_title( ) {
+        do_action(  'bp_' . $this->id . 'setup_title' );
     }