| Current File : //var/www/prestashop/modules/statsproduct/statsproduct.php |
<?php
/**
* Copyright since 2007 PrestaShop SA and Contributors
* PrestaShop is an International Registered Trademark & Property of PrestaShop SA
*
* NOTICE OF LICENSE
*
* This source file is subject to the Academic Free License 3.0 (AFL-3.0)
* that is bundled with this package in the file LICENSE.md.
* It is also available through the world-wide-web at this URL:
* https://opensource.org/licenses/AFL-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://devdocs.prestashop.com/ for more information.
*
* @author PrestaShop SA and Contributors <contact@prestashop.com>
* @copyright Since 2007 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
*/
if (!defined('_PS_VERSION_')) {
exit;
}
class statsproduct extends ModuleGraph
{
private $html = '';
private $query = [];
private $option = 0;
private $id_product = 0;
public function __construct()
{
$this->name = 'statsproduct';
$this->tab = 'analytics_stats';
$this->version = '2.1.1';
$this->author = 'PrestaShop';
$this->need_instance = 0;
parent::__construct();
$this->displayName = $this->trans('Product details', array(), 'Modules.Statsproduct.Admin');
$this->description = $this->trans('Enrich your stats, add detailed statistics for each product of your catalog.', array(), 'Modules.Statsproduct.Admin');
$this->ps_versions_compliancy = array('min' => '1.7.6.0', 'max' => _PS_VERSION_);
}
public function install()
{
return (parent::install() && $this->registerHook('displayAdminStatsModules'));
}
public function getTotalBought($id_product)
{
$date_between = ModuleGraph::getDateBetween();
$sql = 'SELECT SUM(od.`product_quantity`) AS total
FROM `'._DB_PREFIX_.'order_detail` od
LEFT JOIN `'._DB_PREFIX_.'orders` o ON o.`id_order` = od.`id_order`
WHERE od.`product_id` = '.(int)$id_product.'
'.Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o').'
AND o.valid = 1
AND o.`date_add` BETWEEN '.$date_between;
return (int)Db::getInstance(_PS_USE_SQL_SLAVE_)->getValue($sql);
}
public function getTotalSales($id_product)
{
$date_between = ModuleGraph::getDateBetween();
$sql = 'SELECT SUM(od.`total_price_tax_excl`) AS total
FROM `'._DB_PREFIX_.'order_detail` od
LEFT JOIN `'._DB_PREFIX_.'orders` o ON o.`id_order` = od.`id_order`
WHERE od.`product_id` = '.(int)$id_product.'
'.Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o').'
AND o.valid = 1
AND o.`date_add` BETWEEN '.$date_between;
return (float)Db::getInstance(_PS_USE_SQL_SLAVE_)->getValue($sql);
}
public function getTotalViewed($id_product)
{
$date_between = ModuleGraph::getDateBetween();
$sql = 'SELECT SUM(pv.`counter`) AS total
FROM `'._DB_PREFIX_.'page_viewed` pv
LEFT JOIN `'._DB_PREFIX_.'date_range` dr ON pv.`id_date_range` = dr.`id_date_range`
LEFT JOIN `'._DB_PREFIX_.'page` p ON pv.`id_page` = p.`id_page`
LEFT JOIN `'._DB_PREFIX_.'page_type` pt ON pt.`id_page_type` = p.`id_page_type`
WHERE pt.`name` = \'product\'
'.Shop::addSqlRestriction(false, 'pv').'
AND p.`id_object` = '.(int)$id_product.'
AND dr.`time_start` BETWEEN '.$date_between.'
AND dr.`time_end` BETWEEN '.$date_between;
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->getRow($sql);
return isset($result['total']) ? $result['total'] : 0;
}
private function getProducts($id_lang)
{
$sql = 'SELECT p.`id_product`, p.reference, pl.`name`, IFNULL(stock.quantity, 0) as quantity
FROM `'._DB_PREFIX_.'product` p
'.Product::sqlStock('p', 0).'
LEFT JOIN `'._DB_PREFIX_.'product_lang` pl ON p.`id_product` = pl.`id_product`'.Shop::addSqlRestrictionOnLang('pl').'
'.Shop::addSqlAssociation('product', 'p').'
'.(Tools::getValue('id_category') ? 'LEFT JOIN `'._DB_PREFIX_.'category_product` cp ON p.`id_product` = cp.`id_product`' : '').'
WHERE pl.`id_lang` = '.(int)$id_lang.'
'.(Tools::getValue('id_category') ? 'AND cp.id_category = '.(int)Tools::getValue('id_category') : '');
if (version_compare(_PS_VERSION_, '1.7.0.0', '>=')) {
$sql .= ' AND p.state = ' . Product::STATE_SAVED;
}
$sql .= ' ORDER BY pl.`name`';
return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($sql);
}
private function getSales($id_product)
{
$sql = 'SELECT o.date_add, o.id_order, o.id_customer, od.product_quantity, (od.unit_price_tax_excl * od.product_quantity) as total, od.tax_name, od.product_name
FROM `'._DB_PREFIX_.'orders` o
LEFT JOIN `'._DB_PREFIX_.'order_detail` od ON o.id_order = od.id_order
WHERE o.date_add BETWEEN '.$this->getDate().'
'.Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o').'
AND o.valid = 1
AND od.product_id = '.(int)$id_product;
return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($sql);
}
private function getCrossSales($id_product, $id_lang)
{
$sql = 'SELECT pl.name as pname, pl.id_product, SUM(od.product_quantity) as pqty, AVG(od.unit_price_tax_excl) as pprice
FROM `'._DB_PREFIX_.'orders` o
LEFT JOIN `'._DB_PREFIX_.'order_detail` od ON o.id_order = od.id_order
LEFT JOIN `'._DB_PREFIX_.'product_lang` pl ON (pl.id_product = od.product_id AND pl.id_lang = '.(int)$id_lang.Shop::addSqlRestrictionOnLang('pl').')
WHERE o.id_customer IN (
SELECT o.id_customer
FROM `'._DB_PREFIX_.'orders` o
LEFT JOIN `'._DB_PREFIX_.'order_detail` od ON o.id_order = od.id_order
WHERE o.date_add BETWEEN '.$this->getDate().'
AND o.valid = 1
AND od.product_id = '.(int)$id_product.'
)
'.Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o').'
AND o.date_add BETWEEN '.$this->getDate().'
AND o.valid = 1
AND od.product_id != '.(int)$id_product.'
GROUP BY od.product_id
ORDER BY pqty DESC';
return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($sql);
}
public function hookDisplayAdminStatsModules()
{
$id_category = (int)Tools::getValue('id_category');
$currency = Context::getContext()->currency;
if (Tools::getValue('export')) {
if (!Tools::getValue('exportType')) {
$this->csvExport(array(
'layers' => 2,
'type' => 'line',
'option' => '42'
));
}
}
$this->html = '
<div class="panel-heading">
'.$this->displayName.'
</div>
<h4>'.$this->trans('Guide', array(), 'Admin.Global').'</h4>
<div class="alert alert-warning">
<h4>'.$this->trans('Number of purchases compared to number of views', array(), 'Modules.Statsproduct.Admin').'</h4>
'.$this->trans('After choosing a category and selecting a product, informational graphs will appear.', array(), 'Modules.Statsproduct.Admin').'
<ul>
<li class="bullet">'.$this->trans('If you notice that a product is often purchased but viewed infrequently, you should display it more prominently in your Front Office.', array(), 'Modules.Statsproduct.Admin').'</li>
<li class="bullet">'.$this->trans('On the other hand, if a product has many views but is not often purchased, we advise you to check or modify this product\'s information, description and photography again, see if you can find something better.', array(), 'Modules.Statsproduct.Admin').'
</li>
</ul>
</div>';
if ($id_product = (int)Tools::getValue('id_product')) {
if (Tools::getValue('export')) {
if (Tools::getValue('exportType') == 1) {
$this->csvExport(array(
'layers' => 2,
'type' => 'line',
'option' => '1-'.$id_product
));
} elseif (Tools::getValue('exportType') == 2) {
$this->csvExport(array(
'type' => 'pie',
'option' => '3-'.$id_product
));
}
}
$product = new Product($id_product, false, $this->context->language->id);
$total_bought = $this->getTotalBought($product->id);
$total_sales = $this->getTotalSales($product->id);
$total_viewed = $this->getTotalViewed($product->id);
$this->html .= '<h4>'.$product->name.' - '.$this->trans('Details', array(), 'Modules.Statsproduct.Admin').'</h4>
<div class="row row-margin-bottom">
<div class="col-lg-12">
<div class="col-lg-8">
'.$this->engine(array(
'layers' => 2,
'type' => 'line',
'option' => '1-'.$id_product
)).'
</div>
<div class="col-lg-4">
<ul class="list-unstyled">
<li>'.$this->trans('Total bought', array(), 'Modules.Statsproduct.Admin').' '.$total_bought.'</li>
<li>' . $this->trans('Sales (tax excluded)', array(), 'Modules.Statsproduct.Admin'). ' '. $this->context->getCurrentLocale()->formatPrice($total_sales, $currency->iso_code) . '</li>
<li>'.$this->trans('Total Viewed', array(), 'Modules.Statsproduct.Admin').' '.$total_viewed.'</li>
<li>'.$this->trans('Conversion rate', array(), 'Modules.Statsproduct.Admin').' '.number_format($total_viewed ? $total_bought / $total_viewed : 0, 2).'</li>
</ul>
<a class="btn btn-default export-csv" href="'.Tools::safeOutput($_SERVER['REQUEST_URI']).'&export=1&exportType=1">
<i class="icon-cloud-upload"></i> '.$this->trans('CSV Export', array(), 'Modules.Statsproduct.Admin').'
</a>
</div>
</div>
</div>';
if ($has_attribute = $product->hasAttributes() && $total_bought) {
$this->html .= '
<h3 class="space">'.$this->trans('Attribute sales distribution', array(), 'Modules.Statsproduct.Admin').'</h3>
<center>'.$this->engine(array('type' => 'pie', 'option' => '3-'.$id_product)).'</center><br />
<a href="'.Tools::safeOutput($_SERVER['REQUEST_URI']).'&export=1&exportType=2"><img src="../img/admin/asterisk.gif" alt=""/>'.$this->trans('CSV Export', array(), 'Modules.Statsproduct.Admin').'</a>';
}
if ($total_bought) {
$sales = $this->getSales($id_product);
$this->html .= '
<h4>'.$this->trans('Sales', array(), 'Admin.Global').'</h4>
<div style="overflow-y:scroll;height:'.min(400, (count($sales) + 1) * 32).'px">
<table class="table">
<thead>
<tr>
<th>
<span class="title_box active">'.$this->trans('Date', array(), 'Admin.Global').'</span>
</th>
<th>
<span class="title_box active">'.$this->trans('Order', array(), 'Admin.Global').'</span>
</th>
<th>
<span class="title_box active">'.$this->trans('Customer', array(), 'Admin.Global').'</span>
</th>
'.($has_attribute ? '<th><span class="title_box active">'.$this->trans('Attribute', array(), 'Admin.Global').'</span></th>' : '').'
<th>
<span class="title_box active">'.$this->trans('Quantity', array(), 'Admin.Global').'</span>
</th>
<th>
<span class="title_box active">'.$this->trans('Price', array(), 'Admin.Global').'</span>
</th>
</tr>
</thead>
<tbody>';
$token_order = Tools::getAdminToken('AdminOrders'.(int)Tab::getIdFromClassName('AdminOrders').(int)$this->context->employee->id);
$token_customer = Tools::getAdminToken('AdminCustomers'.(int)Tab::getIdFromClassName('AdminCustomers').(int)$this->context->employee->id);
foreach ($sales as $sale) {
$this->html .= '
<tr>
<td>'.Tools::displayDate($sale['date_add'], null, false).'</td>
<td class="text-center"><a href="?tab=AdminOrders&id_order='.$sale['id_order'].'&vieworder&token='.$token_order.'">'.(int)$sale['id_order'].'</a></td>
<td class="text-center"><a href="?tab=AdminCustomers&id_customer='.$sale['id_customer'].'&viewcustomer&token='.$token_customer.'">'.(int)$sale['id_customer'].'</a></td>
'.($has_attribute ? '<td>'.$sale['product_name'].'</td>' : '').'
<td>'.(int)$sale['product_quantity'].'</td>
<td>' . $this->context->getCurrentLocale()->formatPrice($sale['total'], $currency->iso_code) . '</td>
</tr>';
}
$this->html .= '
</tbody>
</table>
</div>';
$cross_selling = $this->getCrossSales($id_product, $this->context->language->id);
if (count($cross_selling)) {
$this->html .= '
<h4>'.$this->trans('Cross selling', array(), 'Modules.Statsproduct.Admin').'</h4>
<div style="overflow-y:scroll;height:200px">
<table class="table">
<thead>
<tr>
<th>
<span class="title_box active">'.$this->trans('Product name', array(), 'Admin.Shopparameters.Feature').'</span>
</th>
<th>
<span class="title_box active">'.$this->trans('Quantity sold', array(), 'Admin.Global').'</span>
</th>
<th>
<span class="title_box active">'.$this->trans('Average price', array(), 'Admin.Global').'</span>
</th>
</tr>
</thead>
<tbody>';
$token_products = Tools::getAdminToken('AdminProducts'.(int)Tab::getIdFromClassName('AdminProducts').(int)$this->context->employee->id);
foreach ($cross_selling as $selling) {
$this->html .= '
<tr>
<td><a href="?tab=AdminProducts&id_product='.(int)$selling['id_product'].'&addproduct&token='.$token_products.'">'.$selling['pname'].'</a></td>
<td class="text-center">'.(int)$selling['pqty'].'</td>
<td class="text-right">' . $this->context->getCurrentLocale()->formatPrice($selling['pprice'], $currency->iso_code) . '</td>
</tr>';
}
$this->html .= '
</tbody>
</table>
</div>';
}
}
} else {
$categories = Category::getCategories((int)$this->context->language->id, true, false);
$this->html .= '
<form action="#" method="post" id="categoriesForm" class="form-horizontal">
<div class="row row-margin-bottom">
<label class="control-label col-lg-3">
<span title="" data-toggle="tooltip" class="label-tooltip" data-original-title="'.$this->trans('Click on a product to access its statistics!', array(), 'Modules.Statsproduct.Admin').'">
'.$this->trans('Choose a category', array(), 'Modules.Statsproduct.Admin').'
</span>
</label>
<div class="col-lg-3">
<select name="id_category" onchange="$(\'#categoriesForm\').submit();">
<option value="0">'.$this->trans('All', array(), 'Admin.Global').'</option>';
foreach ($categories as $category) {
$this->html .= '<option value="'.$category['id_category'].'"'.($id_category == $category['id_category'] ? ' selected="selected"' : '').'>'.$category['name'].'</option>';
}
$this->html .= '
</select>
</div>
</div>
</form>
<h4>'.$this->trans('Products available', array(), 'Modules.Statsproduct.Admin').'</h4>
<table class="table" style="border: 0; cellspacing: 0;">
<thead>
<tr>
<th>
<span class="title_box active">'.$this->trans('Reference', array(), 'Admin.Global').'</span>
</th>
<th>
<span class="title_box active">'.$this->trans('Name', array(), 'Admin.Global').'</span>
</th>
<th>
<span class="title_box active">'.$this->trans('Available quantity for sale', array(), 'Admin.Global').'</span>
</th>
</tr>
</thead>
<tbody>';
foreach ($this->getProducts($this->context->language->id) as $product) {
$this->html .= '
<tr>
<td>'.$product['reference'].'</td>
<td>
<a href="'.Tools::safeOutput(AdminController::$currentIndex.'&token='.Tools::getValue('token').'&module='.$this->name.'&id_product='.$product['id_product']).'">'.$product['name'].'</a>
</td>
<td>'.$product['quantity'].'</td>
</tr>';
}
$this->html .= '
</tbody>
</table>
<a class="btn btn-default export-csv" href="'.Tools::safeOutput($_SERVER['REQUEST_URI'].'&export=1').'">
<i class="icon-cloud-upload"></i> '.$this->trans('CSV Export', array(), 'Modules.Statsproduct.Admin').'
</a>';
}
return $this->html;
}
public function setOption($option, $layers = 1)
{
$options = explode('-', $option);
if (count($options) === 2) {
list($this->option, $this->id_product) = $options;
} else {
$this->option = $option;
}
$date_between = $this->getDate();
switch ($this->option) {
case 1:
$this->_titles['main'][0] = $this->trans('Popularity', array(), 'Modules.Statsproduct.Admin');
$this->_titles['main'][1] = $this->trans('Sales', array(), 'Admin.Global');
$this->_titles['main'][2] = $this->trans('Visits (x100)', array(), 'Modules.Statsproduct.Admin');
$this->query = [];
$this->query[0] = 'SELECT o.`date_add`, SUM(od.`product_quantity`) AS total
FROM `'._DB_PREFIX_.'order_detail` od
LEFT JOIN `'._DB_PREFIX_.'orders` o ON o.`id_order` = od.`id_order`
WHERE od.`product_id` = '.(int)$this->id_product.'
'.Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o').'
AND o.valid = 1
AND o.`date_add` BETWEEN '.$date_between.'
GROUP BY o.`date_add`';
$this->query[1] = 'SELECT dr.`time_start` AS date_add, (SUM(pv.`counter`) / 100) AS total
FROM `'._DB_PREFIX_.'page_viewed` pv
LEFT JOIN `'._DB_PREFIX_.'date_range` dr ON pv.`id_date_range` = dr.`id_date_range`
LEFT JOIN `'._DB_PREFIX_.'page` p ON pv.`id_page` = p.`id_page`
LEFT JOIN `'._DB_PREFIX_.'page_type` pt ON pt.`id_page_type` = p.`id_page_type`
WHERE pt.`name` = \'product\'
'.Shop::addSqlRestriction(false, 'pv').'
AND p.`id_object` = '.(int)$this->id_product.'
AND dr.`time_start` BETWEEN '.$date_between.'
AND dr.`time_end` BETWEEN '.$date_between.'
GROUP BY dr.`time_start`';
break;
case 3:
$this->query = 'SELECT product_attribute_id, SUM(od.`product_quantity`) AS total, od.product_name AS product_name
FROM `'._DB_PREFIX_.'orders` o
LEFT JOIN `'._DB_PREFIX_.'order_detail` od ON o.`id_order` = od.`id_order`
WHERE od.`product_id` = '.(int)$this->id_product.'
'.Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o').'
AND o.valid = 1
AND o.`date_add` BETWEEN '.$date_between.'
GROUP BY od.`product_attribute_id`';
$this->_titles['main'] = $this->trans('Attributes', array(), 'Admin.Global');
break;
case 42:
$this->_titles['main'][1] = $this->trans('Reference', array(), 'Admin.Global');
$this->_titles['main'][2] = $this->trans('Name', array(), 'Admin.Global');
$this->_titles['main'][3] = $this->trans('Stock', array(), 'Modules.Statsproduct.Admin');
break;
}
}
protected function getData($layers)
{
if ($this->option == 42) {
$products = $this->getProducts($this->context->language->id);
foreach ($products as $product) {
$this->_values[0][] = $product['reference'];
$this->_values[1][] = $product['name'];
$this->_values[2][] = $product['quantity'];
$this->_legend[] = $product['id_product'];
}
} elseif ($this->option != 3) {
$this->setDateGraph($layers, true);
} else {
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($this->query);
foreach ($result as $row) {
$this->_values[] = $row['total'];
$this->_legend[] = $row['product_name'];
}
}
}
protected function setAllTimeValues($layers)
{
for ($i = 0; $i < $layers; $i++) {
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($this->query[$i]);
foreach ($result as $row) {
$this->_values[$i][(int)substr($row['date_add'], 0, 4)] += $row['total'];
}
}
}
protected function setYearValues($layers)
{
for ($i = 0; $i < $layers; $i++) {
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($this->query[$i]);
foreach ($result as $row) {
$this->_values[$i][(int)substr($row['date_add'], 5, 2)] += $row['total'];
}
}
}
protected function setMonthValues($layers)
{
for ($i = 0; $i < $layers; $i++) {
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($this->query[$i]);
foreach ($result as $row) {
$this->_values[$i][(int)substr($row['date_add'], 8, 2)] += $row['total'];
}
}
}
protected function setDayValues($layers)
{
for ($i = 0; $i < $layers; $i++) {
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($this->query[$i]);
foreach ($result as $row) {
$this->_values[$i][(int)substr($row['date_add'], 11, 2)] += $row['total'];
}
}
}
}