Changeset 10039 for trunk/src/bp-core/bp-core-avatars.php

Timestamp:

08/09/2015 05:07:56 AM (10 years ago)

Author:

tw2113

Message:

More updates to BP-Core docs.

See #6398.

File:

• trunk/src/bp-core/bp-core-avatars.php (modified) (17 diffs)

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

@@ -1 +1 @@
 <?php
-
 /**
  * BuddyPress Avatars.
- */
-
-// Exit if accessed directly
+ *
+ * @package BuddyPress
+ */
+
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
-/***
+/**
  * Set up the constants we need for avatar support.
  */
@@ -326 +327 @@
     /** Sanity Checks *********************************************************/
 
-    // Get a fallback for the 'alt' parameter, create html output
+    // Get a fallback for the 'alt' parameter, create html output.
     if ( empty( $params['alt'] ) ) {
         $params['alt'] = __( 'Profile Photo', 'buddypress' );
@@ -332 +333 @@
     $html_alt = ' alt="' . esc_attr( $params['alt'] ) . '"';
 
-    // Filter image title and create html string
+    // Filter image title and create html string.
     $html_title = '';
 
@@ -351 +352 @@
     }
 
-    // Set CSS ID and create html string
+    // Set CSS ID and create html string.
     $html_css_id = '';
 
@@ -531 +532 @@
                 return apply_filters( 'bp_core_fetch_avatar', '<img src="' . $avatar_url . '"' . $html_class . $html_css_id  . $html_width . $html_height . $html_alt . $html_title . ' />', $params, $params['item_id'], $params['avatar_dir'], $html_css_id, $html_width, $html_height, $avatar_folder_url, $avatar_folder_dir );
 
-                // ...or only the URL
+            // ...or only the URL
             } else {
 
@@ -612 +613 @@
         }
 
-        // No avatar was found, and we've been told not to use a gravatar.
+    // No avatar was found, and we've been told not to use a gravatar.
     } else {
 
@@ -644 +645 @@
  * @param array|string $args {
  *     Array of function parameters.
- *     @type bool|int $item_id ID of the item whose avatar you're deleting.
- *           Defaults to the current item of type $object.
- *     @type string $object Object type of the item whose avatar you're
- *           deleting. 'user', 'group', 'blog', or custom. Default: 'user'.
+ *     @type bool|int    $item_id    ID of the item whose avatar you're deleting.
+ *                                   Defaults to the current item of type $object.
+ *     @type string      $object     Object type of the item whose avatar you're
+ *                                   deleting. 'user', 'group', 'blog', or custom.
+ *                                   Default: 'user'.
  *     @type bool|string $avatar_dir Subdirectory where avatar is located.
- *           Default: false, which falls back on the default location
- *           corresponding to the $object.
+ *                                   Default: false, which falls back on the default location
+ *                                   corresponding to the $object.
  * }
  * @return bool True on success, false on failure.
@@ -730 +732 @@
  */
 function bp_avatar_ajax_delete() {
-    // Bail if not a POST action
+    // Bail if not a POST action.
     if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
         wp_send_json_error();
@@ -810 +812 @@
     }
 
-    // Setup some variables
+    // Setup some variables.
     $bp          = buddypress();
     $upload_path = bp_core_avatar_upload_path();
 
-    // Upload the file
+    // Upload the file.
     $avatar_attachment = new BP_Attachment_Avatar();
     $bp->avatar_admin->original = $avatar_attachment->upload( $file, $upload_dir_filter );
 
-    // In case of an error, stop the process and display a feedback to the user
+    // In case of an error, stop the process and display a feedback to the user.
     if ( ! empty( $bp->avatar_admin->original['error'] ) ) {
         bp_core_add_message( sprintf( __( 'Upload Failed! Error was: %s', 'buddypress' ), $bp->avatar_admin->original['error'] ), 'error' );
@@ -824 +826 @@
     }
 
-    // Maybe resize
+    // Maybe resize.
     $bp->avatar_admin->resized = $avatar_attachment->shrink( $bp->avatar_admin->original['file'] );
     $bp->avatar_admin->image   = new stdClass();
@@ -838 +840 @@
     }
 
