refactor: update campaign REST API structure by extending the WP REST controller and keeping a consistent naming convention

Author: Jon Waldstein

src/API/REST/V3/Routes/Campaigns/GetCampaignComments.php renamed to src/API/REST/V3/Routes/Campaigns/CampaignCommentsController.php

@@ -4,48 +4,59 @@
 
 use Exception;
 use Give\API\REST\V3\Routes\Campaigns\ValueObjects\CampaignRoute;
-use Give\API\RestRoute;
 use Give\Campaigns\CampaignDonationQuery;
 use Give\Campaigns\Models\Campaign;
 use Give\Donations\ValueObjects\DonationMetaKeys;
+use WP_REST_Controller;
+use WP_REST_Request;
 use WP_REST_Response;
 use WP_REST_Server;
 
-class GetCampaignComments implements RestRoute
+class CampaignCommentsController extends WP_REST_Controller
 {
+    /**
+     * @var string
+     */
+    protected $namespace;
+
+    public function __construct()
+    {
+        $this->namespace = CampaignRoute::NAMESPACE;
+    }
+
     /**
      * @since 4.13.0 add schema
      * @since 4.0.0
      */
-    public function registerRoute()
+    public function register_routes()
     {
         register_rest_route(
-            CampaignRoute::NAMESPACE,
-            CampaignRoute::CAMPAIGN . '/comments',
+            $this->namespace,
+            '/' . CampaignRoute::CAMPAIGN . '/comments',
             [
                 [
                     'methods' => WP_REST_Server::READABLE,
-                    'callback' => [$this, 'handleRequest'],
+                    'callback' => [$this, 'get_items'],
                     'permission_callback' => '__return_true',
-                ],
-                'args' => [
-                    'id' => [
-                        'type' => 'integer',
-                        'required' => true,
-                        'sanitize_callback' => 'absint',
-                    ],
-                    'perPage' => [
-                        'type' => 'integer',
-                        'required' => false,
-                        'sanitize_callback' => 'absint',
-                    ],
-                    'anonymous' => [
-                        'type' => 'boolean',
-                        'required' => false,
-                        'default'  => true,
+                    'args' => [
+                        'id' => [
+                            'type' => 'integer',
+                            'required' => true,
+                            'sanitize_callback' => 'absint',
+                        ],
+                        'perPage' => [
+                            'type' => 'integer',
+                            'required' => false,
+                            'sanitize_callback' => 'absint',
+                        ],
+                        'anonymous' => [
+                            'type' => 'boolean',
+                            'required' => false,
+                            'default'  => true,
+                        ],
                     ],
                 ],
-                'schema' => [$this, 'getSchema'],
+                'schema' => [$this, 'get_public_item_schema'],
             ]
         );
     }
@@ -55,15 +66,15 @@ public function registerRoute()
      *
      * @throws Exception
      */
-    public function handleRequest($request): WP_REST_Response
+    public function get_items($request): WP_REST_Response
     {
         $campaignId = $request->get_param('id');
         $perPage = $request->get_param('perPage');
         $anonymous = $request->get_param('anonymous');
 
         $campaign = Campaign::find($campaignId);
 
-        if ( ! $campaign) {
+        if (!$campaign) {
             return new WP_REST_Response('Campaign not found', 404);
         }
 
@@ -73,8 +84,7 @@ public function handleRequest($request): WP_REST_Response
             ->joinDonationMeta(DonationMetaKeys::ANONYMOUS, 'anonymousMeta')
             ->leftJoin('give_donors', 'donorIdMeta.meta_value', 'donors.id', 'donors');
 
-
-        if ( ! $anonymous) {
+        if (!$anonymous) {
             $query->where('anonymousMeta.meta_value', '1', '!=');
         }
 
@@ -86,20 +96,22 @@ public function handleRequest($request): WP_REST_Response
             'commentMeta.meta_value as comment',
             'anonymousMeta.meta_value as anonymous',
             'donation.post_date as date',
-            'donors.name as donorName'
+            'donors.name as donorName',
+            'donors.email as email'
         );
 
         $donations = $query->limit($perPage)->getAll();
 
         $formattedComments = array_map(function ($donation) {
             $donorName = $donation->anonymous === '1' ? __('Anonymous') : $donation->donorName;
+            $avatarEmail = $donation->anonymous === '1' ? '' : ($donation->email ?? '');
 
             return [
                 'donorName' => $donorName,
                 'comment' => $donation->comment,
                 'anonymous' => $donation->anonymous === '1',
                 'date' => human_time_diff(strtotime($donation->date)),
-                'avatar' => (string)get_avatar_url($donation->email),
+                'avatar' => (string) get_avatar_url($avatarEmail),
             ];
         }, $donations);
 
@@ -109,9 +121,10 @@ public function handleRequest($request): WP_REST_Response
     /**
      * @since 4.13.0
      */
-    public function getSchema(): array
+    public function get_item_schema(): array
     {
         return [
+            '$schema' => 'http://json-schema.org/draft-04/schema#',
             'title' => 'givewp/campaign-comments',
             'description' => esc_html__('Provides comments for a specific campaign.', 'give'),
             'type' => 'object',
@@ -128,8 +141,8 @@ public function getSchema(): array
                 'anonymous' => [
                     'type' => 'boolean',
                     'description' => esc_html__('Include anonymous comments', 'give'),
-                ]
-            ]
+                ],
+            ],
         ];
     }
 }