BxBaseCover Class Reference

Inheritance diagram for BxBaseCover:

Public Member Functions
	__construct ($oTemplate)
	display ()
	displayEmpty ()
Public Member Functions inherited from BxDolCover
	__clone ()
	isEnabled ()
	isCover ()
	set ($aOptions, $sTemplateName=false)
	setCoverImageUrl ($mixedCoverImage)
	setCoverClass ($sClass)

Protected Member Functions
	_addJsCss ()

Protected Attributes
	$_bJsCssAdded = false
	$_oTemplate
Protected Attributes inherited from BxDolCover
	$_aOptions = array()
	$_sTemplateName = 'cover.html'
	$_sTemplateNameEmpty = 'cover_empty.html'
	$_sCoverImageUrl = false
	$_aOptiondDefault = array()

Additional Inherited Members
Static Public Member Functions inherited from BxDolCover
static	getInstance ($oTemplate=false)
static	getCoverImageUrl ($mixedImage)
Static Public Member Functions inherited from iBxDolSingleton
static	getInstance ()

Detailed Description

Cover representation.

See also

BxDolCover

Member Function Documentation

_addJsCss()

BxBaseCover::_addJsCss ( )

protected

Add css/js files which are needed for display and functionality.

display()

BxBaseCover::display

(

)

Display Cover.

Hooks:

'system', 'display_cover' - hook to override page cover code to be output

• $unit_name - equals system
• $action - equals display_cover
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • res - [string] by ref, when null the default generation mechanism will be used, can be overridden in hook processing
  • template_name - [string] by ref, template name, can be overridden in hook processing
  • params - [array] by ref, additional params array as key&value pairs, can be overridden in hook processing

HOOKS

'system', 'display_cover' - hook to override page cover code to be output

displayEmpty()

BxBaseCover::displayEmpty

(

)

Display Empty Cover.

---

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

• template/scripts/BxBaseCover.php