fannie/reports/GeneralDay/GeneralDayReport.php
<?php
/*******************************************************************************
Copyright 2013 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(__DIR__ . '/../../classlib2.0/FannieAPI.php');
}
class GeneralDayReport extends FannieReportPage
{
public $description = '[General Day Report] lists tenders, sales, discounts, and taxes for a given day
(should net to zero). Also listed are transaction count & size information by member type and
equity sales for the day.';
public $report_set = 'Sales Reports';
public $themed = true;
protected $new_tablesorter = true;
protected $title = "Fannie : General Day Report";
protected $header = "General Day Report";
protected $report_cache = 'none';
protected $grandTTL = 1;
protected $multi_report_mode = true;
protected $sortable = false;
protected $no_sort_but_style = true;
protected $report_headers = array('Desc','Qty','Amount');
protected $required_fields = array('date');
public function preprocess()
{
if ($this->report_format == 'html' && $this->hasAllFields($this->required_fields)) {
$this->addScript('../../src/javascript/Chart.min.js');
$this->addScript('../../src/javascript/CoreChart.js?date=20171207');
$this->addScript('generalDay.js?date=20171207');
$this->addOnloadCommand('generalDay.tenders();');
$this->addOnloadCommand('generalDay.sales();');
$this->addOnloadCommand('generalDay.members();');
}
return parent::preprocess();
}
public function report_description_content()
{
if ($this->report_format == 'html') {
return array(
"<br /><label><input type=\"checkbox\" checked class=\"hidden-print\"
onchange=\"if (this.checked) \$('canvas').show(); else \$('canvas').hide();\" />
Show Charts</label>",
"<br /><label><input type=\"checkbox\" checked class=\"hidden-print\"
onchange=\"if (this.checked) \$('table').show(); else \$('table').hide();\" />
Show Tables</label>",
);
}
return array();
}
function fetch_report_data()
{
global $FANNIE_OP_DB, $FANNIE_ARCHIVE_DB, $FANNIE_EQUITY_DEPARTMENTS,
$FANNIE_COOP_ID;
$dbc = $this->connection;
$dbc->selectDB($this->config->get('OP_DB'));
$d1 = $this->form->date;
$dates = array($d1.' 00:00:00',$d1.' 23:59:59');
$store = FormLib::get('store');
$dates[] = $store;
$data = array();
if ( isset($FANNIE_COOP_ID) && $FANNIE_COOP_ID == 'WEFC_Toronto' )
$shrinkageUsers = " AND d.card_no not between 99900 and 99998";
else
$shrinkageUsers = "";
$reconciliation = array(
'Tenders' => 0.0,
'Sales' => 0.0,
'Discounts' => 0.0,
'Tax' => 0.0,
);
$dlog = DTransactionsModel::selectDlog($d1);
$tenderQ = $dbc->prepare("SELECT
TenderName,count(d.total),sum(d.total) as total
FROM $dlog as d,
{$FANNIE_OP_DB}.tenders as t
WHERE d.tdate BETWEEN ? AND ?
AND " . DTrans::isStoreID($store, 'd') . "
AND d.trans_subtype = t.TenderCode
AND d.total <> 0{$shrinkageUsers}
GROUP BY t.TenderName ORDER BY TenderName");
$tenderR = $dbc->execute($tenderQ,$dates);
$report = array();
while($tenderW = $dbc->fetch_row($tenderR)){
$record = array($tenderW['TenderName'],$tenderW[1],
sprintf('%.2f',$tenderW['total']));
$report[] = $record;
$reconciliation['Tenders'] += $tenderW['total'];
}
$data[] = $report;
$salesQ = '';
switch (FormLib::get('sales-by')) {
case 'Department':
$salesQ = '
SELECT t.dept_name AS category,
SUM(d.quantity) AS qty,
SUM(d.total) AS total
FROM ' . $dlog . ' AS d
LEFT JOIN departments AS t ON d.department=t.dept_no
WHERE d.department <> 0
AND d.trans_type <> \'T\' ' . $shrinkageUsers . '
AND d.tdate BETWEEN ? AND ?
AND ' . DTrans::isStoreID($store, 'd') . '
GROUP BY t.dept_name
ORDER BY t.dept_name';
break;
case 'Sales Code':
$salesQ = '
SELECT t.salesCode AS category,
SUM(d.quantity) AS qty,
SUM(d.total) AS total
FROM ' . $dlog . ' AS d
LEFT JOIN departments AS t ON d.department=t.dept_no
WHERE d.department <> 0
AND d.trans_type <> \'T\' ' . $shrinkageUsers . '
AND d.tdate BETWEEN ? AND ?
AND ' . DTrans::isStoreID($store, 'd') . '
GROUP BY t.salesCode
ORDER BY t.salesCode';
break;
case 'Super Department':
default:
$salesQ = '
SELECT m.super_name AS category,
SUM(d.quantity) AS qty,
SUM(d.total) AS total
FROM ' . $dlog . ' AS d
LEFT JOIN MasterSuperDepts AS m ON d.department=m.dept_ID
WHERE d.department <> 0
AND d.trans_type <> \'T\' ' . $shrinkageUsers . '
AND d.tdate BETWEEN ? AND ?
AND ' . DTrans::isStoreID($store, 'd') . '
GROUP BY m.super_name
ORDER BY m.super_name';
break;
}
$salesP = $dbc->prepare($salesQ);
$salesR = $dbc->execute($salesP,$dates);
$report = array();
while($salesW = $dbc->fetch_row($salesR)){
$record = array($salesW['category'],
sprintf('%.2f',$salesW['qty']),
sprintf('%.2f',$salesW['total']));
$report[] = $record;
$reconciliation['Sales'] += $salesW['total'];
}
$data[] = $report;
$discQ = $dbc->prepare("SELECT m.memDesc, SUM(d.total) AS Discount,count(*)
FROM $dlog d
INNER JOIN memtype m ON d.memType = m.memtype
WHERE d.tdate BETWEEN ? AND ?
AND " . DTrans::isStoreID($store, 'd') . "
AND d.upc = 'DISCOUNT'{$shrinkageUsers}
AND total <> 0
GROUP BY m.memDesc ORDER BY m.memDesc");
$discR = $dbc->execute($discQ,$dates);
$report = array();
while($discW = $dbc->fetch_row($discR)){
$record = array($discW['memDesc'],$discW[2],sprintf('%.2f', $discW[1]));
$report[] = $record;
$reconciliation['Discounts'] += $discW['Discount'];
}
$data[] = $report;
$report = array();
$trans = DTransactionsModel::selectDTrans($d1);
$componentP = $dbc->prepare('SELECT description, rate FROM TaxRateComponents WHERE taxRateID=?');
$lineItemQ = $dbc->prepare("
SELECT MIN(description) AS description,
numflag,
SUM(regPrice) AS ttl
FROM $trans AS d
WHERE datetime BETWEEN ? AND ?
AND " . DTrans::isStoreID($store, 'd') . "
AND d.upc='TAXLINEITEM'
AND " . DTrans::isNotTesting('d') . "
GROUP BY numflag
");
$lineItemR = $dbc->execute($lineItemQ, $dates);
while ($lineItemW = $dbc->fetch_row($lineItemR)) {
$componentR = $dbc->execute($componentP, array($lineItemW['numflag']));
$baseDesc = $lineItemW['description'];
if ($dbc->numRows($componentR) > 0) {
$lineItemW['description'] .= ' - Total';
}
$comp = array();
$sum = 0;
while ($compW = $dbc->fetchRow($componentR)) {
$comp[] = $compW;
$sum += $compW['rate'];
}
$record = array(
sprintf('%s (est. owed)', $lineItemW['description']),
sprintf('%.2f', $lineItemW['ttl']),
);
$report[] = $record;
foreach ($comp as $c) {
$report[] = array(
sprintf('%s - %s (%.4f%%) (est. owed)', $baseDesc, $c['description'], $c['rate']*100),
sprintf('%.2f', $lineItemW['ttl'] * ($c['rate']/$sum)));
}
}
$taxSumQ = $dbc->prepare("SELECT sum(total) as tax_collected
FROM $dlog as d
WHERE d.tdate BETWEEN ? AND ?
AND " . DTrans::isStoreID($store, 'd') . "
AND (d.upc = 'tax'){$shrinkageUsers}
GROUP BY d.upc");
$taxR = $dbc->execute($taxSumQ,$dates);
while($taxW = $dbc->fetch_row($taxR)){
$record = array('Total Tax Collected',round($taxW['tax_collected'],2));
$report[] = $record;
$reconciliation['Tax'] = $taxW['tax_collected'];
}
$data[] = $report;
$report = array();
foreach ($reconciliation as $type => $amt) {
$report[] = array(
$type,
sprintf('%.2f', $amt),
);
}
$data[] = $report;
$transQ = $dbc->prepare("select q.trans_num,sum(q.quantity) as items,transaction_type, sum(q.total) from
(
select trans_num,card_no,quantity,total,
m.memDesc as transaction_type
from $dlog as d
left join memtype as m on d.memType = m.memtype
WHERE d.tdate BETWEEN ? AND ?
AND " . DTrans::isStoreID($store, 'd') . "
AND trans_type in ('I','D')
AND upc <> 'RRR'{$shrinkageUsers}
) as q
group by q.trans_num,q.transaction_type");
$transR = $dbc->execute($transQ,$dates);
$transinfo = array();
while($row = $dbc->fetchRow($transR)){
if (!isset($transinfo[$row[2]]))
$transinfo[$row[2]] = array(0,0.0,0.0,0.0,0.0);
$transinfo[$row[2]][0] += 1;
$transinfo[$row[2]][1] += $row[1];
$transinfo[$row[2]][3] += $row[3];
}
$tSum = 0;
$tItems = 0;
$tDollars = 0;
foreach (array_keys($transinfo) as $k) {
$transinfo[$k][2] = round($transinfo[$k][1]/$transinfo[$k][0],2);
$transinfo[$k][4] = round($transinfo[$k][3]/$transinfo[$k][0],2);
$tSum += $transinfo[$k][0];
$tItems += $transinfo[$k][1];
$tDollars += $transinfo[$k][3];
}
$report = array();
foreach($transinfo as $title => $info){
array_unshift($info,$title);
$report[] = $info;
}
$data[] = $report;
$ret = preg_match_all("/[0-9]+/",$FANNIE_EQUITY_DEPARTMENTS,$depts);
if ($ret != 0){
/* equity departments exist */
$depts = array_pop($depts);
$dlist = "(";
foreach($depts as $d){
$dates[] = $d; // add query param
$dlist .= '?,';
}
$dlist = substr($dlist,0,strlen($dlist)-1).")";
$equityQ = $dbc->prepare("SELECT d.card_no,t.dept_name, sum(total) as total
FROM $dlog as d
LEFT JOIN {$FANNIE_OP_DB}.departments as t ON d.department = t.dept_no
WHERE d.tdate BETWEEN ? AND ?
AND " . DTrans::isStoreID($store, 'd') . "
AND d.department IN $dlist{$shrinkageUsers}
GROUP BY d.card_no, t.dept_name ORDER BY d.card_no, t.dept_name");
$equityR = $dbc->execute($equityQ,$dates);
$report = array();
while($equityW = $dbc->fetch_row($equityR)){
$record = array($equityW['card_no'],$equityW['dept_name'],
sprintf('%.2f',$equityW['total']));
$report[] = $record;
}
$data[] = $report;
}
return $data;
}
function calculate_footers($data)
{
switch($this->multi_counter){
case 1:
$this->report_headers[0] = 'Tenders';
break;
case 2:
$this->report_headers[0] = 'Sales';
break;
case 3:
$this->report_headers[0] = 'Discounts';
break;
case 4:
$this->report_headers = array('Tax', 'Amount');
$sumTax = 0.0;
for ($i=0; $i<count($data)-1; $i++) {
if (!strstr($data[$i][0], ' - Total (')) continue;
$sumTax += $data[$i][1];
}
return array('Total Sales Tax', sprintf('%.2f', $sumTax));
break;
case 5:
$this->report_headers = array('Reconcile Totals', 'Amount');
$ttl = 0.0;
foreach ($data as $row) {
$ttl += $row[1];
}
return array('Net', sprintf('%.2f', $ttl));
case 6:
$this->report_headers = array('Type','Trans','Items','Avg. Items','Amount','Avg. Amount');
$trans = 0.0;
$items = 0.0;
$amount = 0.0;
for ($i=0; $i<count($data); $i++) {
$trans += $data[$i][1];
$items += $data[$i][2];
$amount += $data[$i][4];
}
return array('Totals', $trans, sprintf('%.2f', $items), sprintf('%.2f', $items/$trans), sprintf('%.2f', $amount), sprintf('%.2f', $amount/$trans));
break;
case 7:
$this->report_headers = array('Mem#','Equity Type', 'Amount');
$sumSales = 0.0;
foreach ($data as $row) {
$sumSales += $row[2];
}
return array(null,null,$sumSales);
break;
}
$sumQty = 0.0;
$sumSales = 0.0;
foreach($data as $row){
$sumQty += $row[1];
$sumSales += $row[2];
}
return array(null,$sumQty,$sumSales);
}
function form_content()
{
$store = FormLib::storePicker();
return <<<HTML
<form action=GeneralDayReport.php method=get>
<div class="form-group">
<label>
Date
(<a href="../GeneralRange/">Range of Dates</a>)
</label>
<input type=text id=date name=date
class="form-control date-field" />
</div>
<div class="form-group">
<label>Store</label>
{$store['html']}
</div>
<div class="form-group">
<label>List Sales By</label>
<select name="sales-by" class="form-control">
<option>Super Department</option>
<option>Department</option>
<option>Sales Code</option>
</select>
</div>
<div class="form-group">
<label>Excel <input type=checkbox name=excel /></label>
</div>
<p>
<button type=submit name=submit value="Submit"
class="btn btn-default">Submit</button>
</p>
</form>
HTML;
}
public function helpContent()
{
return '<p>
This report lists the four major categories of transaction
information for a given day: tenders, sales, discounts, and
taxes.
</p>
<p>
Tenders are payments given by customers such as cash or
credit cards. Sales are items sold to customers. Discounts
are percentage discounts associated with an entire
transaction instead of individual items. Taxes are sales
tax collected.
</p>
<p>
Tenders should equal sales minus discounts plus taxes.
</p>
<p>
Equity and transaction statistics are provided as generally
useful information.
</p>';
}
}
FannieDispatch::conditionalExec(false);