BannerLanguage
in package
Uses ElementTrait

This is the Banner Language class.

The language information of API banners will be stored in that class and will remain immutable (only get methods are available)

Tags
see
BannerLanguage::getAlt()
see
BannerLanguage::getImage()
see
BannerLanguage::getDestinationUrl()
see
BannerLanguage::getLinkFollowing()
see
ElementTrait

Table of Contents

__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getAlt() Returns the banner alt attribute for the website current language.  : string
getDestinationUrl() Returns the banner destination URL for the website current language.  : string
getImage() Returns the banner image for the website current language.  : string
getLinkFollowing() Sets if the banner link must be a following one or not (value of rel HTML attribute) for the website current language.  : bool
jsonSerialize() Allow elements to be serialized.  : array<string|int, mixed>
toArray() Used to allow elements to be serialized.  : array<string|int, mixed>
getFieldItem()  : object|null
getFormattedData()  : mixed
setArrayField() Convert an API array of objects to a PHP array of objects.  : array<string|int, mixed>

Methods

__construct()

Elements constructor.

public __construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
$data : array<string|int, mixed> = []

Array that contains all the values to the object to initialize

Return values
mixed —

__toString()

Uses "json_encode" function to return the JSON format of the element.

public __toString() : string

Auto-invoked using echo or concatenations.

Return values
string —

getAlt()

Returns the banner alt attribute for the website current language.

public getAlt() : string
Return values
string —

getDestinationUrl()

Returns the banner destination URL for the website current language.

public getDestinationUrl() : string
Return values
string —

getImage()

Returns the banner image for the website current language.

public getImage() : string
Return values
string —

getLinkFollowing()

Sets if the banner link must be a following one or not (value of rel HTML attribute) for the website current language.

public getLinkFollowing() : bool
Return values
bool —

jsonSerialize()

Allow elements to be serialized.

public jsonSerialize() : array<string|int, mixed>

Auto-invoked using "json_encode" function.

Return values
array<string|int, mixed> —

toArray()

Used to allow elements to be serialized.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getFieldItem()

protected getFieldItem(array<string|int, mixed> $item, string $class) : object|null
Parameters
$item : array<string|int, mixed>
$class : string
Return values
object|null —

getFormattedData()

protected getFormattedData(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

setArrayField()

Convert an API array of objects to a PHP array of objects.

protected setArrayField(array<string|int, mixed> $data, string $class) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Array that contains all the values to the objects to initialize

$class : string

The PHP class we want the objects to be

Return values
array<string|int, mixed> —

Search results