* @copyright 2007-2016 PrestaShop SA
* @license http://opensource.org/licenses/afl-3.0.php Academic Free License (AFL 3.0)
* International Registered Trademark & Property of PrestaShop SA
*/
if (!defined('_PS_VERSION_')) {
exit;
}
class StatsSales extends ModuleGraph
{
private $html = '';
private $query = '';
private $query_group_by = '';
private $query_having_filter = '';
private $option = '';
private $id_country = '';
private $id_hotel = '';
public function __construct()
{
$this->name = 'statssales';
$this->tab = 'analytics_stats';
$this->version = '1.3.4';
$this->author = 'PrestaShop';
$this->need_instance = 0;
parent::__construct();
$this->displayName = $this->l('Sales and orders');
$this->description = $this->l('Adds graphics presenting the evolution of sales and orders to the Stats dashboard.');
$this->ps_versions_compliancy = array('min' => '1.6', 'max' => _PS_VERSION_);
}
public function install()
{
return (parent::install() && $this->registerHook('AdminStatsModules'));
}
public function hookAdminStatsModules()
{
$totals = $this->getTotals();
$currency = new Currency((int)Configuration::get('PS_CURRENCY_DEFAULT'));
if (($id_export = (int)Tools::getValue('export')) == 1) {
$this->csvExport(array(
'layers' => 0,
'type' => 'line',
'option' => '1-'.(int)Tools::getValue('id_country').'-'.(int)Tools::getValue('id_hotel')
));
} elseif ($id_export == 2) {
$this->csvExport(array(
'layers' => 0,
'type' => 'line',
'option' => '2-'.(int)Tools::getValue('id_country').'-'.(int)Tools::getValue('id_hotel')
));
} elseif ($id_export == 3) {
$this->csvExport(array(
'type' => 'pie',
'option' => '3-'.(int)Tools::getValue('id_country').'-'.(int)Tools::getValue('id_hotel')
));
}
$objHotelBranchInformation = new HotelBranchInformation();
$hotelsInfo = $objHotelBranchInformation->getProfileAccessedHotels($this->context->employee->id_profile, 1);
$this->html = '
'.$this->displayName.'
'.$this->l('Guide').'
'.$this->l('About order statuses').'
'.$this->l('In your back office, you can modify the following order statuses: Awaiting check payment, Payment accepted, Processing in progress, Canceled, Refunded, Payment error and Awaiting bank wire payment.').'
'.$this->l('These order statuses cannot be removed from the back office; however you have the option to add more.').'
'
.$this->l('The following graphs represent the evolution of your website\'s orders and sales turnover for a selected period.').'
'
.$this->l('You should often consult this screen, as it allows you to quickly monitor your website\'s sustainability. It also allows you to monitor multiple time periods.').'
'
.$this->l('Only valid orders are graphically represented.')
.'
'.$this->engine(array(
'type' => 'line',
'option' => '1-'.(int)Tools::getValue('id_country').'-'.(int)Tools::getValue('id_hotel'),
)).'
'.$this->engine(array(
'type' => 'line',
'option' => '2-'.(int)Tools::getValue('id_country').'-'.(int)Tools::getValue('id_hotel'),
)).'
'.$this->l('You can view the distribution of order statuses below.').'
'.($totals['orderCount'] ? $this->engine(array(
'type' => 'pie',
'option' => '3-'.(int)Tools::getValue('id_country').'-'.(int)Tools::getValue('id_hotel'),
'format' => 'd'
)) : $this->l('No orders found.')).'
';
return $this->html;
}
private function getTotals()
{
$idHotel = (int)Tools::getValue('id_hotel');
$sql = 'SELECT COUNT(id_order) AS orderCount, IFNULL(ROUND(SUM(total_paid_tax_excl), 2), 0) AS orderSum
FROM `'._DB_PREFIX_.'orders` o
'.((int)Tools::getValue('id_country') ? 'LEFT JOIN `'._DB_PREFIX_.'address` a ON o.`id_address_delivery` = a.`id_address`' : '').'
WHERE o.valid = 1 AND o.`invoice_date` BETWEEN '.ModuleGraph::getDateBetween().'
'.((int)Tools::getValue('id_country') ? ' AND a.`id_country` = '.(int)Tools::getValue('id_country') : '').'
AND (
EXISTS (
SELECT 1
FROM `'._DB_PREFIX_.'htl_booking_detail` hbd
WHERE hbd.`id_order` = o.`id_order`' . HotelBranchInformation::addHotelRestriction($idHotel).'
) OR EXISTS (
SELECT 1
FROM `'._DB_PREFIX_.'service_product_order_detail` spod
WHERE spod.`id_order` = o.`id_order`' . HotelBranchInformation::addHotelRestriction($idHotel, 'spod').'
)'.(!$idHotel ? ' OR EXISTS (
SELECT 1
FROM `'._DB_PREFIX_.'service_product_order_detail` spod
WHERE spod.`id_order` = o.`id_order` AND spod.`id_hotel` = 0 AND spod.`id_htl_booking_detail` = 0
)' : '').'
)';
return Db::getInstance(_PS_USE_SQL_SLAVE_)->getRow($sql);
}
public function setOption($options, $layers = 1)
{
list($this->option, $this->id_country, $this->id_hotel) = explode('-', $options);
switch ($this->option) {
case 1:
if (Tools::getValue('export')) {
$this->_titles['main'][] = $this->l('Date');
}
$this->_titles['main'][] = $this->l('Orders placed');
break;
case 2:
if (Tools::getValue('export')) {
$this->_titles['main'][] = $this->l('Date');
}
$currency = new Currency((int)Configuration::get('PS_CURRENCY_DEFAULT'));
$this->_titles['main'][] = sprintf($this->l('Revenue currency: %s'), $currency->iso_code);
break;
case 3:
if (Tools::getValue('export')) {
$this->_titles['main'][] = $this->l('Payment method');
}
$this->_titles['main'][] = $this->l('Percentage of orders per status.');
break;
}
}
protected function getData($layers)
{
if ($this->option == 3) {
return $this->getOrderStatusesData();
}
if ($this->option == 1) {
$this->_formats['y'] = 'd';
}
$this->query = 'SELECT o.`invoice_date`, ROUND(total_paid_tax_excl) AS total_revenue
FROM `'._DB_PREFIX_.'orders` o
'.((int)$this->id_country ? 'LEFT JOIN `'._DB_PREFIX_.'address` a ON o.`id_address_delivery` = a.`id_address`' : '').'
WHERE o.valid = 1
'.((int)$this->id_country ? ' AND a.`id_country` = '.(int)$this->id_country : '').'
AND (
EXISTS (
SELECT 1
FROM `'._DB_PREFIX_.'htl_booking_detail` hbd
WHERE hbd.`id_order` = o.`id_order`' . HotelBranchInformation::addHotelRestriction($this->id_hotel).'
) OR EXISTS (
SELECT 1
FROM `'._DB_PREFIX_.'service_product_order_detail` spod
WHERE spod.`id_order` = o.`id_order`' . HotelBranchInformation::addHotelRestriction($this->id_hotel, 'spod').'
)'.(!$this->id_hotel ? ' OR EXISTS (
SELECT 1
FROM `'._DB_PREFIX_.'service_product_order_detail` spod
WHERE spod.`id_order` = o.`id_order` AND spod.`id_hotel` = 0 AND spod.`id_htl_booking_detail` = 0
)' : '').'
) AND o.`invoice_date` BETWEEN';
$this->query_group_by = ' GROUP BY o.`id_order`';
$this->setDateGraph($layers, true);
}
protected function setAllTimeValues($layers)
{
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($this->query.$this->getDate().$this->query_group_by.$this->query_having_filter);
foreach ($result as $row) {
if ($this->option == 1) {
$this->_values[(int)substr($row['invoice_date'], 0, 4)] += 1;
} else {
$this->_values[(int)substr($row['invoice_date'], 0, 4)] += $row['total_revenue'];
}
}
}
protected function setYearValues($layers)
{
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($this->query.$this->getDate().$this->query_group_by.$this->query_having_filter);
foreach ($result as $row) {
$mounth = (int)substr($row['invoice_date'], 5, 2);
if (!isset($this->_values[$mounth])) {
$this->_values[$mounth] = 0;
}
if ($this->option == 1) {
$this->_values[$mounth] += 1;
} else {
$this->_values[$mounth] += $row['total_revenue'];
}
}
}
protected function setMonthValues($layers)
{
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($this->query.$this->getDate().$this->query_group_by.$this->query_having_filter);
foreach ($result as $row) {
$days = (int)substr($row['invoice_date'], 8, 2);
if (!isset($this->_values[$days])) {
$this->_values[$days] = 0;
}
if ($this->option == 1) {
$this->_values[$days] += 1;
} else {
$this->_values[$days] += $row['total_revenue'];
}
}
}
protected function setDayValues($layers)
{
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($this->query.$this->getDate().$this->query_group_by.$this->query_having_filter);
foreach ($result as $row) {
if ($this->option == 1) {
$this->_values[(int)substr($row['invoice_date'], 11, 2)] += 1;
} else {
$this->_values[(int)substr($row['invoice_date'], 11, 2)] += $row['total_revenue'];
}
}
}
private function getOrderStatusesData()
{
$sql = 'SELECT t.`name`, COUNT(t.`id_order`) AS total
FROM (
SELECT osl.`id_order_state`, osl.`name`, oh.`id_order`
FROM `'._DB_PREFIX_.'order_state` os
LEFT JOIN `'._DB_PREFIX_.'order_state_lang` osl ON (os.`id_order_state` = osl.`id_order_state` AND osl.`id_lang` = '.(int)$this->getLang().')
LEFT JOIN `'._DB_PREFIX_.'order_history` oh ON os.`id_order_state` = oh.`id_order_state`
LEFT JOIN `'._DB_PREFIX_.'orders` o ON o.`id_order` = oh.`id_order`
'.((int)$this->id_country ? 'LEFT JOIN `'._DB_PREFIX_.'address` a ON o.id_address_delivery = a.id_address' : '').'
WHERE oh.`id_order_history` = (
SELECT ios.`id_order_history`
FROM `'._DB_PREFIX_.'order_history` ios
WHERE ios.`id_order` = oh.`id_order`
ORDER BY ios.`date_add` DESC, oh.`id_order_history` DESC
LIMIT 1
)
AND (
EXISTS (
SELECT 1
FROM `'._DB_PREFIX_.'htl_booking_detail` hbd
WHERE hbd.`id_order` = o.`id_order`' . HotelBranchInformation::addHotelRestriction($this->id_hotel).'
) OR EXISTS (
SELECT 1
FROM `'._DB_PREFIX_.'service_product_order_detail` spod
WHERE spod.`id_order` = o.`id_order`' . HotelBranchInformation::addHotelRestriction($this->id_hotel, 'spod').'
)'.(!$this->id_hotel ? ' OR EXISTS (
SELECT 1
FROM `'._DB_PREFIX_.'service_product_order_detail` spod
WHERE spod.`id_order` = o.`id_order` AND spod.`id_hotel` = 0 AND spod.`id_htl_booking_detail` = 0
)' : '').'
)'
.((int)$this->id_country ? 'AND a.id_country = '.(int)$this->id_country : '').'
AND o.`date_add` BETWEEN '.ModuleGraph::getDateBetween().'
GROUP BY o.`id_order`
) AS t
GROUP BY t.`id_order_state`';
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($sql);
foreach ($result as $row) {
$this->_values[] = $row['total'];
$this->_legend[] = $row['name'];
}
}
}