Class GXEngineProduct

GXEngineProduct implements ProductInterface

Direct known subclasses

StoredProduct

Package: Product\Entities
Category: System
Located at CoreServices/Product/Entities/GXEngineProduct.inc.php

Methods summary

`public`	# `__construct( ProductSettingsInterface $settings )` GXEngineProduct constructor. GXEngineProduct constructor. Parameters `$settings` Product settings.
`public boolean`	# `isActive( )` Is Active Is Active Checks if a product is active. Returns boolean Product status. Implementation of `ProductInterface::isActive()`
`public integer`	# `getSortOrder( )` Get Sort Order Get Sort Order Returns an integer which represents a specific sort order. Returns integer The sort order. Implementation of `ProductInterface::getSortOrder()`
`public DateTime`	# `getAvailableDateTime( )` Get Available Date Time Get Available Date Time Returns the available date time of the product. Returns DateTime The available date time. Implementation of `ProductInterface::getAvailableDateTime()`
`public DateTime`	# `getAddedDateTime( )` Get Added Date Time Get Added Date Time Returns the added date time of the product. Returns DateTime The added date time. Implementation of `ProductInterface::getAddedDateTime()`
`public DateTime`	# `getLastModifiedDateTime( )` Get Last Modified Date Time Get Last Modified Date Time Returns the last modified date time. Returns DateTime The last modified date time. Implementation of `ProductInterface::getLastModifiedDateTime()`
`public integer`	# `getViewedCount( LanguageCode $language )` Get View Count Get View Count Returns the current view count of the product, depending on the provided language code. Parameters `$language` The language code of the language to be returned. Returns integer The current view count. Throws InvalidArgumentException if the language code is not valid. Implementation of `ProductInterface::getViewedCount()`
`public integer`	# `getOrderedCount( )` Get Ordered Count Get Ordered Count Returns the ordered count of the product. Returns integer The ordered count. Implementation of `ProductInterface::getOrderedCount()`
`public ProductSettingsInterface`	# `getSettings( )` Get Product Settings. Get Product Settings. Returns the product settings. Returns `ProductSettingsInterface` Implementation of `ProductInterface::getSettings()`
`public string`	# `getName( LanguageCode $language )` Get Name Get Name Returns the name of the product, depending on the provided language code. Parameters `$language` The language code of the name to return. Returns string The name of the product. Throws InvalidArgumentException if the language code is not valid. Implementation of `ProductInterface::getName()`
`public string`	# `getDescription( LanguageCode $language )` Get Description Get Description Returns the description of the product, depending on the provided language code. Parameters `$language` The language code of the description to return. Returns string The description of the product. Throws InvalidArgumentException if the language code is not valid. Implementation of `ProductInterface::getDescription()`
`public string`	# `getShortDescription( LanguageCode $language )` Get Short Description Get Short Description Returns the short description of the product, depending on the provided language code. Parameters `$language` The language code of the short description to return. Returns string The short description of the product. Throws InvalidArgumentException if the language code is not valid. Implementation of `ProductInterface::getShortDescription()`
`public string`	# `getKeywords( LanguageCode $language )` Get Keywords Get Keywords Returns the keywords of the product, depending on the provided language code. Parameters `$language` The language code of the keywords to return. Returns string The keywords of the product. Throws InvalidArgumentException if the language code is not valid. Implementation of `ProductInterface::getKeywords()`
`public string`	# `getMetaTitle( LanguageCode $language )` Get Meta Title Get Meta Title Returns the meta title of the product, depending on the provided language code. Parameters `$language` The language code of the meta title to return. Returns string The meta title of the product. Throws InvalidArgumentException if the language code is not valid. Implementation of `ProductInterface::getMetaTitle()`
`public string`	# `getMetaDescription( LanguageCode $language )` Get Meta Description Get Meta Description Returns the meta description of the product, depending on the provided language code. Parameters `$language` The language code of the meta description to return. Returns string The meta description of the product. Throws InvalidArgumentException if the language code is not valid. Implementation of `ProductInterface::getMetaDescription()`
`public string`	# `getMetaKeywords( LanguageCode $language )` Get Meta Keywords Get Meta Keywords Returns the meta keywords of the product, depending on the provided language code. Parameters `$language` The language code of the meta keywords to return. Returns string The meta keywords of the product. Throws InvalidArgumentException if the language code is not valid. Implementation of `ProductInterface::getMetaKeywords()`
`public string`	# `getUrl( LanguageCode $language )` Get Url Get Url Returns the URL of the product, depending on the provided language code. Parameters `$language` The language code of the URL to return. Returns string Product URL Throws InvalidArgumentException if the language code is not valid. Implementation of `ProductInterface::getUrl()`
`public string`	# `getUrlKeywords( LanguageCode $language )` Get URL Keywords Get URL Keywords Returns the URL keywords of the product, depending on the provided language code. Parameters `$language` The language code of the URL keywords to be return. Returns string The URL keywords of the product. Throws InvalidArgumentException if the language code is not valid. Implementation of `ProductInterface::getUrlKeywords()`
`public string`	# `getCheckoutInformation( LanguageCode $language )` Get Checkout Information Get Checkout Information Returns the checkout information of the product, depending on the provided language code. Parameters `$language` The language code of the checkout information to be return. Returns string The checkout information of the product. Throws InvalidArgumentException if the language code is not valid. Implementation of `ProductInterface::getCheckoutInformation()`
`public string`	# `getProductModel( )` Get Product Model Get Product Model Returns the product model. Returns string The product model. Implementation of `ProductInterface::getProductModel()`
`public string`	# `getEan( )` Get EAN Get EAN Returns the EAN of the product. Returns string The EAN of the product. Implementation of `ProductInterface::getEan()`
`public float`	# `getPrice( )` Get Price Get Price Returns the price of a product. Returns float The price of the product. Implementation of `ProductInterface::getPrice()`
`public integer`	# `getTaxClassId( )` Get Tax Class ID Get Tax Class ID Returns the tax class ID of the product. Returns integer The tax class ID. Implementation of `ProductInterface::getTaxClassId()`
`public float`	# `getQuantity( )` Get Quantity Get Quantity Returns the quantity of the product. Returns float The quantity of the product. Implementation of `ProductInterface::getQuantity()`
`public float`	# `getWeight( )` Get Weight Get Weight Returns the weight of the product. Returns float The weight of the product. Implementation of `ProductInterface::getWeight()`
`public float`	# `getDiscountAllowed( )` Get Discount Allowed Get Discount Allowed Returns the allowed discount. Returns float The allowed discount. Implementation of `ProductInterface::getDiscountAllowed()`
`public float`	# `getShippingCosts( )` Get Shipping Costs Get Shipping Costs Returns the shipping cost of the product. Returns float The shipping costs of the product. Implementation of `ProductInterface::getShippingCosts()`
`public integer`	# `getShippingTimeId( )` Get Shipping Time ID Get Shipping Time ID Returns the shipping time ID of the product. Returns integer The shipping time ID. Implementation of `ProductInterface::getShippingTimeId()`
`public integer`	# `getProductTypeId( )` Get Product Type ID. Get Product Type ID. Returns the product type ID. Returns integer The product type ID. Implementation of `ProductInterface::getProductTypeId()`
`public integer`	# `getManufacturerId( )` Get Manufacturer ID Get Manufacturer ID Returns the manufacturer ID. Returns integer The manufacturer ID. Implementation of `ProductInterface::getManufacturerId()`
`public boolean`	# `isFsk18( )` Is FSK 18 Is FSK 18 Checks if the product is only available for FSK 18. Returns boolean Is the product FSK18? Implementation of `ProductInterface::isFsk18()`
`public boolean`	# `isVpeActive( )` Is VPE Active Is VPE Active Checks if VPE is active on the product. Returns boolean Is VPE active on the product? Implementation of `ProductInterface::isVpeActive()`
`public integer`	# `getVpeId( )` Get VPE ID. Get VPE ID. Returns the VPE ID. Returns integer VPE ID. Implementation of `ProductInterface::getVpeId()`
`public float`	# `getVpeValue( )` Get VPE Value Get VPE Value Returns the VPE value. Returns float The VPE value. Implementation of `ProductInterface::getVpeValue()`
`public string`	# `getAddonValue( StringType $key )` Get Addon Value Get Addon Value Returns the addon value of a product, depending on the provided key. Parameters `$key` The key of the addon value to return. Returns string The addon value. Throws InvalidArgumentException if the key is not valid. Implementation of `ProductInterface::getAddonValue()`
`public KeyValueCollection`	# `getAddonValues( )` Get Addon Values Get Addon Values Returns a key value collection of the product. Returns `KeyValueCollection` The key value collection. Implementation of `ProductInterface::getAddonValues()`
`public GXEngineProduct`	# `setActive( BoolType $status )` Set Active Set Active Activates or deactivates a product status. Parameters `$status` The status to activate or deactivate the product. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setActive()`
`public GXEngineProduct`	# `setSortOrder( IntType $sortOrder )` Set Sort Order Set Sort Order Sets the sort order of the product. Parameters `$sortOrder` The sort order. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setSortOrder()`
`public GXEngineProduct`	# `setAvailableDateTime( DateTime $date )` Set Available Date Time Set Available Date Time Sets an available date time. Parameters `$date` The date time to add. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setAvailableDateTime()`
`public GXEngineProduct`	# `setLastModifiedDateTime( DateTime $date )` Set Last Modified Date Time Set Last Modified Date Time Sets the last modified date time. Parameters `$date` The last modified date time. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setLastModifiedDateTime()`
`public GXEngineProduct`	# `setViewedCount( IntType $count, LanguageCode $language )` Set Viewed Count Set Viewed Count Sets the viewed count. Parameters `$count` The amount of views. `$language` The language code for the product name. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setViewedCount()`
`public GXEngineProduct`	# `setOrderedCount( IntType $count )` Set Ordered Count Set Ordered Count Sets the ordered count. Parameters `$count` The ordered count. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setOrderedCount()`
`public GXEngineProduct`	# `setImageContainer( ProductImageContainerInterface $images )` Set Image Container Set Image Container Sets the image container of a product. Parameters `$images` Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setImageContainer()`
`public GXEngineProduct`	# `setSettings( ProductSettingsInterface $productSettings )` Sets a product setting object Sets a product setting object Parameters `$productSettings` Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setSettings()`
`public GXEngineProduct`	# `setName( StringType $text, LanguageCode $language )` Set Name Set Name Sets the products name. Parameters `$text` The name of the product. `$language` The language code for the product name. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setName()`
`public GXEngineProduct`	# `setDescription( StringType $text, LanguageCode $language )` Set Description Set Description Sets the products description. Parameters `$text` The description. `$language` The language code for the description. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setDescription()`
`public GXEngineProduct`	# `setShortDescription( StringType $text, LanguageCode $language )` Set Short Description Set Short Description Sets the products description. Parameters `$text` The short description. `$language` The language code for the short description. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setShortDescription()`
`public GXEngineProduct`	# `setKeywords( StringType $text, LanguageCode $language )` Set Keywords Set Keywords Sets the products keywords. Parameters `$text` The keywords. `$language` The language code for the keywords. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setKeywords()`
`public GXEngineProduct`	# `setMetaTitle( StringType $text, LanguageCode $language )` Set Meta title. Set Meta title. Sets the meta title of a product. Parameters `$text` `$language` Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setMetaTitle()`
`public GXEngineProduct`	# `setMetaDescription( StringType $text, LanguageCode $language )` Set Meta description. Set Meta description. Sets the meta description of a product. Parameters `$text` `$language` Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setMetaDescription()`
`public GXEngineProduct`	# `setMetaKeywords( StringType $text, LanguageCode $language )` Set Meta Keywords Set Meta Keywords Sets the products meta keywords. Parameters `$text` The meta keywords. `$language` The language code for the meta keywords. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setMetaKeywords()`
`public GXEngineProduct`	# `setUrl( StringType $url, LanguageCode $language )` Set URL Set URL Sets the products URL. Parameters `$url` The URL. `$language` The language code for the URL keywords. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setUrl()`
`public GXEngineProduct`	# `setUrlKeywords( StringType $text, LanguageCode $language )` Set URL Keywords Set URL Keywords Sets the products URL Keywords. Parameters `$text` The URL Keywords. `$language` The language code for the URL keywords. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setUrlKeywords()`
`public GXEngineProduct`	# `setCheckoutInformation( StringType $text, LanguageCode $language )` Set Checkout Information Set Checkout Information Sets the checkout information of a product. Parameters `$text` The checkout information. `$language` The language code for the checkout information. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setCheckoutInformation()`
`public GXEngineProduct`	# `setProductModel( StringType $model )` Set Product Model Set Product Model Set the product model. Parameters `$model` The product model. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setProductModel()`
`public GXEngineProduct`	# `setEan( StringType $ean )` Set EAN Set EAN Sets a EAN for the product. Parameters `$ean` The EAN to set. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setEan()`
`public GXEngineProduct`	# `setPrice( DecimalType $price )` Set Price Set Price Sets a price of the product. Parameters `$price` The price to set. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setPrice()`
`public GXEngineProduct`	# `setTaxClassId( IdType $id )` Set Tax Class ID Set Tax Class ID Sets a tax class ID for the product. Parameters `$id` The tax class ID to set. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setTaxClassId()`
`public GXEngineProduct`	# `setQuantity( DecimalType $quantity )` Set Quantity Set Quantity Sets a quantity for the product. Parameters `$quantity` The quantity to set. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setQuantity()`
`public GXEngineProduct`	# `setWeight( DecimalType $weight )` Set Weight Set Weight Sets the weight of a product. Parameters `$weight` The weight to set. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setWeight()`
`public GXEngineProduct`	# `setDiscountAllowed( DecimalType $discount )` Set Discount Allowed Set Discount Allowed Sets the allowed discount of a product. Parameters `$discount` The discount to set. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setDiscountAllowed()`
`public GXEngineProduct`	# `setShippingCosts( DecimalType $price )` Set Shipping Costs Set Shipping Costs Sets the shipping costs of a product. Parameters `$price` The shipping costs to set. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setShippingCosts()`
`public GXEngineProduct`	# `setShippingTimeId( IdType $id )` Set Shipping Time ID Set Shipping Time ID Sets the shipping time ID of a product. Parameters `$id` The shipping time ID to set. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setShippingTimeId()`
`public GXEngineProduct`	# `setProductTypeId( IdType $id )` Set Product Type ID. Set Product Type ID. Sets the product type ID of the product. Parameters `$id` Product type ID. Returns `GXEngineProduct` Implementation of `ProductInterface::setProductTypeId()`
`public GXEngineProduct`	# `setManufacturerId( IdType $id )` Set Manufacturer ID Set Manufacturer ID Sets the manufacturer ID of a product. Parameters `$id` The manufacturer ID to set. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setManufacturerId()`
`public GXEngineProduct`	# `setFsk18( BoolType $status )` Set FSK 18 Set FSK 18 Activates or deactivates FSK18 for a product. Parameters `$status` Should FSK be activated? Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setFsk18()`
`public GXEngineProduct`	# `setVpeActive( BoolType $status )` Set VPE Active Set VPE Active Activates or deactivates VPE for a product. Parameters `$status` Should VPE be activated? Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setVpeActive()`
`public GXEngineProduct`	# `setVpeId( IdType $id )` Set VPE ID Set VPE ID Sets the VPE ID of a product. Parameters `$id` The VPE ID to set. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setVpeId()`
`public GXEngineProduct`	# `setVpeValue( DecimalType $vpeValue )` Set VPE Value Set VPE Value Sets the VPE value of a product. Parameters `$vpeValue` The VPE value to set. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setVpeValue()`
`public GXEngineProduct`	# `setAddonValue( StringType $key, StringType $value )` Set Addon Value Set Addon Value Sets the addon value of a product. Parameters `$key` The key for the addon value. `$value` The value for the addon. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setAddonValue()`
`public GXEngineProduct`	# `addAddonValues( KeyValueCollection $keyValueCollection )` Add Addon Values Add Addon Values Adds a key value collection to a product. Parameters `$keyValueCollection` The key value collection to add. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::addAddonValues()`
`public GXEngineProduct`	# `deleteAddonValue( StringType $key )` Delete Addon Value Delete Addon Value Deletes an addon value of a product. Parameters `$key` The key of the addon value to delete. Returns `GXEngineProduct` Same instance for chained method calls. Throws InvalidArgumentException if the key is not valid. Implementation of `ProductInterface::deleteAddonValue()`
`public GXEngineProduct`	# `setAddedDateTime( DateTime $date )` Sets the added date time. Sets the added date time. Parameters `$date` Added date time. Returns `GXEngineProduct` Same instance for chained method calls. Implementation of `ProductInterface::setAddedDateTime()`
`public ProductImageContainer`	# `getImageContainer( )` Returns the image container of the product. Returns the image container of the product. Returns `ProductImageContainer` Product image container. Implementation of `ProductInterface::getImageContainer()`
`public ProductImage`	# `getPrimaryImage( )` Returns the product's primary image. Returns the product's primary image. Returns `ProductImage` Implementation of `ProductInterface::getPrimaryImage()`
`public ProductImageCollection`	# `getAdditionalImages( )` Returns a product's additional images. Returns a product's additional images. Returns `ProductImageCollection` Implementation of `ProductInterface::getAdditionalImages()`

