BP_Search_Core

BuddyPress Global Search Core Controller class

Description

Source

File: bp-search/classes/class-bp-search-core.php

class BP_Search_Core {
 
    /* Includes
     * ===================================================================
     */
 
    /**
     * Most WordPress/BuddyPress plugin have the includes in the function
     * method that loads them, we like to keep them up here for easier
     * access.
     * @var array
     */
    private $main_includes = [
        // Core
        'bp-search-functions',
        'bp-search-template',
        'bp-search-filters',
        'bp-search-settings',
        'classes/class-bp-search',
        'plugins/search-cpt/index'
    ];
 
    /* Plugin Options
     * ===================================================================
     */
 
    /* Version
     * ===================================================================
     */
 
    /* Magic
     * ===================================================================
     */
 
    /**
     * BuddyPress Global Search uses many variables, most of which can be filtered to
     * customize the way that it works. To prevent unauthorized access,
     * these variables are stored in a private array that is magically
     * updated using PHP 5.2+ methods. This is to prevent third party
     * plugins from tampering with essential information indirectly, which
     * would cause issues later.
     *
     * @see bp_search_Plugin::setup_globals()
     * @var array
     */
    private $data;
 
    /* Singleton
     * ===================================================================
     */
 
    /**
     * Main BuddyPress Global Search Instance.
     *
     * Insures that only one instance of BuddyPress Global Search exists in memory at any
     * one time. Also prevents needing to define globals all over the place.
     *
     * @since BuddyBoss 1.0.0
     *
     * @static object $instance
     * @uses bp_search_Plugin::setup_globals() Setup the globals needed.
     * @uses bp_search_Plugin::setup_actions() Setup the hooks and actions.
     * @uses bp_search_Plugin::setup_textdomain() Setup the plugin's language file.
     * @see  BP_Search::instance()
     *
     * @return object bp_search_Plugin
     */
    public static function instance() {
        // Store the instance locally to avoid private static replication
        static $instance = null;
 
        // Only run these methods if they haven't been run previously
        if ( null === $instance ) {
            $instance = new self();
            $instance->setup_globals();
            $instance->setup_actions();
        }
 
        // Always return the instance
        return $instance;
    }
 
    /* Magic Methods
     * ===================================================================
     */
 
    /**
     * A dummy constructor to prevent BuddyBoss Global Search from being loaded more than once.
     *
     * @since BuddyBoss Global Search (1.0.0)
     * @see bp_search_Plugin::instance()
     * @see buddypress()
     */
    private function __construct() { /* Do nothing here */
    }
 
    /**
     * A dummy magic method to prevent BuddyPress Global Search from being cloned.
     *
     * @since BuddyBoss 1.0.0
     */
    public function __clone() {
        _doing_it_wrong( __FUNCTION__, __( 'Cheatin\' huh?', 'buddyboss' ), '1.7' );
    }
 
    /**
     * A dummy magic method to prevent BuddyPress Global Search from being unserialized.
     *
     * @since BuddyBoss 1.0.0
     */
    public function __wakeup() {
        _doing_it_wrong( __FUNCTION__, __( 'Cheatin\' huh?', 'buddyboss' ), '1.7' );
    }
 
    /**
     * Magic method for checking the existence of a certain custom field.
     *
     * @since BuddyBoss 1.0.0
     */
    public function __isset( $key ) {
        return isset( $this->data[ $key ] );
    }
 
    /**
     * Magic method for getting BuddyPress Global Search varibles.
     *
     * @since BuddyBoss 1.0.0
     */
    public function __get( $key ) {
        return isset( $this->data[ $key ] ) ? $this->data[ $key ] : null;
    }
 
    /**
     * Magic method for setting BuddyPress Global Search varibles.
     *
     * @since BuddyBoss 1.0.0
     */
    public function __set( $key, $value ) {
        $this->data[ $key ] = $value;
    }
 
    /**
     * Magic method for unsetting BuddyPress Global Search variables.
     *
     * @since BuddyBoss 1.0.0
     */
    public function __unset( $key ) {
        if ( isset( $this->data[ $key ] ) ) {
            unset( $this->data[ $key ] );
        }
    }
 
    /**
     * Magic method to prevent notices and errors from invalid method calls.
     *
     * @since BuddyBoss 1.0.0
     */
    public function __call( $name = '', $args = array() ) {
        unset( $name, $args );
 
        return null;
    }
 
