UserGroup
in package
Uses
ElementTrait, IdentifiableElementTrait, IntegrableElementTrait, ElementNameTrait, ElementDescriptionTrait
This is the user group main class.
The user group information will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $description | : string | |
|---|---|---|
| $id | Autonumeric element id. | : int |
| $name | : string | |
| $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 |
| getDefaultGroup() | Returns if this group is the default one for new users or not. | : bool |
| getDescription() | Returns the element description on the website current language. | : string |
| getId() | Returns the element id. | : int |
| getName() | Returns the element name on the website current language. | : string |
| getPId() | Returns the element public id (pId). | : string |
| getSystemGroup() | Returns if this group is a system group (administrators group). | : 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> |
Properties
$description
protected
string
$description
= ''
$id
Autonumeric element id.
protected
int
$id
= 0
All the given elements by the LogiCommerce API will send it.
$name
protected
string
$name
= ''
$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 —getDefaultGroup()
Returns if this group is the default one for new users or not.
public
getDefaultGroup() : bool
Return values
bool —getDescription()
Returns the element description on the website current language.
public
getDescription() : string
Return values
string —getId()
Returns the element id.
public
getId() : int
Return values
int —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getPId()
Returns the element public id (pId).
public
getPId() : string
Return values
string —getSystemGroup()
Returns if this group is a system group (administrators group).
public
getSystemGroup() : 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