ProductComparison extends Element
in package
Uses ElementTrait

This is the Product Comparison class.

Information for each custom tag group that contains comparable custom tags associated to the product comparison products. In case the custom tag group depends on another, all the parent groups up to the root are recursively included to make up the complete path.

Tags
see
ProductComparison::getPriority()
see
ProductComparison::getPosition()
see
ProductComparison::getComparable()
see
ProductComparison::getParentId()
see
ProductComparison::getCustomTags()
see
Element
uses
ElementTrait

Table of Contents

$error  : Error|null
__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getCustomTagGroups() Returns the element customTagGroups.  : array<string|int, ProductComparisonCustomTagGroup>
getCustomTagsWithoutGroup() Returns the element customTagsWithoutGroup.  : array<string|int, ProductComparisonCustomTagGroupCustomTag>
getError() Returns the current element error (if there is error).  : Error|null
getItems() Returns the element items.  : array<string|int, Product>
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>
setCustomTagGroups()  : void
setCustomTagsWithoutGroup()  : void
setError()  : void
setItems()  : void

Properties

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 —

getError()

Returns the current element error (if there is error).

public getError() : Error|null
Return values
Error|null —

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> —

setCustomTagGroups()

protected setCustomTagGroups(array<string|int, mixed> $customTagGroups) : void
Parameters
$customTagGroups : array<string|int, mixed>
Return values
void —

setCustomTagsWithoutGroup()

protected setCustomTagsWithoutGroup(array<string|int, mixed> $customTagsWithoutGroup) : void
Parameters
$customTagsWithoutGroup : array<string|int, mixed>
Return values
void —

setError()

protected setError(mixed $error) : void
Parameters
$error : mixed
Return values
void —

setItems()

protected setItems(array<string|int, mixed> $items) : void
Parameters
$items : array<string|int, mixed>
Return values
void —

Search results