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.

Package: Category\Entities
Category: System
Located at Services/Core/Category/Entities/CategoryListItem.inc.php

Methods summary

`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 )` CategoryListItem constructor. CategoryListItem constructor. Parameters `$categoryRepo` Category repository. `$categoryListProvider` Category list provider. `$categoryId` Category ID. `$parentId` Category parent ID. `$active` Is category active? `$name` Category name. `$headingTitle` Category heading title. `$description` Category description. `$urlKeywords` URL keywords. `$image` Category image. `$imageAltText` Image alternative text. `$icon` Category icon.
`public integer`	# `getCategoryId( )` Returns the category ID. Returns the category ID. Returns integer
`public integer`	# `getParentId( )` Returns the category parent ID. Returns the category parent ID. Returns integer
`public boolean`	# `isActive( )` Returns the value whether the category is active. Returns the value whether the category is active. Returns boolean
`public string`	# `getName( )` Returns the category name. Returns the category name. Returns string
`public string`	# `getHeadingTitle( )` Returns the category heading title. Returns the category heading title. Returns string
`public string`	# `getDescription( )` Returns the category description. Returns the category description. Returns string
`public string`	# `getUrlKeywords( )` Returns the URL keywords. Returns the URL keywords. Returns string
`public string`	# `getImage( )` Returns the category image. Returns the category image. Returns string
`public string`	# `getImageAltText( )` Returns the image alternative text. Returns the image alternative text. Returns string
`public string`	# `getIcon( )` Returns the category icon. Returns the category icon. Returns string
`public CategoryInterface`	# `getCategoryObject( )` Returns the category object. Returns the category object. Returns `CategoryInterface`
`public CategoryListItemCollection`	# `getSubcategoryList( )` Returns the subcategory collection. Returns the subcategory collection. Returns `CategoryListItemCollection`

Properties summary

`protected CategoryRepositoryInterface`	`$categoryRepo` Category repository. Category repository.	#
`protected CategoryListProviderInterface`	`$categoryListProvider` Category list provider. Category list provider.	#
`protected integer`	`$categoryId` Category ID. Category ID.	#
`protected integer`	`$parentId` Category parent ID. Category parent ID.	#
`protected boolean`	`$active` Value whether category is active? Value whether category is active?	#
`protected string`	`$name` Category name. Category name.	#
`protected string`	`$headingTitle` Category heading title. Category heading title.	#
`protected string`	`$description` Category description. Category description.	#
`protected string`	`$urlKeywords` Category URL keywords. Category URL keywords.	#
`protected string`	`$image` Category image. Category image.	#
`protected string`	`$imageAltText` Image alternative text. Image alternative text.	#
`protected string`	`$icon` Category icon file. Category icon file.	#

Packages

Classes

Class CategoryListItem

Methods summary

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Properties summary