CategoryListItem
in package
Class CategoryListItem
This class represents a flattened category with just its essential data. The object stores language specific data only in one language and is mainly used inside a CategoryListItemCollection for displaying among other CategoryListItems in a list. The class provides only read access and can not use to manipulate and persist categories data.
Tags
Table of Contents
- $active : bool
- Value whether category is active?
- $categoryId : int
- Category ID.
- $categoryListProvider : CategoryListProviderInterface
- Category list provider.
- $categoryRepo : CategoryRepositoryInterface
- Category repository.
- $description : string
- Category description.
- $headingTitle : string
- Category heading title.
- $icon : string
- Category icon file.
- $image : string
- Category image.
- $imageAltText : string
- Image alternative text.
- $name : string
- Category name.
- $parentId : int
- Category parent ID.
- $urlKeywords : string
- Category URL keywords.
- __construct() : mixed
- CategoryListItem constructor.
- getCategoryId() : int
- Returns the category ID.
- getCategoryObject() : CategoryInterface
- Returns the category object.
- getDescription() : string
- Returns the category description.
- getHeadingTitle() : string
- Returns the category heading title.
- getIcon() : string
- Returns the category icon.
- getImage() : string
- Returns the category image.
- getImageAltText() : string
- Returns the image alternative text.
- getName() : string
- Returns the category name.
- getParentId() : int
- Returns the category parent ID.
- getSubcategoryList() : CategoryListItemCollection
- Returns the subcategory collection.
- getUrlKeywords() : string
- Returns the URL keywords.
- isActive() : bool
- Returns the value whether the category is active.
Properties
$active
Value whether category is active?
protected
bool
$active
$categoryId
Category ID.
protected
int
$categoryId
$categoryListProvider
Category list provider.
protected
CategoryListProviderInterface
$categoryListProvider
$categoryRepo
Category repository.
protected
CategoryRepositoryInterface
$categoryRepo
$description
Category description.
protected
string
$description
$headingTitle
Category heading title.
protected
string
$headingTitle
$icon
Category icon file.
protected
string
$icon
$image
Category image.
protected
string
$image
$imageAltText
Image alternative text.
protected
string
$imageAltText
$name
Category name.
protected
string
$name
$parentId
Category parent ID.
protected
int
$parentId
$urlKeywords
Category URL keywords.
protected
string
$urlKeywords
Methods
__construct()
CategoryListItem constructor.
public
__construct(CategoryRepositoryInterface $categoryRepo, CategoryListProviderInterface $categoryListProvider, IdType $categoryId, IdType $parentId, BoolType $active, StringType $name, StringType $headingTitle, StringType $description, StringType $urlKeywords, StringType $image, StringType $imageAltText, StringType $icon) : mixed
Parameters
- $categoryRepo : CategoryRepositoryInterface
-
Category repository.
- $categoryListProvider : CategoryListProviderInterface
-
Category list provider.
- $categoryId : IdType
-
Category ID.
- $parentId : IdType
-
Category parent ID.
- $active : BoolType
-
Is category active?
- $name : StringType
-
Category name.
- $headingTitle : StringType
-
Category heading title.
- $description : StringType
-
Category description.
- $urlKeywords : StringType
-
URL keywords.
- $image : StringType
-
Category image.
- $imageAltText : StringType
-
Image alternative text.
- $icon : StringType
-
Category icon.
Return values
mixed —getCategoryId()
Returns the category ID.
public
getCategoryId() : int
Return values
int —getCategoryObject()
Returns the category object.
public
getCategoryObject() : CategoryInterface
Return values
CategoryInterface —getDescription()
Returns the category description.
public
getDescription() : string
Return values
string —getHeadingTitle()
Returns the category heading title.
public
getHeadingTitle() : string
Return values
string —getIcon()
Returns the category icon.
public
getIcon() : string
Return values
string —getImage()
Returns the category image.
public
getImage() : string
Return values
string —getImageAltText()
Returns the image alternative text.
public
getImageAltText() : string
Return values
string —getName()
Returns the category name.
public
getName() : string
Return values
string —getParentId()
Returns the category parent ID.
public
getParentId() : int
Return values
int —getSubcategoryList()
Returns the subcategory collection.
public
getSubcategoryList() : CategoryListItemCollection
Return values
CategoryListItemCollection —getUrlKeywords()
Returns the URL keywords.
public
getUrlKeywords() : string
Return values
string —isActive()
Returns the value whether the category is active.
public
isActive() : bool