BxBaseFunctions Class Reference

Inheritance diagram for BxBaseFunctions:

Public Member Functions
	__clone ()
	popupBox ($sName, $sTitle, $sContent, $isHiddenByDefault=false)
	transBox ($sName, $sContent, $isHiddenByDefault=false, $isPlaceInCenter=false)
	getStringWithLimitedLength ($sString, $iWidth=45, $isPopupOnOverflow=false, $bReturnString=true)
	designBoxContent ($sTitle, $sContent, $iTemplateNum=BX_DB_DEF, $mixedMenu=false, $mixedButtons=array())
	getMainLogoUrl ()
	getMainMarkUrl ()
	getMainLogo ($aParams=array())
	getManifests ()
	getMetaIcons ()
	timeForJs ($iUnixTimestamp, $sFormatIdentifier=BX_FORMAT_DATE, $bForceFormat=false)
	timeForJsFullDate ($sDateUTC, $sFormatIdentifier=BX_FORMAT_DATE, $bForceFormat=false, $bUTC=false)
	videoPlayer ($sUrlPoster, $sUrlMP4, $sUrlMP4Hd='', $aAttrs=false, $sStyles=false, $bDynamicMode=false)

Member Function Documentation

__clone()

BxBaseFunctions::__clone

(

)

Prevent cloning the instance

designBoxContent()

BxBaseFunctions::designBoxContent	(		$sTitle,
			$sContent,
			$iTemplateNum = BX_DB_DEF,
			$mixedMenu = false,
			$mixedButtons = array()
	)

Display design box with specified title, template, content and menu.

Parameters

$sTitle	- design box title, please note that some templates don't use title.
$sContent	- design box content.
$iTemplateNum	- number of design box template, use predefined contants only, default is BX_DB_DEF.
$mixedMenu	- design box menu, it can be: object: instance of BxTemplMenu class string: menu object identifier array: array of menu links to create menu from
$mixedButtons	- design box menu representation, it can be: false: design box menu will be used as horizontal menu (tabs) array: array of menu links to create menu from. If empty array is used and 'design box menu' isn't empty, then 'design box menu' will be added as one of menu items automatically. If non-empty array is used and 'design box menu' isn't empty then it should be added as one of menu items. Use array('menu' => 1) to define menu item for 'design box menu'.

Returns

string

See also

BX_DB_CONTENT_ONLY

BX_DB_DEF

BX_DB_EMPTY

BX_DB_NO_CAPTION

BX_DB_PADDING_CONTENT_ONLY

BX_DB_PADDING_DEF

BX_DB_PADDING_NO_CAPTION

getMainLogo()

BxBaseFunctions::getMainLogo

(

$aParams = array()

)

Get logo HTML.

Returns

string

getMainLogoUrl()

BxBaseFunctions::getMainLogoUrl

(

)

Get logo URL.

Returns

string

getMainMarkUrl()

BxBaseFunctions::getMainMarkUrl

(

)

Get mark URL.

Returns

string

getManifests()

BxBaseFunctions::getManifests

(

)

Get HTML code for manifests.

Returns

HTML string to insert into HEAD section

getMetaIcons()

BxBaseFunctions::getMetaIcons

(

)

Get HTML code for meta icons.

Returns

HTML string to insert into HEAD section

getStringWithLimitedLength()

BxBaseFunctions::getStringWithLimitedLength	(		$sString,
			$iWidth = 45,
			$isPopupOnOverflow = false,
			$bReturnString = true
	)

functions for limiting maximal string length

popupBox()

BxBaseFunctions::popupBox	(		$sName,
			$sTitle,
			$sContent,
			$isHiddenByDefault = false
	)

Get standard popup box with title.

Parameters

string	$sName	- unique name
string	$sTitle	- translated title
string	$sContent	- content of the box

Returns

HTML string

timeForJs()

BxBaseFunctions::timeForJs	(		$iUnixTimestamp,
			$sFormatIdentifier = BX_FORMAT_DATE,
			$bForceFormat = false
	)

Output time wrapped in <time> tag in HTML. Then time is autoformatted using JS upon page load, this is aumatically converted to user's timezone and updated in realtime in case of short periods of 'from now' time format.

Short version of this function:

See also

bx_time_js

Parameters

$iUnixTimestamp	time as unixtimestamp
$sFormatIdentifier	output format identifier

See also

BX_FORMAT_DATE

BX_FORMAT_TIME

BX_FORMAT_DATE_TIME

Parameters

$bForceFormat

force provided format and don't use "from now" time autoformat.

timeForJsFullDate()

BxBaseFunctions::timeForJsFullDate	(		$sDateUTC,
			$sFormatIdentifier = BX_FORMAT_DATE,
			$bForceFormat = false,
			$bUTC = false
	)

Same as

See also

timeForJs but instead of unxtimestamp full date format is used (ex: 2005-08-15T15:52:01) as passec date param

transBox()

BxBaseFunctions::transBox	(		$sName,
			$sContent,
			$isHiddenByDefault = false,
			$isPlaceInCenter = false
	)

Get popup box without title.

Parameters

string	$sName	- unique name
string	$sContent	- content of the box

Returns

HTML string

videoPlayer()

BxBaseFunctions::videoPlayer	(		$sUrlPoster,
			$sUrlMP4,
			$sUrlMP4Hd = '',
			$aAttrs = false,
			$sStyles = false,
			$bDynamicMode = false
	)

Ouputs HTML5 video player.

Parameters

$sUrlPoster	video poster image
$sUrlMP4	.mp4 video
$sUrlMP4Hd	.mp4 video in better quality
$aAttrs	custom attributes, defaults are: controls="" preload="none" autobuffer=""
$sStyles	custom styles, defaults are: width:100%; height:auto;

---

The documentation for this class was generated from the following file:

• template/scripts/BxBaseFunctions.php