• Главная
• BookStack
• Services
• PermissionService

PHP Класс BookStack\Services\PermissionService

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$book
$chapter
$page

Защищенные свойства (Protected)

Свойство	Тип	Описание
$currentAction
$currentUserModel
$entityCache
$isAdminUser
$jointPermission
$role
$userRoles

Открытые методы

Метод	Описание
__construct ( JointPermission $jointPermission, Book $book, Chapter $chapter, Page $page, Role $role )	PermissionService constructor.
buildJointPermissionForRole ( Role $role )	Build the entity jointPermissions for a particular role.
buildJointPermissions ( )	Re-generate all entity permission from scratch.
buildJointPermissionsForEntities ( Collection $entities )	Rebuild the entity jointPermissions for a collection of entities.
buildJointPermissionsForEntity ( Entity $entity )	Rebuild the entity jointPermissions for a particular entity.
checkIfRestrictionsSet ( Entity $entity, $action ) : boolean | mixed	Check if an entity has restrictions set on itself or its parent tree.
checkOwnableUserAccess ( Ownable $ownable, $permission ) : boolean	Checks if an entity has a restriction set upon it.
deleteJointPermissionsForEntity ( Entity $entity )	Delete the entity jointPermissions for a particular entity.
deleteJointPermissionsForRole ( Role $role )	Delete the entity jointPermissions attached to a particular role.
enforceBookRestrictions ( $query, string $action = 'view' ) : mixed	Add restrictions to a book query.
enforceChapterRestrictions ( $query, string $action = 'view' ) : mixed	Add on permission restrictions to a chapter query.
enforceEntityRestrictions ( $query, string $action = 'view' ) : mixed	Add restrictions for a generic entity
enforcePageRestrictions ( $query, string $action = 'view' ) : mixed	Add restrictions for a page query
filterRelatedPages ( $query, $tableName, $entityIdColumn ) : mixed	Filters pages that are a direct relation to another item.
filterRestrictedEntityRelations ( $query, string $tableName, string $entityIdColumn, string $entityTypeColumn ) : mixed	Filter items that have entities set a a polymorphic relation.

Защищенные методы

Метод	Описание
createJointPermissionData ( Entity $entity, Role $role, $action ) : array	Create entity permission data for an entity and role for a particular action.
createJointPermissionDataArray ( Entity $entity, Role $role, $action, $permissionAll, $permissionOwn ) : array	Create an array of data with the information of an entity jointPermissions.
createManyJointPermissions ( Collection $entities, Collection $roles )	Create & Save entity jointPermissions for many entities and jointPermissions.
deleteManyJointPermissionsForEntities ( Entity[] $entities )	Delete all of the entity jointPermissions for a list of entities.
deleteManyJointPermissionsForRoles ( Role[] $roles )	Delete all of the entity jointPermissions for a list of entities.
entityRestrictionQuery ( $query ) : mixed	The general query filter to remove all entities that the current user does not have access to.
getActions ( $entity ) : array	Get the actions related to an entity.
getBook ( $bookId ) : Book	Get a book via ID, Checks local cache
getChapter ( $chapterId ) : Book	Get a chapter via ID, Checks local cache
getRoles ( ) : array | boolean	Get the roles for the current user;
readyEntityCache ( )	Prepare the local entity cache and ensure it's empty

Приватные методы

Метод	Описание
clean ( )	Clean the cached user elements.
currentUser ( ) : User	Get the current user
isAdmin ( ) : boolean	Check if the current user is an admin.

Описание методов

Описание свойств