Documentation

revision extends dataset
in package
Uses eventModuleEmpty

Article revision object for storage in database

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.3

Table of Contents

$article_id  : string
Article id
$cache  : cache
System-Cache
$cacheName  : string
Cache name
$config  : config
System-Config-Objekt
$content  : array<string|int, mixed>
Article data store din revision
$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
Controller-Pfad, wenn Objekt Edit-Action besitzt
$events  : events
Event-Liste
$hashsum  : string
Revision hash
$id  : int
Objekt-ID
$language  : language
System-Sprachen-Objekt
$nodata  : bool
$this->data beim Speichern nicht berücksichtigen
$notifications  : notifications
Notifications
$objExists  : bool
Objektexistiert
$revision_idx  : string
Revision number
$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
createFromDbObject()  : bool
Füllt Objekt mit Daten aus Datenbank-Result
createHashSum()  : mixed
Revision Hash Sum erzeugen
delete()  : bool
Löscht Revision in der Datenbank
exists()  : bool
Prüft ob Objekt existiert
getArticleId()  : int
Artikel ID zurückgeben
getContent()  : array<string|int, mixed>
Artikel-COntent aus Revision zurückgeben
getData()  : array<string|int, mixed>
Gibt Inhalt von "data" zurück
getEditLink()  : string
Gibt Link für Edit-Action zurück
getHashSum()  : string
Hash von Revision zurückgeben
getId()  : int
Gibt Object-ID zurück
getNodata()  : bool
Prüft, ob "data" gespeichert werden soll
getPreparedValueParams()  : int
Gibt array mit Values für Prepared Statements zurück
getRevisionIdx()  : int
Revisionszeit-Index zurückgeben
init()  : bool
Initializes object
prepareDataSave()  : bool
Bereitet Daten für Speicherung in Datenbank vor
save()  : int
Speichert eine neue Revision in der Datenbank
setArticleId()  : mixed
Artikel ID setzen
setContent()  : mixed
Content aus artikel speichern
setHashsum()  : mixed
Hash von Revision setzen
setId()  : mixed
Set dataset id
setNodata()  : mixed
Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden
setRevisionIdx()  : mixed
Revisionszeit-Index setzen
update()  : bool
Revision kann nicht verändert werden
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

Properties

$article_id

Article id

protected string $article_id = 0

$cacheName

Cache name

protected string $cacheName = false

$content

Article data store din revision

protected array<string|int, mixed> $content = ''

$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

Controller-Pfad, wenn Objekt Edit-Action besitzt

protected string $editAction

$hashsum

Revision hash

protected string $hashsum = ''
Tags
since
3.4

$nodata

$this->data beim Speichern nicht berücksichtigen

protected bool $nodata = true

$objExists

Objektexistiert

protected bool $objExists = false

$revision_idx

Revision number

protected string $revision_idx = 0

$table

Tabellen-Name

protected string $table

Methods

__construct()

Konstruktor

public __construct(int $articleId, int $revisionIdx) : void
Parameters
$articleId : int
$revisionIdx : int
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

createFromDbObject()

Füllt Objekt mit Daten aus Datenbank-Result

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

createHashSum()

Revision Hash Sum erzeugen

public createHashSum([array<string|int, mixed> $data = [] ]) : mixed
Parameters
$data : array<string|int, mixed> = []
Tags
since
3.4
Return values
mixed

delete()

Löscht Revision in der Datenbank

public delete() : bool
Return values
bool

exists()

Prüft ob Objekt existiert

public exists() : bool
Return values
bool

getArticleId()

Artikel ID zurückgeben

public getArticleId() : int
Return values
int

getContent()

Artikel-COntent aus Revision zurückgeben

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

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

getHashSum()

Hash von Revision zurückgeben

public getHashSum() : string
Tags
since
3.4
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

getPreparedValueParams()

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

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

getRevisionIdx()

Revisionszeit-Index zurückgeben

public getRevisionIdx() : int
Return values
int

init()

Initializes object

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()

Speichert eine neue Revision in der Datenbank

public save() : int
Return values
int

setArticleId()

Artikel ID setzen

public setArticleId(int $articleId) : mixed
Parameters
$articleId : int
Return values
mixed

setContent()

Content aus artikel speichern

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

setHashsum()

Hash von Revision setzen

public setHashsum(type $hashsum) : mixed
Parameters
$hashsum : type
Tags
since
3.4
Return values
mixed

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

setRevisionIdx()

Revisionszeit-Index setzen

public setRevisionIdx(int $revisionIdx) : mixed
Parameters
$revisionIdx : int
Return values
mixed

update()

Revision kann nicht verändert werden

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 abstract getEventModule() : string
Tags
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