Class GXEngineProduct

GXEngineProduct implements ProductInterface

Direct known subclasses

StoredProduct

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

Methods summary


				
				 public 
				
				

				__construct( ProductSettingsInterface $settings )

GXEngineProduct constructor.


				
				 public 
				
				

				isActive( void )
				

				: boolean

Is Active


				
				 public 
				
				

				getSortOrder( void )
				

				: integer

Get Sort Order


				
				 public 
				
				

				getAvailableDateTime( void )
				

				: DateTime

Get Available Date Time


				
				 public 
				
				

				getAddedDateTime( void )
				

				: DateTime

Get Added Date Time


				
				 public 
				
				

				getLastModifiedDateTime( void )
				

				: DateTime

Get Last Modified Date Time


				
				 public 
				
				

				getViewedCount( LanguageCode $language )
				

				: integer

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 
				
				

				getOrderedCount( void )
				

				: integer

Get Ordered Count


				
				 public 
				
				

				getSettings( void )
				

				: ProductSettingsInterface

Get Product Settings.


				
				 public 
				
				

				getName( LanguageCode $language )
				

				: string

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 
				
				

				getDescription( LanguageCode $language )
				

				: string

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 
				
				

				getShortDescription( LanguageCode $language )
				

				: string

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 
				
				

				getKeywords( LanguageCode $language )
				

				: string

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 
				
				

				getMetaTitle( LanguageCode $language )
				

				: string

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 
				
				

				getMetaDescription( LanguageCode $language )
				

				: string

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 
				
				

				getMetaKeywords( LanguageCode $language )
				

				: string

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 
				
				

				getUrl( LanguageCode $language )
				

				: string

Get Info Url

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.

Parameters

$language: The language code of the URL to return.

Returns

string
Product's Manufacturer URL

Implementation of

ProductInterface::getUrl()


				
				 public 
				
				

				getInfoUrl( LanguageCode $language )
				

				: string

Get Info Url

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

Parameters

$language: The language code of the URL to return.

Returns

string
Product's Manufacturer URL

Implementation of

ProductInterface::getInfoUrl()


				
				 public 
				
				

				getUrlKeywords( LanguageCode $language )
				

				: string

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 
				
				

				getUrlRewrite( LanguageCode $language )
				

				: UrlRewrite

Get URL rewrite

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

Parameters

$language: The language code of the URL rewrite to be return.

Returns

UrlRewrite
The URL rewrite of the product.

Throws

InvalidArgumentException
if the language code is not valid.

Implementation of

ProductInterface::getUrlRewrite()


				
				 public 
				
				

				getUrlRewrites( void )
				

				: UrlRewriteCollection

Get URL rewrites


				
				 public 
				
				

				getCheckoutInformation( LanguageCode $language )
				

				: string

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 
				
				

				getProductModel( void )
				

				: string

Get Product Model


				
				 public 
				
				

				getEan( void )
				

				: string

Get EAN


				
				 public 
				
				

				getPrice( void )
				

				: float

Get Price


				
				 public 
				
				

				getTaxClassId( void )
				

				: integer

Get Tax Class ID


				
				 public 
				
				

				getQuantity( void )
				

				: float

Get Quantity


				
				 public 
				
				

				getWeight( void )
				

				: float

Get Weight


				
				 public 
				
				

				getDiscountAllowed( void )
				

				: float

Get Discount Allowed


				
				 public 
				
				

				getShippingCosts( void )
				

				: float

Get Shipping Costs


				
				 public 
				
				

				getShippingTimeId( void )
				

				: integer

Get Shipping Time ID


				
				 public 
				
				

				getProductTypeId( void )
				

				: integer

Get Product Type ID.


				
				 public 
				
				

				getManufacturerId( void )
				

				: integer

Get Manufacturer ID


				
				 public 
				
				

				getQuantityUnitId( void )
				

				: integer

Get Quantity Unit ID


				
				 public 
				
				

				isFsk18( void )
				

				: boolean

Is FSK 18


				
				 public 
				
				

				isVpeActive( void )
				

				: boolean

Is VPE Active


				
				 public 
				
				

				getVpeId( void )
				

				: integer

Get VPE ID.


				
				 public 
				
				

				getVpeValue( void )
				

				: float

Get VPE Value


				
				 public 
				
				

				getAddonValue( StringType $key )
				

				: string

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 
				
				

				getAddonValues( void )
				

				: KeyValueCollection

Get Addon Values


				
				 public 
				
				

				setActive( BoolType $status )
				

				: GXEngineProduct

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 
				
				

				setSortOrder( IntType $sortOrder )
				

				: GXEngineProduct

Set Sort Order


				
				 public 
				
				

				setAvailableDateTime( DateTime $date )
				

				: GXEngineProduct

