Properties

$cypheredPassPrefix

$cypheredPassPrefix : 

Type

$groupPath

$groupPath : String

Type

String — path of this role, default is root path

$roleId

$roleId : String

Type

String — Role identifier

$acls

$acls : array

Type

array — List of access rights for each workspaces (wsId => "r", "w", "rw", "d")

$parameters

$parameters : array

Type

array — List of plugins parameters values, (SCOPE => PLUGIN NAME => PARAM NAME => value)

$actions

$actions : array

Type

array — List of plugin actions that can be disabled/enabled (SCOPE => PLUGIN NAME => ACTION NAME => status)

$autoApplies

$autoApplies : array

Type

array — Automatically applies to a given list of profiles

$lastUpdated

$lastUpdated : integer

Type

integer

Methods

__construct()

__construct(string  $id) 

AJXP_Role constructor.

Parameters

string $id

migrateDeprecated()

migrateDeprecated(  $repositoriesList, \Pydio\Conf\Core\AjxpRole  $oldRole) 

Migrates an old AjxpRole object to AJXP_Role

Parameters

$repositoriesList
\Pydio\Conf\Core\AjxpRole $oldRole

isGroupRole()

isGroupRole() : boolean

Returns

boolean

isUserRole()

isUserRole() : boolean

Returns

boolean

canRead()

canRead(string  $repositoryId) : boolean

Whether this role can read the given repo

Parameters

string $repositoryId

Repository ID

Returns

boolean

canWrite()

canWrite(string  $repositoryId) : boolean

Whether this role can write the given repo

Parameters

string $repositoryId

Repository ID

Returns

boolean

setAcl()

setAcl(string  $repositoryId, string  $rightString) : void

Parameters

string $repositoryId
string $rightString

getAcl()

getAcl(string  $repositoryId) : string

Parameters

string $repositoryId

Returns

string

listAcls()

listAcls(boolean  $accessibleOnly = false) : array

Parameters

boolean $accessibleOnly

If set to true, return only r, w, or rw.

Returns

array —

Associative array[REPO_ID] => RIGHT_STRING (r / w / rw / AJXP_VALUE_CLEAR)

clearAcls()

clearAcls() 

clearMask()

clearMask(string  $repositoryId) 

Parameters

string $repositoryId

hasMask()

hasMask(string  $repositoryId) : boolean

Parameters

string $repositoryId

Returns

boolean

getDataArray()

getDataArray(boolean  $blurPasswords = false) : array

Send all role informations as an associative array

Parameters

boolean $blurPasswords

Returns

array

bunchUpdate()

bunchUpdate(array  $roleData) 

Update the role information from an associative array

Parameters

array $roleData

setParameterValue()

setParameterValue(string  $pluginId, string  $parameterName, mixed  $parameterValue, string|null  $repositoryId = null) 

Parameters

string $pluginId
string $parameterName
mixed $parameterValue

can be AJXP_VALUE_CLEAR (force clear previous), or empty string for clearing value (apply previous).

string|null $repositoryId

filterPluginConfigs()

filterPluginConfigs(string  $pluginId, array  $parameters, string  $repositoryId) : array

Parameters

string $pluginId
array $parameters
string $repositoryId

Returns

array

filterParameterValue()

filterParameterValue(string  $pluginId, string  $parameterName, string  $repositoryId, mixed  $parameterValue) : mixed

Parameters

string $pluginId
string $parameterName
string $repositoryId
mixed $parameterValue

Returns

mixed

listParameters()

listParameters(boolean  $preserveCypheredPasswords = false, boolean  $blurCypheredPasswords = false) : array

Parameters

boolean $preserveCypheredPasswords
boolean $blurCypheredPasswords

Returns

array —

Associative array of parameters : array[REPO_ID][PLUGIN_ID][PARAMETER_NAME] = PARAMETER_VALUE

listAutoApplies()

listAutoApplies() : array

Returns

array

setActionState()

setActionState(string  $pluginId, string  $actionName, string|null  $repositoryId = null, string  $state = "disabled") 

Parameters

string $pluginId
string $actionName
string|null $repositoryId
string $state

listActionsStates()

listActionsStates() : array

Returns

array

actionEnabled()

actionEnabled(string  $pluginId, string  $actionName, string  $repositoryId, boolean  $inputState) : boolean

Parameters

string $pluginId
string $actionName
string $repositoryId
boolean $inputState

Returns

boolean

listAllActionsStates()

listAllActionsStates() : array

Returns

array

setArrayValue()

setArrayValue() 

array_merge_recursive2()

array_merge_recursive2(array  $array1, array  $array2) : array

Parameters

array $array1
array $array2

Returns

array

setGroupPath()

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

Parameters

String $groupPath
boolean $update

Save use after setting groupPath

getGroupPath()

getGroupPath() : String

Returns

String

getId()

getId() : String

Returns

String

setLabel()

setLabel(string  $roleLabel) 

Parameters

string $roleLabel

getLabel()

getLabel() : String

Returns

String

alwaysOverrides()

alwaysOverrides() : mixed

Returns

mixed

setAutoApplies()

setAutoApplies(array  $specificRights) 

Parameters

array $specificRights

autoAppliesTo()

autoAppliesTo(string  $specificRight) : boolean

Parameters

string $specificRight

Returns

boolean

getLastUpdated()

getLastUpdated() : integer

Returns

integer

setLastUpdated()

setLastUpdated(  $time) 

Parameters

$time

filterCypheredPasswordValue()

filterCypheredPasswordValue(String  $value) : String

Parameters

String $value

Returns

String