\Pydio\Conf\CoreAjxpRole

Authentication "role" concept : set of permissions that can be applied to one or more users, plus set of actions to be disabled.

Summary

Methods
Properties
Constants
__construct()
setId()
getId()
canRead()
canWrite()
getRight()
setRight()
removeRights()
clearRights()
getSpecificActionsRights()
setSpecificActionRight()
setDefault()
isDefault()
setGroupPath()
getGroupPath()
No public properties found
No constants found
No protected methods found
$groupPath
N/A
No private methods found
$id
$rights
$default
N/A

Properties

$groupPath

$groupPath : String

Type

String

$id

$id : 

Type

$rights

$rights : 

Type

$default

$default : 

Type

Methods

__construct()

__construct(string  $id) : void

Constructor

Parameters

string $id

setId()

setId(  $id) : void

Parameters

$id

getId()

getId() : string

Returns

string

canRead()

canRead(string  $rootDirId) : boolean

Whether this role can read the given repo

Parameters

string $rootDirId

Repository ID

Returns

boolean

canWrite()

canWrite(string  $rootDirId) : boolean

Whether this role can write the given repo

Parameters

string $rootDirId

Repository ID

Returns

boolean

getRight()

getRight(string  $rootDirId) : string

Current definitioon (r, rw, w, empty string) for the given repo

Parameters

string $rootDirId

Repository ID

Returns

string

setRight()

setRight(string  $rootDirId, string  $rightString) : void

Set the right

Parameters

string $rootDirId

Repo id

string $rightString

("r", "rw", "w", "")

removeRights()

removeRights(string  $rootDirId) : void

Remove a right entry for the repository

Parameters

string $rootDirId

clearRights()

clearRights() : void

Remove all rights

getSpecificActionsRights()

getSpecificActionsRights(  $rootDirId) : array

Get the specific actions rights (see setSpecificActionsRights)

Parameters

$rootDirId

Returns

array

setSpecificActionRight()

setSpecificActionRight(string  $rootDirId, string  $actionName, boolean  $allowed) : void

This method allows to specifically disable some actions for a given role for one or more repository.

Parameters

string $rootDirId

Repository id or "ajxp.all" for all repositories

string $actionName
boolean $allowed

setDefault()

setDefault(  $default) 

Parameters

$default

isDefault()

isDefault() : boolean

Returns

boolean

setGroupPath()

setGroupPath(String  $groupPath, boolean  $update = true) : void

Parameters

String $groupPath
boolean $update

Save use after setting groupPath

getGroupPath()

getGroupPath() : String

Returns

String