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 

<?php

/* --------------------------------------------------------------
   ProductListProvider.inc.php 2018-02-14
   Gambio GmbH
   http://www.gambio.de
   Copyright (c) 2018 Gambio GmbH
   Released under the GNU General Public License (Version 2)
   [http://www.gnu.org/licenses/gpl-2.0.html]
   --------------------------------------------------------------
*/

/**
 * Class ProductListProvider
 *
 * @category   System
 * @package    Product
 * @subpackage Providers
 */
class ProductListProvider implements ProductListProviderInterface
{
    /**
     * Two-letter language code.
     *
     * @var LanguageCode
     */
    protected $languageCode;
    
    /**
     * Database query conditions.
     *
     * @var array
     */
    protected $conditions;
    
    /**
     * Product repository.
     *
     * @var ProductRepositoryInterface
     */
    protected $productRepository;
    
    /**
     * Database connection.
     *
     * @var CI_DB_query_builder
     */
    protected $db;
    
    
    /**
     * ProductListProvider constructor.
     *
     * @param LanguageCode               $languageCode Two-letter language code.
     * @param array                      $conditions   Database query conditions.
     * @param ProductRepositoryInterface $productRepo  Product repository.
     * @param CI_DB_query_builder        $db           Database connection.
     */
    public function __construct(LanguageCode $languageCode,
                                array $conditions = array(),
                                ProductRepositoryInterface $productRepo,
                                CI_DB_query_builder $db)
    {
        $this->languageCode      = $languageCode;
        $this->conditions        = $conditions;
        $this->productRepository = $productRepo;
        $this->db                = $db;
    }
    
    
    /**
     * Returns a product list item collection by the provided category ID.
     *
     * @param IdType $categoryId Category ID.
     *
     * @throws InvalidArgumentException if the provided category ID is not valid.
     *
     * @return ProductListItemCollection
     */
    public function getByCategoryId(IdType $categoryId)
    {
        $this->_selectWithCategories()->_applyExtraConditions();
        
        $this->db->where('products_to_categories.categories_id', $categoryId->asInt());
        
        $result = $this->db->get()->result_array();
        
        return $this->_prepareCollection($result);
    }
    
    
    /**
     * Get all product list items.
     *
     * @return ProductListItemCollection
     */
    public function getAll()
    {
        // Build select part of query.
        $result = $this->_select()->_applyExtraConditions()->db->get()->result_array();
        
        return $this->_prepareCollection($result);
    }
    
    
    /**
     * Returns a paged list of product items.
     *
     * @param \IntType|null $page  (Optional) Offset of resource elements.
     * @param \IntType|null $limit (Optional) Maximum amount of elements per page.
     *
     * @return \ProductListItemCollection
     */
    public function getAllPaged(IntType $page = null, IntType $limit = null)
    {
        $result = $this->_select()->_applyExtraConditions()->_applyLimitAndOffset($page, $limit)->db->get()
                                                                                                    ->result_array();
        
        return $this->_prepareCollection($result);
    }
    
    
    /**
     * Applies a LIMIT,OFFSET clause to the currently building query.
     *
     * @param \IntType|null $page  Page to calculate the given offset.
     * @param \IntType|null $limit Limit of result count.
     *
     * @return $this|ProductListProvider Same instance for chained method calls.
     */
    protected function _applyLimitAndOffset(IntType $page = null, IntType $limit = null)
    {
        $limit  = $limit ? $limit->asInt() : 50;
        $offset = $page && $page->asInt() > 1 ? $limit * ($page->asInt() - 1) : 0;
        $this->db->limit($limit, $offset);
        
        return $this;
    }
    
    
    /**
     * Build the select part of the query build.
     *
     * @return ProductListProvider Same instance for chained method calls.
     */
    protected function _select()
    {
        // Build the database query.
        $this->db->select('products.*, products_description.*, products_quantity_unit.quantity_unit_id')
                 ->from('products, products_description')
                 ->join('products_quantity_unit', 'products_quantity_unit.products_id = products.products_id', 'left')
                 ->join('languages', 'languages.languages_id = products_description.language_id', 'inner')
                 ->where('products_description.products_id = products.products_id')
                 ->where('languages.code', $this->languageCode->asString())
                 ->order_by('products.products_id', 'asc')
                 ->order_by('products_description.language_id', 'asc');
        
        return $this;
    }
    
    
    /**
     * Build the select part of the query build and additionally join the products_to_categories table.
     *
     * @return ProductListProvider Same instance for chained method calls.
     */
    protected function _selectWithCategories()
    {
        // Build the database query.
        $this->_select()->db->join('products_to_categories',
                                   'products_to_categories.products_id = products.products_id', 'left');
        
        return $this;
    }
    
    
    /**
     * Apply extra query conditions.
     *
     * @return ProductListProvider Same instance for chained method calls.
     */
    protected function _applyExtraConditions()
    {
        // Check for additional conditions to be appended to query (the AND operator will be used).
        if(count($this->conditions) > 0)
        {
            $this->db->where($this->conditions);
        }
        
        return $this;
    }
    
    
    /**
     * Prepares the ProductListItemCollection object.
     *
     * @param array $result Query result.
     *
     * @throws InvalidArgumentException if the provided result is not valid.
     *
     * @return ProductListItemCollection
     */
    protected function _prepareCollection(array $result)
    {
        $listItems = array();
        
        // Iterate over each query result row and create a ProductListItem for each row which will be pushed
        // into $listItems array.
        foreach($result as $row)
        {
            $productId            = new IdType((int)$row['products_id']);
            $isActive             = new BoolType((bool)$row['products_status']);
            $sortOrder            = new IntType((int)$row['products_sort']);
            $addedDateTime        = new EmptyDateTime($row['products_date_added']);
            $availableDateTime    = new EmptyDateTime($row['products_date_available']);
            $lastModifiedDateTime = new EmptyDateTime($row['products_last_modified']);
            $orderedCount         = new IntType((int)$row['products_ordered']);
            $productModel         = new StringType((string)$row['products_model']);
            $ean                  = new StringType((string)$row['products_ean']);
            $price                = new DecimalType((float)$row['products_price']);
            $discountAllowed      = new DecimalType((float)$row['products_discount_allowed']);
            $taxClassId           = new IdType((int)$row['products_tax_class_id']);
            $quantity             = new DecimalType($row['products_quantity']);
            $name                 = new StringType((string)$row['products_name']);
            $image                = new StringType((string)$row['products_image']);
            $imageAltText         = new StringType((string)$row['gm_alt_text']);
            $urlKeyWords          = new StringType((string)$row['products_meta_keywords']);
            $weight               = new DecimalType((float)$row['products_weight']);
            $shippingCosts        = new DecimalType((float)$row['nc_ultra_shipping_costs']);
            $shippingTimeId       = new IdType((int)$row['products_shippingtime']);
            $productTypeId        = new IdType((int)$row['product_type']);
            $manufacturerId       = new IdType((int)$row['manufacturers_id']);
            $quantityUnitId       = new IdType((int)$row['quantity_unit_id']);
            $isFsk18              = new BoolType((bool)$row['products_fsk18']);
            $isVpeActive          = new BoolType((bool)$row['products_vpe_status']);
            $vpeId                = new IdType((int)$row['products_vpe']);
            $vpeValue             = new DecimalType((float)$row['products_vpe_value']);
            
            $productListItem = MainFactory::create('ProductListItem', $this->productRepository);
            
            $productListItem->setProductId($productId)
                            ->setActive($isActive)
                            ->setSortOrder($sortOrder)
                            ->setAddedDateTime($addedDateTime)
                            ->setAvailableDateTime($availableDateTime)
                            ->setLastModifiedDateTime($lastModifiedDateTime)
                            ->setOrderedCount($orderedCount)
                            ->setProductModel($productModel)
                            ->setEan($ean)
                            ->setPrice($price)
                            ->setDiscountAllowed($discountAllowed)
                            ->setTaxClassId($taxClassId)
                            ->setQuantity($quantity)
                            ->setName($name)
                            ->setImage($image)
                            ->setImageAltText($imageAltText)
                            ->setUrlKeywords($urlKeyWords)
                            ->setWeight($weight)
                            ->setShippingCosts($shippingCosts)
                            ->setShippingTimeId($shippingTimeId)
                            ->setProductTypeId($productTypeId)
                            ->setManufacturerId($manufacturerId)
                            ->setQuantityUnitId($quantityUnitId)
                            ->setFsk18($isFsk18)
                            ->setVpeActive($isVpeActive)
                            ->setVpeId($vpeId)
                            ->setVpeValue($vpeValue);
            
            $listItems[] = $productListItem;
        }
        
        $collection = MainFactory::create('ProductListItemCollection', $listItems);
        
        return $collection;
    }
}