API Documentation
Back to top  

ProductListItem

Class ProductListItem

category

System
package

Product
subpackage

Entities

Methods

ProductListItem constructor.

__construct(\ProductRepositoryInterface $productRepository, \IdType $productId = null, \BoolType $isActive = null, \StringType $name = null, \StringType $urlKeywords = null, \StringType $image = null, \StringType $imageAltText = null)
todo

Remove optional methods from this constructor for v3.5.1.0.

Deprecation Notice:

The optional parameters of this constructor are deprecated as of v3.3.1.0 and will be removed in v3.5.1.0. Please use the setter methods instead.

Arguments

$productRepository

\ProductRepositoryInterface

Product Repository.

$productId

\IdType

Optional (null), product ID.

$isActive

\BoolType

Optional (null), product active status.

$name

\StringType

Optional (null), product name.

$urlKeywords

\StringType

Optional (null), URL keywords.

$image

\StringType

Optional (null), product image.

$imageAltText

\StringType

Optional (null), product image alternative text.

Get Added Date Time

getAddedDateTime() : \DateTime

Response

\DateTime

The added date time.

Get Available Date Time

getAvailableDateTime() : \DateTime

Response

\DateTime

The available date time.

Get Discount Allowed

getDiscountAllowed() : float

Response

float

The allowed discount.

Get EAN

getEan() : string

Response

string

The EAN of the product.

Returns the image.

getImage() : string

Response

string

Returns the alternative image text.

getImageAltText() : string

Response

string

Get Last Modified Date Time

getLastModifiedDateTime() : \DateTime

Response

\DateTime

The last modified date time.

Get Manufacturer ID

getManufacturerId() : integer

Response

integer

The manufacturer ID.

Returns the name of the product.

getName() : string

Response

string

Get Ordered Count

getOrderedCount() : integer

Response

integer

The ordered count.

Get Price

getPrice() : float

Response

float

The price of the product.

Returns the product ID.

getProductId() : integer

Response

integer

Get Product Model

getProductModel() : string

Response

string

The product model.

Returns the product object.

getProductObject() : \ProductListItem
Throws
\InvalidArgumentException

if the product ID is not valid.

Response

\ProductListItem

Returns same instance for chained calls.

Get Product Type ID.

getProductTypeId() : integer

Response

integer

The product type ID.

Get Quantity

getQuantity() : float

Response

float

The quantity of the product.

Get Quantity Unit ID

getQuantityUnitId() : integer

Response

integer

The quantity unit ID.

Get Shipping Costs

getShippingCosts() : float

Response

float

The shipping costs of the product.

Get Shipping Time ID

getShippingTimeId() : integer

Response

integer

The shipping time ID.

Get Sort Order

getSortOrder() : integer

Response

integer

The sort order.

Returns the Special offer id.

getSpecialOfferId() : integer

Response

integer

The special offer id.

Get Tax Class ID

getTaxClassId() : integer

Response

integer

The tax class ID.

Returns the URL keywords.

getUrlKeywords() : string

Response

string

Get VPE ID

getVpeId() : integer

Response

integer

VPE ID.

Get VPE Value

getVpeValue() : float

Response

float

The VPE value.

Get Weight

getWeight() : float

Response

float

The weight of the product.

Checks if product is active or not.

isActive() : boolean

Response

boolean

Is FSK 18

isFsk18() : boolean

Response

boolean

Is the product FSK18?

Is VPE Active

isVpeActive() : boolean

Response

boolean

Is VPE active on the product?

Set active state value.

setActive(\BoolType $status) : \ProductListItem

Arguments

$status

\BoolType

Response

\ProductListItem

Returns same instance for chained calls.

Sets the added date time.

setAddedDateTime(\DateTime $date) : \ProductListItem

Arguments

$date

\DateTime

Response

\ProductListItem

Returns same instance for chained calls.

Set Available Date Time

setAvailableDateTime(\DateTime $date) : \ProductListItem

Arguments

$date

\DateTime

Response

\ProductListItem

Returns same instance for chained calls.

Set Discount Allowed

setDiscountAllowed(\DecimalType $discount) : \ProductListItem

Arguments

$discount

\DecimalType

The discount to set.

Response

\ProductListItem

Returns same instance for chained calls.

Set EAN

setEan(\StringType $ean) : \ProductListItem

Arguments

$ean

\StringType

The EAN to set.

Response

\ProductListItem

Returns same instance for chained calls.

Set FSK 18

setFsk18(\BoolType $status) : \ProductListItem

Arguments

$status

\BoolType

Response

\ProductListItem

Returns same instance for chained calls.

Set product image.

setImage(\StringType $image) : \ProductListItem

Arguments

$image

\StringType

Response

\ProductListItem

Returns same instance for chained calls.

Set image alt text.

setImageAltText(\StringType $imageAltText) : \ProductListItem

Arguments

$imageAltText

\StringType

Response

\ProductListItem

Returns same instance for chained calls.

Set Last Modified Date Time

setLastModifiedDateTime(\DateTime $date) : \ProductListItem

Arguments

$date

\DateTime

The last modified date time.

Response

\ProductListItem

Returns same instance for chained calls.

Set Manufacturer ID

setManufacturerId(\IdType $id) : \ProductListItem

Arguments

$id

\IdType

The manufacturer ID to set.

Response

\ProductListItem

Returns same instance for chained calls.

