fpcmAPI
in
FanPress CM API, class for integration into a website
Table of Contents
| $controllers | API-Controller | array |
|---|---|---|
| $versionFailed | Ausführung unter PHP 7+ | bool |
| __construct() | Konstruktor, prüft PHP-Version, Installer-Status und Datenbank-Config-Status | void |
| registerController() | Initializes controllers | bool |
| initObjects() | Initialized objects required by system | bool |
| showArticles() | Artikel anzeigen | bool |
| showLatestNews() | Exec Latest News display | bool |
| showPageNumber() | Display current page number | mixed |
| showTitle() | Display title of currently requested article | mixed |
| __call() | PHP-Magic-Methode __call, ruft Event apiCallFunction auf Form: MODULEKEY mit _ statt _ + "_" + FUNCTIONNAME (Bsp.: nkorg_example_foo) | mixed |
| __callStatic() | PHP-Magic-Methode __callStatic, ruft Event apiCallFunction auf Form: MODULEKEY mit _ statt _ + "_" + FUNCTIONNAME (Bsp.: nkorg_example_foo) | mixed |
| loginExternal() | FPCM-Login für externe Anwendungen nutzen | bool|string |
| logoutExternal() | Logout für externe Anwendungen nutzen | bool|string |
| fpcmEnCrypt() | FPCM-interne Verschlüsselung nutzen - Verschlüsseln | string |
| fpcmDeCrypt() | FPCM-interne Verschlüsselung nutzen - Entschlüsseln | string |
| exitOnRequest() | Exit script execution on request | bool |
| showMessagesBox() | Display messages div in frontend | void |
| checkLockedIp() | Check if IP adress is locked | bool |
Properties
$controllers
API-Controller
protected
array
$controllers
= []
$versionFailed
Ausführung unter PHP 7+
protected
bool
$versionFailed
= \false
Methods
__construct()
Konstruktor, prüft PHP-Version, Installer-Status und Datenbank-Config-Status
public
__construct(
)
: void
registerController()
Initializes controllers
private
registerController(
)
: bool
Return values
boolinitObjects()
Initialized objects required by system
private
initObjects(
)
: bool
Tags
Return values
boolshowArticles()
Artikel anzeigen
public
showArticles(
[ $params :
array
= [] ]
)
: bool
Parameters
- $params : array = []
params @see \fpcm\controller\action\pub\showcommon
Return values
boolshowLatestNews()
Exec Latest News display
public
showLatestNews(
[ $params :
array
= [] ]
)
: bool
Parameters
- $params : array = []
params @see \fpcm\controller\action\pub\showlatest
Return values
boolshowPageNumber()
Display current page number
public
showPageNumber(
[ $divider :
string
= "• Page" ]
[, $isUtf8 :
bool
= true ]
)
: mixed
Parameters
- $divider : string = "• Page"
- $isUtf8 : bool = true
Return values
mixedshowTitle()
Display title of currently requested article
public
showTitle(
[ $divider :
string
= "•" ]
[, $isUtf8 :
bool
= true ]
)
: mixed
Parameters
- $divider : string = "•"
- $isUtf8 : bool = true
Return values
mixed__call()
PHP-Magic-Methode __call, ruft Event apiCallFunction auf Form: MODULEKEY mit _ statt _ + "_" + FUNCTIONNAME (Bsp.: nkorg_example_foo)
public
__call(
$name :
string
, $arguments :
array
)
: mixed
Parameters
- $name : string
- $arguments : array
Tags
Return values
mixed__callStatic()
PHP-Magic-Methode __callStatic, ruft Event apiCallFunction auf Form: MODULEKEY mit _ statt _ + "_" + FUNCTIONNAME (Bsp.: nkorg_example_foo)
public
static __callStatic(
$name :
string
, $arguments :
array
)
: mixed
Parameters
- $name : string
- $arguments : array
Tags
Return values
mixedloginExternal()
FPCM-Login für externe Anwendungen nutzen
public
loginExternal(
$credentials :
array
)
: bool|string
Parameters
- $credentials : array
Tags
Return values
bool|stringlogoutExternal()
Logout für externe Anwendungen nutzen
public
logoutExternal(
$sessionId :
string
)
: bool|string
Parameters
- $sessionId : string
Tags
Return values
bool|stringfpcmEnCrypt()
FPCM-interne Verschlüsselung nutzen - Verschlüsseln
public
fpcmEnCrypt(
$value :
string
)
: string
Parameters
- $value : string
Tags
Return values
stringfpcmDeCrypt()
FPCM-interne Verschlüsselung nutzen - Entschlüsseln
public
fpcmDeCrypt(
$value :
string
)
: string
Parameters
- $value : string
Tags
Return values
stringexitOnRequest()
Exit script execution on request
public
exitOnRequest(
$param :
array
)
: bool
Parameters
- $param : array
Tags
Return values
boolshowMessagesBox()
Display messages div in frontend
public
showMessagesBox(
)
: void
Tags
checkLockedIp()
Check if IP adress is locked
public
checkLockedIp(
[ $lockType :
string
= 'noaccess' ]
)
: bool
Parameters
- $lockType : string = 'noaccess'