Changeset 10858 for trunk/src/bp-activity/classes/class-bp-activity-activity.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/classes/class-bp-activity-activity.php (modified) (3 diffs)

trunk/src/bp-activity/classes/class-bp-activity-activity.php

@@ -135 +135 @@
 
     /**
+     * Error holder.
+     *
+     * @since 2.6.0
+     *
+     * @var WP_Error
+     */
+    public $errors;
+
+    /**
+     * Error type to return. Either 'bool' or 'wp_error'.
+     *
+     * @since 2.6.0
+     *
+     * @var string
+     */
+    public $error_type = 'bool';
+
+    /**
      * Constructor method.
      *
@@ -142 +160 @@
      */
     public function __construct( $id = false ) {
+        // Instantiate errors object.
+        $this->errors = new WP_Error;
+
         if ( !empty( $id ) ) {
             $this->id = (int) $id;
@@ -236 +257 @@
         do_action_ref_array( 'bp_activity_before_save', array( &$this ) );
 
+        if ( 'wp_error' === $this->error_type && $this->errors->get_error_code() ) {
+            return $this->errors;
+        }
+
         if ( empty( $this->component ) || empty( $this->type ) ) {
-            return false;
+            if ( 'bool' === $this->error_type ) {
+                return false;
+            } else {
+                if ( empty( $this->component ) ) {
+                    $this->errors->add( 'bp_activity_missing_component' );
+                } else {
+                    $this->errors->add( 'bp_activity_missing_type' );
+                }
+
+                return $this->errors;
+            }
         }