Documentation

article extends dataset
in
Uses autoTable

Artikel object

Table of Contents

CACHE_ARTICLE_SINGLE Cache-Name für einzelnen Artikel 'articlesingle'
CACHE_ARTICLE_MODULE Cache-Module-Name 'articles'
SOURCES_AUTOCOMPLETE Sources auto-complete fileoption name 'articles/sources'
POSTPONED_ACTIVE Postpoed active status 1
POSTPONED_INACTIVE Postpoed active status 0
POSTPONED_SEARCH_FE Postpoed search status flag 2
$title News-Titel string
$content News-Text string
$categories Kategorien array
$draft Status: Entwurf int
$archived Status: archiviert int
$pinned Status: gepinnt int
$postponed Status: automatisch freischalten int
$deleted Status: gelöscht int
$comments Kommentare aktiv int
$approval Artikel muss freigegeben werden int
$imagepath Pfad zum Artikel-Bild string
$createtime Veröffentlichungszeit int
$createuser Author int
$changetime Zeitpunkt der letzten Änderung int
$changeuser Benutzer der letzten Änderung int
$sources Artikel-Quellen string
$inedit Artikel-Quellen int
$forceDelete richtiges Löschen erzwingen int
$dbExcludes Auszuschließende Elemente beim in save/update array
$editAction Action-String für edit-Action string
$wordbanList Wortsperren-Liste items
$crypt Crypto-Objekt crypt
$editPermission Status ob Artikel bearbeitet werden kann bool
$tweetOverride Text für überschriebenes Tweet-Template string
$tweetCreate TWeet Erstellung aktivieren bool
$dbcon DB-Verbindung database
$id Objekt-ID int
$table Tabellen-Name string
$data data-Array für nicht weiter definierte Eigenschaften array
$dbExcludes Eigenschaften, welche beim Speichern in DB nicht von getPreparedSaveParams() zurückgegeben werden sollen array
$nodata $this->data beim Speichern nicht berücksichtigen bool
$cache System-Cache cache
$session System-Session session
$events Event-Liste events
$config System-Config-Objekt config
$language System-Sprachen-Objekt language
$notifications Notifications notifications
$editAction Controller-Pfad, wenn Objekt Edit-Action besitzt string
$objExists Objektexistiert bool
$cacheName Cache name string
__construct() Konstruktor void
getTitle() Gibt Artikel- zurück string
getContent() Gibt Artikel-Inhalt zurück strig
getCategories() Gibt Artikel-Kategorie-IDs zurück array
getDraft() Gibt Artikel-Entwurf-Status zurück bool
getArchived() Gibt Artikel-archiviert-Status zurück bool
getPinned() Gibt Artikel-gepinnt-Status zurück bool
getPostponed() Gibt Artikel-geplant-Status zurück bool
getDeleted() Gibt Artikel-gelöscht-Status zurück bool
getCreatetime() Gibt Artikel-Erstellungszeitpunkt zurück int
getCreateuser() Gibt Artikel-Author-ID zurück int
getChangetime() Gibt Zeitpunkt der letzten Änderung zurück int
getChangeuser() Gibt Benutzer-ID zurück, von dem letzte Änderung durchgeführt wurde int
getComments() Gibt Artikel-Kommentare aktiv-Status zurück bool
getApproval() Gibt Artikel-muss freigeschaltet werden-Status zurück bool
getImagepath() Gibt Pfad zum Artikel-Bild zurück string
getEditPermission() Liefert Status, ob Artikel bearbeitet werden kann zurück bool
getSources() Gibt Artikel-Quellen zurück bool
tweetCreationEnabled() Tweet-Erstellung aktiv? bool
setTitle() Ttiel setzen mixed
setContent() Inhalt setzen mixed
setCategories() Kategorien setzen mixed
setDraft() Entwurf-Status setzen mixed
setArchived() archiviert Status setzen mixed
setPinned() gepinnt Status mixed
setPostponed() Geplant-Status setzen mixed
setDeleted() Gelöscht Status setzen mixed
setCreatetime() Zeitpunk der Erzeugung setzen mixed
setCreateuser() Benutzer der Erzeugung setzen mixed
setChangetime() Zeitpunk der letzten Änderung setzen mixed
setChangeuser() Benutzer der letzten Änderung setzen mixed
setComments() Kommentar-aktiv-Status setzen mixed
setApproval() Freigabe-Status setzen mixed
setImagepath() Setzt Pfad zum Artikel-Bild mixed
setSources() Setzt Artikel-Quellen-Daten bool
setEditPermission() Setzt Status, ob Artikel bearbeitet werden kann mixed
setForceDelete() Artikel vollständig löschen erzwingen mixed
getTweetOverride() Text für überschriebenes Tweet-Template zurückgeben string
setTweetOverride() Text für überschriebenes Tweet-Template setzen mixed
enableTweetCreation() Tweet-Erstellung aktivieren mixed
getArticleNicePath() schönen URL-Pfad zurückgeben string
getElementLink() Return frontend article link string
getArticleCacheParams() Link zum Löschen des Artikel-Caches string
getArticleShortLink() Erzeugt Short-Link zum Artikel zurück string
getArticleImage() Liefert <img>-Tag für Artikel-Image zurück string
delete() Löscht News in der Datenbank bool
prepareRevision() Artikel-Daten für Revision vorbereiten mixed
createRevision() Erzeugt eine Revision des Artikels bool
getRevisions() Gib Revisionen des Artikels zurück array
getRevisionsCount() Anzahl Revisionen des Artikels array
getRevision() Lädt Revision eines Artikels bool
restoreRevision() Stellt Revision eines Artikels wieder her bool
deleteRevisions() Löscht Revisionen bool
createTweet() Erzeugt einen Tweet bei Twitter, wenn Verbindung aktiv und Events ausgewählt bool
setInEdit() Sperrt Artikel als in Bearbeitung bool
getInEdit() In Bearbeitung Informationen auslesen array
isInEdit() Ist Artikel in Bearbeitung bool
publicIsVisible() Prüft, ob Artikel öffentlich sichtbar ist bool
getMetaDataStatusIcons() Returns array with all status icons array
getStatusIconPinned() Returns pinned status icon icon
getStatusIconDraft() Returns draft status icon icon
getStatusIconPostponed() Returns postponed status icon icon
getStatusIconApproval() Returns approval status icon icon
getStatusIconComments() Returns comments enabled status icon icon
getStatusIconArchive() Returns archive status icon icon
removeBannedTexts() Führt Ersetzung von gesperrten Texten in Artikel-Daten durch bool
cleanupCaches() Bereinigt Caches void
getEventModule() Returns event base string string
afterSaveInternal() Is triggered after successful database insert bool
afterUpdateInternal() Is triggered after successful database update bool
addSourcesAutocomplete() Add sources string to auto-complete file option, max. 25 values saved bool
fetchSourcesAutocomplete() Fetch sources strings from auto-complete file option array
getTableName() Returns table name based on class name string
__construct() Konstruktor void
__get() Magic get mixed
__set() Magic set mixed
__toString() Magic string string
__call() Magische Methode für nicht vorhandene Methoden bool
__callStatic() Magische Methode für nicht vorhandene, statische Methoden bool
__destruct() Konstruktor void
getData() Gibt Inhalt von "data" zurück array
init() Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde bool
getId() Gibt Object-ID zurück int
setId() Set dataset id mixed
exists() Prüft ob Objekt existiert bool
getNodata() Prüft, ob "data" gespeichert werden soll bool
setNodata() Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden mixed
save() Executes save process to database and events bool|int
update() Executes update process to database and events bool|int
delete() Löscht ein Objekt in der Datenbank bool
createFromDbObject() Füllt Objekt mit Daten aus Datenbank-Result bool
getPreparedSaveParams() Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften array
getPreparedValueParams() Gibt array mit Values für Prepared Statements zurück int
prepareDataSave() Bereitet Daten für Speicherung in Datenbank vor bool
getEditLink() Gibt Link für Edit-Action zurück string
getEventName() Returns full event name string string
getEventModule() Returns event base string string
afterSaveInternal() Is triggered after successful database insert bool
afterUpdateInternal() Is triggered after successful database update bool

