Changeset 9755

Timestamp:

04/16/2015 10:11:05 PM (11 years ago)

Author:

imath

Message:

Avatar UI: Add Conditional functions and new BP Attachment methods

• bp_avatar_is_front_edit() checks if the user is editing his or a group avatar on front-end
• bp_avatar_use_webcam() checks if the Camera feature should be enabled. By default, it is not the case for touch devices as it can introduce some confustions with the possibility of using the camera of the device to take a selfie, save it as an image an upload it using the Browse button of the Avatar UI. Chrome and Firefox are the only browsers supporting getUserMedia.

NB: these two functions can be filtered to disallow the Camera feature or to completely disallow the new Avatar UI if you prefer to carry on using the legacy UI.

BP_Attachment::script_data() and BP_Attachment_Avatar::script_data() are two new methods to build the javascript localization data. The bp_attachment_avatar_params filter is fired if the current object is not a group or a user and can be used to build the params of another object such as a blog. You can also use the filter bp_attachment_avatar_script_data if you need to override data for any object.

Props boonebgorges, DJPaul.

See #6290
See #6278

Location:

trunk/src/bp-core

Files:

• bp-core-avatars.php (modified) (1 diff)
• classes/class-bp-attachment-avatar.php (modified) (1 diff)
• classes/class-bp-attachment.php (modified) (1 diff)

trunk/src/bp-core/bp-core-avatars.php

@@ -1374 +1374 @@
 }
 add_action( 'bp_parse_query', 'bp_core_avatar_reset_query', 10, 1 );
+
+/**
+ * Checks whether Avatar UI should be loaded
+ *
+ * @since  BuddyPress (2.3.0)
+ *
+ * @return bool True if Avatar UI should load, false otherwise
+ */
+function bp_avatar_is_front_edit() {
+        $retval = false;
+
+        if ( bp_is_user_change_avatar() && 'crop-image' !== bp_get_avatar_admin_step() ) {
+                $retval = ! bp_core_get_root_option( 'bp-disable-avatar-uploads' );
+        }
+
+        if ( bp_is_active( 'groups' ) ) {
+                // Group creation
+                if ( bp_is_group_create() && bp_is_group_creation_step( 'group-avatar' ) && 'crop-image' !== bp_get_avatar_admin_step() ) {
+                        $retval = ! bp_core_get_root_option( 'bp-disable-avatar-uploads' );
+
+                // Group Manage
+                } elseif ( bp_is_group_admin_page() && bp_is_group_admin_screen( 'group-avatar' ) && 'crop-image' !== bp_get_avatar_admin_step() ) {
+                        $retval = ! bp_core_get_root_option( 'bp-disable-avatar-uploads' );
+                }
+        }
+
+        /**
+         * Use this filter if you need to :
+         * - Load the avatar UI for a component that is !groups or !user (return true regarding your conditions)
+         * - Completely disable the avatar UI introduced in 2.3 (eg: __return_false())
+         *
+         * @since  BuddyPress (2.3.0)
+         *
+         * @var  bool whether to load the Avatar UI
+         */
+        return apply_filters( 'bp_avatar_is_front_edit', $retval );
+}
+
+/**
+ * Checks whether the Webcam Avatar UI part should be loaded
+ *
+ * @since  BuddyPress (2.3.0)
+ *
+ * @return bool True to load the Webcam Avatar UI part. False otherwise.
+ */
+function bp_avatar_use_webcam() {
+        /**
+         * Do not use the webcam feature for mobile devices
+         * to avoid possible confusions.
+         */
+        if ( wp_is_mobile() ) {
+                return false;
+        }
+
+        /**
+         * Use this filter if you need to disable the webcam capture feature
+         * by returning false.
+         *
+         * @since  BuddyPress (2.3.0)
+         *
+         * @var  bool whether to load Webcam Avatar UI part
+         */
+        return apply_filters( 'bp_avatar_use_webcam', true );
+}

trunk/src/bp-core/classes/class-bp-attachment-avatar.php

@@ -257 +257 @@
                 return $avatar_types;
         }
