fannie/reports/DDD/DDDReport.php
<?php
/*******************************************************************************
Copyright 2014 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 DDDReport extends FannieReportPage
{
public $description = '[Shrink Reports] lists items marked as DDD/shrink at the registers.';
public $report_set = 'Shrink';
public $themed = true;
protected $title = "Fannie : DDD Report";
protected $header = "DDD Report";
protected $report_headers = array('Date','UPC','LC','Brand','Item','Dept#','Dept Name','Account#', 'Super Dept', 'Qty','Cost $','Retail $','Reason', 'Loss');
protected $required_fields = array('date1', 'date2');
protected $sort_direction = 1;
public function fetch_report_data()
{
$dbc = $this->connection;
$dbc->selectDB($this->config->get('OP_DB'));
$FANNIE_TRANS_DB = $this->config->get('TRANS_DB');
$args = array();
try {
$date1 = $this->form->date1;
$date2 = $this->form->date2;
$dtrans = DTransactionsModel::selectDTrans($date1, $date2);
$args[] = $date1 . ' 00:00:00';
$args[] = $date2 . ' 23:59:59';
} catch (Exception $ex) {
return array();
}
$store = FormLib::get('store', 0);
$args[] = $store;
$dept_where = '';
$super = FormLib::get('buyer', '');
$superTable = 'MasterSuperDepts';
$depts = FormLib::get('departments', array());
$dept1 = FormLib::get('deptStart', '');
$dept2 = FormLib::get('deptEnd', '');
$subs = FormLib::get('subdepts', array());
if ($super !== '' && $super == -2) {
$dept_where .= " AND m.superID<>0 ";
} elseif ($super !== '' && $super > -1) {
$superTable = 'superdepts';
$dept_where .= " AND m.superID=? ";
$args[] = $super;
}
if (!empty($depts)) {
list($dIN, $args) = $dbc->safeInClause($depts, $args);
$dept_where .= " AND d.department IN ({$dIN}) ";
} elseif ($dept1 && $dept2) {
$dept_where .= " AND d.department BETWEEN ? AND ? ";
$args[] = $dept1;
$args[] = $dept2;
}
if (!empty($subs)) {
list($sIN, $args) = $dbc->safeInClause($subs, $args);
$dept_where .= " AND p.subdept IN ({$sIN}) ";
}
/**
I'm using {{placeholders}}
to build the basic query, then replacing those
pieces depending on date range options
*/
$query = "SELECT
YEAR(datetime) AS year,
MONTH(datetime) AS month,
DAY(datetime) AS day,
d.upc,
MAX(COALESCE(p.brand, '')) AS brand,
d.description,
d.department,
e.dept_name,
SUM(d.cost) AS cost,
SUM(d.quantity) AS quantity,
SUM(d.total) AS total,
s.description AS shrinkReason,
MAX(" . ($superTable == 'MasterSuperDepts' ? 'm.super_name' : "''") . ") AS super_name,
MAX(e.salesCode) AS salesCode,
MAX(d.charflag) AS charflag,
MAX(u.likeCode) AS lc
FROM {$dtrans} AS d
LEFT JOIN departments AS e ON d.department=e.dept_no
LEFT JOIN ShrinkReasons AS s ON d.numflag=s.shrinkReasonID
LEFT JOIN {$superTable} AS m ON d.department=m.dept_ID
LEFT JOIN upcLike AS u ON d.upc=u.upc
" . DTrans::joinProducts('d') . "
WHERE trans_status = 'Z'
AND trans_type IN ('D', 'I')
AND emp_no <> 9999
AND register_no <> 99
AND d.upc <> '0'
AND datetime BETWEEN ? AND ?
AND " . DTrans::isStoreID($store, 'd') . "
{$dept_where}
GROUP BY
YEAR(datetime),
MONTH(datetime),
DAY(datetime),
d.upc,
d.description,
d.department,
e.dept_name,
s.description
HAVING SUM(d.quantity) > 0";
$data = array();
$prep = $dbc->prepare($query);
$result = $dbc->execute($prep, $args);
while ($row = $dbc->fetchRow($result)) {
$data[] = $this->rowToRecord($row);
}
return $data;
}
private function rowToRecord($row)
{
return array(
date('Y-m-d', mktime(0, 0, 0, $row['month'], $row['day'], $row['year'])),
$row['upc'],
$row['lc'] ? $row['lc'] : '',
$row['brand'],
$row['description'],
$row['department'],
$row['dept_name'],
$row['salesCode'],
$row['super_name'],
sprintf('%.2f', $row['quantity']),
sprintf('%.2f', $row['cost']),
sprintf('%.2f', $row['total']),
empty($row['shrinkReason']) ? 'n/a' : $row['shrinkReason'],
$row['charflag'] == 'C' ? 'No' : 'Yes',
);
}
public function calculate_footers($data)
{
$sumQty = 0.0;
$sumCost = 0.0;
$sumRetail = 0.0;
foreach($data as $row) {
$sumQty += $row[9];
$sumCost += $row[10];
$sumRetail += $row[11];
}
return array(_('Total'),
null,null,null,null,null,null,null,null,
sprintf('%s', number_format($sumQty,2)),
sprintf('$ %s', number_format($sumCost,2)),
sprintf('$ %s', number_format($sumRetail,2)),
'', null, null
);
}
public function form_content()
{
return FormLib::dateAndDepartmentForm();
}
public function helpContent()
{
return '<p>
List items marked as shrink for a given date range. In this
context, shrink is tracking losses.
</p>';
}
public function unitTest($phpunit)
{
$data = array('month'=>1, 'day'=>1, 'year'=>2000, 'upc'=>'4011',
'brand'=>'b','description'=>'test', 'department'=>1, 'dept_name'=>'test',
'salesCode'=>100, 'super_name'=>'test', 'quantity'=>1,
'cost'=>1, 'total'=>1, 'shrinkReason'=>'test', 'charflag'=>'C');
$phpunit->assertInternalType('array', $this->rowToRecord($data));
}
}
FannieDispatch::conditionalExec();