Constants

CACHE_ARTICLE_SINGLE

Cache-Name für einzelnen Artikel

mixed $CACHE_ARTICLE_SINGLE = 'articlesingle'

CACHE_ARTICLE_MODULE

Cache-Module-Name

mixed $CACHE_ARTICLE_MODULE = 'articles'

SOURCES_AUTOCOMPLETE

Sources auto-complete fileoption name

mixed $SOURCES_AUTOCOMPLETE = 'articles/sources'

POSTPONED_ACTIVE

Postpoed active status

mixed $POSTPONED_ACTIVE = 1

POSTPONED_INACTIVE

Postpoed active status

mixed $POSTPONED_INACTIVE = ""

POSTPONED_SEARCH_FE

Postpoed search status flag

mixed $POSTPONED_SEARCH_FE = 2

Properties

$title

News-Titel

protected string $title = ''

$content

News-Text

protected string $content = ''

$categories

Kategorien

protected array $categories = []

$draft

Status: Entwurf

protected int $draft = ""

$archived

Status: archiviert

protected int $archived = ""

$pinned

Status: gepinnt

protected int $pinned = ""

$postponed

Status: automatisch freischalten

protected int $postponed = ""

$deleted

Status: gelöscht

protected int $deleted = ""

$comments

Kommentare aktiv

protected int $comments = 1

$approval

Artikel muss freigegeben werden

protected int $approval = ""

$imagepath

Pfad zum Artikel-Bild

protected string $imagepath = ''

$createtime

Veröffentlichungszeit

protected int $createtime = ""

$createuser

Author

protected int $createuser = ""

$changetime

Zeitpunkt der letzten Änderung

protected int $changetime = ""

$changeuser

Benutzer der letzten Änderung

protected int $changeuser = ""

$sources

Artikel-Quellen

protected string $sources = ''

$inedit

Artikel-Quellen

protected int $inedit = ''

$forceDelete

richtiges Löschen erzwingen

protected int $forceDelete = ""

$dbExcludes

Auszuschließende Elemente beim in save/update

protected array $dbExcludes = ['defaultPermissions', 'forceDelete', 'editPermission', 'tweetOverride', 'tweetCreate', 'crypt']

$editAction

Action-String für edit-Action

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

$editPermission

Status ob Artikel bearbeitet werden kann

protected bool $editPermission = true

$tweetOverride

Text für überschriebenes Tweet-Template

protected string $tweetOverride = false

$tweetCreate

TWeet Erstellung aktivieren

protected bool $tweetCreate = null

$table

Tabellen-Name

protected string $table

$data

data-Array für nicht weiter definierte Eigenschaften

protected array $data = []

$dbExcludes

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

protected array $dbExcludes = []

$nodata

$this->data beim Speichern nicht berücksichtigen

protected bool $nodata = true

$editAction

Controller-Pfad, wenn Objekt Edit-Action besitzt

protected string $editAction

$objExists

Objektexistiert

protected bool $objExists = false

$cacheName

Cache name

protected string $cacheName = false

Methods

__construct()

Konstruktor

public __construct( [ $id : int = null ] ) : void
Parameters
$id : int = null

getTitle()

Gibt Artikel- zurück

public getTitle( ) : string
Return values
string

getContent()

Gibt Artikel-Inhalt zurück

public getContent( ) : strig
Return values
strig

getCategories()

Gibt Artikel-Kategorie-IDs zurück

public getCategories( ) : array
Return values
array

getDraft()

Gibt Artikel-Entwurf-Status zurück

public getDraft( ) : bool
Return values
bool

getArchived()

Gibt Artikel-archiviert-Status zurück