    /**
     * Setup BuddyPress Global Search plugin global variables.
     *
     * @since BuddyBoss 1.0.0
     * @access private
     *
     * @uses plugin_dir_path() To generate BuddyPress Global Search plugin path.
     * @uses plugin_dir_url() To generate BuddyPress Global Search plugin url.
     * @uses apply_filters() Calls various filters.
     */
    private function setup_globals() {
        // Assets
        $this->assets_url = plugin_dir_url( __DIR__ ) . 'assets';
    }
 
    /**
     * Set up the default hooks and actions.
     *
     * @since BuddyBoss 1.0.0
     * @access private
     *
     * @uses add_action() To add various actions.
     */
    private function setup_actions() {
        // Hook into BuddyPress init
        add_action( 'init', array( $this, 'init_load' ) );
    }
 
    /**
     * Setup plugin options settings admin page
     */
    public function setup_admin_settings() {
 
        if ( ( is_admin() || is_network_admin() ) && current_user_can( 'manage_options' ) ) {
            $this->load_admin();
        }
    }
 
 
    /**
     * We require BuddyPress to run the main components, so we attach
     * to the 'bp_init' action which BuddyPress calls after it's started
     * up. This ensures any BuddyPress related code is only loaded
     * when BuddyPress is active.
     *
     * @since BuddyBoss 1.0.0
     *
     * @return void
     */
    public function init_load() {
        $this->load_main();
    }
 
    /* Load
     * ===================================================================
     */
 
    /**
     * Include required admin files.
     *
     * @since BuddyBoss 1.0.0
     * @access private
     *
     * @uses $this->do_includes() Loads array of files in the include folder
     */
    private function load_admin() {
        $this->do_includes( $this->admin_includes );
 
        $this->admin = bp_search_Admin::instance();
    }
 
    /**
     * Include required files.
     *
     * @since BuddyBoss 1.0.0
     * @access private
     *
     * @uses bp_search_Plugin::do_includes() Loads array of files in the include folder
     */
    private function load_main() {
        $this->do_includes( $this->main_includes );
 
        $this->search = BP_Search::instance();
 
        // Front End Assets
        if ( ! is_admin() && ! is_network_admin() ) {
            add_action( 'wp_enqueue_scripts', array( $this, 'assets' ) );
        }
 
        // Remove bp compose message deprecated autocomplete
        //remove_action( "bp_enqueue_scripts", "messages_add_autocomplete_js" );
        // remove_action("wp_head","messages_add_autocomplete_css");
    }
 
    /**
     * Load css/js files
     *
     * @since BuddyBoss 1.0.0
     * @return void
     */
    public function assets() {
 
    }
 
    /* Print inline JS for initializing the bp messages autocomplete.
     * Proper updated auto complete code for buddypress message compose (replacing autocompletefb script).
     * @todo : Why this inline code is not at proper file.
     * @clean: This is not working.
     */
 
 
    /* Utility functions
     * ===================================================================
     */
 
    /**
     * Include required array of files in the includes directory
     *
     * @since BuddyBoss 1.0.0
     *
     * @uses require_once() Loads include file
     */
    public function do_includes( $includes = array() ) {
        global $bp;
 
        foreach ( (array) $includes as $include ) {
            require_once( $bp->plugin_dir . '/bp-search/' . $include . '.php' );
        }
    }
 
}

Expand full source code Collapse full source code

Methods

__call — Magic method to prevent notices and errors from invalid method calls.
__clone — A dummy magic method to prevent BuddyPress Global Search from being cloned.
__construct — A dummy constructor to prevent BuddyBoss Global Search from being loaded more than once.
__get — Magic method for getting BuddyPress Global Search varibles.
__isset — Magic method for checking the existence of a certain custom field.
__set — Magic method for setting BuddyPress Global Search varibles.
__unset — Magic method for unsetting BuddyPress Global Search variables.
__wakeup — A dummy magic method to prevent BuddyPress Global Search from being unserialized.
assets — Load css/js files
do_includes — Include required array of files in the includes directory
init_load — We require BuddyPress to run the main components, so we attach to the 'bp_init' action which BuddyPress calls after it's started up. This ensures any BuddyPress related code is only loaded when BuddyPress is active.
instance — Main BuddyPress Global Search Instance.
load_admin — Include required admin files.
load_main — Include required files.
setup_actions — Set up the default hooks and actions.
setup_admin_settings — Setup plugin options settings admin page
setup_globals — Setup BuddyPress Global Search plugin global variables.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents

Description

Source

Methods

Questions?