BlogSettings
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, EnumResolverTrait
This is the blog settings class.
The information of API blog settings 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 |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getActive() | Sets if the blog is active or not. | : bool |
| getAllowCategorySubscriptions() | Sets if the blog allow category subscriptions or not. | : bool |
| getAllowPostSubscriptions() | Sets if the blog allow post subscriptions or not. | : bool |
| getAllowSubscriptions() | Sets if the blog allow subscriptions or not. | : bool |
| getCommentsMode() | Returns the blog comments mode. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getId() | Returns the element id. | : int |
| getLanguage() | Returns the blog language object. | : BlogSettingsLanguage|null |
| getMaxIpComments() | Returns the blog maximum number of comments per IP. | : int |
| getUserVerificationRequired() | Sets if the blog requires user verification. | : bool |
| 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.
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 —getActive()
Sets if the blog is active or not.
public
getActive() : bool
Return values
bool —getAllowCategorySubscriptions()
Sets if the blog allow category subscriptions or not.
public
getAllowCategorySubscriptions() : bool
Return values
bool —getAllowPostSubscriptions()
Sets if the blog allow post subscriptions or not.
public
getAllowPostSubscriptions() : bool
Return values
bool —getAllowSubscriptions()
Sets if the blog allow subscriptions or not.
public
getAllowSubscriptions() : bool
Return values
bool —getCommentsMode()
Returns the blog comments mode.
public
getCommentsMode() : string
Return values
string —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 —getLanguage()
Returns the blog language object.
public
getLanguage() : BlogSettingsLanguage|null
Tags
Return values
BlogSettingsLanguage|null —getMaxIpComments()
Returns the blog maximum number of comments per IP.
public
getMaxIpComments() : int
Return values
int —getUserVerificationRequired()
Sets if the blog requires user verification.
public
getUserVerificationRequired() : bool
Return values
bool —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