-    // Check for WP_Error on what should be an image
+    // Check for WP_Error on what should be an image.
     if ( is_wp_error( $bp->avatar_admin->image->dir ) ) {
         bp_core_add_message( sprintf( __( 'Upload failed! Error was: %s', 'buddypress' ), $bp->avatar_admin->image->dir->get_error_message() ), 'error' );
@@ -844 +846 @@
     }
 
-    // If the uploaded image is smaller than the "full" dimensions, throw a warning
+    // If the uploaded image is smaller than the "full" dimensions, throw a warning.
     if ( $avatar_attachment->is_too_small( $bp->avatar_admin->image->file ) ) {
         bp_core_add_message( sprintf( __( 'You have selected an image that is smaller than recommended. For best results, upload a picture larger than %d x %d pixels.', 'buddypress' ), bp_core_avatar_full_width(), bp_core_avatar_full_height() ), 'error' );
     }
 
-    // Set the url value for the image
+    // Set the url value for the image.
     $bp->avatar_admin->image->url = bp_core_avatar_url() . $bp->avatar_admin->image->dir;
 
@@ -1005 +1007 @@
 
  /**
- * Handle avatar webcam capture.
- *
- * @since BuddyPress (2.3.0)
- *
- * @param string $data     Base64 encoded image.
- * @param int    $item_id.
+  * Handle avatar webcam capture.
   *
- * @return bool True on success, false on failure.
- */
+  * @since BuddyPress (2.3.0)
+  *
+  * @param string $data    Base64 encoded image.
+  * @param int    $item_id Item to associate.
+  *
+  * @return bool True on success, false on failure.
+  */
 function bp_avatar_handle_capture( $data = '', $item_id = 0 ) {
     if ( empty( $data ) || empty( $item_id ) ) {
@@ -1021 +1023 @@
     $avatar_dir = bp_core_avatar_upload_path() . '/avatars';
 
-    // It's not a regular upload, we may need to create this folder
+    // It's not a regular upload, we may need to create this folder.
     if ( ! file_exists( $avatar_dir ) ) {
         if ( ! wp_mkdir_p( $avatar_dir ) ) {
@@ -1040 +1042 @@
     $avatar_folder_dir = apply_filters( 'bp_core_avatar_folder_dir', $avatar_dir . '/' . $item_id, $item_id, 'user', 'avatars' );
 
-    // It's not a regular upload, we may need to create this folder
+    // It's not a regular upload, we may need to create this folder.
     if( ! is_dir( $avatar_folder_dir ) ) {
         if ( ! wp_mkdir_p( $avatar_folder_dir ) ) {
@@ -1449 +1451 @@
     }
 
-    // See if the value has already been calculated and stashed in the $bp global
+    // See if the value has already been calculated and stashed in the $bp global.
     if ( isset( $bp->avatar->$type ) ) {
         $retval = $bp->avatar->$type;
     } else {
-        // If this value has been set in a constant, just use that
+        // If this value has been set in a constant, just use that.
         if ( defined( $constant ) ) {
             $retval = constant( $constant );
         } else {
 
-            // Use cached upload dir data if available
+            // Use cached upload dir data if available.
             if ( ! empty( $bp->avatar->upload_dir ) ) {
                 $upload_dir = $bp->avatar->upload_dir;
 
-            // No cache, so query for it
+            // No cache, so query for it.
             } else {
 
-                // Get upload directory information from current site
+                // Get upload directory information from current site.
                 $upload_dir = bp_upload_dir();
 
-                // Stash upload directory data for later use
+                // Stash upload directory data for later use.
                 $bp->avatar->upload_dir = $upload_dir;
             }
 
-            // Directory does not exist and cannot be created
+            // Directory does not exist and cannot be created.
             if ( ! empty( $upload_dir['error'] ) ) {
                 $retval = '';
@@ -1488 +1490 @@
         }
 
-        // Stash in $bp for later use
+        // Stash in $bp for later use.
         $bp->avatar->$type = $retval;
     }