Documentation

smr.inc.php

Table of Contents

Functions

parseBoolean()  : bool
linkCombatLog()  : string
smrBBCode()  : bool|string
Converts a BBCode tag into some other text depending on the tag and value.
inify()  : string
bbify()  : string
create_error()  : never
handleUserError()  : never
create_link()  : string
create_submit_link()  : string
get_colored_text_range()  : string
get_colored_text()  : string
word_filter()  : string
pluralise()  : string
do_voodoo()  : never
This function is a hack around the old style http forward mechanism.
saveAllAndReleaseLock()  : void
doTickerAssigns()  : void
doSkeletonAssigns()  : void
format_list()  : string
Join a list of items into a grammatically-correct sentence fragment.
in_time_or_now()  : string
Convert an integer number of seconds into a human-readable time for grammatically-correct use in a sentence, i.e. prefixed with "in" when the amount is positive.
format_time()  : string
Convert an integer number of seconds into a human-readable time.
number_colour_format()  : string
getWeightedRandom()  : T
Randomly choose an array key weighted by the array values.

Functions

parseBoolean()

parseBoolean(mixed $check) : bool
Parameters
$check : mixed
Return values
bool

linkCombatLog()

linkCombatLog(int $logID) : string
Parameters
$logID : int
Return values
string

smrBBCode()

Converts a BBCode tag into some other text depending on the tag and value.

smrBBCode(BBCode $bbParser, int $action, string $tagName, string $default, array<string, string> $tagParams, string $tagContent) : bool|string

This is called in two stages: first with action BBCODE_CHECK (where the returned value must be a boolean) and second, if the first check passes, with action BBCODE_OUTPUT.

Parameters
$bbParser : BBCode
$action : int
$tagName : string
$default : string
$tagParams : array<string, string>
$tagContent : string
Return values
bool|string

inify()

inify(string $text) : string
Parameters
$text : string
Return values
string

bbify()

bbify(string $message[, int|null $gameID = null ][, bool $noLinks = false ]) : string
Parameters
$message : string
$gameID : int|null = null
$noLinks : bool = false
Return values
string

create_error()

create_error(string $message) : never
Parameters
$message : string
Return values
never

handleUserError()

handleUserError(string $message) : never
Parameters
$message : string
Return values
never

create_link()

create_link(Page|string $container, string $text[, string|null $class = null ]) : string
Parameters
$container : Page|string
$text : string
$class : string|null = null
Return values
string

create_submit_link()

create_submit_link(Page $container, string $text) : string
Parameters
$container : Page
$text : string
Return values
string

get_colored_text_range()

get_colored_text_range(float $value, int $maxValue[, string|null $text = null ][, int $minValue = 0 ]) : string
Parameters
$value : float
$maxValue : int
$text : string|null = null
$minValue : int = 0
Return values
string

get_colored_text()

get_colored_text(float $value[, string|null $text = null ]) : string
Parameters
$value : float
$text : string|null = null
Return values
string

word_filter()

word_filter(string $string) : string
Parameters
$string : string
Return values
string

pluralise()

pluralise(int|float $amount, string $word[, bool $includeAmount = true ]) : string
Parameters
$amount : int|float
$word : string
$includeAmount : bool = true
Return values
string

do_voodoo()

This function is a hack around the old style http forward mechanism.

do_voodoo() : never

It is also responsible for setting most of the global variables (see loader.php for the initialization of the globals).

Return values
never

saveAllAndReleaseLock()

saveAllAndReleaseLock([bool $updateSession = true ]) : void
Parameters
$updateSession : bool = true

format_list()

Join a list of items into a grammatically-correct sentence fragment.

format_list(array<string|int, string> $items) : string
Parameters
$items : array<string|int, string>
Return values
string

in_time_or_now()

Convert an integer number of seconds into a human-readable time for grammatically-correct use in a sentence, i.e. prefixed with "in" when the amount is positive.

in_time_or_now(int $seconds[, bool $short = false ]) : string
Parameters
$seconds : int
$short : bool = false
Return values
string

format_time()

Convert an integer number of seconds into a human-readable time.

format_time(int $seconds[, bool $short = false ]) : string

Seconds are omitted to avoid frequent and disruptive ajax updates. Use short=true to use 1-letter units (e.g. "1h and 3m"). If seconds is negative, will append "ago" to the result. If seconds is zero, will return only "now". If seconds is <60, will prefix "less than" or "<" (HTML-safe).

Parameters
$seconds : int
$short : bool = false
Return values
string

number_colour_format()

number_colour_format(float $number[, bool $justSign = false ]) : string
Parameters
$number : float
$justSign : bool = false
Return values
string

getWeightedRandom()

Randomly choose an array key weighted by the array values.

getWeightedRandom(array<string|int, mixed> $choices) : T

Probabilities are relative to the total weight. For example:

array( 'A' => 1, // 10% chance 'B' => 3, // 30% chance 'C' => 6, // 60% chance );

Parameters
$choices : array<string|int, mixed>
Tags
template

T of array-key

Return values
T 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results