public getArchived( ) : bool
Return values
bool

getPinned()

Gibt Artikel-gepinnt-Status zurück

public getPinned( ) : bool
Return values
bool

getPostponed()

Gibt Artikel-geplant-Status zurück

public getPostponed( ) : bool
Return values
bool

getDeleted()

Gibt Artikel-gelöscht-Status zurück

public getDeleted( ) : bool
Return values
bool

getCreatetime()

Gibt Artikel-Erstellungszeitpunkt zurück

public getCreatetime( ) : int
Return values
int

getCreateuser()

Gibt Artikel-Author-ID zurück

public getCreateuser( ) : int
Return values
int

getChangetime()

Gibt Zeitpunkt der letzten Änderung zurück

public getChangetime( ) : int
Return values
int

getChangeuser()

Gibt Benutzer-ID zurück, von dem letzte Änderung durchgeführt wurde

public getChangeuser( ) : int
Return values
int

getComments()

Gibt Artikel-Kommentare aktiv-Status zurück

public getComments( ) : bool
Return values
bool

getApproval()

Gibt Artikel-muss freigeschaltet werden-Status zurück

public getApproval( ) : bool
Return values
bool

getImagepath()

Gibt Pfad zum Artikel-Bild zurück

public getImagepath( ) : string
Tags
since
Return values
string

getEditPermission()

Liefert Status, ob Artikel bearbeitet werden kann zurück

public getEditPermission( ) : bool
Tags
since
Return values
bool

getSources()

Gibt Artikel-Quellen zurück

public getSources( ) : bool
Tags
since
Return values
bool

tweetCreationEnabled()

Tweet-Erstellung aktiv?

public tweetCreationEnabled( ) : bool
Tags
since
Return values
bool

setTitle()

Ttiel setzen

public setTitle( $title : string ) : mixed
Parameters
$title : string
Return values
mixed

setContent()

Inhalt setzen

public setContent( $content : string ) : mixed
Parameters
$content : string
Return values
mixed

setCategories()

Kategorien setzen

public setCategories( $categories : array ) : mixed
Parameters
$categories : array
Return values
mixed

setDraft()

Entwurf-Status setzen

public setDraft( $draft : bool ) : mixed
Parameters
$draft : bool
Return values
mixed

setArchived()

archiviert Status setzen

public setArchived( $archived : bool ) : mixed
Parameters
$archived : bool
Return values
mixed

setPinned()

gepinnt Status

public setPinned( $pinned : bool ) : mixed
Parameters
$pinned : bool
Return values
mixed

setPostponed()

Geplant-Status setzen

public setPostponed( $postponed : bool ) : mixed
Parameters
$postponed : bool
Return values
mixed

setDeleted()

Gelöscht Status setzen

public setDeleted( $deleted : bool ) : mixed
Parameters
$deleted : bool
Return values
mixed

setCreatetime()

Zeitpunk der Erzeugung setzen

public setCreatetime( $createtime : int ) : mixed
Parameters
$createtime : int
Return values
mixed

setCreateuser()

Benutzer der Erzeugung setzen

public setCreateuser( $createuser : int ) : mixed
Parameters
$createuser : int
Return values
mixed

setChangetime()

Zeitpunk der letzten Änderung setzen

public setChangetime( $changetime : int ) : mixed
Parameters
$changetime : int
Return values
mixed

setChangeuser()

Benutzer der letzten Änderung setzen

public setChangeuser( $changeuser : int ) : mixed
Parameters
$changeuser : int
Return values
mixed

setComments()

Kommentar-aktiv-Status setzen

public setComments( $comments : bool ) : mixed
Parameters
$comments : bool
Return values
mixed

setApproval()

Freigabe-Status setzen

public setApproval( $approval : bool ) : mixed
Parameters
$approval : bool
Return values
mixed

setImagepath()

Setzt Pfad zum Artikel-Bild

public setImagepath( $imagepath : string ) : mixed
Parameters
$imagepath : string
Tags
since
Return values
mixed

