Files
PrestaShop/classes/Shop.php
2011-07-19 09:23:10 +00:00

737 lines
19 KiB
PHP

<?php
/*
* 2007-2011 PrestaShop
*
* 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:
* http://opensource.org/licenses/osl-3.0.php
* 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 http://www.prestashop.com for more information.
*
* @author PrestaShop SA <contact@prestashop.com>
* @copyright 2007-2011 PrestaShop SA
* @version Release: $Revision: 7521 $
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
* International Registered Trademark & Property of PrestaShop SA
*/
/**
* @since 1.5.0
*/
class ShopCore extends ObjectModel
{
public $id_group_shop;
public $id_theme;
public $name;
public $active;
public $id_category;
public $deleted;
protected $base_uri;
protected $theme_name;
/**
* @var GroupShop
*/
protected $group;
protected $fieldsSize = array('name' => 64);
protected $fieldsValidate = array(
'active' => 'isBool',
'name' => 'isGenericName',
);
protected $table = 'shop';
protected $identifier = 'id_shop';
/** @var array List of shops cached */
protected static $shops = array();
private static $assoTables = array(
'carrier' => array('type' => 'shop'),
'category_lang' => array('type' => 'fk_shop'),
'cms' => array('type' => 'shop'),
'contact' => array('type' => 'shop'),
'country' => array('type' => 'shop'),
'currency' => 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'),
'stock' => array('type' => 'fk_shop', 'primary' => 'id_stock'),
'product' => array('type' => 'shop'),
'product_lang' => array('type' => 'fk_shop'),
'referrer' => array('type' => 'shop'),
'store' => array('type' => 'shop'),
'webservice_account' => array('type' => 'shop'),
);
protected $webserviceParameters = array(
'fields' => array(
'id_group_shop' => array('xlink_resource' => 'shop_groups'),
'id_category' => array(),
'id_theme' => array(),
),
);
/**
* There are 3 kinds of shop context : shop, group shop and general
*/
const CONTEXT_SHOP = 1;
const CONTEXT_GROUP = 2;
const CONTEXT_ALL = 3;
public function getFields()
{
parent::validateFields();
$fields['id_group_shop'] = (int)$this->id_group_shop;
$fields['id_category'] = (int)$this->id_category;
$fields['id_theme'] = (int)$this->id_theme;
$fields['name'] = pSQL($this->name);
$fields['active'] = (int)$this->active;
$fields['deleted'] = (int)$this->deleted;
return $fields;
}
public function add($autodate = true, $nullValues = false)
{
$res = parent::add();
Shop::cacheShops(true);
return $res;
}
public function delete()
{
if (!$res = parent::delete())
return false;
foreach (Shop::getAssoTables() AS $table_name => $row)
{
// Special case for stock if current shop is in a share stock group
if ($table_name == 'stock')
{
$group = new GroupShop($this->id_group_shop);
if ($group->share_stock && $group->getNbShops() > 1)
continue;
}
$id = 'id_'.$row['type'];
if ($row['type'] == 'fk_shop')
$id = 'id_shop';
else
$table_name .= '_'.$row['type'];
$res &= Db::getInstance()->Execute('DELETE FROM `'._DB_PREFIX_.$table_name.'` WHERE `'.$id.'`='.(int)$this->id);
}
Shop::cacheShops(true);
return $res;
}
/**
* Get a new instance of a shop
*
* @param int $id shop ID
* @return Shop
*/
public static function getInstance($id)
{
return new Shop($id);
}
/**
* Find the shop from current domain / uri and get an instance of this shop
*
* @return Shop
*/
public static function initialize()
{
// Get list of excluded uri
$dirname = dirname(__FILE__);
$directories = scandir($dirname.'/../');
$excluded_uris = array();
foreach ($directories AS $directory)
if (is_dir($dirname.'/../'.$directory) AND (!preg_match ('/^\./', $directory)))
$excluded_uris[] = $directory;
// Parse request_uri
preg_match('/^'.Tools::pRegexp(_PS_DIRECTORY_, '/').'([a-z0-9]+)\/.*$/Ui', $_SERVER['REQUEST_URI'], $res);
$uri = (isset($res[1]) AND !in_array($res[1], $excluded_uris)) ? $res[1] : '';
if (!$id_shop = Tools::getValue('id_shop'))
{
// Find current shop from URL
$db = Db::getInstance();
$sql = 'SELECT s.id_shop
FROM '._DB_PREFIX_.'shop_url su
LEFT JOIN '._DB_PREFIX_.'shop s ON (s.id_shop = su.id_shop)
WHERE su.domain=\''.pSQL(Tools::getHttpHost()).'\'
AND uri=\''.pSQL($uri).'\'
AND s.active = 1
AND s.deleted = 0';
if (!$id_shop = $db->getValue($sql))
$id_shop = Configuration::get('PS_SHOP_DEFAULT');
}
// Get instance of found shop
$shop = new Shop($id_shop);
if (!Validate::isLoadedObject($shop))
die(Tools::displayError());
return $shop;
}
/**
* Load some additional data of current shop (theme name, shop uri)
*
* @return bool
*/
protected function loadShopInfos()
{
$sql = 'SELECT su.uri, t.name
FROM '._DB_PREFIX_.'shop s
LEFT JOIN '._DB_PREFIX_.'shop_url su ON (s.id_shop = su.id_shop)
LEFT JOIN '._DB_PREFIX_.'theme t ON (t.id_theme = s.id_theme)
WHERE s.id_shop = '.$this->id.'
AND s.active = 1
AND s.deleted = 0
AND su.main = 1';
if (!$row = Db::getInstance()->getRow($sql))
return false;
$this->theme_name = $row['name'];
$this->base_uri = ($row['uri']) ? $row['uri'].'/' : '';
return true;
}
/**
* Get shop theme name
*
* @return string
*/
public function getTheme()
{
if (!$this->theme_name)
$this->loadShopInfos();
return $this->theme_name;
}
/**
*
* Get shop URI
*
* @param bool $with_base
* @return string
*/
public function getBaseURI($with_base = true)
{
if (!$this->theme_name)
$this->loadShopInfos();
return ($with_base ? _PS_DIRECTORY_ : '').$this->base_uri;
}
/**
* Get group of current shop
*
* @return GroupShop
*/
public function getGroup($asObject = false)
{
if (!$this->group)
$this->group = new GroupShop($this->getGroupID());
return $this->group;
}
/**
* Get current shop ID
*
* @return int
*/
public function getID($useDefault = false)
{
return (!$this->id && $useDefault) ? (int)Configuration::get('PS_SHOP_DEFAULT') : (int)$this->id;
}
/**
* Get current shop group ID
*
* @return int
*/
public function getGroupID()
{
if (defined('PS_ADMIN_DIR'))
return Shop::getContextGroupID();
return (int)$this->id_group_shop;
}
/**
* Get root category of current shop
*
* @return int
*/
public function getCategory()
{
return ($this->id_category) ? $this->id_category : 1;
}
/**
* 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 list of associated tables to shop
*
* @return array
*/
public static function getAssoTables()
{
return self::$assoTables;
}
/**
* Load list of groups and shops, and cache it
*
* @param bool $refresh
*/
public static function cacheShops($refresh = false)
{
if (self::$shops && !$refresh)
return;
$sql = 'SELECT gs.id_group_shop, gs.name AS group_name, gs.share_datas, gs.share_stock, s.id_shop, s.name AS shop_name, s.id_theme, s.id_category, s.active
FROM '._DB_PREFIX_.'group_shop gs
LEFT JOIN '._DB_PREFIX_.'shop s
ON (s.id_group_shop = gs.id_group_shop)
WHERE s.deleted = 0
AND gs.deleted = 0
ORDER BY gs.name, s.name';
if ($results = Db::getInstance()->ExecuteS($sql))
{
foreach ($results as $row)
{
if (!isset(self::$shops[$row['id_group_shop']]))
self::$shops[$row['id_group_shop']] = array(
'id' => $row['id_group_shop'],
'name' => $row['group_name'],
'share_datas' => $row['share_datas'],
'share_stock' => $row['share_stock'],
'shops' => array(),
);
self::$shops[$row['id_group_shop']]['shops'][$row['id_shop']] = array(
'id_shop' => $row['id_shop'],
'id_group_shop' => $row['id_group_shop'],
'name' => $row['shop_name'],
'id_theme' => $row['id_theme'],
'id_category' => $row['id_category'],
'active' => $row['active'],
);
}
}
}
/**
* Get shops list
*
* @param bool $active
* @param int $id_group_shop
* @param bool $getAsListID
*/
public static function getShops($active = true, $id_group_shop = null, $getAsListID = false)
{
Shop::cacheShops();
$results = array();
foreach (self::$shops as $groupID => $groupData)
foreach ($groupData['shops'] as $id => $shopData)
if ((!$active || $shopData['active']) && (!$id_group_shop || $id_group_shop == $groupID))
{
if ($getAsListID)
$results[] = $id;
else
$results[] = $shopData;
}
return $results;
}
/**
* Return a shop ID from shop name
*
* @param string $name
* @return int
*/
public static function getIdByName($name)
{
Shop::cacheShops();
foreach (self::$shops as $groupData)
foreach ($groupData['shops'] as $shopID => $shopData)
if (Tools::strtolower($shopData['name']) == Tools::strtolower($name))
return $shopID;
return false;
}
/**
* @return int Total of shops
*/
public static function getTotalShops($active = true)
{
return count(Shop::getShops($active));
}
/**
* Retrieve group ID of a shop
*
* @param int $shopID Shop ID
* @return int Group ID
*/
public static function getGroupFromShop($shopID, $asID = true)
{
Shop::cacheShops();
foreach (self::$shops as $groupID => $groupData)
if (array_key_exists($shopID, $groupData['shops']))
return ($asID) ? $groupID : $groupData;
return false;
}
/**
* If the shop group has the option "share_datas" activated, get all shops ID of this group, else get current shop ID
*
* @param int $shopID
* @return array
*/
public static function getSharedShops($shopID)
{
Shop::cacheShops();
foreach (self::$shops as $groupData)
if (array_key_exists($shopID, $groupData['shops']) && $groupData['share_datas'])
return array_keys($groupData['shops']);
return array($shopID);
}
/**
* Get a list of ID concerned by the shop context (E.g. if context is shop group, get list of children shop ID)
*
* @param int $shopID
* @param int $shopGroupID
* @param bool $share If true and if $shopID is set, list shops with share data too
* @return array
*/
public static function getListOfID(Context $context, $share = false)
{
$shopID = $context->shop->getID();
$shopGroupID = $context->shop->getGroupID();
if ($shopID)
$list = (!$share) ? array($shopID) : Shop::getSharedShops($shopID);
else if ($shopGroupID)
$list = Shop::getShops(true, $shopGroupID, true);
else
$list = Shop::getShops(true, null, true);
return $list;
}
/**
* Retrieve the current shop context in FO or BO
*
* @param string null|shop|group
* @return array(id_shop, id_group_shop)|int
*/
public static function getContext($type = null)
{
static $executed = false, $shopID = 0, $shopGroupID = 0;
if (!$executed)
{
$context = Context::getContext();
if (defined('PS_ADMIN_DIR'))
{
// While cookie is not instancied in admin, we wait ...
if (!isset($context->cookie))
return ($type == 'shop' || $type == 'group') ? '' : array('', '');
// Parse shopContext cookie value (E.g. s-2, g-4)
$split = explode('-', Context::getContext()->cookie->shopContext);
if (count($split) == 2)
{
if ($split[0] == 's')
$shopID = (int)$split[1];
else if ($split[0] == 'g')
$shopGroupID = (int)$split[1];
if ($shopID && !$shopGroupID)
$shopGroupID = Shop::getGroupFromShop($shopID);
}
}
else
{
$shopID = (int)$context->shop->id_shop;
$shopGroupID = (int)$context->shop->id_group_shop;
}
$executed = true;
}
if ($type == 'shop')
return $shopID;
else if ($type == 'group')
return $shopGroupID;
return array($shopID, $shopGroupID);
}
/**
* Get ID shop from context
*
* @return int
*/
public static function getContextID()
{
return Shop::getContext('shop');
}
/**
* Get ID shop from context
*
* @return int
*/
public static function getContextGroupID()
{
return Shop::getContext('group');
}
/**
* Get a list of ID concerned by the shop context (E.g. if context is shop group, get list of children shop ID)
*
* @return array
*/
public static function getListFromContext()
{
return Shop::getListOfID(Context::getContext());
}
/**
* Check in which type of shop context we are
*
* @return int
*/
public function getContextType()
{
list($shopID, $shopGroupID) = Shop::getContext();
if ($shopID)
return Shop::CONTEXT_SHOP;
else if ($shopGroupID)
return Shop::CONTEXT_GROUP;
return Shop::CONTEXT_ALL;
}
public static function sqlRestriction($share = false, $alias = null, Context $context = null, $type = 'shop')
{
if ($type != 'shop' && $type != 'group_shop')
$type = 'shop';
if ($alias)
$alias .= '.';
$restriction = '';
if (!$context)
$context = Context::getContext();
$shopID = $context->shop->getID();
$shopGroupID = $context->shop->getGroupID();
if ($type == 'group_shop')
{
if ($shopID)
$restriction = ' AND '.$alias.'id_group_shop = '.Shop::getGroupFromShop($shopID);
else if ($shopGroupID)
$restriction = ' AND '.$alias.'id_group_shop = '.$shopGroupID;
}
else
{
if ($shopID || $shopGroupID)
$restriction = ' AND '.$alias.'id_shop IN ('.implode(', ', Shop::getListOfID($context, $share)).')';
}
return $restriction;
}
public static function sqlSharedStock($alias = null, Context $context = null)
{
if ($alias)
$alias .= '.';
if (!$context)
$context = Context::getContext();
$shopID = $context->shop->getID();
$shopGroupID = $context->shop->getGroupID();
if (!$shopID)
return ($shopGroupID) ? ' AND '.$alias.'id_group_shop = '.(int)$shopGroupID : '';
Shop::cacheShops();
foreach (self::$shops as $groupID => $groupData)
if (array_key_exists($shopID, $groupData['shops']) && $groupData['share_stock'])
return ' AND '.$alias.'id_group_shop = '.$groupID;
return ' AND '.$alias.'id_shop = '.$shopID;
}
/**
* 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 $innerJoin Use or not INNER JOIN
* @param Context $context
* @return string
*/
public static function sqlAsso($table, $alias, $innerJoin = false, Context $context = null)
{
if (!$context)
$context = Context::getContext();
$tableAlias = ' asso_shop_'.$table;
if (strpos($table, '.') !== false)
list($tableAlias, $table) = explode('.', $table);
$assoTables = Shop::getAssoTables();
if (!isset($assoTables[$table]) || $assoTables[$table]['type'] != 'shop')
return ;
$sql = (($innerJoin) ? ' INNER' : ' LEFT').' JOIN '._DB_PREFIX_.$table.'_shop '.$tableAlias.'
ON '.$tableAlias.'.id_'.$table.' = '.$alias.'.id_'.$table.'
AND '.$tableAlias.'.id_shop IN('.implode(', ', Shop::getListFromContext($context)).') ';
return $sql;
}
/**
* Add a restriction on id_shop for multishop lang table
*
* @param string $alias
* @param Context $context
* @return string
*/
public static function sqlLang($alias, Context $context = null)
{
return ' AND '.$alias.'.id_shop = '.$context->shop->getID(true). ' ';
}
/**
* Get all groups and associated shops as subarrays
*
* @return array
*/
public static function getTree()
{
Shop::cacheShops();
return self::$shops;
}
/**
* Generate a sweet HTML list for shop selection
*
* @return string
*/
public static function generateHtmlList()
{
$tree = Shop::getTree();
// Get default value
list($shopID, $shopGroupID) = Shop::getContext();
if ($shopID)
$value = 's-'.$shopID;
else if ($shopGroupID)
$value = 'g-'.$shopGroupID;
else
$value = '';
// Generate HTML
$url = $_SERVER['REQUEST_URI'] . (($_SERVER['QUERY_STRING']) ? '&' : '?') . 'setShopContext=';
$html = '<select class="shopList" onchange="location.href = \''.$url.'\'+$(this).val();">';
$html .= '<option value="" class="first">' . translate('All shops') . '</option>';
foreach ($tree as $gID => $groupData)
{
$html .= '<option class="group" value="g-'.$gID.'" '.(($value == 'g-'.$gID) ? 'selected="selected"' : '').'>'.htmlspecialchars($groupData['name']).'</option>';
foreach ($groupData['shops'] as $sID => $shopData)
if ($shopData['active'])
$html .= '<option value="s-'.$sID.'" class="shop" '.(($value == 's-'.$sID) ? 'selected="selected"' : '').'>&raquo; '.$shopData['name'].'</option>';
}
$html .= '</select>';
return $html;
}
public function copyShopData($old_id, $tables_import = false, $deleted = false)
{
foreach (Shop::getAssoTables() AS $table_name => $row)
{
if ($tables_import && !isset($tables_import[$table_name]))
continue;
// Special case for stock if current shop is in a share stock group
if ($table_name == 'stock')
{
$group = new GroupShop($this->id_group_shop);
if ($group->share_stock && $group->haveShops())
continue;
}
$id = 'id_'.$row['type'];
if ($row['type'] == 'fk_shop')
$id = 'id_shop';
else
$table_name .= '_'.$row['type'];
if (!$deleted)
{
$res = Db::getInstance()->getRow('SELECT * FROM `'._DB_PREFIX_.$table_name.'` WHERE `'.$id.'` = '.(int)$old_id);
if ($res)
{
unset($res[$id]);
if (isset($row['primary']))
unset($res[$row['primary']]);
$keys = implode(', ', array_keys($res));
$sql = 'INSERT INTO `'._DB_PREFIX_.$table_name.'` ('.$keys.', '.$id.')
(SELECT '.$keys.', '.(int)$this->id.' FROM '._DB_PREFIX_.$table_name.'
WHERE `'.$id.'` = '.(int)$old_id.')';
Db::getInstance()->Execute($sql);
}
}
else
{
Db::getInstance()->Execute('UPDATE `'._DB_PREFIX_.$table_name.'` SET WHERE `'.$id.'`='.(int)$old_id);
}
}
}
}