Properties summary

`protected ProductSettingsInterface`	`$settings` Product settings. Product settings.	#
`protected boolean`	`$active` Determines whether this product is active. Determines whether this product is active.	# `false`
`protected integer`	`$sortOrder` Sort order. Sort order.	# `0`
`protected EmptyDateTime`	`$availableDateTime` Available DateTime. Available DateTime.	#
`protected DateTime`	`$addedDateTime` Added DateTime. Added DateTime.	#
`protected DateTime`	`$lastModifiedDateTime` Last modified DateTime. Last modified DateTime.	#
`protected EditableKeyValueCollection`	`$viewedCount` Viewed count. Viewed count.	#
`protected integer`	`$orderedCount` Ordered count. Ordered count.	# `0`
`protected EditableKeyValueCollection`	`$names` Names collection. Names collection.	#
`protected EditableKeyValueCollection`	`$descriptions` Description collection. Description collection.	#
`protected EditableKeyValueCollection`	`$shortDescriptions` Short description collection. Short description collection.	#
`protected EditableKeyValueCollection`	`$keywords` Keyword collection. Keyword collection.	#
`protected EditableKeyValueCollection`	`$metaTitles` Meta title collection. Meta title collection.	#
`protected EditableKeyValueCollection`	`$metaDescriptions` Meta description collection. Meta description collection.	#
`protected EditableKeyValueCollection`	`$metaKeywords` Meta keywords collection. Meta keywords collection.	#
`protected EditableKeyValueCollection`	`$url` URL. URL.	#
`protected EditableKeyValueCollection`	`$urlKeywords` URL keywords. URL keywords.	#
`protected EditableKeyValueCollection`	`$checkoutInformation` Checkout information collection. Checkout information collection.	#
`protected string`	`$productModel` Product model. Product model.	# `''`
`protected string`	`$ean` EAN. EAN.	# `''`
`protected float`	`$price` Price. Price.	# `0.00`
`protected integer`	`$taxClassId` Tax class ID. Tax class ID.	# `0`
`protected float`	`$quantity` Quantity. Quantity.	# `0.00`
`protected float`	`$weight` Weight. Weight.	# `0.00`
`protected float`	`$discountAllowed` Discount allowed. Discount allowed.	# `0.00`
`protected float`	`$shippingCosts` Shipping costs. Shipping costs.	# `0.00`
`protected integer`	`$shippingTimeId` Shipping time ID. Shipping time ID.	# `0`
`protected integer`	`$productTypeId` Product type ID. Product type ID.	# `0`
`protected integer`	`$manufacturerId` Manufacturer ID. Manufacturer ID.	# `0`
`protected boolean`	`$fsk18` Is FSK 18? Is FSK 18?	# `false`
`protected boolean`	`$vpeActive` Is VPE active? Is VPE active?	# `false`
`protected integer`	`$vpeId` VPE ID. VPE ID.	# `0`
`protected float`	`$vpeValue` VPE value. VPE value.	# `0.00`
`protected EditableKeyValueCollection`	`$addonValues` Addons collection. Addons collection.	#
`protected ProductImageContainer`	`$imageContainer` Image container. Image container.	#

Packages

Classes

Class GXEngineProduct

Direct known subclasses

Methods summary

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of