setSources()

Setzt Artikel-Quellen-Daten

public setSources( $sources : string ) : bool
Parameters
$sources : string
Tags
since
Return values
bool

setEditPermission()

Setzt Status, ob Artikel bearbeitet werden kann

public setEditPermission( $editPermission : bool ) : mixed
Parameters
$editPermission : bool
Tags
since
Return values
mixed

setForceDelete()

Artikel vollständig löschen erzwingen

public setForceDelete( $forceDelete : bool ) : mixed
Parameters
$forceDelete : bool
Return values
mixed

getTweetOverride()

Text für überschriebenes Tweet-Template zurückgeben

public getTweetOverride( ) : string
Tags
since
Return values
string

setTweetOverride()

Text für überschriebenes Tweet-Template setzen

public setTweetOverride( $tweetOverride : string ) : mixed
Parameters
$tweetOverride : string
Tags
since
Return values
mixed

enableTweetCreation()

Tweet-Erstellung aktivieren

public enableTweetCreation( $tweetCreate : bool ) : mixed
Parameters
$tweetCreate : bool
Tags
since
Return values
mixed

getArticleNicePath()

schönen URL-Pfad zurückgeben

public getArticleNicePath( ) : string
Return values
string

getElementLink()

Return frontend article link

public getElementLink( [ $params : string = '' ] ) : string
Parameters
$params : string = ''
Return values
string

getArticleCacheParams()

Link zum Löschen des Artikel-Caches

public getArticleCacheParams( ) : string
Tags
since
Return values
string

getArticleShortLink()

Erzeugt Short-Link zum Artikel zurück

public getArticleShortLink( ) : string
Return values
string

getArticleImage()

Liefert <img>-Tag für Artikel-Image zurück

public getArticleImage( ) : string
Tags
since
Return values
string

delete()

Löscht News in der Datenbank

public delete( ) : bool
Return values
bool

prepareRevision()

Artikel-Daten für Revision vorbereiten

public prepareRevision( ) : mixed
Tags
since
Return values
mixed

createRevision()

Erzeugt eine Revision des Artikels

public createRevision( $timer : int ) : bool
Parameters
$timer : int
Return values
bool

getRevisions()

Gib Revisionen des Artikels zurück

public getRevisions( [ $full : bool = false ] ) : array
Parameters
$full : bool = false

Soll die Revision ganz zurückgegebn werden oder nur Titel

Return values
array

getRevisionsCount()

Anzahl Revisionen des Artikels

public getRevisionsCount( ) : array
Tags
since
Return values
array

getRevision()

Lädt Revision eines Artikels

public getRevision( $revisionTime : int ) : bool
Parameters
$revisionTime : int

Revisions-ID

Return values
bool

restoreRevision()

Stellt Revision eines Artikels wieder her

public restoreRevision( $revisionTime : int ) : bool
Parameters
$revisionTime : int

Revisions-ID

Return values
bool

deleteRevisions()

Löscht Revisionen

public deleteRevisions( [ $revisionList : array = [] ] ) : bool
Parameters
$revisionList : array = []

Liste von Revisions-IDs

Return values
bool

createTweet()

Erzeugt einen Tweet bei Twitter, wenn Verbindung aktiv und Events ausgewählt

public createTweet( [ $force : bool = false ] ) : bool
Parameters
$force : bool = false
Return values
bool

setInEdit()

Sperrt Artikel als in Bearbeitung

public setInEdit( ) : bool
Tags
since
Return values
bool

getInEdit()

In Bearbeitung Informationen auslesen

public getInEdit( ) : array
Tags
since
Return values
array

isInEdit()

Ist Artikel in Bearbeitung

public isInEdit( ) : bool
Tags
since
Return values
bool

publicIsVisible()

Prüft, ob Artikel öffentlich sichtbar ist

public publicIsVisible( ) : bool
Tags
since
Return values
bool

getMetaDataStatusIcons()

Returns array with all status icons

