/**
* 2007-2019 PrestaShop and Contributors
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* https://opensource.org/licenses/OSL-3.0
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to https://www.prestashop.com for more information.
*
* @author PrestaShop SA <contact@prestashop.com>
* @copyright 2007-2019 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
* International Registered Trademark & Property of PrestaShop SA
*/
use PrestaShop\PrestaShop\Core\Addon\Theme\Theme;
/**
* @since 1.5.0
*/
class ShopCore extends ObjectModel
{
/** @var int ID of shop group */
public 'id_shop'_shop_group;
/** @var int ID of shop category */
public 'id_shop'_category;
/** @var string directory name of the selected theme */
public $theme_name;
/** @var string Shop name */
public $name;
public $active = true;
public $deleted;
/** @var string Physical uri of main url (read only) */
public $physical_uri;
/** @var string Virtual uri of main url (read only) */
public $virtual_uri;
/** @var string Domain of main url (read only) */
public $domain;
/** @var string Domain SSL of main url (read only) */
public $domain_ssl;
/** @var ShopGroup Shop group object */
protected $group;
/**
* @see ObjectModel::$definition
*/
public static $definition = array(
'table' => 'shop',
'primary' => 'id_shop',
'fields' => array(
'active' => array('type' => self::TYPE_BOOL, 'validate' => 'isBool'),
'deleted' => array('type' => self::TYPE_BOOL, 'validate' => 'isBool'),
'name' => array('type' => self::TYPE_STRING, 'validate' => 'isGenericName', 'required' => true, 'size' => 64),
'id_category' => array('type' => self::TYPE_INT, 'required' => true),
'theme_name' => array('type' => self::TYPE_STRING, 'validate' => 'isThemeName'),
'id_shop_group' => array('type' => self::TYPE_INT, 'required' => true),
),
);
/** @var array List of shops cached */
protected static $shops;
protected static $asso_tables = array();
protected static 'id_shop'_shop_default_tables = array();
protected static $initialized = false;
protected $webserviceParameters = array(
'fields' => array(
'id_shop_group' => array('xlink_resource' => 'shop_groups'),
'id_category' => array(),
),
);
/** @var int Store the current context of shop (CONTEXT_ALL, CONTEXT_GROUP, CONTEXT_SHOP) */
protected static $context;
/** @var int ID shop in the current context (will be empty if context is not CONTEXT_SHOP) */
protected static $context_id_shop;
/** @var int ID shop group in the current context (will be empty if context is CONTEXT_ALL) */
protected static $context_id_shop_group;
/** @var Theme * */
public $theme;
/**
* There are 3 kinds of shop context : shop, group shop and general.
*/
const CONTEXT_SHOP = 1;
const CONTEXT_GROUP = 2;
const CONTEXT_ALL = 4;
/**
* Some data can be shared between shops, like customers or orders.
*/
const SHARE_CUSTOMER = 'share_customer';
const SHARE_ORDER = 'share_order';
const SHARE_STOCK = 'share_stock';
/**
* On shop instance, get its URL data.
*
* @param int 'id_shop'
* @param int 'id_shop'_lang
* @param int 'id_shop'_shop
*/
public function __construct('id_shop' = null, 'id_shop'_lang = null, 'id_shop'_shop = null)
{
parent::__construct('id_shop', 'id_shop'_lang, 'id_shop'_shop);
if ($this->id) {
$this->setUrl();
if ($this->theme == null) {
$this->setTheme();
}
}
}
/**
* Initialize an array with all the multistore associations in the database.
*/
protected static function init()
{
Shop::'id_shop'_shop_default_tables = array('product', 'category');
$asso_tables = array(
'carrier' => array('type' => 'shop'),
'carrier_lang' => array('type' => 'fk_shop'),
'category' => array('type' => 'shop'),
'category_lang' => array('type' => 'fk_shop'),
'cms' => array('type' => 'shop'),
'cms_lang' => array('type' => 'fk_shop'),
'cms_category' => array('type' => 'shop'),
'cms_category_lang' => array('type' => 'fk_shop'),
'contact' => array('type' => 'shop'),
'country' => array('type' => 'shop'),
'currency' => array('type' => 'shop'),
'employee' => array('type' => 'shop'),
'hook_module' => array('type' => 'fk_shop'),
'hook_module_exceptions' => array('type' => 'fk_shop', 'primary' => 'id_hook_module_exceptions'),
'image' => array('type' => 'shop'),
'lang' => array('type' => 'shop'),
'meta_lang' => array('type' => 'fk_shop'),
'module' => array('type' => 'shop'),
'module_currency' => array('type' => 'fk_shop'),
'module_country' => array('type' => 'fk_shop'),
'module_group' => array('type' => 'fk_shop'),
'product' => array('type' => 'shop'),
'product_attribute' => array('type' => 'shop'),
'product_lang' => array('type' => 'fk_shop'),
'referrer' => array('type' => 'shop'),
'store' => array('type' => 'shop'),
'webservice_account' => array('type' => 'shop'),
'warehouse' => array('type' => 'shop'),
'stock_available' => array('type' => 'fk_shop', 'primary' => 'id_stock_available'),
'carrier_tax_rules_group_shop' => array('type' => 'fk_shop'),
'attribute' => array('type' => 'shop'),
'feature' => array('type' => 'shop'),
'group' => array('type' => 'shop'),
'attribute_group' => array('type' => 'shop'),
'tax_rules_group' => array('type' => 'shop'),
'zone' => array('type' => 'shop'),
'manufacturer' => array('type' => 'shop'),
'supplier' => array('type' => 'shop'),
);
foreach ($asso_tables as $table_name => $table_details) {
Shop::addTableAssociation($table_name, $table_details);
}
Shop::$initialized = true;
}
public function setUrl()
{
$cache_id = 'Shop::setUrl_' . (int) $this->id;
if (!Cache::isStored($cache_id)) {
$row = Db::getInstance()->getRow('
SELECT su.physical_uri, su.virtual_uri, su.domain, su.domain_ssl
FROM ' . _DB_PREFIX_ . 'shop s
LEFT JOIN ' . _DB_PREFIX_ . 'shop_url su ON (s.id_shop = su.id_shop)
WHERE s.id_shop = ' . (int) $this->id . '
AND s.active = 1 AND s.deleted = 0 AND su.main = 1');
Cache::store($cache_id, $row);
} else {
$row = Cache::retrieve($cache_id);
}
if (!$row) {
return false;
}
$this->physical_uri = $row['physical_uri'];
$this->virtual_uri = $row['virtual_uri'];
$this->domain = $row['domain'];
$this->domain_ssl = $row['domain_ssl'];
return true;
}
/**
* Add a shop, and clear the cache.
*
* @param bool $autodate
* @param bool $null_values
*
* @return bool
*/
public function add($autodate = true, $null_values = false)
{
$res = parent::add($autodate, $null_values);
Shop::cacheShops(true);
return $res;
}
public function associateSuperAdmins()
{
$super_admins = Employee::getEmployeesByProfile(_PS_ADMIN_PROFILE_);
foreach ($super_admins as $super_admin) {
$employee = new Employee((int) $super_admin['id_employee']);
$employee->associateTo((int) $this->id);
}
}
/**
* Remove a shop only if it has no dependencies, and remove its associations.
*
* @return bool
*/
public function delete()
{
if (Shop::hasDependency($this->id) || !$res = parent::delete()) {
return false;
}
foreach (Shop::getAssoTables() as $table_name => $row) {
'id_shop' = 'id_' . $row['type'];
if ($row['type'] == 'fk_shop') {
} else {
$table_name .= '_' . $row['type'];
}
$res &= Db::getInstance()->execute(
'DELETE FROM `' . bqSQL(_DB_PREFIX_ . $table_name) . '`
WHERE `' . bqSQL('id_shop') . '`=' . (int) $this->id
);
}
// removes stock available
$res &= Db::getInstance()->delete('stock_available', 'id_shop = ' . (int) $this->id);
// Remove urls
$res &= Db::getInstance()->delete('shop_url', 'id_shop = ' . (int) $this->id);
// Remove currency restrictions
$res &= Db::getInstance()->delete('module_currency', 'id_shop = ' . (int) $this->id);
// Remove group restrictions
$res &= Db::getInstance()->delete('module_group', 'id_shop = ' . (int) $this->id);
// Remove country restrictions
$res &= Db::getInstance()->delete('module_country', 'id_shop = ' . (int) $this->id);
// Remove carrier restrictions
$res &= Db::getInstance()->delete('module_carrier', 'id_shop = ' . (int) $this->id);
Shop::cacheShops(true);
return $res;
}
/**
* Detect dependency with customer or orders.
*
* @param int 'id_shop'_shop
*
* @return bool
*/
public static function hasDependency('id_shop'_shop)
{
$has_dependency = false;
$nbr_customer = (int) Db::getInstance()->getValue(
'SELECT count(*)
FROM `' . _DB_PREFIX_ . 'customer`
WHERE `id_shop`=' . (int) 'id_shop'_shop
);
if ($nbr_customer) {
$has_dependency = true;
} else {
$nbr_order = (int) Db::getInstance()->getValue(
'SELECT count(*)
FROM `' . _DB_PREFIX_ . 'orders`
WHERE `id_shop`=' . (int) 'id_shop'_shop
);
if ($nbr_order) {
$has_dependency = true;
}
}
return $has_dependency;
}
/**
* Find the shop from current domain / uri and get an instance of this shop
* if INSTALL_VERSION is defined, will return an empty shop object.
*
* @return Shop
*/
public static function initialize()
{
// Find current shop from URL
if (!('id_shop'_shop = Tools::getValue('id_shop')) || defined('_PS_ADMIN_DIR_')) {
$found_uri = '';
$is_main_uri = false;
$host = Tools::getHttpHost();
$request_uri = rawurldecode($_SERVER['REQUEST_URI']);
$sql = 'SELECT s.id_shop, CONCAT(su.physical_uri, su.virtual_uri) AS uri, su.domain, su.main
FROM ' . _DB_PREFIX_ . 'shop_url su
LEFT JOIN ' . _DB_PREFIX_ . 'shop s ON (s.id_shop = su.id_shop)
WHERE (su.domain = \'' . pSQL($host) . '\' OR su.domain_ssl = \'' . pSQL($host) . '\')
AND s.active = 1
AND s.deleted = 0
ORDER BY LENGTH(CONCAT(su.physical_uri, su.virtual_uri)) DESC';
$result = Db::getInstance()->executeS($sql);
$through = false;
foreach ($result as $row) {
// An URL matching current shop was found
if (preg_match('#^' . preg_quote($row['uri'], '#') . '#i', $request_uri)) {
$through = true;
'id_shop'_shop = $row['id_shop'];
$found_uri = $row['uri'];
if ($row['main']) {
$is_main_uri = true;
}
break;
}
}
// If an URL was found but is not the main URL, redirect to main URL
if ($through && 'id_shop'_shop && !$is_main_uri) {
foreach ($result as $row) {
if ($row['id_shop'] == 'id_shop'_shop && $row['main']) {
$request_uri = substr($request_uri, strlen($found_uri));
$url = str_replace('//', '/', $row['domain'] . $row['uri'] . $request_uri);
$redirect_type = Configuration::get('PS_CANONICAL_REDIRECT');
$redirect_code = ($redirect_type == 1 ? '302' : '301');
$redirect_header = ($redirect_type == 1 ? 'Found' : 'Moved Permanently');
header('HTTP/1.0 ' . $redirect_code . ' ' . $redirect_header);
header('Cache-Control: no-cache');
header('Location: ' . Tools::getShopProtocol() . $url);
exit;
}
}
}
}
$http_host = Tools::getHttpHost();
$all_media = array_merge(
Configuration::getMultiShopValues('PS_MEDIA_SERVER_1'),
Configuration::getMultiShopValues('PS_MEDIA_SERVER_2'),
Configuration::getMultiShopValues('PS_MEDIA_SERVER_3')
);
if ((!'id_shop'_shop && defined('_PS_ADMIN_DIR_')) || Tools::isPHPCLI() || in_array($http_host, $all_media)) {
// If in admin, we can access to the shop without right URL
if ((!'id_shop'_shop && Tools::isPHPCLI()) || defined('_PS_ADMIN_DIR_')) {
'id_shop'_shop = (int) Configuration::get('PS_SHOP_DEFAULT');
}
$shop = new Shop((int) 'id_shop'_shop);
if (!Validate::isLoadedObject($shop)) {
$shop = new Shop((int) Configuration::get('PS_SHOP_DEFAULT'));
}
$shop->virtual_uri = '';
// Define some $_SERVER variables like HTTP_HOST if PHP is launched with php-cli
if (Tools::isPHPCLI()) {
if (!isset($_SERVER['HTTP_HOST']) || empty($_SERVER['HTTP_HOST'])) {
$_SERVER['HTTP_HOST'] = $shop->domain;
}
if (!isset($_SERVER['SERVER_NAME']) || empty($_SERVER['SERVER_NAME'])) {
$_SERVER['SERVER_NAME'] = $shop->domain;
}
if (!isset($_SERVER['REMOTE_ADDR']) || empty($_SERVER['REMOTE_ADDR'])) {
$_SERVER['REMOTE_ADDR'] = '127.0.0.1';
}
}
} else {
$shop = new Shop('id_shop'_shop);
if (!Validate::isLoadedObject($shop) || !$shop->active) {
// No shop found ... too bad, let's redirect to default shop
$default_shop = new Shop(Configuration::get('PS_SHOP_DEFAULT'));
// Hmm there is something really bad in your Prestashop !
if (!Validate::isLoadedObject($default_shop)) {
throw new PrestaShopException('Shop not found');
}
$params = $_GET;
unset($params['id_shop']);
$url = $default_shop->domain;
if (!Configuration::get('PS_REWRITING_SETTINGS')) {
$url .= $default_shop->getBaseURI() . 'index.php?' . http_build_query($params);
} else {
// Catch url with subdomain "www"
if (strpos($url, 'www.') === 0 && 'www.' . $_SERVER['HTTP_HOST'] === $url || $_SERVER['HTTP_HOST'] === 'www.' . $url) {
$url .= $_SERVER['REQUEST_URI'];
} else {
$url .= $default_shop->getBaseURI();
}
if (count($params)) {
$url .= '?' . http_build_query($params);
}
}
$redirect_type = Configuration::get('PS_CANONICAL_REDIRECT');
$redirect_code = ($redirect_type == 1 ? '302' : '301');
$redirect_header = ($redirect_type == 1 ? 'Found' : 'Moved Permanently');
header('HTTP/1.0 ' . $redirect_code . ' ' . $redirect_header);
header('Location: ' . Tools::getShopProtocol() . $url);
exit;
} elseif (defined('_PS_ADMIN_DIR_') && empty($shop->physical_uri)) {
$shop_default = new Shop((int) Configuration::get('PS_SHOP_DEFAULT'));
$shop->physical_uri = $shop_default->physical_uri;
$shop->virtual_uri = $shop_default->virtual_uri;
}
}
self::$context_id_shop = $shop->id;
self::$context_id_shop_group = $shop->id_shop_group;
self::$context = self::CONTEXT_SHOP;
return $shop;
}
/**
* @return Address the current shop address
*/
public function getAddress()
{
if (!isset($this->address)) {
$address = new Address();
$address->company = Configuration::get('PS_SHOP_NAME');
$address->id_country = Configuration::get('PS_SHOP_COUNTRY_ID') ? Configuration::get('PS_SHOP_COUNTRY_ID') : Configuration::get('PS_COUNTRY_DEFAULT');
$address->id_state = Configuration::get('PS_SHOP_STATE_ID');
$address->address1 = Configuration::get('PS_SHOP_ADDR1');
$address->address2 = Configuration::get('PS_SHOP_ADDR2');
$address->postcode = Configuration::get('PS_SHOP_CODE');
$address->city = Configuration::get('PS_SHOP_CITY');
$this->address = $address;
}
return $this->address;
}
/**
* Set shop theme details from Json data.
*/
public function setTheme()
{
$context = Context::getContext();
$db = Db::getInstance();
$themeRepository = (new PrestaShop\PrestaShop\Core\Addon\Theme\ThemeManagerBuilder($context, $db))->buildRepository($this);
if (empty($this->theme_name)) {
$this->theme_name = 'classic';
}
$this->theme = $themeRepository->getInstanceByName($this->theme_name);
}
/**
* Get theme directory name.
*
* @return string $this->theme->theme_name
*/
public function getTheme()
{
Tools::displayAsDeprecated('Please use $this->theme->getDirectory() instead');
return $this->theme->getDirectory();
}
/**
* Get shop URI.
*
* @return string
*/
public function getBaseURI()
{
return $this->physical_uri . $this->virtual_uri;
}
/**
* Get shop URL.
*
* @param string $auto_secure_mode if set to true, secure mode will be checked
* @param string $add_base_uri if set to true, shop base uri will be added
*
* @return string complete base url of current shop
*/
public function getBaseURL($auto_secure_mode = false, $add_base_uri = true)
{
if (($auto_secure_mode && Tools::usingSecureMode() && !$this->domain_ssl) || !$this->domain) {
return false;
}
$url = array();
$url['protocol'] = $auto_secure_mode && Tools::usingSecureMode() ? 'https://' : 'http://';
$url['domain'] = $auto_secure_mode && Tools::usingSecureMode() ? $this->domain_ssl : $this->domain;
if ($add_base_uri) {
$url['base_uri'] = $this->getBaseURI();
}
return implode('', $url);
}
/**
* Get group of current shop.
*
* @return ShopGroup
*/
public function getGroup()
{
if (!$this->group) {
$this->group = new ShopGroup($this->id_shop_group);
}
return $this->group;
}
/**
* Get root category of current shop.
*
* @return int
*/
public function getCategory()
{
return (int) ($this->id_category ? $this->id_category : Configuration::get('PS_ROOT_CATEGORY'));
}
/**
* Get list of shop's urls.
*
* @return array
*/
public function getUrls()
{
$sql = 'SELECT *
FROM ' . _DB_PREFIX_ . 'shop_url
WHERE active = 1
AND id_shop = ' . (int) $this->id;
return Db::getInstance()->executeS($sql);
}
/**
* Check if current shop ID is the same as default shop in configuration.
*
* @return bool
*/
public function isDefaultShop()
{
return $this->id == Configuration::get('PS_SHOP_DEFAULT');
}
/**
* Get the associated table if available.
*
* @return array
*/
public static function getAssoTable($table)
{
if (!Shop::$initialized) {
Shop::init();
}
return isset(Shop::$asso_tables[$table]) ? Shop::$asso_tables[$table] : false;
}
/**
* check if the table has an id_shop_default.
*
* @return bool
*/
public static function checkIdShopDefault($table)
{
if (!Shop::$initialized) {
Shop::init();
}
return in_array($table, self::'id_shop'_shop_default_tables);
}
/**
* Get list of associated tables to shop.
*
* @return array
*/
public static function getAssoTables()
{
if (!Shop::$initialized) {
Shop::init();
}
return Shop::$asso_tables;
}
/**
* Add table associated to shop.
*
* @param string $table_name
* @param array $table_details
*
* @return bool
*/
public static function addTableAssociation($table_name, $table_details)
{
if (!isset(Shop::$asso_tables[$table_name])) {
Shop::$asso_tables[$table_name] = $table_details;
} else {
return false;
}
return true;
}
/**
* Check if given table is associated to shop.
*
* @param string $table
*
* @return bool
*/
public static function isTableAssociated($table)
{
if (!Shop::$initialized) {
Shop::init();
}
return isset(Shop::$asso_tables[$table]) && Shop::$asso_tables[$table]['type'] == 'shop';
}
/**
* Load list of groups and shops, and cache it.
*
* @param bool $refresh
*/
public static function cacheShops($refresh = false)
{
if (null !== self::$shops && !$refresh) {
return;
}
self::$shops = array();
$from = '';
$where = '';
$employee = Context::getContext()->employee;
// If the profile isn't a superAdmin
if (Validate::isLoadedObject($employee) && $employee->id_profile != _PS_ADMIN_PROFILE_) {
$from .= 'LEFT JOIN ' . _DB_PREFIX_ . 'employee_shop es ON es.id_shop = s.id_shop';
$where .= 'AND es.id_employee = ' . (int) $employee->id;
}
$sql = 'SELECT gs.*, s.*, gs.name AS group_name, s.name AS shop_name, s.active, su.domain, su.domain_ssl, su.physical_uri, su.virtual_uri
FROM ' . _DB_PREFIX_ . 'shop_group gs
LEFT JOIN ' . _DB_PREFIX_ . 'shop s
ON s.id_shop_group = gs.id_shop_group
LEFT JOIN ' . _DB_PREFIX_ . 'shop_url su
ON s.id_shop = su.id_shop AND su.main = 1
' . $from . '
WHERE s.deleted = 0
AND gs.deleted = 0
' . $where . '
ORDER BY gs.name, s.name';
if ($results = Db::getInstance()->executeS($sql)) {
foreach ($results as $row) {
if (!isset(self::$shops[$row['id_shop_group']])) {
self::$shops[$row['id_shop_group']] = array(
'id' => $row['id_shop_group'],
'name' => $row['group_name'],
'share_customer' => $row['share_customer'],
'share_order' => $row['share_order'],
'share_stock' => $row['share_stock'],
'shops' => array(),
);
}
$row = $row + array('theme_name' => '');
self::$shops[$row['id_shop_group']]['shops'][$row['id_shop']] = array(
'id_shop' => $row['id_shop'],
'id_shop_group' => $row['id_shop_group'],
'name' => $row['shop_name'],
'id_category' => $row['id_category'],
'theme_name' => $row['theme_name'],
'domain' => $row['domain'],
'domain_ssl' => $row['domain_ssl'],
'uri' => $row['physical_uri'] . $row['virtual_uri'],
'active' => $row['active'],
);
}
}
}
public static function getCompleteListOfShopsID()
{
$cache_id = 'Shop::getCompleteListOfShopsID';
if (!Cache::isStored($cache_id)) {
$list = array();
$sql = 'SELECT id_shop FROM ' . _DB_PREFIX_ . 'shop';
foreach (Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($sql) as $row) {
$list[] = $row['id_shop'];
}
Cache::store($cache_id, $list);
return $list;
}
return Cache::retrieve($cache_id);
}
/**
* Get shops list.
*
* @param bool $active
* @param int 'id_shop'_shop_group
* @param bool $get_as_list_id
*
* @return array
*/
public static function getShops($active = true, 'id_shop'_shop_group = null, $get_as_list_id = false)
{
Shop::cacheShops();
$results = array();
foreach (self::$shops as $group_id => $group_data) {
foreach ($group_data['shops'] as 'id_shop' => $shop_data) {
if ((!$active || $shop_data['active']) && (!'id_shop'_shop_group || 'id_shop'_shop_group == $group_id)) {
if ($get_as_list_id) {
$results['id_shop'] = 'id_shop';
} else {
$results['id_shop'] = $shop_data;
}
}
}
}
return $results;
}
public function getUrlsSharedCart()
{
if (!$this->getGroup()->share_order) {
return false;
}
$query = new DbQuery();
$query->select('domain');
$query->from('shop_url');
$query->where('main = 1');
$query->where('active = 1');
$query .= $this->addSqlRestriction(Shop::SHARE_ORDER);
$domains = array();
foreach (Db::getInstance()->executeS($query) as $row) {
$domains[] = $row['domain'];
}
return $domains;
}
/**
* Get a collection of shops.
*
* @param bool $active
* @param int 'id_shop'_shop_group
*
* @return PrestaShopCollection Collection of Shop
*/
public static function getShopsCollection($active = true, 'id_shop'_shop_group = null)
{
$shops = new PrestaShopCollection('Shop');
if ($active) {
$shops->where('active', '=', 1);
}
if ('id_shop'_shop_group) {
$shops->where('id_shop_group', '=', (int) 'id_shop'_shop_group);
}
return $shops;
}
/**
* Return some informations cached for one shop.
*
* @param int $shop_id
*
* @return array
*/
public static function getShop($shop_id)
{
Shop::cacheShops();
foreach (self::$shops as $group_id => $group_data) {
if (array_key_exists($shop_id, $group_data['shops'])) {
return $group_data['shops'][$shop_id];
}
}
return false;
}
/**
* Return a shop ID from shop name.
*
* @param string $name
*
* @return int
*/
public static function getIdByName($name)
{
Shop::cacheShops();
foreach (self::$shops as $group_data) {
foreach ($group_data['shops'] as $shop_id => $shop_data) {
if (Tools::strtolower($shop_data['name']) == Tools::strtolower($name)) {
return $shop_id;
}
}
}
return false;
}
/**
* @param bool $active
* @param int 'id_shop'_shop_group
*
* @return int Total of shops
*/
public static function getTotalShops($active = true, 'id_shop'_shop_group = null)
{
return count(Shop::getShops($active, 'id_shop'_shop_group));
}
/**
* Retrieve group ID of a shop.
*
* @param int $shop_id Shop ID
*
* @return int Group ID
*/
public static function getGroupFromShop($shop_id, $as_id = true)
{
Shop::cacheShops();
foreach (self::$shops as $group_id => $group_data) {
if (array_key_exists($shop_id, $group_data['shops'])) {
return ($as_id) ? $group_id : $group_data;
}
}
return false;
}
/**
* If the shop group has the option $type activated, get all shops ID of this group, else get current shop ID.
*
* @param int $shop_id
* @param int $type Shop::SHARE_CUSTOMER | Shop::SHARE_ORDER
*
* @return array
*/
public static function getSharedShops($shop_id, $type)
{
if (!in_array($type, array(Shop::SHARE_CUSTOMER, Shop::SHARE_ORDER, SHOP::SHARE_STOCK))) {
die('Wrong argument ($type) in Shop::getSharedShops() method');
}
Shop::cacheShops();
foreach (self::$shops as $group_data) {
if (array_key_exists($shop_id, $group_data['shops']) && $group_data[$type]) {
return array_keys($group_data['shops']);
}
}
return array($shop_id);
}
/**
* Get a list of ID concerned by the shop context (E.g. if context is shop group, get list of children shop ID).
*
* @param string $share If false, dont check share datas from group. Else can take a Shop::SHARE_* constant value
*
* @return array
*/
public static function getContextListShopID($share = false)
{
if (Shop::getContext() == Shop::CONTEXT_SHOP) {
$list = ($share) ? Shop::getSharedShops(Shop::getContextShopID(), $share) : array(Shop::getContextShopID());
} elseif (Shop::getContext() == Shop::CONTEXT_GROUP) {
$list = Shop::getShops(true, Shop::getContextShopGroupID(), true);
} else {
$list = Shop::getShops(true, null, true);
}
return $list;
}
/**
* Return the list of shop by id.
*
* @param int 'id_shop'
* @param string 'id_shop'entifier
* @param string $table
*
* @return array
*/
public static function getShopById('id_shop', 'id_shop'entifier, $table)
{
return Db::getInstance()->executeS(
'SELECT `id_shop`, `' . bqSQL('id_shop'entifier) . '`
FROM `' . _DB_PREFIX_ . bqSQL($table) . '_shop`
WHERE `' . bqSQL('id_shop'entifier) . '` = ' . (int) 'id_shop'
);
}
/**
* Change the current shop context.
*
* @param int $type Shop::CONTEXT_ALL | Shop::CONTEXT_GROUP | Shop::CONTEXT_SHOP
* @param int 'id_shop' ID shop if CONTEXT_SHOP or id shop group if CONTEXT_GROUP
*/
public static function setContext($type, 'id_shop' = null)
{
switch ($type) {
case self::CONTEXT_ALL:
self::$context_id_shop = null;
self::$context_id_shop_group = null;
break;
case self::CONTEXT_GROUP:
self::$context_id_shop = null;
self::$context_id_shop_group = (int) 'id_shop';
break;
case self::CONTEXT_SHOP:
self::$context_id_shop = (int) 'id_shop';
self::$context_id_shop_group = Shop::getGroupFromShop('id_shop');
break;
default:
throw new PrestaShopException('Unknown context for shop');
}
self::$context = $type;
}
/**
* Get current context of shop.
*
* @return int
*/
public static function getContext()
{
return self::$context;
}
/**
* Reset current context of shop.
*/
public static function resetContext()
{
self::$context = null;
}
/**
* @return int
*/
public function getContextType()
{
return self::getContext();
}
/**
* Get current ID of shop if context is CONTEXT_SHOP.
*
* @return int
*/
public static function getContextShopID($null_value_without_multishop = false)
{
if ($null_value_without_multishop && !Shop::isFeatureActive()) {
return null;
}
return self::$context_id_shop;
}
/**
* @return int
*/
public function getContextualShopId()
{
if ($this->getContextType() !== self::CONTEXT_SHOP) {
throw new LogicException('The retrieval of the contextual shop id is only possible in "single shop mode);
}
return (int) self::$context_id_shop;
}
/**
* Get current ID of shop group if context is CONTEXT_SHOP or CONTEXT_GROUP.
*
* @return int
*/
public static function getContextShopGroupID($null_value_without_multishop = false)
{
if ($null_value_without_multishop && !Shop::isFeatureActive()) {
return null;
}
return self::$context_id_shop_group;
}
public static function getContextShopGroup()
{
static $context_shop_group = null;
if ($context_shop_group === null) {
$context_shop_group = new ShopGroup((int) self::$context_id_shop_group);
}
return $context_shop_group;
}
/**
* Add an sql restriction for shops fields.
*
* @param int $share If false, dont check share datas from group. Else can take a Shop::SHARE_* constant value
* @param string $alias
*/
public static function addSqlRestriction($share = false, $alias = null)
{
if ($alias) {
$alias .= ;
}
if (is_string($alias)) {
$alias = Db::getInstance()->escape($alias);
}
$group = Shop::getGroupFromShop(Shop::getContextShopID(), false);
if ($share == Shop::SHARE_CUSTOMER && Shop::getContext() == Shop::CONTEXT_SHOP && $group['share_customer']) {
$restriction = ' AND ' . $alias . 'id_shop_group = ' . (int) Shop::getContextShopGroupID() . ' ';
} else {
$restriction = ' AND ' . $alias . 'id_shop IN (' . implode(', ', Shop::getContextListShopID($share)) . ') ';
}
return $restriction;
}
/**
* Add an SQL JOIN in query between a table and its associated table in multishop.
*
* @param string $table Table name (E.g. product, module, etc.)
* @param string $alias Alias of table
* @param bool $inner_join Use or not INNER JOIN
* @param string $on
*
* @return string
*/
public static function addSqlAssociation($table, $alias, $inner_join = true, $on = null, $force_not_default = false)
{
$table_alias = $table . '_shop';
if (strpos($table, ) !== false) {
list($table_alias, $table) = explode(, $table);
}
$asso_table = Shop::getAssoTable($table);
if ($asso_table === false || $asso_table['type'] != 'shop') {
return;
}
$sql = (($inner_join) ? ' INNER' : ' LEFT') . ' JOIN ' . _DB_PREFIX_ . $table . '_shop ' . $table_alias . '
ON (' . $table_alias . '.id_' . $table . ' = ' . $alias . '.id_' . $table;
if ((int) self::$context_id_shop) {
$sql .= ' AND ' . $table_alias . '.id_shop = ' . (int) self::$context_id_shop;
} elseif (Shop::checkIdShopDefault($table) && !$force_not_default) {
$sql .= ' AND ' . $table_alias . '.id_shop = ' . $alias . '.id_shop_default';
} else {
$sql .= ' AND ' . $table_alias . '.id_shop IN (' . implode(', ', Shop::getContextListShopID()) . ')';
}
$sql .= (($on) ? ' AND ' . $on : '') . ')';
return $sql;
}
/**
* Add a restriction on id_shop for multishop lang table.
*
* @param string $alias
* @param Context $context
*
* @return string
*/
public static function addSqlRestrictionOnLang($alias = null, 'id_shop'_shop = null)
{
if (isset(Context::getContext()->shop) && null === 'id_shop'_shop) {
'id_shop'_shop = (int) Context::getContext()->shop->id;
}
if (!'id_shop'_shop) {
'id_shop'_shop = (int) Configuration::get('PS_SHOP_DEFAULT');
}
return ' AND ' . (($alias) ? Db::getInstance()->escape($alias) . : '') . 'id_shop = id_shop'_shop . ' ';
}
/**
* Get all groups and associated shops as subarrays.
*
* @return array
*/
public static function getTree()
{
Shop::cacheShops();
return self::$shops;
}
/**
* @return bool Return true if multishop feature is active and at last 2 shops have been created
*/
public static function isFeatureActive()
{
static $feature_active = null;
if ($feature_active === null) {
$feature_active = (bool) Db::getInstance()->getValue('SELECT value FROM `' . _DB_PREFIX_ . 'configuration` WHERE `name` = "PS_MULTISHOP_FEATURE_ACTIVE"')
&& (Db::getInstance()->getValue('SELECT COUNT(*) FROM ' . _DB_PREFIX_ . 'shop') > 1);
}
return $feature_active;
}
public function copyShopData($old_id, $tables_import = false, $deleted = false)
{
// If we duplicate some specific data, automatically duplicate other data linked to the first
// E.g. if carriers are duplicated for the shop, duplicate carriers langs too
if (!$old_id) {
$old_id = Configuration::get('PS_SHOP_DEFAULT');
}
if (isset($tables_import['carrier'])) {
$tables_import['carrier_tax_rules_group_shop'] = true;
$tables_import['carrier_lang'] = true;
}
if (isset($tables_import['cms'])) {
$tables_import['cms_lang'] = true;
$tables_import['cms_category'] = true;
$tables_import['cms_category_lang'] = true;
}
$tables_import['category_lang'] = true;
if (isset($tables_import['product'])) {
$tables_import['product_lang'] = true;
}
if (isset($tables_import['module'])) {
$tables_import['module_currency'] = true;
$tables_import['module_country'] = true;
$tables_import['module_group'] = true;
}
if (isset($tables_import['hook_module'])) {
$tables_import['hook_module_exceptions'] = true;
}
if (isset($tables_import['attribute_group'])) {
$tables_import['attribute'] = true;
}
// Browse and duplicate data
foreach (Shop::getAssoTables() as $table_name => $row) {
if ($tables_import && !isset($tables_import[$table_name])) {
continue;
}
// Special case for stock_available if current shop is in a share stock group
if ($table_name == 'stock_available') {
$group = new ShopGroup($this->id_shop_group);
if ($group->share_stock && $group->haveShops()) {
continue;
}
}
'id_shop' = 'id_' . $row['type'];
if ($row['type'] == 'fk_shop') {
} else {
$table_name .= '_' . $row['type'];
}
if (!$deleted) {
$res = Db::getInstance()->getRow('SELECT * FROM `' . _DB_PREFIX_ . $table_name . '` WHERE `id_shop` = ' . (int) $old_id);
if ($res) {
unset($res['id_shop']);
if (isset($row['primary'])) {
unset($res[$row['primary']]);
}
$categories = Tools::getValue('categoryBox');
if ($table_name == 'product_shop' && count($categories) == 1) {
unset($res['id_category_default']);
$keys = implode('`, `', array_keys($res));
$sql = 'INSERT IGNORE INTO `' . _DB_PREFIX_ . $table_name . '` (`' . $keys . '`, `id_category_default`, id_shop)
(SELECT `' . $keys . '`, ' . (int) $categories[0] . ', ' . (int) $this->id . ' FROM ' . _DB_PREFIX_ . $table_name . '
WHERE `id_shop` = ' . (int) $old_id . ')';
} else {
$keys = implode('`, `', array_keys($res));
$sql = 'INSERT IGNORE INTO `' . _DB_PREFIX_ . $table_name . '` (`' . $keys . '`, id_shop)
(SELECT `' . $keys . '`, ' . (int) $this->id . ' FROM ' . _DB_PREFIX_ . $table_name . '
WHERE `id_shop` = ' . (int) $old_id . ')';
}
Db::getInstance()->execute($sql);
}
}
}
// Hook for duplication of shop data
$modules_list = Hook::getHookModuleExecList('actionShopDataDuplication');
if (is_array($modules_list) && count($modules_list) > 0) {
foreach ($modules_list as $m) {
if (!$tables_import || isset($tables_import['Module' . ucfirst($m['module'])])) {
Hook::exec('actionShopDataDuplication', array(
'old_id_shop' => (int) $old_id,
'new_id_shop' => (int) $this->id,
), $m['id_module']);
}
}
}
}
/**
* @param int 'id_shop'
*
* @return array
*/
public static function getCategories('id_shop' = 0, $only_id = true)
{
// build query
$query = new DbQuery();
if ($only_id) {
$query->select('cs.`id_category`');
} else {
$query->select('DISTINCT cs.`id_category`, cl.`name`, cl.`link_rewrite`');
}
$query->from('category_shop', 'cs');
$query->leftJoin('category_lang', 'cl', 'cl.`id_category` = cs.`id_category` AND cl.`id_lang` = ' . (int) Context::getContext()->language->id);
$query->where('cs.`id_shop` = ' . (int) 'id_shop');
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($query);
if ($only_id) {
$array = array();
foreach ($result as $row) {
$array[] = $row['id_category'];
}
$array = array_unique($array);
} else {
return $result;
}
return $array;
}
/**
* @param string $entity
* @param int 'id_shop'_shop
*
* @return array|bool
*/
public static function getEntityIds($entity, 'id_shop'_shop, $active = false, $delete = false)
{
if (!Shop::isTableAssociated($entity)) {
return false;
}
return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS(
'SELECT entity.`id_' . bqSQL($entity) . '`
FROM `' . _DB_PREFIX_ . bqSQL($entity) . '_shop`es
LEFT JOIN ' . _DB_PREFIX_ . bqSQL($entity) . ' entity
ON (entity.`id_' . bqSQL($entity) . '` = es.`id_' . bqSQL($entity) . '`)
WHERE es.`id_shop` = ' . (int) 'id_shop'_shop .
($active ? ' AND entity.`active` = 1' : '') .
($delete ? ' AND entity.deleted = 0' : '')
);
}
}
© 2023 Quttera Ltd. All rights reserved.