Adventure Documentation

ProductVariantController extends ProductCommonController
in package

This controller describes the behavior of Product Variant entities.

Use the controller to generate a collection of Product Variant entities. Note: Collection will be sorted according to variant sorting UNLESS dataIds are provided and in that case the sorting of the data values will be used.

Tags
see
CollectionProductVariant

Main entity of collection

see
ProductVariantDataController

Associated Data to Variant entity

see
ProductVariantPacketController

Associated Packet product to Variant entity

see
ProductVariantTypeController

Associated Type to Variant entity

Table of Contents

__construct()  : mixed
getDescription()  : string
Get the description (long) of the entity
getDescriptionShort()  : string
Get the description (short) of the entity
getPaymentOptions()  : mixed
Legacy, do not use this method
getTranslation()  : string
Get translation data
getUnitTitle()  : string
Get the title of a product entity
preload()  : mixed

Methods

__construct()

public __construct([mixed $parseUriParameters = false ]) : mixed
Parameters
$parseUriParameters : mixed = false
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

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

getTranslation()

Get translation data

public getTranslation(mixed $Id, mixed $Title[, mixed $LanguageIso = null ][, mixed $Module = 'variant' ]) : string
Parameters
$Id : mixed
$Title : mixed
$LanguageIso : mixed = null
$Module : mixed = 'variant'
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

preload()

public preload(mixed $ids) : mixed
Parameters
$ids : mixed
Tags
see
CollectionController::preload
Return values
mixed

        

Search results