Add groups endpoint

Author: AshCorr

Api/Controller/Groups.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace YogstationPermissions\Api\Controller;
+
+use XF\Api\Controller\AbstractController;
+use XF\Mvc\ParameterBag;
+
+/**
+ * @api-group Groups
+ */
+
+class Groups extends AbstractController
+{
+    /**
+	 * @api-desc Get list of user groups sorted by display rank.
+	 *
+	 *
+	 * @api-out str $key the linking key generated.
+     * @api-out str $url the url the end user needs to access to link.
+	 */
+    public function actionGet(ParameterBag $params)
+	{
+        $this->assertSuperUserKey();
+
+        $groups = $this->finder('XF:UserGroup')->order('display_style_priority')->fetch();
+
+        return $this->apiSuccess([
+            'groups' => $groups
+		]);
+    }
+
+}

XF/Entity/UserGroup.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace YogstationPermissions\XF\Entity;
+
+class UserGroup extends XFCP_UserGroup {
+    protected function setupApiResultData(
+		\XF\Api\Result\EntityResult $result, $verbosity = self::VERBOSITY_NORMAL, array $options = [])
+    {
+        $result->title = $this->title;
+        $result->display_priority = $this->display_style_priority;
+    }
+}

_output/class_extensions/XF-Entity-UserGroup_YogstationPermissions-XF-Entity-UserGroup.json

@@ -0,0 +1,6 @@
+{
+    "from_class": "XF\\Entity\\UserGroup",
+    "to_class": "YogstationPermissions\\XF\\Entity\\UserGroup",
+    "execute_order": 10,
+    "active": true
+}

_output/class_extensions/_metadata.json

@@ -1,4 +1,7 @@
 {
+    "XF-Entity-UserGroup_YogstationPermissions-XF-Entity-UserGroup.json": {
+        "hash": "68f5eff9b6a0fe9735f6633c26aad323"
+    },
     "XF-Entity-User_YogstationPermissions-XF-Entity-User.json": {
         "hash": "2c81c2cf6835563462e9b5630856842a"
     }

_output/extension_hint.php

@@ -6,4 +6,5 @@
 namespace YogstationPermissions\XF\Entity
 {
 	class XFCP_User extends \XF\Entity\User {}
+	class XFCP_UserGroup extends \XF\Entity\UserGroup {}
 }

_output/routes/_metadata.json

@@ -1,4 +1,7 @@
 {
+    "api_groups_.json": {
+        "hash": "cd3636cd893aa6db95981fb5f4cc3548"
+    },
     "api_linking_.json": {
         "hash": "8746785f7f0cde8a03be2abafa5d6751"
     },

_output/routes/api_groups_.json

@@ -0,0 +1,11 @@
+{
+    "route_type": "api",
+    "route_prefix": "groups",
+    "sub_name": "",
+    "format": "",
+    "build_class": "",
+    "build_method": "",
+    "controller": "YogstationPermissions:Groups",
+    "context": "",
+    "action_prefix": ""
+}

addon.json

@@ -2,8 +2,8 @@
     "legacy_addon_id": "",
     "title": "Yogstation Permissions",
     "description": "",
-    "version_id": 20201010,
-    "version_string": "20201010",
+    "version_id": 20201130,
+    "version_string": "20201130",
     "dev": "",
     "dev_url": "",
     "faq_url": "",