From b1be45f365df3aaa404b184b76bbe622517513fc Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Thu, 17 Mar 2022 23:01:29 +0100 Subject: [PATCH] changed badly named permission type to permission category because type should only be read/write/... --- Admin/Install/db.json | 8 +-- Admin/Routes/Web/Api.php | 62 +++++++++---------- Admin/Routes/Web/Backend.php | 24 +++---- Controller/ApiController.php | 4 +- Models/AccountPermission.php | 6 +- Models/AccountPermissionMapper.php | 2 +- Models/GroupPermission.php | 6 +- Models/GroupPermissionMapper.php | 2 +- ...issionState.php => PermissionCategory.php} | 2 +- Models/PermissionQueryBuilder.php | 14 ++--- 10 files changed, 65 insertions(+), 65 deletions(-) rename Models/{PermissionState.php => PermissionCategory.php} (94%) diff --git a/Admin/Install/db.json b/Admin/Install/db.json index b45683f..9c79b23 100755 --- a/Admin/Install/db.json +++ b/Admin/Install/db.json @@ -615,8 +615,8 @@ "default": null, "null": true }, - "group_permission_type": { - "name": "group_permission_type", + "group_permission_category": { + "name": "group_permission_category", "type": "INT", "default": null, "null": true @@ -863,8 +863,8 @@ "default": null, "null": true }, - "account_permission_type": { - "name": "account_permission_type", + "account_permission_category": { + "name": "account_permission_category", "type": "INT", "default": null, "null": true diff --git a/Admin/Routes/Web/Api.php b/Admin/Routes/Web/Api.php index 5d573d7..2ac6250 100755 --- a/Admin/Routes/Web/Api.php +++ b/Admin/Routes/Web/Api.php @@ -13,7 +13,7 @@ declare(strict_types=1); use Modules\Admin\Controller\ApiController; -use Modules\Admin\Models\PermissionState; +use Modules\Admin\Models\PermissionCategory; use phpOMS\Account\PermissionType; use phpOMS\Router\RouteVerb; @@ -60,7 +60,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::MODIFY, - 'state' => PermissionState::SETTINGS, + 'state' => PermissionCategory::SETTINGS, ], ], [ @@ -69,7 +69,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::READ, - 'state' => PermissionState::SETTINGS, + 'state' => PermissionCategory::SETTINGS, ], ], ], @@ -81,7 +81,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::MODIFY, - 'state' => PermissionState::SETTINGS, + 'state' => PermissionCategory::SETTINGS, ], ], ], @@ -93,7 +93,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::CREATE, - 'state' => PermissionState::GROUP, + 'state' => PermissionCategory::GROUP, ], ], [ @@ -102,7 +102,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::MODIFY, - 'state' => PermissionState::GROUP, + 'state' => PermissionCategory::GROUP, ], ], [ @@ -111,7 +111,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::DELETE, - 'state' => PermissionState::GROUP, + 'state' => PermissionCategory::GROUP, ], ], [ @@ -120,7 +120,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::READ, - 'state' => PermissionState::GROUP, + 'state' => PermissionCategory::GROUP, ], ], ], @@ -132,7 +132,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::READ, - 'state' => PermissionState::SEARCH, + 'state' => PermissionCategory::SEARCH, ], ], ], @@ -143,7 +143,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::READ, - 'state' => PermissionState::SEARCH, + 'state' => PermissionCategory::SEARCH, ], ], ], @@ -154,7 +154,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::READ, - 'state' => PermissionState::SEARCH, + 'state' => PermissionCategory::SEARCH, ], ], ], @@ -166,7 +166,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::CREATE, - 'state' => PermissionState::ACCOUNT, + 'state' => PermissionCategory::ACCOUNT, ], ], [ @@ -175,7 +175,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::MODIFY, - 'state' => PermissionState::ACCOUNT, + 'state' => PermissionCategory::ACCOUNT, ], ], [ @@ -184,7 +184,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::DELETE, - 'state' => PermissionState::ACCOUNT, + 'state' => PermissionCategory::ACCOUNT, ], ], [ @@ -193,7 +193,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::READ, - 'state' => PermissionState::ACCOUNT, + 'state' => PermissionCategory::ACCOUNT, ], ], ], @@ -204,7 +204,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::MODIFY, - 'state' => PermissionState::ACCOUNT_SETTINGS, + 'state' => PermissionCategory::ACCOUNT_SETTINGS, ], ], ], @@ -216,7 +216,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::MODIFY, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], ], @@ -228,7 +228,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::MODIFY, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], ], @@ -239,7 +239,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::MODIFY, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], ], @@ -251,7 +251,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::PERMISSION, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], [ @@ -260,7 +260,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::PERMISSION, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], [ @@ -269,7 +269,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::PERMISSION, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], [ @@ -278,7 +278,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::PERMISSION, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], ], @@ -289,7 +289,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::PERMISSION, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], [ @@ -298,7 +298,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::PERMISSION, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], [ @@ -307,7 +307,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::PERMISSION, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], [ @@ -316,7 +316,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::PERMISSION, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], ], @@ -327,7 +327,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::CREATE, - 'state' => PermissionState::ROUTE, + 'state' => PermissionCategory::ROUTE, ], ], ], @@ -339,7 +339,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::CREATE, - 'state' => PermissionState::APP, + 'state' => PermissionCategory::APP, ], ], ], @@ -350,7 +350,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::CREATE, - 'state' => PermissionState::APP, + 'state' => PermissionCategory::APP, ], ], ], @@ -361,7 +361,7 @@ return [ 'permission' => [ 'module' => ApiController::NAME, 'type' => PermissionType::CREATE, - 'state' => PermissionState::APP, + 'state' => PermissionCategory::APP, ], ], ], diff --git a/Admin/Routes/Web/Backend.php b/Admin/Routes/Web/Backend.php index 7c577ab..9cc34bf 100755 --- a/Admin/Routes/Web/Backend.php +++ b/Admin/Routes/Web/Backend.php @@ -13,7 +13,7 @@ declare(strict_types=1); use Modules\Admin\Controller\BackendController; -use Modules\Admin\Models\PermissionState; +use Modules\Admin\Models\PermissionCategory; use phpOMS\Account\PermissionType; use phpOMS\Router\RouteVerb; @@ -34,7 +34,7 @@ return [ 'permission' => [ 'module' => BackendController::NAME, 'type' => PermissionType::READ, - 'state' => \Modules\Admin\Models\PermissionState::MODULE, + 'state' => \Modules\Admin\Models\PermissionCategory::MODULE, ], ], ], @@ -46,7 +46,7 @@ return [ 'permission' => [ 'module' => BackendController::NAME, 'type' => PermissionType::READ, - 'state' => PermissionState::ACCOUNT, + 'state' => PermissionCategory::ACCOUNT, ], ], ], @@ -57,7 +57,7 @@ return [ 'permission' => [ 'module' => BackendController::NAME, 'type' => PermissionType::READ, - 'state' => PermissionState::ACCOUNT, + 'state' => PermissionCategory::ACCOUNT, ], ], ], @@ -68,7 +68,7 @@ return [ 'permission' => [ 'module' => BackendController::NAME, 'type' => PermissionType::CREATE, - 'state' => PermissionState::ACCOUNT, + 'state' => PermissionCategory::ACCOUNT, ], ], ], @@ -79,7 +79,7 @@ return [ 'permission' => [ 'module' => BackendController::NAME, 'type' => PermissionType::READ, - 'state' => PermissionState::GROUP, + 'state' => PermissionCategory::GROUP, ], ], ], @@ -90,7 +90,7 @@ return [ 'permission' => [ 'module' => BackendController::NAME, 'type' => PermissionType::MODIFY, - 'state' => PermissionState::GROUP, + 'state' => PermissionCategory::GROUP, ], ], ], @@ -101,7 +101,7 @@ return [ 'permission' => [ 'module' => BackendController::NAME, 'type' => PermissionType::CREATE, - 'state' => PermissionState::GROUP, + 'state' => PermissionCategory::GROUP, ], ], ], @@ -112,7 +112,7 @@ return [ 'permission' => [ 'module' => BackendController::NAME, 'type' => PermissionType::READ, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], ], @@ -123,7 +123,7 @@ return [ 'permission' => [ 'module' => BackendController::NAME, 'type' => PermissionType::READ, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], ], @@ -134,7 +134,7 @@ return [ 'permission' => [ 'module' => BackendController::NAME, 'type' => PermissionType::READ, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], ], @@ -145,7 +145,7 @@ return [ 'permission' => [ 'module' => BackendController::NAME, 'type' => PermissionType::READ, - 'state' => PermissionState::MODULE, + 'state' => PermissionCategory::MODULE, ], ], ], diff --git a/Controller/ApiController.php b/Controller/ApiController.php index e7ba4d2..73c31e2 100755 --- a/Controller/ApiController.php +++ b/Controller/ApiController.php @@ -28,7 +28,7 @@ use Modules\Admin\Models\Module; use Modules\Admin\Models\ModuleMapper; use Modules\Admin\Models\ModuleStatusUpdateType; use Modules\Admin\Models\NullAccount; -use Modules\Admin\Models\PermissionState; +use Modules\Admin\Models\PermissionCategory; use Modules\Media\Models\Collection; use Modules\Media\Models\CollectionMapper; use Modules\Media\Models\UploadFile; @@ -483,7 +483,7 @@ final class ApiController extends Controller $this->app->orgId, $this->app->appName, self::NAME, - PermissionState::ACCOUNT_SETTINGS, + PermissionCategory::ACCOUNT_SETTINGS, $accountId ) ) { diff --git a/Models/AccountPermission.php b/Models/AccountPermission.php index 1116d3e..1eee494 100755 --- a/Models/AccountPermission.php +++ b/Models/AccountPermission.php @@ -45,7 +45,7 @@ class AccountPermission extends PermissionAbstract * @param null|string $app App App to check (null if all are acceptable) * @param null|string $module Module to check (null if all are acceptable) * @param null|string $from Module providing this permission - * @param null|int $type Type (e.g. customer) (null if all are acceptable) + * @param null|int $category Category (e.g. customer) (null if all are acceptable) * @param null|int $element (e.g. customer id) (null if all are acceptable) * @param null|int $component (e.g. address) (null if all are acceptable) * @param int $permission Permission to check @@ -58,13 +58,13 @@ class AccountPermission extends PermissionAbstract string $app = null, string $module = null, string $from = null, - int $type = null, + int $category = null, int $element = null, int $component = null, int $permission = PermissionType::NONE ) { $this->account = $account; - parent::__construct($unit, $app, $module, $from, $type, $element, $component, $permission); + parent::__construct($unit, $app, $module, $from, $category, $element, $component, $permission); } /** diff --git a/Models/AccountPermissionMapper.php b/Models/AccountPermissionMapper.php index 2080478..51b187e 100755 --- a/Models/AccountPermissionMapper.php +++ b/Models/AccountPermissionMapper.php @@ -39,7 +39,7 @@ final class AccountPermissionMapper extends DataMapperFactory 'account_permission_app' => ['name' => 'account_permission_app', 'type' => 'string', 'internal' => 'app'], 'account_permission_module' => ['name' => 'account_permission_module', 'type' => 'string', 'internal' => 'module'], 'account_permission_from' => ['name' => 'account_permission_from', 'type' => 'string', 'internal' => 'from'], - 'account_permission_type' => ['name' => 'account_permission_type', 'type' => 'int', 'internal' => 'type'], + 'account_permission_category' => ['name' => 'account_permission_category', 'type' => 'int', 'internal' => 'category'], 'account_permission_element' => ['name' => 'account_permission_element', 'type' => 'int', 'internal' => 'element'], 'account_permission_component' => ['name' => 'account_permission_component', 'type' => 'int', 'internal' => 'component'], 'account_permission_hasread' => ['name' => 'account_permission_hasread', 'type' => 'bool', 'internal' => 'hasRead'], diff --git a/Models/GroupPermission.php b/Models/GroupPermission.php index cc4d9d7..7f77b76 100755 --- a/Models/GroupPermission.php +++ b/Models/GroupPermission.php @@ -45,7 +45,7 @@ class GroupPermission extends PermissionAbstract * @param null|string $app App App to check (null if all are acceptable) * @param null|string $module Module to check (null if all are acceptable) * @param null|string $from Module providing this permission - * @param null|int $type Type (e.g. customer) (null if all are acceptable) + * @param null|int $category Category (e.g. customer) (null if all are acceptable) * @param null|int $element (e.g. customer id) (null if all are acceptable) * @param null|int $component (e.g. address) (null if all are acceptable) * @param int $permission Permission to check @@ -58,13 +58,13 @@ class GroupPermission extends PermissionAbstract string $app = null, string $module = null, string $from = null, - int $type = null, + int $category = null, int $element = null, int $component = null, int $permission = PermissionType::NONE ) { $this->group = $group; - parent::__construct($unit, $app, $module, $from, $type, $element, $component, $permission); + parent::__construct($unit, $app, $module, $from, $category, $element, $component, $permission); } /** diff --git a/Models/GroupPermissionMapper.php b/Models/GroupPermissionMapper.php index 5e45e6e..be80b1f 100755 --- a/Models/GroupPermissionMapper.php +++ b/Models/GroupPermissionMapper.php @@ -39,7 +39,7 @@ final class GroupPermissionMapper extends DataMapperFactory 'group_permission_app' => ['name' => 'group_permission_app', 'type' => 'string', 'internal' => 'app'], 'group_permission_module' => ['name' => 'group_permission_module', 'type' => 'string', 'internal' => 'module'], 'group_permission_from' => ['name' => 'group_permission_from', 'type' => 'string', 'internal' => 'from'], - 'group_permission_type' => ['name' => 'group_permission_type', 'type' => 'int', 'internal' => 'type'], + 'group_permission_category' => ['name' => 'group_permission_category', 'type' => 'int', 'internal' => 'category'], 'group_permission_element' => ['name' => 'group_permission_element', 'type' => 'int', 'internal' => 'element'], 'group_permission_component' => ['name' => 'group_permission_component', 'type' => 'int', 'internal' => 'component'], 'group_permission_hasread' => ['name' => 'group_permission_hasread', 'type' => 'bool', 'internal' => 'hasRead'], diff --git a/Models/PermissionState.php b/Models/PermissionCategory.php similarity index 94% rename from Models/PermissionState.php rename to Models/PermissionCategory.php index 5f9ce09..a3f938d 100755 --- a/Models/PermissionState.php +++ b/Models/PermissionCategory.php @@ -24,7 +24,7 @@ use phpOMS\Stdlib\Base\Enum; * @link https://karaka.app * @since 1.0.0 */ -abstract class PermissionState extends Enum +abstract class PermissionCategory extends Enum { public const SETTINGS = 1; diff --git a/Models/PermissionQueryBuilder.php b/Models/PermissionQueryBuilder.php index a8a3abf..ec35c3b 100644 --- a/Models/PermissionQueryBuilder.php +++ b/Models/PermissionQueryBuilder.php @@ -40,7 +40,7 @@ final class PermissionQueryBuilder private array $modules = [null]; - private array $types = [null]; + private array $categories = [null]; private int $permission = 0; @@ -78,9 +78,9 @@ final class PermissionQueryBuilder return $this; } - public function types(array $types) : self + public function categories(array $categories) : self { - $this->types = $types; + $this->categories = $categories; return $this; } @@ -132,8 +132,8 @@ final class PermissionQueryBuilder $accountPermission->where($subWhere); $subWhere = new Where($this->connection); - foreach ($this->types as $type) { - $subWhere->orWhere('account_permission_type', '=', $type); + foreach ($this->categories as $category) { + $subWhere->orWhere('account_permission_category', '=', $category); } $accountPermission->where($subWhere); @@ -171,8 +171,8 @@ final class PermissionQueryBuilder $groupPermission->where($subWhere); $subWhere = new Where($this->connection); - foreach ($this->types as $type) { - $subWhere->orWhere('group_permission_type', '=', $type); + foreach ($this->categories as $category) { + $subWhere->orWhere('group_permission_category', '=', $category); } $groupPermission->where($subWhere);