phpDocumentor

StoredProductInterface extends ProductInterface, AddonValueContainerInterface

Interface StoredProductInterface

Tags
category

System

subpackage

Interfaces

Table of Contents

addAddonValues()  : mixed
Merges the existing addon values with new ones.
deleteAddonValue()  : mixed
Deletes a specific addon value entry by key.
getAddedDateTime()  : DateTime
Get Added Date Time
getAdditionalImages()  : ProductImageCollection
Returns a product's additional images.
getAddonValue()  : string
Returns a specific addon value by providing its key.
getAddonValueContainerId()  : int
Returns the addon value container ID.
getAddonValues()  : KeyValueCollection
Returns all the addon values as a KeyValueCollection.
getAvailableDateTime()  : DateTime
Get Available Date Time
getCheckoutInformation()  : string
Get Checkout Information
getDescription()  : string
Get Description
getDiscountAllowed()  : float
Get Discount Allowed
getEan()  : string
Get EAN
getImageContainer()  : ProductImageContainer
Returns the image container of the product.
getInfoUrl()  : string
Get Info Url
getKeywords()  : string
Get Keywords
getLastModifiedDateTime()  : DateTime
Get Last Modified Date Time
getMainCategoryId()  : int
Returns the main category ID of the product.
getManufacturerId()  : int
Get Manufacturer ID
getMetaDescription()  : string
Get Meta Description
getMetaKeywords()  : string
Get Meta Keywords
getMetaTitle()  : string
Get Meta Title
getName()  : string
Get Name
getOrderedCount()  : int
Get Ordered Count
getPrice()  : float
Get Price
getPrimaryImage()  : ProductImage
Returns a product's primary image.
getProductId()  : int
Get Product ID.
getProductModel()  : string
Get Product Model
getProductTypeId()  : int
Get Product Type ID.
getQuantity()  : float
Get Quantity
getQuantityUnitId()  : int
Get Quantity Unit ID
getSettings()  : ProductSettingsInterface
Get Product Settings.
getShippingCosts()  : float
Get Shipping Costs
getShippingTimeId()  : int
Get Shipping Time ID
getShortDescription()  : string
Get Short Description
getSortOrder()  : int
Get Sort Order
getSpecialOfferId()  : int
Returns the Special offer id.
getTaxClassId()  : int
Get Tax Class ID
getUrl()  : string
Get Info Url
getUrlKeywords()  : string
Get URL Keywords
getUrlRewrite()  : UrlRewrite
Get URL rewrite
getUrlRewrites()  : UrlRewriteCollection
Get URL rewrites
getViewedCount()  : int
Get View Count
getVpeId()  : int
Get VPE ID.
getVpeValue()  : float
Get VPE Value
getWeight()  : float
Get Weight
isActive()  : bool
Is Active
isFsk18()  : bool
Is FSK 18
isVpeActive()  : bool
Is VPE Active
setActive()  : ProductInterface
Set Active
setAddedDateTime()  : ProductInterface
Sets the added date time.
setAddonValue()  : mixed
Sets the value of a specific addon key.
setAvailableDateTime()  : ProductInterface
Set Available Date Time
setCheckoutInformation()  : ProductInterface
Set Checkout Information
setDescription()  : ProductInterface
Set Description
setDiscountAllowed()  : ProductInterface
Set Discount Allowed
setEan()  : ProductInterface
Set EAN
setFsk18()  : ProductInterface
Set FSK 18
setImageContainer()  : ProductInterface
Set Image Container
setInfoUrl()  : GXEngineProduct
SSet Product's Info URL
setKeywords()  : ProductInterface
Set Keywords
setLastModifiedDateTime()  : ProductInterface
Set Last Modified Date Time
setMainCategoryId()  : ProductInterface
setManufacturerId()  : ProductInterface
Set Manufacturer ID
setMetaDescription()  : ProductInterface
Set Meta description.
setMetaKeywords()  : ProductInterface
Set Meta Keywords
setMetaTitle()  : ProductInterface
Set Meta title.
setName()  : ProductInterface
Set Name
setOrderedCount()  : ProductInterface
Set Ordered Count
setPrice()  : ProductInterface
Set Price
setProductModel()  : ProductInterface
Set Product Model
setProductTypeId()  : ProductInterface
Set Product Type ID.
setQuantity()  : ProductInterface
Set Quantity
setQuantityUnitId()  : ProductInterface
Set Quantity Uniz ID
setSettings()  : ProductInterface
Sets the settings of the product.
setShippingCosts()  : ProductInterface
Set Shipping Costs
setShippingTimeId()  : ProductInterface
Set Shipping Time ID
setShortDescription()  : ProductInterface
Set Short Description
setSortOrder()  : ProductInterface
Set Sort Order
setSpecialOfferId()  : ProductInterface
Sets Special offer id.
setTaxClassId()  : ProductInterface
Set Tax Class ID
setUrl()  : GXEngineProduct
Set Product's Info URL
setUrlKeywords()  : ProductInterface
Set URL Keywords
setUrlRewrite()  : GXEngineProduct
Set URL rewrite
setUrlRewrites()  : GXEngineProduct
Set URL rewrites
setViewedCount()  : ProductInterface
Set Viewed Count
setVpeActive()  : ProductInterface
Set VPE Active
setVpeId()  : ProductInterface
Set VPE ID
setVpeValue()  : ProductInterface
Set VPE Value
setWeight()  : ProductInterface
Set Weight