+
+        /**
+         * Get the user id to set its avatar
+         *
+         * @since BuddyPress (2.3.0)
+         *
+         * @return integer the user ID
+         */
+        private function get_user_id() {
+                $bp = buddypress();
+                $user_id = 0;
+
+                if ( bp_is_user() ) {
+                        $user_id = bp_displayed_user_id();
+                }
+
+                if ( ! empty( $bp->members->admin->user_id ) ) {
+                        $user_id = $bp->members->admin->user_id;
+                }
+
+                return $user_id;
+        }
+
+        /**
+         * Get the group id to set its avatar
+         *
+         * @since BuddyPress (2.3.0)
+         *
+         * @return integer the group id
+         */
+        private function get_group_id() {
+                $group_id = 0;
+
+                if ( bp_is_group() ) {
+                        $group_id = bp_get_current_group_id();
+                }
+
+                return $group_id;
+        }
+
+        /**
+         * Build script datas for the Uploader UI
+         *
+         * @since BuddyPress (2.3.0)
+         *
+         * @return array the javascript localization data
+         */
+        public function script_data() {
+                // Get default script data
+                $script_data = parent::script_data();
+
+                // Defaults to Avatar Backbone script
+                $js_scripts = array( 'bp-avatar' );
+
+                // Default object
+                $object = '';
+
+                // Get the possible item ids
+                $user_id  = $this->get_user_id();
+                $group_id = $this->get_group_id();
+
+                if ( ! empty( $user_id ) ) {
+                        // Should we load the the Webcam Avatar javascript file
+                        if ( bp_avatar_use_webcam() ) {
+                                $js_scripts = array( 'bp-webcam' );
+                        }
+
+                        $script_data['bp_params'] = array(
+                                'object'     => 'user',
+                                'item_id'    => $user_id,
+                                'has_avatar' => bp_get_user_has_avatar( $user_id ),
+                                'nonces'  => array(
+                                        'set'    => wp_create_nonce( 'bp_avatar_cropstore' ),
+                                        'remove' => wp_create_nonce( 'bp_delete_avatar_link' ),
+                                ),
+                        );
+
+                        // Set feedback messages
+                        $script_data['feedback_messages'] = array(
+                                1 => __( 'There was a problem cropping your profile photo.', 'buddypress' ),
+                                2 => __( 'Your new profile photo was uploaded successfully.', 'buddypress' ),
+                                3 => __( 'There was a problem deleting your profile photo. Please try again.', 'buddypress' ),
+                                4 => __( 'Your profile photo was deleted successfully!', 'buddypress' ),
+                        );
+                } elseif ( ! empty( $group_id ) ) {
+                        $script_data['bp_params'] = array(
+                                'object'     => 'group',
+                                'item_id'    => $group_id,
+                                'has_avatar' => bp_get_group_has_avatar( $group_id ),
+                                'nonces'     => array(
+                                        'set'    => wp_create_nonce( 'bp_avatar_cropstore' ),
+                                        'remove' => wp_create_nonce( 'bp_group_avatar_delete' ),
+                                ),
+                        );
+
+                        // Set feedback messages
+                        $script_data['feedback_messages'] = array(
+                                1 => __( 'There was a problem cropping the group profile photo.', 'buddypress' ),
+                                2 => __( 'The group profile photo was uploaded successfully.', 'buddypress' ),
+                                3 => __( 'There was a problem deleting the group profile photo. Please try again.', 'buddypress' ),
+                                4 => __( 'The group profile photo was deleted successfully!', 'buddypress' ),
+                        );
+                } else {
+                        /**
+                         * Use this filter to include specific BuddyPress params for your object
+                         * e.g. Blavatar
+                         *
+                         * @since BuddyPress (2.3.0)
+                         *
+                         * @param array the avatar specific BuddyPress parameters
+                         */
+                        $script_data['bp_params'] = apply_filters( 'bp_attachment_avatar_params', array() );
+                }
+
+                // Include the specific css
+                $script_data['extra_css'] = array( 'bp-avatar' );
+
+                // Include the specific css
+                $script_data['extra_js']  = $js_scripts;
+
+                // Set the object to contextualize the filter
+                if ( isset( $script_data['bp_params']['object'] ) ) {
+                        $object = $script_data['bp_params']['object'];
+                }
+
+                /**
+                 * Use this filter to override/extend the avatar script data
+                 *
+                 * @since BuddyPress (2.3.0)
+                 *
+                 * @param array  $script_data the avatar script data
+                 * @param string $object      the object the avatar belongs to (eg: user or group)
+                 */
+                return apply_filters( 'bp_attachment_avatar_script_data', $script_data, $object );
+        }
 }

trunk/src/bp-core/classes/class-bp-attachment.php

@@ -478 +478 @@
                 return wp_crop_image( $r['original_file'], (int) $r['crop_x'], (int) $r['crop_y'], (int) $r['crop_w'], (int) $r['crop_h'], (int) $r['dst_w'], (int) $r['dst_h'], $r['src_abs'], $r['dst_file'] );
         }
+
+        /**
+         * Build script datas for the Uploader UI
+         *
+         * Override this method from your child class to build the script datas
+         *
+         * @since BuddyPress (2.3.0)
+         *
+         * @return array the javascript localization data
+         */
+        public function script_data() {
+                $script_data = array(
+                        'action'            => $this->action,
+                        'file_data_name'    => $this->file_input,
+                        'max_file_size'     => $this->original_max_filesize,
+                        'feedback_messages' => array(
+                                1 => __( 'Sorry, uploading the file failed.', 'buddypress' ),
+                                2 => __( 'File successfully uploaded.', 'buddypress' ),
+                        ),
+                );
+
+                return $script_data;
+        }
 }