BackendUserGroup extends AbstractEntity

This model represents a backend usergroup.

Deprecated

since v11, will be removed in v12. Do not use or extend this model.

Table of Contents

Constants

DIRECTORY_COPY  = 8
DIRECTORY_OPPERATIONS  = 4
DIRECTORY_REMOVE_RECURSIVELY  = 16
FILE_OPPERATIONS  = 1

Properties

$_languageUid  : int
$_localizedUid  : int
$_versionedUid  : int
$allowedExcludeFields  : string
$allowedLanguages  : string
$databaseMounts  : string
$description  : string
$explicitlyAllowAndDeny  : string
$fileOperationPermissions  : int
$modules  : string
$pageTypes  : string
$pid  : int
$subGroups  : ObjectStorage<string|int, BackendUserGroup>
$tablesListening  : string
$tablesModify  : string
$title  : string
$tsConfig  : string
$uid  : int
$workspacePermission  : bool

Methods

__clone()  : mixed
Clone method. Sets the _isClone property.
__construct()  : mixed
Constructs this backend usergroup
__toString()  : string
Returns the class name and the uid of the object as string
_getCleanProperties()  : array<string|int, mixed>
Returns a hash map of clean properties and $values.
_getCleanProperty()  : mixed
Returns the clean value of the given property. The returned value will be NULL if the clean state was not memorized before, or if the clean value is NULL.
_getProperties()  : array<string|int, mixed>
Returns a hash map of property names and property values. Only for internal use.
_getProperty()  : mixed
Returns the property value of the given property name. Only for internal use.
_hasProperty()  : bool
Returns the property value of the given property name. Only for internal use.
_isClone()  : bool
Returns TRUE if the object has been cloned, FALSE otherwise.
_isDirty()  : bool
Returns TRUE if the properties were modified after reconstitution
_isNew()  : bool
Returns TRUE if the object is new (the uid was not set, yet). Only for internal use
_memorizeCleanState()  : mixed
Register an object's clean state, e.g. after it has been reconstituted from the database.
_memorizePropertyCleanState()  : mixed
Register a properties's clean state, e.g. after it has been reconstituted from the database.
_setClone()  : mixed
Setter whether this Domain Object is a clone of another one.
_setProperty()  : bool
Reconstitutes a property. Only for internal use.
addSubGroup()  : mixed
Adds a sub group to this backend user group
getAllowedExcludeFields()  : string
Getter for allowed exclude fields
getAllowedLanguages()  : string
Getter for allowed languages
getDatabaseMounts()  : string
Getter for database mounts
getDescription()  : string
Getter for description
getExplicitlyAllowAndDeny()  : string
Getter for explicitly allow and deny
getFileOperationPermissions()  : int
Getter for file operation permissions
getModules()  : string
Getter for modules
getPageTypes()  : string
Getter for page types
getPid()  : int|null
Getter for the pid.
getSubGroups()  : ObjectStorage
Getter of sub groups
getTablesListening()  : string
Getter for tables listening
getTablesModify()  : string
Getter for tables modify
getTitle()  : string
Getter for title
getTsConfig()  : string
Getter for ts config
getUid()  : int|null
Getter for uid.
getWorkspacePermission()  : bool
Getter for workspace permission
isDirectoryCopyAllowed()  : bool
Check if it is allowed to copy folders.
isDirectoryOperationAllowed()  : bool
Check if folder operations like move, delete, rename, and new are allowed.
isDirectoryRemoveRecursivelyAllowed()  : bool
Check if it is allowed to remove folders recursively.
isFileOperationAllowed()  : bool
Check if file operations like upload, copy, move, delete, rename, new and edit files is allowed.
removeAllSubGroups()  : mixed
Remove all sub groups from this backend user group
removeSubGroup()  : mixed
Removes sub group from this backend user group
setAllowedExcludeFields()  : mixed
Setter for allowed exclude fields
setAllowedLanguages()  : mixed
Setter for allowed languages
setDatabaseMounts()  : mixed
Setter for database mounts
setDescription()  : mixed
Setter for description
setDirectoryCopyAllowed()  : mixed
Set the the bit for copy directories.
setDirectoryOperationAllowed()  : mixed
Set the the bit for directory operations are allowed.
setDirectoryRemoveRecursivelyAllowed()  : mixed
Set the the bit for remove directories recursively.
setExplicitlyAllowAndDeny()  : mixed
Setter for explicitly allow and deny
setFileOperationAllowed()  : mixed
Set the the bit for file operations are allowed.
setFileOperationPermissions()  : mixed
Getter for file operation permissions
setModules()  : mixed
Setter for modules
setPageTypes()  : mixed
Setter for page types
setPid()  : void
Setter for the pid.
setSubGroups()  : mixed
Setter for the sub groups
setTablesListening()  : mixed
Setter for tables listening
setTablesModify()  : mixed
Setter for tables modify
setTitle()  : mixed
Setter for title
setTsConfig()  : mixed
Setter for ts config
setWorkspacePermissions()  : mixed
Setter for workspace permission
isPermissionSet()  : bool
Helper method for checking the permissions bitwise.
isPropertyDirty()  : bool
Checks the $value against the $cleanState.
setPermission()  : mixed
Helper method for setting permissions bitwise.