Set product name.

setName(\StringType $name) : \ProductListItem

Arguments

$name

\StringType

Response

\ProductListItem

Returns same instance for chained calls.

Set Ordered Count

setOrderedCount(\IntType $count) : \ProductListItem

Arguments

$count

\IntType

The ordered count.

Response

\ProductListItem

Returns same instance for chained calls.

Set Price

setPrice(\DecimalType $price) : \ProductListItem

Arguments

$price

\DecimalType

The price to set.

Response

\ProductListItem

Returns same instance for chained calls.

Set Product ID value.

setProductId(\IdType $id) : \ProductListItem

Arguments

$id

\IdType

Response

\ProductListItem

Returns same instance for chained calls.

Set Product Model

setProductModel(\StringType $model) : \ProductListItem

Arguments

$model

\StringType

The product model.

Response

\ProductListItem

Returns same instance for chained calls.

Set Product Type ID.

setProductTypeId(\IdType $id) : \ProductListItem

Arguments

$id

\IdType

Product type ID.

Response

\ProductListItem

Set Quantity

setQuantity(\DecimalType $quantity) : \ProductListItem

Arguments

$quantity

\DecimalType

The quantity to set.

Response

\ProductListItem

Returns same instance for chained calls.

Set Quantity Unit ID

setQuantityUnitId(\IdType $id) : \ProductListItem

Arguments

$id

\IdType

The quantity unit ID to set.

Response

\ProductListItem

Returns same instance for chained calls.

Set Shipping Costs

setShippingCosts(\DecimalType $price) : \ProductListItem

Arguments

$price

\DecimalType

The shipping costs to set.

Response

\ProductListItem

Returns same instance for chained calls.

Set Shipping Time ID

setShippingTimeId(\IdType $id) : \ProductListItem

Arguments

$id

\IdType

The shipping time ID to set.

Response

\ProductListItem

Returns same instance for chained calls.

Set Sort Order

setSortOrder(\IntType $sortOrder) : \ProductListItem

Arguments

$sortOrder

\IntType

The sort order.

Response

\ProductListItem

Returns same instance for chained calls.

Set Special offer id.

setSpecialOfferId(\IdType $id) : \ProductListItem

Arguments

$id

\IdType

Response

\ProductListItem

Returns same instance for chained calls.

Set Tax Class ID

setTaxClassId(\IdType $id) : \ProductListItem

Arguments

$id

\IdType

The tax class ID to set.

Response

\ProductListItem

Returns same instance for chained calls.

Set product URL keywords.

setUrlKeywords(\StringType $urlKeywords) : \ProductListItem

Arguments

$urlKeywords

\StringType

Response

\ProductListItem

Returns same instance for chained calls.

Set VPE Active

setVpeActive(\BoolType $status) : \ProductListItem

Arguments

$status

\BoolType

Response

\ProductListItem

Returns same instance for chained calls.

Set VPE ID

setVpeId(\IdType $id) : \ProductListItem

Arguments

$id

\IdType

Response

\ProductListItem

Returns same instance for chained calls.

Set VPE Value

setVpeValue(\DecimalType $vpeValue) : \ProductListItem

Arguments

$vpeValue

\DecimalType

Response

\ProductListItem

Returns same instance for chained calls.

Set Weight

setWeight(\DecimalType $weight) : \ProductListItem

Arguments

$weight

\DecimalType

The weight to set.

Response

\ProductListItem

Returns same instance for chained calls.

Properties

Product repository.

productRepository : \ProductRepositoryInterface
var

Type(s)

\ProductRepositoryInterface

Product ID

productId : integer
var

Type(s)

integer

Product Active Status

active : boolean
var

Type(s)

boolean

Sort Order

sortOrder : integer
var

Type(s)

integer

Added DateTime

addedDateTime : \DateTime
var

Type(s)

\DateTime

Available DateTime

availableDateTime : \DateTime
var

Type(s)

\DateTime

Last Modified DateTime

lastModifiedDateTime : \DateTime
var

Type(s)

\DateTime

Ordered Count

orderedCount : integer
var

Type(s)

integer

Product Model

productModel : string
var

Type(s)

string

EAN

ean : string
var

Type(s)

string

Price

price : float
var

Type(s)

float

Discount Allowed

discountAllowed : float
var

Type(s)

float

Tax Class ID

taxClassId : integer
var

Type(s)

integer

Quantity

quantity : float
var

Type(s)

float

Product Name

name : string
var

Type(s)

string

Image

image : string
var

Type(s)

string

Image alternative text

imageAltText : string
var

Type(s)

string

URL Keywords

urlKeywords : string
var

Type(s)

string

Weight

weight : float
var

Type(s)

float

Shipping costs

shippingCosts : float
var

Type(s)

float

Shipping Time ID

shippingTimeId : integer
var

Type(s)

integer

Product Type ID

productTypeId : integer
var

Type(s)

integer

Manufacturer ID

manufacturerId : integer
var

Type(s)

integer

Manufacturer ID

quantityUnitId : integer
var

Type(s)

integer

FSK 18 Status

fsk18 : boolean
var

Type(s)

boolean

VPE Active Status

vpeActive : boolean
var

Type(s)

boolean

VPE ID

vpeId : integer
var

Type(s)

integer

VPE Value

vpeValue : float
var

Type(s)

float

Special offer id.

specialOfferId : integer
var

Type(s)

integer