* @copyright Since 2007 PrestaShop SA and Contributors * @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0) */ /** * Class TagCore. */ class TagCore extends ObjectModel { /** @var int Language id */ public $id_lang; /** @var string Name */ public $name; /** * @see ObjectModel::$definition */ public static $definition = [ 'table' => 'tag', 'primary' => 'id_tag', 'fields' => [ 'id_lang' => ['type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true], 'name' => ['type' => self::TYPE_STRING, 'validate' => 'isGenericName', 'required' => true, 'size' => 32], ], ]; protected $webserviceParameters = [ 'fields' => [ 'id_lang' => ['xlink_resource' => 'languages'], ], ]; public function __construct($id = null, $name = null, $idLang = null) { $this->def = Tag::getDefinition($this); $this->setDefinitionRetrocompatibility(); if ($id) { parent::__construct($id); } elseif ($name && Validate::isGenericName($name) && $idLang && Validate::isUnsignedId($idLang)) { $row = Db::getInstance(_PS_USE_SQL_SLAVE_)->getRow(' SELECT * FROM `' . _DB_PREFIX_ . 'tag` t WHERE `name` = \'' . pSQL($name) . '\' AND `id_lang` = ' . (int) $idLang); if ($row) { $this->id = (int) $row['id_tag']; $this->id_lang = (int) $row['id_lang']; $this->name = $row['name']; } } } public function add($autoDate = true, $nullValues = false) { if (!parent::add($autoDate, $nullValues)) { return false; } elseif (isset($_POST['products'])) { return $this->setProducts(Tools::getValue('products')); } return true; } /** * @return bool */ public function delete() { if (!parent::delete()) { return false; } Search::removeProductsSearchIndex(array_column($this->getProducts(), 'id_product')); return true; } /** * Add several tags in database and link it to a product. * * @param int $idLang Language id * @param int $idProduct Product id to link tags with * @param string|array $tagList List of tags, as array or as a string with comas * * @return bool Operation success */ public static function addTags($idLang, $idProduct, $tagList, $separator = ',') { if (!Validate::isUnsignedId($idLang)) { return false; } if (!is_array($tagList)) { $tagList = array_filter(array_unique(array_map('trim', preg_split('#\\' . $separator . '#', $tagList, 0, PREG_SPLIT_NO_EMPTY)))); } $list = []; if (is_array($tagList)) { foreach ($tagList as $tag) { if (!Validate::isGenericName($tag)) { return false; } $tagMaxLength = self::$definition['fields']['name']['size']; $tag = trim(Tools::substr(trim($tag), 0, $tagMaxLength)); $tagObj = new Tag(null, $tag, (int) $idLang); /* Tag does not exist in database */ if (!Validate::isLoadedObject($tagObj)) { $tagObj->name = $tag; $tagObj->id_lang = (int) $idLang; $tagObj->add(); } if (!in_array($tagObj->id, $list)) { $list[] = $tagObj->id; } } } $data = []; foreach ($list as $tag) { $data[] = [ 'id_tag' => (int) $tag, 'id_product' => (int) $idProduct, 'id_lang' => (int) $idLang, ]; } $result = Db::getInstance()->insert('product_tag', $data); if ($list != []) { self::updateTagCount($list); } return $result; } /** * Update tag count. * * @param array|null $tagList */ public static function updateTagCount($tagList = null) { if (!Module::getBatchMode()) { if ($tagList != null) { $tagListQuery = ' AND pt.id_tag IN (' . implode(',', array_map('intval', $tagList)) . ')'; Db::getInstance()->execute('DELETE pt FROM `' . _DB_PREFIX_ . 'tag_count` pt WHERE 1=1 ' . $tagListQuery); } else { $tagListQuery = ''; } Db::getInstance()->execute('REPLACE INTO `' . _DB_PREFIX_ . 'tag_count` (id_group, id_tag, id_lang, id_shop, counter) SELECT cg.id_group, pt.id_tag, pt.id_lang, id_shop, COUNT(pt.id_tag) AS times FROM `' . _DB_PREFIX_ . 'product_tag` pt INNER JOIN `' . _DB_PREFIX_ . 'product_shop` product_shop USING (id_product) JOIN (SELECT DISTINCT id_group FROM `' . _DB_PREFIX_ . 'category_group`) cg WHERE product_shop.`active` = 1 AND EXISTS(SELECT 1 FROM `' . _DB_PREFIX_ . 'category_product` cp LEFT JOIN `' . _DB_PREFIX_ . 'category_group` cgo ON (cp.`id_category` = cgo.`id_category`) WHERE cgo.`id_group` = cg.id_group AND product_shop.`id_product` = cp.`id_product`) ' . $tagListQuery . ' GROUP BY pt.id_tag, pt.id_lang, cg.id_group, id_shop ORDER BY NULL'); Db::getInstance()->execute('REPLACE INTO `' . _DB_PREFIX_ . 'tag_count` (id_group, id_tag, id_lang, id_shop, counter) SELECT 0, pt.id_tag, pt.id_lang, id_shop, COUNT(pt.id_tag) AS times FROM `' . _DB_PREFIX_ . 'product_tag` pt INNER JOIN `' . _DB_PREFIX_ . 'product_shop` product_shop USING (id_product) WHERE product_shop.`active` = 1 ' . $tagListQuery . ' GROUP BY pt.id_tag, pt.id_lang, id_shop ORDER BY NULL'); } } /** * Get main tags. * * @param int $idLang Language ID * @param int $nb number * * @return array|false|mysqli_result|PDOStatement|resource|null */ public static function getMainTags($idLang, $nb = 10) { $context = Context::getContext(); if (Group::isFeatureActive()) { $groups = FrontController::getCurrentCustomerGroups(); return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS(' SELECT t.name, counter AS times FROM `' . _DB_PREFIX_ . 'tag_count` pt LEFT JOIN `' . _DB_PREFIX_ . 'tag` t ON (t.id_tag = pt.id_tag) WHERE pt.`id_group` ' . (count($groups) ? 'IN (' . implode(',', $groups) . ')' : '=' . (int) Group::getCurrent()->id) . ' AND pt.`id_lang` = ' . (int) $idLang . ' AND pt.`id_shop` = ' . (int) $context->shop->id . ' ORDER BY times DESC LIMIT ' . (int) $nb); } else { return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS(' SELECT t.name, counter AS times FROM `' . _DB_PREFIX_ . 'tag_count` pt LEFT JOIN `' . _DB_PREFIX_ . 'tag` t ON (t.id_tag = pt.id_tag) WHERE pt.id_group = 0 AND pt.`id_lang` = ' . (int) $idLang . ' AND pt.`id_shop` = ' . (int) $context->shop->id . ' ORDER BY times DESC LIMIT ' . (int) $nb); } } /** * Get Product Tags. * * @param int $idProduct Product ID * * @return array|bool */ public static function getProductTags($idProduct) { if (!$tmp = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS(' SELECT t.`id_lang`, t.`name` FROM ' . _DB_PREFIX_ . 'tag t LEFT JOIN ' . _DB_PREFIX_ . 'product_tag pt ON (pt.id_tag = t.id_tag) WHERE pt.`id_product`=' . (int) $idProduct)) { return false; } $result = []; foreach ($tmp as $tag) { $result[$tag['id_lang']][] = $tag['name']; } return $result; } /** * Get Products. * * @param bool $associated * @param Context|null $context * * @return array|false|mysqli_result|PDOStatement|resource|null */ public function getProducts($associated = true, Context $context = null) { if (!$context) { $context = Context::getContext(); } $idLang = $this->id_lang ? $this->id_lang : $context->language->id; if (!$this->id && $associated) { return []; } $in = $associated ? 'IN' : 'NOT IN'; // select not only active products when we are getting list of already associated products // to avoid confusion when product is disabled, but still has the tag assigned $onlyActive = $associated ? '' : 'AND product_shop.active = 1'; return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS(' SELECT pl.name, pl.id_product FROM `' . _DB_PREFIX_ . 'product` p LEFT JOIN `' . _DB_PREFIX_ . 'product_lang` pl ON p.id_product = pl.id_product' . Shop::addSqlRestrictionOnLang('pl') . ' ' . Shop::addSqlAssociation('product', 'p') . ' WHERE pl.id_lang = ' . (int) $idLang . ' ' . $onlyActive . ' ' . ($this->id ? ('AND p.id_product ' . $in . ' (SELECT pt.id_product FROM `' . _DB_PREFIX_ . 'product_tag` pt WHERE pt.id_tag = ' . (int) $this->id . ')') : '') . ' ORDER BY pl.name'); } /** * Set products. * * @param array $array * * @return bool */ public function setProducts($array) { $result = Db::getInstance()->delete('product_tag', 'id_tag = ' . (int) $this->id); if (is_array($array)) { $array = array_map('intval', $array); $result = $result && ObjectModel::updateMultishopTable('Product', ['indexed' => 0], 'a.id_product IN (' . implode(',', $array) . ')'); if ($result) { $ids = []; foreach ($array as $idProduct) { $ids[] = '(' . (int) $idProduct . ',' . (int) $this->id . ',' . (int) $this->id_lang . ')'; } $result = Db::getInstance()->execute('INSERT INTO ' . _DB_PREFIX_ . 'product_tag (id_product, id_tag, id_lang) VALUES ' . implode(',', $ids)); if (Configuration::get('PS_SEARCH_INDEXATION')) { $result = $result && Search::indexation(false); } } } self::updateTagCount([(int) $this->id]); return $result; } /** * Delete tags for product. * * @param int $idProduct Product ID * * @return bool * * @throws PrestaShopDatabaseException */ public static function deleteTagsForProduct($idProduct) { return self::deleteProductTags($idProduct); } /** * Delete tags for product in specific language * * @param int $productId * @param int $langId * * @return bool */ public static function deleteProductTagsInLang(int $productId, int $langId) { return self::deleteProductTags($productId, $langId); } /** * Deletes product tags. * * @param int $idProduct * @param int|null $langId if provided, only deletes tags in specific language * * @return bool * * @throws PrestaShopDatabaseException */ private static function deleteProductTags($idProduct, int $langId = null) { $removeWhere = 'id_product = ' . (int) $idProduct; $selectTagsToRemove = ' SELECT id_tag FROM ' . _DB_PREFIX_ . 'product_tag WHERE id_product=' . (int) $idProduct ; if ($langId) { $removeWhere .= ' AND id_lang =' . $langId; $selectTagsToRemove .= ' AND id_lang =' . $langId; } $tagsRemoved = Db::getInstance()->executeS($selectTagsToRemove); $result = Db::getInstance()->delete('product_tag', $removeWhere); Db::getInstance()->delete('tag', 'NOT EXISTS (SELECT 1 FROM ' . _DB_PREFIX_ . 'product_tag WHERE ' . _DB_PREFIX_ . 'product_tag.id_tag = ' . _DB_PREFIX_ . 'tag.id_tag)'); $tagList = []; foreach ($tagsRemoved as $tagRemoved) { $tagList[] = $tagRemoved['id_tag']; } if ($tagList != []) { self::updateTagCount($tagList); } return $result; } }