Interface ProductInterface
| category |
System |
|---|---|
| package |
Product |
| subpackage |
Interfaces |
addAddonValues(\KeyValueCollection $keyValueCollection) : \ProductInterface
Adds a key value collection to a product.
\ProductInterfaceSame instance for chained method calls.
deleteAddonValue(\StringType $key) : \ProductInterface
Deletes a addon value of a product.
\ProductInterfaceSame instance for chained method calls.
getAddedDateTime() : \DateTime
Returns the added date time of the product.
\DateTimeThe added date time.
getAdditionalImages() : \ProductImageCollection
getAddonValue(\StringType $key) : string
Returns the addon value of a product, depending on the provided key.
stringThe addon value.
getAddonValues() : \KeyValueCollection
Returns a key value collection of the product.
\KeyValueCollectionThe key value collection.
getAvailableDateTime() : \DateTime
Returns the available date time of the product.
\DateTimeThe available date time.
getCheckoutInformation(\LanguageCode $language) : string
Returns the checkout information of the product, depending on the provided language code.
stringThe checkout information of the product.
getDescription(\LanguageCode $language) : string
Returns the description of the product, depending on the provided language code.
stringThe description of the product.
getDiscountAllowed() : float
Returns the allowed discount.
floatThe allowed discount.
getEan() : string
Returns the EAN of the product.
stringThe EAN of the product.
getImageContainer() : \ProductImageContainer
getInfoUrl(\LanguageCode $language) : string
Returns the URL for further information of the product (e.g. manufacturer homepage), depending on the provided language code.
stringProduct's Manufacturer URL
getKeywords(\LanguageCode $language) : string
Returns the keywords of the product, depending on the provided language code.
stringThe keywords of the product.
getLastModifiedDateTime() : \DateTime
Returns the last modified date time.
\DateTimeThe last modified date time.
getManufacturerId() : integer
Returns the manufacturer ID.
integerThe manufacturer ID.
getMetaDescription(\LanguageCode $language) : string
Returns the meta description of the product, depending on the provided language code.
stringThe meta description of the product.
getMetaKeywords(\LanguageCode $language) : string
Returns the meta keywords of the product, depending on the provided language code.
stringThe meta keywords of the product.
getMetaTitle(\LanguageCode $language) : string
Returns the meta title of the product, depending on the provided language code.
stringThe meta title of the product.
getName(\LanguageCode $language) : string
Returns the name of the product, depending on the provided language code.
stringThe name of the product.
getOrderedCount() : integer
Returns the ordered count of the product.
integerThe ordered count.
getPrice() : float
Returns the price of a product.
floatThe price of the product.
getProductModel() : string
Returns the product model.
stringThe product model.
getProductTypeId() : integer
Returns the product type ID.
integerThe product type ID.
getQuantity() : float
Returns the quantity of the product.
floatThe quantity of the product.
getQuantityUnitId() : integer
Returns the quantity unit ID.
integerThe quantity unit ID.
getSettings() : \ProductSettingsInterface
getShippingCosts() : float
Returns the shipping cost of the product.
floatThe shipping costs of the product.
getShippingTimeId() : integer
Returns the shipping time ID of the product.
integerThe shipping time ID.
getShortDescription(\LanguageCode $language) : string
Returns the short description of the product, depending on the provided language code.
stringThe short description of the product.
getSortOrder() : integer
Returns an integer which represents a specific sort order.
integerThe sort order.
getSpecialOfferId() : integer
integerThe special offer id.
getTaxClassId() : integer
Returns the tax class ID of the product.
integerThe tax class ID.
getUrl(\LanguageCode $language) : string
Returns the URL for further information of the product (e.g. manufacturer homepage), depending on the provided language code.
| deprecated |
Use ::getInfoUrl() instead. Will be removed in GX3.11. |
|---|
stringProduct's Manufacturer URL
getUrlKeywords(\LanguageCode $language) : string
Returns the URL keywords of the product, depending on the provided language code.
stringThe URL keywords of the product.
getUrlRewrite(\LanguageCode $language) : \UrlRewrite
Returns the URL rewrite of the product, depending on the provided language code.
\UrlRewriteThe URL rewrite of the product.
getUrlRewrites() : \UrlRewriteCollection
Returns the URL rewrites of the product.
\UrlRewriteCollectionThe URL rewrites of the product.
getViewedCount(\LanguageCode $language) : integer
Returns the current view count of the product, depending on the provided language code.
integerThe current view count.
getVpeId() : integer
Returns the VPE ID.
integerVPE ID.
getVpeValue() : float
Returns the VPE value.
floatThe VPE value.
getWeight() : float
Returns the weight of the product.
floatThe weight of the product.
isActive() : boolean
Checks if a product is active.
boolean
isFsk18() : boolean
Checks if the product is only available for FSK 18.
booleanIs the product FSK18?
isVpeActive() : boolean
Checks if VPE is active on the product.
booleanIs VPE active on the product?
setActive(\BoolType $status) : \ProductInterface
Activates or deactivates a product status.
\ProductInterfaceSame instance for chained method calls.
setAddedDateTime(\DateTime $date) : \ProductInterface
\DateTimeAdded date time to set.
\ProductInterfaceSame instance for chained method calls.
setAddonValue(\StringType $key, \StringType $value) : \ProductInterface
Sets the addon value of a product.
\ProductInterfaceSame instance for chained method calls.
setAvailableDateTime(\DateTime $date) : \ProductInterface
Sets an available date time.
\DateTimeThe date time to add.
\ProductInterfaceSame instance for chained method calls.
setCheckoutInformation(\StringType $text, \LanguageCode $language) : \ProductInterface
Sets the checkout information.
\ProductInterfaceSame instance for chained method calls.
setDescription(\StringType $text, \LanguageCode $language) : \ProductInterface
Sets the products description.
\ProductInterfaceSame instance for chained method calls.
setDiscountAllowed(\DecimalType $discount) : \ProductInterface
Sets the allowed discount of a product.
\ProductInterfaceSame instance for chained method calls.
setEan(\StringType $ean) : \ProductInterface
Sets a EAN for the product.
\ProductInterfaceSame instance for chained method calls.
setFsk18(\BoolType $status) : \ProductInterface
Activates or deactivates FSK18 for a product.
\ProductInterfaceSame instance for chained method calls.
setImageContainer(\ProductImageContainerInterface $images) : \ProductInterface
Sets the image container of a product.
\ProductInterfaceSame instance for chained method calls.
setInfoUrl(\StringType $url, \LanguageCode $language) : \GXEngineProduct
Sets the product's info URL (e.g. homepage of the manufacturer).
\GXEngineProductSame instance for chained method calls.
setKeywords(\StringType $text, \LanguageCode $language) : \ProductInterface
Sets the products keywords.
\ProductInterfaceSame instance for chained method calls.
setLastModifiedDateTime(\DateTime $date) : \ProductInterface
Sets the last modified date time.
\DateTimeThe last modified date time.
\ProductInterfaceSame instance for chained method calls.
setManufacturerId(\IdType $id) : \ProductInterface
Sets the manufacturer ID of a product.
\ProductInterfaceSame instance for chained method calls.
setMetaDescription(\StringType $text, \LanguageCode $language) : \ProductInterface
Sets the products meta description.
\ProductInterfaceSame instance for chained method calls.
setMetaKeywords(\StringType $text, \LanguageCode $language) : \ProductInterface
Sets the products meta keywords.
\ProductInterfaceSame instance for chained method calls.
setMetaTitle(\StringType $text, \LanguageCode $language) : \ProductInterface
setName(\StringType $text, \LanguageCode $language) : \ProductInterface
setOrderedCount(\IntType $count) : \ProductInterface
setPrice(\DecimalType $price) : \ProductInterface
Sets a price of the product.
\ProductInterfaceSame instance for chained method calls.
setProductModel(\StringType $model) : \ProductInterface
setProductTypeId(\IdType $id) : \ProductInterface
Sets the product type ID of the product.
\ProductInterfaceSame instance for chained method calls.
setQuantity(\DecimalType $quantity) : \ProductInterface
Sets a quantity for the product.
\ProductInterfaceSame instance for chained method calls.
setQuantityUnitId(\IdType $id) : \ProductInterface
Sets the quantity unit ID of a product.
\ProductInterfaceSame instance for chained method calls.
setSettings(\ProductSettingsInterface $productSettings) : \ProductInterface
setShippingCosts(\DecimalType $price) : \ProductInterface
Sets the shipping costs of a product.
\ProductInterfaceSame instance for chained method calls.
setShippingTimeId(\IdType $id) : \ProductInterface
Sets the shipping time ID of a product.
\ProductInterfaceSame instance for chained method calls.
setShortDescription(\StringType $text, \LanguageCode $language) : \ProductInterface
Sets the products short description.
\ProductInterfaceSame instance for chained method calls.
setSortOrder(\IntType $sortOrder) : \ProductInterface
Sets the sort order of the product.
\ProductInterfaceSame instance for chained method calls.
setSpecialOfferId(\IdType $id) : \ProductInterface
setTaxClassId(\IdType $id) : \ProductInterface
Sets a tax class ID for the product.
\ProductInterfaceSame instance for chained method calls.
setUrl(\StringType $url, \LanguageCode $language) : \GXEngineProduct
Sets the product's info URL (e.g. homepage of the manufacturer).
| deprecated |
Use ::setInfoUrl() instead. Will be removed in GX3.11. |
|---|
\GXEngineProductSame instance for chained method calls.
setUrlKeywords(\StringType $text, \LanguageCode $language) : \ProductInterface
Sets the products URL Keywords.
\ProductInterfaceSame instance for chained method calls.
setUrlRewrite(\UrlRewrite $urlRewrite, \LanguageCode $language) : \GXEngineProduct
Sets the products URL rewrite for the provided language code.
\GXEngineProductSame instance for chained method calls.
setUrlRewrites(\UrlRewriteCollection $urlRewrites) : \GXEngineProduct
Sets the products URL rewrites.
\GXEngineProductSame instance for chained method calls.
setViewedCount(\IntType $count, \LanguageCode $language) : \ProductInterface
Sets the viewed count of a product.
\ProductInterfaceSame instance for chained method calls.
setVpeActive(\BoolType $status) : \ProductInterface
Activates or deactivates VPE for a product.
\ProductInterfaceSame instance for chained method calls.
setVpeId(\IdType $id) : \ProductInterface
Sets the VPE ID of a product.
\ProductInterfaceSame instance for chained method calls.
setVpeValue(\DecimalType $vpeValue) : \ProductInterface
Sets the VPE value of a product.
\ProductInterfaceSame instance for chained method calls.
setWeight(\DecimalType $weight) : \ProductInterface
Sets the weight of a product.
\ProductInterfaceSame instance for chained method calls.