ProductExtraBuyController
extends ProductController
in package
This controller describes the behavior of Product Extra buy entities.
Use the controller to generate a collection of CollectionProduct entities. Note: This controller adds an extra attribute to CollectionProduct named "ExtraBuyAmount" which is the default minimum amount of extra buy products
Tags
Table of Contents
- TYPE_DISCONTINUED = 'discontinued'
- __construct() : mixed
- getDescription() : string
- Get the description (long) of the entity
- getDescriptionList() : string
- Get the description (list) of the entity
- getDescriptionShort() : string
- Get the description (short) of the entity
- getPaymentOptions() : mixed
- Legacy, do not use this method
- getPrevNextProduct() : mixed
- getTranslation() : string
- Get translation data
- getUnitTitle() : string
- Get the title of a product entity
- getVariantCount() : int
- Returns the amount of variants for a specific product
- googleCategory() : int|null
- Returns the google category associated with a Product, if any
- link() : string
- Get the qualified url of a product
- preload() : mixed
- variantTypeIds() : array<string|int, int>
- Returns the distinct variant type ids for one or more product
Constants
TYPE_DISCONTINUED
public
mixed
TYPE_DISCONTINUED
= 'discontinued'
Tags
Methods
__construct()
public
__construct() :
mixed
Tags
Return values
mixed —getDescription()
Get the description (long) of the entity
public
getDescription(mixed $Id[, mixed $LanguageIso = null ]) :
string
Parameters
- $Id : mixed
- $LanguageIso : mixed = null
Tags
Return values
string —getDescriptionList()
Get the description (list) of the entity
public
getDescriptionList(mixed $Id[, mixed $LanguageIso = null ]) :
string
Parameters
- $Id : mixed
- $LanguageIso : mixed = null
Tags
Return values
string —getDescriptionShort()
Get the description (short) of the entity
public
getDescriptionShort(mixed $Id[, mixed $LanguageIso = null ]) :
string
Parameters
- $Id : mixed
- $LanguageIso : mixed = null
Tags
Return values
string —getPaymentOptions()
Legacy, do not use this method
public
getPaymentOptions(mixed $Price) :
mixed
Parameters
- $Price : mixed
Tags
Return values
mixed —getPrevNextProduct()
public
getPrevNextProduct(mixed $CurrentId) :
mixed
Parameters
- $CurrentId : mixed
Tags
Return values
mixed —getTranslation()
Get translation data
public
getTranslation(mixed $Id, mixed $Title[, mixed $LanguageIso = null ][, mixed $Module = 'product' ]) :
string
Parameters
- $Id : mixed
- $Title : mixed
- $LanguageIso : mixed = null
- $Module : mixed = 'product'
Tags
Return values
string —getUnitTitle()
Get the title of a product entity
public
getUnitTitle(mixed $UnitId[, mixed $LanguageIso = null ]) :
string
Parameters
- $UnitId : mixed
- $LanguageIso : mixed = null
Tags
Return values
string —getVariantCount()
Returns the amount of variants for a specific product
public
getVariantCount(int $productId) :
int
Parameters
- $productId : int
-
the id of the product
Tags
Return values
int —the amount of variants for the product
googleCategory()
Returns the google category associated with a Product, if any
public
googleCategory(mixed $productId) :
int|null
Parameters
- $productId : mixed
Tags
Return values
int|null —link()
Get the qualified url of a product
public
static
link(mixed $productId[, mixed $absolute = false ][, mixed $product = null ]) :
string
Parameters
- $productId : mixed
- $absolute : mixed = false
- $product : mixed = null
Tags
Return values
string —preload()
public
preload(mixed $ids) :
mixed
Parameters
- $ids : mixed
Tags
Return values
mixed —variantTypeIds()
Returns the distinct variant type ids for one or more product
public
variantTypeIds(mixed $productIds) :
array<string|int, int>
Parameters
- $productIds : mixed