fannie/reports/ProductMovement/ProductMovementModular.php
<?php
/*******************************************************************************
Copyright 2012 Whole Foods Co-op
This file is part of CORE-POS.
CORE-POS is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
CORE-POS is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
in the file license.txt along with IT CORE; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*********************************************************************************/
include(dirname(__FILE__) . '/../../config.php');
if (!class_exists('FannieAPI')) {
include_once(__DIR__ . '/../../classlib2.0/FannieAPI.php');
}
class ProductMovementModular extends FannieReportPage
{
protected $title = "Fannie : Product Movement";
protected $header = "Product Movement Report";
protected $report_headers = array('Date','UPC','Brand','Description','Qty','$');
protected $required_fields = array('date1', 'date2', 'upc');
public $description = '[Product Movement] lists sales for a specific UPC over a given date range.';
public $report_set = 'Movement Reports';
public $themed = true;
protected $new_tablesorter = true;
function preprocess()
{
$ret = parent::preprocess();
// custom: needs graphing JS/CSS
if ($this->content_function == 'report_content' && $this->report_format == 'html') {
$this->addScript('../../src/javascript/Chart.min.js');
$this->addScript('../../src/javascript/CoreChart.js');
}
return $ret;
}
public function report_content()
{
$default = parent::report_content();
if ($this->report_format == 'html') {
$default .= '<div class="col-sm-10 col-sm-offset-1"><canvas id="chartCanvas"></canvas></div>';
$this->addOnloadCommand('showGraph()');
}
return $default;
}
private function getTransTable($upc, $date1, $date2)
{
if (!is_numeric($upc) || $upc == "0000000000052") {
return DTransactionsModel::selectDTrans($date1, $date2);
} elseif (substr($upc, 0, 3) == '004') {
return DTransactionsModel::selectDLog($date1, $date2);
} elseif (substr($upc, 0, 3) == '005') {
return DTransactionsModel::selectDLog($date1, $date2);
} elseif ($upc == '0096000000002') {
return DTransactionsModel::selectDLog($date1, $date2);
}
return DTrans::getView($date1, $date2);
}
private function defaultQuery($dlog, $store, $between)
{
$ymd = DTrans::extractYMD($dlog);
return "SELECT {$ymd},
t.upc,
p.brand,
p.description,
" . DTrans::sumQuantity('t', false, $dlog) . " AS qty,
SUM(t.total) AS total
FROM $dlog AS t
" . DTrans::joinProducts('t', 'p', 'LEFT') . "
WHERE t.upc = ? AND
{$between}
AND " . DTrans::isStoreID($store, 't') . "
GROUP BY
{$ymd},
t.upc,
p.description
ORDER BY {$ymd}";
}
private function wfcRrrQuery($dlog, $store)
{
$ymd = DTrans::extractYMD($dlog);
$ymd = str_replace('tdate', 'datetime', $ymd);
return "select {$ymd},
upc,'' AS brand,'RRR' AS description,
sum(case when upc <> 'rrr' then quantity when volSpecial is null or volSpecial > 9999 then 0 else volSpecial end) as qty,
sum(t.total) AS total from
$dlog as t
where upc = ?
AND datetime BETWEEN ? AND ?
AND " . DTrans::isStoreID($store, 't') . "
and emp_no <> 9999 and register_no <> 99
and trans_status <> 'X'
GROUP BY {$ymd}
ORDER BY {$ymd}";
}
private function nonNumericQuery($dlog, $store)
{
$ymd = DTrans::extractYMD($dlog);
$ymd = str_replace('tdate', 'datetime', $ymd);
return "select {$ymd},
upc,'' AS brand, description,
sum(CASE WHEN quantity=0 THEN 1 ELSE quantity END) as qty,
sum(t.total) AS total from
$dlog as t
where upc = ?
AND datetime BETWEEN ? AND ?
AND " . DTrans::isStoreID($store, 't') . "
and emp_no <> 9999 and register_no <> 99
and (trans_status <> 'X' || trans_type='L')
GROUP BY {$ymd}";
}
function fetch_report_data()
{
$dbc = $this->connection;
$dbc->selectDB($this->config->get('OP_DB'));
$date1 = $this->form->date1;
$date2 = $this->form->date2;
$upc = $this->form->upc;
if (is_numeric($upc)) {
$upc = BarcodeLib::padUPC($upc);
}
$store = FormLib::get('store', 0);
$dlog = $this->getTransTable($upc, $date1, $date2);
list($between, $dates) = DTrans::dateBetween($dlog, $date1, $date2);
$query = $this->defaultQuery($dlog, $store, $between);
$args = array($upc, $dates[0], $dates[1], $store);
if (strtolower(trim($upc)) == "rrr" || $upc == "0000000000052"){
$query = $this->wfcRrrQuery($dlog, $store);
} elseif (!is_numeric($upc)) {
$query = $this->nonNumericQuery($dlog, $store);
}
$prep = $dbc->prepare($query);
try {
$result = $dbc->execute($prep,$args);
} catch (Exception $ex) {
// MySQL 5.6 GROUP BY issue
return array();
}
/**
Simple report
Issue a query, build array of results
*/
$ret = array();
while ($row = $dbc->fetchRow($result)){
$ret[] = $this->rowToRecord($row);
}
return $ret;
}
private function rowToRecord($row)
{
$record = array();
$record[] = $row[1]."/".$row[2]."/".$row[0];
$record[] = $row['upc'];
$record[] = $row['brand'] === null ? '' : $row['brand'];
$record[] = $row['description'] === null ? '' : $row['description'];
$record[] = sprintf('%.2f', $row['qty']);
$record[] = sprintf('%.2f', $row['total']);
return $record;
}
/**
Sum the quantity and total columns
*/
function calculate_footers($data){
$sumQty = 0.0;
$sumSales = 0.0;
foreach($data as $row){
$sumQty += $row[4];
$sumSales += $row[5];
}
$divisor = count($data) > 0 ? count($data) : 1;
return array(
array('Daily Avg.',null,null,null,round($sumQty/$divisor,2),round($sumSales/$divisor,2)),
array('Total',null,null,null,$sumQty,$sumSales)
);
}
public function javascriptContent()
{
if ($this->report_format != 'html') {
return;
}
ob_start();
?>
function showGraph() {
var xLabels = $('td.reportColumn0').toArray().map(x => x.innerHTML.trim());
var yData = $('td.reportColumn4').toArray().map(x => Number(x.innerHTML.trim()));
CoreChart.lineChart('chartCanvas', xLabels, [yData], ["Daily Qty Sold"]);
}
<?php
return ob_get_clean();
}
function form_content()
{
$stores = FormLib::storePicker();
$dates = FormLib::standardDateFields();
$this->addScript($this->config->get('URL') . 'item/autocomplete.js');
$ws = $this->config->get('URL') . 'ws/';
$this->addOnloadCommand("bindAutoComplete('#upc', '$ws', 'item');\n");
$this->addOnloadCommand('$(\'#upc\').focus();');
return <<<HTML
<form method="get" action="ProductMovementModular.php" class="form-horizontal">
<div class="col-sm-5">
<div class="form-group">
<label class="control-label col-sm-4">UPC</label>
<div class="col-sm-8">
<input type=text name=upc id=upc class="form-control" required />
</div>
</div>
<div class="form-group">
<label class="control-label col-sm-4">Store</label>
<div class="col-sm-8">
{$stores['html']}
</div>
</div>
<div class="form-group">
<label class="control-label col-sm-4">
<input type="checkbox" name="excel" id="excel" value="xls" /> Excel
</label>
</div>
<div class="form-group">
<button type=submit name=submit value="Submit" class="btn btn-default btn-core">Submit</button>
<button type=reset name=reset class="btn btn-default btn-reset">Start Over</button>
</div>
</div>
{$dates}
</form>
HTML;
}
public function helpContent()
{
return '<p>This report shows per-day total sales for
a given item. You can type in item names to find the
appropriate UPC if needed.</p>';
}
public function unitTest($phpunit)
{
$data = array(0=>1, 1=>1, 2=>2000, 'upc'=>'4011', 'brand'=>'test',
'description'=>'test', 'qty'=>1, 'total'=>1);
$phpunit->assertInternalType('array', $this->rowToRecord($data));
$this->form = new COREPOS\common\mvc\ValueContainer();
$this->form->date1 = date('Y-m-d');
$this->form->date2 = date('Y-m-d');
$this->form->upc = '4011';
$phpunit->assertInternalType('array', $this->fetch_report_data());
$this->form->upc = 'rrr';
$phpunit->assertInternalType('array', $this->fetch_report_data());
$this->form->upc = 'asdf';
$phpunit->assertInternalType('array', $this->fetch_report_data());
}
}
FannieDispatch::conditionalExec();