PHP Класс eZ\Publish\Core\REST\Server\Controller\Role

Наследование: extends eZ\Publish\Core\REST\Server\Controller
Показать файл Открыть проект

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

Свойство Тип Описание
$locationService eZ\Publish\API\Repository\LocationService Location service.
$roleService eZ\Publish\API\Repository\RoleService Role service.
$userService eZ\Publish\API\Repository\UserService User service.

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

Метод Описание
__construct ( eZ\Publish\API\Repository\RoleService $roleService, eZ\Publish\API\Repository\UserService $userService, eZ\Publish\API\Repository\LocationService $locationService ) Construct controller.
addPolicy ( $roleId, Request $request ) : CreatedPolicy Adds a policy to role.
addPolicyByRoleDraft ( $roleId, Request $request ) : CreatedPolicy Adds a policy to a role draft.
assignRoleToUser ( $userId, Request $request ) : RoleAssignmentList Assigns role to user.
assignRoleToUserGroup ( $groupPath, Request $request ) : RoleAssignmentList Assigns role to user group.
createRole ( Request $request ) : CreatedRole Create new role.
createRoleDraft ( $roleId, Request $request ) : CreatedRole Creates a new RoleDraft for an existing Role.
deletePolicies ( $roleId ) : eZ\Publish\Core\REST\Server\Values\NoContent Deletes all policies from a role.
deletePolicy ( $roleId, $policyId, Request $request ) : eZ\Publish\Core\REST\Server\Values\NoContent Delete a policy from role.
deleteRole ( $roleId ) : eZ\Publish\Core\REST\Server\Values\NoContent Delete a role by ID.
deleteRoleDraft ( $roleId ) : eZ\Publish\Core\REST\Server\Values\NoContent Delete a role draft by ID.
listPoliciesForUser ( Request $request ) : PolicyList Search all policies which are applied to a given user.
listRoles ( Request $request ) : RoleList Loads list of roles.
loadPolicies ( $roleId, Request $request ) : PolicyList Loads the policies for the role.
loadPolicy ( $roleId, $policyId, Request $request ) : eZ\Publish\API\Repository\Values\User\Policy Loads a policy.
loadRole ( $roleId ) : eZ\Publish\API\Repository\Values\User\Role Loads role.
loadRoleAssignmentForUser ( $userId, $roleId, Request $request ) : RestUserRoleAssignment Returns a role assignment to the given user.
loadRoleAssignmentForUserGroup ( $groupPath, $roleId, Request $request ) : RestUserGroupRoleAssignment Returns a role assignment to the given user group.
loadRoleAssignmentsForUser ( $userId ) : RoleAssignmentList Loads role assignments for user.
loadRoleAssignmentsForUserGroup ( $groupPath ) : RoleAssignmentList Loads role assignments for user group.
loadRoleDraft ( mixed $roleId ) : eZ\Publish\API\Repository\Values\User\RoleDraft Loads a role draft.
publishRoleDraft ( mixed $roleId ) : PublishedRole Publishes a role draft.
removePolicyByRoleDraft ( $roleId, $policyId, Request $request ) : eZ\Publish\Core\REST\Server\Values\NoContent Remove a policy from a role draft.
unassignRoleFromUser ( $userId, $roleId ) : RoleAssignmentList Un-assigns role from user.
unassignRoleFromUserGroup ( $groupPath, $roleId ) : RoleAssignmentList Un-assigns role from user group.
updatePolicy ( $roleId, $policyId, Request $request ) : eZ\Publish\API\Repository\Values\User\Policy Updates a policy.
updatePolicyByRoleDraft ( $roleId, $policyId, Request $request ) : eZ\Publish\API\Repository\Values\User\Policy Updates a policy.
updateRole ( $roleId, Request $request ) : eZ\Publish\API\Repository\Values\User\Role Updates a role.
updateRoleDraft ( mixed $roleId, Request $request ) : eZ\Publish\API\Repository\Values\User\RoleDraft Updates a role draft.

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

Метод Описание
mapToUpdateStruct ( eZ\Publish\API\Repository\Values\User\RoleCreateStruct $createStruct ) : eZ\Publish\API\Repository\Values\User\RoleUpdateStruct Maps a RoleCreateStruct to a RoleUpdateStruct.

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

Метод Описание
getLastAddedPolicy ( $role ) : eZ\Publish\API\Repository\Values\User\Policy Get the last added policy for $role.

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

__construct() публичный Метод

Construct controller.
public __construct ( eZ\Publish\API\Repository\RoleService $roleService, eZ\Publish\API\Repository\UserService $userService, eZ\Publish\API\Repository\LocationService $locationService )
$roleService eZ\Publish\API\Repository\RoleService
$userService eZ\Publish\API\Repository\UserService
$locationService eZ\Publish\API\Repository\LocationService

addPolicy() публичный Метод

Adds a policy to role.
public addPolicy ( $roleId, Request $request ) : CreatedPolicy
$roleId int ID of a role or a role draft
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\Core\REST\Server\Values\CreatedPolicy

addPolicyByRoleDraft() публичный Метод

Adds a policy to a role draft.
Устаревший: since 6.3, use {@see \addPolicy}
С версии: 6.2
public addPolicyByRoleDraft ( $roleId, Request $request ) : CreatedPolicy
$roleId
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\Core\REST\Server\Values\CreatedPolicy

assignRoleToUser() публичный Метод

Assigns role to user.
public assignRoleToUser ( $userId, Request $request ) : RoleAssignmentList
$userId
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\Core\REST\Server\Values\RoleAssignmentList

assignRoleToUserGroup() публичный Метод

Assigns role to user group.
public assignRoleToUserGroup ( $groupPath, Request $request ) : RoleAssignmentList
$groupPath
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\Core\REST\Server\Values\RoleAssignmentList

createRole() публичный Метод

Defaults to publishing the role, but you can create a draft instead by setting the POST parameter publish=false
public createRole ( Request $request ) : CreatedRole
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\Core\REST\Server\Values\CreatedRole

createRoleDraft() публичный Метод

Creates a new RoleDraft for an existing Role.
С версии: 6.2
public createRoleDraft ( $roleId, Request $request ) : CreatedRole
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\Core\REST\Server\Values\CreatedRole

deletePolicies() публичный Метод

Deletes all policies from a role.
public deletePolicies ( $roleId ) : eZ\Publish\Core\REST\Server\Values\NoContent
$roleId
Результат eZ\Publish\Core\REST\Server\Values\NoContent

deletePolicy() публичный Метод

Delete a policy from role.
public deletePolicy ( $roleId, $policyId, Request $request ) : eZ\Publish\Core\REST\Server\Values\NoContent
$roleId int ID of a role or a role draft
$policyId int ID of a policy
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\Core\REST\Server\Values\NoContent

deleteRole() публичный Метод

Delete a role by ID.
public deleteRole ( $roleId ) : eZ\Publish\Core\REST\Server\Values\NoContent
$roleId
Результат eZ\Publish\Core\REST\Server\Values\NoContent

deleteRoleDraft() публичный Метод

Delete a role draft by ID.
С версии: 6.2
public deleteRoleDraft ( $roleId ) : eZ\Publish\Core\REST\Server\Values\NoContent
$roleId
Результат eZ\Publish\Core\REST\Server\Values\NoContent

listPoliciesForUser() публичный Метод

Search all policies which are applied to a given user.
public listPoliciesForUser ( Request $request ) : PolicyList
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\Core\REST\Server\Values\PolicyList

listRoles() публичный Метод

Loads list of roles.
public listRoles ( Request $request ) : RoleList
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\Core\REST\Server\Values\RoleList

loadPolicies() публичный Метод

Loads the policies for the role.
public loadPolicies ( $roleId, Request $request ) : PolicyList
$roleId
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\Core\REST\Server\Values\PolicyList

loadPolicy() публичный Метод

Loads a policy.
public loadPolicy ( $roleId, $policyId, Request $request ) : eZ\Publish\API\Repository\Values\User\Policy
$roleId
$policyId
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\API\Repository\Values\User\Policy

loadRole() публичный Метод

Loads role.
public loadRole ( $roleId ) : eZ\Publish\API\Repository\Values\User\Role
$roleId
Результат eZ\Publish\API\Repository\Values\User\Role

loadRoleAssignmentForUser() публичный Метод

Returns a role assignment to the given user.
public loadRoleAssignmentForUser ( $userId, $roleId, Request $request ) : RestUserRoleAssignment
$userId
$roleId
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\Core\REST\Server\Values\RestUserRoleAssignment

loadRoleAssignmentForUserGroup() публичный Метод

Returns a role assignment to the given user group.
public loadRoleAssignmentForUserGroup ( $groupPath, $roleId, Request $request ) : RestUserGroupRoleAssignment
$groupPath
$roleId
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\Core\REST\Server\Values\RestUserGroupRoleAssignment

loadRoleAssignmentsForUser() публичный Метод

Loads role assignments for user.
public loadRoleAssignmentsForUser ( $userId ) : RoleAssignmentList
$userId
Результат eZ\Publish\Core\REST\Server\Values\RoleAssignmentList

loadRoleAssignmentsForUserGroup() публичный Метод

Loads role assignments for user group.
public loadRoleAssignmentsForUserGroup ( $groupPath ) : RoleAssignmentList
$groupPath
Результат eZ\Publish\Core\REST\Server\Values\RoleAssignmentList

loadRoleDraft() публичный Метод

Loads a role draft.
public loadRoleDraft ( mixed $roleId ) : eZ\Publish\API\Repository\Values\User\RoleDraft
$roleId mixed Original role ID, or ID of the role draft itself
Результат eZ\Publish\API\Repository\Values\User\RoleDraft

mapToUpdateStruct() защищенный Метод

Needed since both structs are encoded into the same media type on input.
protected mapToUpdateStruct ( eZ\Publish\API\Repository\Values\User\RoleCreateStruct $createStruct ) : eZ\Publish\API\Repository\Values\User\RoleUpdateStruct
$createStruct eZ\Publish\API\Repository\Values\User\RoleCreateStruct
Результат eZ\Publish\API\Repository\Values\User\RoleUpdateStruct

publishRoleDraft() публичный Метод

Publishes a role draft.
public publishRoleDraft ( mixed $roleId ) : PublishedRole
$roleId mixed Original role ID, or ID of the role draft itself
Результат eZ\Publish\Core\REST\Server\Values\PublishedRole

removePolicyByRoleDraft() публичный Метод

Remove a policy from a role draft.
Устаревший: since 6.3, use {@see \deletePolicy}
С версии: 6.2
public removePolicyByRoleDraft ( $roleId, $policyId, Request $request ) : eZ\Publish\Core\REST\Server\Values\NoContent
$roleId
$policyId
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\Core\REST\Server\Values\NoContent

unassignRoleFromUser() публичный Метод

Un-assigns role from user.
public unassignRoleFromUser ( $userId, $roleId ) : RoleAssignmentList
$userId
$roleId
Результат eZ\Publish\Core\REST\Server\Values\RoleAssignmentList

unassignRoleFromUserGroup() публичный Метод

Un-assigns role from user group.
public unassignRoleFromUserGroup ( $groupPath, $roleId ) : RoleAssignmentList
$groupPath
$roleId
Результат eZ\Publish\Core\REST\Server\Values\RoleAssignmentList

updatePolicy() публичный Метод

Updates a policy.
public updatePolicy ( $roleId, $policyId, Request $request ) : eZ\Publish\API\Repository\Values\User\Policy
$roleId int ID of a role or a role draft
$policyId int ID of a policy
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\API\Repository\Values\User\Policy

updatePolicyByRoleDraft() публичный Метод

Updates a policy.
Устаревший: since 6.3, use {@see \updatePolicy}
С версии: 6.2
public updatePolicyByRoleDraft ( $roleId, $policyId, Request $request ) : eZ\Publish\API\Repository\Values\User\Policy
$roleId
$policyId
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\API\Repository\Values\User\Policy

updateRole() публичный Метод

Updates a role.
public updateRole ( $roleId, Request $request ) : eZ\Publish\API\Repository\Values\User\Role
$roleId
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\API\Repository\Values\User\Role

updateRoleDraft() публичный Метод

Updates a role draft.
public updateRoleDraft ( mixed $roleId, Request $request ) : eZ\Publish\API\Repository\Values\User\RoleDraft
$roleId mixed Original role ID, or ID of the role draft itself
$request Symfony\Component\HttpFoundation\Request
Результат eZ\Publish\API\Repository\Values\User\RoleDraft

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

$locationService защищенное свойство

Location service.
protected LocationService,eZ\Publish\API\Repository $locationService
Результат eZ\Publish\API\Repository\LocationService

$roleService защищенное свойство

Role service.
protected RoleService,eZ\Publish\API\Repository $roleService
Результат eZ\Publish\API\Repository\RoleService

$userService защищенное свойство

User service.
protected UserService,eZ\Publish\API\Repository $userService
Результат eZ\Publish\API\Repository\UserService