phpDocumentor

GXEngineProduct
in package
implements ProductInterface

Class GXEngineProduct

Tags
category

System

subpackage

Entities

Interfaces, Classes and Traits

ProductInterface
Interface ProductInterface

Table of Contents

$active  : bool
Determines whether this product is active.
$addedDateTime  : DateTime
Added DateTime
$addonValues  : EditableKeyValueCollection
Addons collection
$availableDateTime  : EmptyDateTime
Available DateTime
$checkoutInformation  : EditableKeyValueCollection
Checkout information collection
$descriptions  : EditableKeyValueCollection
Description collection
$discountAllowed  : float
Discount allowed
$ean  : string
EAN
$fsk18  : bool
Is FSK 18?
$imageContainer  : ProductImageContainer
Image container
$infoUrl  : EditableKeyValueCollection
Url for further information of the product (e.g. manufacturer homepage)
$keywords  : EditableKeyValueCollection
Keyword collection
$lastModifiedDateTime  : DateTime
Last modified DateTime
$mainCategoryId  : int
Main category ID
$manufacturerId  : int
Manufacturer ID
$metaDescriptions  : EditableKeyValueCollection
Meta description collection
$metaKeywords  : EditableKeyValueCollection
Meta keywords collection
$metaTitles  : EditableKeyValueCollection
Meta title collection
$minQuantity  : int
Minimum quantity
$names  : EditableKeyValueCollection
Names collection
$orderedCount  : int
Ordered count
$price  : float
Price
$productModel  : string
Product model
$productTypeId  : int
Product type ID
$quantity  : float
Quantity
$quantityUnitId  : int
Quantity Unit ID
$settings  : ProductSettingsInterface
Product settings
$shippingCosts  : float
Shipping costs
$shippingTimeId  : int
Shipping time ID
$shortDescriptions  : EditableKeyValueCollection
Short description collection
$sortOrder  : int
Sort order
$specialOfferId  : int
Special offer id.
$taxClassId  : int
Tax class ID
$url  : EditableKeyValueCollection
Manufacturer URL
$urlKeywords  : EditableKeyValueCollection
URL keywords
$urlRewrites  : UrlRewriteCollection
URL rewrites
$viewedCount  : EditableKeyValueCollection
Viewed count
$vpeActive  : bool
Is VPE active?
$vpeId  : int
VPE ID
$vpeValue  : float
VPE value
$weight  : float
Weight
__construct()  : mixed
GXEngineProduct constructor.
addAddonValues()  : GXEngineProduct
Add Addon Values
deleteAddonValue()  : GXEngineProduct
Delete Addon Value
getAddedDateTime()  : DateTime
Get Added Date Time
getAdditionalImages()  : ProductImageCollection
Returns a product's additional images.
getAddonValue()  : string
Get Addon Value
getAddonValues()  : KeyValueCollection
Get Addon Values
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.
getManufacturerId()  : int
Get Manufacturer ID
getMetaDescription()  : string
Get Meta Description
getMetaKeywords()  : string
Get Meta Keywords
getMetaTitle()  : string
Get Meta Title
getMinimumQuantity()  : float
Get Quantity
getName()  : string
Get Name
getOrderedCount()  : int
Get Ordered Count
getPrice()  : float
Get Price
getPrimaryImage()  : ProductImage
Returns the product's primary image.
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()  : GXEngineProduct
Set Active
setAddedDateTime()  : GXEngineProduct
Sets the added date time.
setAddonValue()  : GXEngineProduct
Set Addon Value
setAvailableDateTime()  : GXEngineProduct
Set Available Date Time
setCheckoutInformation()  : GXEngineProduct
Set Checkout Information
setDescription()  : GXEngineProduct
Set Description
setDiscountAllowed()  : GXEngineProduct
Set Discount Allowed
setEan()  : GXEngineProduct
Set EAN
setFsk18()  : GXEngineProduct
Set FSK 18
setImageContainer()  : GXEngineProduct
Set Image Container
setInfoUrl()  : GXEngineProduct
Set Product's Info URL
setKeywords()  : GXEngineProduct
Set Keywords
setLastModifiedDateTime()  : GXEngineProduct
Set Last Modified Date Time
setMainCategoryId()  : GXEngineProduct
Set Main Category ID
setManufacturerId()  : GXEngineProduct
Set Manufacturer ID
setMetaDescription()  : GXEngineProduct
Set Meta description.
setMetaKeywords()  : GXEngineProduct
Set Meta Keywords
setMetaTitle()  : GXEngineProduct
Set Meta title.
setMinimumQuantity()  : GXEngineProduct
Set minimum quantity
setName()  : GXEngineProduct
Set Name
setOrderedCount()  : GXEngineProduct
Set Ordered Count
setPrice()  : GXEngineProduct
Set Price
setProductModel()  : GXEngineProduct
Set Product Model
setProductTypeId()  : GXEngineProduct
Set Product Type ID.
setQuantity()  : GXEngineProduct
Set Quantity
setQuantityUnitId()  : ProductInterface
Set Quantity Uniz ID
setSettings()  : GXEngineProduct
Sets a product setting object
setShippingCosts()  : GXEngineProduct
Set Shipping Costs
setShippingTimeId()  : GXEngineProduct
Set Shipping Time ID
setShortDescription()  : GXEngineProduct
Set Short Description
setSortOrder()  : GXEngineProduct
Set Sort Order
setSpecialOfferId()  : GXEngineProduct
Sets Special offer id.
setTaxClassId()  : GXEngineProduct
Set Tax Class ID
setUrl()  : GXEngineProduct
Set Product's Info URL
setUrlKeywords()  : GXEngineProduct
Set URL Keywords
setUrlRewrite()  : GXEngineProduct
Set URL rewrite
setUrlRewrites()  : GXEngineProduct
Set URL rewrites
setViewedCount()  : GXEngineProduct
Set Viewed Count
setVpeActive()  : GXEngineProduct
Set VPE Active
setVpeId()  : GXEngineProduct
Set VPE ID
setVpeValue()  : GXEngineProduct
Set VPE Value
setWeight()  : GXEngineProduct
Set Weight

