Changeset 11146

Timestamp:

09/21/2016 10:59:04 PM (8 years ago)

Author:

r-a-y

Message:

Groups: Add group type settings fields and a group type list on single group pages.

• If group types are registered with the 'show_in_create_screen' parameter, group administrators can set the group type when creating a group or when on a group's "Manage > Settings" page.
• If group types are registered with the 'show_in_list' parameter, a comma-delimited list of group types can be displayed for a group with the bp_group_type_list() function. By default, this function is used on a group page's header.

See #7210.

Location:

trunk/src

Files:

• bp-groups/bp-groups-actions.php (modified) (1 diff)
• bp-groups/bp-groups-screens.php (modified) (1 diff)
• bp-groups/bp-groups-template.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress/groups/create.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress/groups/single/admin/group-settings.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress/groups/single/cover-image-header.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress/groups/single/group-header.php (modified) (1 diff)

trunk/src/bp-groups/bp-groups-actions.php

@@ -209 +209 @@
                 bp_core_add_message( __( 'There was an error saving group details. Please try again.', 'buddypress' ), 'error' );
                 bp_core_redirect( trailingslashit( bp_get_groups_directory_permalink() . 'create/step/' . bp_get_groups_current_create_step() ) );
+            }
+
+            // Save group types.
+            if ( ! empty( $_POST['group-types'] ) ) {
+                bp_groups_set_group_type( $bp->groups->new_group_id, $_POST['group-types'] );
             }
 

trunk/src/bp-groups/bp-groups-screens.php

@@ -931 +931 @@
         if ( !check_admin_referer( 'groups_edit_group_settings' ) )
             return false;
