Page
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, IntegrableElementTrait, CustomTagValuesTrait, EnumResolverTrait
This is the Page class.
The information of API pages will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $active | : bool | |
|---|---|---|
| $customTagValues | : array<string|int, mixed> | |
| $customType | : string | |
| $error | : Error|null | |
| $id | Autonumeric element id. | : int |
| $itemId | : int | |
| $language | : PageLanguage|null | |
| $pagesGroupId | : int | |
| $pageType | : string | |
| $parentPageId | : int | |
| $pId | Public and readable element id. | : string |
| $position | : int | |
| $priority | : int | |
| $subpages | : array<string|int, mixed> | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getActive() | Sets if the page is active or not. | : bool |
| getAdditionalData() | Returns the particular content of the page type. | : null |
| getCustomTagValues() | Returns the element custom tag values. | : array<string|int, CustomTagValue> |
| getCustomType() | Returns the page custom type. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getId() | Returns the element id. | : int |
| getItemId() | Returns the page item id. | : int |
| getLanguage() | Returns the page language object. | : PageLanguage|null |
| getPagesGroupId() | Returns the pages group id where this page belongs. | : int |
| getPageType() | Returns the page type. | : string |
| getParentPageId() | Returns the parent page id. | : int |
| getPId() | Returns the element public id (pId). | : string |
| getPosition() | Returns the page position. | : int |
| getPriority() | Returns the page priority. | : int |
| getSubpages() | Returns the subpages of this page. | : array<string|int, Page> |
| 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> |
| setCustomTagValues() | : void | |
| setError() | : void | |
| setLanguage() | : void | |
| setSubpages() | : void |
Properties
$active
protected
bool
$active
= false
$customTagValues
protected
array<string|int, mixed>
$customTagValues
= []
$customType
protected
string
$customType
= ''
$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.
$itemId
protected
int
$itemId
= 0
$language
protected
PageLanguage|null
$language
= null
$pagesGroupId
protected
int
$pagesGroupId
= 0
$pageType
protected
string
$pageType
= ''
$parentPageId
protected
int
$parentPageId
= 0
$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.
$position
protected
int
$position
= 0
$priority
protected
int
$priority
= 0
$subpages
protected
array<string|int, mixed>
$subpages
= []
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 page is active or not.
public
getActive() : bool
Return values
bool —getAdditionalData()
Returns the particular content of the page type.
public
getAdditionalData() : null
For main type (Page) it always will return null
Return values
null —getCustomTagValues()
Returns the element custom tag values.
public
getCustomTagValues() : array<string|int, CustomTagValue>
Return values
array<string|int, CustomTagValue> —getCustomType()
Returns the page custom type.
public
getCustomType() : string
Only filled if pageType require this to work properly.
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 —getItemId()
Returns the page item id.
public
getItemId() : int
Only filled if pageType require this to work properly.
Return values
int —getLanguage()
Returns the page language object.
public
getLanguage() : PageLanguage|null
Tags
Return values
PageLanguage|null —getPagesGroupId()
Returns the pages group id where this page belongs.
public
getPagesGroupId() : int
Return values
int —getPageType()
Returns the page type.
public
getPageType() : string
Return values
string —getParentPageId()
Returns the parent page id.
public
getParentPageId() : int
Return values
int —getPId()
Returns the element public id (pId).
public
getPId() : string
Return values
string —getPosition()
Returns the page position.
public
getPosition() : int
Return values
int —getPriority()
Returns the page priority.
public
getPriority() : int
Return values
int —getSubpages()
Returns the subpages of this page.
public
getSubpages() : array<string|int, Page>
Return values
array<string|int, Page> —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> —setCustomTagValues()
protected
setCustomTagValues(array<string|int, mixed> $customTagValues) : void
Parameters
- $customTagValues : array<string|int, mixed>
Return values
void —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed
Return values
void —setLanguage()
protected
setLanguage(array<string|int, mixed> $language) : void
Parameters
- $language : array<string|int, mixed>
Return values
void —setSubpages()
protected
setSubpages(array<string|int, mixed> $subpages) : void
Parameters
- $subpages : array<string|int, mixed>