Documentation

articlelist extends tablelist
in package
implements gsearchIndex Uses permissions

FanPress CM Article List Model

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

$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
$permissions  : permissions
Permission Object
$table  : string
Tabellen-Name
__construct()  : void
Konstruktor
__destruct()  : void
Konstruktor
checkArticlesPinnedUntil()  : array<string|int, mixed>
Returns List of pinned articles with date in the past
checkEditPermissions()  : bool
Führt Prüfung durch, ob Artikel bearbeitet werden kann
countArticlesByCondition()  : int
Zählt Artikel anhand von Bedingung
countArticlesByUsers()  : array<string|int, mixed>
Gibt Artikel-Anzahl für jeden Benutzer zurück
deleteArticles()  : bool
Verschiebt Artikel in Papierkorb
deleteArticlesByUser()  : bool
Löscht alle Artikel eines Benutzers
editArticlesByMass()  : mixed
Massenbearbeitung
emptyTrash()  : bool
Empty trash
emptyTrashByDate()  : bool
Empty trash by date
getArticleIDsByUser()  : array<string|int, mixed>
Gibt Liste mit Artikel-IDs für übergebenen Benutzer zurück
getArticlesActive()  : array<string|int, mixed>
Gibt Liste mit allen aktiven Artikeln zurück
getArticlesAll()  : array<string|int, mixed>
Gibt Liste mit allen nicht gelöschten Artikeln zurück
getArticlesArchived()  : array<string|int, mixed>
Gibt Liste mit allen archivierten Artikeln zurück
getArticlesByCondition()  : array<string|int, mixed>
Gibt Liste von Artikeln anhand einer Bedingung zurück
getArticlesDeleted()  : array<string|int, mixed>
Gibt Liste mit allen gelöschten Artikeln zurück (Papierkorb)
getArticlesDraft()  : array<string|int, mixed>
Gibt Liste mit allen gelöschten Artikeln zurück (Papierkorb)
getArticlesPostponed()  : array<string|int, mixed>
Gibt Liste mit allen Artikeln zurück, welche automatisch freigeschalten werden sollen
getArticlesPostponedIDs()  : array<string|int, mixed>
Gibt Liste mit Artikel-IDs zurück, welche automatisch freigeschalten werden sollen
getCountQuery()  : selectParams
Get count query string
getElementIcon()  : icon
Return link icon
getElementLink()  : string
Return link to element link
getMinMaxDate()  : array<string|int, mixed>
Liefert minimalen und maximalen createtime-Timestamp
getRelatedItemsCount()  : array<string|int, mixed>
Fetch counts of comments amnd shares for articles
getSearchQuery()  : selectParams
Get query string
moveArticlesToUser()  : bool
Verschiebt Artikel von einem Benutzer zu einem anderen
prepareText()  : string
Prepare result text
publishPostponedArticles()  : bool
Veröffentlicht Article, die freigeschlaten werden sollen
restoreArticles()  : bool
Stellt Artikel aus Papierkorb wieder her
assignMultipleSearchParams()  : bool
Assigns search params object to value arrays
assignSearchParams()  : bool
Assigns search params from search object to where condition
createListResult()  : 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

$table

Tabellen-Name

protected string $table

Methods

__construct()

Konstruktor

public __construct() : void
Return values
void

__destruct()

Konstruktor

public __destruct() : void
Return values
void

checkArticlesPinnedUntil()

Returns List of pinned articles with date in the past

public checkArticlesPinnedUntil() : array<string|int, mixed>
Tags
since
5.2.0-b4
Return values
array<string|int, mixed>

checkEditPermissions()

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

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

countArticlesByCondition()

Zählt Artikel anhand von Bedingung

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

countArticlesByUsers()

Gibt Artikel-Anzahl für jeden Benutzer zurück

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

deleteArticles()

Verschiebt Artikel in Papierkorb

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

deleteArticlesByUser()

Löscht alle Artikel eines Benutzers

public deleteArticlesByUser(int $userId) : bool
Parameters
$userId : int
Tags
since
3.5.1
Return values
bool

editArticlesByMass()

Massenbearbeitung

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

emptyTrash()

Empty trash

public emptyTrash() : bool
Return values
bool

emptyTrashByDate()

Empty trash by date

public emptyTrashByDate() : bool
Return values
bool

getArticleIDsByUser()

Gibt Liste mit Artikel-IDs für übergebenen Benutzer zurück

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

