File: //home/dfwparty/dfwchat.net/wp-content/plugins/buddyboss-platform/bp-forums/common/classes.php
<?php
/**
* Forums Classes
*
* @package BuddyBoss\Classes
*/
// Exit if accessed directly
defined( 'ABSPATH' ) || exit;
if ( ! class_exists( 'BBP_Component' ) ) :
/**
* Forums Component Class
*
* The Forums component class is responsible for simplifying the creation
* of components that share similar behaviors and routines. It is used
* internally by Forums to create forums, topics and replies, but can be
* extended to create other really neat things.
*
* @since bbPress (r2688)
*/
class BBP_Component {
/**
* @var string Unique name (for internal identification)
* @internal
*/
var $name;
/**
* @var Unique ID (normally for custom post type)
*/
var $id;
/**
* @var string Unique slug (used in query string and permalinks)
*/
var $slug;
/**
* @var WP_Query The loop for this component
*/
var $query;
/**
* @var string The current ID of the queried object
*/
var $current_id;
/** Methods ***************************************************************/
/**
* Forums Component loader
*
* @since bbPress (r2700)
*
* @param mixed $args Required. Supports these args:
* - name: Unique name (for internal identification)
* - id: Unique ID (normally for custom post type)
* - slug: Unique slug (used in query string and permalinks)
* - query: The loop for this component (WP_Query)
* - current_id: The current ID of the queried object
* @uses BBP_Component::setup_globals() Setup the globals needed
* @uses BBP_Component::includes() Include the required files
* @uses BBP_Component::setup_actions() Setup the hooks and actions
*/
public function __construct( $args = '' ) {
if ( empty( $args ) ) {
return;
}
$this->setup_globals( $args );
$this->includes();
$this->setup_actions();
}
/**
* Component global variables
*
* @since bbPress (r2700)
* @access private
*
* @uses apply_filters() Calls 'bbp_{@link BBP_Component::name}_id'
* @uses apply_filters() Calls 'bbp_{@link BBP_Component::name}_slug'
*/
private function setup_globals( $args = '' ) {
$this->name = $args['name'];
$this->id = apply_filters( 'bbp_' . $this->name . '_id', $args['id'] );
$this->slug = apply_filters( 'bbp_' . $this->name . '_slug', $args['slug'] );
}
/**
* Include required files
*
* @since bbPress (r2700)
* @access private
*
* @uses do_action() Calls 'bbp_{@link BBP_Component::name}includes'
*/
private function includes() {
do_action( 'bbp_' . $this->name . 'includes' );
}
/**
* Setup the actions
*
* @since bbPress (r2700)
* @access private
*
* @uses add_action() To add various actions
* @uses do_action() Calls
* 'bbp_{@link BBP_Component::name}setup_actions'
*/
private function setup_actions() {
add_action( 'bbp_register_post_types', array( $this, 'register_post_types' ), 10, 2 ); // Register post types
add_action( 'bbp_register_taxonomies', array( $this, 'register_taxonomies' ), 10, 2 ); // Register taxonomies
add_action( 'bbp_add_rewrite_tags', array( $this, 'add_rewrite_tags' ), 10, 2 ); // Add the rewrite tags
add_action( 'bbp_generate_rewrite_rules', array( $this, 'generate_rewrite_rules' ), 10, 2 ); // Generate rewrite rules
// Additional actions can be attached here
do_action( 'bbp_' . $this->name . 'setup_actions' );
}
/**
* Setup the component post types
*
* @since bbPress (r2700)
*
* @uses do_action() Calls 'bbp_{@link BBP_Component::name}_register_post_types'
*/
public function register_post_types() {
do_action( 'bbp_' . $this->name . '_register_post_types' );
}
/**
* Register component specific taxonomies
*
* @since bbPress (r2700)
*
* @uses do_action() Calls 'bbp_{@link BBP_Component::name}_register_taxonomies'
*/
public function register_taxonomies() {
do_action( 'bbp_' . $this->name . '_register_taxonomies' );
}
/**
* Add any additional rewrite tags
*
* @since bbPress (r2700)
*
* @uses do_action() Calls 'bbp_{@link BBP_Component::name}_add_rewrite_tags'
*/
public function add_rewrite_tags() {
do_action( 'bbp_' . $this->name . '_add_rewrite_tags' );
}
/**
* Generate any additional rewrite rules
*
* @since bbPress (r2700)
*
* @uses do_action() Calls 'bbp_{@link BBP_Component::name}_generate_rewrite_rules'
*/
public function generate_rewrite_rules( $wp_rewrite ) {
do_action_ref_array( 'bbp_' . $this->name . '_generate_rewrite_rules', $wp_rewrite );
}
}
endif; // BBP_Component
if ( class_exists( 'Walker' ) ) :
/**
* Create HTML dropdown list of forums/topics.
*
* @since bbPress (r2746)
* @uses Walker
*/
class BBP_Walker_Dropdown extends Walker {
/**
* @see Walker::$tree_type
*
* @since bbPress (r2746)
*
* @var string
*/
var $tree_type;
/**
* @see Walker::$db_fields
*
* @since bbPress (r2746)
*
* @var array
*/
var $db_fields = array(
'parent' => 'post_parent',
'id' => 'ID',
);
/** Methods ***************************************************************/
/**
* Set the tree_type
*
* @since bbPress (r2746)
*/
public function __construct() {
$this->tree_type = bbp_get_forum_post_type();
}
/**
* @see Walker::start_el()
*
* @since bbPress (r2746)
*
* @param string $output Passed by reference. Used to append additional
* content.
* @param object $_post Post data object.
* @param int $depth Depth of post in reference to parent posts. Used
* for padding.
* @param array $args Uses 'selected' argument for selected post to set
* selected HTML attribute for option element.
* @param int $current_object_id
* @uses bbp_is_forum_category() To check if the forum is a category
* @uses current_user_can() To check if the current user can post in
* closed forums
* @uses bbp_is_forum_closed() To check if the forum is closed
* @uses apply_filters() Calls 'bbp_walker_dropdown_post_title' with the
* title, output, post, depth and args
*/
public function start_el( &$output, $object, $depth = 0, $args = array(), $current_object_id = 0 ) {
$pad = str_repeat( ' ', (int) $depth * 3 );
$output .= '<option class="level-' . (int) $depth . '"';
// Disable the <option> if:
// - we're told to do so
// - the post type is a forum
// - the forum is a category
// - forum is closed
if ( ( true === $args['disable_categories'] )
&& ( bbp_get_forum_post_type() === $object->post_type )
&& ( bbp_is_forum_category( $object->ID )
|| ( ! current_user_can( 'edit_forum', $object->ID ) && bbp_is_forum_closed( $object->ID )
)
) ) {
$output .= ' disabled="disabled" value=""';
} else {
$output .= ' value="' . (int) $object->ID . '"' . selected( $args['selected'], $object->ID, false );
}
/**
* Add extra attributes for dropdown options.
* Default value empty.
*
* @since BuddyBoss 1.7.8
*
* @param string $attribute Option attribute.
* @param object $object Post data.
* @param array $args Dropdown arguments.
* @param int $depth Depth of post in reference to parent posts.
* @param string $output Used to append additional content.
*/
$output .= apply_filters( 'bb_walker_dropdown_option_attr', '', $object, $args, $depth, $output );
$output .= '>';
$title = apply_filters( 'bbp_walker_dropdown_post_title', $object->post_title, $output, $object, $depth, $args );
$output .= $pad . esc_html( $title );
$output .= "</option>\n";
}
}
/**
* Create hierarchical list of Forums replies.
*
* @since bbPress (r4944)
*/
class BBP_Walker_Reply extends Walker {
/**
* @see Walker::$tree_type
*
* @since bbPress (r4944)
*
* @var string
*/
var $tree_type = 'reply';
/**
* @see Walker::$db_fields
*
* @since bbPress (r4944)
*
* @var array
*/
var $db_fields = array(
'parent' => 'reply_to',
'id' => 'ID',
);
var $total_items_per_page = 0;
/**
* @see Walker::start_lvl()
*
* @since bbPress (r4944)
*
* @param string $output Passed by reference. Used to append additional content
* @param int $depth Depth of reply
* @param array $args Uses 'style' argument for type of HTML list
*/
public function start_lvl( &$output = '', $depth = 0, $args = array() ) {
bbpress()->reply_query->reply_depth = $depth + 1;
switch ( $args['style'] ) {
case 'div':
break;
case 'ol':
echo "<ol class='bbp-threaded-replies'>\n";
break;
case 'ul':
default:
echo "<ul class='bbp-threaded-replies'>\n";
break;
}
}
/**
* @see Walker::end_lvl()
*
* @since bbPress (r4944)
*
* @param string $output Passed by reference. Used to append additional content
* @param int $depth Depth of reply
* @param array $args Will only append content if style argument value is 'ol' or 'ul'
*/
public function end_lvl( &$output = '', $depth = 0, $args = array() ) {
bbpress()->reply_query->reply_depth = (int) $depth + 1;
switch ( $args['style'] ) {
case 'div':
break;
case 'ol':
echo "</ol>\n";
break;
case 'ul':
default:
echo "</ul>\n";
break;
}
}
/**
* @since bbPress (r4944)
*/
public function display_element( $element = false, &$children_elements = array(), $max_depth = 0, $depth = 0, $args = array(), &$output = '' ) {
if ( empty( $element ) ) {
return;
}
$this->total_items_per_page++;
// Get element's id.
$id_field = $this->db_fields['id'];
$id = $element->$id_field;
// Display element.
parent::display_element( $element, $children_elements, $max_depth, $depth, $args, $output );
// If we're at the max depth and the current element still has children, loop over those
// and display them at this level to prevent them being orphaned to the end of the list.
if ( ( $max_depth <= (int) $depth + 1 ) && isset( $children_elements[ $id ] ) ) {
foreach ( $children_elements[ $id ] as $child ) {
$this->display_element( $child, $children_elements, $max_depth, $depth, $args, $output );
}
unset( $children_elements[ $id ] );
}
}
/**
* @see Walker:start_el()
*
* @since bbPress (r4944)
*/
public function start_el( &$output, $object, $depth = 0, $args = array(), $current_object_id = 0 ) {
// Set up reply.
$depth++;
bbpress()->reply_query->reply_depth = $depth;
bbpress()->reply_query->post = $object;
bbpress()->current_reply_id = $object->ID;
// Check for a callback and use it if specified.
if ( ! empty( $args['callback'] ) ) {
call_user_func( $args['callback'], $object, $args, $depth );
return;
}
// Style for div or list element.
if ( ! empty( $args['style'] ) && ( 'div' === $args['style'] ) ) {
echo "<div class='depth-$depth' data-depth='$depth'>\n";
} else {
echo "<li class='depth-$depth' data-depth='$depth'>\n";
}
bbp_get_template_part( 'loop', 'single-reply' );
}
/**
* @since bbPress (r4944)
*/
public function end_el( &$output = '', $object = false, $depth = 0, $args = array() ) {
// Check for a callback and use it if specified.
if ( ! empty( $args['end-callback'] ) ) {
call_user_func( $args['end-callback'], $object, $args, $depth );
return;
}
// Style for div or list element.
if ( ! empty( $args['style'] ) && ( 'div' === $args['style'] ) ) {
echo "</div>\n";
} else {
echo "</li>\n";
}
}
}
endif; // class_exists check.