+
+        /*
+         * Save group types.
+         *
+         * Ensure we keep types that have 'show_in_create_screen' set to false.
+         */
+        $current_types = bp_groups_get_group_type( bp_get_current_group_id(), false );
+        $current_types = array_intersect( bp_groups_get_group_types( array( 'show_in_create_screen' => false ) ), (array) $current_types );
+        if ( isset( $_POST['group-types'] ) ) {
+            $current_types = array_merge( $current_types, $_POST['group-types'] );
+
+            // Set group types.
+            bp_groups_set_group_type( bp_get_current_group_id(), $current_types );
+
+        // No group types checked, so this means we want to wipe out all group types.
+        } else {
+            /*
+             * Passing a blank string will wipe out all types for the group.
+             *
+             * Ensure we keep types that have 'show_in_create_screen' set to false.
+             */
+            $current_types = empty( $current_types ) ? '' : $current_types;
+
+            // Set group types.
+            bp_groups_set_group_type( bp_get_current_group_id(), $current_types );
+        }
 
         if ( !groups_edit_group_settings( $_POST['group-id'], $enable_forum, $status, $invite_status ) ) {

trunk/src/bp-groups/bp-groups-template.php

@@ -127 +127 @@
          */
         return apply_filters( 'bp_get_groups_directory_permalink', trailingslashit( bp_get_root_domain() . '/' . bp_get_groups_root_slug() ) );
+    }
+
+/**
+ * Output group type directory permalink.
+ *
+ * @since 2.7.0
+ *
+ * @param string $group_type Optional. Group type.
+ */
+function bp_group_type_directory_permalink( $group_type = '' ) {
+    echo esc_url( bp_get_group_type_directory_permalink( $group_type ) );
+}
+    /**
+     * Return group type directory permalink.
+     *
+     * @since 2.7.0
+     *
+     * @param string $group_type Optional. Group type. Defaults to current group type.
+     * @return string Group type directory URL on success, an empty string on failure.
+     */
+    function bp_get_group_type_directory_permalink( $group_type = '' ) {
+
+        if ( $group_type ) {
+            $_group_type = $group_type;
+        } else {
+            // Fall back on the current group type.
+            $_group_type = bp_get_current_group_directory_type();
+        }
+
+        $type = bp_groups_get_group_type_object( $_group_type );
+
+        // Bail when member type is not found or has no directory.
+        if ( ! $type || ! $type->has_directory ) {
+            return '';
+        }
+
+        /**
+         * Filters the group type directory permalink.
+         *
+         * @since 2.7.0
+         *
+         * @param string $value       Group type directory permalink.
+         * @param object $type        Group type object.
+         * @param string $member_type Group type name, as passed to the function.
+         */
+        return apply_filters( 'bp_get_group_type_directory_permalink', trailingslashit( bp_get_groups_directory_permalink() . bp_get_groups_group_type_base() . '/' . $type->directory_slug ), $type, $group_type );
+    }
+
+/**
+ * Output group type directory link.
+ *
+ * @since 2.7.0
+ *
+ * @param string $group_type Unique group type identifier as used in bp_groups_register_group_type().
+ */
+function bp_group_type_directory_link( $group_type = '' ) {
+    echo bp_get_group_type_directory_link( $group_type );
+}
+    /**
+     * Return group type directory link.
+     *
+     * @since 2.7.0
+     *
+     * @param string $group_type Unique group type identifier as used in bp_groups_register_group_type().
+     * @return string
+     */
+    function bp_get_group_type_directory_link( $group_type = '' ) {
+        if ( empty( $group_type ) ) {
+            return '';
+        }
+
+        return sprintf( '<a href="%s">%s</a>', esc_url( bp_get_group_type_directory_permalink( $group_type ) ), bp_groups_get_group_type_object( $group_type )->labels['name'] );
+    }
+
+/**
+ * Output a comma-delimited list of group types.
+ *
+ * @since 2.7.0
+ * @see   bp_get_group_type_list() for parameter documentation.
+ */
+function bp_group_type_list( $group_id = 0, $r = array() ) {
+    echo bp_get_group_type_list( $group_id, $r );
+}
+    /**
+     * Return a comma-delimited list of group types.
+     *
+     * @since 2.7.0
+     *
+     * @param int $group_id Group ID. Defaults to current group ID if on a group page.
+     * @param array|string $args {
+     *     Array of parameters. All items are optional.
+     *     @type string $parent_element Element to wrap around the list. Defaults to 'p'.
+     *     @type array  $parent_attr    Element attributes for parent element. Defaults to
+     *                                  array( 'class' => 'bp-group-type-list' ).
+     *     @type string $label          Label to add before the list. Defaults to 'Group Types:'.
+     *     @type string $label_element  Element to wrap around the label. Defaults to 'strong'.
+     *     @type array  $label_attr     Element attributes for label element. Defaults to array().
+     * }
+     * @return string
+     */
+    function bp_get_group_type_list( $group_id = 0, $r = array() ) {
+        if ( empty( $group_id ) ) {
+            $group_id = bp_get_current_group_id();
+        }
+
+        $r = bp_parse_args( $r, array(
+            'parent_element' => 'p',
+            'parent_attr'    => array(
+                 'class' => 'bp-group-type-list',
+            ),
+            'label'          => __( 'Group Types:', 'buddypress' ),
+            'label_element'  => 'strong',
+            'label_attr'     => array()
+        ), 'group_type_list' );
+
+        $retval = '';
+
+        if ( $types = bp_groups_get_group_type( $group_id, false ) ) {
+            // Make sure we can show the type in the list.
+            $types = array_intersect( bp_groups_get_group_types( array( 'show_in_list' => true ) ), $types );
+            if ( empty( $types ) ) {
+                return $retval;
+            }
+
+            $before = $after = $label = '';
+
+            // Render parent element.
+            if ( ! empty( $r['parent_element'] ) ) {
+                $parent_elem = new BP_Core_HTML_Element( array(
+                    'element' => $r['parent_element'],
+                    'attr'    => $r['parent_attr']
+                ) );
+
+                // Set before and after.
+                $before = $parent_elem->get( 'open_tag' );
+                $after  = $parent_elem->get( 'close_tag' );
+            }
+
+            // Render label element.
+            if ( ! empty( $r['label_element'] ) ) {
+                $label = new BP_Core_HTML_Element( array(
+                    'element'    => $r['label_element'],
+                    'attr'       => $r['label_attr'],
+                    'inner_html' => esc_html( $r['label'] )
+                ) );
+                $label = $label->contents() . ' ';
+
+            // No element, just the label.
+            } else {
+                $label = esc_html( $r['label'] );
+            }
+
+            // Comma-delimit each type into the group type directory link.
+            $label .= implode( ', ', array_map( 'bp_get_group_type_directory_link', $types ) );
+
+            // Retval time!
+            $retval = $before . $label . $after;
+        }
+
+        return $retval;
     }
 

