Changeset 10858 for trunk/src/bp-activity/bp-activity-functions.php

Timestamp:

06/01/2016 09:00:21 PM (8 years ago)

Author:

r-a-y

Message:

Activity: Introduce error handling to the BP_Activity_Activity class.

To support frontend user messages for activity failures, we need the
ability to add errors.

This commit:

• Introduces the $errors object and $error_type property to the BP_Activity_Activity class.
• Adds an 'error_type' parameter to all applicable, activity functions.
• Modifies bp-legacy to output an error message for activity failures.

See #6719.

File:

• trunk/src/bp-activity/bp-activity-functions.php (modified) (12 diffs)

trunk/src/bp-activity/bp-activity-functions.php

@@ -1783 +1783 @@
  *
  * @since 1.1.0
+ * @since 2.6.0 Added 'error_type' parameter to $args.
  *
  * @param array|string $args {
@@ -1814 +1815 @@
  *                                       Default: false.
  *     @type bool     $is_spam           Should the item be marked as spam? Default: false.
+ *     @type string   $error_type        Optional. Error type. Either 'bool' or 'wp_error'. Default: 'bool'.
  * }
  * @return int|bool The ID of the activity on success. False on error.
@@ -1832 +1834 @@
         'hide_sitewide'     => false,                  // Should this be hidden on the sitewide activity stream?
         'is_spam'           => false,                  // Is this activity item to be marked as spam?
+        'error_type'        => 'bool'
     ), 'activity_add' );
 
@@ -1855 +1858 @@
     $activity->hide_sitewide     = $r['hide_sitewide'];
     $activity->is_spam           = $r['is_spam'];
+    $activity->error_type        = $r['error_type'];
     $activity->action            = ! empty( $r['action'] )
-                                        ? $r['action']
-                                        : bp_activity_generate_action_string( $activity );
-
-    if ( ! $activity->save() ) {
+                        ? $r['action']
+                        : bp_activity_generate_action_string( $activity );
+
+    $save = $activity->save();
+
+    if ( 'wp_error' === $r['error_type'] && is_wp_error( $save ) ) {
+        return $save;
+    } elseif ('bool' === $r['error_type'] && false === $save ) {
         return false;
     }
@@ -1899 +1907 @@
 
     $r = wp_parse_args( $args, array(
-        'content' => false,
-        'user_id' => bp_loggedin_user_id()
+        'content'    => false,
+        'user_id'    => bp_loggedin_user_id(),
+        'error_type' => 'bool',
     ) );
 
@@ -1940 +1949 @@
         'component'    => buddypress()->activity->id,
         'type'         => 'activity_update',
+        'error_type'   => $r['error_type']
     ) );
+
+    if ( is_wp_error( $activity_id ) ) {
+        return $activity_id;
+    }
 
     /**
@@ -2492 +2506 @@
  * @since 2.5.0 Add a new possible parameter $skip_notification for the array of arguments.
  *              Add the $primary_link parameter for the array of arguments.
+ * @since 2.6.0 Added 'error_type' parameter to $args.
  *
  * @param array|string $args {
@@ -2508 +2523 @@
  *     @type bool   $skip_notification Optional. false to send a comment notification, false otherwise.
  *                                     Defaults to false.
+ *     @type string $error_type        Optional. Error type. Either 'bool' or 'wp_error'. Default: 'bool'.
  * }
  * @return int|bool The ID of the comment on success, otherwise false.
  */
 function bp_activity_new_comment( $args = '' ) {
-    $bp       = buddypress();
-    $errors   = new WP_Error();
-    $feedback = __( 'There was an error posting your reply. Please try again.', 'buddypress' );
-
-    if ( empty( $bp->activity->errors ) ) {
-        $bp->activity->errors = array();
-    }
+    $bp = buddypress();
 
     $r = wp_parse_args( $args, array(
@@ -2528 +2538 @@
         'primary_link'      => '',
         'skip_notification' => false,
+        'error_type'        => 'bool'
     ) );
+
+    // Error type is boolean; need to initialize some variables for backpat.
+    if ( 'bool' === $r['error_type'] ) {
+        if ( empty( $bp->activity->errors ) ) {
+            $bp->activity->errors = array();
+        }
+    }
+
+    // Default error message.
+    $feedback = __( 'There was an error posting your reply. Please try again.', 'buddypress' );
 
     // Bail if missing necessary data.
     if ( empty( $r['content'] ) || empty( $r['user_id'] ) || empty( $r['activity_id'] ) ) {
-        $errors->add( 'missing_data', $feedback );
-        $bp->activity->errors['new_comment'] = $errors;
-
-        return false;
+        $error = new WP_Error( 'missing_data', $feedback );
+
+        if ( 'wp_error' === $r['error_type'] ) {
+            return $error;
+
+        // Backpat.
+        } else {
+            $bp->activity->errors['new_comment'] = $error;
+            return false;
+        }
     }
 
@@ -2550 +2577 @@
     // Bail if the parent activity does not exist.
     if ( empty( $activity->date_recorded ) ) {
-        $errors->add( 'missing_activity', __( 'Sorry, the item you are replying to no longer exists.', 'buddypress' ) );
-        $bp->activity->errors['new_comment'] = $errors;
-
-        return false;
+        $error = new WP_Error( 'missing_activity', __( 'The item you were replying to no longer exists.', 'buddypress' ) );
+
+        if ( 'wp_error' === $r['error_type'] ) {
+            return $error;
+
+        // Backpat.
+        } else {
+            $bp->activity->errors['new_comment'] = $error;
+            return false;
+        }
+
     }
 
@@ -2578 +2612 @@
         'item_id'           => $activity_id,
         'secondary_item_id' => $r['parent_id'],
-        'hide_sitewide'     => $is_hidden
+        'hide_sitewide'     => $is_hidden,
+        'error_type'        => $r['error_type']
     ) );
+
+    // Return WP Error.
+    if ( is_wp_error( $comment_id ) && 'wp_error' === $r['error_type'] ) {
+        return $comment_id;
+    }
 
     // Comment caches are stored only with the top-level item.
@@ -2620 +2660 @@
 
     if ( empty( $comment_id ) ) {
-        $errors->add( 'comment_failed', $feedback );
-        $bp->activity->errors['new_comment'] = $errors;
+        $error = new WP_Error( 'comment_failed', $feedback );
+
+        if ( 'wp_error' === $r['error_type'] ) {
+            return $error;
+
+        // Backpat.
+        } else {
+            $bp->activity->errors['new_comment'] = $error;
+        }
     }