Properties

$lastModifiedDateTime

Last modified DateTime

protected DateTime $lastModifiedDateTime

Methods

deleteAddonValue()

Delete Addon Value

public deleteAddonValue(StringType $key) : GXEngineProduct

Deletes an addon value of a product.

Parameters
$key : StringType

The key of the addon value to delete.

Tags
throws
InvalidArgumentException

if the key is not valid.

Return values
GXEngineProduct —

Same instance for chained method calls.

getAddedDateTime()

Get Added Date Time

public getAddedDateTime() : DateTime

Returns the added date time of the product.

Return values
DateTime —

The added date time.

getAddonValue()

Get Addon Value

public getAddonValue(StringType $key) : string

Returns the addon value of a product, depending on the provided key.

Parameters
$key : StringType

The key of the addon value to return.

Tags
throws
InvalidArgumentException

if the key is not valid.

Return values
string —

The addon value.

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 checkout information to be return.

Tags
throws
InvalidArgumentException

if the language code is not valid.

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 description to return.

Tags
throws
InvalidArgumentException

if the language code is not valid.

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 keywords to return.

Tags
throws
InvalidArgumentException

if the language code is not valid.

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.

public getMainCategoryId() : int
Return values
int —

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 meta description to return.

Tags
throws
InvalidArgumentException

if the language code is not valid.

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 meta keywords to return.

Tags
throws
InvalidArgumentException

if the language code is not valid.

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 meta title to return.

Tags
throws
InvalidArgumentException

if the language code is not valid.

Return values
string —

The meta title of the product.

getMinimumQuantity()

Get Quantity

public getMinimumQuantity() : float

Returns the minimum quantity of the product.

Return values
float —

The minimumquantity 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 name to return.

Tags
throws
InvalidArgumentException

if the language code is not valid.

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.

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 short description to return.

Tags
throws
InvalidArgumentException

if the language code is not valid.

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 URL keywords to be return.

Tags
throws
InvalidArgumentException

if the language code is not valid.

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.

Tags
throws
InvalidArgumentException

if the language code is not valid.

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.

Tags
throws
InvalidArgumentException

if the language code is not valid.

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 —

Product status.

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) : GXEngineProduct

Sets an available date time.

Parameters
$date : DateTime

The date time to add.

Return values
GXEngineProduct —

Same instance for chained method calls.

setLastModifiedDateTime()

Set Last Modified Date Time

public setLastModifiedDateTime(DateTime $date) : GXEngineProduct

Sets the last modified date time.

Parameters
$date : DateTime

The last modified date time.

Return values
GXEngineProduct —

Same instance for chained method calls.

Search results