Methods

getAddedDateTime()

Get Added Date Time

public getAddedDateTime() : DateTime

Returns the added date time of the product.

Return values
DateTime

The added date time.

getAddonValueContainerId()

Returns the addon value container ID.

public getAddonValueContainerId() : int
Return values
int

Addon value container ID.

getAvailableDateTime()

Get Available Date Time

public getAvailableDateTime() : DateTime

Returns the available date time of the product.

Return values
DateTime

The available date time.

getCheckoutInformation()

Get Checkout Information

public getCheckoutInformation(LanguageCode $language) : string

Returns the checkout information of the product, depending on the provided language code.

Parameters
$language : LanguageCode

The language code of the language to return.

Return values
string

The checkout information of the product.

getDescription()

Get Description

public getDescription(LanguageCode $language) : string

Returns the description of the product, depending on the provided language code.

Parameters
$language : LanguageCode

The language code of the language to return.

Return values
string

The description of the product.

getDiscountAllowed()

Get Discount Allowed

public getDiscountAllowed() : float

Returns the allowed discount.

Return values
float

The allowed discount.

getEan()

Get EAN

public getEan() : string

Returns the EAN of the product.

Return values
string

The EAN of the product.

getInfoUrl()

Get Info Url

public getInfoUrl(LanguageCode $language) : string

Returns the URL for further information of the product (e.g. manufacturer homepage), depending on the provided language code.

Parameters
$language : LanguageCode

The language code of the URL to return.

Return values
string

Product's Manufacturer URL

getKeywords()

Get Keywords

public getKeywords(LanguageCode $language) : string

Returns the keywords of the product, depending on the provided language code.

Parameters
$language : LanguageCode

The language code of the language to return.

Return values
string

The keywords of the product.

getLastModifiedDateTime()

Get Last Modified Date Time

public getLastModifiedDateTime() : DateTime

Returns the last modified date time.

Return values
DateTime

The last modified date time.

getMainCategoryId()

Returns the main category ID of the product.

public getMainCategoryId() : int
Return values
int

The main category ID

getManufacturerId()

Get Manufacturer ID

public getManufacturerId() : int

Returns the manufacturer ID.

Return values
int

The manufacturer ID.

getMetaDescription()

Get Meta Description

public getMetaDescription(LanguageCode $language) : string

Returns the meta description of the product, depending on the provided language code.

Parameters
$language : LanguageCode

The language code of the language to return.

Return values
string

The meta description of the product.

getMetaKeywords()

Get Meta Keywords

public getMetaKeywords(LanguageCode $language) : string

Returns the meta keywords of the product, depending on the provided language code.

Parameters
$language : LanguageCode

The language code of the language to return.

Return values
string

The meta keywords of the product.

getMetaTitle()

Get Meta Title

public getMetaTitle(LanguageCode $language) : string

Returns the meta title of the product, depending on the provided language code.

Parameters
$language : LanguageCode

The language code of the language to return.

Return values
string

The meta title of the product.

getName()

Get Name

public getName(LanguageCode $language) : string

Returns the name of the product, depending on the provided language code.

Parameters
$language : LanguageCode

The language code of the language to return.

Return values
string

The name of the product.

getOrderedCount()

