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 
<?php
/* --------------------------------------------------------------
   CategoryRepositoryReader.inc.php 2016-04-18
   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]
   --------------------------------------------------------------
*/

/**
 * Class CategoryRepositoryReader
 *
 * This class provides methods for fetching specific category records from the database and is used in the category
 * repository among the classes for writing and deleting category records.
 *
 * @category   System
 * @package    Category
 * @subpackage Repositories
 */
class CategoryRepositoryReader implements CategoryRepositoryReaderInterface
{
    /**
     * Database connector.
     *
     * @var CI_DB_query_builder
     */
    protected $db;
    
    /**
     * Category factory.
     *
     * @var CategoryFactoryInterface
     */
    protected $categoryFactory;
    
    
    /**
     * CategoryRepositoryReader constructor.
     *
     * @param CI_DB_query_builder      $db              Database connector.
     * @param CategoryFactoryInterface $categoryFactory Category factory.
     */
    public function __construct(CI_DB_query_builder $db, CategoryFactoryInterface $categoryFactory)
    {
        $this->db              = $db;
        $this->categoryFactory = $categoryFactory;
    }
    
    
    /**
     * Returns a category.
     *
     * @param IdType $categoryId Category ID.
     *
     * @throws UnexpectedValueException if no category record for the provided category ID was found.
     * 
     * @return StoredCategoryInterface
     */
    public function getById(IdType $categoryId)
    {
        // Query the categories table.
        $categoryData = $this->db->get_where('categories', array(
            'categories_id' => $categoryId->asInt()
        ))->row_array();
        
        // Get language specific context.
        $categoryDescriptionQuery = $this->db->select('categories_description.*, languages.code AS language_code')
                                             ->from('categories_description')
                                             ->join('languages',
                                                    'languages.languages_id = categories_description.language_id',
                                                    'inner')
                                             ->where('categories_description.categories_id', $categoryId->asInt());
        
        $categoryDescription = $categoryDescriptionQuery->get()->result_array();
        
        if($categoryData === null)
        {
            throw new UnexpectedValueException('The requested category was not found in database (ID:'
                                               . $categoryId->asInt() . ')');
        }
        
        if($categoryDescription === null)
        {
            throw new UnexpectedValueException('The requested category description was not found in database (ID:'
                                               . $categoryId->asInt() . ')');
        }
        
        $category = $this->_createCategoryByArray($categoryData, $categoryDescription);
        
        return $category;
    }
    
    
    /**
     * Returns all Categories with the provided parent ID.
     * 
     * @param IdType $parentId
     *
     * @return IdCollection
     */
    public function getByParentId(IdType $parentId)
    {
        $subCategories = array();
        $result = $this->db->select('categories_id')
                           ->get_where('categories', array('parent_id' => $parentId->asInt()))
                           ->result_array();
        
        foreach($result as $row)
        {
            $categoryId = new IdType($row['categories_id']);
            $subCategories[] = $categoryId;
        }
        
        $idCollection = new IdCollection($subCategories);
        
        return $idCollection;
    }
    
    
    /**
     * Returns an id collection with the ids of subcategories.
     *
     * @param \IdType $parentCategoryId Parent category id.
     *
     * @return IdCollection
     */
    public function getCategoryIdsTree(IdType $parentCategoryId)
    {
        $categoryIds     = array_merge([$parentCategoryId->asInt()],
                                       $this->_getCategoryIdsTreeArray($parentCategoryId));
        $categoryIdTypes = [];
        
        foreach($categoryIds as $categoryId)
        {
            $categoryIdTypes[] = new IdType($categoryId);
        }
        
        $categoryIdCollection = MainFactory::create('IdCollection', $categoryIdTypes);
        
        return $categoryIdCollection;
    }
    
    
    /**
     * Fetches the ids of the subcategories from the passed parent category.
     *
     * @param \IdType $parentCategoryId Parent id from category of subcategory ids to be fetched.
     *
     * @return array Contains unsorted ids of sub categories from passed parent category id.
     */
    protected function _getCategoryIdsTreeArray(IdType $parentCategoryId)
    {
        $categoryIds = array_map(function ($el)
        {
            return (int)$el['categories_id'];
        }, $this->db->select('categories_id')
                    ->from('categories')
                    ->where('parent_id', $parentCategoryId->asInt())
                    ->get()
                    ->result_array());
        
        foreach($categoryIds as $categoryId)
        {
            $categoryIds = array_merge($categoryIds, $this->_getCategoryIdsTreeArray(new IdType($categoryId)));
        }
        
        return $categoryIds;
    }
    
    
    /**
     * Creates a category instance.
     *
     * @param array $categoryData            Category query result.
     * @param array $categoryDescriptionData Category description query result.
     *
     * @return StoredCategory Returns the complete category object.
     *                        
     * @throws LogicException
     * @throws InvalidArgumentException
     */
    protected function _createCategoryByArray(array $categoryData, array $categoryDescriptionData)
    {
        $category = $this->categoryFactory->createStoredCategory(new IdType($categoryData['categories_id']));
        $category->setActive(new BoolType((boolean)$categoryData['categories_status']));
        $category->setParentId(new IdType($categoryData['parent_id']));
        $category->setSortOrder(new IntType((int)$categoryData['sort_order']));
        $category->setAddedDateTime(new EmptyDateTime($categoryData['date_added']));
        $category->setLastModifiedDateTime(new EmptyDateTime($categoryData['last_modified']));
        $category->setImage(new StringType((string)$categoryData['categories_image']));
        $category->setIcon(new StringType((string)$categoryData['categories_icon']));
        
        // Set language specific data.
        foreach($categoryDescriptionData as $row)
        {
            $languageCode = new LanguageCode(new NonEmptyStringType((string)$row['language_code']));
            
            $category->setName(new StringType((string)$row['categories_name']), $languageCode);
            $category->setHeadingTitle(new StringType((string)$row['categories_heading_title']), $languageCode);
            $category->setDescription(new StringType((string)$row['categories_description']), $languageCode);
            $category->setMetaTitle(new StringType((string)$row['categories_meta_title']), $languageCode);
            $category->setMetaDescription(new StringType((string)$row['categories_meta_description']), $languageCode);
            $category->setMetaKeywords(new StringType((string)$row['categories_meta_keywords']), $languageCode);
            $category->setUrlKeywords(new StringType((string)$row['gm_url_keywords']), $languageCode);
            $category->setImageAltText(new StringType((string)$row['gm_alt_text']), $languageCode);
        }
        
        return $category;
    }
}