g
Frontend | Backend | Api

Products\Models\Frontend\Category

Category

Method Description Returns
getName() Get the name in the default language for this product string
getSlug() Get the slug in the default language for this category string
getFullSlug() Get the full slug for the default language for this category, including category slugs but without the module slug string
getFullPath() Get the full path for the default language for this category, including parent slugs and the module slug string
getOriginalPath() Get the original path for the category without any custom urls applied string
getDefaultDescription() Get the default language description CategoryDescription
getLanguageDescription(Language $language) Retrieve a description for the specified language. Returns null if no description exists. CategoryDescription
getId() int
getPosition() int
getCreated() Date the record was created. DateTime
getModified() Last modification date for the record. DateTime
getPublished() DateTime
getParent() Category
getChildren() Collection (Category)
getSite() Site
isPublished() Determines if the record is published. bool
getCategoryElements() Collection (CategoryElement)
getProducts() Gets products associated with current category Collection
getDescriptions() Collection (CategoryDescription)
getCustomFieldValues() Collection (CategoryCustomFieldValue)
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
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