Documentation

commentList extends tablelist
in package
implements gsearchIndex Uses permissions

Kommentar-Listen-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

gsearchIndex
FanPress CM Model global search indexer

Table of Contents

$articleList  : articlelist
articlelist Objekt
$cache  : cache
System-Cache
$cacheModule  : string
Cache Modul
$cacheName  : string
Cache name
$config  : config
System-Config-Objekt
$data  : array<string|int, mixed>
Data array
$dbcon  : database
DB-Verbindung
$events  : events
Event-Liste
$language  : language
System-Sprachen-Objekt
$notifications  : notifications
Notifications
$ownArticleIds  : array<string|int, mixed>
Liste mit IDs von Artikeln, die vom aktuelle Benutzer verschrieben wurden
$permissions  : permissions
Permission Object
$table  : string
Tabellen-Name
__construct()  : void
Konstruktor
__destruct()  : void
Konstruktor
checkEditPermissions()  : bool
Führt Prüfung durch, ob Artikel bearbeitet werden kann
countComments()  : bool
Zählt Kommentare für alle Artikel
countCommentsByCondition()  : int
Zählt Kommentare anhand von Bedingung
countUnapprovedPrivateComments()  : array<string|int, mixed>
Zählt Kommentare für alle Artikel, die Privat oder nicht genehmigt sind
deleteComments()  : bool
Löscht Kommentare
deleteCommentsByArticle()  : bool
Löscht Kommentare für einen Artikel mit übergebener/n ID(s)
editCommentsByMass()  : mixed
Massenbearbeitung
emptyTrash()  : bool
Empty trash bin
emptyTrashByDate()  : bool
Empty trash by date
getCommentsAll()  : array<string|int, mixed>
Liefert ein array aller Kommentare
getCommentsByCondition()  : array<string|int, mixed>
Liefert ein array der Kommentare, welcher mit der Bedingung übereinstimmen
getCommentsBySearchCondition()  : array<string|int, mixed>
Liefert ein array der Kommentare, welcher mit der Bedingung übereinstimmen
getCountQuery()  : selectParams
Get count query string
getElementIcon()  : icon
Return link icon
getElementLink()  : string
Return link to element link
getLastCommentTimeByIP()  : int
Gibt Zeit zurück, wenn von der aktuellen IP der letzte Kommentar geschrieben wurde
getNewCommentCount()  : int
Checks for new comments
getSearchQuery()  : selectParams
Get query string
prepareText()  : string
Prepare result text
retoreComments()  : bool
Empty trash bin
spamExistsbyCommentData()  : bool
Prüft ob für die in Daten eines neuen Kommentars bereits Kommentare als Spam markiert wurden
assignMultipleSearchParams()  : bool
Assigns search params object to value arrays
assignSearchParams()  : bool
Assigns search params object to value arrays
createCommentResult()  : array<string|int, mixed>
Erzeugt Listen-Result-Array
getSearchQueryObj()  : selectParams
Returns selectParams object instance

Properties

$cacheModule

Cache Modul

protected string $cacheModule = ''
Tags
since
3.4

$cacheName

Cache name

protected string $cacheName = false

$data

Data array

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

$ownArticleIds

Liste mit IDs von Artikeln, die vom aktuelle Benutzer verschrieben wurden

protected array<string|int, mixed> $ownArticleIds = false
Tags
since
3.3

$table

Tabellen-Name

protected string $table

Methods

__construct()

Konstruktor

public __construct() : void
Return values
void

__destruct()

Konstruktor

public __destruct() : void
Return values
void

checkEditPermissions()

Führt Prüfung durch, ob Artikel bearbeitet werden kann

public checkEditPermissions(comment &$comment) : bool
Parameters
$comment : comment
Return values
bool

countComments()

Zählt Kommentare für alle Artikel

public countComments([array<string|int, mixed> $articleIds = [] ][, bool $private = null ][, bool $approved = null ][, bool $spam = null ][, bool $getCached = true ]) : bool
Parameters
$articleIds : array<string|int, mixed> = []
$private : bool = null
$approved : bool = null
$spam : bool = null
$getCached : bool = true
Return values
bool

countCommentsByCondition()

Zählt Kommentare anhand von Bedingung

