RelatedItems extends Element
in package
Uses ElementTrait, ElementNameTrait, ElementModuleTrait, EnumResolverTrait

This is the Related Items class.

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

Tags
see
RelatedItems::getImage()
see
RelatedItems::getBanners()
see
RelatedItems::getCategories()
see
RelatedItems::getNews()
see
RelatedItems::getPages()
see
RelatedItems::getProducts()
see
RelatedItems::getPosts()
see
Element
see
ElementTrait
see
ElementNameTrait

Table of Contents

$error  : Error|null
$module  : string
$name  : string
__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getBanners() Returns the banners into the related section.  : array<string|int, Banner>
getCategories() Returns the categories into the related section.  : array<string|int, Category>
getError() Returns the current element error (if there is error).  : Error|null
getImage() Returns the related section image.  : string
getModule() Returns the element module.  : string
getName() Returns the element name on the website current language.  : string
getNews() Returns the news into the related section.  : array<string|int, News>
getPages() Returns the pages into the related section.  : array<string|int, Page>
getPosition() Returns the related section position.  : int
getPosts() Returns the posts into the related section.  : array<string|int, BlogPost>
getProducts() Returns the products into the related section.  : array<string|int, Product>
getType() Returns the related section type.  : string
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>
setError()  : void

Properties

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 —

getBanners()

Returns the banners into the related section.

public getBanners() : array<string|int, Banner>
Return values
array<string|int, Banner> —

getCategories()

Returns the categories into the related section.

public getCategories() : array<string|int, Category>
Return values
array<string|int, Category> —

getError()

Returns the current element error (if there is error).

public getError() : Error|null
Return values
Error|null —

getImage()

Returns the related section image.

public getImage() : string
Return values
string —

getModule()

Returns the element module.

public getModule() : string
Return values
string —

getName()

Returns the element name on the website current language.

public getName() : string
Return values
string —

getNews()

Returns the news into the related section.

public getNews() : array<string|int, News>
Return values
array<string|int, News> —

getPages()

Returns the pages into the related section.

public getPages() : array<string|int, Page>
Return values
array<string|int, Page> —

getPosition()

Returns the related section position.

public getPosition() : int
Return values
int —

getPosts()

Returns the posts into the related section.

public getPosts() : array<string|int, BlogPost>
Return values
array<string|int, BlogPost> —

getProducts()

Returns the products into the related section.

public getProducts() : array<string|int, Product>
Return values
array<string|int, Product> —

getType()

Returns the related section type.

public getType() : string
Return values
string —

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> —

setError()

protected setError(mixed $error) : void
Parameters
$error : mixed
Return values
void —

Search results