Constants

DIRECTORY_COPY

public mixed DIRECTORY_COPY = 8

DIRECTORY_OPPERATIONS

public mixed DIRECTORY_OPPERATIONS = 4

DIRECTORY_REMOVE_RECURSIVELY

public mixed DIRECTORY_REMOVE_RECURSIVELY = 16

FILE_OPPERATIONS

public mixed FILE_OPPERATIONS = 1

Properties

$_languageUid

protected int $_languageUid

The uid of the language of the object. This is the uid of the language record in the table sys_language.

$_localizedUid

protected int $_localizedUid

The uid of the localized record. Holds the uid of the record in default language (the translationOrigin).

$_versionedUid

protected int $_versionedUid

The uid of the versioned record.

$allowedExcludeFields

protected string $allowedExcludeFields = ''

$allowedLanguages

protected string $allowedLanguages = ''

$databaseMounts

protected string $databaseMounts = ''

$description

protected string $description = ''

$explicitlyAllowAndDeny

protected string $explicitlyAllowAndDeny = ''

$fileOperationPermissions

protected int $fileOperationPermissions = 0

$pageTypes

protected string $pageTypes = ''

$pid

protected int $pid

The id of the page the record is "stored".

$tablesListening

protected string $tablesListening = ''

$tablesModify

protected string $tablesModify = ''

$title

protected string $title = ''
Tags
Extbase\Validate

("NotEmpty")

$uid

protected int $uid

The uid of the record. The uid is only unique in the context of the database table.

$workspacePermission

protected bool $workspacePermission = false

Methods

__clone()

Clone method. Sets the _isClone property.

public __clone() : mixed

__construct()

Constructs this backend usergroup

public __construct() : mixed

__toString()

Returns the class name and the uid of the object as string

public __toString() : string
Return values
string

_getCleanProperties()

Returns a hash map of clean properties and $values.

public _getCleanProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>

_getCleanProperty()

Returns the clean value of the given property. The returned value will be NULL if the clean state was not memorized before, or if the clean value is NULL.

public _getCleanProperty(string $propertyName) : mixed
Parameters
$propertyName : string

The name of the property to be memorized.

Internal
Return values
mixed —

The clean property value or NULL

_getProperties()

Returns a hash map of property names and property values. Only for internal use.

public _getProperties() : array<string|int, mixed>
Internal
Return values
array<string|int, mixed> —

The properties

_getProperty()

Returns the property value of the given property name. Only for internal use.

public _getProperty(string $propertyName) : mixed
Parameters
$propertyName : string
Internal
Return values
mixed —

The propertyValue

_hasProperty()

Returns the property value of the given property name. Only for internal use.

public _hasProperty(string $propertyName) : bool
Parameters
$propertyName : string
Internal
Return values
bool —

TRUE bool true if the property exists, FALSE if it doesn't exist or NULL in case of an error.

_isClone()

Returns TRUE if the object has been cloned, FALSE otherwise.

public _isClone() : bool
Return values
bool —

TRUE if the object has been cloned

_isDirty()

Returns TRUE if the properties were modified after reconstitution

public _isDirty([string $propertyName = null ]) : bool
Parameters
$propertyName : string = null

An optional name of a property to be checked if its value is dirty

Tags
throws
TooDirtyException
Return values
bool

_isNew()

Returns TRUE if the object is new (the uid was not set, yet). Only for internal use

public _isNew() : bool
Internal
Return values
bool

_memorizeCleanState()

Register an object's clean state, e.g. after it has been reconstituted from the database.

public _memorizeCleanState([string $propertyName = null ]) : mixed
Parameters
$propertyName : string = null

The name of the property to be memorized. If omitted all persistable properties are memorized.

_memorizePropertyCleanState()

Register a properties's clean state, e.g. after it has been reconstituted from the database.

public _memorizePropertyCleanState(string $propertyName) : mixed
Parameters
$propertyName : string

The name of the property to be memorized. If omitted all persistable properties are memorized.

_setClone()

Setter whether this Domain Object is a clone of another one.

public _setClone(bool $clone) : mixed

NEVER SET THIS PROPERTY DIRECTLY. We currently need it to make the _isDirty check inside AbstractEntity work, but it is just a work- around right now.

Parameters
$clone : bool

_setProperty()

Reconstitutes a property. Only for internal use.

public _setProperty(string $propertyName, mixed $propertyValue) : bool
Parameters
$propertyName : string
$propertyValue : mixed
Internal
Return values
bool

getAllowedExcludeFields()

Getter for allowed exclude fields

public getAllowedExcludeFields() : string
Return values
string

getAllowedLanguages()

Getter for allowed languages

public getAllowedLanguages() : string
Return values
string

getDatabaseMounts()

Getter for database mounts

public getDatabaseMounts() : string
Return values
string

getDescription()

Getter for description

