Files
PrestaShop/modules/dashtrends/dashtrends.php
2013-09-18 17:28:04 +02:00

265 lines
11 KiB
PHP

<?php
/*
* 2007-2013 PrestaShop
*
* NOTICE OF LICENSE
*
* This source file is subject to the Academic Free License (AFL 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/afl-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-2013 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 Dashtrends extends Module
{
public function __construct()
{
$this->name = 'dashtrends';
$this->displayName = 'Dashboard Trends';
$this->tab = '';
$this->version = '0.1';
$this->author = 'PrestaShop';
parent::__construct();
}
public function install()
{
if (!parent::install() || !$this->registerHook('dashboardZoneTwo') || !$this->registerHook('dashboardData') || !$this->registerHook('displayBackOfficeHeader'))
return false;
return true;
}
public function hookDisplayBackOfficeHeader()
{
if (get_class($this->context->controller) == 'AdminDashboardController')
$this->context->controller->addJs($this->_path.'views/js/'.$this->name.'.js');
}
public function hookDashboardZoneTwo($params)
{
return $this->display(__FILE__, 'dashboard_zone_two.tpl');
}
protected $dashboard_data = array(
'sales' => array(),
'orders' => array(),
'average_cart_value' => array(),
'visits' => array(),
'conversion_rate' => array(),
'net_profits' => array()
);
protected $dashboard_data_sum = array(
'sales' => 0,
'orders' => 0,
'average_cart_value' => 0,
'visits' => 0,
'conversion_rate' => 0,
'net_profits' => 0
);
public function hookDashboardData($params)
{
// We need the following figures to calculate our stats
$tmp_data = array(
'visits_score' => array(),
'orders_score' => array(),
'total_paid_tax_excl' => array(),
'total_discounts_tax_excl' => array(),
'total_credit_tax_excl' => array(),
'total_credit_shipping_tax_excl' => array(),
'total_product_price_tax_excl' => array(),
'total_purchase_price' => array()
);
// The visits are retrieved from Analytics if available
$gapi = Module::isInstalled('gapi') ? Module::getInstanceByName('gapi') : false;
if (Validate::isLoadedObject($gapi) && $gapi->isConfigured())
{
if ($result = $gapi->requestReportData('ga:date', 'ga:visits', $params['date_from'], $params['date_to'].' 23:59:59', null, null, 1, 9999))
foreach ($result as $row)
$tmp_data['visits_score'][strtotime(preg_replace('/^([0-9]{4})([0-9]{2})([0-9]{2})$/', '$1-$2-$3', $row['dimensions']['date']))] = $row['metrics']['visits'];
}
else
{
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->ExecuteS('
SELECT
LEFT(`date_add`, 10) as date,
COUNT(*) as visits_score
FROM `'._DB_PREFIX_.'connections`
WHERE `date_add` BETWEEN "'.pSQL($params['date_from']).'" AND "'.pSQL($params['date_to'].' 23:59:59').'"
'.Shop::addSqlRestriction(false).'
GROUP BY LEFT(`date_add`, 10)');
foreach ($result as $row)
$tmp_data['visits_score'][strtotime($row['date'])] = $row['visits_score'];
}
// First we retrieve the
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->ExecuteS('
SELECT
LEFT(`invoice_date`, 10) as date,
COUNT(*) as orders_score,
SUM(`total_paid_tax_excl` / `conversion_rate`) as total_paid_tax_excl,
SUM(`total_discounts_tax_excl` / `conversion_rate`) as total_discounts_tax_excl
FROM `'._DB_PREFIX_.'orders`
WHERE `invoice_date` BETWEEN "'.pSQL($params['date_from']).'" AND "'.pSQL($params['date_to'].' 23:59:59').'"
'.Shop::addSqlRestriction(Shop::SHARE_ORDER).'
GROUP BY LEFT(`invoice_date`, 10)');
foreach ($result as $row)
foreach (array('orders_score', 'total_paid_tax_excl', 'total_discounts_tax_excl') as $var)
$tmp_data[$var][strtotime($row['date'])] = $row[$var];
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->ExecuteS('
SELECT
LEFT(os.`date_add`, 10) as date,
SUM(os.`amount` / o.`conversion_rate`) as total_credit_tax_excl,
SUM(os.`shipping_cost_amount` / o.`conversion_rate`) as total_credit_shipping_tax_excl
FROM `'._DB_PREFIX_.'orders` o
LEFT JOIN `'._DB_PREFIX_.'order_slip` os ON o.id_order = os.id_order
WHERE os.`date_add` BETWEEN "'.pSQL($params['date_from']).'" AND "'.pSQL($params['date_to'].' 23:59:59').'"
'.Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o').'
GROUP BY LEFT(os.`date_add`, 10)');
foreach ($result as $row)
foreach (array('total_credit_tax_excl', 'total_credit_shipping_tax_excl') as $var)
$tmp_data[$var][strtotime($row['date'])] = $row[$var];
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->ExecuteS('
SELECT
LEFT(`invoice_date`, 10) as date,
SUM(od.`total_price_tax_excl` / `conversion_rate`) as total_product_price_tax_excl,
SUM(od.`product_quantity` * od.`purchase_supplier_price` / `conversion_rate`) as total_purchase_price
FROM `'._DB_PREFIX_.'orders` o
LEFT JOIN `'._DB_PREFIX_.'order_detail` od ON o.id_order = od.id_order
WHERE `invoice_date` BETWEEN "'.pSQL($params['date_from']).'" AND "'.pSQL($params['date_to'].' 23:59:59').'"
'.Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o').'
GROUP BY LEFT(`invoice_date`, 10)');
foreach ($result as $row)
foreach (array('total_product_price_tax_excl', 'total_purchase_price') as $var)
$tmp_data[$var][strtotime($row['date'])] = $row[$var];
$from = max(strtotime(_PS_CREATION_DATE_.' 00:00:00'), strtotime($params['date_from'].' 00:00:00'));
$to = min(time(), strtotime($params['date_to'].' 23:59:59'));
for ($date = $from; $date <= $to; $date = strtotime('+1 day', $date))
{
$this->dashboard_data['sales'][$date] = 0;
if (isset($tmp_data['total_paid_tax_excl'][$date]))
$this->dashboard_data['sales'][$date] += $tmp_data['total_paid_tax_excl'][$date];
if (isset($tmp_data['total_credit_tax_excl'][$date]))
$this->dashboard_data['sales'][$date] -= $tmp_data['total_credit_tax_excl'][$date];
if (isset($tmp_data['total_credit_shipping_tax_excl'][$date]))
$this->dashboard_data['sales'][$date] -= $tmp_data['total_credit_shipping_tax_excl'][$date];
$this->dashboard_data['orders'][$date] = isset($tmp_data['orders_score'][$date]) ? $tmp_data['orders_score'][$date] : 0;
$this->dashboard_data['average_cart_value'][$date] = $this->dashboard_data['orders'][$date] ? $this->dashboard_data['sales'][$date] / $this->dashboard_data['orders'][$date] : 0;
$this->dashboard_data['visits'][$date] = isset($tmp_data['visits_score'][$date]) ? $tmp_data['visits_score'][$date] : 0;
$this->dashboard_data['conversion_rate'][$date] = $this->dashboard_data['visits'][$date] ? $this->dashboard_data['orders'][$date] / $this->dashboard_data['visits'][$date] : 0;
$this->dashboard_data['net_profits'][$date] = 0;
if (isset($tmp_data['total_product_price_tax_excl'][$date]))
$this->dashboard_data['net_profits'][$date] += $tmp_data['total_product_price_tax_excl'][$date];
if (isset($tmp_data['total_discounts_tax_excl'][$date]))
$this->dashboard_data['net_profits'][$date] -= $tmp_data['total_discounts_tax_excl'][$date];
if (isset($tmp_data['total_purchase_price'][$date]))
$this->dashboard_data['net_profits'][$date] -= $tmp_data['total_purchase_price'][$date];
if (isset($tmp_data['total_credit_tax_excl'][$date]))
$this->dashboard_data['net_profits'][$date] -= $tmp_data['total_credit_tax_excl'][$date];
}
$this->dashboard_data_sum['sales'] = array_sum($this->dashboard_data['sales']);
$this->dashboard_data_sum['orders'] = array_sum($this->dashboard_data['orders']);
$this->dashboard_data_sum['average_cart_value'] = $this->dashboard_data_sum['sales'] ? $this->dashboard_data_sum['sales'] / $this->dashboard_data_sum['orders'] : 0;
$this->dashboard_data_sum['visits'] = array_sum($this->dashboard_data['visits']);
$this->dashboard_data_sum['conversion_rate'] = $this->dashboard_data_sum['visits'] ? $this->dashboard_data_sum['orders'] / $this->dashboard_data_sum['visits'] : 0;
$this->dashboard_data_sum['net_profits'] = array_sum($this->dashboard_data['net_profits']);
return array(
'data_value' => array(
'sales_score' => Tools::displayPrice(round($this->dashboard_data_sum['sales'])),
'orders_score' => $this->dashboard_data_sum['orders'],
'cart_value_score' => Tools::displayPrice($this->dashboard_data_sum['average_cart_value']),
'visits_score' => $this->dashboard_data_sum['visits'],
'convertion_rate_score' => round(100 * $this->dashboard_data_sum['conversion_rate'], 2),
'net_profits_score' => Tools::displayPrice(round($this->dashboard_data_sum['net_profits'])),
),
'data_trends' => array(
'sales_score_trends' => array('way' => 'up', 'value' => 0.42),
'orders_score_trends' => array('way' => 'down', 'value' => 0.42),
'cart_value_score_trends' => array('way' => 'up', 'value' => 0.42),
'visits_score_trends' => array('way' => 'down', 'value' => 0.42),
'convertion_rate_score_trends' => array('way' => 'up', 'value' => 0.42),
'net_profits_score_trends' => array('way' => 'up', 'value' => 0.42)
),
'data_chart' => array(
'dash_trends_chart1' => $this->getChartTrends(),
),
);
}
public function getChartTrends()
{
$chart_data = array();
foreach (array_keys($this->dashboard_data) as $chart_key)
{
$calibration = 1;
foreach ($this->dashboard_data[$chart_key] as $value)
if ($value)
{
$calibration = $value;
break;
}
$chart_values = array();
foreach ($this->dashboard_data[$chart_key] as $key => $value)
$chart_values[] = array(1000 * $key, 100 * $value / $calibration);
$chart_data[$chart_key] = $chart_values;
}
return array(
'chart_type' => 'line_chart_trends',
'data' => array(
array(
'key' => $this->l('Sales'),
'values' => $chart_data['sales']
),
array(
'key' => $this->l('Orders'),
'values' => $chart_data['orders']
),
array(
'key' => $this->l('Average Cart Value'),
'values' => $chart_data['average_cart_value']
),
array(
'key' => $this->l('Visits'),
'values' => $chart_data['visits']
),
array(
'key' => $this->l('Conversion Rate'),
'values' => $chart_data['conversion_rate']
),
array(
'key' => $this->l('Net Profits'),
'values' => $chart_data['net_profits']
)
)
);
}
}