NewsLanguage
in package
Uses
ElementTrait, ElementLinkAttributesTrait, ElementUrlSeoTrait
This is the News Language class.
The language information of API news will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $linkAttributes | : array<string|int, mixed> | |
|---|---|---|
| $urlSeo | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getLinkAttributes() | Returns the element link attributes URL for the website current language. | : array<string|int, mixed> |
| getPageText() | Returns the news page text on the website current language. | : string |
| getShortText() | Returns the news short text on the website current language. | : string |
| getTitle() | Returns the news title on the website current language. | : 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
$linkAttributes
protected
array<string|int, mixed>
$linkAttributes
= []
$urlSeo
protected
string
$urlSeo
= ''
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 —getLinkAttributes()
Returns the element link attributes URL for the website current language.
public
getLinkAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPageText()
Returns the news page text on the website current language.
public
getPageText() : string
Return values
string —getShortText()
Returns the news short text on the website current language.
public
getShortText() : string
Return values
string —getTitle()
Returns the news title on the website current language.
public
getTitle() : 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