BlogPost
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, IntegrableElementTrait, PublicatedElementTrait
This is the blog post class.
The information of API blog posts will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $id | Autonumeric element id. | : int |
| $pId | Public and readable element id. | : string |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getBlogger() | Returns the author (blogger) of this blog post. | : Blogger|null |
| getDislikes() | Returns the blog post number of dislikes. | : int |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getHits() | Returns the blog post hits. | : int |
| getId() | Returns the element id. | : int |
| getLanguage() | Returns the blog post language object. | : BlogPostLanguage|null |
| getLargeImage() | Returns the blog post large image. | : string |
| getLikes() | Returns the blog post number of likes. | : int |
| getMainCategory() | Returns the internal identifier of the main category for this blog post. | : int |
| getMainCategoryName() | Returns the name of the main category for this blog post. | : string |
| getPId() | Returns the element public id (pId). | : string |
| getPublicationDate() | Returns the date when the element was publicated. | : Date|null |
| getRates() | Returns the blog post number of rates. | : int |
| getRating() | Returns the blog post average vote. | : float |
| getSmallImage() | Returns the blog post small image. | : string |
| getTags() | Returns the blog post tags. | : array<string|int, mixed> |
| 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
$error
protected
Error|null
$error
= null
$id
Autonumeric element id.
protected
int
$id
= 0
All the given elements by the LogiCommerce API will send it.
$pId
Public and readable element id.
protected
string
$pId
= ''
Setted by the user on LogiCommerce. All the integrable elements by the LogiCommerce API will send it. Useful for integrations and other 3rd party softwares that need to connect to LogiCommerce software.
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 —getBlogger()
Returns the author (blogger) of this blog post.
public
getBlogger() : Blogger|null
Tags
Return values
Blogger|null —getDislikes()
Returns the blog post number of dislikes.
public
getDislikes() : int
Return values
int —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getHits()
Returns the blog post hits.
public
getHits() : int
Return values
int —getId()
Returns the element id.
public
getId() : int
Return values
int —getLanguage()
Returns the blog post language object.
public
getLanguage() : BlogPostLanguage|null
Tags
Return values
BlogPostLanguage|null —getLargeImage()
Returns the blog post large image.
public
getLargeImage() : string
Return values
string —getLikes()
Returns the blog post number of likes.
public
getLikes() : int
Return values
int —getMainCategory()
Returns the internal identifier of the main category for this blog post.
public
getMainCategory() : int
Return values
int —getMainCategoryName()
Returns the name of the main category for this blog post.
public
getMainCategoryName() : string
Return values
string —getPId()
Returns the element public id (pId).
public
getPId() : string
Return values
string —getPublicationDate()
Returns the date when the element was publicated.
public
getPublicationDate() : Date|null
Return values
Date|null —getRates()
Returns the blog post number of rates.
public
getRates() : int
Return values
int —getRating()
Returns the blog post average vote.
public
getRating() : float
Return values
float —getSmallImage()
Returns the blog post small image.
public
getSmallImage() : string
Return values
string —getTags()
Returns the blog post tags.
public
getTags() : array<string|int, mixed>
Return values
array<string|int, mixed> —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