| getPrimaryCategory() |
|
Category
|
| getCategoryElements() |
|
Collection (CategoryElement)
|
| getVariants() |
|
Collection (ProductVariant)
|
| getChildren() |
|
Collection
|
| getParent() |
|
Product
|
| getProductCategories(?array|null $criteria, string $sort, string $direction) |
Helper that will fetch instances of Products\Models\Category through Products\Models\CategoryElement |
Collection
|
| getCustomFieldValues() |
|
Collection (ProductCustomFieldValue)
|
| getCustomFieldValue(CustomField $customField) |
Get the value for a custom field |
CustomFieldValue
|
| getCustomFieldValueByName(string $customFieldName) |
Get the value for a custom field by the custom field name |
CustomFieldValue
|
| getCustomFieldContent(string $customFieldName) |
Get the content for the custom field identified by the specified name |
Content
|
| getCustomFieldContentOrDefault(string $customFieldName) |
Get the content (or default content) for the custom field identified by the specified name |
Content
|
| getCustomFieldBoolean(string $customFieldName, ?bool|null $default) |
Get the (default) content of the custom field as boolean value |
bool
|
| getCustomFieldText(string $customFieldName, ?string|null $default) |
Get the (default) content of the custom field as text |
string
|
| getCustomFieldImage(string $customFieldName) |
Get the (default) image contained in the custom field |
Image
|
| getCustomFieldFile(string $customFieldName) |
Get the (default) file contained in the custom field |
File
|
| getCustomFields() |
Get the custom fields for this entity |
array
|
| hasCustomField(string $customFieldName) |
Check if the entity has a custom field with the specified name |
bool
|
| getName() |
Get the name in the default language for this product |
string
|
| getText() |
Get the short description in the default language for this product |
string
|
| getSlug() |
Get the slug for the default language description for this product |
string
|
| getFullSlug() |
Get the full slug for the default language for this product, including category slugs but without the module slug |
string
|
| getFullPath() |
Get the full path for the default language for this product, including category slugs and the module slug |
string
|
| getOriginalPath() |
Get the original path for the product without any custom urls applied |
string
|
| getDefaultDescription() |
Get the default language description |
ProductDescription
|
| getLanguageDescription(Language $language) |
Retrieve a description for the specified language. Returns null if no description exists. |
ProductDescription
|
| getDefaultPricing() |
Get the default pricing |
ProductPricing
|
| getPublished() |
Get the date the default language description for this product was published. This getter is used for the products manage page. |
DateTime
|
| getId() |
|
int
|
| getCode() |
The code that uniquely identifies this product |
string
|
| getExternalId() |
|
string
|
| isPurchasable() |
|
bool
|
| getAvailableFrom() |
|
DateTime
|
| getAvailableTill() |
|
DateTime
|
| getCreated() |
Date the record was created. |
DateTime
|
| getModified() |
Last modification date for the record. |
DateTime
|
| getImage() |
|
Image
|
| getSite() |
|
Site
|
| getDescriptions() |
|
Collection (ProductDescription)
|
| getPricings() |
|
Collection (ProductPricing)
|
| getWidth() |
|
string
|
| getHeight() |
|
string
|
| getDepth() |
|
string
|
| getWeight() |
|
string
|
| isNewRecord() |
Check if the record is a new record |
bool
|
| isHierarchicalModel() |
Check whether a model is a hierarchical model, i.e. can have children |
bool
|
| getAvailableLayouts() |
Get the available layouts for showing products |
Collection
|
| getAvailableCategories() |
Get the available categories |
Collection
|