public getMetaDataStatusIcons( $showDraftStatus : bool , $showCommentsStatus : bool , $showArchivedStatus : bool ) : array
Parameters
$showDraftStatus : bool
$showCommentsStatus : bool
$showArchivedStatus : bool
Return values
array

getStatusIconPinned()

Returns pinned status icon

public getStatusIconPinned( ) : icon
Return values
icon

getStatusIconDraft()

Returns draft status icon

public getStatusIconDraft( ) : icon
Return values
icon

getStatusIconPostponed()

Returns postponed status icon

public getStatusIconPostponed( ) : icon
Return values
icon

getStatusIconApproval()

Returns approval status icon

public getStatusIconApproval( ) : icon
Return values
icon

getStatusIconComments()

Returns comments enabled status icon

public getStatusIconComments( ) : icon
Return values
icon

getStatusIconArchive()

Returns archive status icon

public getStatusIconArchive( ) : icon
Return values
icon

removeBannedTexts()

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

protected removeBannedTexts( ) : bool
Tags
since
Return values
bool

cleanupCaches()

Bereinigt Caches

private cleanupCaches( ) : void
Tags
since

getEventModule()

Returns event base string

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

afterSaveInternal()

Is triggered after successful database insert

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

afterUpdateInternal()

Is triggered after successful database update

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

addSourcesAutocomplete()

Add sources string to auto-complete file option, max. 25 values saved

public static addSourcesAutocomplete( $sources : string ) : bool
Parameters
$sources : string
Tags
since
Return values
bool

fetchSourcesAutocomplete()

Fetch sources strings from auto-complete file option

public static fetchSourcesAutocomplete( ) : array
Tags
since
Return values
array

getTableName()

Returns table name based on class name

public final getTableName( ) : string
Tags
since
Return values
string

__construct()

Konstruktor

public __construct( [ $id : int = null ] ) : void
Parameters
$id : int = null

__get()

Magic get

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

__set()

Magic set

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

__toString()

Magic string

public __toString( ) : string
Return values
string

__call()

Magische Methode für nicht vorhandene Methoden

public __call( $name : string , $arguments : mixed ) : bool
Parameters
$name : string
$arguments : mixed
Return values
bool

__callStatic()

Magische Methode für nicht vorhandene, statische Methoden

public static __callStatic( $name : string , $arguments : mixed ) : bool
Parameters
$name : string
$arguments : mixed
Return values
bool

__destruct()

Konstruktor

public __destruct( ) : void

getData()

Gibt Inhalt von "data" zurück

public getData( ) : array
Return values
array

init()

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

public init( ) : bool
Return values
bool

getId()

Gibt Object-ID zurück

public getId( ) : int
Return values
int

setId()

Set dataset id

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

exists()

Prüft ob Objekt existiert

public exists( ) : bool
Return values
bool

getNodata()

Prüft, ob "data" gespeichert werden soll

public getNodata( ) : bool
Return values
bool

setNodata()

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

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

save()

Executes save process to database and events

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

update()

Executes update process to database and events

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

delete()

Löscht ein Objekt in der Datenbank

public delete( ) : bool
Return values
bool

createFromDbObject()

Füllt Objekt mit Daten aus Datenbank-Result

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

getPreparedSaveParams()

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

protected getPreparedSaveParams( ) : array
Return values
array

getPreparedValueParams()

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

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

prepareDataSave()

Bereitet Daten für Speicherung in Datenbank vor

public prepareDataSave( ) : bool
Tags
since
Return values
bool

getEditLink()

Gibt Link für Edit-Action zurück

public getEditLink( ) : string
Return values
string

getEventName()

Returns full event name string

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

getEventModule()

Returns event base string

protected abstract getEventModule( ) : string
Tags
since
Return values
string

afterSaveInternal()

Is triggered after successful database insert

protected afterSaveInternal( ) : bool
Tags
since
Return values
bool

afterUpdateInternal()

Is triggered after successful database update

protected afterUpdateInternal( ) : bool
Tags
since
Return values
bool

Search results