Save permissions as JSON in user/group entities.

src/Entity/UserSystem/PermissionData.php

@@ -0,0 +1,116 @@
+<?php
+
+namespace App\Entity\UserSystem;
+
+final class PermissionData implements \JsonSerializable
+{
+    /**
+     * Permission values.
+     */
+    public const INHERIT = null;
+    public const ALLOW = true;
+    public const DISALLOW = false;
+
+    /**
+     * @var array This array contains the permission values for each permission
+     * This array contains the permission values for each permission, in the form of:
+     * permission => [
+     *     operation => value,
+     * ]
+     */
+    protected array $data = [];
+
+    /**
+     * Creates a new Permission Data Instance using the given data.
+     * By default, a empty array is used, meaning
+     */
+    public function __construct(array $data = [])
+    {
+        $this->data = $data;
+    }
+
+    /**
+     * Check if a permission value is set for the given permission and operation (meaning there value is not inherit).
+     * @param  string  $permission
+     * @param  string  $operation
+     * @return bool True if the permission value is set, false otherwise
+     */
+    public function isPermissionSet(string $permission, string $operation): bool
+    {
+        return isset($this->data[$permission][$operation]);
+    }
+
+    /**
+     * Returns the permission value for the given permission and operation.
+     * @param  string  $permission
+     * @param  string  $operation
+     * @return bool|null True means allow, false means disallow, null means inherit
+     */
+    public function getPermissionValue(string $permission, string $operation): ?bool
+    {
+        if ($this->isPermissionSet($permission, $operation)) {
+            return $this->data[$permission][$operation];
+        }
+
+        //If the value is not set explicitly, return null (meaning inherit)
+        return null;
+    }
+
+    /**
+     * Sets the permission value for the given permission and operation.
+     * @param  string  $permission
+     * @param  string  $operation
+     * @param  bool|null  $value
+     * @return $this
+     */
+    public function setPermissionValue(string $permission, string $operation, ?bool $value): self
+    {
+        if ($value === null) {
+            //If the value is null, unset the permission value (meaning implicit inherit)
+            unset($this->data[$permission][$operation]);
+        } else {
+            //Otherwise, set the pemission value
+            if(!isset($this->data[$permission])) {
+                $this->data[$permission] = [];
+            }
+            $this->data[$permission][$operation] = $value;
+        }
+
+        return $this;
+    }
+
+    /**
+     * Creates a new Permission Data Instance using the given JSON encoded data
+     * @param  string  $json
+     * @return static
+     * @throws \JsonException
+     */
+    public static function fromJSON(string $json): self
+    {
+        $data = json_decode($json, true, 512, JSON_THROW_ON_ERROR);
+        return new self($data);
+    }
+
+    /**
+     * Returns an JSON encodable representation of this object.
+     * @return array|mixed
+     */
+    public function jsonSerialize()
+    {
+        $ret = [];
+
+        //Filter out all empty or null values
+        foreach ($this->data as $permission => $operations) {
+            $ret[$permission] = array_filter($operations, function ($value) {
+                return $value !== null;
+            });
+
+            //If the permission has no operations, unset it
+            if (empty($ret[$permission])) {
+                unset($ret[$permission]);
+            }
+        }
+
+        return $ret;
+    }
+}