Documentation

fpcmAPI
in package

FanPress CM API, class for integration into a website

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2021, Stefan Seehafer

license

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

Table of Contents

$controllers  : array<string|int, mixed>
API-Controller
$versionFailed  : bool
Ausführung unter PHP 7+
__call()  : mixed
PHP-Magic-Methode __call, ruft Event apiCallFunction auf Form: MODULEKEY mit _ statt _ + "_" + FUNCTIONNAME (Bsp.: nkorg_example_foo)
__callStatic()  : mixed
PHP-Magic-Methode __callStatic, ruft Event apiCallFunction auf Form: MODULEKEY mit _ statt _ + "_" + FUNCTIONNAME (Bsp.: nkorg_example_foo)
__construct()  : void
Konstruktor, prüft PHP-Version, Installer-Status und Datenbank-Config-Status
checkLockedIp()  : bool
Check if IP adress is locked
exitOnRequest()  : bool
Exit script execution on request
fpcmDeCrypt()  : string
FPCM-interne Verschlüsselung nutzen - Entschlüsseln
fpcmEnCrypt()  : string
FPCM-interne Verschlüsselung nutzen - Verschlüsseln
getPublicJsFile()  : string
Returns url of fanpress/js/fpcm(.min).js
isMaintenance()  : bool
Check if maintenance mode is enabled
loginExternal()  : bool|string
FPCM-Login für externe Anwendungen nutzen
logoutExternal()  : bool|string
Logout für externe Anwendungen nutzen
sendMail()  : bool
Send e-mail via system settings
showArticles()  : bool
Artikel anzeigen
showLatestNews()  : bool
Exec Latest News display
showMessagesBox()  : void
Display messages div in frontend
showPageNumber()  : mixed
Display current page number
showTitle()  : mixed
Display title of currently requested article
initObjects()  : bool
Initialized objects required by system
registerController()  : bool
Initializes controllers

Properties

$controllers

API-Controller

protected array<string|int, mixed> $controllers = []

$versionFailed

Ausführung unter PHP 7+

protected bool $versionFailed = \false

Methods

__call()

PHP-Magic-Methode __call, ruft Event apiCallFunction auf Form: MODULEKEY mit _ statt _ + "_" + FUNCTIONNAME (Bsp.: nkorg_example_foo)

public __call(string $name, array<string|int, mixed> $arguments) : mixed
Parameters
$name : string
$arguments : array<string|int, mixed>
Tags
since
3.1.5
Return values
mixed —

__callStatic()

PHP-Magic-Methode __callStatic, ruft Event apiCallFunction auf Form: MODULEKEY mit _ statt _ + "_" + FUNCTIONNAME (Bsp.: nkorg_example_foo)

public static __callStatic(string $name, array<string|int, mixed> $arguments) : mixed
Parameters
$name : string
$arguments : array<string|int, mixed>
Tags
since
3.1.5
Return values
mixed —

__construct()

Konstruktor, prüft PHP-Version, Installer-Status und Datenbank-Config-Status

public __construct() : void
Return values
void —

checkLockedIp()

Check if IP adress is locked

public checkLockedIp([string $lockType = 'noaccess' ]) : bool
Parameters
$lockType : string = 'noaccess'
Tags
see
iplist::ipIsLocked
since
4.4.1
Return values
bool —

exitOnRequest()

Exit script execution on request

public exitOnRequest(array<string|int, mixed> $param) : bool
Parameters
$param : array<string|int, mixed>
Tags
since
4.3
Return values
bool —

fpcmDeCrypt()

FPCM-interne Verschlüsselung nutzen - Entschlüsseln

public fpcmDeCrypt(string $value) : string
Parameters
$value : string
Tags
since
3.5
Return values
string —

fpcmEnCrypt()

FPCM-interne Verschlüsselung nutzen - Verschlüsseln

public fpcmEnCrypt(string $value) : string
Parameters
$value : string
Tags
since
3.5
Return values
string —

getPublicJsFile()

Returns url of fanpress/js/fpcm(.min).js

public getPublicJsFile() : string
Tags
since
4.5.2
Return values
string —

isMaintenance()

Check if maintenance mode is enabled

public isMaintenance() : bool
Tags
since
4.5.2
Return values
bool —

loginExternal()

FPCM-Login für externe Anwendungen nutzen

public loginExternal(array<string|int, mixed> $credentials) : bool|string
Parameters
$credentials : array<string|int, mixed>
Tags
since
3.4
Return values
bool|string —

logoutExternal()

Logout für externe Anwendungen nutzen

public logoutExternal(string $sessionId) : bool|string
Parameters
$sessionId : string
Tags
since
3.4
Return values
bool|string —

sendMail()

Send e-mail via system settings

public sendMail(array<string|int, mixed> $param) : bool
Parameters
$param : array<string|int, mixed>
Tags
since
4.5.2
Return values
bool —

showArticles()

Artikel anzeigen

public showArticles([array<string|int, mixed> $params = [] ]) : bool
Parameters
$params : array<string|int, mixed> = []

params @see \fpcm\controller\action\pub\showcommon

Return values
bool —

showLatestNews()

Exec Latest News display

public showLatestNews([array<string|int, mixed> $params = [] ]) : bool
Parameters
$params : array<string|int, mixed> = []

params @see \fpcm\controller\action\pub\showlatest

Return values
bool —

showMessagesBox()

Display messages div in frontend

public showMessagesBox() : void
Tags
since
4.4
Return values
void —

showPageNumber()

Display current page number

public showPageNumber([string $divider = "&bull; Page" ][, bool $isUtf8 = true ]) : mixed
Parameters
$divider : string = "&bull; Page"
$isUtf8 : bool = true
Return values
mixed —

showTitle()

Display title of currently requested article

public showTitle([string $divider = "&bull;" ][, bool $isUtf8 = true ]) : mixed
Parameters
$divider : string = "&bull;"
$isUtf8 : bool = true
Return values
mixed —

initObjects()

Initialized objects required by system

private initObjects() : bool
Tags
since
4.2.1
Return values
bool —

registerController()

Initializes controllers

private registerController() : bool
Return values
bool —

Search results