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 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
<?php
/* --------------------------------------------------------------
CategoryInterface.inc.php 2016-06-23
Gambio GmbH
http://www.gambio.de
Copyright (c) 2016 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Interface CategoryInterface
*
* @category System
* @package Category
* @subpackage Interfaces
*/
interface CategoryInterface
{
/**
* Is tax of the OrderItem allowed?
*
* @return bool Value if tax of the OrderItem allowed.
*/
public function isActive();
/**
* Sets whether category is active or not.
*
* @param BoolType $status Category active or not?
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setActive(BoolType $status);
/**
* Returns the ID of the parent category.
*
* @return int The ID of the parent category
*/
public function getParentId();
/**
* Sets the parent ID of the category.
*
* @param IdType $categoryId Category ID.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setParentId(IdType $categoryId);
/**
* Returns the sort order value.
*
* @return int Sort order value.
*/
public function getSortOrder();
/**
* Sets the sort order to the given value.
*
* @param IntType $sortOrder Sorting order.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setSortOrder(IntType $sortOrder);
/**
* Returns the date time when the category was added.
*
* @return DateTime The date time when the category was added.
*/
public function getAddedDateTime();
/**
* Sets the date time when the category was added.
*
* @param DateTime $added DateTime when the category has been added.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setAddedDateTime(DateTime $added);
/**
* Returns the date time when the category was modified last.
*
* @return DateTime The date time when the category was modified last.
*/
public function getLastModifiedDateTime();
/**
* Sets the date time when the category was modified last.
*
* @param DateTime $modified DateTime when the category has been lastly modified.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setLastModifiedDateTime(DateTime $modified);
/**
* Returns the settings of the category.
*
* @return CategorySettingsInterface Settings of the category.
*/
public function getSettings();
/**
* Sets the settings of the category.
*
* @param CategorySettingsInterface $categorySettings The settings of the category.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setSettings(CategorySettingsInterface $categorySettings);
/**
* Returns the name of the category in the language with the provided language code.
*
* @param LanguageCode $language Two letter Language code.
*
* @return string Name of the category from the given language code.
*/
public function getName(LanguageCode $language);
/**
* Sets the name of the category for the language with the provided language code.
*
* @param StringType $text Name of the category.
* @param LanguageCode $language Two letter language code.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setName(StringType $text, LanguageCode $language);
/**
* Returns the heading title of the category in the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string Heading title of the category from the given language code.
*/
public function getHeadingTitle(LanguageCode $language);
/**
* Sets the heading title of the category for the language with the provided language code.
*
* @param StringType $text Heading title of the category.
* @param LanguageCode $language Two letter language code.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setHeadingTitle(StringType $text, LanguageCode $language);
/**
* Returns the description of the category for the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string Description of the category from the given language code.
*/
public function getDescription(LanguageCode $language);
/**
* Sets the description of the category for the language with the provided language code.
*
* @param StringType $text Description of the category.
* @param LanguageCode $language Two letter language code.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setDescription(StringType $text, LanguageCode $language);
/**
* Returns the meta title of the category for the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string Meta title of the category from the given language code
*/
public function getMetaTitle(LanguageCode $language);
/**
* Sets the meta title of the category for the language with the provided language code.
*
* @param StringType $text Meta title of the category.
* @param LanguageCode $language Two letter language code.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setMetaTitle(StringType $text, LanguageCode $language);
/**
* Returns the meta description of the category in the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string Meta description of the category from the given language code.
*/
public function getMetaDescription(LanguageCode $language);
/**
* Sets the meta description of the category for the language with the provided language code.
*
* @param StringType $text Meta description of the category.
* @param LanguageCode $language Two letter language code.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setMetaDescription(StringType $text, LanguageCode $language);
/**
* Returns the meta keywords of the category in the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string Meta keywords of the category from the given language code.
*/
public function getMetaKeywords(LanguageCode $language);
/**
* Sets the meta keywords of the category for the language with the provided language code.
*
* @param StringType $text The meta keyword for the category.
* @param LanguageCode $language Two letter language code.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setMetaKeywords(StringType $text, LanguageCode $language);
/**
* Returns the url keywords of the category in the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string URL keywords of the category from the given language code.
*/
public function getUrlKeywords(LanguageCode $language);
/**
* Sets the url keywords of the category for the language with the provided language code.
*
* @param StringType $text URL Keyword for the category.
* @param LanguageCode $language Two letter language code.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setUrlKeywords(StringType $text, LanguageCode $language);
/**
* Get URL rewrite
*
* Returns the URL rewrite of the category, depending on the provided language code.
*
* @throws InvalidArgumentException if the language code is not valid.
*
* @param LanguageCode $language The language code of the URL rewrite to be return.
*
* @return UrlRewrite The URL rewrite of the category.
*/
public function getUrlRewrite(LanguageCode $language);
/**
* Get URL rewrites
*
* Returns the URL rewrites of the category.
*
* @return UrlRewriteCollection The URL rewrites of the category.
*/
public function getUrlRewrites();
/**
* Set URL rewrite
*
* Sets the URL rewrite of the category for the provided language code.
*
* @param UrlRewrite $urlRewrite The URL rewrite instance.
* @param LanguageCode $language The language code for the URL keywords.
*
* @return Category Same instance for chained method calls.
*/
public function setUrlRewrite(UrlRewrite $urlRewrite, LanguageCode $language);
/**
* Set URL rewrites
*
* Sets the URL rewrites of the category.
*
* @param UrlRewriteCollection $urlRewrites The URL rewrites.
*
* @return Category Same instance for chained method calls.
*/
public function setUrlRewrites(UrlRewriteCollection $urlRewrites);
/**
* Returns the image filename of the category.
*
* @return string The image filename of the category.
*/
public function getImage();
/**
* Sets the image filename of the category.
*
* @param StringType $imageFile Image filename.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setImage(StringType $imageFile);
/**
* Returns the alternative text of the image in the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string The alt text of the image.
*/
public function getImageAltText(LanguageCode $language);
/**
* Set the alternative text of the image for the language with the provided language code.
*
* @param StringType $text Alternative text for the image.
* @param LanguageCode $language Two letter language code.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setImageAltText(StringType $text, LanguageCode $language);
/**
* Returns the icon filename of the category.
*
* @return string The icon filename of the category.
*/
public function getIcon();
/**
* Sets the icon filename of the category.
*
* @param StringType $iconFile Icon filename.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setIcon(StringType $iconFile);
/**
* Returns an addon value by a given key.
*
* @param StringType $key Identifier key.
*
* @return string Addon value by a given key.
*/
public function getAddonValue(StringType $key);
/**
* Sets an addon key and value.
*
* @param StringType $key Identifier key.
* @param StringType $value The value to be saved.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function setAddonValue(StringType $key, StringType $value);
/**
* Returns a KeyValueCollection of addon values.
*
* @return KeyValueCollection A KeyValueCollection of addon values.
*/
public function getAddonValues();
/**
* Adds a KeyValueCollection of addon values.
*
* @param KeyValueCollection $collection Key value collection.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function addAddonValues(KeyValueCollection $collection);
/**
* Deletes an addon value with a given key from the KeyValueCollection.
*
* @param StringType $key Identifier key.
*
* @return CategoryInterface Same instance for chained method calls.
*/
public function deleteAddonValue(StringType $key);
}