class vB5_Template_Runtime

Properties

static $units

Methods

static 
date($timestamp, $format = '', $doyestoday = 1, $adjust = 1)

No description

static 
time($timestamp, $timeformat = '')

No description

static 
datetime($timestamp, $format = 'date, time', $formatdate = '', $formattime = '')

No description

static 
escapeJS($javascript)

No description

static 
numberFormat($number, $decimals = 0)

No description

static 
urlEncode($text)

No description

static 
parsePhrase($phraseName)

No description

static 
fetchStyleVar($stylevar)

No description

static 
fetchCustomStylevar($stylevar, $user = false)

No description

static 
runMaths($str)

No description

static 
linkBuild($type, $info = array(), $extra = array(), $primaryid = null, $primarytitle = null)

No description

static 
parseData()

No description

static 
parseDataWithErrors()

No description

static 
parseAction()

No description

static 
parseJSON()

No description

static 
replaceJSON($search_structure, $all_arguments)

No description

static 
includeTemplate()

No description

static 
includeJs()

No description

static 
includeHeadLink()

No description

static 
includeCss()

No description

static 
includeCssFile()

No description

static 
includeSpriteFile($filename)

This is a no-op here, and is implemented in the core vB_Template_Runtime, since CSS is rendered in the back end via css.php, and the {vb:spritepath} tag is only used in CSS files.

static 
doRedirect($url, $bypasswhitelist = false)

No description

static string
vbdate(string $format, integer $timestamp = 0, boolean $doyestoday = false, boolean $locale = true, boolean $adjust = true, boolean $gmdate = false)

Formats a UNIX timestamp into a human-readable string according to vBulletin prefs

static 
buildUrlAdmincpTemp($route, array $parameters = array())

No description

static type
buildUrl(mixed $route, array $data = array(), array $extra = array(), array $options = array())

Returns the URL for a route with the passed parameters

static 
hook($hookName, $vars = array())

No description

static 
buildVars($select, $master)

No description

static 
nextLevel($res, $array, $master)

No description

static boolean
isBrowser(string $browser, float $version = 0)

Browser detection system - returns whether or not the visiting browser is the one specified

static 
vBVar($value)

No description

static string
parseSchema(array $schemaInfo = array())

No description

static 
debugExit()

Implements {vb:debugexit}, which allows placing a "breakpoint" in a template for debugging purposes.

static string
debugTimer(string $timerName)

Implements {vb:debugtimer}, which allows timing exectution time takes from one call to another.

Details

at line 33
static date($timestamp, $format = '', $doyestoday = 1, $adjust = 1)

Parameters

$timestamp
$format
$doyestoday
$adjust

at line 65
static time($timestamp, $timeformat = '')

Parameters

$timestamp
$timeformat

at line 85
static datetime($timestamp, $format = 'date, time', $formatdate = '', $formattime = '')

Parameters

$timestamp
$format
$formatdate
$formattime

at line 136
static escapeJS($javascript)

Parameters

$javascript

at line 141
static numberFormat($number, $decimals = 0)

Parameters

$number
$decimals

at line 146
static urlEncode($text)

Parameters

$text

at line 151
static parsePhrase($phraseName)

Parameters

$phraseName

at line 856
static fetchStyleVar($stylevar)

Parameters

$stylevar

at line 862
static fetchCustomStylevar($stylevar, $user = false)

Parameters

$stylevar
$user

at line 873
static runMaths($str)

Parameters

$str

at line 942
static linkBuild($type, $info = array(), $extra = array(), $primaryid = null, $primarytitle = null)

Parameters

$type
$info
$extra
$primaryid
$primarytitle

at line 965
static parseData()

at line 982
static parseDataWithErrors()

at line 994
static parseAction()

at line 1012
static parseJSON()

at line 1037
static protected replaceJSON($search_structure, $all_arguments)

Parameters

$search_structure
$all_arguments

at line 1083
static includeTemplate()

at line 1095
static includeJs()

at line 1125
static includeCss()

at line 1158
static includeCssFile()

at line 1171
static includeSpriteFile($filename)

This is a no-op here, and is implemented in the core vB_Template_Runtime, since CSS is rendered in the back end via css.php, and the {vb:spritepath} tag is only used in CSS files.

Parameters

$filename

at line 1176
static doRedirect($url, $bypasswhitelist = false)

Parameters

$url
$bypasswhitelist

at line 1217
static protected string vbdate(string $format, integer $timestamp = 0, boolean $doyestoday = false, boolean $locale = true, boolean $adjust = true, boolean $gmdate = false)

Formats a UNIX timestamp into a human-readable string according to vBulletin prefs

Note: Ifvbdate() is called with a date format other than than one in $vbulletin->options[], set $locale to false unless you dynamically set the date() and strftime() formats in the vbdate() call.

Parameters

string $format Date format string (same syntax as PHP's date() function). It also supports the following vB specific date/time format: 'registered' - Format For Registration Date 'cal1' - Format For Birthdays with Year Specified 'cal2' - Format For Birthdays with Year Unspecified 'event' - Format event start date in the upcoming events module 'log' - Log Date Format
integer $timestamp Unix time stamp
boolean $doyestoday If true, attempt to show strings like "Yesterday, 12pm" instead of full date string
boolean $locale If true, and user has a language locale, use strftime() to generate language specific dates
boolean $adjust If true, don't adjust time to user's adjusted time .. (think gmdate instead of date!)
boolean $gmdate If true, uses gmstrftime() and gmdate() instead of strftime() and date()

Return Value

string Formatted date string

at line 1483
static buildUrlAdmincpTemp($route, array $parameters = array())

Parameters

$route
array $parameters

at line 1524
static type buildUrl(mixed $route, array $data = array(), array $extra = array(), array $options = array())

Returns the URL for a route with the passed parameters

Parameters

mixed $route
  • Route identifier (routeid or name)
array $data
  • Data for building route
array $extra
  • Additional data to be added
array $options
  • Options for building URL - noBaseUrl: skips adding the baseurl - anchor: anchor id to be added

Return Value

type

Exceptions

vB5_Exception_Api

at line 1529
static hook($hookName, $vars = array())

Parameters

$hookName
$vars

at line 1595
static buildVars($select, $master)

Parameters

$select
$master

at line 1621
static nextLevel($res, $array, $master)

Parameters

$res
$array
$master

at line 1644
static boolean isBrowser(string $browser, float $version = 0)

Browser detection system - returns whether or not the visiting browser is the one specified

Parameters

string $browser Browser name (opera, ie, mozilla, firebord, firefox... etc. - see $is array)
float $version Minimum acceptable version for true result (optional)

Return Value

boolean

at line 1811
static vBVar($value)

Parameters

$value

at line 1828
static string parseSchema(array $schemaInfo = array())

Parameters

array $schemaInfo
  • id (string) - itemprop (string) - itemscope (bool) - itemref (string) - itemtype (string) - datetime (int) - tag (string)

Return Value

string

at line 1875
static debugExit()

Implements {vb:debugexit}, which allows placing a "breakpoint" in a template for debugging purposes.

at line 1892
static string debugTimer(string $timerName)

Implements {vb:debugtimer}, which allows timing exectution time takes from one call to another.

Parameters

string $timerName timer name

Return Value

string rendered time