Code Style & PHPDoc

This commit is contained in:
Daniel Kesselberg 2018-01-13 19:45:02 +01:00
parent 850d1673be
commit 6e2c253a79

View File

@ -1,23 +1,24 @@
<?php
/**
* @link https://www.humhub.org/
* @copyright Copyright (c) 2015 HumHub GmbH & Co. KG
* @copyright Copyright (c) 2018 HumHub GmbH & Co. KG
* @license https://www.humhub.com/licences
*/
namespace humhub\modules\user\components;
use Yii;
use humhub\components\Module;
use humhub\libs\BasePermission;
use humhub\modules\user\models\GroupPermission;
use Yii;
use yii\base\Component;
/**
* Description of PermissionManager
*
* @author luke
*/
class PermissionManager extends \yii\base\Component
class PermissionManager extends Component
{
/**
@ -60,12 +61,12 @@ class PermissionManager extends \yii\base\Component
$can = $this->can($current, $params, $allowCaching);
if ($can && !$verifyAll) {
return true;
} else if (!$can && $verifyAll) {
} elseif (!$can && $verifyAll) {
return false;
}
}
return $verifyAll;
} else if ($allowCaching) {
} elseif ($allowCaching) {
$permission = ($permission instanceof BasePermission) ? $permission : Yii::createObject($permission);
$key = $permission->getId();
@ -80,14 +81,20 @@ class PermissionManager extends \yii\base\Component
}
}
/**
* Return boolean for verifyAll
*
* @param array $params
* @return bool
*/
private function isVerifyAll($params = [])
{
if(isset($params['strict'])) {
if (isset($params['strict'])) {
return $params['strict'];
}
//deprecated
if(isset($params['all'])) {
if (isset($params['all'])) {
return $params['all'];
}
@ -136,6 +143,9 @@ class PermissionManager extends \yii\base\Component
* @param string $groupId
* @param string|BasePermission $permission either permission class or instance
* @param string $state
* @throws \Exception
* @throws \yii\base\InvalidConfigException
* @throws \yii\db\StaleObjectException
*/
public function setGroupState($groupId, $permission, $state)
{
@ -175,7 +185,7 @@ class PermissionManager extends \yii\base\Component
public function getGroupState($groups, BasePermission $permission, $returnDefaultState = 1)
{
if (is_array($groups)) {
$state = "";
$state = '';
foreach ($groups as $group) {
$state = $this->getSingleGroupState($group, $permission, $returnDefaultState);
if ($state === BasePermission::STATE_ALLOW) {
@ -213,21 +223,23 @@ class PermissionManager extends \yii\base\Component
return $permission->getDefaultState($groupId);
}
return "";
return '';
}
/**
* Returns a BasePermission by Id
*
* @param string $permissionId
* @param string $moduleId
* @return BasePermission
* @param $permissionId
* @param $moduleId
* @return BasePermission|null
* @throws \yii\base\InvalidConfigException
*/
public function getById($permissionId, $moduleId)
{
$module = Yii::$app->getModule($moduleId);
foreach ($this->getModulePermissions($module) as $permission) {
/** @var BasePermission $permission */
if ($permission->hasId($permissionId)) {
return $permission;
}
@ -236,6 +248,11 @@ class PermissionManager extends \yii\base\Component
return null;
}
/**
* @param $groupId
* @param BasePermission $permission
* @return array|null|\yii\db\ActiveRecord
*/
protected function getGroupStateRecord($groupId, BasePermission $permission)
{
return $this->getQuery()->andWhere([
@ -249,6 +266,7 @@ class PermissionManager extends \yii\base\Component
* Returns a list of all Permission objects
*
* @return array of BasePermissions
* @throws \yii\base\InvalidConfigException
*/
public function getPermissions()
{
@ -272,16 +290,17 @@ class PermissionManager extends \yii\base\Component
/**
* Returns permissions provided by a module
*
* @param \yii\base\Module $module
* @return array of BasePermissions
* @param Module $module
* @return array
* @throws \yii\base\InvalidConfigException
*/
protected function getModulePermissions(\yii\base\Module $module)
protected function getModulePermissions(Module $module)
{
$result = [];
if ($module instanceof \humhub\components\Module) {
if ($module instanceof Module) {
$permisisons = $module->getPermissions();
if(!empty($permisisons)) {
foreach($permisisons as $permission) {
if (!empty($permisisons)) {
foreach ($permisisons as $permission) {
$result[] = is_string($permission) ? Yii::createObject($permission) : $permission;
}
}
@ -313,8 +332,11 @@ class PermissionManager extends \yii\base\Component
/**
* Returns Permission Array
*
* @param int $groupId id of the group
* @param int $groupId v
* @param bool $returnOnlyChangeable
* @return array the permission array
* @throws \yii\base\Exception
* @throws \yii\base\InvalidConfigException
*/
public function createPermissionArray($groupId, $returnOnlyChangeable = false)
{
@ -325,6 +347,9 @@ class PermissionManager extends \yii\base\Component
continue;
}
$defaultState = BasePermission::getLabelForState(BasePermission::STATE_DEFAULT) . ' - '
. BasePermission::getLabelForState($permission->getDefaultState($groupId));
$permissions[] = [
'id' => $permission->id,
'title' => $permission->title,
@ -332,7 +357,7 @@ class PermissionManager extends \yii\base\Component
'moduleId' => $permission->moduleId,
'permissionId' => $permission->id,
'states' => [
BasePermission::STATE_DEFAULT => BasePermission::getLabelForState(BasePermission::STATE_DEFAULT) . ' - ' . BasePermission::getLabelForState($permission->getDefaultState($groupId)),
BasePermission::STATE_DEFAULT => $defaultState,
BasePermission::STATE_DENY => BasePermission::getLabelForState(BasePermission::STATE_DENY),
BasePermission::STATE_ALLOW => BasePermission::getLabelForState(BasePermission::STATE_ALLOW),
],