BuddyPress_Support_Topic

Loads BuddyPress Specific parts.

Defined (1)

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

/includes/buddypress.php  
  1. class BuddyPress_Support_Topic extends BP_Group_Extension { 
  2.  
  3.     /** 
  4.      * The constructor 
  5.      * 
  6.      * @since 2.0 
  7.      * 
  8.      * @uses  BuddyPress_Support_Topic::enable_edit_item() to check if a forum is set for the group 
  9.      * @uses  BuddyPress_Support_Topic::setup_actions() to register some key actions and filters 
  10.      * @uses  BP_Group_Extension::init() 
  11.      */ 
  12.     public function __construct() { 
  13.  
  14.         $args = array( 
  15.             'slug' => 'forum-support',  
  16.                'name' => 'Forum Support',  
  17.                'enable_nav_item' => false,  
  18.                'screens' => array( 
  19.                    'create' => array( 'enabled' => false ),  
  20.                    'edit' => array( 'enabled' => $this->enable_edit_item() ),  
  21.                    'admin' => array( 'enabled' => false ),  
  22.  ) 
  23.  ); 
  24.  
  25.         parent::init( $args ); 
  26.  
  27.         $this->setup_actions(); 
  28.  
  29.     } 
  30.  
  31.     /** 
  32.      * Checks a forum is activated for the current group 
  33.      * 
  34.      * @since  2.0 
  35.      * 
  36.      * @uses   bp_is_group() to check we're in a single group 
  37.      * @uses   bp_get_new_group_id() to get the created group id 
  38.      * @uses   bp_get_current_group_id() to get current group id 
  39.      * @uses   bp_get_new_group_enable_forum() to check forum is enabled 
  40.      * @uses   groups_get_groupmeta() to get the forum settings for this group 
  41.      * @return boolean true|false 
  42.      */ 
  43.     public function enable_edit_item() { 
  44.         // Bail if not viewing a single group 
  45.         if ( ! bp_is_group() ) { 
  46.             return; 
  47.         } 
  48.  
  49.         $group_id = bp_get_new_group_id(); 
  50.  
  51.         if ( empty( $group_id ) ) { 
  52.             $group_id = bp_get_current_group_id(); 
  53.         } 
  54.  
  55.         // Are forums enabled for this group? 
  56.         $checked = bp_get_new_group_enable_forum() || groups_get_groupmeta( $group_id, 'forum_id' ); 
  57.  
  58.         return (bool) $checked; 
  59.     } 
  60.  
  61.     /** 
  62.      * Sets some key actions and filters 
  63.      * 
  64.      * @since 2.0 
  65.      * 
  66.      * @uses  add_action() to hook our action to specific points 
  67.      * @uses  add_filter() to eventually modify some key parts 
  68.      */ 
  69.     public function setup_actions() { 
  70.         // Enqueues a js script to hide/show the recipients 
  71.         add_action( 'bp_enqueue_scripts', array( $this, 'enqueue_forum_js' )                 ); 
  72.  
  73.         // Topic title in a BuddyPress group 
  74.         add_filter( 'bbp_get_topic_title', array( $this, 'filter_topic_title' ), 10, 2 ); 
  75.  
  76.         // removes above filter as soon as we can ! 
  77.         add_filter( 'bbp_get_template_part', array( $this, 'remove_topic_title_filer' ), 100, 3 ); 
  78.  
  79.         // adds the list of 'BuddyPress group mods' recipients to forum admin ui 
  80.         add_action( 'bpbbpst_forum_support_options', array( $this, 'admin_group_mods_list' ), 10, 2 ); 
  81.  
  82.         // saves the group recipients from forum admin 
  83.         add_action( 'bpbbpst_forum_settings_updated', array( $this, 'admin_group_mods_list_save' ), 10, 2 ); 
  84.  
  85.         // merges bp group specific recipients with bbPress ones 
  86.         add_filter( 'bpbbpst_list_recipients', array( $this, 'merge_bp_recipients' ), 10, 3 ); 
  87.     } 
  88.  
  89.     /** 
  90.      * Adds a javascript to WordPress scripts queue 
  91.      * 
  92.      * @since 2.0 
  93.      * 
  94.      * @uses  bp_is_group_admin_screen() to make sure we're in plugin's group admin tab 
  95.      * @uses  wp_enqueue_script() to add the script to WordPress queue 
  96.      * @uses  bpbbpst_get_plugin_url() to get the plugin's url 
  97.      * @uses  bpbbpst_get_plugin_version() to get plugin's version 
  98.      */ 
  99.     public function enqueue_forum_js() { 
  100.         if ( bp_is_group_admin_screen( 'forum-support' ) ) { 
  101.             wp_enqueue_script( 'bpbbpst-forum-js', bpbbpst_get_plugin_url( 'js' ) . 'bpbbpst-forum.js', array( 'jquery' ), bpbbpst_get_plugin_version() ); 
  102.         } 
  103.     } 
  104.  
  105.     /** 
  106.      * Adds the support status to topic title when on single topic 
  107.      * 
  108.      * @since  2.0 
  109.      * 
  110.      * @param  string $topic_title the topic title 
  111.      * @uses   bp_is_group_forum_topic() to check we're viewing a topic 
  112.      * @uses   bpbbpst_add_support_mention() to build the right support status 
  113.      * @return string the topic title 
  114.      */ 
  115.     public function filter_topic_title( $topic_title = '', $topic_id = 0 ) { 
  116.         // Avoid the prefix to be displayed in <title> 
  117.         if ( ! did_action( 'bp_head' ) ) { 
  118.             return $topic_title; 
  119.         } 
  120.  
  121.         if ( bp_is_group_forum_topic() ) { 
  122.             return bpbbpst_add_support_mention( $topic_id, false ) . $topic_title ; 
  123.         } else { 
  124.             return $topic_title; 
  125.         } 
  126.     } 
  127.  
  128.     /** 
  129.      * Removes the above filter as soon as we can 
  130.      * 
  131.      * This prevents the filter to spread in places we don't want to. 
  132.      * 
  133.      * @since  2.0 
  134.      * 
  135.      * @param  array  $templates the list of templates 
  136.      * @param  string $slug 
  137.      * @param  string $name 
  138.      * @uses   remove_filter() to remove our filter on the topic title 
  139.      * @return array             the list of templates 
  140.      */ 
  141.     public function remove_topic_title_filer( $templates = array(), $slug = '', $name = '' ) { 
  142.  
  143.         if ( in_array( $name, array( 'single-topic', 'topic' ) ) ) { 
  144.             remove_filter( 'bbp_get_topic_title', array( $this, 'filter_topic_title' ), 10, 2 ); 
  145.         } 
  146.  
  147.         return $templates; 
  148.     } 
  149.  
  150.     /** 
  151.      * Displays the content of plugin's group admin tab 
  152.      * 
  153.      * @since  2.0 
  154.      * 
  155.      * @param  integer $group_id the group id 
  156.      * @uses   bbp_get_group_forum_ids() to get the forum id attached to this group 
  157.      * @uses   bpbbpst_get_forum_support_setting() to get the forum support setting 
  158.      * @uses   bpbbpst_display_forum_setting_options() to display the forum support available options 
  159.      * @uses   groups_get_groupmeta() to get a specific group setting 
  160.      * @uses   BuddyPress_Support_Topic::group_list_moderators() to build the list of admins and mods for the group 
  161.      * @uses   bpbbpst_array_checked() to eventually add a checked attribute to user's checkbox 
  162.      * @uses   bp_core_get_user_displayname() to get user's display name 
  163.      * @return string html output 
  164.      */ 
  165.     public function edit_screen( $group_id = 0 ) { 
  166.  
  167.         if ( empty( $group_id ) ) { 
  168.             return false; 
  169.         } 
  170.  
  171.         $forum_ids = bbp_get_group_forum_ids( $group_id ); 
  172.  
  173.         // Get the first forum ID 
  174.         if ( ! empty( $forum_ids ) ) { 
  175.             $forum_id = (int) is_array( $forum_ids ) ? $forum_ids[0] : $forum_ids; 
  176.         } else { 
  177.             return false; 
  178.         } 
  179.  
  180.         $support_feature = bpbbpst_get_forum_support_setting( $forum_id ); 
  181.  
  182.         $style = ( $support_feature == 3 ) ? 'style="display:none"' : ''; 
  183.  
  184.         bpbbpst_display_forum_setting_options( $support_feature ); 
  185.  
  186.         $recipients = groups_get_groupmeta( $group_id, '_bpbbpst_support_bp_recipients' ); 
  187.  
  188.         if ( empty( $recipients ) ) { 
  189.             $recipients = array(); 
  190.         } 
  191.  
  192.         $group_forum_moderators = $this->group_list_moderators( $group_id ); 
  193.         ?> 
  194.         <div class="bpbbpst-mailing-list" <?php echo $style;?>> 
  195.             <h4><?php _e( 'Who should receive an email notification when a new support topic is posted ?', 'buddy-bbpress-support-topic' );?></h4> 
  196.             <input type="hidden" name="_bpbbpst_support_groups[]" value="<?php echo $group_id;?>"/> 
  197.             <ul class="bp-moderators-list"> 
  198.                 <?php foreach ( $group_forum_moderators as $moderator ) : ?> 
  199.                     <li> 
  200.                         <input type="checkbox" value="<?php echo $moderator->user_id;?>" name="_bpbbpst_support_bp_recipients[<?php echo $group_id;?>][]" <?php bpbbpst_array_checked( $recipients, $moderator->user_id );?>> 
  201.                         <?php echo bp_core_get_user_displayname( $moderator->user_id ) ;?> (<?php echo $moderator->role ;?>) 
  202.                     </li> 
  203.                 <?php endforeach;?> 
  204.             </ul> 
  205.         </div> 
  206.         <?php 
  207.     } 
  208.  
  209.     /** 
  210.      * Saves the group settings 
  211.      * 
  212.      * @since 2.0 
  213.      * 
  214.      * @param integer $group_id the group id 
  215.      * @uses  bbp_get_group_forum_ids() to get group's forum ids 
  216.      * @uses  delete_post_meta() to eventually remove a forum setting 
  217.      * @uses  update_post_meta() to save the forum setting 
  218.      * @uses  BuddyPress_Support_Topic::admin_group_mods_list_save() to eventually save the recipients for this group 
  219.      * @uses  bp_core_add_message() to add a user's notice to inform him of success / fail 
  220.      * @uses  bp_core_redirect() to redirect user and avoid double post 
  221.      * @uses  bp_get_group_permalink() to get current group permalink 
  222.      * @uses  buddypress() to get BuddyPress main instance 
  223.      */ 
  224.     public function edit_screen_save( $group_id = 0 ) { 
  225.         $success = false; 
  226.  
  227.         $forum_ids = bbp_get_group_forum_ids( $group_id ); 
  228.  
  229.         // Get the first forum ID 
  230.         if ( ! empty( $forum_ids ) ) { 
  231.             $forum_id = (int) is_array( $forum_ids ) ? $forum_ids[0] : $forum_ids; 
  232.         } 
  233.  
  234.         $support_feature = ! empty( $_POST['_bpbbpst_forum_settings'] ) ? intval( $_POST['_bpbbpst_forum_settings'] ) : 1; 
  235.  
  236.         if ( 3 == $support_feature ) { 
  237.             delete_post_meta( $forum_id, '_bpbbpst_support_recipients' ); 
  238.         } 
  239.  
  240.         $success = update_post_meta( $forum_id, '_bpbbpst_forum_settings', $support_feature ); 
  241.  
  242.         // let's use admin function for recipients 
  243.         $this->admin_group_mods_list_save( $forum_id , $support_feature ); 
  244.  
  245.         if ( ! $success ) { 
  246.             bp_core_add_message( __( 'There was an error saving, please try again', 'buddy-bbpress-support-topic' ), 'error' ); 
  247.         } else { 
  248.             bp_core_add_message( __( 'Settings saved successfully', 'buddy-bbpress-support-topic' ) ); 
  249.         } 
  250.  
  251.         bp_core_redirect( bp_get_group_permalink( buddypress()->groups->current_group ) . 'admin/' . $this->slug ); 
  252.     } 
  253.  
  254.     /** 
  255.      * Builds a list of Moderators for the forum of the group (Admin + Mods) 
  256.      * 
  257.      * @since  2.0 
  258.      * 
  259.      * @param  integer $forum_id the forum id 
  260.      * @param  string  $style    hide or show the recipients 
  261.      * @uses   bbp_get_group_forum_ids() to get group's forum ids 
  262.      * @uses   groups_get_groups() to build a detailled list of groups using the forum 
  263.      * @uses   esc_url() to sanitize url 
  264.      * @uses   bp_get_group_permalink() to build the group permalink 
  265.      * @uses   esc_html() to sanitize the group name 
  266.      * @uses   groups_get_groupmeta() to get the previously saved recipients 
  267.      * @uses   BuddyPress_Support_Topic::group_list_moderators() to get Group Admins and Mods 
  268.      * @uses   bpbbpst_array_checked() to eventually add a checked attribute to user's checkbox 
  269.      * @uses   bp_core_get_user_displayname() to get user's display name 
  270.      * @return string html  output 
  271.      */ 
  272.     public function admin_group_mods_list( $forum_id = 0, $style = '' ) { 
  273.  
  274.         $group_ids = bbp_get_forum_group_ids( $forum_id ); 
  275.  
  276.         if ( empty( $group_ids ) || ! is_array( $group_ids ) ) { 
  277.             return false; 
  278.         } 
  279.  
  280.         /** a forum can be in several groups... But strangely the forum meta seems to only keep the latest group.. 
  281.         it might evolved so let's keep the following this way, we'll be ready */ 
  282.         $groups = groups_get_groups( array( 'include' => implode( ', ', $group_ids ) ) ); 
  283.  
  284.         if ( empty( $groups ) ) { 
  285.             return false; 
  286.         } 
  287.         ?> 
  288.         <ul class="bpbbpst-mailing-list" <?php echo $style;?>> 
  289.  
  290.         <?php foreach ( $groups['groups'] as $group ) : ?> 
  291.  
  292.             <li> 
  293.                 <h4><?php printf( __( 'In Group: %s', 'buddy-bbpress-support-topic' ), '<a href="'. esc_url( bp_get_group_permalink( $group ) ) .'">'. esc_html( $group->name ) .'</a>' );?></h4> 
  294.                 <input type="hidden" name="_bpbbpst_support_groups[]" value="<?php echo $group->id;?>"/> 
  295.                 <ul class="bp-moderators-list"> 
  296.  
  297.                 <?php 
  298.  
  299.                 $recipients = $group_moderators = array(); 
  300.                 $recipients = groups_get_groupmeta( $group->id, '_bpbbpst_support_bp_recipients' ); 
  301.                 $group_moderators = $this->group_list_moderators( $group->id ); 
  302.  
  303.                 foreach ( $group_moderators as $moderator ) : ?> 
  304.                     <li> 
  305.                         <input type="checkbox" value="<?php echo $moderator->user_id;?>" name="_bpbbpst_support_bp_recipients[<?php echo $group->id;?>][]" <?php bpbbpst_array_checked( $recipients, $moderator->user_id );?>> 
  306.                         <?php echo bp_core_get_user_displayname( $moderator->user_id ) ;?> (<?php echo $moderator->role ;?>) 
  307.                     </li> 
  308.                 <?php endforeach ; ?> 
  309.                 </ul> 
  310.  
  311.             </li> 
  312.  
  313.         <?php endforeach;?> 
  314.  
  315.         </ul> 
  316.         <?php 
  317.     } 
  318.  
  319.     /** 
  320.      * Saves the recipients list for the forum of the group 
  321.      * 
  322.      * @since 2.0 
  323.      * 
  324.      * @param integer $forum_id        the forum id 
  325.      * @param integer $support_feature the forum support setting 
  326.      * @uses  groups_delete_groupmeta() to eventually remove a group setting 
  327.      * @uses  groups_update_groupmeta() to save a group setting 
  328.      */ 
  329.     public function admin_group_mods_list_save( $forum_id = 0, $support_feature = 0 ) { 
  330.  
  331.         if ( empty( $_POST['_bpbbpst_support_groups'] ) || ! is_array( $_POST['_bpbbpst_support_groups'] ) || empty( $forum_id ) ) { 
  332.             return; 
  333.         } 
  334.  
  335.         $group_ids = array_map( 'intval', $_POST['_bpbbpst_support_groups'] ); 
  336.  
  337.         if ( $support_feature == 3 ) { 
  338.             foreach ( $group_ids as $group_id ) { 
  339.                 groups_delete_groupmeta( $group_id, '_bpbbpst_support_bp_recipients' ); 
  340.             } 
  341.  
  342.         } else { 
  343.             $bp_recipients = ! empty( $_POST['_bpbbpst_support_bp_recipients'] ) ? $_POST['_bpbbpst_support_bp_recipients'] : false ; 
  344.  
  345.             if ( ! empty( $bp_recipients ) && is_array( $bp_recipients ) && count( $bp_recipients ) > 0 ) { 
  346.                 foreach ( $group_ids as $group_id ) { 
  347.                     if ( ! empty( $bp_recipients[$group_id] ) && is_array( $bp_recipients[$group_id] ) && count( $bp_recipients[$group_id] ) > 0 ) { 
  348.                         groups_update_groupmeta( $group_id, '_bpbbpst_support_bp_recipients', array_map( 'intval', $bp_recipients[$group_id] ) ); 
  349.                     } else { 
  350.                         groups_delete_groupmeta( $group_id, '_bpbbpst_support_bp_recipients' ); 
  351.                     } 
  352.                 } 
  353.  
  354.             } else { 
  355.                 foreach ( $group_ids as $group_id ) { 
  356.                     groups_delete_groupmeta( $group_id, '_bpbbpst_support_bp_recipients' ); 
  357.                 } 
  358.             } 
  359.         } 
  360.     } 
  361.  
  362.     /** 
  363.      * In case of a notification, eventually adds group's forum recipients to bbPress ones 
  364.      * 
  365.      * @since  2.0 
  366.      * 
  367.      * @param  array   $recipients the list of bbPress moderators 
  368.      * @param  string  $context    are we notifying users ? 
  369.      * @param  integer $forum_id   the forum id 
  370.      * @uses   bbp_get_group_forum_ids() to get group's forum ids 
  371.      * @uses   groups_get_groupmeta() to get the previously saved recipients 
  372.      * @return array              the list of forum moderators 
  373.      */ 
  374.     public function merge_bp_recipients( $recipients = array(), $context = 'admin', $forum_id = 0 ) { 
  375.  
  376.         if ( $context == 'notify' && ! empty( $forum_id ) ) { 
  377.             $group_ids = bbp_get_forum_group_ids( $forum_id ); 
  378.  
  379.             if ( empty( $group_ids ) || ! is_array( $group_ids ) ) { 
  380.                 return $recipients; 
  381.             } 
  382.  
  383.             foreach ( $group_ids as $group_id ) { 
  384.                 $bp_recipients = groups_get_groupmeta( $group_id, '_bpbbpst_support_bp_recipients' ); 
  385.  
  386.                 if ( ! empty( $bp_recipients ) ) { 
  387.                     // strips common values 
  388.                     $bp_recipients = array_diff( $bp_recipients, $recipients ); 
  389.                     // merge unique 
  390.                     $recipients = array_merge( $recipients, $bp_recipients ); 
  391.                 } 
  392.  
  393.             } 
  394.  
  395.         } 
  396.  
  397.         return $recipients; 
  398.     } 
  399.  
  400.     /** 
  401.      * Builds the list of group mods and admins 
  402.      * 
  403.      * @since  2.0 
  404.      * 
  405.      * @param  integer $group_id the group id 
  406.      * @uses   groups_get_group_admins() to get group admins 
  407.      * @uses   groups_get_group_mods() to get group mods 
  408.      * @return array            the list of group's forum admins and mods 
  409.      */ 
  410.     public static function group_list_moderators( $group_id = 0 ) { 
  411.  
  412.         if ( empty( $group_id ) ) { 
  413.             return false; 
  414.         } 
  415.  
  416.         $group_admins = array( 
  417.             array( 
  418.                 'users' => groups_get_group_admins( $group_id ),  
  419.                 'role' => __( 'Group Admin', 'buddy-bbpress-support-topic' ) 
  420.  ) 
  421.  ); 
  422.  
  423.         $group_mods = array( 
  424.             array( 
  425.                 'users' => groups_get_group_mods( $group_id ),  
  426.                 'role' => __( 'Group Mod', 'buddy-bbpress-support-topic' ) 
  427.  ) 
  428.  ); 
  429.  
  430.         $group_admins = array_map( 'bpbbpst_role_group_forum_map', $group_admins ); 
  431.         $group_mods = array_map( 'bpbbpst_role_group_forum_map', $group_mods ); 
  432.  
  433.         $group_forum_moderators = array_merge( $group_admins[0], $group_mods[0] ); 
  434.  
  435.         return $group_forum_moderators; 
  436.     } 
  437.  
  438.     /** 
  439.      * We do not use widgets 
  440.      * 
  441.      * @since  2.0 
  442.      * 
  443.      * @return boolean false 
  444.      */ 
  445.     public function widget_display() { return false; } 
  446.  
  447. }