API Documentation
Back to top  

FeaturedProduct

Implements \FeaturedProductInterface

Class FeaturedProduct

package

Default

Methods

FeaturedProduct constructor.

__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)

Arguments

$settings

\FeaturedProductSettingsInterface

$productsId

\IntType

$name

\StringType

$vpeID

\IntType

$image

\StringType

$imageAltText

\StringType

$shortDescription

\StringType

$metaDescription

\StringType

$shippingStatusName

\StringType

$price

\DecimalType

$taxClassId

\IntType

$quantity

\DecimalType

Returns the image.

getImage() : string

Response

string

Returns the alternative image text.

getImageAltText() : string

Response

string

Returns product meta description.

getMetaDescription() : string

Response

string

Returns the name of the product.

getName() : string

Response

string

Returns product price.

getPrice() : float

Response

float

Returns the product ID.

getProductsId() : integer

Response

integer

Returns product tax class ID.

getQuantity() : float

Response

float

Return the featured product settings

getSettings() : \FeaturedProductSettingsInterface

Response

\FeaturedProductSettingsInterface

Returns shipping status name.

getShippingStatusName() : string

Response

string

Returns product short description.

getShortDescription() : string

Response

string

Returns product tax class ID.

getTaxClassId() : integer

Response

integer

Get VPE ID

getVpeID() : integer

Response

integer

VPE ID.

Properties

settings

settings : \FeaturedProductSettingsInterface
var

Type(s)

\FeaturedProductSettingsInterface

Product ID

productsId : integer
var

Type(s)

integer

Product name.

name : string
var

Type(s)

string

VPE ID

vpeID : integer
var

Type(s)

integer

Image

image : string
var

Type(s)

string

Image alternative text

imageAltText : string
var

Type(s)

string

Product short description

shortDescription : string
var

Type(s)

string

Product meta description

metaDescription : string
var

Type(s)

string

Shipping status name.

shippingStatusName : string
var

Type(s)

string

Product price.

price : float
var

Type(s)

float

Product tax class ID.

taxClassId : float
var

Type(s)

float

Product quantity.

quantity : float
var

Type(s)

float