MCI_Footnotes_Convert
Converts data types and Footnotes specific values.
Tags
Table of Contents
- debug() : mixed
- Displays a Variable.
- getArrow() : array<string|int, mixed>|string
- Get a html Array short code depending on Arrow-Array key index.
- Index() : string
- Converts a integer into the user-defined counter style for the footnotes.
- toBool() : bool
- Converts a string depending on its value to a boolean.
- toArabicLeading() : string
- Converts an integer to a leading-0 integer.
- toLatin() : string
- Converts an integer into latin ascii characters, either lower or upper-case.
- toRomanic() : string
- Converts an integer to a romanic letter.
Methods
debug()
Displays a Variable.
public
static debug(mixed $p_mixed_Value) : mixed
Parameters
- $p_mixed_Value : mixed
Tags
Return values
mixed —getArrow()
Get a html Array short code depending on Arrow-Array key index.
public
static getArrow([int $p_int_Index = -1 ]) : array<string|int, mixed>|string
Parameters
- $p_int_Index : int = -1
-
Index representing the Arrow. If empty all Arrows are specified.
Tags
Return values
array<string|int, mixed>|string —Array of all Arrows if Index is empty otherwise html tag of a specific arrow.
Index()
Converts a integer into the user-defined counter style for the footnotes.
public
static Index(int $p_int_Index[, string $p_str_ConvertStyle = "arabic_plain" ]) : string
Parameters
- $p_int_Index : int
-
Index to be converted.
- $p_str_ConvertStyle : string = "arabic_plain"
-
Style of the new/converted Index.
Tags
Return values
string —Converted Index as string in the defined counter style.
Edited:
toBool()
Converts a string depending on its value to a boolean.
public
static toBool(string $p_str_Value) : bool
Parameters
- $p_str_Value : string
-
String to be converted to boolean.
Tags
Return values
bool —Boolean representing the string.
toArabicLeading()
Converts an integer to a leading-0 integer.
private
static toArabicLeading(int $p_int_Value) : string
Parameters
- $p_int_Value : int
-
Value/Index to be converted.
Tags
Return values
string —Value with a leading zero.
toLatin()
Converts an integer into latin ascii characters, either lower or upper-case.
private
static toLatin(int $p_int_Value, bool $p_bool_UpperCase) : string
Function available from A to ZZ ( means 676 footnotes at 1 page possible).
Parameters
- $p_int_Value : int
-
Value/Index to be converted.
- $p_bool_UpperCase : bool
-
True to convert the value to upper case letter, otherwise to lower case.
Tags
Return values
string —toRomanic()
Converts an integer to a romanic letter.
private
static toRomanic(int $p_int_Value, mixed $p_bool_UpperCase) : string
Parameters
- $p_int_Value : int
-
Value/Index to be converted.
- $p_bool_UpperCase : mixed
Tags
Return values
string —Edited: