Frontend | Backend | Api

Products\Models\Backend\Product

Method Description Returns
isVariant() Returns that the product is not the variant bool
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
getText() Get the short description in the default language for this product string
getDefaultPricing() Get the default pricing ProductPricing
getName() Fetches the name in the default description for this container string
getSlug() Fetches the slug for the default description for this container string
getFullSlug() Fetches the full slug for the default description for this container string
getFullPath() Fetches the full path for the default description for this container string
getOriginalPath() Fetches the original path for the container without any custom urls applied string
getLanguageDescription(Language $language) Retrieves a description for the specified language. Returns null if no description exists. Model
getDefaultDescription() Fetches the description in the default language for this container. If no description in the default language, fetches the first one. If still no description exists, creates a new description with the default language. Model
getImageRootTargetFolderPath() Retrieves the *root* target folder path for uploaded images. This is usually the root entity path without the ID or slug sub folder. string
getImageTargetFolderPath() Retrieves the target folder path for uploaded images. Images will be moved to this path after the upload has been processed. string
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
getPublished() DateTime
isPublished() Determines if the record is published. bool
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
isVersionedModel() Check whether a model is versioned bool
getAvailableCategories() Get the available categories Collection
getDefaultLanguage() Get the default language for the record Language
getAvailableLanguages() Get the available languages Collection