Documentation

permissions extends dataset
in package

Permissions handler object

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2022, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

since
4.4

Table of Contents

$article  : article
Article permissions
$comment  : comment
Comment permissions
$modules  : modules
Module manager permissions
$system  : system
Common system permissions
$uploads  : uploads
Filemanager permissions
$cache  : cache
System-Cache
$cacheName  : string
Cache name
$checkedData  : array<string|int, mixed>
Berechtigungsdaten - bereits geprüft
$config  : config
System-Config-Objekt
$data  : array<string|int, mixed>
data-Array für nicht weiter definierte Eigenschaften
$dbcon  : database
DB-Verbindung
$dbExcludes  : array<string|int, mixed>
Exclude items from databse save
$editAction  : string
Controller-Pfad, wenn Objekt Edit-Action besitzt
$events  : events
Event-Liste
$id  : int
Objekt-ID
$language  : language
System-Sprachen-Objekt
$nodata  : bool
$this->data beim Speichern nicht berücksichtigen
$notifications  : notifications
Notifications
$objExists  : bool
Objektexistiert
$permissiondata  : array<string|int, mixed>
Berechtigungsdaten
$rollid  : int
Rollen-ID
$session  : session
System-Session
$table  : string
Tabellen-Name
__construct()  : void
Constructor
__destruct()  : void
Konstruktor
__get()  : mixed
Magic get
__set()  : mixed
Magic set
__toString()  : string
Magic string
addDefault()  : bool
Initialisiert Berechtigungen mit Standardwerten
articleTrash()  : bool
User has permissions for article trash
createFromDbObject()  : bool
Füllt Objekt mit Daten aus Datenbank-Result
delete()  : bool
Löschen Berechtigungsdatensatz aus DB
editArticles()  : bool
User has comment editing permissions
editArticlesMass()  : bool
User has comment editing permissions
editComments()  : bool
User has comment editing permissions
editCommentsMass()  : bool
User has comment editing permissions
exists()  : bool
Prüft ob Objekt existiert
getData()  : array<string|int, mixed>
Gibt Inhalt von "data" zurück
getEditLink()  : string
Gibt Link für Edit-Action zurück
getId()  : int
Gibt Object-ID zurück
getNodata()  : bool
Prüft, ob "data" gespeichert werden soll
getPermissionData()  : array<string|int, mixed>
Berechtigungsdaten auslesen
getPermissionsAll()  : array<string|int, mixed>
Gibt Array mit allen Berechtigungsdatensätzen zurück
getPermissionSet()  : array<string|int, mixed>
Gibt leeren Standard-Berechtigungsset zurück
getPreparedValueParams()  : int
Gibt array mit Values für Prepared Statements zurück
getRollId()  : int
Rollen-ID auslesen
init()  : void
Berechtigungen initialisieren
prepareDataSave()  : bool
Bereitet Daten für Speicherung in Datenbank vor
save()  : bool
Speichert einen neuen Rechte-Datensatz in der Datenbank
setId()  : mixed
Set dataset id
setNodata()  : mixed
Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden
setPermissionData()  : mixed
Berechtigungsdaten setzen
setRollId()  : mixed
Rollen-ID setzen
update()  : bool
Aktualisiert einen Rechte-Datensatz in der Datenbank
afterSaveInternal()  : bool
Is triggered after successful database insert
afterUpdateInternal()  : bool
Is triggered after successful database update
getEventModule()  : string
Returns event base string
getEventName()  : string
Returns full event name string
getPreparedSaveParams()  : array<string|int, mixed>
Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften
initItems()  : bool
Init permission object items
refresh()  : bool
Refresh cache and session data

Properties

$cacheName

Cache name

protected string $cacheName = false

$checkedData

Berechtigungsdaten - bereits geprüft

protected array<string|int, mixed> $checkedData = []

$data

data-Array für nicht weiter definierte Eigenschaften

protected array<string|int, mixed> $data = []

$dbExcludes

Exclude items from databse save

protected array<string|int, mixed> $dbExcludes = ['checkedData', 'article', 'comment', 'system', 'modules', 'uploads']

$editAction

Controller-Pfad, wenn Objekt Edit-Action besitzt

protected string $editAction

$nodata

$this->data beim Speichern nicht berücksichtigen

protected bool $nodata = true

$objExists

Objektexistiert

