Changeset 12607

Timestamp:

03/31/2020 11:33:35 AM (5 years ago)

Author:

imath

Message:

Prepare the inclusion of the BP REST API remaining endpoints

6.0.0 is introducing 6 new BP REST API endpoints :

• Blogs, Blog avatar,
• Friends,
• Group Cover image,
• Member Cover Image and User Signups

We're also reorganizing files, making sure they are located to their belonging endpoints. As a result, 2 files are now deprecated:

• bp-core/classes/class-bp-rest-attachments-group-avatar-endpoint.php (moved into bp-groups/classes)
• bp-core/classes/class-bp-rest-attachments-member-avatar-endpoint.php (moved into bp-members/classes)

Props espellcaste, boonebgorges & I ;)

Fixes #7156

Location:

trunk

Files:

• src/bp-blogs/classes/class-bp-blogs-component.php (modified) (1 diff)
• src/bp-core/classes/class-bp-rest-attachments-group-avatar-endpoint.php (added)
• src/bp-core/classes/class-bp-rest-attachments-member-avatar-endpoint.php (added)
• src/bp-friends/classes/class-bp-friends-component.php (modified) (1 diff)
• src/bp-groups/classes/class-bp-groups-component.php (modified) (3 diffs)
• src/bp-members/classes/class-bp-members-component.php (modified) (3 diffs)
• src/class-buddypress.php (modified) (2 diffs)
• tests/phpunit/assets/bp-rest-api-controllers.php (modified) (1 diff)
• tests/phpunit/testcases/core/class-bp-component.php (modified) (3 diffs)

trunk/src/bp-blogs/classes/class-bp-blogs-component.php

@@ -357 +357 @@
         parent::setup_cache_groups();
     }
+
+    /**
+     * Init the BP REST API.
+     *
+     * @since 6.0.0
+     *
+     * @param array $controllers Optional. See BP_Component::rest_api_init() for
+     *                           description.
+     */
+    public function rest_api_init( $controllers = array() ) {
+        if ( is_multisite() ) {
+            $controllers = array(
+                'BP_REST_Blogs_Endpoint',
+            );
+
+            // Support to Blog Avatar.
+            if ( bp_is_active( 'blogs', 'site-icon' ) ) {
+                $controllers[] = 'BP_REST_Attachments_Blog_Avatar_Endpoint';
+            }
+        }
+
+        parent::rest_api_init( $controllers );
+    }
 }

trunk/src/bp-friends/classes/class-bp-friends-component.php

@@ -326 +326 @@
         parent::setup_cache_groups();
     }
+
+    /**
+     * Init the BP REST API.
+     *
+     * @since 6.0.0
+     *
+     * @param array $controllers Optional. See BP_Component::rest_api_init() for
+     *                           description.
+     */
+    public function rest_api_init( $controllers = array() ) {
+        parent::rest_api_init( array( 'BP_REST_Friends_Endpoint' ) );
+    }
 }

trunk/src/bp-groups/classes/class-bp-groups-component.php

@@ -937 +937 @@
      *
      * @since 5.0.0
+     * @since 6.0.0 Adds the Group Cover REST endpoint.
      *
      * @param array $controllers Optional. See BP_Component::rest_api_init() for
@@ -942 +943 @@
      */
     public function rest_api_init( $controllers = array() ) {
-        parent::rest_api_init( array(
+        $controllers = array(
             'BP_REST_Groups_Endpoint',
             'BP_REST_Group_Membership_Endpoint',
@@ -948 +949 @@
             'BP_REST_Group_Membership_Request_Endpoint',
             'BP_REST_Attachments_Group_Avatar_Endpoint',
-        ) );
+        );
+
+        // Support to Group Cover.
+        if ( bp_is_active( 'groups', 'cover_image' ) ) {
+            $controllers[] = 'BP_REST_Attachments_Group_Cover_Endpoint';
+        }
+
+        parent::rest_api_init( $controllers );
     }
 