public getDescription() : string
Return values
string

getExplicitlyAllowAndDeny()

Getter for explicitly allow and deny

public getExplicitlyAllowAndDeny() : string
Return values
string

getFileOperationPermissions()

Getter for file operation permissions

public getFileOperationPermissions() : int
Return values
int

getModules()

Getter for modules

public getModules() : string
Return values
string

getPageTypes()

Getter for page types

public getPageTypes() : string
Return values
string

getPid()

Getter for the pid.

public getPid() : int|null
Return values
int|null —

The pid or NULL if none set yet.

getTablesListening()

Getter for tables listening

public getTablesListening() : string
Return values
string

getTablesModify()

Getter for tables modify

public getTablesModify() : string
Return values
string

getTitle()

Getter for title

public getTitle() : string
Return values
string

getTsConfig()

Getter for ts config

public getTsConfig() : string
Return values
string

getUid()

Getter for uid.

public getUid() : int|null
Return values
int|null —

The uid or NULL if none set yet.

getWorkspacePermission()

Getter for workspace permission

public getWorkspacePermission() : bool
Return values
bool

isDirectoryCopyAllowed()

Check if it is allowed to copy folders.

public isDirectoryCopyAllowed() : bool
Return values
bool

isDirectoryOperationAllowed()

Check if folder operations like move, delete, rename, and new are allowed.

public isDirectoryOperationAllowed() : bool
Return values
bool

isDirectoryRemoveRecursivelyAllowed()

Check if it is allowed to remove folders recursively.

public isDirectoryRemoveRecursivelyAllowed() : bool
Return values
bool

isFileOperationAllowed()

Check if file operations like upload, copy, move, delete, rename, new and edit files is allowed.

public isFileOperationAllowed() : bool
Return values
bool

removeAllSubGroups()

Remove all sub groups from this backend user group

public removeAllSubGroups() : mixed

setAllowedExcludeFields()

Setter for allowed exclude fields

public setAllowedExcludeFields(string $allowedExcludeFields) : mixed
Parameters
$allowedExcludeFields : string

setAllowedLanguages()

Setter for allowed languages

public setAllowedLanguages(string $allowedLanguages) : mixed
Parameters
$allowedLanguages : string

setDatabaseMounts()

Setter for database mounts

public setDatabaseMounts(string $databaseMounts) : mixed
Parameters
$databaseMounts : string

setDescription()

Setter for description

public setDescription(string $description) : mixed
Parameters
$description : string

setDirectoryCopyAllowed()

Set the the bit for copy directories.

public setDirectoryCopyAllowed(bool $value) : mixed
Parameters
$value : bool

setDirectoryOperationAllowed()

Set the the bit for directory operations are allowed.

public setDirectoryOperationAllowed(bool $value) : mixed
Parameters
$value : bool

setDirectoryRemoveRecursivelyAllowed()

Set the the bit for remove directories recursively.

public setDirectoryRemoveRecursivelyAllowed(bool $value) : mixed
Parameters
$value : bool

setExplicitlyAllowAndDeny()

Setter for explicitly allow and deny

public setExplicitlyAllowAndDeny(string $explicitlyAllowAndDeny) : mixed
Parameters
$explicitlyAllowAndDeny : string

setFileOperationAllowed()

Set the the bit for file operations are allowed.

public setFileOperationAllowed(bool $value) : mixed
Parameters
$value : bool

setFileOperationPermissions()

Getter for file operation permissions

public setFileOperationPermissions(int $fileOperationPermissions) : mixed
Parameters
$fileOperationPermissions : int

setModules()

Setter for modules

public setModules(string $modules) : mixed
Parameters
$modules : string

setPageTypes()

Setter for page types

public setPageTypes(string $pageTypes) : mixed
Parameters
$pageTypes : string

setPid()

Setter for the pid.

public setPid(int $pid) : void
Parameters
$pid : int

setTablesListening()

Setter for tables listening

public setTablesListening(string $tablesListening) : mixed
Parameters
$tablesListening : string

setTablesModify()

Setter for tables modify

public setTablesModify(string $tablesModify) : mixed
Parameters
$tablesModify : string

setTitle()

Setter for title

public setTitle(string $title) : mixed
Parameters
$title : string

setTsConfig()

Setter for ts config

public setTsConfig(string $tsConfig) : mixed
Parameters
$tsConfig : string

setWorkspacePermissions()

Setter for workspace permission

public setWorkspacePermissions(bool $workspacePermission) : mixed
Parameters
$workspacePermission : bool

isPermissionSet()

Helper method for checking the permissions bitwise.

protected isPermissionSet(int $permission) : bool
Parameters
$permission : int
Return values
bool

isPropertyDirty()

Checks the $value against the $cleanState.

protected isPropertyDirty(mixed $previousValue, mixed $currentValue) : bool
Parameters
$previousValue : mixed
$currentValue : mixed
Return values
bool

setPermission()

Helper method for setting permissions bitwise.

protected setPermission(int $permission, bool $value) : mixed
Parameters
$permission : int
$value : bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results