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 

<?php

/* --------------------------------------------------------------
   CategoryRepositoryInterface.inc.php 2016-01-29
   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 CategoryRepositoryInterface
 * 
 * This interface defines methods for handling the database operations that concern the category records of the
 * database. It provides a layer for more complicated methods that use the writer, reader and deleter.
 *
 * @category   System
 * @package    Category
 * @subpackage Interfaces
 */
interface CategoryRepositoryInterface
{
    /**
     * Adds a category.
     *
     * @param CategoryInterface $category Category to add.
     *
     * @return int Stored id of the passed category.
     */
    public function add(CategoryInterface $category);
    
    
    /**
     * Stores a category.
     *
     * @param StoredCategoryInterface $category Stored category.
     *
     * @return CategoryRepositoryInterface Same instance for chained method calls.
     */
    public function store(StoredCategoryInterface $category);
    
    
    /**
     * Gets a category by the given ID.
     *
     * @param IdType $categoryId Category ID.
     *
     * @return StoredCategoryInterface
     */
    public function getCategoryById(IdType $categoryId);
    
    
    /**
     * Deletes a category by the given ID.
     *
     * @param IdType $categoryId Category ID.
     *
     * @return CategoryRepositoryInterface Same instance for chained method calls.
     */
    public function deleteCategoryById(IdType $categoryId);
    
    
    /**
     * Returns all Categories with the provided parent ID.
     *
     * @param IdType $parentId
     *
     * @return IdCollection
     */
    public function getCategoryIdsByParentId(IdType $parentId);
    
    
    /**
     * Returns an id collection with the ids of subcategories.
     *
     * @param \IdType $parentCategoryId Parent category id.
     *
     * @return IdCollection
     */
    public function getCategoryIdsTree(IdType $parentCategoryId);
}