Product
class Product extends Product implements PrimaryKeyInterface, Serializable, CSVEntityInterface, BlockEntity, RelationshipEntityInterface
Product
Traits
Trait UpdatedByTrait - contains properties to trace update history
Properties
| protected string | $productName | Name of product | from Product |
| protected DateTime|null | $createdAt | Date when product created | from Product |
| protected DateTime|null | $updatedAt | Date when product last updated | from Product |
| protected DateTime|null | $arrivalDate | Date when product will be available | from Product |
| protected string|null | $description | Description of product | from Product |
| protected bool|null | $onAction | Product is on action | from Product |
| protected float|null | $priceOnAction | Product action price | from Product |
| protected string|null | $sku | Sku of product | from Product |
| protected string|null | $youtubeUrl | Link to youtube video | from Product |
| protected string|null | $vimeoUrl | Link to viemo video | from Product |
| protected string|null | $status | Product availability (AVAILABLE, UNAVAILABLE) | from Product |
| protected array|null | $tags | Product tags, specific keywords | from Product |
| protected string | $descriptionHtml | Description of product as HTML | from Product |
| protected string | $type | Type of product | from Product |
| protected float|null | $currentPrice | Product price | from Product |
| protected string|null | $slug | Product slug | from Product |
| protected string|null | $updatedBy | User which triggered update | from UpdatedByTrait |
| protected string|null | $hash | Filed for update validation | from UpdatedByTrait |
| protected int | $id | ||
| protected bool|null | $usedAsPavProduct | Product used as product attribute values | |
| protected array|null | $pricelistItemsArray | List of associated price list items represented in one field for easier manipulation | |
| protected int|null | $defaultPricelistDiscount | Default percentage price list discount | |
| protected int | $viewCount | Number of times the product is viewed | |
| protected int | $sales | Number of times the product is sold | |
| protected string|null | $companyName | ||
| protected string|null | $baseImageUrl | Path to product base image | |
| protected DateTime|null | $deletedAt | Date when product set to UNAVAILABLE | |
| protected bool | $hasNullCategory | Product assigned to any category | |
| protected string|null | $erpCode | Code to connect product with ERP representation of entity | |
| protected float|null | $taxValue | Tax value for product | |
| protected float|null | $vatValue | Vat value for product | |
| protected bool | $isNew | Product is new | |
| protected bool | $onSale | Product is on sale | |
| protected bool | $onTotalSale | Product is on total sale | |
| protected bool | $damagedGood | Product is damaged | |
| protected array|null | $permissions | Product permissions | |
| protected array|null | $keywords | Product keywords | |
| protected array|null | $additionalKeywords | Product additional keywords for search | |
| protected array|null | $productSearchOptions | Contains all product specific search terms | |
| protected float|null | $priceFrom | If product contains product attribute values, represents minimal price | |
| protected float|null | $priceTo | If product contains product attribute values, represents maximal price | |
| protected float|null | $reviewRating | Product rating | |
| protected bool|null | $adminReview | Fixed rating set by admin | |
| protected string|null | $productSearchString | Contains product specific search terms | |
| protected bool|null | $outlet | Product is on outlet | |
| protected array|null | $quantityRebate | Product quantity rebate | |
| protected int|null | $quantityStep | Product quantity to add to cart | |
| protected float|null | $width | Product width | |
| protected float|null | $height | Product height | |
| protected float|null | $depth | Product depth | |
| protected float|null | $weight | Product weight with weight of its packaging | |
| protected float|null | $netWeight | Product weight without weight of its packaging | |
| protected float|null | $qtyPerPackage | Number of products per package | |
| protected string|null | $permalink | Product permalink, needs to be unique on database level | |
| protected string|null | $seoTitle | SEO title for product | |
| protected string|null | $seoDescription | SEO description for product | |
| protected string|null | $seoKeywords | SEO keywords for product | |
| protected array|null | $customLabels | Array of labels for product | |
| protected array|null | $customProductLinks | Array of associated links | |
| protected bool|null | $preventDirectAddToCart | Can you add product to cart directly from product component. If product has multiple product attribute values you can't add it from component | |
| protected SimpleProduct | $simpleProduct | Simple product | |
| protected GroupProduct | $groupProduct | Group product | |
| protected ConfigurableProduct | $configurableProduct | Configurable product | |
| protected ArrayCollection | $categories | List of associated categories | |
| protected ArrayCollection | $images | List of associated images | |
| protected ArrayCollection | $prices | Price history | |
| protected Brand | $brand | Product brand | |
| protected ArrayCollection | $productAttributesValues | List of associated product attribute values | |
| protected ArrayCollection | $orderItems | List of associated order items | |
| protected ArrayCollection | $productFeatures | List of associated features | |
| protected ArrayCollection | $pricelistItems | List of associated price list items | |
| protected ArrayCollection | $statistics | List of associated statistics | |
| protected ArrayCollection | $files | All product specific files | |
| protected UnitOfMeasure | $unitOfMeasure | Unit of measure | |
| protected Package | $package | Type of packing | |
| protected UnitOfMeasure | $unitOfMeasureWeight | Unit of measure for weight | |
| protected UnitOfMeasure | $unitOfMeasureQtyPerPackage | Unit of measure for quantity per package | |
| protected ArrayCollection | $productTranslations | Product translations containing only not default languages | |
| protected | $removedImages |
Methods
setDescriptionHtml(string|null $descriptionHtml)
Set descriptionHtml
from Product
__construct()
Constructor
bool
getHasNullCategory()
No description
setHasNullCategory(bool $hasNullCategory)
No description
bool
isIsNew()
No description
bool
isDamagedGood()
No description
setDamagedGood(bool $damagedGood)
No description
bool
isOnSale()
No description
bool
isOnTotalSale()
No description
setOnTotalSale(bool $onTotalSale)
No description
DateTime|null
getDeletedAt()
No description
setBaseImage()
No description
setBaseImageUrl(null|string $baseImageUrl)
No description
null|string
getBaseImageUrl()
No description
ArrayCollection
getRemovedImages()
No description
setRemovedImages(ArrayCollection $removedImages)
No description
integer
getId()
Get id
getConfigurableProduct()
No description
getGroupProduct()
No description
getSimpleProduct()
No description
ArrayCollection
getCategories()
Get categories
ArrayCollection
getImages()
Get images
ArrayCollection
getPrices()
Get prices
ArrayCollection
getProductAttributesValues()
No description
setProductAttributesValues(ArrayCollection $productAttributesValues)
No description
removeProductAttributeValue(ProductAttributeValues $productAttributesValue)
Remove productAttributesValue
setCategories(ArrayCollection $categories)
No description
float
getLastPrice()
No description
ArrayCollection
getOrderItems()
Get all order items for this product
ArrayCollection
getStatistics()
Get statistics
ArrayCollection
getProductFeatures()
No description
setProductFeatures(ArrayCollection $productFeatures)
No description
ArrayCollection
getPricelistItems()
No description
null|string
getErpCode()
No description
setErpCode(null|string $erpCode)
No description
float|null
getTaxValue()
No description
setTaxValue(float|null $taxValue)
No description
array|null
getPermissions()
No description
setPermissions(array|null $permissions)
No description
ArrayCollection
getProductTranslations()
No description
setProductTranslations(ArrayCollection $productTranslations)
No description
string
serialize()
(PHP 5 >= 5.1.0)
String representation of object
void
unserialize(string $serialized)
(PHP 5 >= 5.1.0)
Constructs the object
array
toCSVArray()
No description
int
getViewCount()
No description
setViewCount(int $viewCount)
No description
int
getSaleCount()
No description
setSaleCount(int $saleCount)
No description
null|string
getCompanyName()
No description
setCompanyName(null|string $companyName)
No description
array|null
getKeywords()
No description
setKeywords(array $keywords)
No description
array|null
getAdditionalKeywords()
No description
setAdditionalKeywords(array $additionalKeywords)
No description
float|null
getReviewRating()
No description
setReviewRating(float|null $reviewRating)
No description
bool|null
isAdminReview()
No description
setAdminReview(bool|null $adminReview)
No description
setProductSearchOptions(array $data = [])
No description
array|null
getProductSearchOptions()
No description
float|null
getPriceFrom()
No description
setPriceFrom()
No description
float|null
getPriceTo()
No description
setPriceTo()
No description
null|string
getProductSearchString()
No description
setProductSearchString(null|string $productSearchString)
No description
bool|null
isOutlet()
No description
array
getCSVHeader()
No description
array
getCSVValues()
No description
setCSVValues($csvRow, mixed $locale, array $csvHeaders, array $propertyMappings = array())
No description
int|null
getQuantityStep()
No description
setQuantityStep(int|null $quantityStep)
No description
array|null
getQuantityRebate()
No description
setQuantityRebate(array|null $quantityRebate)
No description
ArrayCollection
getFiles()
No description
float|null
getVatValue()
No description
setVatValue(float|null $vatValue)
No description
getUnitOfMeasure()
No description
array|null
getPricelistItemsArray()
No description
bool
updatePricelistItemsArray(int $id, float $price)
No description
setPricelistItemsArray(array|null $pricelistItemsArray)
No description
getUnitOfMeasureQtyPerPackage()
No description
float|null
getWeight()
No description
float|null
getNetWeight()
No description
setNetWeight(float|null $netWeight)
No description
float|null
getQtyPerPackage()
No description
setQtyPerPackage(float|null $qtyPerPackage)
No description
getUnitOfMeasureWeight()
No description
getPackage()
No description
float|null
getHeight()
No description
float|null
getDepth()
No description
float|null
getWidth()
No description
int|null
isDefaultPricelistDiscount()
No description
setDefaultPricelistDiscount(int|null $defaultPricelistDiscount)
No description
bool|null
isUsedAsPavProduct()
No description
setUsedAsPavProduct(bool|null $usedAsPavProduct)
No description
null|string
getPermalink()
No description
setPermalink(null|string $permalink)
No description
null|string
getSeoTitle()
No description
setSeoTitle(null|string $seoTitle)
No description
null|string
getSeoDescription()
No description
setSeoDescription(null|string $seoDescription)
No description
null|string
getSeoKeywords()
No description
setSeoKeywords(null|string $seoKeywords)
No description
array|null
getCustomLabels()
No description
setCustomLabels(array|null $customLabels)
No description
addCustomLabel(string $customLabel)
No description
removeCustomLabel(string $customLabel)
No description
array|null
getCustomProductLinks()
No description
setCustomProductLinks(array|null $customProductLinks)
No description
bool|null
isPreventDirectAddToCart()
No description
setPreventDirectAddToCart(bool|null $preventDirectAddToCart)
No description
Details
in Product at line 220
BaseProductInterface
setProductName(string $productName)
Set productName
in Product at line 232
string
getProductName()
Get productName
in Product at line 244
BaseProductInterface
setDescription(string|null $description)
Set description
in Product at line 256
string|null
getDescription()
Get description
in Product at line 269
BaseProductInterface
setSku(string|null $sku)
Set sku
in Product at line 281
string|null
getSku()
Get sku
in Product at line 293
mixed
setYoutubeUrl(string $youtubeUrl)
Set youtubeUrl
in Product at line 305
mixed
getYoutubeUrl()
Get youtubeUrl
in Product at line 317
mixed
setVimeoUrl(string $vimeoUrl)
Set vimeoUrl
in Product at line 329
mixed
getVimeoUrl()
Get vimeoUrl
in Product at line 341
mixed
setStatus(string $status)
Set status
in Product at line 352
mixed
getStatus()
Get status
in Product at line 364
BaseProductInterface
setTags(array|null $tags)
Set tags
in Product at line 376
array|null
getTags()
Get tags
in Product at line 388
BaseProductInterface
setDescriptionHtml(string|null $descriptionHtml)
Set descriptionHtml
in Product at line 400
string|null
getDescriptionHtml()
Get descriptionHtml
in Product at line 408
mixed
getCreatedAt()
in Product at line 428
mixed
getUpdatedAt()
in Product at line 470
mixed
setType(string $type)
in Product at line 480
string
getType()
in Product at line 488
float|null
getCurrentPrice()
in Product at line 508
boolean
isOnAction()
in Product at line 528
null|string
getSlug()
in Product at line 548
float|null
getPriceOnAction()
in UpdatedByTrait at line 46
null|string
getUpdatedBy()
in UpdatedByTrait at line 56
$this
setUpdatedBy(null|string $updatedBy)
in UpdatedByTrait at line 66
null|string
getHash()
in UpdatedByTrait at line 76
$this
setHash(null|string $hash)
at line 730
__construct()
Constructor
at line 756
bool
getHasNullCategory()
at line 766
Product
setHasNullCategory(bool $hasNullCategory)
at line 776
bool
isIsNew()
at line 786
Product
setIsNew(bool $isNew)
at line 796
bool
isDamagedGood()
at line 806
Product
setDamagedGood(bool $damagedGood)
at line 816
bool
isOnSale()
at line 826
Product
setOnSale(bool $onSale)
at line 836
bool
isOnTotalSale()
at line 846
Product
setOnTotalSale(bool $onTotalSale)
at line 856
DateTime|null
getDeletedAt()
at line 876
Product
setBaseImage()
at line 903
Product
setBaseImageUrl(null|string $baseImageUrl)
at line 913
null|string
getBaseImageUrl()
at line 921
ArrayCollection
getRemovedImages()
at line 931
Product
setRemovedImages(ArrayCollection $removedImages)
at line 941
Brand
getBrand()
at line 963
Product
setId(int $id)
at line 975
integer
getId()
Get id
at line 983
ConfigurableProduct
getConfigurableProduct()
at line 993
Product
setConfigurableProduct(ConfigurableProduct $configurableProduct)
at line 1003
GroupProduct
getGroupProduct()
at line 1013
Product
setGroupProduct(GroupProduct $groupProduct)
at line 1024
SimpleProduct
getSimpleProduct()
at line 1034
Product
setSimpleProduct(SimpleProduct $simpleProduct)
at line 1075
ArrayCollection
getCategories()
Get categories
at line 1116
ArrayCollection
getImages()
Get images
at line 1156
ArrayCollection
getPrices()
Get prices
at line 1166
Product
setPrices(ArrayCollection $prices)
at line 1176
ArrayCollection
getProductAttributesValues()
at line 1186
Product
setProductAttributesValues(ArrayCollection $productAttributesValues)
at line 1207
Product
addProductAttributeValue(ProductAttributeValues $productAttributesValue)
Add productAttributesValue
at line 1224
Product
removeProductAttributeValue(ProductAttributeValues $productAttributesValue)
Remove productAttributesValue
at line 1237
Product
setImages(ArrayCollection $images)
at line 1250
Product
setCategories(ArrayCollection $categories)
at line 1263
float
getLastPrice()
at line 1305
ArrayCollection
getOrderItems()
Get all order items for this product
at line 1317
Product
addStatistic(Statistics $statistic)
Add statistic
at line 1332
Product
removeStatistic(Statistics $statistic)
Remove statistic
at line 1344
ArrayCollection
getStatistics()
Get statistics
at line 1352
ArrayCollection
getProductFeatures()
at line 1362
Product
setProductFeatures(ArrayCollection $productFeatures)
at line 1374
Product
addProductFeature(ProductFeature $productFeature)
at line 1388
Product
removeProductFeature(ProductFeature $productFeature)
at line 1399
ArrayCollection
getPricelistItems()
at line 1409
Product
addPricelistItem(PricelistItem $pricelistItem)
at line 1423
Product
removePricelistItem(PricelistItem $pricelistItem)
at line 1434
null|string
getErpCode()
at line 1444
Product
setErpCode(null|string $erpCode)
at line 1454
float|null
getTaxValue()
at line 1464
Product
setTaxValue(float|null $taxValue)
at line 1474
array|null
getPermissions()
at line 1484
Product
setPermissions(array|null $permissions)
at line 1494
ArrayCollection
getProductTranslations()
at line 1504
Product
setProductTranslations(ArrayCollection $productTranslations)
at line 1519
string
serialize()
(PHP 5 >= 5.1.0)
String representation of object
at line 1552
void
unserialize(string $serialized)
(PHP 5 >= 5.1.0)
Constructs the object