1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
<?php
/* --------------------------------------------------------------
CategoryListItem.inc.php 2015-11-26
Gambio GmbH
http://www.gambio.de
Copyright (c) 2015 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* 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.
*
* @category System
* @package Category
* @subpackage Entities
*/
class CategoryListItem
{
/**
* Category repository.
*
* @var CategoryRepositoryInterface
*/
protected $categoryRepo;
/**
* Category list provider.
*
* @var CategoryListProviderInterface
*/
protected $categoryListProvider;
/**
* Category ID.
*
* @var int
*/
protected $categoryId;
/**
* Category parent ID.
*
* @var int
*/
protected $parentId;
/**
* Value whether category is active?
*
* @var bool
*/
protected $active;
/**
* Category name.
*
* @var string
*/
protected $name;
/**
* Category heading title.
*
* @var string
*/
protected $headingTitle;
/**
* Category description.
*
* @var string
*/
protected $description;
/**
* Category URL keywords.
*
* @var string
*/
protected $urlKeywords;
/**
* Category image.
*
* @var string
*/
protected $image;
/**
* Image alternative text.
*
* @var string
*/
protected $imageAltText;
/**
* Category icon file.
*
* @var string
*/
protected $icon;
/**
* CategoryListItem constructor.
*
* @param CategoryRepositoryInterface $categoryRepo Category repository.
* @param CategoryListProviderInterface $categoryListProvider Category list provider.
* @param IdType $categoryId Category ID.
* @param IdType $parentId Category parent ID.
* @param BoolType $active Is category active?
* @param StringType $name Category name.
* @param StringType $headingTitle Category heading title.
* @param StringType $description Category description.
* @param StringType $urlKeywords URL keywords.
* @param StringType $image Category image.
* @param StringType $imageAltText Image alternative text.
* @param StringType $icon Category icon.
*/
public function __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)
{
$this->categoryRepo = $categoryRepo;
$this->categoryListProvider = $categoryListProvider;
$this->categoryId = $categoryId->asInt();
$this->parentId = $parentId->asInt();
$this->active = $active->asBool();
$this->name = $name->asString();
$this->headingTitle = $headingTitle->asString();
$this->description = $description->asString();
$this->urlKeywords = $urlKeywords->asString();
$this->image = $image->asString();
$this->imageAltText = $imageAltText->asString();
$this->icon = $icon->asString();
}
/**
* Returns the category ID.
*
* @return int
*/
public function getCategoryId()
{
return $this->categoryId;
}
/**
* Returns the category parent ID.
*
* @return int
*/
public function getParentId()
{
return $this->parentId;
}
/**
* Returns the value whether the category is active.
*
* @return boolean
*/
public function isActive()
{
return $this->active;
}
/**
* Returns the category name.
*
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Returns the category heading title.
*
* @return string
*/
public function getHeadingTitle()
{
return $this->headingTitle;
}
/**
* Returns the category description.
*
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* Returns the URL keywords.
*
* @return string
*/
public function getUrlKeywords()
{
return $this->urlKeywords;
}
/**
* Returns the category image.
*
* @return string
*/
public function getImage()
{
return $this->image;
}
/**
* Returns the image alternative text.
*
* @return string
*/
public function getImageAltText()
{
return $this->imageAltText;
}
/**
* Returns the category icon.
*
* @return string
*/
public function getIcon()
{
return $this->icon;
}
/**
* Returns the category object.
*
* @return CategoryInterface
*/
public function getCategoryObject()
{
$id = new IdType($this->getCategoryId());
return $this->categoryRepo->getCategoryById($id);
}
/**
* Returns the subcategory collection.
*
* @return CategoryListItemCollection
*/
public function getSubcategoryList()
{
$id = new IdType($this->getCategoryId());
return $this->categoryListProvider->getByParentId($id);
}
}