Documentation

share extends dataset
in package
Uses eventModuleEmpty

Artikel Objekt

Tags
author

Stefan Seehafer aka imagine fanpress@nobody-knows.org

copyright

(c) 2011-2020, Stefan Seehafer

license

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

Table of Contents

$article_id  : int
ARtciel id
$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
Controller-Pfad, wenn Objekt Edit-Action besitzt
$events  : events
Event-Liste
$id  : int
Objekt-ID
$language  : language
System-Sprachen-Objekt
$lastshare  : int
Timestamp of last share
$nodata  : bool
$this->data beim Speichern nicht berücksichtigen
$notifications  : notifications
Notifications
$objExists  : bool
Objektexistiert
$session  : session
System-Session
$sharecount  : int
Share count
$shareitem  : int
Share item string
$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
delete()  : bool
Löscht ein Objekt in der Datenbank
exists()  : bool
Prüft ob Objekt existiert
getArticleId()  : int
Returns article id
getData()  : array<string|int, mixed>
Gibt Inhalt von "data" zurück
getDescription()  : string
Returns share item description
getEditLink()  : string
Gibt Link für Edit-Action zurück
getIcon()  : string
Returns share item icon
getId()  : int
Gibt Object-ID zurück
getLastshare()  : int
Returns last share timestamp
getNodata()  : bool
Prüft, ob "data" gespeichert werden soll
getPreparedValueParams()  : int
Gibt array mit Values für Prepared Statements zurück
getSharecount()  : int
Returns share count
getShareitem()  : int
Returns share item string
increase()  : bool
Increase share count
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
Save object
setArticleId()  : mixed
Set article id
setId()  : mixed
Set dataset id
setLastshare()  : mixed
Set last share timestamp
setNodata()  : mixed
Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden
setSharecount()  : mixed
Set share count
setShareitem()  : mixed
Set share item string
update()  : bool
Update object
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

ARtciel id

protected int $article_id = 0

$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

Controller-Pfad, wenn Objekt Edit-Action besitzt

protected string $editAction

$lastshare

Timestamp of last share

protected int $lastshare = 0

$nodata

$this->data beim Speichern nicht berücksichtigen

protected bool $nodata = true

$objExists

Objektexistiert

protected bool $objExists = false

$sharecount

Share count

protected int $sharecount = 0

$shareitem

Share item string

protected int $shareitem = ''

$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 —

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 —

getArticleId()

Returns article id

public getArticleId() : int
Return values
int —

getData()

Gibt Inhalt von "data" zurück

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

getDescription()

Returns share item description

public getDescription() : string
Return values
string —

getEditLink()

Gibt Link für Edit-Action zurück

public getEditLink() : string
Return values
string —

getIcon()

Returns share item icon

public getIcon() : string
Tags
see
sharebuttons::getShareItemClass
Return values
string —

getId()

Gibt Object-ID zurück

public getId() : int
Return values
int —

getLastshare()

Returns last share timestamp

public getLastshare() : 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 —

getSharecount()

Returns share count

public getSharecount() : int
Return values
int —

getShareitem()

Returns share item string

public getShareitem() : int
Return values
int —

increase()

Increase share count

public increase() : bool
Return values
bool —

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

Save object

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

setArticleId()

Set article id

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

setId()

Set dataset id

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

setLastshare()

Set last share timestamp

public setLastshare(int $lastshare) : mixed
Parameters
$lastshare : 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 —

setSharecount()

Set share count

public setSharecount(int $sharecount) : mixed
Parameters
$sharecount : int
Return values
mixed —

setShareitem()

Set share item string

public setShareitem(int $shareitem) : mixed
Parameters
$shareitem : int
Return values
mixed —

update()

Update object

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