Bpbbpst_Support_Stats

Buddy-bbPress Support Topic statistic Widget.

Defined (1)

The class is defined in the following location(s).

/includes/widgets.php  
  1. class Bpbbpst_Support_Stats extends WP_Widget { 
  2.     /** 
  3.      * Buddy-bbPress Support Topic statistic Widget 
  4.      * 
  5.      * @since  1.1 
  6.      * 
  7.      * @uses   WP_Widget::__construct() to init the widget 
  8.      * @uses   add_filter() to filter bbPress topic query, breadcrumb and pagination 
  9.      * @uses   add_action() to enqueue widget style 
  10.      */ 
  11.     public function __construct() { 
  12.  
  13.         $widget_ops = array( 'description' => __( 'Displays support topic global statistics or of the active forum', 'buddy-bbpress-support-topic' ) ); 
  14.         parent::__construct( false, $name = __( 'Support Topics Stats', 'buddy-bbpress-support-topic' ), $widget_ops ); 
  15.  
  16.         /** bbPress filters to handle breadcrumb, pagination and topics query */ 
  17.         add_filter( 'bbp_after_has_topics_parse_args', array( $this, 'filter_topics_query_by_status' ), 20, 1 ); 
  18.         add_filter( 'bbp_get_breadcrumb', array( $this, 'breadcrumb_for_status' ), 20, 3 ); 
  19.         add_filter( 'bbp_topic_pagination', array( $this, 'pagination_for_status' ), 20, 1 ); 
  20.  
  21.         /** finally add some style */ 
  22.         add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_style' ), 10 ); 
  23.     } 
  24.  
  25.     /** 
  26.      * Registers the widget 
  27.      * 
  28.      * @since  1.1 
  29.      * 
  30.      * @uses   register_widget() to register the widget 
  31.      */ 
  32.     public static function register_widget() { 
  33.         register_widget( 'Bpbbpst_Support_Stats' ); 
  34.     } 
  35.  
  36.     /** 
  37.      * Displays the output, the statistics 
  38.      * 
  39.      * Depending if the widget is displayed on a single forum template 
  40.      * it displays the current forum stats or the global stats. 
  41.      * If on a single forum, add links to filter by support status the topics 
  42.      * 
  43.      * @since  2.0 
  44.      * 
  45.      * @param  mixed $args Arguments 
  46.      * @param  array $instance Instance 
  47.      * @uses   bbp_get_forum_id() to get the forum id 
  48.      * @uses   bbp_is_topic_edit() to check if the topic is being edited 
  49.      * @uses   bbp_get_topic_forum_id() to get the forum parent of the edited topic 
  50.      * @uses   bbp_get_topic_id() to get the edited topic id 
  51.      * @uses   bpbbpst_support_statistics() To get the statistics according to its parameter 
  52.      * @uses   add_query_arg() to add the querystring to filter the support topics 
  53.      * @uses   bbp_get_forum_permalink() to get the forum permalink 
  54.      * @uses   esc_attr() to sanitize attributes 
  55.      * @uses   get_post_type_archive_link() to build the link to forum archives 
  56.      * @uses   bbp_get_forum_post_type() to get the forum post type 
  57.      * @return string html output 
  58.      */ 
  59.     public function widget( $args, $instance ) { 
  60.         if ( ! $instance['bpbbpst_title'] ) { 
  61.             $instance['bpbbpst_title'] = __( 'Support Topics Stats', 'buddy-bbpress-support-topic' ); 
  62.         } 
  63.  
  64.         if ( ! $instance['show_forum_link'] ) { 
  65.             $instance['show_forum_link'] = false; 
  66.         } 
  67.  
  68.         $forum_id = bbp_get_forum_id(); 
  69.         $stats_params = ""; 
  70.  
  71.         if ( empty( $forum_id ) && bbp_is_topic_edit() ) { 
  72.             $forum_id = bbp_get_topic_forum_id( bbp_get_topic_id() ); 
  73.         } 
  74.  
  75.         if ( ! empty( $forum_id ) ) { 
  76.  
  77.             $stats_params = array( 
  78.                 'meta_query' => array( 
  79.                     array( 
  80.                         'key' => '_bpbbpst_support_topic',  
  81.                         'value' => 1,  
  82.                         'type' => 'numeric',  
  83.                         'compare' => '>=' 
  84.  ),  
  85.                     array( 
  86.                         'key' => '_bbp_forum_id',  
  87.                         'value' =>  $forum_id,  
  88.                         'compare' => '=' 
  89.  ) 
  90.  ) 
  91.  ); 
  92.         } 
  93.  
  94.         echo $args['before_widget']; 
  95.         echo $args['before_title'] . $instance['bpbbpst_title'] . $args['after_title']; 
  96.  
  97.         $support_statistics = bpbbpst_support_statistics( $stats_params ); 
  98.  
  99.         if ( ! empty( $support_statistics['total_support'] ) ) { 
  100.  
  101.             $status_stats = $support_statistics['allstatus']; 
  102.  
  103.             if ( ! is_array( $status_stats ) || count( $status_stats ) < 1 ) { 
  104.                 return false; 
  105.             } 
  106.  
  107.             $num_percent = $support_statistics['percent']; 
  108.             $text_percent = __( 'Resolved so far', 'buddy-bbpress-support-topic' ); ?> 
  109.  
  110.             <ul class="bpbbpst-widget"> 
  111.                 <li class="bpbbpst-percent"> 
  112.                     <span class="bpbbpst-text"><?php echo esc_html( $text_percent );?></span> <span class="bpbbpst-num"><?php echo esc_html( $num_percent );?></span> 
  113.                 </li> 
  114.  
  115.                 <?php foreach ( $status_stats as $key => $stat ) : 
  116.  
  117.                     $num = $stat['stat']; 
  118.                     $text = $stat['label']; 
  119.                     $class = $stat['front_class']; 
  120.  
  121.                     if ( ! empty( $forum_id ) ) { 
  122.                         $link = esc_url( add_query_arg( array( 'support_status' => $key ), bbp_get_forum_permalink() ) ); 
  123.                         $num = '<a href="'. $link .'" title="'. esc_attr( $text ) .'">'. esc_html( $num ) .'</a>' ; 
  124.                         $text = '<a href="'. $link .'" title="'. esc_attr( $text ) .'">'. esc_html( $text ) .'</a>' ; 
  125.                     } 
  126.  
  127.                 ?> 
  128.  
  129.                     <li class="bpbbpst-<?php echo $class;?> status"> 
  130.                         <span class="bpbbpst-num"><?php echo $num;?></span> <span class="bpbbpst-text"><?php echo $text;?></span> 
  131.                     </li> 
  132.  
  133.                 <?php endforeach;?> 
  134.  
  135.             </ul> 
  136.             <?php 
  137.  
  138.         // Otherwise display there are no stats available! 
  139.         } else { 
  140.             printf( '<p>%s</p>',  
  141.                 esc_html__( 'No statisitcs available.' , 'buddy-bbpress-support-topic' ) 
  142.  ); 
  143.         } 
  144.  
  145.         if ( ! is_bbpress() && ! empty( $instance['show_forum_link'] ) ) { 
  146.             printf( '<p><a href="%1$s" title="%2$s">%3$s</a></p>',  
  147.                 esc_url( get_post_type_archive_link( bbp_get_forum_post_type() ) ),  
  148.                 esc_attr__( 'Go to forums' , 'buddy-bbpress-support-topic' ),  
  149.                 esc_html__( 'Go to forums' , 'buddy-bbpress-support-topic' ) 
  150.  ); 
  151.         } 
  152.  
  153.         echo $args['after_widget']; 
  154.     } 
  155.  
  156.     /** 
  157.      * Update the statistics widget options (title) 
  158.      * 
  159.      * @since  1.1 
  160.      * 
  161.      * @param  array $new_instance The new instance options 
  162.      * @param  array $old_instance The old instance options 
  163.      * @return array the instance 
  164.      */ 
  165.     public function update( $new_instance, $old_instance ) { 
  166.         $instance = $old_instance; 
  167.  
  168.         $instance['bpbbpst_title'] = strip_tags( $new_instance['bpbbpst_title'] ); 
  169.  
  170.         if ( ! empty( $new_instance['show_forum_link'] ) ) { 
  171.             $instance['show_forum_link'] = intval( $new_instance['show_forum_link'] ); 
  172.         } else { 
  173.             $instance['show_forum_link'] = 0; 
  174.         } 
  175.  
  176.         return $instance; 
  177.     } 
  178.  
  179.     /** 
  180.      * Output the statistics widget options form 
  181.      * 
  182.      * @since 1.1 
  183.      * 
  184.      * @param  $instance Instance 
  185.      * @uses   wp_parse_args() to merge instance defined arguments into defaults array 
  186.      * @uses   Bpbbpst_Support_Stats::get_field_id() To output the field id 
  187.      * @uses   Bpbbpst_Support_Stats::get_field_name() To output the field name 
  188.      * @uses   checked() to activate the checkbox if it needs to 
  189.      * @return string html output 
  190.      */ 
  191.     public function form( $instance ) { 
  192.         $defaults = array( 
  193.             'bpbbpst_title' => __( 'Support Topics Stats', 'buddy-bbpress-support-topic' ),  
  194.             'show_forum_link' => 0 
  195.  ); 
  196.  
  197.         $instance = wp_parse_args( (array) $instance, $defaults ); 
  198.  
  199.         $bpbbpst_title = strip_tags( $instance['bpbbpst_title'] ); 
  200.             $show_forum_link = strip_tags( $instance['show_forum_link'] ); 
  201.         ?> 
  202.         <p> 
  203.             <label for="bpbbpst_title"><?php _e( 'Title:', 'buddy-bbpress-support-topic' ); ?> 
  204.                 <input class="widefat" id="<?php echo $this->get_field_id( 'bpbbpst_title' ); ?>" name="<?php echo $this->get_field_name( 'bpbbpst_title' ); ?>" type="text" value="<?php echo esc_attr( $bpbbpst_title ); ?>" style="width: 100%" /> 
  205.             </label> 
  206.         </p> 
  207.             <label for="show_forum_link"> 
  208.             <input id="<?php echo $this->get_field_id( 'show_forum_link' ); ?>" name="<?php echo $this->get_field_name( 'show_forum_link' ); ?>" type="checkbox" value="1" <?php checked( true, $show_forum_link );?> /> <?php _e( 'Show forum link', 'buddy-bbpress-support-topic' ); ?> 
  209.             </label> 
  210.             <p class="description"><?php _e( 'When not on a forum page, display a link to it', 'buddy-bbpress-support-topic' )?></p> 
  211.         <?php 
  212.     } 
  213.  
  214.     /** 
  215.      * Adds a meta_query to the topics query 
  216.      * 
  217.      * @since  1.1 
  218.      * 
  219.      * @param  mixed $args Arguments 
  220.      * @uses   bbp_is_single_forum() to check it's a single forum page 
  221.      * @return mixed $args the new arguments eventually including the meta_query 
  222.      */ 
  223.     public function filter_topics_query_by_status( $args = "" ) { 
  224.         if ( ! bbp_is_single_forum() ) { 
  225.             return $args; 
  226.         } 
  227.  
  228.         if ( empty( $_GET['support_status'] ) ) { 
  229.             return $args; 
  230.         } 
  231.  
  232.         /** if meta_query exists, we dont want to break anything */ 
  233.         if ( ! empty( $args['meta_query'] ) ) { 
  234.             return $args; 
  235.         } 
  236.  
  237.         $args['meta_query'] = array( 
  238.             array( 
  239.                 'key' => '_bpbbpst_support_topic',  
  240.                 'value' => intval( $_GET['support_status'] ),  
  241.                 'compare' => '=' 
  242.  ) 
  243.  ); 
  244.  
  245.         $args['show_stickies'] = false; 
  246.  
  247.         return $args; 
  248.     } 
  249.  
  250.     /** 
  251.      * Adds the support status at the end of the breadcrumb 
  252.      * 
  253.      * @since  2.0 
  254.      * 
  255.      * @param  string $trail the breadcrumb html 
  256.      * @param  array $crumbs the different element to show in the breadcrumb 
  257.      * @param  array $args arguments to organize the display of the breadcrumb 
  258.      * @uses   bbp_is_single_forum() to check it's a single forum page 
  259.      * @uses   bpbbpst_get_selected_support_status() to get the caption for the filtered status 
  260.      * @uses   bbp_get_forum_permalink() to get the forum's permalink 
  261.      * @uses   esc_html() to sanitize the status 
  262.      * @return string $trail the new breadcrumb eventually including the support status 
  263.      */ 
  264.     public function breadcrumb_for_status( $trail, $crumbs, $args ) { 
  265.         if ( ! bbp_is_single_forum() ) { 
  266.             return $trail; 
  267.         } 
  268.  
  269.         if ( empty( $_GET['support_status'] ) ) { 
  270.             return $trail; 
  271.         } 
  272.  
  273.         $last = $crumbs[ count($crumbs) -1 ]; 
  274.         $sep = $args['sep']; 
  275.  
  276.         if ( ! empty( $sep ) ) { 
  277.             $sep = $args['sep_before'] . $sep . $args['sep_after']; 
  278.         } 
  279.  
  280.         $pad_sep = $args['pad_sep']; 
  281.  
  282.         // Pad the separator 
  283.         if ( ! empty( $pad_sep ) ) { 
  284.             $sep = str_pad( $sep, strlen( $sep ) + ( (int) $pad_sep * 2 ), ' ', STR_PAD_BOTH ); 
  285.         } 
  286.  
  287.         $support_status = bpbbpst_get_selected_support_status(  $_GET['support_status'] ); 
  288.  
  289.         $trail = str_replace( $last, '<a href="'. bbp_get_forum_permalink() .'" >'. $last .'</a>' . $sep . esc_html( $support_status['sb-caption'] ), $trail ); 
  290.  
  291.         return $trail; 
  292.     } 
  293.  
  294.     /** 
  295.      * Adds the support status at the end of the querystring 
  296.      * 
  297.      * @since  1.1 
  298.      * 
  299.      * @param  array pagination pagination settings 
  300.      * @uses   bbp_is_single_forum() to check it's a single forum page 
  301.      * @return array pagination the new pagination settings including the support status 
  302.      */ 
  303.     public function pagination_for_status( $pagination = array() ) { 
  304.         if ( ! bbp_is_single_forum() ) { 
  305.             return $pagination; 
  306.         } 
  307.  
  308.         if ( empty( $_GET['support_status'] ) ) { 
  309.             return $pagination; 
  310.         } 
  311.  
  312.         $pagination['base'] .= '?support_status=' .intval( $_GET['support_status'] )  ; 
  313.  
  314.         return $pagination; 
  315.     } 
  316.  
  317.     /** 
  318.      * Enqueue some style for the widget 
  319.      * 
  320.      * @since  2.0 
  321.      * 
  322.      * @uses   wp_enqueue_style() to load the css file 
  323.      * @uses   bpbbpst_get_plugin_url() to get plugin's url 
  324.      * @uses   bpbbpst_get_plugin_version() to get plugin's version 
  325.      */ 
  326.     public function enqueue_style() { 
  327.         wp_enqueue_style( 'bpbbpst-bbpress-widget-css', bpbbpst_get_plugin_url( 'css' ). 'bpbbpst-bbpress-widget.css', false, bpbbpst_get_plugin_version() ); 
  328.     } 
  329. }