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 <?php
/* --------------------------------------------------------------
ProductListProvider.inc.php 2015-12-11
Gambio GmbH
http://www.gambio.de
Copyright (c) 2015 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 $productRepo;
/**
* 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->productRepo = $productRepo;
$this->db = $db;
}
/**
* 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.*')
->from('products, products_description')
->join('products_to_categories', 'products_to_categories.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());
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)
{
$productRepo = $this->productRepo;
$id = new IdType((int)$row['products_id']);
$isActive = new BoolType((bool)$row['products_status']);
$name = new StringType((string)$row['products_name']);
$urlKeyWords = new StringType((string)$row['products_meta_keywords']);
$image = new StringType((string)$row['products_image']);
$imageAltText = new StringType((string)$row['gm_alt_text']);
$productListItem = MainFactory::create('ProductListItem', $productRepo, $id, $isActive, $name, $urlKeyWords,
$image, $imageAltText);
$listItems[] = $productListItem;
}
$collection = MainFactory::create('ProductListItemCollection', $listItems);
return $collection;
}
/**
* 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->_select()->_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.
$this->db->select('products.*, products_description.*')
->from('products, products_description')
->join('languages', 'languages.languages_id = products_description.language_id', 'inner')
->where('products_description.products_id = products.products_id')
->where('languages.code', $this->languageCode->asString());
$this->_applyExtraConditions();
$result = $this->db->get()->result_array();
return $this->_prepareCollection($result);
}
}