* @copyright 2007-2014 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 $option = ''; private $id_country = ''; public function __construct() { $this->name = 'statssales'; $this->tab = 'analytics_stats'; $this->version = '1.2.3'; $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' => 2, 'type' => 'line', 'option' => '1-'.(int)Tools::getValue('id_country') )); elseif ($id_export == 2) $this->csvExport(array( 'layers' => 0, 'type' => 'line', 'option' => '2-'.(int)Tools::getValue('id_country') )); elseif ($id_export == 3) $this->csvExport(array( 'type' => 'pie', 'option' => '3-'.(int)Tools::getValue('id_country') )); $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, Preparation in Progress, Shipping, Delivered, Canceled, Refund, Payment Error, Out of Stock, 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 shop\'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 shop\'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'), 'layers' => 2 )).'

'.$this->l('Orders placed:').' '.(int)$totals['orderCount'].'
'.$this->l('Products bought:').' '.(int)$totals['products'].'

'.$this->l('CSV Export').'

'.$this->engine(array( 'type' => 'line', 'option' => '2-'.(int)Tools::getValue('id_country') )).'

'.$this->l('Sales:').' '.Tools::displayPrice($totals['orderSum'], $currency).'

'.$this->l('CSV Export').'

'.$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') )) : $this->l('No orders for this period.')).'

'.$this->l('CSV Export').'

'; return $this->html; } private function getTotals() { $sql = 'SELECT COUNT(o.`id_order`) as orderCount, SUM(o.`total_paid_real` / o.conversion_rate) 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 '.Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o').' '.((int)Tools::getValue('id_country') ? 'AND a.id_country = '.(int)Tools::getValue('id_country') : '').' AND o.`invoice_date` BETWEEN '.ModuleGraph::getDateBetween(); $result1 = Db::getInstance(_PS_USE_SQL_SLAVE_)->getRow($sql); $sql = 'SELECT SUM(od.product_quantity) as products FROM `'._DB_PREFIX_.'orders` o LEFT JOIN `'._DB_PREFIX_.'order_detail` od ON od.`id_order` = o.`id_order` '.((int)Tools::getValue('id_country') ? 'LEFT JOIN `'._DB_PREFIX_.'address` a ON o.id_address_delivery = a.id_address' : '').' WHERE o.valid = 1 '.Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o').' '.((int)Tools::getValue('id_country') ? 'AND a.id_country = '.(int)Tools::getValue('id_country') : '').' AND o.`invoice_date` BETWEEN '.ModuleGraph::getDateBetween(); $result2 = Db::getInstance(_PS_USE_SQL_SLAVE_)->getRow($sql); return array_merge($result1, $result2); } public function setOption($options, $layers = 1) { list($this->option, $this->id_country) = explode('-', $options); switch ($this->option) { case 1: $this->_titles['main'][0] = $this->l('Orders placed'); $this->_titles['main'][1] = $this->l('Products bought'); $this->_titles['main'][2] = $this->l('Products:'); break; case 2: $currency = new Currency((int)Configuration::get('PS_CURRENCY_DEFAULT')); $this->_titles['main'] = sprintf($this->l('Sales currency: %s'), $currency->iso_code); break; case 3: $this->_titles['main'] = $this->l('Percentage of orders per status.'); break; } } protected function getData($layers) { if ($this->option == 3) return $this->getStatesData(); $this->query = ' SELECT o.`invoice_date`, o.`total_paid_real` / o.conversion_rate as total_paid_real, SUM(od.product_quantity) as product_quantity FROM `'._DB_PREFIX_.'orders` o LEFT JOIN `'._DB_PREFIX_.'order_detail` od ON od.`id_order` = o.`id_order` '.((int)$this->id_country ? 'LEFT JOIN `'._DB_PREFIX_.'address` a ON o.id_address_delivery = a.id_address' : '').' WHERE o.valid = 1 '.Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o').' '.((int)$this->id_country ? 'AND a.id_country = '.(int)$this->id_country : '').' 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); foreach ($result as $row) if ($this->option == 1) { $this->_values[0][(int)substr($row['invoice_date'], 0, 4)] += 1; $this->_values[1][(int)substr($row['invoice_date'], 0, 4)] += $row['product_quantity']; } else $this->_values[(int)substr($row['invoice_date'], 0, 4)] += $row['total_paid_real']; } protected function setYearValues($layers) { $result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($this->query.$this->getDate().$this->query_group_by); foreach ($result as $row) { $mounth = (int)substr($row['invoice_date'], 5, 2); if ($this->option == 1) { if (!isset($this->_values[0][$mounth])) $this->_values[0][$mounth] = 0; if (!isset($this->_values[1][$mounth])) $this->_values[1][$mounth] = 0; $this->_values[0][$mounth] += 1; $this->_values[1][$mounth] += $row['product_quantity']; } else { if (!isset($this->_values[$mounth])) $this->_values[$mounth] = 0; $this->_values[$mounth] += $row['total_paid_real']; } } } protected function setMonthValues($layers) { $result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($this->query.$this->getDate().$this->query_group_by); foreach ($result as $row) if ($this->option == 1) { $this->_values[0][(int)substr($row['invoice_date'], 8, 2)] += 1; $this->_values[1][(int)substr($row['invoice_date'], 8, 2)] += $row['product_quantity']; } else $this->_values[(int)substr($row['invoice_date'], 8, 2)] += $row['total_paid_real']; } protected function setDayValues($layers) { $result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($this->query.$this->getDate().$this->query_group_by); foreach ($result as $row) if ($this->option == 1) { $this->_values[0][(int)substr($row['invoice_date'], 11, 2)] += 1; $this->_values[1][(int)substr($row['invoice_date'], 11, 2)] += $row['product_quantity']; } else $this->_values[(int)substr($row['invoice_date'], 11, 2)] += $row['total_paid_real']; } private function getStatesData() { $result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS(' SELECT osl.`name`, COUNT(oh.`id_order`) as total 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 ) '.((int)$this->id_country ? 'AND a.id_country = '.(int)$this->id_country : '').' AND o.`date_add` BETWEEN '.ModuleGraph::getDateBetween().' GROUP BY oh.`id_order_state`'); foreach ($result as $row) { $this->_values[] = $row['total']; $this->_legend[] = $row['name']; } } }