Ticket #1479: bp-component.php

<?php
/*
Plugin Name: BP-Test
Plugin URI: http://buddypress.org/
Description: BP Test Class
Author: The BuddyPress Community
Version: Concept
Author URI: http://buddypress.org/developers/
Site Wide Only: true
*/

add_action( 'plugins_loaded', 'bp_test_load' );

function bp_test_load() {
        global $bp3;

        $friends = new BP_Component (
                array(
                        'id' => 'friends',
                        'slug' => 'friends',
                        'version' => '1.3',
                        'table_name' => 'bp_friends',
                        'object' => 'user',
                        'active' => true,
                        'css_class' => 'bp_friends',
                )
        );

        $followers = new BP_Component (
                array(
                        'id' => 'followers',
                        'slug' => 'followers',
                        'version' => '1.3',
                        'table_name' => 'bp_followers',
                        'object' => 'user',
                        'active' => true,
                        'css_class' => 'bp_followers',
                )
        );

        /* Uncomment to see it load */
        //var_dump( $bp3 );
}

/* Make sure slug is healthy */
function bp_component_sanitize_slug( $slug ) {
        return $slug;
}

/* Check table_name */
function bp_component_check_table_name( $table_name ) {
        return $table_name;
}

/* Standard component class for all BuddyPress components
 *
 * It includes all of the necessary functions and variables to
 * create, initialize, and control all BuddyPress components.
 *
 * To be used by core and external plugins
 *
 * @since 1.3
 *
 */

class BP_Component {
        /* Set a unique ID for internal reference
         *      - Will be checked for duplicates
         */
        var $id;

        /* Unique slug to identify component in URI's
         *      - Will be checked for duplicates
         */
        var $slug;

        /* For updating the DB schema */
        var $version;

        /* Set the table name where component data is saved
         *      - Table will be created/updated by this class
         */
        var $table_name;

        /* Set object type
         *      - user/group/blog/custom type
         *  - @uses bp_get_registered_objects
         */
        var $object;

        /* Set if component is on or off
         *      - Defaults to off
         */
        var $active;

        /* Best to set this as sanitized component name
         *      - @uses sanitize_title
         */
        var $css_class;

        /* Used internally */
        var $before_install;
        var $after_install;

        /* Initialize new component */
        function bp_component( $args ) {
                $this->setup_globals( $args );
        }

        /* Setup component values */
        function setup_globals( $args ) {
                global $bp3;

                /* Allow for pre component initialization */
                $this->init();
                do_action( $this->id . '_setup_globals' );

                /* Set default args */
                $defaults = array (
                        'id' => 'bp_component',
                        'slug' => 'bp_component',
                        'version' => BP_CORE_DB_VERSION,
                        'table_name' => '',
                        'object' => 'bp_component',
                        'active' => false,
                        'css_class' => 'bp_component',
                        'before_install' => false,
                        'after_install' => false,
                );

                /* Parse args and extract */
                $params = wp_parse_args( $args, $defaults );
                extract( $params, EXTR_SKIP );

                $this->id = $id;
                $this->slug = $slug;
                $this->version = $version;
                $this->table_name = $wpdb->base_prefix . $table_name;
                $this->object = $object;
                $this->active = $active;
                $this->css_class = $css_class;

                /* Check existing components for conflicting values */
                if ( $this->check_conflict() ) {
                        die( 'Dupe!' );

                /* Register this in the active components array */
                } else {
                        if ( $this->active )
                                $bp3->active_components[$this->id] = $this;
                }

                do_action ( $this->id . '_setup_globals');
        }

        /* Run after construct but before setup_globals */
        function init() {
                do_action( $this->id . '_init' );
        }

        /* Run before db schema installation */
        function before_install() {
                do_action( $this->id . '_before_install' );
        }

        /* Run after db schema installation */
        function after_install() {
                do_action( $this->id . '_after_install' );
        }

        /* Check if db schema needs to be installed/upgraded */
        function check_installed() {
                global $wpdb, $bp3;

                if ( get_site_option( $this->id . '-db-version') < $this->version )
                        $this->install();

        }

        /* Install if need be */
        function install( $sql ) {
                global $wpdb;

                /* Allow components to perform actions before install */
                $this->before_install();

                if ( !empty( $wpdb->charset ) )
                        $charset_collate = "DEFAULT CHARACTER SET $wpdb->charset";

                require_once( ABSPATH . 'wp-admin/upgrade-functions.php' );
                dbDelta( $sql );

                /* Allow components to perform action after install */
                $this->after_install();

                /* Set component version in site meta */
                update_site_option( $this->id . '-db-version', $this->version );

                do_action( $this->id . '_installed' );
        }

        function setup_nav() {
                do_action( $this->id . '_setup_nav' );
        }

        function admin_menu() {
                global $wpdb, $bp3;

                if ( !is_site_admin() )
                        return false;

                do_action( $this->id . '_admin_menu' );
        }

        /* Template files are stored like $template/$slug/$screen
         *
         * Examples:    /bp-default/members/index
         *                              /bp-default/members/my-friends
         * 
         *                              /bp-default/groups/index
         *                              /bp-default/groups/my-groups
         * 
         *                              /bp-default/blogs/index
         *                              /bp-default/blogs/create
         *
         *                              /bp-default/activity/index
         */
        function screen( $screen, $single = false ) {
                /* Not a single item */
                if ( $single === false ) {
                        do_action( $this->id . '_screen_' . $screen );
                        bp_core_load_template( apply_filters( $this->id . '_template_' . $screen, $this->slug . '/' . $screen ) );

                /* Viewing a single item */
                } else {
                        do_action( $this->id . '_screen_' . $screen );
                        bp_core_load_template( apply_filters( $this->id . '_template_' . $screen, $this->slug . '/single/' . $screen ) );
                }
        }

        /* Template files are stored like $template/$slug/single/$screen
         *
         * Examples:    /bp-default/members/single/my-friends
         *                              /bp-default/members/single/friends-activity
         *
         *                              /bp-default/groups/single/my-groups
         *                              /bp-default/groups/single/groups-activity
         *
         *                              /bp-default/forums/single/edit
         *                              /bp-default/forums/single/topic
         *
         *                              /bp-default/activity/single/my-activity
         *                              /bp-default/activity/single/friends-activity
         *                              /bp-default/activity/single/blogs-activity
         */
        function single_screen( $screen ) {
                $this->screen( $screen, true );
        }

        /* Default for when screen is not set */
        function single_screen_permalink() {
                do_action( $this->id . '_screen_single_permalink' );
        }

        /* Handle removing of data */
        function remove_data() {
                do_action( $this->id . '_remove_data', $this );
        }

        function check_conflict() {
                global $bp3;

                /* If first item, no dupe */
                if ( !is_array( $bp3->active_components ) )
                        return false;

                /* Loop through components and look for dupes */
                foreach ( $bp3->active_components as $component ) {

                        if ( $this->id == $component->id )
                                return true;

                        if ( $this->slug == $component->slug )
                                return true;

                        if ( $this->slug == $component->slug )
                                return true;

                        if ( ( $this->table_name && $component->table_name) && $this->table_name == $component->table_name )
                                return true;

                        if ( $this->css_class == $component->css_class )
                                return true;

                }

                /* No dupes, return false */
                return false;

        }
}
?>