Contents

Code Reference Classes Bp_Search_Type

Bp_Search_Type

BuddyPress Global Search Type – Parent class

Description

Source

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

17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
abstract class Bp_Search_Type {
 
    /**
     * search term. might be used later for caching purposes
     * @var string
     */
    protected $search_term = '';
 
    /**
     * The variable to hold search results.
     *
     * @var array
     */
    protected $search_results = array( 'total_match_count'=>false, 'items'=> array(), 'items_title'=> array(), 'html_generated' => false );
 
    /* Magic Methods
     * ===================================================================
     */
 
    /**
     * A dummy magic method to prevent this class 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 this class being unserialized.
     *
     * @since BuddyBoss 1.0.0
     */
    public function __wakeup() {
        _doing_it_wrong(__FUNCTION__, __('Cheatin\' huh?', 'buddyboss'), '1.7');
    }
 
    /**
     * Returns the sql query to be used in performing an 'all' items search.
     *
     * @param string $search_term
     * @return string sql query
     * @since BuddyBoss 1.0.0
     */
    public function union_sql( $search_term ){
        $this->search_term = $search_term;//save it for future reference may be.
 
        return $this->sql($search_term);
    }
 
    public function add_search_item( $item_id ){
        if( !in_array( $item_id, $this->search_results['items'] ) )
            $this->search_results['items'][$item_id] = '';
    }
 
    public function get_title( $item_id ){
        if( !$this->search_results['html_generated'] ){
            $this->generate_html();
            $this->search_results['html_generated'] = true;//do once only
        }
 
        return isset( $this->search_results['items'][$item_id]['title'] ) ? $this->search_results['items'][$item_id]['title'] : $this->search_term;
    }
 
    public function get_total_match_count( $search_term ){
        $this->search_term = $search_term;//save it for future reference may be.
 
        global $wpdb;
        $sql = $this->sql( $search_term, true );
        return $wpdb->get_var( $sql );
    }
 
    /**
     * This function must be overriden by inheritingn classes
     * @param string $search_term
     * @param boolean $only_totalrow_count
     */
    abstract function sql( $search_term, $only_totalrow_count=false );
 
    /**
     * Get the html for given search result.
     * @param int $itemid
     * @param string $template_type Optional
     * @return string
     */
    public function get_html( $itemid, $template_type='' ){
        if( !$this->search_results['html_generated'] ){
            $this->generate_html( $template_type );
            $this->search_results['html_generated'] = true;//do once only
        }
 
        return isset( $this->search_results['items'][$itemid] ) ? @$this->search_results['items'][$itemid]['html'] : '';
    }
}

Expand full source code Collapse full source code

Used By
Used By Description
bp-search/classes/class-bp-search-albums.php: Bp_Search_Albums

BuddyPress Global Search – search albums class
bp-search/classes/class-bp-search-media.php: Bp_Search_Media

BuddyPress Global Search – search media class
bp-search/classes/class-bp-search-documents.php: Bp_Search_Documents

BuddyPress Global Search – search document class
bp-search/classes/class-bp-search-folders.php: Bp_Search_Folders

BuddyPress Global Search – search folder class
bp-search/plugins/search-cpt/class-bp-search-cpt.php: BP_Search_CPT

BuddyPress Global Search – search posts class
bp-search/classes/class-bp-search-members.php: Bp_Search_Members

BuddyPress Global Search – search members class
bp-search/classes/class-bp-search-activity-comments.php: Bp_Search_Activity_Comment

BuddyPress Global Search – search activity comment class
bp-search/classes/class-bp-search-posts.php: Bp_Search_Posts

BuddyPress Global Search – search posts class
bp-search/classes/class-bp-search-activities.php: Bp_Search_Activities

BuddyPress Global Search – search activities class
bp-search/classes/class-bp-search-bbpress.php: Bp_Search_bbPress

BuddyPress Global Search – search bbPress class
Show 5 more used by Hide more used by

Methods

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.