Set Available Date Time


				
				 public 
				
				

				setLastModifiedDateTime( DateTime $date )
				

				: GXEngineProduct

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 
				
				

				setViewedCount( IntType $count, LanguageCode $language )
				

				: GXEngineProduct

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 
				
				

				setOrderedCount( IntType $count )
				

				: GXEngineProduct

Set Ordered Count


				
				 public 
				
				

				setImageContainer( ProductImageContainerInterface $images )
				

				: GXEngineProduct

Set Image Container


				
				 public 
				
				

				setSettings( ProductSettingsInterface $productSettings )
				

				: GXEngineProduct

Sets a product setting object


				
				 public 
				
				

				setName( StringType $text, LanguageCode $language )
				

				: GXEngineProduct

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 
				
				

				setDescription( StringType $text, LanguageCode $language )
				

				: GXEngineProduct

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 
				
				

				setShortDescription( StringType $text, LanguageCode $language )
				

				: GXEngineProduct

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 
				
				

				setKeywords( StringType $text, LanguageCode $language )
				

				: GXEngineProduct

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 
				
				

				setMetaTitle( StringType $text, LanguageCode $language )
				

				: GXEngineProduct

Set Meta title.


				
				 public 
				
				

				setMetaDescription( StringType $text, LanguageCode $language )
				

				: GXEngineProduct

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 
				
				

				setMetaKeywords( StringType $text, LanguageCode $language )
				

				: GXEngineProduct

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 
				
				

				setUrl( StringType $url, LanguageCode $language )
				

				: GXEngineProduct

Set Product's Info URL

Sets the product's info URL (e.g. homepage of the manufacturer).

Deprecated

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

Parameters

$url: The URL.
$language: The language code.

Returns

GXEngineProduct
Same instance for chained method calls.

Implementation of

ProductInterface::setUrl()


				
				 public 
				
				

				setInfoUrl( StringType $url, LanguageCode $language )
				

				: GXEngineProduct

Set Product's Info URL

Sets the product's info URL (e.g. homepage of the manufacturer).

Parameters

$url: The URL.
$language: The language code.

Returns

GXEngineProduct
Same instance for chained method calls.

Implementation of

ProductInterface::setInfoUrl()


				
				 public 
				
				

				setUrlKeywords( StringType $text, LanguageCode $language )
				

				: GXEngineProduct

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 
				
				

				setUrlRewrite( UrlRewrite $urlRewrite, LanguageCode $language )
				

				: GXEngineProduct

Set URL rewrite

Sets the products URL rewrite for the provided language code.

Parameters

$urlRewrite: The URL rewrite instance.
$language: The language code for the URL keywords.

Returns

GXEngineProduct
Same instance for chained method calls.

Implementation of

ProductInterface::setUrlRewrite()


				
				 public 
				
				

				setUrlRewrites( UrlRewriteCollection $urlRewrites )
				

				: GXEngineProduct

Set URL rewrites


				
				 public 
				
				

				setCheckoutInformation( StringType $text, LanguageCode $language )
				

				: GXEngineProduct

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 
				
				

				setProductModel( StringType $model )
				

				: GXEngineProduct

Set Product Model


				
				 public 
				
				

				setEan( StringType $ean )
				

				: GXEngineProduct

Set EAN


				
				 public 
				
				

				setPrice( DecimalType $price )
				

				: GXEngineProduct

Set Price


				
				 public 
				
				

				setTaxClassId( IdType $id )
				

				: GXEngineProduct

Set Tax Class ID


				
				 public 
				
				

				setQuantity( DecimalType $quantity )
				

				: GXEngineProduct

Set Quantity


				
				 public 
				
				

				setWeight( DecimalType $weight )
				

				: GXEngineProduct

Set Weight


				
				 public 
				
				

				setDiscountAllowed( DecimalType $discount )
				

				: GXEngineProduct

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 
				
				

				setShippingCosts( DecimalType $price )
				

				: GXEngineProduct

Set Shipping Costs


				
				 public 
				
				

				setShippingTimeId( IdType $id )
				

				: GXEngineProduct

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 
				
				

				setProductTypeId( IdType $id )
				

				: GXEngineProduct

Set Product Type ID.


				
				 public 
				
				

				setManufacturerId( IdType $id )
				

				: GXEngineProduct

Set Manufacturer ID


				
				 public 
				
				

				setQuantityUnitId( IdType $id )
				

				: ProductInterface

Set Quantity Uniz ID

Sets the quantity unit ID of a product.

Parameters

$id: The quantity unit ID to set.

Returns

ProductInterface
Same instance for chained method calls.

Implementation of

ProductInterface::setQuantityUnitId()


				
				 public 
				
				

				setFsk18( BoolType $status )
				

				: GXEngineProduct

