Documentation

category extends dataset
in package
implements isCsvImportable

Kategorie-Objekt

Tags
author

Stefan Seehafer aka imagine fanpress@nobody-knows.org

copyright

(c) 2011-2022, Stefan Seehafer

license

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

Interfaces, Classes, Traits and Enums

isCsvImportable
CSV importtable interface

Table of Contents

$cache  : cache
System-Cache
$cacheName  : string
Cache name
$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>
Eigenschaften, welche beim Speichern in DB nicht von getPreparedSaveParams() zurückgegeben werden sollen
$editAction  : string
Action-String für edit-Action
$events  : events
Event-Liste
$groups  : array<string|int, mixed>
Gruppen, die diese Kategorie nutzen dürfen
$iconpath  : string
Kategorie-Icon-Pfad
$id  : int
Objekt-ID
$language  : language
System-Sprachen-Objekt
$name  : string
Kategorie-Name
$nodata  : bool
$this->data beim Speichern nicht berücksichtigen
$notifications  : notifications
Notifications
$objExists  : bool
Objektexistiert
$session  : session
System-Session
$table  : string
Tabellen-Name
$wordbanList  : items
Wortsperren-Liste
__construct()  : void
Konstruktor
__destruct()  : void
Konstruktor
__get()  : mixed
Magic get
__set()  : mixed
Magic set
__toString()  : string
Magic string
assignCsvRow()  : bool
Assigns csv row to internal fields
createFromDbObject()  : bool
Füllt Objekt mit Daten aus Datenbank-Result
delete()  : bool
Löscht ein Objekt in der Datenbank
exists()  : bool
Prüft ob Objekt existiert
getCategoryImage()  : string
Liefert <img>-Tag für Kategorie-Icon zurück
getData()  : array<string|int, mixed>
Gibt Inhalt von "data" zurück
getEditLink()  : string
Gibt Link für Edit-Action zurück
getFields()  : array<string|int, mixed>
Fetch fields for mapping
getGroups()  : mixed
Gruppen, die diese Kategorie nutzen dürfen
getIconPath()  : mixed
Kategorie-Icon-Pfad
getId()  : int
Gibt Object-ID zurück
getName()  : string
Kategorie-Name
getNodata()  : bool
Prüft, ob "data" gespeichert werden soll
getPreparedValueParams()  : int
Gibt array mit Values für Prepared Statements zurück
init()  : bool
Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde
prepareDataSave()  : bool
Bereitet Daten für Speicherung in Datenbank vor
save()  : bool|int
Executes save process to database and events
setGroups()  : mixed
Gruppen, die diese Kategorie nutzen dürfen, setzen
setIconPath()  : mixed
Kategorie-Icon-Pfad setzen
setId()  : mixed
Set dataset id
setName()  : mixed
Kategorie-Name setzen
setNodata()  : mixed
Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden
update()  : bool|int
Executes update process to database and events
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
removeBannedTexts()  : bool
Führt Ersetzung von gesperrten Texten in Kommentar-Daten durch

Properties

$cacheName

Cache name

protected string $cacheName = false

$data

data-Array für nicht weiter definierte Eigenschaften

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

$dbExcludes

Eigenschaften, welche beim Speichern in DB nicht von getPreparedSaveParams() zurückgegeben werden sollen

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

$editAction

Action-String für edit-Action

protected string $editAction = 'categories/edit&id='

$groups

Gruppen, die diese Kategorie nutzen dürfen

protected array<string|int, mixed> $groups

$iconpath

Kategorie-Icon-Pfad

protected string $iconpath

$name

Kategorie-Name

protected string $name

$nodata

$this->data beim Speichern nicht berücksichtigen

protected bool $nodata = true

$objExists

Objektexistiert

protected bool $objExists = false

$table

Tabellen-Name

protected string $table

$wordbanList

Wortsperren-Liste

protected items $wordbanList
Tags
since
3.2.0

Methods

__construct()

Konstruktor

public __construct([int $id = null ]) : void
Parameters
$id : int = null
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

assignCsvRow()

Assigns csv row to internal fields

public assignCsvRow(array<string|int, mixed> $csvRow) : bool
Parameters
$csvRow : array<string|int, mixed>
Tags
since
4.5-b8
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öscht ein Objekt in der Datenbank

public delete() : bool
Return values
bool

exists()

Prüft ob Objekt existiert

public exists() : bool
Return values
bool

getCategoryImage()

Liefert <img>-Tag für Kategorie-Icon zurück

public getCategoryImage() : string
Tags
since
3.1.0
Return values
string

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

getFields()

Fetch fields for mapping

public getFields() : array<string|int, mixed>
Tags
since
4.5-b8
Return values
array<string|int, mixed>

getGroups()

Gruppen, die diese Kategorie nutzen dürfen

public getGroups() : mixed
Return values
mixed

getIconPath()

Kategorie-Icon-Pfad

public getIconPath() : mixed
Return values
mixed

getId()

Gibt Object-ID zurück

public getId() : int
Return values
int

getName()

Kategorie-Name

public getName() : string
Return values
string

getNodata()

Prüft, ob "data" gespeichert werden soll

public getNodata() : bool
Return values
bool

getPreparedValueParams()

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

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

init()

Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde

public init() : bool
Return values
bool

prepareDataSave()

Bereitet Daten für Speicherung in Datenbank vor

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

save()

Executes save process to database and events

public save() : bool|int
Return values
bool|int

setGroups()

Gruppen, die diese Kategorie nutzen dürfen, setzen

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

setIconPath()

Kategorie-Icon-Pfad setzen

public setIconPath(string $iconpath) : mixed
Parameters
$iconpath : string
Return values
mixed

setId()

Set dataset id

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

setName()

Kategorie-Name setzen

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

setNodata()

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

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

update()

Executes update process to database and events

public update() : bool|int
Return values
bool|int

afterSaveInternal()

Is triggered after successful database insert

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

afterUpdateInternal()

Is triggered after successful database update

protected afterUpdateInternal() : bool
Tags
see
dataset::afterUpdateInternal
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>

removeBannedTexts()

Führt Ersetzung von gesperrten Texten in Kommentar-Daten durch

protected removeBannedTexts() : bool
Tags
since
3.2.0
Return values
bool

Search results