Class ProductListItem

Package: Product\Entities
Category: System
Located at Services/Core/Product/Entities/ProductListItem.inc.php

Methods summary

`public`	# `__construct( ProductRepositoryInterface $productRepository, IdType $productId = null, BoolType $isActive = null, StringType $name = null, StringType $urlKeywords = null, StringType $image = null, StringType $imageAltText = null )` ProductListItem constructor. ProductListItem constructor. Parameters `$productRepository` Product Repository. `$productId` Optional (null), product ID. `$isActive` Optional (null), product active status. `$name` Optional (null), product name. `$urlKeywords` Optional (null), URL keywords. `$image` Optional (null), product image. `$imageAltText` Optional (null), product image alternative text. 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.
`public integer`	# `getProductId( )` Returns the product ID. Returns the product ID. Returns integer
`public boolean`	# `isActive( )` Checks if product is active or not. Checks if product is active or not. Returns boolean
`public string`	# `getName( )` Returns the name of the product. Returns the name of the product. Returns string
`public string`	# `getUrlKeywords( )` Returns the URL keywords. Returns the URL keywords. Returns string
`public string`	# `getImage( )` Returns the image. Returns the image. Returns string
`public string`	# `getImageAltText( )` Returns the alternative image text. Returns the alternative image text. Returns string
`public ProductListItem`	# `getProductObject( )` Returns the product object. Returns the product object. Returns `ProductListItem` Returns same instance for chained calls. Throws InvalidArgumentException if the product ID is not valid.
`public integer`	# `getSortOrder( )` Get Sort Order Get Sort Order Returns integer The sort order.
`public DateTime`	# `getAvailableDateTime( )` Get Available Date Time Get Available Date Time Returns DateTime The available date time.
`public DateTime`	# `getAddedDateTime( )` Get Added Date Time Get Added Date Time Returns DateTime The added date time.
`public DateTime`	# `getLastModifiedDateTime( )` Get Last Modified Date Time Get Last Modified Date Time Returns DateTime The last modified date time.
`public integer`	# `getOrderedCount( )` Get Ordered Count Get Ordered Count Returns integer The ordered count.
`public string`	# `getProductModel( )` Get Product Model Get Product Model Returns string The product model.
`public string`	# `getEan( )` Get EAN Get EAN Returns string The EAN of the product.
`public float`	# `getPrice( )` Get Price Get Price Returns float The price of the product.
`public integer`	# `getTaxClassId( )` Get Tax Class ID Get Tax Class ID Returns integer The tax class ID.
`public float`	# `getQuantity( )` Get Quantity Get Quantity Returns float The quantity of the product.
`public float`	# `getWeight( )` Get Weight Get Weight Returns float The weight of the product.
`public float`	# `getDiscountAllowed( )` Get Discount Allowed Get Discount Allowed Returns float The allowed discount.
`public float`	# `getShippingCosts( )` Get Shipping Costs Get Shipping Costs Returns float The shipping costs of the product.
`public integer`	# `getShippingTimeId( )` Get Shipping Time ID Get Shipping Time ID Returns integer The shipping time ID.
`public integer`	# `getProductTypeId( )` Get Product Type ID. Get Product Type ID. Returns integer The product type ID.
`public integer`	# `getManufacturerId( )` Get Manufacturer ID Get Manufacturer ID Returns integer The manufacturer ID.
`public boolean`	# `isFsk18( )` Is FSK 18 Is FSK 18 Returns boolean Is the product FSK18?
`public boolean`	# `isVpeActive( )` Is VPE Active Is VPE Active Returns boolean Is VPE active on the product?
`public integer`	# `getVpeId( )` Get VPE ID Get VPE ID Returns integer VPE ID.
`public float`	# `getVpeValue( )` Get VPE Value Get VPE Value Returns float The VPE value.
`public ProductListItem`	# `setProductId( IdType $id )` Set Product ID value. Set Product ID value. Parameters `$id` Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setActive( BoolType $status )` Set active state value. Set active state value. Parameters `$status` Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setName( StringType $name )` Set product name. Set product name. Parameters `$name` Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setUrlKeywords( StringType $urlKeywords )` Set product URL keywords. Set product URL keywords. Parameters `$urlKeywords` Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setImage( StringType $image )` Set product image. Set product image. Parameters `$image` Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setImageAltText( StringType $imageAltText )` Set image alt text. Set image alt text. Parameters `$imageAltText` Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setSortOrder( IntType $sortOrder )` Set Sort Order Set Sort Order Parameters `$sortOrder` The sort order. Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setAddedDateTime( DateTime $date )` Sets the added date time. Sets the added date time. Parameters `$date` Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setAvailableDateTime( DateTime $date )` Set Available Date Time Set Available Date Time Parameters `$date` Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setLastModifiedDateTime( DateTime $date )` Set Last Modified Date Time Set Last Modified Date Time Parameters `$date` The last modified date time. Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setOrderedCount( IntType $count )` Set Ordered Count Set Ordered Count Parameters `$count` The ordered count. Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setProductModel( StringType $model )` Set Product Model Set Product Model Parameters `$model` The product model. Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setEan( StringType $ean )` Set EAN Set EAN Parameters `$ean` The EAN to set. Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setPrice( DecimalType $price )` Set Price Set Price Parameters `$price` The price to set. Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setTaxClassId( IdType $id )` Set Tax Class ID Set Tax Class ID Parameters `$id` The tax class ID to set. Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setQuantity( DecimalType $quantity )` Set Quantity Set Quantity Parameters `$quantity` The quantity to set. Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setWeight( DecimalType $weight )` Set Weight Set Weight Parameters `$weight` The weight to set. Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setDiscountAllowed( DecimalType $discount )` Set Discount Allowed Set Discount Allowed Parameters `$discount` The discount to set. Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setShippingCosts( DecimalType $price )` Set Shipping Costs Set Shipping Costs Parameters `$price` The shipping costs to set. Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setShippingTimeId( IdType $id )` Set Shipping Time ID Set Shipping Time ID Parameters `$id` The shipping time ID to set. Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setProductTypeId( IdType $id )` Set Product Type ID. Set Product Type ID. Parameters `$id` Product type ID. Returns `ProductListItem`
`public ProductListItem`	# `setManufacturerId( IdType $id )` Set Manufacturer ID Set Manufacturer ID Parameters `$id` The manufacturer ID to set. Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setFsk18( BoolType $status )` Set FSK 18 Set FSK 18 Parameters `$status` Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setVpeActive( BoolType $status )` Set VPE Active Set VPE Active Parameters `$status` Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setVpeId( IdType $id )` Set VPE ID Set VPE ID Parameters `$id` Returns `ProductListItem` Returns same instance for chained calls.
`public ProductListItem`	# `setVpeValue( DecimalType $vpeValue )` Set VPE Value Set VPE Value Parameters `$vpeValue` Returns `ProductListItem` Returns same instance for chained calls.

