\Pydio\Core\ServicesRolesService

Class RolesService

Summary

Methods
Properties
Constants
updateAdminRights()
updateDefaultRights()
updateAutoApplyRole()
updateAuthProvidedData()
getRolesForRepository()
getRole()
getOrCreateRole()
updateRole()
deleteRole()
limitedRoleFromParent()
enableRolesCache()
getRolesList()
bootSequence()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$useCache
$rolesCache
N/A

Properties

$useCache

$useCache : boolean

Type

boolean

$rolesCache

$rolesCache : array

Type

array

Methods

updateDefaultRights()

updateDefaultRights(\Pydio\Core\Model\UserInterface  $userObject) 

Update a user object with the default repositories rights

Parameters

\Pydio\Core\Model\UserInterface $userObject

getRolesForRepository()

getRolesForRepository(  $repositoryId, string  $rolePrefix = '', boolean  $splitByType = false) : array

Retrieve the current users who have either read or write access to a repository

Parameters

$repositoryId
string $rolePrefix
boolean $splitByType

Returns

array

getRole()

getRole(string  $roleId) : \Pydio\Conf\Core\AJXP_Role

Get Role by Id

Parameters

string $roleId

Returns

\Pydio\Conf\Core\AJXP_Role

getOrCreateRole()

getOrCreateRole(string  $roleId, string  $groupPath = "/") : \Pydio\Conf\Core\AJXP_Role

Parameters

string $roleId

Id of the role

string $groupPath

GroupPath to be applied

Returns

\Pydio\Conf\Core\AJXP_Role

deleteRole()

deleteRole(string  $roleId) : void

Delete a role by its id

Parameters

string $roleId

limitedRoleFromParent()

limitedRoleFromParent(string  $parentUserId) : \Pydio\Conf\Core\AJXP_Role

Parameters

string $parentUserId

Returns

\Pydio\Conf\Core\AJXP_Role

enableRolesCache()

enableRolesCache(boolean  $status) 

Parameters

boolean $status

getRolesList()

getRolesList(array  $roleIds = array(),   $excludeReserved = false) : array<mixed,\Pydio\Conf\Core\AJXP_Role>

Get all defined roles

Parameters

array $roleIds
$excludeReserved

Returns

array<mixed,\Pydio\Conf\Core\AJXP_Role>

bootSequence()

bootSequence() 

Specific operations to perform at boot time

Throws

\Pydio\Core\Exception\PydioException
\Exception