ProductsParametersGroup
extends ParametersGroup
in package
Uses
IdentifiableItemsParametersGroupTrait, PaginableItemsParametersGroupTrait, FilterIndexableParametersGroupTrait
This is the products model parameters group class.
Table of Contents
| $addDefaultOptionsPrice | : bool | |
|---|---|---|
| $brandId | : int | |
| $brandsList | : string | |
| $categoryId | : int | |
| $categoryIdList | : string | |
| $categoryPId | : string | |
| $customTagsSearchList | : string | |
| $customTagsSearchType | : string | |
| $defaultOptionsPriceSort | : string | |
| $filterIndexable | : string | |
| $fromPrice | : float | |
| $id | : int | |
| $idList | : string | |
| $includeSubcategories | : bool | |
| $onlyFeatured | : bool | |
| $onlyOffers | : bool | |
| $optionsPriceMode | : string | |
| $page | : int | |
| $perPage | : int | |
| $pId | : string | |
| $portalId | : int | |
| $q | : string | |
| $qDeep | : string | |
| $qType | : string | |
| $randomItems | : int | |
| $sort | : string | |
| $sortByIdList | : string | |
| $stockType | : string | |
| $thirdPartySort | : bool | |
| $toPrice | : float | |
| $validator | : ParametersValidator | |
| addFilterCustomTag() | Sets a new custom tag filter for this parameters group. | : void |
| addFilterCustomTagInterval() | Sets a new custom tag interval filter for this parameters group. | : void |
| addFilterOption() | Sets a new option filter for this parameters group. | : void |
| getFilterIndexable() | Returns the filter indexable parameter value. | : string |
| setAddDefaultOptionsPrice() | Sets whether to return the prices of the default products options. | : void |
| setBrandId() | Sets a brand internal identifier for this parameters group. | : void |
| setBrandsList() | Sets a list of brands internal identifiers for this parameters group. | : void |
| setCategoryId() | Sets a category internal identifier for this parameters group. | : void |
| setCategoryIdList() | Sets the public category identifier parameter for this parameters group. | : void |
| setCategoryPId() | Sets a list of categories internal identifiers for this parameters group. | : void |
| setCustomTagsSearchList() | Sets a list of custom tags internal identifiers were the API must search. | : void |
| setCustomTagsSearchType() | Sets the type of the custom tags search query parameter for this parameters group. | : void |
| setDefaultOptionsPriceSort() | Sets the default order of the products options. | : void |
| setFilterIndexable() | Sets the filter indexable parameter for this parameters group. | : void |
| setFromPrice() | Sets the minimum price parameter for this parameters group. | : void |
| setId() | Sets the internal identifier parameter for this parameters group. | : void |
| setIdList() | Sets a list of internal identifiers for this parameters group. | : void |
| setIncludeSubcategories() | Sets if the elements will be filtered using this parameters group in function of if they are on subcategories. | : void |
| setOnlyFeatured() | Sets if the elements will be filtered using this parameters group in function of if they are featured. | : void |
| setOnlyOffers() | Sets if the elements will be filtered using this parameters group in function of if they are on offer. | : void |
| setOptionsPriceMode() | Sets a the prices sort criteria for this parameters group. | : void |
| setPage() | Sets the page parameter for this parameters group. | : void |
| setPerPage() | Sets the per page parameter for this parameters group. | : void |
| setPId() | Sets the public identifier parameter for this parameters group. | : void |
| setPortalId() | Sets the portal internal identifier parameter for this parameters group. | : void |
| setQ() | Sets a search query parameter for this parameters group. | : void |
| setQDeep() | Sets a search query deepness parameter for this parameters group. | : void |
| setQType() | Sets the type of the search query parameter for this parameters group. | : void |
| setRandomItems() | Sets the random items parameter for this parameters group. | : void |
| setSort() | Sets the sort criteria parameter for this parameters group. | : void |
| setSortByIdList() | Sets a list of internal identifiers as a sort criteria parameter for this parameters group. | : void |
| setStockType() | Sets the stockType criteria parameter for this parameters group. | : void |
| setThirdPartySort() | Indicates that you want to preserve the ordering received by thirdparty. | : void |
| setToPrice() | Sets the maximum price parameter for this parameters group. | : void |
| toArray() | Returns the object data on array format. | : array<string|int, mixed> |
| filter() | : array<string|int, mixed> | |
| getInstantiatedValidator() | : ParametersValidator | |
| getValidator() | : ProductsParametersValidator |
Properties
$addDefaultOptionsPrice
protected
bool
$addDefaultOptionsPrice
$brandId
protected
int
$brandId
$brandsList
protected
string
$brandsList
$categoryId
protected
int
$categoryId
$categoryIdList
protected
string
$categoryIdList
$categoryPId
protected
string
$categoryPId
$customTagsSearchList
protected
string
$customTagsSearchList
$customTagsSearchType
protected
string
$customTagsSearchType
$defaultOptionsPriceSort
protected
string
$defaultOptionsPriceSort
$filterIndexable
protected
string
$filterIndexable
$fromPrice
protected
float
$fromPrice
$id
protected
int
$id
$idList
protected
string
$idList
$includeSubcategories
protected
bool
$includeSubcategories
$onlyFeatured
protected
bool
$onlyFeatured
$onlyOffers
protected
bool
$onlyOffers
$optionsPriceMode
protected
string
$optionsPriceMode
$page
protected
int
$page
$perPage
protected
int
$perPage
$pId
protected
string
$pId
$portalId
protected
int
$portalId
$q
protected
string
$q
$qDeep
protected
string
$qDeep
$qType
protected
string
$qType
$randomItems
protected
int
$randomItems
$sort
protected
string
$sort
$sortByIdList
protected
string
$sortByIdList
$stockType
protected
string
$stockType
$thirdPartySort
protected
bool
$thirdPartySort
$toPrice
protected
float
$toPrice
$validator
protected
ParametersValidator
$validator
Methods
addFilterCustomTag()
Sets a new custom tag filter for this parameters group.
public
addFilterCustomTag(int $customTagId, string $customTagValue) : void
Parameters
- $customTagId : int
- $customTagValue : string
Return values
void —addFilterCustomTagInterval()
Sets a new custom tag interval filter for this parameters group.
public
addFilterCustomTagInterval(int $customTagId, string $customTagRangeFrom, string $customTagRangeTo) : void
Parameters
- $customTagId : int
- $customTagRangeFrom : string
- $customTagRangeTo : string
Return values
void —addFilterOption()
Sets a new option filter for this parameters group.
public
addFilterOption(string $optionName, string $optionValue) : void
Parameters
- $optionName : string
- $optionValue : string
Return values
void —getFilterIndexable()
Returns the filter indexable parameter value.
public
getFilterIndexable() : string
Return values
string —setAddDefaultOptionsPrice()
Sets whether to return the prices of the default products options.
public
setAddDefaultOptionsPrice(bool $addDefaultOptionsPrice) : void
Parameters
- $addDefaultOptionsPrice : bool
Return values
void —setBrandId()
Sets a brand internal identifier for this parameters group.
public
setBrandId(int $brandId) : void
Parameters
- $brandId : int
Return values
void —setBrandsList()
Sets a list of brands internal identifiers for this parameters group.
public
setBrandsList(string $brandsList) : void
Parameters
- $brandsList : string
Return values
void —setCategoryId()
Sets a category internal identifier for this parameters group.
public
setCategoryId(int $categoryId) : void
Parameters
- $categoryId : int
Return values
void —setCategoryIdList()
Sets the public category identifier parameter for this parameters group.
public
setCategoryIdList(string $categoryIdList) : void
Parameters
- $categoryIdList : string
Return values
void —setCategoryPId()
Sets a list of categories internal identifiers for this parameters group.
public
setCategoryPId(string $categoryPId) : void
Parameters
- $categoryPId : string
Return values
void —setCustomTagsSearchList()
Sets a list of custom tags internal identifiers were the API must search.
public
setCustomTagsSearchList(string $customTagsSearchList) : void
Parameters
- $customTagsSearchList : string
Return values
void —setCustomTagsSearchType()
Sets the type of the custom tags search query parameter for this parameters group.
public
setCustomTagsSearchType(string $customTagsSearchType) : void
Parameters
- $customTagsSearchType : string
Return values
void —setDefaultOptionsPriceSort()
Sets the default order of the products options.
public
setDefaultOptionsPriceSort(string $defaultOptionsPriceSort) : void
Parameters
- $defaultOptionsPriceSort : string
Return values
void —setFilterIndexable()
Sets the filter indexable parameter for this parameters group.
public
setFilterIndexable(string $filterIndexable) : void
Parameters
- $filterIndexable : string
Return values
void —setFromPrice()
Sets the minimum price parameter for this parameters group.
public
setFromPrice(float $fromPrice) : void
Parameters
- $fromPrice : float
Return values
void —setId()
Sets the internal identifier parameter for this parameters group.
public
setId(int $id) : void
Parameters
- $id : int
Return values
void —setIdList()
Sets a list of internal identifiers for this parameters group.
public
setIdList(string $idList) : void
Parameters
- $idList : string
Return values
void —setIncludeSubcategories()
Sets if the elements will be filtered using this parameters group in function of if they are on subcategories.
public
setIncludeSubcategories(bool $includeSubcategories) : void
Parameters
- $includeSubcategories : bool
Return values
void —setOnlyFeatured()
Sets if the elements will be filtered using this parameters group in function of if they are featured.
public
setOnlyFeatured(bool $onlyFeatured) : void
Parameters
- $onlyFeatured : bool
Return values
void —setOnlyOffers()
Sets if the elements will be filtered using this parameters group in function of if they are on offer.
public
setOnlyOffers(bool $onlyOffers) : void
Parameters
- $onlyOffers : bool
Return values
void —setOptionsPriceMode()
Sets a the prices sort criteria for this parameters group.
public
setOptionsPriceMode(string $optionsPriceMode) : void
Parameters
- $optionsPriceMode : string
Return values
void —setPage()
Sets the page parameter for this parameters group.
public
setPage(int $page) : void
Parameters
- $page : int
Return values
void —setPerPage()
Sets the per page parameter for this parameters group.
public
setPerPage(int $perPage) : void
Parameters
- $perPage : int
Return values
void —setPId()
Sets the public identifier parameter for this parameters group.
public
setPId(string $pId) : void
Parameters
- $pId : string
Return values
void —setPortalId()
Sets the portal internal identifier parameter for this parameters group.
public
setPortalId(int $portalId) : void
Parameters
- $portalId : int
Return values
void —setQ()
Sets a search query parameter for this parameters group.
public
setQ(string $q) : void
Parameters
- $q : string
Return values
void —setQDeep()
Sets a search query deepness parameter for this parameters group.
public
setQDeep(string $qDeep) : void
Parameters
- $qDeep : string
Return values
void —setQType()
Sets the type of the search query parameter for this parameters group.
public
setQType(string $qType) : void
Parameters
- $qType : string
Return values
void —setRandomItems()
Sets the random items parameter for this parameters group.
public
setRandomItems(int $randomItems) : void
Parameters
- $randomItems : int
Return values
void —setSort()
Sets the sort criteria parameter for this parameters group.
public
setSort(string $sort) : void
Parameters
- $sort : string
Return values
void —setSortByIdList()
Sets a list of internal identifiers as a sort criteria parameter for this parameters group.
public
setSortByIdList(string $sortByIdList) : void
Parameters
- $sortByIdList : string
Return values
void —setStockType()
Sets the stockType criteria parameter for this parameters group.
public
setStockType(string $stockType) : void
Parameters
- $stockType : string
Return values
void —setThirdPartySort()
Indicates that you want to preserve the ordering received by thirdparty.
public
setThirdPartySort(bool $thirdPartySort) : void
Parameters
- $thirdPartySort : bool
Return values
void —setToPrice()
Sets the maximum price parameter for this parameters group.
public
setToPrice(float $toPrice) : void
Parameters
- $toPrice : float
Return values
void —toArray()
Returns the object data on array format.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —filter()
protected
filter(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —getInstantiatedValidator()
protected
getInstantiatedValidator() : ParametersValidator
Return values
ParametersValidator —getValidator()
protected
getValidator() : ProductsParametersValidator