mirror of
https://github.com/Karaka-Management/phpOMS.git
synced 2026-01-11 09:48:40 +00:00
538 lines
12 KiB
PHP
Executable File
538 lines
12 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* Karaka
|
|
*
|
|
* PHP Version 8.1
|
|
*
|
|
* @package phpOMS\Account
|
|
* @copyright Dennis Eichhorn
|
|
* @license OMS License 2.0
|
|
* @version 1.0.0
|
|
* @link https://jingga.app
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace phpOMS\Account;
|
|
|
|
/**
|
|
* Permission class.
|
|
*
|
|
* This permission abstract is the basis for all permissions. Contrary to it's name it is not an
|
|
* abstract class and can be used directly if needed.
|
|
*
|
|
* @package phpOMS\Account
|
|
* @license OMS License 2.0
|
|
* @link https://jingga.app
|
|
* @since 1.0.0
|
|
*/
|
|
class PermissionAbstract implements \JsonSerializable
|
|
{
|
|
/**
|
|
* Permission id.
|
|
*
|
|
* @var int
|
|
* @since 1.0.0
|
|
*/
|
|
protected int $id = 0;
|
|
|
|
/**
|
|
* Unit id.
|
|
*
|
|
* @var null|int
|
|
* @since 1.0.0
|
|
*/
|
|
protected ?int $unit = null;
|
|
|
|
/**
|
|
* App name.
|
|
*
|
|
* @var null|string
|
|
* @since 1.0.0
|
|
*/
|
|
protected ?string $app = null;
|
|
|
|
/**
|
|
* Module id.
|
|
*
|
|
* @var null|string
|
|
* @since 1.0.0
|
|
*/
|
|
protected ?string $module = null;
|
|
|
|
/**
|
|
* Providing module id.
|
|
*
|
|
* @var string
|
|
* @since 1.0.0
|
|
*/
|
|
protected ?string $from = null;
|
|
|
|
/**
|
|
* Type.
|
|
*
|
|
* @var null|int
|
|
* @since 1.0.0
|
|
*/
|
|
protected ?int $category = null;
|
|
|
|
/**
|
|
* Element id.
|
|
*
|
|
* @var null|int
|
|
* @since 1.0.0
|
|
*/
|
|
protected ?int $element = null;
|
|
|
|
/**
|
|
* Component id.
|
|
*
|
|
* @var null|int
|
|
* @since 1.0.0
|
|
*/
|
|
protected ?int $component = null;
|
|
|
|
/**
|
|
* Permission.
|
|
*
|
|
* @var bool
|
|
* @since 1.0.0
|
|
*/
|
|
protected bool $hasRead = false;
|
|
|
|
/**
|
|
* Permission.
|
|
*
|
|
* @var bool
|
|
* @since 1.0.0
|
|
*/
|
|
protected bool $hasModify = false;
|
|
|
|
/**
|
|
* Permission.
|
|
*
|
|
* @var bool
|
|
* @since 1.0.0
|
|
*/
|
|
protected bool $hasCreate = false;
|
|
|
|
/**
|
|
* Permission.
|
|
*
|
|
* @var bool
|
|
* @since 1.0.0
|
|
*/
|
|
protected bool $hasDelete = false;
|
|
|
|
/**
|
|
* Permission.
|
|
*
|
|
* @var bool
|
|
* @since 1.0.0
|
|
*/
|
|
protected bool $hasPermission = false;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param null|int $unit Unit to check (null if all are acceptable)
|
|
* @param null|string $app App to check (null if all are acceptable)
|
|
* @param null|string $module Module Module to check (null if all are acceptable)
|
|
* @param null|string $from Provided by which module
|
|
* @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
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function __construct(
|
|
int $unit = null,
|
|
string $app = null,
|
|
string $module = null,
|
|
string $from = null,
|
|
int $category = null,
|
|
int $element = null,
|
|
int $component = null,
|
|
int $permission = PermissionType::NONE
|
|
) {
|
|
$this->unit = $unit;
|
|
$this->app = $app;
|
|
$this->module = $module;
|
|
$this->from = $from;
|
|
$this->category = $category;
|
|
$this->element = $element;
|
|
$this->component = $component;
|
|
|
|
$this->hasRead = ($permission & PermissionType::READ) === PermissionType::READ;
|
|
$this->hasCreate = ($permission & PermissionType::CREATE) === PermissionType::CREATE;
|
|
$this->hasModify = ($permission & PermissionType::MODIFY) === PermissionType::MODIFY;
|
|
$this->hasDelete = ($permission & PermissionType::DELETE) === PermissionType::DELETE;
|
|
$this->hasPermission = ($permission & PermissionType::PERMISSION) === PermissionType::PERMISSION;
|
|
}
|
|
|
|
/**
|
|
* Get permission id.
|
|
*
|
|
* @return int Retunrs the id of the permission
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function getId() : int
|
|
{
|
|
return $this->id;
|
|
}
|
|
|
|
/**
|
|
* Get unit id.
|
|
*
|
|
* @return null|int
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function getUnit() : ?int
|
|
{
|
|
return $this->unit;
|
|
}
|
|
|
|
/**
|
|
* Set unit id.
|
|
*
|
|
* @param null|int $unit Unit
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function setUnit(int $unit = null) : void
|
|
{
|
|
$this->unit = $unit;
|
|
}
|
|
|
|
/**
|
|
* Get app name.
|
|
*
|
|
* @return null|string
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function getApp() : ?string
|
|
{
|
|
return $this->app;
|
|
}
|
|
|
|
/**
|
|
* Set app name.
|
|
*
|
|
* @param string $app App name
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function setApp(string $app = null) : void
|
|
{
|
|
$this->app = $app;
|
|
}
|
|
|
|
/**
|
|
* Get module id.
|
|
*
|
|
* @return null|string
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function getModule() : ?string
|
|
{
|
|
return $this->module;
|
|
}
|
|
|
|
/**
|
|
* Set module id.
|
|
*
|
|
* @param string $module Module
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function setModule(string $module = null) : void
|
|
{
|
|
$this->module = $module;
|
|
}
|
|
|
|
/**
|
|
* Get providing module id.
|
|
*
|
|
* @return null|string Returns the module responsible for setting this permission
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function getFrom() : ?string
|
|
{
|
|
return $this->from;
|
|
}
|
|
|
|
/**
|
|
* Set providing module id.
|
|
*
|
|
* @param null|string $from Providing module
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function setFrom(string $from = null) : void
|
|
{
|
|
$this->from = $from;
|
|
}
|
|
|
|
/**
|
|
* Get category.
|
|
*
|
|
* @return null|int
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function getCategory() : ?int
|
|
{
|
|
return $this->category;
|
|
}
|
|
|
|
/**
|
|
* Set category.
|
|
*
|
|
* @param int $category Category
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function setCategory(int $category = null) : void
|
|
{
|
|
$this->category = $category;
|
|
}
|
|
|
|
/**
|
|
* Get element id.
|
|
*
|
|
* @return null|int
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function getElement() : ?int
|
|
{
|
|
return $this->element;
|
|
}
|
|
|
|
/**
|
|
* Set element id.
|
|
*
|
|
* @param int $element Element id
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function setElement(int $element = null) : void
|
|
{
|
|
$this->element = $element;
|
|
}
|
|
|
|
/**
|
|
* Get component id.
|
|
*
|
|
* @return null|int
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function getComponent() : ?int
|
|
{
|
|
return $this->component;
|
|
}
|
|
|
|
/**
|
|
* Set component id.
|
|
*
|
|
* @param int $component Component
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function setComponent(int $component = null) : void
|
|
{
|
|
$this->component = $component;
|
|
}
|
|
|
|
/**
|
|
* Get permission
|
|
*
|
|
* @return int Returns the permission (PermissionType)
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function getPermission() : int
|
|
{
|
|
$permission = 0;
|
|
|
|
if ($this->hasRead) {
|
|
$permission |= PermissionType::READ;
|
|
}
|
|
|
|
if ($this->hasCreate) {
|
|
$permission |= PermissionType::CREATE;
|
|
}
|
|
|
|
if ($this->hasModify) {
|
|
$permission |= PermissionType::MODIFY;
|
|
}
|
|
|
|
if ($this->hasDelete) {
|
|
$permission |= PermissionType::DELETE;
|
|
}
|
|
|
|
if ($this->hasPermission) {
|
|
$permission |= PermissionType::PERMISSION;
|
|
}
|
|
|
|
return $permission === 0 ? PermissionType::NONE : $permission;
|
|
}
|
|
|
|
/**
|
|
* Set permission.
|
|
*
|
|
* @param int $permission Permission
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function setPermission(int $permission = 0) : void
|
|
{
|
|
$this->hasRead = ($permission & PermissionType::READ) === PermissionType::READ;
|
|
$this->hasCreate = ($permission & PermissionType::CREATE) === PermissionType::CREATE;
|
|
$this->hasModify = ($permission & PermissionType::MODIFY) === PermissionType::MODIFY;
|
|
$this->hasDelete = ($permission & PermissionType::DELETE) === PermissionType::DELETE;
|
|
$this->hasPermission = ($permission & PermissionType::PERMISSION) === PermissionType::PERMISSION;
|
|
}
|
|
|
|
/**
|
|
* Add permission.
|
|
*
|
|
* @param int $permission Permission
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function addPermission(int $permission = 0) : void
|
|
{
|
|
switch($permission) {
|
|
case PermissionType::READ:
|
|
$this->hasRead = true;
|
|
break;
|
|
case PermissionType::CREATE:
|
|
$this->hasCreate = true;
|
|
break;
|
|
case PermissionType::MODIFY:
|
|
$this->hasModify = true;
|
|
break;
|
|
case PermissionType::DELETE:
|
|
$this->hasDelete = true;
|
|
break;
|
|
case PermissionType::PERMISSION:
|
|
$this->hasPermission = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Has permission.
|
|
*
|
|
* @param int $permission Permission
|
|
*
|
|
* @return bool Returns true if the permission is set otherwise returns false
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function hasPermissionFlags(int $permission) : bool
|
|
{
|
|
return ($this->getPermission() & $permission) === $permission;
|
|
}
|
|
|
|
/**
|
|
* Has permissions.
|
|
*
|
|
* Checks if the permission is defined
|
|
*
|
|
* @param int $permission Permission to check
|
|
* @param null|int $unit Unit Unit to check (null if all are acceptable)
|
|
* @param null|string $app App App to check (null if all are acceptable)
|
|
* @param null|string $module Module Module to check (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)
|
|
*
|
|
* @return bool Returns true if the permission is set, false otherwise
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function hasPermission(
|
|
int $permission,
|
|
int $unit = null,
|
|
string $app = null,
|
|
string $module = null,
|
|
int $category = null,
|
|
int $element = null,
|
|
int $component = null
|
|
) : bool
|
|
{
|
|
return $permission === PermissionType::NONE ||
|
|
(($unit === null || $this->unit === null || $this->unit === $unit)
|
|
&& ($app === null || $this->app === null || $this->app === $app)
|
|
&& ($module === null || $this->module === null || $this->module === $module)
|
|
&& ($category === null || $this->category === null || $this->category === $category)
|
|
&& ($element === null || $this->element === null || $this->element === $element)
|
|
&& ($component === null || $this->component === null || $this->component === $component)
|
|
&& ($this->getPermission() & $permission) === $permission);
|
|
}
|
|
|
|
/**
|
|
* Is equals.
|
|
*
|
|
* @param self $permission Permission
|
|
*
|
|
* @return bool Returns true if the permission is the same
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function isEqual(self $permission) : bool
|
|
{
|
|
return $this->unit === $permission->getUnit()
|
|
&& $this->app === $permission->getApp()
|
|
&& $this->module === $permission->getModule()
|
|
&& $this->category === $permission->getCategory()
|
|
&& $this->element === $permission->getElement()
|
|
&& $this->component === $permission->getComponent()
|
|
&& $this->getPermission() === $permission->getPermission();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function jsonSerialize() : mixed
|
|
{
|
|
return [
|
|
'id' => $this->id,
|
|
'unit' => $this->unit,
|
|
'app' => $this->app,
|
|
'module' => $this->module,
|
|
'from' => $this->from,
|
|
'category' => $this->category,
|
|
'element' => $this->element,
|
|
'component' => $this->component,
|
|
'permission' => $this->getPermission(),
|
|
];
|
|
}
|
|
}
|