Documentation

VisualThumbnail
in package

A visual thumbnail for a hero content blocker.

Table of Contents

Properties

$height  : int
The height of the thumbnail
$hide  : array<string|int, string>
Can be `overlay` and `title`.
$titleType  : string
Can be `center` or `top`.
$url  : string
The URL to the thumbnail.
$width  : int
The width of the thumbnail

Methods

fromJson()  : self
Generate a `VisualThumbnail` object from an array.
getHeight()  : mixed
Getter.
getHide()  : mixed
Getter.
getTitleType()  : mixed
Getter.
getUrl()  : mixed
Getter.
getWidth()  : mixed
Getter.
setHeight()  : mixed
Setter.
setHide()  : mixed
Setter.
setTitleType()  : mixed
Setter.
setUrl()  : mixed
Setter.
setWidth()  : mixed
Setter.
toJson()  : mixed
Create a JSON representation of this object.

Properties

$hide

Can be `overlay` and `title`.

private array<string|int, string> $hide = []

$titleType

Can be `center` or `top`.

private string $titleType = 'center'

Methods

fromJson()

Generate a `VisualThumbnail` object from an array.

public static fromJson(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Return values
self

getHeight()

Getter.

public getHeight() : mixed
Tags
codeCoverageIgnore

getTitleType()

Getter.

public getTitleType() : mixed
Tags
codeCoverageIgnore

getWidth()

Getter.

public getWidth() : mixed
Tags
codeCoverageIgnore

setHeight()

Setter.

public setHeight(int $height) : mixed
Parameters
$height : int
Tags
codeCoverageIgnore

setHide()

Setter.

public setHide(array<string|int, string> $hide) : mixed
Parameters
$hide : array<string|int, string>
Tags
codeCoverageIgnore

setTitleType()

Setter.

public setTitleType(string $titleType) : mixed
Parameters
$titleType : string
Tags
codeCoverageIgnore

setUrl()

Setter.

public setUrl(string $url) : mixed
Parameters
$url : string
Tags
codeCoverageIgnore

setWidth()

Setter.

public setWidth(int $width) : mixed
Parameters
$width : int
Tags
codeCoverageIgnore

toJson()

Create a JSON representation of this object.

public toJson() : mixed

        
On this page

Search results