protected bool $objExists = false

$permissiondata

Berechtigungsdaten

protected array<string|int, mixed> $permissiondata = []

$table

Tabellen-Name

protected string $table

Methods

__construct()

Constructor

public __construct(int $rollid[, bool $useCache = true ]) : void
Parameters
$rollid : int
$useCache : bool = true
Return values
void

__destruct()

Konstruktor

public __destruct() : void
Return values
void

__get()

Magic get

public __get(string $name) : mixed
Parameters
$name : string
Return values
mixed

__set()

Magic set

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed
Return values
mixed

__toString()

Magic string

public __toString() : string
Return values
string

addDefault()

Initialisiert Berechtigungen mit Standardwerten

public addDefault(int $rollid) : bool
Parameters
$rollid : int
Return values
bool

articleTrash()

User has permissions for article trash

public articleTrash() : bool
Return values
bool

createFromDbObject()

Füllt Objekt mit Daten aus Datenbank-Result

public createFromDbObject(object $object) : bool
Parameters
$object : object
Return values
bool

delete()

Löschen Berechtigungsdatensatz aus DB

public delete() : bool
Return values
bool

editArticles()

User has comment editing permissions

public editArticles() : bool
Return values
bool

editArticlesMass()

User has comment editing permissions

public editArticlesMass() : bool
Return values
bool

editComments()

User has comment editing permissions

public editComments() : bool
Return values
bool

editCommentsMass()

User has comment editing permissions

public editCommentsMass() : bool
Return values
bool

exists()

Prüft ob Objekt existiert

public exists() : bool
Return values
bool

getData()

Gibt Inhalt von "data" zurück

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

Gibt Link für Edit-Action zurück

public getEditLink() : string
Return values
string

getId()

Gibt Object-ID zurück

public getId() : int
Return values
int

getNodata()

Prüft, ob "data" gespeichert werden soll

public getNodata() : bool
Return values
bool

getPermissionData()

Berechtigungsdaten auslesen

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

getPermissionsAll()

Gibt Array mit allen Berechtigungsdatensätzen zurück

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

getPermissionSet()

Gibt leeren Standard-Berechtigungsset zurück

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

getPreparedValueParams()

Gibt array mit Values für Prepared Statements zurück

public getPreparedValueParams([int $count = false ]) : int
Parameters
$count : int = false
Return values
int

getRollId()

Rollen-ID auslesen

public getRollId() : int
Return values
int

init()

Berechtigungen initialisieren

public init() : void
Return values
void

prepareDataSave()

Bereitet Daten für Speicherung in Datenbank vor

public prepareDataSave() : bool
Tags
since
3.6
Return values
bool

save()

Speichert einen neuen Rechte-Datensatz in der Datenbank

public save() : bool
Return values
bool

setId()

Set dataset id

public setId(int $id) : mixed
Parameters
$id : int
Return values
mixed

setNodata()

Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden

public setNodata(bool $nodata) : mixed
Parameters
$nodata : bool
Return values
mixed

setPermissionData()

Berechtigungsdaten setzen

public setPermissionData(array<string|int, mixed> $permissiondata) : mixed
Parameters
$permissiondata : array<string|int, mixed>
Return values
mixed

setRollId()

Rollen-ID setzen

public setRollId(array<string|int, mixed> $rollid) : mixed
Parameters
$rollid : array<string|int, mixed>
Return values
mixed

update()

Aktualisiert einen Rechte-Datensatz in der Datenbank

public update() : bool
Return values
bool

afterSaveInternal()

Is triggered after successful database insert

protected afterSaveInternal() : bool
Tags
since
4.1
Return values
bool

afterUpdateInternal()

Is triggered after successful database update

protected afterUpdateInternal() : bool
Tags
since
4.1
Return values
bool

getEventModule()

Returns event base string

protected getEventModule() : string
Tags
see
dataset::getEventModule
since
4.1
Return values
string

getEventName()

Returns full event name string

protected final getEventName(string $event) : string
Parameters
$event : string
Tags
since
4.1
Return values
string

getPreparedSaveParams()

Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften

protected getPreparedSaveParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

initItems()

Init permission object items

protected final initItems() : bool
Tags
since
4.4
Return values
bool

refresh()

Refresh cache and session data

private refresh() : bool
Tags
since
4.5
Return values
bool

Search results