Documentation

Title

Table of Contents

$caption  : array<string|int, mixed>|RichText|string
Title Caption.
$layout  : Layout|null
Title Layout.
$overlay  : bool
Allow overlay of other elements?
__construct()  : mixed
Create a new Title.
getCaption()  : array<string|int, mixed>|RichText|string
Get caption.
getCaptionText()  : string
getLayout()  : Layout|null
getOverlay()  : bool
Get allow overlay of other elements?
setCaption()  : $this
Set caption.
setOverlay()  : void
Set allow overlay of other elements?

Properties

$caption

Title Caption.

private array<string|int, mixed>|RichText|string $caption = ''

$overlay

Allow overlay of other elements?

private bool $overlay = true

Methods

__construct()

Create a new Title.

public __construct([array<string|int, mixed>|RichText|string $caption = '' ][, Layout|null $layout = null ][, bool $overlay = false ]) : mixed
Parameters
$caption : array<string|int, mixed>|RichText|string = ''
$layout : Layout|null = null
$overlay : bool = false
Return values
mixed

getCaption()

Get caption.

public getCaption() : array<string|int, mixed>|RichText|string
Return values
array<string|int, mixed>|RichText|string

getCaptionText()

public getCaptionText() : string
Return values
string

getOverlay()

Get allow overlay of other elements?

public getOverlay() : bool
Return values
bool

setCaption()

Set caption.

public setCaption(array<string|int, mixed>|RichText|string $caption) : $this
Parameters
$caption : array<string|int, mixed>|RichText|string
Return values
$this

setOverlay()

Set allow overlay of other elements?

public setOverlay(bool $overlay) : void
Parameters
$overlay : bool
Return values
void

Search results