Documentation

item extends dataset
in package
implements isCsvImportable

Word Ban Item Object

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

since
3.2.0

Interfaces, Classes, Traits and Enums

isCsvImportable
CSV importtable interface

Table of Contents

$cache  : cache
System-Cache
$cacheName  : string
Cache name
$commentapproval  : bool
Kommentar muss freigegeben werden
$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
$id  : int
Objekt-ID
$language  : language
System-Sprachen-Objekt
$lockarticle  : bool
Artikel muss freigeschalten werden
$nodata  : bool
$this->data beim Speichern nicht berücksichtigen
$notifications  : notifications
Notifications
$objExists  : bool
Objektexistiert
$replacementtext  : string
Text für Ersetzung
$replacetxt  : bool
Text ersetzen
$searchtext  : string
gesuchter Text
$session  : session
System-Session
$table  : string
Tabellen-Name
__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
getCommentApproval()  : bool
Status ob Kommentar freigegeben werden muss
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
getId()  : int
Gibt Object-ID zurück
getLockArticle()  : bool
Status ob Artikel überprüft werden muss
getNodata()  : bool
Prüft, ob "data" gespeichert werden soll
getPreparedValueParams()  : int
Gibt array mit Values für Prepared Statements zurück
getReplacementtext()  : string
Text für Ersetzung zurückgeben
getReplaceTxt()  : bool
Status das Text ersetzt wird
getSearchtext()  : string
gesuchter Text zurückgeben
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
Executes save process to database and events
setCommentApproval()  : mixed
Status ob Kommentar freigegeben werden muss setzen
setId()  : mixed
Set dataset id
setLockArticle()  : mixed
Status ob Artikel überprüft werden muss setzen
setNodata()  : mixed
Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden
setReplacementtext()  : mixed
Text für Ersetzung setzen
setReplaceTxt()  : mixed
Status das Text ersetzt wird setzen
setSearchtext()  : mixed
gesuchter Text setzen
update()  : bool|int
Executes update process to database and events
afterSaveInternal()  : bool
Returns event base string
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

Properties

$cacheName

Cache name

protected string $cacheName = false

$commentapproval

Kommentar muss freigegeben werden

protected bool $commentapproval
Tags
since
3.5

$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 = 'wordban/edit&id='

$lockarticle

Artikel muss freigeschalten werden

protected bool $lockarticle
Tags
since
3.5

$nodata

$this->data beim Speichern nicht berücksichtigen

protected bool $nodata = true

$objExists

Objektexistiert

protected bool $objExists = false

$replacementtext

Text für Ersetzung

protected string $replacementtext

$replacetxt

Text ersetzen

protected bool $replacetxt
Tags
since
3.5

$searchtext

gesuchter Text

protected string $searchtext

$table

Tabellen-Name

protected string $table

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

getCommentApproval()

Status ob Kommentar freigegeben werden muss

public getCommentApproval() : bool
Tags
since
3.5
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

getFields()

Fetch fields for mapping

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

getId()

Gibt Object-ID zurück

public getId() : int
Return values
int

getLockArticle()

Status ob Artikel überprüft werden muss

public getLockArticle() : bool
Tags
since
3.5
Return values
bool

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

getReplacementtext()

Text für Ersetzung zurückgeben

public getReplacementtext() : string
Return values
string

getReplaceTxt()

Status das Text ersetzt wird

public getReplaceTxt() : bool
Tags
since
3.5
Return values
bool

getSearchtext()

gesuchter Text zurückgeben

public getSearchtext() : string
Return values
string

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
Tags
see
dataset::save
Return values
bool

setCommentApproval()

Status ob Kommentar freigegeben werden muss setzen

public setCommentApproval(bool $commentapproval) : mixed
Parameters
$commentapproval : bool
Tags
since
3.5
Return values
mixed

setId()

Set dataset id

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

setLockArticle()

Status ob Artikel überprüft werden muss setzen

public setLockArticle(bool $lockarticle) : mixed
Parameters
$lockarticle : bool
Tags
since
3.5
Return values
mixed

setNodata()

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

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

setReplacementtext()

Text für Ersetzung setzen

public setReplacementtext(string $replacementtext) : mixed
Parameters
$replacementtext : string
Tags
since
3.5
Return values
mixed

setReplaceTxt()

Status das Text ersetzt wird setzen

public setReplaceTxt(bool $replacetxt) : mixed
Parameters
$replacetxt : bool
Tags
since
3.5
Return values
mixed

setSearchtext()

gesuchter Text setzen

public setSearchtext(string $searchtext) : mixed
Parameters
$searchtext : string
Tags
since
3.5
Return values
mixed

update()

Executes update process to database and events

public update() : bool|int
Tags
since
4.1
Return values
bool|int

afterSaveInternal()

Returns event base string

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>

Search results