1 <?php
2
3 /* --------------------------------------------------------------
4 CategoryListProviderInterface.inc.php 2015-11-25
5 Gambio GmbH
6 http://www.gambio.de
7 Copyright (c) 2015 Gambio GmbH
8 Released under the GNU General Public License (Version 2)
9 [http://www.gnu.org/licenses/gpl-2.0.html]
10 --------------------------------------------------------------
11 */
12
13 /**
14 * Interface CategoryListProviderInterface
15 *
16 * This interface defines methods for creating a list of flattened categories with just its essential data.
17 * The list of categories is filtered by its parent category ID and customer status permissions and for simplicity
18 * it contains language specific data only in one language.
19 *
20 * @category System
21 * @package Category
22 * @subpackage Interfaces
23 */
24 interface CategoryListProviderInterface
25 {
26 /**
27 * Returns a category list based the parent ID provided.
28 *
29 * @param IdType $parentId Category parent ID.
30 *
31 * @return CategoryListItemCollection
32 */
33 public function getByParentId(IdType $parentId);
34 }