public countCommentsByCondition(search $conditions) : int
Parameters
$conditions : search
Return values
int

countUnapprovedPrivateComments()

Zählt Kommentare für alle Artikel, die Privat oder nicht genehmigt sind

public countUnapprovedPrivateComments([array<string|int, mixed> $articleIds = [] ]) : array<string|int, mixed>
Parameters
$articleIds : array<string|int, mixed> = []
Return values
array<string|int, mixed>

deleteComments()

Löscht Kommentare

public deleteComments(array<string|int, mixed> $ids) : bool
Parameters
$ids : array<string|int, mixed>
Return values
bool

deleteCommentsByArticle()

Löscht Kommentare für einen Artikel mit übergebener/n ID(s)

public deleteCommentsByArticle(int|array<string|int, mixed> $article_ids) : bool
Parameters
$article_ids : int|array<string|int, mixed>
Return values
bool

editCommentsByMass()

Massenbearbeitung

public editCommentsByMass(array<string|int, mixed> $commentIds, array<string|int, mixed> $fields) : mixed
Parameters
$commentIds : array<string|int, mixed>
$fields : array<string|int, mixed>
Tags
since
3.6
Return values
mixed

emptyTrash()

Empty trash bin

public emptyTrash() : bool
Return values
bool

emptyTrashByDate()

Empty trash by date

public emptyTrashByDate() : bool
Return values
bool

getCommentsAll()

Liefert ein array aller Kommentare

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

getCommentsByCondition()

Liefert ein array der Kommentare, welcher mit der Bedingung übereinstimmen

public getCommentsByCondition(int $articleId, bool $private[, bool $hideUnapproved = 1 ], bool $spam) : array<string|int, mixed>
Parameters
$articleId : int

Artikel-ID

$private : bool

private Kommentare ja/nein

$hideUnapproved : bool = 1

genehmigte Kommentare ja/nein

$spam : bool

als Spam markierte Kommentare ja/nein

Return values
array<string|int, mixed>

getCommentsBySearchCondition()

Liefert ein array der Kommentare, welcher mit der Bedingung übereinstimmen

public getCommentsBySearchCondition(search $conditions) : array<string|int, mixed>
Parameters
$conditions : search
Return values
array<string|int, mixed>

getElementIcon()

Return link icon

public getElementIcon() : icon
Tags
since
5.1-dev
Return values
icon

Return link to element link

public getElementLink(mixed $id) : string
Parameters
$id : mixed
Tags
since
5.1-dev
Return values
string

getLastCommentTimeByIP()

Gibt Zeit zurück, wenn von der aktuellen IP der letzte Kommentar geschrieben wurde

public getLastCommentTimeByIP() : int
Return values
int

getNewCommentCount()

Checks for new comments

public getNewCommentCount() : int
Tags
since
5.1.0-a1
Return values
int

prepareText()

Prepare result text

public prepareText(string $text) : string
Parameters
$text : string
Return values
string

retoreComments()

Empty trash bin

public retoreComments(array<string|int, mixed> $ids) : bool
Parameters
$ids : array<string|int, mixed>

Description

Return values
bool

spamExistsbyCommentData()

Prüft ob für die in Daten eines neuen Kommentars bereits Kommentare als Spam markiert wurden

public spamExistsbyCommentData(comment $comment) : bool
Parameters
$comment : comment
Return values
bool

true, wenn Anzahl größer als in $this->config->comments_markspam_commentcount definiert

assignMultipleSearchParams()

Assigns search params object to value arrays

private assignMultipleSearchParams(search $conditions, array<string|int, mixed> &$where, array<string|int, mixed> &$valueParams) : bool
Parameters
$conditions : search
$where : array<string|int, mixed>
$valueParams : array<string|int, mixed>
Tags
since
4.3
Return values
bool

assignSearchParams()

Assigns search params object to value arrays

private assignSearchParams(search $conditions, array<string|int, mixed> &$where, array<string|int, mixed> &$valueParams) : bool
Parameters
$conditions : search
$where : array<string|int, mixed>
$valueParams : array<string|int, mixed>
Tags
since
4.3
Return values
bool

createCommentResult()

Erzeugt Listen-Result-Array

private createCommentResult(array<string|int, mixed> $list) : array<string|int, mixed>
Parameters
$list : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results