Comment
extends Comment
in package
Uses
ElementTrait, IdentifiableElementTrait, DateAddedTrait
This is the comment class.
The product comments will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $answers | : array<string|int, mixed> | |
|---|---|---|
| $comment | : string | |
| $error | : Error|null | |
| $id | Autonumeric element id. | : int |
| $nick | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getAnswers() | Returns the blog post comment answers. | : array<string|int, mixed> |
| getComment() | Returns the comment content. | : string |
| getDateAdded() | Returns the date when the element was added. | : Date|null |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getId() | Returns the element id. | : int |
| getNick() | Returns the blog post comment nick. | : string |
| getRating() | Returns the comment's punctuation. | : int |
| 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 | |
| setAnswers() | : void | |
| setArrayField() | Convert an API array of objects to a PHP array of objects. | : array<string|int, mixed> |
| setError() | : void |
Properties
$answers
protected
array<string|int, mixed>
$answers
= []
$comment
protected
string
$comment
= ''
$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.
$nick
protected
string
$nick
= ''
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 —getAnswers()
Returns the blog post comment answers.
public
getAnswers() : array<string|int, mixed>
Return values
array<string|int, mixed> —getComment()
Returns the comment content.
public
getComment() : string
Return values
string —getDateAdded()
Returns the date when the element was added.
public
getDateAdded() : Date|null
Return values
Date|null —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getId()
Returns the element id.
public
getId() : int
Return values
int —getNick()
Returns the blog post comment nick.
public
getNick() : string
Return values
string —getRating()
Returns the comment's punctuation.
public
getRating() : int
Return values
int —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 —setAnswers()
protected
setAnswers(array<string|int, mixed> $answers) : void
Parameters
- $answers : array<string|int, mixed>
Return values
void —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