FeaturedProduct
in package
implements
FeaturedProductInterface
Class FeaturedProduct
Interfaces, Classes and Traits
Table of Contents
- $image : string
- Image
- $imageAltText : string
- Image alternative text
- $metaDescription : string
- Product meta description
- $name : string
- Product name.
- $price : float
- Product price.
- $productsId : int
- Product ID
- $quantity : float
- Product quantity.
- $settings : FeaturedProductSettingsInterface
- $shippingStatusName : string
- Shipping status name.
- $shortDescription : string
- Product short description
- $taxClassId : float
- Product tax class ID.
- $vpeID : int
- VPE ID
- __construct() : mixed
- FeaturedProduct constructor.
- getImage() : string
- Returns the image.
- getImageAltText() : string
- Returns the alternative image text.
- getMetaDescription() : string
- Returns product meta description.
- getName() : string
- Returns the name of the product.
- getPrice() : float
- Returns product price.
- getProductsId() : int
- Returns the product ID.
- getQuantity() : float
- Returns product tax class ID.
- getSettings() : FeaturedProductSettingsInterface
- Return the featured product settings
- getShippingStatusName() : string
- Returns shipping status name.
- getShortDescription() : string
- Returns product short description.
- getTaxClassId() : int
- Returns product tax class ID.
- getVpeID() : int
- Get VPE ID
Properties
$image
Image
protected
string
$image
$imageAltText
Image alternative text
protected
string
$imageAltText
$metaDescription
Product meta description
protected
string
$metaDescription
$name
Product name.
protected
string
$name
$price
Product price.
protected
float
$price
$productsId
Product ID
protected
int
$productsId
$quantity
Product quantity.
protected
float
$quantity
$settings
protected
FeaturedProductSettingsInterface
$settings
$shippingStatusName
Shipping status name.
protected
string
$shippingStatusName
$shortDescription
Product short description
protected
string
$shortDescription
$taxClassId
Product tax class ID.
protected
float
$taxClassId
$vpeID
VPE ID
protected
int
$vpeID
Methods
__construct()
FeaturedProduct constructor.
public
__construct(FeaturedProductSettingsInterface $settings, IntType $productsId, StringType $name, IntType $vpeID, StringType $image, StringType $imageAltText, StringType $shortDescription, StringType $metaDescription, StringType $shippingStatusName, DecimalType $price, IntType $taxClassId, DecimalType $quantity) : mixed
Parameters
- $settings : FeaturedProductSettingsInterface
- $productsId : IntType
- $name : StringType
- $vpeID : IntType
- $image : StringType
- $imageAltText : StringType
- $shortDescription : StringType
- $metaDescription : StringType
- $shippingStatusName : StringType
- $price : DecimalType
- $taxClassId : IntType
- $quantity : DecimalType
Return values
mixed —getImage()
Returns the image.
public
getImage() : string
Return values
string —getImageAltText()
Returns the alternative image text.
public
getImageAltText() : string
Return values
string —getMetaDescription()
Returns product meta description.
public
getMetaDescription() : string
Return values
string —getName()
Returns the name of the product.
public
getName() : string
Return values
string —getPrice()
Returns product price.
public
getPrice() : float
Return values
float —getProductsId()
Returns the product ID.
public
getProductsId() : int
Return values
int —getQuantity()
Returns product tax class ID.
public
getQuantity() : float
Return values
float —getSettings()
Return the featured product settings
public
getSettings() : FeaturedProductSettingsInterface
Return values
FeaturedProductSettingsInterface —getShippingStatusName()
Returns shipping status name.
public
getShippingStatusName() : string
Return values
string —getShortDescription()
Returns product short description.
public
getShortDescription() : string
Return values
string —getTaxClassId()
Returns product tax class ID.
public
getTaxClassId() : int
Return values
int —getVpeID()
Get VPE ID
public
getVpeID() : int
Return values
int —VPE ID.