fannie/reports/MovementPrice/PriceMovementReport.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 PriceMovementReport extends FannieReportPage
{
protected $title = "Fannie : Price Movement Report";
protected $header = "Price Movement Report";
protected $report_headers = array('UPC', 'Brand', 'Desc', 'Dept#', 'Dept', 'Price', 'Qty', 'Sales');
protected $required_fields = array('date1', 'date2');
public $description = '[Movement by Price] lists item sales with a separate line for each price point. If an item was sold at more than one price in the given date range, sales from each price are listed separately.';
public $report_set = 'Movement Reports';
public function report_description_content()
{
$deptStart = FormLib::get('deptStart');
$deptEnd = FormLib::get('deptEnd');
$deptMulti = FormLib::get('departments', array());
$buyer = FormLib::get('buyer', '');
$ret = array();
if ($buyer === '') {
$ret[] = 'Department '.$deptStart.' to '.$deptEnd;
} else if ($buyer == -1) {
$ret[] = 'All Super Departments';
} else {
$ret[] = 'Super Department '.$buyer;
}
return $ret;
}
public function fetch_report_data()
{
$dbc = $this->connection;
$dbc->selectDB($this->config->get('OP_DB'));
$date1 = $this->form->date1;
$date2 = $this->form->date2;
$deptStart = FormLib::get('deptStart');
$deptEnd = FormLib::get('deptEnd');
$deptMulti = FormLib::get('departments', array());
$subs = FormLib::get('subdepts', array());
$buyer = FormLib::get('buyer', '');
$store = FormLib::get('store', 0);
// args/parameters differ with super
// vs regular department
$args = array($date1.' 00:00:00', $date2.' 23:59:59');
$where = ' 1=1 ';
if ($buyer !== '') {
if ($buyer == -2) {
$where .= ' AND s.superID != 0 ';
} elseif ($buyer != -1) {
$where .= ' AND s.superID=? ';
$args[] = $buyer;
}
}
if ($buyer != -1) {
list($conditional, $args) = DTrans::departmentClause($deptStart, $deptEnd, $deptMulti, $args);
$where .= $conditional;
}
if (count($subs) > 0) {
list($inStr, $args) = $dbc->safeInClause($subs, $args);
$where .= " AND p.subdept IN ($inStr) ";
}
$dlog = DTransactionsModel::selectDlog($date1, $date2);
$query = "
SELECT d.upc,
p.brand,
p.description,"
. DTrans::sumQuantity('d') . " AS qty,
CASE
WHEN unitPrice=0.01 THEN total
WHEN memDiscount <> 0 AND memType <> 0 THEN unitPrice - memDiscount
ELSE unitPrice
END as price,
d.department,
t.dept_name,
SUM(total) AS total
FROM $dlog AS d "
. DTrans::joinProducts('d', 'p', 'inner')
. DTrans::joinDepartments('d', 't');
// join only needed with specific buyer
if ($buyer !== '' && $buyer > -1) {
$query .= 'LEFT JOIN superdepts AS s ON d.department=s.dept_ID ';
} elseif ($buyer !== '' && $buyer == -2) {
$query .= 'LEFT JOIN MasterSuperDepts AS s ON d.department=s.dept_ID ';
}
$query .= "
WHERE tdate BETWEEN ? AND ?
AND $where
AND " . DTrans::isStoreID($store, 'd') . "
GROUP BY d.upc,p.brand,p.description,price,d.department,t.dept_name
ORDER BY d.upc";
$args[] = $store;
$prep = $dbc->prepare($query);
$result = $dbc->execute($query, $args);
$data = array();
while ($row = $dbc->fetchRow($result)) {
$data[] = $this->rowToRecord($row);
}
// bold items that sold at multiple prices
for ($i=0; $i<count($data); $i++) {
if (!isset($data[$i+1])) {
continue;
}
if ($data[$i][0] == $data[$i+1][0]) {
$data[$i]['meta'] = FannieReportPage::META_BOLD;
$data[$i+1]['meta'] = FannieReportPage::META_BOLD;
}
}
return $data;
}
private function rowToRecord($row)
{
return array(
$row['upc'],
$row['brand'],
$row['description'],
$row['department'],
$row['dept_name'],
sprintf('%.2f', $row['price']),
sprintf('%.2f', $row['qty']),
sprintf('%.2f', $row['total']),
);
}
public function calculate_footers($data)
{
if (count($data) == 0) {
return array();
}
$sum_qty = 0.0;
$sum_ttl = 0.0;
foreach($data as $row) {
$sum_qty += $row[6];
$sum_ttl += $row[7];
}
return array('Totals', null, null, null, null, null, sprintf('%.2f',$sum_qty), sprintf('%.2f',$sum_ttl));
}
public function form_content()
{
ob_start();
?>
<form method="get" action="PriceMovementReport.php" class="form-horizontal">
<div class="row">
<div class="col-sm-5">
<?php echo FormLib::standardDepartmentFields('buyer'); ?>
<div class="form-group">
<label class="control-label col-sm-4">Save to Excel
<input type=checkbox name=excel id=excel value=1>
</label>
<label class="col-sm-4 control-label">Store</label>
<div class="col-sm-4">
<?php $ret=FormLib::storePicker();echo $ret['html']; ?>
</div>
</div>
</div>
<div class="col-sm-5">
<div class="form-group">
<label class="col-sm-4 control-label">Start Date</label>
<div class="col-sm-8">
<input type=text id=date1 name=date1 class="form-control date-field" required />
</div>
</div>
<div class="form-group">
<label class="col-sm-4 control-label">End Date</label>
<div class="col-sm-8">
<input type=text id=date2 name=date2 class="form-control date-field" required />
</div>
</div>
<div class="form-group">
<?php echo FormLib::date_range_picker(); ?>
</div>
</div>
</div>
<p>
<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"
onclick="$('#super-id').val('').trigger('change');">Start Over</button>
</p>
</form>
<?php
return ob_get_clean();
}
public function helpContent()
{
return '<p>This report lists a row for each price point
each item was sold for in the given date range. Sales
totals are for all sales at a particular price during
the date range.</p>';
}
public function unitTest($phpunit)
{
$data = array('upc'=>'4011', 'brand'=>'test', 'description'=>'test',
'department'=>1, 'dept_name'=>'test', 'price'=>1.99,
'qty'=>1, 'total'=>1);
$phpunit->assertInternalType('array', $this->rowToRecord($data));
$phpunit->assertInternalType('array', $this->calculate_footers($this->dekey_array(array($data))));
}
}
FannieDispatch::conditionalExec();