ProductListItem
in package
Class ProductListItem
Tags
Table of Contents
- $active : bool
- Product Active Status
- $addedDateTime : DateTime
- Added DateTime
- $availableDateTime : DateTime
- Available DateTime
- $discountAllowed : float
- Discount Allowed
- $ean : string
- EAN
- $fsk18 : bool
- FSK 18 Status
- $image : string
- Image
- $imageAltText : string
- Image alternative text
- $lastModifiedDateTime : DateTime
- Last Modified DateTime
- $mainCategoryId : int
- Main category id.
- $manufacturerId : int
- Manufacturer ID
- $name : string
- Product Name
- $orderedCount : int
- Ordered Count
- $price : float
- Price
- $productId : int
- Product ID
- $productModel : string
- Product Model
- $productRepository : ProductRepositoryInterface
- Product repository.
- $productTypeId : int
- Product Type ID
- $quantity : float
- Quantity
- $quantityUnitId : int
- Manufacturer ID
- $shippingCosts : float
- Shipping costs
- $shippingTimeId : int
- Shipping Time ID
- $sortOrder : int
- Sort Order
- $specialOfferId : int
- Special offer id.
- $taxClassId : int
- Tax Class ID
- $urlKeywords : string
- URL Keywords
- $vpeActive : bool
- VPE Active Status
- $vpeId : int
- VPE ID
- $vpeValue : float
- VPE Value
- $weight : float
- Weight
- __construct() : mixed
- ProductListItem constructor.
- getAddedDateTime() : DateTime
- Get Added Date Time
- getAvailableDateTime() : DateTime
- Get Available Date Time
- getDiscountAllowed() : float
- Get Discount Allowed
- getEan() : string
- Get EAN
- getImage() : string
- Returns the image.
- getImageAltText() : string
- Returns the alternative image text.
- getLastModifiedDateTime() : DateTime
- Get Last Modified Date Time
- getMainCategoryId() : int
- Returns the Main Category id.
- getManufacturerId() : int
- Get Manufacturer ID
- getName() : string
- Returns the name of the product.
- getOrderedCount() : int
- Get Ordered Count
- getPrice() : float
- Get Price
- getProductId() : int
- Returns the product ID.
- getProductModel() : string
- Get Product Model
- getProductObject() : StoredProductInterface
- Returns the product object.
- getProductTypeId() : int
- Get Product Type ID.
- getQuantity() : float
- Get Quantity
- getQuantityUnitId() : int
- Get Quantity Unit ID
- getShippingCosts() : float
- Get Shipping Costs
- getShippingTimeId() : int
- Get Shipping Time ID
- getSortOrder() : int
- Get Sort Order
- getSpecialOfferId() : int
- Returns the Special offer id.
- getTaxClassId() : int
- Get Tax Class ID
- getUrlKeywords() : string
- Returns the URL keywords.
- getVpeId() : int
- Get VPE ID
- getVpeValue() : float
- Get VPE Value
- getWeight() : float
- Get Weight
- isActive() : bool
- Checks if product is active or not.
- isFsk18() : bool
- Is FSK 18
- isVpeActive() : bool
- Is VPE Active
- setActive() : ProductListItem
- Set active state value.
- setAddedDateTime() : ProductListItem
- Sets the added date time.
- setAvailableDateTime() : ProductListItem
- Set Available Date Time
- setDiscountAllowed() : ProductListItem
- Set Discount Allowed
- setEan() : ProductListItem
- Set EAN
- setFsk18() : ProductListItem
- Set FSK 18
- setImage() : ProductListItem
- Set product image.
- setImageAltText() : ProductListItem
- Set image alt text.
- setLastModifiedDateTime() : ProductListItem
- Set Last Modified Date Time
- setMainCategoryId() : ProductListItem
- Set main category id.
- setManufacturerId() : ProductListItem
- Set Manufacturer ID
- setName() : ProductListItem
- Set product name.
- setOrderedCount() : ProductListItem
- Set Ordered Count
- setPrice() : ProductListItem
- Set Price
- setProductId() : ProductListItem
- Set Product ID value.
- setProductModel() : ProductListItem
- Set Product Model
- setProductTypeId() : ProductListItem
- Set Product Type ID.
- setQuantity() : ProductListItem
- Set Quantity
- setQuantityUnitId() : ProductListItem
- Set Quantity Unit ID
- setShippingCosts() : ProductListItem
- Set Shipping Costs
- setShippingTimeId() : ProductListItem
- Set Shipping Time ID
- setSortOrder() : ProductListItem
- Set Sort Order
- setSpecialOfferId() : ProductListItem
- Set Special offer id.
- setTaxClassId() : ProductListItem
- Set Tax Class ID
- setUrlKeywords() : ProductListItem
- Set product URL keywords.
- setVpeActive() : ProductListItem
- Set VPE Active
- setVpeId() : ProductListItem
- Set VPE ID
- setVpeValue() : ProductListItem
- Set VPE Value
- setWeight() : ProductListItem
- Set Weight
Properties
$active
Product Active Status
protected
bool
$active
= alse
$addedDateTime
Added DateTime
protected
DateTime
$addedDateTime
$availableDateTime
Available DateTime
protected
DateTime
$availableDateTime
$discountAllowed
Discount Allowed
protected
float
$discountAllowed
= 0.0
$ean
EAN
protected
string
$ean
= ''
$fsk18
FSK 18 Status
protected
bool
$fsk18
= alse
$image
Image
protected
string
$image
= ''
$imageAltText
Image alternative text
protected
string
$imageAltText
= ''
$lastModifiedDateTime
Last Modified DateTime
protected
DateTime
$lastModifiedDateTime
$mainCategoryId
Main category id.
protected
int
$mainCategoryId
= 0
$manufacturerId
Manufacturer ID
protected
int
$manufacturerId
= 0
$name
Product Name
protected
string
$name
= ''
$orderedCount
Ordered Count
protected
int
$orderedCount
= 0
$price
Price
protected
float
$price
= 0.0
$productId
Product ID
protected
int
$productId
= 0
$productModel
Product Model
protected
string
$productModel
= ''
$productRepository
Product repository.
protected
ProductRepositoryInterface
$productRepository
$productTypeId
Product Type ID
protected
int
$productTypeId
= 0
$quantity
Quantity
protected
float
$quantity
= 0.0
$quantityUnitId
Manufacturer ID
protected
int
$quantityUnitId
= 0
$shippingCosts
Shipping costs
protected
float
$shippingCosts
= 0.0
$shippingTimeId
Shipping Time ID
protected
int
$shippingTimeId
= 0
$sortOrder
Sort Order
protected
int
$sortOrder
= 0
$specialOfferId
Special offer id.
protected
int
$specialOfferId
= 0
$taxClassId
Tax Class ID
protected
int
$taxClassId
= 0
$urlKeywords
URL Keywords
protected
string
$urlKeywords
= ''
$vpeActive
VPE Active Status
protected
bool
$vpeActive
= alse
$vpeId
VPE ID
protected
int
$vpeId
= 0
$vpeValue
VPE Value
protected
float
$vpeValue
= 0.0
$weight
Weight
protected
float
$weight
= 0.0
Methods
__construct()
ProductListItem constructor.
public
__construct(ProductRepositoryInterface $productRepository[, IdType $productId = null ][, BoolType $isActive = null ][, StringType $name = null ][, StringType $urlKeywords = null ][, StringType $image = null ][, StringType $imageAltText = null ]) : mixed
Parameters
- $productRepository : ProductRepositoryInterface
-
Product Repository.
- $productId : IdType = null
-
Optional (null), product ID.
- $isActive : BoolType = null
-
Optional (null), product active status.
- $name : StringType = null
-
Optional (null), product name.
- $urlKeywords : StringType = null
-
Optional (null), URL keywords.
- $image : StringType = null
-
Optional (null), product image.
- $imageAltText : StringType = null
-
Optional (null), product image alternative text.
Tags
Return values
mixed —getAddedDateTime()
Get Added Date Time
public
getAddedDateTime() : DateTime
Return values
DateTime —The added date time.
getAvailableDateTime()
Get Available Date Time
public
getAvailableDateTime() : DateTime
Return values
DateTime —The available date time.
getDiscountAllowed()
Get Discount Allowed
public
getDiscountAllowed() : float
Return values
float —The allowed discount.
getEan()
Get EAN
public
getEan() : string
Return values
string —The EAN of the product.
getImage()
Returns the image.
public
getImage() : string
Return values
string —getImageAltText()
Returns the alternative image text.
public
getImageAltText() : string
Return values
string —getLastModifiedDateTime()
Get Last Modified Date Time
public
getLastModifiedDateTime() : DateTime
Return values
DateTime —The last modified date time.
getMainCategoryId()
Returns the Main Category id.
public
getMainCategoryId() : int
Return values
int —The main category id.
getManufacturerId()
Get Manufacturer ID
public
getManufacturerId() : int
Return values
int —The manufacturer ID.
getName()
Returns the name of the product.
public
getName() : string
Return values
string —getOrderedCount()
Get Ordered Count
public
getOrderedCount() : int
Return values
int —The ordered count.
getPrice()
Get Price
public
getPrice() : float
Return values
float —The price of the product.
getProductId()
Returns the product ID.
public
getProductId() : int
Return values
int —getProductModel()
Get Product Model
public
getProductModel() : string
Return values
string —The product model.
getProductObject()
Returns the product object.
public
getProductObject() : StoredProductInterface
Return values
StoredProductInterface —Returns same instance for chained calls.
getProductTypeId()
Get Product Type ID.
public
getProductTypeId() : int
Return values
int —The product type ID.
getQuantity()
Get Quantity
public
getQuantity() : float
Return values
float —The quantity of the product.
getQuantityUnitId()
Get Quantity Unit ID
public
getQuantityUnitId() : int
Return values
int —The quantity unit ID.
getShippingCosts()
Get Shipping Costs
public
getShippingCosts() : float
Return values
float —The shipping costs of the product.
getShippingTimeId()
Get Shipping Time ID
public
getShippingTimeId() : int
Return values
int —The shipping time ID.
getSortOrder()
Get Sort Order
public
getSortOrder() : int
Return values
int —The sort order.
getSpecialOfferId()
Returns the Special offer id.
public
getSpecialOfferId() : int
Return values
int —The special offer id.
getTaxClassId()
Get Tax Class ID
public
getTaxClassId() : int
Return values
int —The tax class ID.
getUrlKeywords()
Returns the URL keywords.
public
getUrlKeywords() : string
Return values
string —getVpeId()
Get VPE ID
public
getVpeId() : int
Return values
int —VPE ID.
getVpeValue()
Get VPE Value
public
getVpeValue() : float
Return values
float —The VPE value.
getWeight()
Get Weight
public
getWeight() : float
Return values
float —The weight of the product.
isActive()
Checks if product is active or not.
public
isActive() : bool
Return values
bool —isFsk18()
Is FSK 18
public
isFsk18() : bool
Return values
bool —Is the product FSK18?
isVpeActive()
Is VPE Active
public
isVpeActive() : bool
Return values
bool —Is VPE active on the product?
setActive()
Set active state value.
public
setActive(BoolType $status) : ProductListItem
Parameters
- $status : BoolType
Return values
ProductListItem —Returns same instance for chained calls.
setAddedDateTime()
Sets the added date time.
public
setAddedDateTime(DateTime $date) : ProductListItem
Parameters
- $date : DateTime
Return values
ProductListItem —Returns same instance for chained calls.
setAvailableDateTime()
Set Available Date Time
public
setAvailableDateTime(DateTime $date) : ProductListItem
Parameters
- $date : DateTime
Return values
ProductListItem —Returns same instance for chained calls.
setDiscountAllowed()
Set Discount Allowed
public
setDiscountAllowed(DecimalType $discount) : ProductListItem
Parameters
- $discount : DecimalType
-
The discount to set.
Return values
ProductListItem —Returns same instance for chained calls.
setEan()
Set EAN
public
setEan(StringType $ean) : ProductListItem
Parameters
- $ean : StringType
-
The EAN to set.
Return values
ProductListItem —Returns same instance for chained calls.
setFsk18()
Set FSK 18
public
setFsk18(BoolType $status) : ProductListItem
Parameters
- $status : BoolType
Return values
ProductListItem —Returns same instance for chained calls.
setImage()
Set product image.
public
setImage(StringType $image) : ProductListItem
Parameters
- $image : StringType
Return values
ProductListItem —Returns same instance for chained calls.
setImageAltText()
Set image alt text.
public
setImageAltText(StringType $imageAltText) : ProductListItem
Parameters
- $imageAltText : StringType
Return values
ProductListItem —Returns same instance for chained calls.
setLastModifiedDateTime()
Set Last Modified Date Time
public
setLastModifiedDateTime(DateTime $date) : ProductListItem
Parameters
- $date : DateTime
-
The last modified date time.
Return values
ProductListItem —Returns same instance for chained calls.
setMainCategoryId()
Set main category id.
public
setMainCategoryId(IdType $id) : ProductListItem
Parameters
- $id : IdType
Return values
ProductListItem —Returns same instance for chained calls.
setManufacturerId()
Set Manufacturer ID
public
setManufacturerId(IdType $id) : ProductListItem
Parameters
- $id : IdType
-
The manufacturer ID to set.
Return values
ProductListItem —Returns same instance for chained calls.
setName()
Set product name.
public
setName(StringType $name) : ProductListItem
Parameters
- $name : StringType
Return values
ProductListItem —Returns same instance for chained calls.
setOrderedCount()
Set Ordered Count
public
setOrderedCount(IntType $count) : ProductListItem
Parameters
- $count : IntType
-
The ordered count.
Return values
ProductListItem —Returns same instance for chained calls.
setPrice()
Set Price
public
setPrice(DecimalType $price) : ProductListItem
Parameters
- $price : DecimalType
-
The price to set.
Return values
ProductListItem —Returns same instance for chained calls.
setProductId()
Set Product ID value.
public
setProductId(IdType $id) : ProductListItem
Parameters
- $id : IdType
Return values
ProductListItem —Returns same instance for chained calls.
setProductModel()
Set Product Model
public
setProductModel(StringType $model) : ProductListItem
Parameters
- $model : StringType
-
The product model.
Return values
ProductListItem —Returns same instance for chained calls.
setProductTypeId()
Set Product Type ID.
public
setProductTypeId(IdType $id) : ProductListItem
Parameters
- $id : IdType
-
Product type ID.
Return values
ProductListItem —setQuantity()
Set Quantity
public
setQuantity(DecimalType $quantity) : ProductListItem
Parameters
- $quantity : DecimalType
-
The quantity to set.
Return values
ProductListItem —Returns same instance for chained calls.
setQuantityUnitId()
Set Quantity Unit ID
public
setQuantityUnitId(IdType $id) : ProductListItem
Parameters
- $id : IdType
-
The quantity unit ID to set.
Return values
ProductListItem —Returns same instance for chained calls.
setShippingCosts()
Set Shipping Costs
public
setShippingCosts(DecimalType $price) : ProductListItem
Parameters
- $price : DecimalType
-
The shipping costs to set.
Return values
ProductListItem —Returns same instance for chained calls.
setShippingTimeId()
Set Shipping Time ID
public
setShippingTimeId(IdType $id) : ProductListItem
Parameters
- $id : IdType
-
The shipping time ID to set.
Return values
ProductListItem —Returns same instance for chained calls.
setSortOrder()
Set Sort Order
public
setSortOrder(IntType $sortOrder) : ProductListItem
Parameters
- $sortOrder : IntType
-
The sort order.
Return values
ProductListItem —Returns same instance for chained calls.
setSpecialOfferId()
Set Special offer id.
public
setSpecialOfferId(IdType $id) : ProductListItem
Parameters
- $id : IdType
Return values
ProductListItem —Returns same instance for chained calls.
setTaxClassId()
Set Tax Class ID
public
setTaxClassId(IdType $id) : ProductListItem
Parameters
- $id : IdType
-
The tax class ID to set.
Return values
ProductListItem —Returns same instance for chained calls.
setUrlKeywords()
Set product URL keywords.
public
setUrlKeywords(StringType $urlKeywords) : ProductListItem
Parameters
- $urlKeywords : StringType
Return values
ProductListItem —Returns same instance for chained calls.
setVpeActive()
Set VPE Active
public
setVpeActive(BoolType $status) : ProductListItem
Parameters
- $status : BoolType
Return values
ProductListItem —Returns same instance for chained calls.
setVpeId()
Set VPE ID
public
setVpeId(IdType $id) : ProductListItem
Parameters
- $id : IdType
Return values
ProductListItem —Returns same instance for chained calls.
setVpeValue()
Set VPE Value
public
setVpeValue(DecimalType $vpeValue) : ProductListItem
Parameters
- $vpeValue : DecimalType
Return values
ProductListItem —Returns same instance for chained calls.
setWeight()
Set Weight
public
setWeight(DecimalType $weight) : ProductListItem
Parameters
- $weight : DecimalType
-
The weight to set.
Return values
ProductListItem —Returns same instance for chained calls.