trunk/src/bp-members/classes/class-bp-members-component.php

@@ -655 +655 @@
      *
      * @since 5.0.0
+     * @since 6.0.0 Adds the Member Cover and Signup REST endpoints.
      *
      * @param array $controllers Optional. See BP_Component::rest_api_init() for
@@ -660 +661 @@
      */
     public function rest_api_init( $controllers = array() ) {
-        parent::rest_api_init( array(
+        $controllers = array(
             /**
              * As the Members component is always loaded,
@@ -668 +669 @@
             'BP_REST_Members_Endpoint',
             'BP_REST_Attachments_Member_Avatar_Endpoint',
-        ) );
+        );
+
+        if ( bp_is_active( 'members', 'cover_image' ) ) {
+            $controllers[] = 'BP_REST_Attachments_Member_Cover_Endpoint';
+        }
+
+        if ( bp_get_signup_allowed() ) {
+            $controllers[] = 'BP_REST_Signup_Endpoint';
+        }
+
+        parent::rest_api_init( $controllers );
     }
 

trunk/src/class-buddypress.php

@@ -551 +551 @@
             'BP_REST_Activity_Endpoint' => 'activity',
 
-            'BP_Admin'                                   => 'core',
-            'BP_Attachment_Avatar'                       => 'core',
-            'BP_Attachment_Cover_Image'                  => 'core',
-            'BP_Attachment'                              => 'core',
-            'BP_Button'                                  => 'core',
-            'BP_Block'                                   => 'core',
-            'BP_Component'                               => 'core',
-            'BP_Customizer_Control_Range'                => 'core',
-            'BP_Date_Query'                              => 'core',
-            'BP_Email_Delivery'                          => 'core',
-            'BP_Email_Address'                           => 'core',
-            'BP_Email_Recipient'                         => 'core',
-            'BP_Email_Sender'                            => 'core',
-            'BP_Email_Participant'                       => 'core',
-            'BP_Email'                                   => 'core',
-            'BP_Embed'                                   => 'core',
-            'BP_Media_Extractor'                         => 'core',
-            'BP_Members_Suggestions'                     => 'core',
-            'BP_PHPMailer'                               => 'core',
-            'BP_Recursive_Query'                         => 'core',
-            'BP_Suggestions'                             => 'core',
-            'BP_Theme_Compat'                            => 'core',
-            'BP_User_Query'                              => 'core',
-            'BP_Walker_Category_Checklist'               => 'core',
-            'BP_Walker_Nav_Menu_Checklist'               => 'core',
-            'BP_Walker_Nav_Menu'                         => 'core',
-            'BP_Invitation_Manager'                      => 'core',
-            'BP_Invitation'                              => 'core',
-            'BP_REST_Components_Endpoint'                => 'core',
-            'BP_REST_Attachments'                        => 'core',
-            'BP_REST_Attachments_Member_Avatar_Endpoint' => 'core',
-            'BP_REST_Attachments_Group_Avatar_Endpoint'  => 'core',
-
-            'BP_Core_Friends_Widget' => 'friends',
+            'BP_REST_Blogs_Endpoint'                   => 'blogs',
+            'BP_REST_Attachments_Blog_Avatar_Endpoint' => 'blogs',
+
+            'BP_Admin'                     => 'core',
+            'BP_Attachment_Avatar'         => 'core',
+            'BP_Attachment_Cover_Image'    => 'core',
+            'BP_Attachment'                => 'core',
+            'BP_Button'                    => 'core',
+            'BP_Block'                     => 'core',
+            'BP_Component'                 => 'core',
+            'BP_Customizer_Control_Range'  => 'core',
+            'BP_Date_Query'                => 'core',
+            'BP_Email_Delivery'            => 'core',
+            'BP_Email_Address'             => 'core',
+            'BP_Email_Recipient'           => 'core',
+            'BP_Email_Sender'              => 'core',
+            'BP_Email_Participant'         => 'core',
+            'BP_Email'                     => 'core',
+            'BP_Embed'                     => 'core',
+            'BP_Media_Extractor'           => 'core',
+            'BP_Members_Suggestions'       => 'core',
+            'BP_PHPMailer'                 => 'core',
+            'BP_Recursive_Query'           => 'core',
+            'BP_Suggestions'               => 'core',
+            'BP_Theme_Compat'              => 'core',
+            'BP_User_Query'                => 'core',
+            'BP_Walker_Category_Checklist' => 'core',
+            'BP_Walker_Nav_Menu_Checklist' => 'core',
+            'BP_Walker_Nav_Menu'           => 'core',
+            'BP_Invitation_Manager'        => 'core',
+            'BP_Invitation'                => 'core',
+            'BP_REST_Components_Endpoint'  => 'core',
+            'BP_REST_Attachments'          => 'core',
+
+            'BP_Core_Friends_Widget'   => 'friends',
+            'BP_REST_Friends_Endpoint' => 'friends',
 
             'BP_Group_Extension'                        => 'groups',
@@ -592 +594 @@
             'BP_REST_Group_Invites_Endpoint'            => 'groups',
             'BP_REST_Group_Membership_Request_Endpoint' => 'groups',
-
-            'BP_Core_Members_Template'       => 'members',
-            'BP_Core_Members_Widget'         => 'members',
-            'BP_Core_Recently_Active_Widget' => 'members',
-            'BP_Core_Whos_Online_Widget'     => 'members',
-            'BP_Registration_Theme_Compat'   => 'members',
-            'BP_Signup'                      => 'members',
-            'BP_REST_Members_Endpoint'       => 'members',
+            'BP_REST_Attachments_Group_Avatar_Endpoint' => 'groups',
+            'BP_REST_Attachments_Group_Cover_Endpoint'  => 'groups',
+
+            'BP_Core_Members_Template'                   => 'members',
+            'BP_Core_Members_Widget'                     => 'members',
+            'BP_Core_Recently_Active_Widget'             => 'members',
+            'BP_Core_Whos_Online_Widget'                 => 'members',
+            'BP_Registration_Theme_Compat'               => 'members',
+            'BP_Signup'                                  => 'members',
+            'BP_REST_Members_Endpoint'                   => 'members',
+            'BP_REST_Attachments_Member_Avatar_Endpoint' => 'members',
+            'BP_REST_Attachments_Member_Cover_Endpoint'  => 'members',
+            'BP_REST_Signup_Endpoint'                    => 'members',
 
             'BP_REST_Messages_Endpoint' => 'messages',

trunk/tests/phpunit/assets/bp-rest-api-controllers.php

@@ -9 +9 @@
     public function register_routes( $controller = '' ) {
         array_push( buddypress()->unit_test_rest->controllers, $controller );
+    }
+}
+
+/**
+ * BP Member Cover Image REST Controller's mock.
+ */
+class BP_REST_Attachments_Member_Cover_Endpoint extends BP_REST_Mock_Class {
+    public function __construct() {
+        $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
+        $this->rest_base = 'members';
+    }
+
+    public function register_routes( $controller = '' ) {
+        parent::register_routes( 'BP_REST_Attachments_Member_Cover_Endpoint' );
     }
 }

trunk/tests/phpunit/testcases/core/class-bp-component.php

@@ -34 +34 @@
             'BP_REST_Members_Endpoint',
             'BP_REST_Attachments_Member_Avatar_Endpoint',
+            'BP_REST_Attachments_Member_Cover_Endpoint',
         ) );
     }
@@ -50 +51 @@
             'BP_REST_Components_Endpoint',
             'BP_REST_Attachments_Member_Avatar_Endpoint',
+            'BP_REST_Attachments_Member_Cover_Endpoint',
         ) );
     }
@@ -67 +69 @@
             'BP_REST_Members_Endpoint',
             'BP_REST_Attachments_Member_Avatar_Endpoint',
+            'BP_REST_Attachments_Member_Cover_Endpoint',
         ) );
     }