Set FSK 18


				
				 public 
				
				

				setVpeActive( BoolType $status )
				

				: GXEngineProduct

Set VPE Active


				
				 public 
				
				

				setVpeId( IdType $id )
				

				: GXEngineProduct

Set VPE ID


				
				 public 
				
				

				setVpeValue( DecimalType $vpeValue )
				

				: GXEngineProduct

Set VPE Value


				
				 public 
				
				

				setAddonValue( StringType $key, StringType $value )
				

				: GXEngineProduct

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 
				
				

				addAddonValues( KeyValueCollection $keyValueCollection )
				

				: GXEngineProduct

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 
				
				

				deleteAddonValue( StringType $key )
				

				: GXEngineProduct

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 
				
				

				setAddedDateTime( DateTime $date )
				

				: GXEngineProduct

Sets the added date time.


				
				 public 
				
				

				getImageContainer( void )
				

				: ProductImageContainer

Returns the image container of the product.


				
				 public 
				
				

				getPrimaryImage( void )
				

				: ProductImage

Returns the product's primary image.


				
				 public 
				
				

				getAdditionalImages( void )
				

				: ProductImageCollection

Returns a product's additional images.

Properties summary


				
				protected  
				

				
					$settings
				

				: ProductSettingsInterface

Product settings


				
				protected  
				

				
					$active
				

				: boolean

Determines whether this product is active.

false


				
				protected  
				

				
					$sortOrder
				

				: integer

Sort order


				
				protected  
				

				
					$availableDateTime
				

				: EmptyDateTime

Available DateTime


				
				protected  
				

				
					$addedDateTime
				

				: DateTime

Added DateTime


				
				protected  
				

				
					$lastModifiedDateTime
				

				: DateTime

Last modified DateTime


				
				protected  
				

				
					$viewedCount
				

				: EditableKeyValueCollection

Viewed count


				
				protected  
				

				
					$orderedCount
				

				: integer

Ordered count


				
				protected  
				

				
					$names
				

				: EditableKeyValueCollection

Names collection


				
				protected  
				

				
					$descriptions
				

				: EditableKeyValueCollection

Description collection


				
				protected  
				

				
					$shortDescriptions
				

				: EditableKeyValueCollection

Short description collection


				
				protected  
				

				
					$keywords
				

				: EditableKeyValueCollection

Keyword collection


				
				protected  
				

				
					$metaTitles
				

				: EditableKeyValueCollection

Meta title collection


				
				protected  
				

				
					$metaDescriptions
				

				: EditableKeyValueCollection

Meta description collection


				
				protected  
				

				
					$metaKeywords
				

				: EditableKeyValueCollection

Meta keywords collection


				
				protected  
				

				
					$url
				

				: EditableKeyValueCollection

Manufacturer URL


				
				protected  
				

				
					$urlKeywords
				

				: EditableKeyValueCollection

URL keywords


				
				protected  
				

				
					$urlRewrites
				

				: UrlRewriteCollection

URL rewrites


				
				protected  
				

				
					$checkoutInformation
				

				: EditableKeyValueCollection

Checkout information collection


				
				protected  
				

				
					$productModel
				

				: string

Product model

''


				
				protected  
				

				
					$ean
				

				: string

EAN

''


				
				protected  
				

				
					$price
				

				: float

Price

0.00


				
				protected  
				

				
					$taxClassId
				

				: integer

Tax class ID


				
				protected  
				

				
					$quantity
				

				: float

Quantity

0.00


				
				protected  
				

				
					$weight
				

				: float

Weight

0.00


				
				protected  
				

				
					$discountAllowed
				

				: float

Discount allowed

0.00


				
				protected  
				

				
					$shippingCosts
				

				: float

Shipping costs

0.00


				
				protected  
				

				
					$shippingTimeId
				

				: integer

Shipping time ID


				
				protected  
				

				
					$productTypeId
				

				: integer

Product type ID


				
				protected  
				

				
					$manufacturerId
				

				: integer

Manufacturer ID


				
				protected  
				

				
					$quantityUnitId
				

				: integer

Quantity Unit ID


				
				protected  
				

				
					$fsk18
				

				: boolean

Is FSK 18?

false


				
				protected  
				

				
					$vpeActive
				

				: boolean

Is VPE active?

false


				
				protected  
				

				
					$vpeId
				

				: integer

VPE ID


				
				protected  
				

				
					$vpeValue
				

				: float

VPE value

0.00


				
				protected  
				

				
					$addonValues
				

				: EditableKeyValueCollection

Addons collection


				
				protected  
				

				
					$imageContainer
				

				: ProductImageContainer

Image container


				
				protected  
				

				
					$infoUrl
				

				: EditableKeyValueCollection

Url for further information of the product (e.g. manufacturer homepage)