getArticlesActive()

Gibt Liste mit allen aktiven Artikeln zurück

public getArticlesActive([bool $monthIndex = false ][, array<string|int, mixed> $limits = [] ][, bool $countOnly = false ]) : array<string|int, mixed>
Parameters
$monthIndex : bool = false

Liste mit Monatsindex zurückgeben

$limits : array<string|int, mixed> = []

Anzahl der zurückgegebenen Artikel einschränken array(Start,Anzahl)

$countOnly : bool = false

Verfügbare Artikel nur zählen

Return values
array<string|int, mixed>

getArticlesAll()

Gibt Liste mit allen nicht gelöschten Artikeln zurück

public getArticlesAll([bool $monthIndex = false ][, array<string|int, mixed> $limits = [] ][, bool $countOnly = false ]) : array<string|int, mixed>
Parameters
$monthIndex : bool = false

Liste mit Monatsindex zurückgeben

$limits : array<string|int, mixed> = []

Anzahl der zurückgegebenen Artikel einschränken array(Start,Anzahl)

$countOnly : bool = false

Verfügbare Artikel nur zählen

Return values
array<string|int, mixed>

getArticlesArchived()

Gibt Liste mit allen archivierten Artikeln zurück

public getArticlesArchived([bool $monthIndex = false ][, array<string|int, mixed> $limits = [] ][, bool $countOnly = false ][, bool $dateLimit = false ]) : array<string|int, mixed>
Parameters
$monthIndex : bool = false

Liste mit Monatsindex zurückgeben

$limits : array<string|int, mixed> = []

Anzahl der zurückgegebenen Artikel einschränken array(Start,Anzahl)

$countOnly : bool = false

Verfügbare Artikel nur zählen

$dateLimit : bool = false

Einschränkung auf nach Datum

Return values
array<string|int, mixed>

getArticlesByCondition()

Gibt Liste von Artikeln anhand einer Bedingung zurück

public getArticlesByCondition(search $conditions[, bool $monthIndex = false ]) : array<string|int, mixed>
Parameters
$conditions : search
$monthIndex : bool = false
Return values
array<string|int, mixed>

getArticlesDeleted()

Gibt Liste mit allen gelöschten Artikeln zurück (Papierkorb)

public getArticlesDeleted([bool $monthIndex = false ]) : array<string|int, mixed>
Parameters
$monthIndex : bool = false
Return values
array<string|int, mixed>

getArticlesDraft()

Gibt Liste mit allen gelöschten Artikeln zurück (Papierkorb)

public getArticlesDraft([bool $monthIndex = false ]) : array<string|int, mixed>
Parameters
$monthIndex : bool = false
Return values
array<string|int, mixed>

getArticlesPostponed()

Gibt Liste mit allen Artikeln zurück, welche automatisch freigeschalten werden sollen

public getArticlesPostponed([bool $monthIndex = false ]) : array<string|int, mixed>
Parameters
$monthIndex : bool = false
Return values
array<string|int, mixed>

getArticlesPostponedIDs()

Gibt Liste mit Artikel-IDs zurück, welche automatisch freigeschalten werden sollen

public getArticlesPostponedIDs() : array<string|int, mixed>
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

getMinMaxDate()

Liefert minimalen und maximalen createtime-Timestamp

public getMinMaxDate([int $archived = false ]) : array<string|int, mixed>
Parameters
$archived : int = false
Tags
since
3.3.3
Return values
array<string|int, mixed>

getRelatedItemsCount()

Fetch counts of comments amnd shares for articles

public getRelatedItemsCount([array<string|int, mixed> $ids = [] ]) : array<string|int, mixed>
Parameters
$ids : array<string|int, mixed> = []
Tags
since
4.5
Return values
array<string|int, mixed>

moveArticlesToUser()

Verschiebt Artikel von einem Benutzer zu einem anderen

public moveArticlesToUser(int $userIdFrom, int $userIdTo) : bool
Parameters
$userIdFrom : int
$userIdTo : int
Tags
since
3.5.1
Return values
bool

prepareText()

Prepare result text

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

publishPostponedArticles()

Veröffentlicht Article, die freigeschlaten werden sollen

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

restoreArticles()

Stellt Artikel aus Papierkorb wieder her

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

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 from search object to where condition

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>
Return values
bool

createListResult()

Erzeugt Listen-Result-Array

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

Search results