Plugin
extends Element
in package
Uses
ElementTrait, ElementModuleTrait, IdentifiableElementTrait, ElementNameTrait, ElementDescriptionTrait, EnumResolverTrait
This is the User Plugin class.
The API plugins will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $description | : string | |
|---|---|---|
| $error | : Error|null | |
| $id | Autonumeric element id. | : int |
| $module | : string | |
| $name | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getAuthor() | Returns the plugin author. | : string |
| getConnectors() | Returns the plugin connectors. | : array<string|int, mixed> |
| getDate() | Returns the date. | : Date|null |
| getDescription() | Returns the element description on the website current language. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getId() | Returns the element id. | : int |
| getModule() | Returns the element module. | : string |
| getName() | Returns the element name on the website current language. | : string |
| getVersion() | Returns the plugin version. | : string |
| isActive() | Returns if the plugin is actived. | : 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
$description
protected
string
$description
= ''
$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.
$module
protected
string
$module
= ''
$name
protected
string
$name
= ''
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 —getAuthor()
Returns the plugin author.
public
getAuthor() : string
Return values
string —getConnectors()
Returns the plugin connectors.
public
getConnectors() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDate()
Returns the date.
public
getDate() : Date|null
Return values
Date|null —getDescription()
Returns the element description on the website current language.
public
getDescription() : 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 —getModule()
Returns the element module.
public
getModule() : string
Return values
string —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getVersion()
Returns the plugin version.
public
getVersion() : string
Return values
string —isActive()
Returns if the plugin is actived.
public
isActive() : 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