Get Ordered Count

public getOrderedCount() : int

Returns the ordered count of the product.

Return values
int

The ordered count.

getPrice()

Get Price

public getPrice() : float

Returns the price of a product.

Return values
float

The price of the product.

getProductId()

Get Product ID.

public getProductId() : int

Returns the ID of the stored product.

Return values
int

The product ID.

getProductModel()

Get Product Model

public getProductModel() : string

Returns the product model.

Return values
string

The product model.

getProductTypeId()

Get Product Type ID.

public getProductTypeId() : int

Returns the product type ID.

Return values
int

The product type ID.

getQuantity()

Get Quantity

public getQuantity() : float

Returns the quantity of the product.

Return values
float

The quantity of the product.

getQuantityUnitId()

Get Quantity Unit ID

public getQuantityUnitId() : int

Returns the quantity unit ID.

Return values
int

The quantity unit ID.

getShippingCosts()

Get Shipping Costs

public getShippingCosts() : float

Returns the shipping cost of the product.

Return values
float

The shipping costs of the product.

getShippingTimeId()

Get Shipping Time ID

public getShippingTimeId() : int

Returns the shipping time ID of the product.

Return values
int

The shipping time ID.

getShortDescription()

Get Short Description

public getShortDescription(LanguageCode $language) : string

Returns the short description of the product, depending on the provided language code.

Parameters
$language : LanguageCode

The language code of the language to return.

Return values
string

The short description of the product.

getSortOrder()

Get Sort Order

public getSortOrder() : int

Returns an integer which represents a specific sort order.

Return values
int

The sort order.

getSpecialOfferId()

Returns the Special offer id.

public getSpecialOfferId() : int
Return values
int

The special offer id.

getTaxClassId()

Get Tax Class ID

public getTaxClassId() : int

Returns the tax class ID of the product.

Return values
int

The tax class ID.

getUrl()

Get Info Url

public getUrl(LanguageCode $language) : string

Returns the URL for further information of the product (e.g. manufacturer homepage), depending on the provided language code.

Parameters
$language : LanguageCode

The language code of the URL to return.

Tags
deprecated

Use ::getInfoUrl() instead. Will be removed in GX3.11.

Return values
string

Product's Manufacturer URL

getUrlKeywords()

Get URL Keywords

public getUrlKeywords(LanguageCode $language) : string

Returns the URL keywords of the product, depending on the provided language code.

Parameters
$language : LanguageCode

The language code of the language to return.

Return values
string

The URL keywords of the product.

getUrlRewrite()

Get URL rewrite

public getUrlRewrite(LanguageCode $language) : UrlRewrite

Returns the URL rewrite of the product, depending on the provided language code.

Parameters
$language : LanguageCode

The language code of the URL rewrite to be return.

Return values
UrlRewrite

The URL rewrite of the product.

getViewedCount()

Get View Count

public getViewedCount(LanguageCode $language) : int

Returns the current view count of the product, depending on the provided language code.

Parameters
$language : LanguageCode

The language code of the language to be returned.

Return values
int

The current view count.

getVpeId()

Get VPE ID.

public getVpeId() : int

Returns the VPE ID.

Return values
int

VPE ID.

getVpeValue()

Get VPE Value

public getVpeValue() : float

Returns the VPE value.

Return values
float

The VPE value.

getWeight()

Get Weight

public getWeight() : float

Returns the weight of the product.

Return values
float

The weight of the product.

isActive()

Is Active

public isActive() : bool

Checks if a product is active.

Return values
bool

isFsk18()

Is FSK 18

public isFsk18() : bool

Checks if the product is only available for FSK 18.

Return values
bool

Is the product FSK18?

isVpeActive()

Is VPE Active

public isVpeActive() : bool

Checks if VPE is active on the product.

Return values
bool

Is VPE active on the product?

setAvailableDateTime()

Set Available Date Time

public setAvailableDateTime(DateTime $date) : ProductInterface

Sets an available date time.

Parameters
$date : DateTime

The date time to add.

Return values
ProductInterface

Same instance for chained method calls.

setLastModifiedDateTime()

Set Last Modified Date Time

public setLastModifiedDateTime(DateTime $date) : ProductInterface

Sets the last modified date time.

Parameters
$date : DateTime

The last modified date time.

Return values
ProductInterface

Same instance for chained method calls.

Search results