Properties summary

`protected ProductRepositoryInterface`	`$productRepository` Product repository. Product repository.	#
`protected integer`	`$productId` Product ID Product ID	# `0`
`protected boolean`	`$active` Product Active Status Product Active Status	# `false`
`protected integer`	`$sortOrder` Sort Order Sort Order	# `0`
`protected DateTime`	`$addedDateTime` Added DateTime Added DateTime	#
`protected DateTime`	`$availableDateTime` Available DateTime Available DateTime	#
`protected DateTime`	`$lastModifiedDateTime` Last Modified DateTime Last Modified DateTime	#
`protected integer`	`$orderedCount` Ordered Count Ordered Count	# `0`
`protected string`	`$productModel` Product Model Product Model	# `''`
`protected string`	`$ean` EAN EAN	# `''`
`protected float`	`$price` Price Price	# `0.00`
`protected float`	`$discountAllowed` Discount Allowed Discount Allowed	# `0.00`
`protected integer`	`$taxClassId` Tax Class ID Tax Class ID	# `0`
`protected float`	`$quantity` Quantity Quantity	# `0.00`
`protected string`	`$name` Product Name Product Name	# `''`
`protected string`	`$image` Image Image	# `''`
`protected string`	`$imageAltText` Image alternative text Image alternative text	# `''`
`protected string`	`$urlKeywords` URL Keywords URL Keywords	# `''`
`protected float`	`$weight` Weight Weight	# `0.00`
`protected float`	`$shippingCosts` Shipping costs Shipping costs	# `0.00`
`protected integer`	`$shippingTimeId` Shipping Time ID Shipping Time ID	# `0`
`protected integer`	`$productTypeId` Product Type ID Product Type ID	# `0`
`protected integer`	`$manufacturerId` Manufacturer ID Manufacturer ID	# `0`
`protected boolean`	`$fsk18` FSK 18 Status FSK 18 Status	# `false`
`protected boolean`	`$vpeActive` VPE Active Status VPE Active Status	# `false`
`protected integer`	`$vpeId` VPE ID VPE ID	# `0`
`protected float`	`$vpeValue` VPE Value VPE Value	# `0.00`

Packages

Classes

Class ProductListItem

Methods summary

Parameters

Todo

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Throws

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns