Documentation

shares extends tablelist
in package

Artikel 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

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
$sharesCache  : array<string|int, mixed>
Articles shares count cache
$table  : string
Tabellen-Name
__construct()  : void
Konstruktor
__destruct()  : void
Konstruktor
getAllRegisteredShares()  : array<string|int, mixed>
Get all registered share button providers
getByArticleId()  : array<string|int, mixed>
Fetch share count by article id, item can be give via $item
getRegisteredShares()  : string
Check if a certain share item is registered
getSharesCountByArticles()  : array<string|int, mixed>
Fetch share count sum for all articles

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

$sharesCache

Articles shares count cache

protected array<string|int, mixed> $sharesCache = []
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

getAllRegisteredShares()

Get all registered share button providers

public static getAllRegisteredShares() : array<string|int, mixed>
Tags
since
5.1.0-a1
Return values
array<string|int, mixed>

getByArticleId()

Fetch share count by article id, item can be give via $item

public getByArticleId(int $articleId[, string $item = null ]) : array<string|int, mixed>
Parameters
$articleId : int
$item : string = null
Return values
array<string|int, mixed>

getRegisteredShares()

Check if a certain share item is registered

public static getRegisteredShares(string $item) : string
Parameters
$item : string
Return values
string

getSharesCountByArticles()

Fetch share count sum for all articles

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

Search results