Changeset 12428

Timestamp:

08/12/2019 08:42:30 PM (5 years ago)

Author:

dcavins

Message:

Introduce BP_Invitation and BP_Invitation_Manager.

• Add BP_Invitation, a new class describing generic invitation objects with methods for adding, updating and deleting invitations and membership requests.
• Add a creation routine for the new table that will contain invitations data.
• Add BP_Invitation_Manager, a new class that offers helper functions for managing BP_Invitation objects. For most use cases, this class will be extended for new invitation types, like group invitations.
• Add unit tests for the new classes.

See #6210.

Location:

trunk

Files:

• src/bp-core/admin/bp-core-admin-schema.php (modified) (1 diff)
• src/bp-core/bp-core-cache.php (modified) (1 diff)
• src/bp-core/bp-core-update.php (modified) (3 diffs)
• src/bp-core/classes/class-bp-invitation-manager.php (added)
• src/bp-core/classes/class-bp-invitation.php (added)
• src/class-buddypress.php (modified) (1 diff)
• tests/phpunit/assets/invitations-extensions.php (added)
• tests/phpunit/testcases/core/invitations.php (added)

trunk/src/bp-core/admin/bp-core-admin-schema.php

@@ -541 +541 @@
     do_action( 'bp_core_install_emails' );
 }
+
+/**
+ * Install database tables for the Invitations API
+ *
+ * @since 5.0.0
+ *
+ * @uses bp_core_set_charset()
+ * @uses bp_core_get_table_prefix()
+ * @uses dbDelta()
+ */
+function bp_core_install_invitations() {
+    $sql             = array();
+    $charset_collate = $GLOBALS['wpdb']->get_charset_collate();
+    $bp_prefix       = bp_core_get_table_prefix();
+    $sql[] = "CREATE TABLE {$bp_prefix}bp_invitations (
+        id bigint(20) NOT NULL AUTO_INCREMENT PRIMARY KEY,
+        user_id bigint(20) NOT NULL,
+        inviter_id bigint(20) NOT NULL,
+        invitee_email varchar(100) DEFAULT NULL,
+        class varchar(120) NOT NULL,
+        item_id bigint(20) NOT NULL,
+        secondary_item_id bigint(20) DEFAULT NULL,
+        type varchar(12) NOT NULL DEFAULT 'invite',
+        content longtext DEFAULT '',
+        date_modified datetime NOT NULL,
+        invite_sent tinyint(1) NOT NULL DEFAULT '0',
+        accepted tinyint(1) NOT NULL DEFAULT '0',
+        KEY user_id (user_id),
+        KEY inviter_id (inviter_id),
+        KEY invitee_email (invitee_email),
+        KEY class (class),
+        KEY item_id (item_id),
+        KEY secondary_item_id (secondary_item_id),
+        KEY type (type),
+        KEY invite_sent (invite_sent),
+        KEY accepted (accepted)
+        ) {$charset_collate};";
+    dbDelta( $sql );
+
+    /**
+     * Fires after BuddyPress adds the invitations table.
+     *
+     * @since 5.0.0
+     */
+    do_action( 'bp_core_install_invitations' );
+}

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

@@ -380 +380 @@
     return wp_cache_delete( 'incrementor', $group );
 }
+
+/**
+ * Resets all incremented bp_invitations caches.
+ *
+ * @since 5.0.0
+ */
+function bp_invitations_reset_cache_incrementor() {
+    bp_core_reset_incrementor( 'bp_invitations' );
+}
+add_action( 'bp_invitation_after_save', 'bp_invitations_reset_cache_incrementor' );
+add_action( 'bp_invitation_after_delete', 'bp_invitations_reset_cache_incrementor' );

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

@@ -212 +212 @@
         bp_core_add_page_mappings( $default_components, 'delete' );
         bp_core_install_emails();
+        bp_core_install_invitations();
 
     // Upgrades.
@@ -552 +553 @@
  *
  * - Make sure the custom visibility is disabled for the default profile field.
+ * - Create the invitations table.
  *
  * @since 5.0.0
@@ -580 +582 @@
         )
     );
+
+    bp_core_install_invitations();
 }
 

trunk/src/class-buddypress.php

@@ -573 +573 @@
             'BP_Walker_Nav_Menu_Checklist' => 'core',
             'BP_Walker_Nav_Menu'           => 'core',
+            'BP_Invitation_Manager'        => 'core',
+            'BP_Invitation'                => 'core',
 
             'BP_Core_Friends_Widget' => 'friends',