Changeset 12915

Timestamp:

04/28/2021 11:49:50 PM (6 months ago)

Author:

dcavins

Message:

BP_Invitation_Manager: Functionality improvements.

Introduce convenience methods delete_by_id() and
get_invitations_total_count(). Also add support for
id as a parameter in accept_invitation().

File:

• trunk/src/bp-core/classes/class-bp-invitation-manager.php (modified) (4 diffs)

trunk/src/bp-core/classes/class-bp-invitation-manager.php

@@ -389 +389 @@
 
     /**
+     * Get a count of the number of invitations that match provided filter parameters.
+     *
+     * @since 8.0.0
+     *
+     * @see BP_Invitation::get_total_count() for a description of accepted parameters.
+     *
+     * @return int Total number of invitations.
+     */
+    public function get_invitations_total_count( $args = array() ) {
+        // Default to returning invitations, not requests.
+        if ( empty( $args['type'] ) ) {
+            $args['type'] = 'invite';
+        }
+        // Use the class_name property value.
+        $args['class'] = $this->class_name;
+
+        return BP_Invitation::get_total_count( $args );
+    }
+
+    /**
      * Get requests, based on provided filter parameters.
      *
@@ -480 +500 @@
 
         $r = bp_parse_args( $args, array(
+            'id'                => false,
             'user_id'           => 0,
             'invitee_email'     => '',
@@ -489 +510 @@
         $r['class'] = $this->class_name;
 
-        if ( ! ( ( $r['user_id'] || $r['invitee_email'] ) && $r['class'] && $r['item_id'] ) ) {
+        if ( ! $r['id'] && ! ( ( $r['user_id'] || $r['invitee_email'] ) && $r['class'] && $r['item_id'] ) ) {
             return false;
         }
@@ -709 +730 @@
 
     /**
+     * Delete an invitation by id.
+     *
+     * @since 8.0.0
+     *
+     * @param int $id ID of the invitation to delete.
+     * @return int|bool Number of rows deleted on success, false on failure.
+     */
+    public function delete_by_id( $id ) {
+        // Ensure that the invitation exists and was created by this class.
+        $invite = new BP_Invitation( $id );
+        if ( ! $invite->id || sanitize_key( $this->class_name ) !== $invite->class ) {
+            return false;
+        }
+
+        return BP_Invitation::delete_by_id( $id );
+    }
+
+    /**
      * This is where custom actions are added (in child classes)
      * to determine whether an invitation should be allowed.