trunk/src/bp-templates/bp-legacy/buddypress/groups/create.php

@@ -136 +136 @@
 
                 </fieldset>
+
+                <?php // Group type selection ?>
+                <?php if ( $group_types = bp_groups_get_group_types( array( 'show_in_create_screen' => true ), 'objects' ) ): ?>
+
+                    <fieldset class="group-create-types">
+                        <legend><?php _e( 'Group Types', 'buddypress' ); ?></legend>
+
+                        <p><?php _e( 'Select the types this group should be a part of.', 'buddypress' ); ?></p>
+
+                        <?php foreach ( $group_types as $type ) : ?>
+                            <div class="checkbox">
+                                <label for="<?php printf( 'group-type-%s', $type->name ); ?>"><input type="checkbox" name="group-types[]" id="<?php printf( 'group-type-%s', $type->name ); ?>" value="<?php esc_attr_e( $type->name ); ?>" /> <?php esc_html_e( $type->labels['name'] ); ?>
+                                    <?php
+                                        if ( isset( $type->description ) ) {
+                                            printf( __( '&ndash; %s', 'buddypress' ), '<span class="bp-group-type-desc">' . $type->description . '</span>' );
+                                        }
+                                    ?>
+                                </label>
+                            </div>
+
+                        <?php endforeach; ?>
+
+                    </fieldset>
+
+                <?php endif; ?>
 
                 <fieldset class="group-create-invitations">

trunk/src/bp-templates/bp-legacy/buddypress/groups/single/admin/group-settings.php

@@ -68 +68 @@
 </fieldset>
 
+<?php // Group type selection ?>
+<?php if ( $group_types = bp_groups_get_group_types( array( 'show_in_create_screen' => true ), 'objects' ) ): ?>
+
+    <fieldset class="group-create-types">
+        <legend><?php _e( 'Group Types', 'buddypress' ); ?></legend>
+
+        <p><?php _e( 'Select the types this group should be a part of.', 'buddypress' ); ?></p>
+
+        <?php foreach ( $group_types as $type ) : ?>
+            <div class="checkbox">
+                <label for="<?php printf( 'group-type-%s', $type->name ); ?>">
+                    <input type="checkbox" name="group-types[]" id="<?php printf( 'group-type-%s', $type->name ); ?>" value="<?php esc_attr_e( $type->name ); ?>" <?php checked( bp_groups_has_group_type( bp_get_current_group_id(), $type->name ) ); ?>/> <?php esc_html_e( $type->labels['name'] ); ?>
+                    <?php
+                        if ( ! empty( $type->description ) ) {
+                            printf( __( '&ndash; %s', 'buddypress' ), '<span class="bp-group-type-desc">' . esc_html( $type->description ) . '</span>' );
+                        }
+                    ?>
+                </label>
+            </div>
+
+        <?php endforeach; ?>
+
+    </fieldset>
+
+<?php endif; ?>
+
 <fieldset class="group-create-invitations">
 

trunk/src/bp-templates/bp-legacy/buddypress/groups/single/cover-image-header.php

@@ -64 +64 @@
                 <?php bp_group_description(); ?>
 
+                <?php bp_group_type_list(); ?>
             </div>
         </div><!-- #item-header-content -->

trunk/src/bp-templates/bp-legacy/buddypress/groups/single/group-header.php

@@ -84 +84 @@
         <?php bp_group_description(); ?>
 
+        <?php bp_group_type_list(); ?>
+
         <div id="item-buttons">