BxDolCover Class Reference

Inheritance diagram for BxDolCover:

Public Member Functions
	__clone ()
	isEnabled ()
	isCover ()
	set ($aOptions, $sTemplateName=false)
	setCoverImageUrl ($mixedCoverImage)
	setCoverClass ($sClass)

Static Public Member Functions
static	getInstance ($oTemplate=false)
static	getCoverImageUrl ($mixedImage)

Detailed Description

Cover.

It displays cover area for different pages, usually it have background image, text and some buttons on it.

Example of usage

Setting cover:

$oCover = BxDolCover::getInstance(); // get object instance
if ($oCover) // check if Cover is available for using
    $oCover->set (array( // set cover with default template
        'title' => 'Hello World!',
    )); 

Member Function Documentation

__clone()

BxDolCover::__clone

(

)

Prevent cloning the instance

getCoverImageUrl()

static BxDolCover::getCoverImageUrl (   $mixedImage )

static

Get cover image URL by descriptive array.

Parameters

mixed

$mixedImage

- image descriptive array.

Returns

string with image URL or false on error.

getInstance()

static BxDolCover::getInstance (   $oTemplate = false )

static

Get Cover object instance

Returns

object instance or false on error

isCover()

BxDolCover::isCover

(

)

Determine whether cover is already set for the page or not.

isEnabled()

BxDolCover::isEnabled

(

)

Determine whether cover is enabled globally or not.

set()

BxDolCover::set	(		$aOptions,
			$sTemplateName = false
	)

Set custom cover options

Parameters

$aOptions

- cover options, default template supports the following: title. For more info

See also

template/cover.html

Parameters

$sTemplateName

- optional template name

setCoverClass()

BxDolCover::setCoverClass

(

$sClass

)

Set cover area class

setCoverImageUrl()

BxDolCover::setCoverImageUrl

(

$mixedCoverImage

)

Set cover image url for default cover template

Parameters

$mixedCoverImageUrl

- cover image url, or array with file id and storage or transcoder object: array('id' => 12, 'object' => 'sample'); // or array('id' => 21, 'transcoder' => 'sample');

---

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

• inc/classes/BxDolCover.php