Interface ProductInterface
Interface ProductInterface
Methods summary
public
isActive( void )
: boolean
Is Active
Checks if a product is active.
Returns
boolean
public
getSortOrder( void )
: integer
Get Sort Order
Returns an integer which represents a specific sort order.
Returns
integer
The sort order.
public
getAvailableDateTime( void )
: DateTime
Get Available Date Time
Returns the available date time of the product.
Returns
DateTime
The available date time.
public
getAddedDateTime( void )
: DateTime
Get Added Date Time
Returns the added date time of the product.
Returns
DateTime
The added date time.
public
getLastModifiedDateTime( void )
: DateTime
Get Last Modified Date Time
Get Last Modified Date Time
Returns the last modified date time.
Returns
DateTime
The 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.
public
getOrderedCount( void )
: integer
Get Ordered Count
Returns the ordered count of the product.
Returns
integer
The ordered count.
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 language to return.
Returns
string
The name of the product.
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 language to return.
Returns
string
The description of the product.
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 language to return.
Returns
string
The short description of the product.
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 language to return.
Returns
string
The keywords of the product.
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
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
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 language to return.
Returns
string
The URL keywords of the product.
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
public
getProductModel( void )
: string
Get Product Model
Returns the product model.
Returns
string
The product model.
public
getEan( void )
: string
Get EAN
Returns the EAN of the product.
Returns
string
The EAN of the product.
public
getPrice( void )
: float
Get Price
Returns the price of a product.
Returns
float
The price of the product.
public
getTaxClassId( void )
: integer
Get Tax Class ID
Returns the tax class ID of the product.
Returns
integer
The tax class ID.
public
getQuantity( void )
: float
Get Quantity
Returns the quantity of the product.
Returns
float
The quantity of the product.
public
getWeight( void )
: float
Get Weight
Returns the weight of the product.
Returns
float
The weight of the product.
public
getDiscountAllowed( void )
: float
Get Discount Allowed
Returns the allowed discount.
Returns
float
The allowed discount.
public
getShippingCosts( void )
: float
Get Shipping Costs
Returns the shipping cost of the product.
Returns
float
The shipping costs of the product.
public
getShippingTimeId( void )
: integer
Get Shipping Time ID
Returns the shipping time ID of the product.
Returns
integer
The shipping time ID.
public
getProductTypeId( void )
: integer
Get Product Type ID.
Returns the product type ID.
Returns
integer
The product type ID.
public
getManufacturerId( void )
: integer
Get Manufacturer ID
Returns the manufacturer ID.
Returns
integer
The manufacturer ID.
public
getQuantityUnitId( void )
: integer
Get Quantity Unit ID
Returns the quantity unit ID.
Returns
integer
The quantity unit ID.
public
isFsk18( void )
: boolean
Is FSK 18
Checks if the product is only available for FSK 18.
Returns
boolean
Is the product FSK18?
public
isVpeActive( void )
: boolean
Is VPE Active
Checks if VPE is active on the product.
Returns
boolean
Is VPE active on the product?
public
getVpeId( void )
: integer
Get VPE ID.
Returns the VPE ID.
Returns
integer
VPE ID.
public
getVpeValue( void )
: float
Get VPE Value
Returns the VPE value.
Returns
float
The 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.
public
setActive( BoolType $status )
: ProductInterface
Set Active
Activates or deactivates a product status.
Parameters
$status
- Should the product status be activated?
Returns
public
setLastModifiedDateTime( DateTime $date )
: ProductInterface
Set Last Modified Date Time
Set Last Modified Date Time
Sets the last modified date time.
Parameters
$date
- The last modified date time.
Returns
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
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
public
setFsk18( BoolType $status )
: ProductInterface
Set FSK 18
Activates or deactivates FSK18 for a product.
Parameters
$status
- Should FSK be activated?
Returns
public
setAddedDateTime( DateTime $date )
: ProductInterface
Sets the added date time.
Sets the added date time.
Parameters
$date
- Added date time to set.
Returns