Documentation

tools
in package

FanPress CM internal tools class

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2022, Stefan Seehafer

license

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

since
3.1.2

Table of Contents

calcPagination()  : array<string|int, mixed>
Berechnet Werte für Seitennavigation
calcSize()  : string
Erzeugt für Wert in $value einen String mit passender Einheit und Anzahl Dezimalstellen von Byte (B) bis Terrabyte/Tebibyte (TB/TiB)
escapeFileName()  : string
Escapes filename
getAreaName()  : string
getControllerLink()  : string
Create controller link
getFullControllerLink()  : string
Create controller link
getHash()  : string
Create Hash of $data with @see security::defaultHashAlgo
getMajorMinorReleaseFromString()  : string
Retreives Major.Minor release version from version string of type Major.Minor.Bugfix
getNavigationActiveCheckStr()  : string
String zum Setzen des aktuell aktiven Modules in Navigation
getPageOffset()  : int
Berechnet Limit anhand von Seite und Limit pro Seite
parseLinks()  : string
strReplaceArray()  : array<string|int, mixed>
Array wrapper for str_replace
validateDateString()  : bool
Validates date string

Methods

calcPagination()

Berechnet Werte für Seitennavigation

public static calcPagination(int $pageLimit, int $currentPage, int $maxItemCount, int $currentItemCount) : array<string|int, mixed>
Parameters
$pageLimit : int
$currentPage : int
$maxItemCount : int
$currentItemCount : int
Tags
since
3.4
Return values
array<string|int, mixed>

calcSize()

Erzeugt für Wert in $value einen String mit passender Einheit und Anzahl Dezimalstellen von Byte (B) bis Terrabyte/Tebibyte (TB/TiB)

public static calcSize(number $value[, int $decimals = 2 ][, string $delimDec = ',' ][, string $delimTousands = '.' ]) : string
Parameters
$value : number

ein numerischer Wert

$decimals : int = 2

Anzahl Dezimalstellen, Default = 2

$delimDec : string = ','

Dezimal-Trennzeichen

$delimTousands : string = '.'

Tausender-Trennzeichen

Tags
since
3.1.2
Return values
string

escapeFileName()

Escapes filename

public static escapeFileName(string $filename) : string
Parameters
$filename : string
Return values
string

getAreaName()

public static getAreaName(string $prefix) : string
Parameters
$prefix : string
Tags
since
5.1.0-a1
Return values
string

Create controller link

public static getControllerLink([string $controller = '' ][, array<string|int, mixed> $params = [] ]) : string
Parameters
$controller : string = ''
$params : array<string|int, mixed> = []
Tags
since
3.4
Return values
string

Create controller link

public static getFullControllerLink([string $controller = '' ][, array<string|int, mixed> $params = [] ]) : string
Parameters
$controller : string = ''
$params : array<string|int, mixed> = []
Tags
since
3.4
Return values
string

getHash()

Create Hash of $data with @see security::defaultHashAlgo

public static getHash(string $data) : string
Parameters
$data : string
Return values
string

getMajorMinorReleaseFromString()

Retreives Major.Minor release version from version string of type Major.Minor.Bugfix

public static getMajorMinorReleaseFromString(string $str) : string
Parameters
$str : string
Tags
since
5.1-dev
Return values
string

getNavigationActiveCheckStr()

String zum Setzen des aktuell aktiven Modules in Navigation

public static getNavigationActiveCheckStr() : string
Tags
since
3.5
Return values
string

getPageOffset()

Berechnet Limit anhand von Seite und Limit pro Seite

public static getPageOffset(int $page, int $pageLimit) : int
Parameters
$page : int
$pageLimit : int
Tags
since
3.4
Return values
int
public static parseLinks(string $str) : string
Parameters
$str : string
Tags
since
5.0.0-rc4
Return values
string

strReplaceArray()

Array wrapper for str_replace

public static strReplaceArray(string $subject, array<string|int, mixed> $replacement[, int &$count = NULL ]) : array<string|int, mixed>
Parameters
$subject : string
$replacement : array<string|int, mixed>
$count : int = NULL
Tags
see
str_replace
since
4.4
Return values
array<string|int, mixed>

validateDateString()

Validates date string

public static validateDateString(string $str[, mixed $widthTime = false ]) : bool
Parameters
$str : string
$widthTime : mixed = false
Tags
since
4.4
Return values
bool

Search results