CategoryLanguage extends CategoryLanguage
in package
Uses ElementTrait

This is the Category Language class.

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

Tags
see
CategoryLanguage::getLongDescription()
see
ElementTrait

Table of Contents

$destinationUrl  : string
$indexable  : bool
$largeImage  : string
$largeTitleImage  : string
$linkAttributes  : array<string|int, mixed>
$linkFollowing  : bool
$name  : string
$shortDescription  : string
$smallImage  : string
$smallTitleImage  : string
$target  : string
$urlSeo  : string
__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getDestinationUrl() Returns the category destination URL for the website current language.  : string
getIndexable() Returns if the element is indexable on the website current language.  : bool
getLargeImage() Returns the category large image for the website current language.  : string
getLargeTitleImage() Returns the category large title for the website current language.  : string
getLink() Returns the element value for the href attribute. This will return destinationUrl if filled or urlSeo.  : string
getLinkAttributes() Returns the element link attributes URL for the website current language.  : array<string|int, mixed>
getLinkFollowing() Sets if the element link must be a following one or not (value of rel HTML attribute) for the website current language.  : bool
getLongDescription() Returns the category long description for the website current language.  : string
getName() Returns the element name on the website current language.  : string
getShortDescription() Returns the category short description for the website current language.  : string
getSmallImage() Returns the category small image for the website current language.  : string
getSmallTitleImage() Returns the title for the category small image for the website current language.  : string
getTarget() Returns the element target (attribute of <a> HTML entity).  : string
getUrlSeo() Returns the element SEO URL for the website current language.  : 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>

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

getDestinationUrl()

Returns the category destination URL for the website current language.

public getDestinationUrl() : string
Return values
string

getIndexable()

Returns if the element is indexable on the website current language.

public getIndexable() : bool
Return values
bool

getLargeImage()

Returns the category large image for the website current language.

public getLargeImage() : string
Return values
string

getLargeTitleImage()

Returns the category large title for the website current language.

public getLargeTitleImage() : string
Return values
string

Returns the element value for the href attribute. This will return destinationUrl if filled or urlSeo.

public getLink() : string
Return values
string

getLinkAttributes()

Returns the element link attributes URL for the website current language.

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

getLinkFollowing()

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

public getLinkFollowing() : bool
Return values
bool

getLongDescription()

Returns the category long description for the website current language.

public getLongDescription() : string
Return values
string

getName()

Returns the element name on the website current language.

public getName() : string
Return values
string

getShortDescription()

Returns the category short description for the website current language.

public getShortDescription() : string
Return values
string

getSmallImage()

Returns the category small image for the website current language.

public getSmallImage() : string
Return values
string

getSmallTitleImage()

Returns the title for the category small image for the website current language.

public getSmallTitleImage() : string
Return values
string

getTarget()

Returns the element target (attribute of <a> HTML entity).

public getTarget() : string
Return values
string

getUrlSeo()

Returns the element SEO URL for the website current language.

public getUrlSeo() : 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>

Search results