fannie/item/shrink/ShrinkTool.php
<?php
/*******************************************************************************
Copyright 2013 Whole Foods Community 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
*********************************************************************************/
use COREPOS\Fannie\API\lib\Store;
require(dirname(__FILE__) . '/../../config.php');
if (!class_exists('FannieAPI')) {
include_once(__DIR__ . '/../../classlib2.0/FannieAPI.php');
}
class ShrinkTool extends FannieRESTfulPage
{
protected $header = 'Enter Shrink';
protected $title = 'Enter Shrink';
public $themed = true;
public $description = '[Shrink Entry] adds items to shrink counts. Duplicates lane functionality to allow backend entry.';
public $enable_linea = true;
private $quantity = 1;
public function preprocess()
{
$this->__routes[] = 'get<msg>';
$this->__routes[] = 'post<upc><description><department><cost><price><qty><reason>';
return parent::preprocess();
}
public function set_newReason_handler($str)
{
global $FANNIE_OP_DB;
$dbc = FannieDB::get($FANNIE_OP_DB);
$reasons = new ShrinkReasonsModel($dbc);
$reasons->description($str);
$reasons->disabled(1);
$id = $reasons->save();
return $id;
}
public function post_upc_description_department_cost_price_qty_reason_handler()
{
$recordReason = $this->reason;
$newReason = FormLib::get('reason-other-text');
if ($this->reason == 9 && $newReason != '') {
$recordReason = $this->set_newReason_handler($newReason);
}
global $FANNIE_TRANS_DB, $FANNIE_EMP_NO, $FANNIE_REGISTER_NO;
$dbc = FannieDB::get($FANNIE_TRANS_DB);
$record = DTrans::defaults();
$record['emp_no'] = $FANNIE_EMP_NO;
$record['register_no'] = $FANNIE_REGISTER_NO;
$record['trans_no'] = DTrans::getTransNo($dbc, $FANNIE_EMP_NO, $FANNIE_REGISTER_NO);
$record['trans_id'] = 1;
$record['upc'] = $this->upc;
$record['description'] = $this->description;
$record['department'] = $this->department;
$record['trans_type'] = 'I';
$record['quantity'] = $this->qty;
$record['ItemQtty'] = $this->qty;
$record['unitPrice'] = $this->price;
$record['regPrice'] = $this->price;
$record['total'] = $this->qty * $this->price;
$record['cost'] = $this->qty * $this->cost;
$record['numflag'] = $recordReason;
$record['charflag'] = strlen(FormLib::get('type')) > 0 ? strtoupper(substr(FormLib::get('type'), 0, 1)) : '';
$record['trans_status'] = 'Z';
if (FormLib::get('store', false) !== false) {
$record['store_id'] = FormLib::get('store');
if ($record['store_id'] == 50) {
$record['store_id'] = Store::getIdByIp();
}
}
$info = DTrans::parameterize($record, 'datetime', $dbc->now());
$query = 'INSERT INTO dtransactions
(' . $info['columnString'] . ')
VALUES
(' . $info['valueString'] . ')';
$prep = $dbc->prepare($query);
$result = $dbc->execute($prep, $info['arguments']);
header('Location: ' . $_SERVER['PHP_SELF'] . '?msg=1');
return false;
}
public function get_msg_handler()
{
$this->add_onload_command("showBootstrapAlert('#alert-area', 'success', 'Shrink Saved');\n");
$this->__route_stem = 'get';
return true;
}
public function get_id_handler()
{
global $FANNIE_OP_DB;
$dbc = FannieDB::get($FANNIE_OP_DB);
$upc = BarcodeLib::padUPC($this->id);
$product = new ProductsModel($dbc);
$product->upc($upc);
$product->store_id($this->config->get('STORE_ID'));
$superP = $dbc->prepare("SELECT superID FROM MasterSuperDepts WHERE dept_ID=?");
if (!$product->load()) {
if (substr($upc, 0, 3) == '002') {
$price = substr($upc, -4) / 100;
$upc = substr($upc, 0, 8) . '00000';
$product->upc($upc);
if ($product->load()) {
$this->id = $upc;
$this->description = $product->description();
$this->cost = $product->cost();
$this->price = $product->normal_price();
$this->department = $product->department();
$this->superID = $dbc->getValue($superP, array($this->department));
$this->upc = $upc;
if ($product->scale() && $product->normal_price() > 0 && $price > 0) {
$this->quantity = sprintf('%.2f', $price / $product->normal_price());
}
return true;
}
}
$this->add_onload_command("showBootstrapAlert('#alert-area', 'danger', 'Item not found');\n");
$this->__route_stem = 'get';
} else {
$this->description = $product->description();
$this->cost = $product->cost();
$this->price = $product->normal_price();
$this->department = $product->department();
$this->superID = $dbc->getValue($superP, array($this->department));
$this->upc = $upc;
}
return true;
}
private function getLossContribute($dbc)
{
$deptP = $dbc->prepare("SELECT lossContribute FROM ShrinkDefaults WHERE deptID=?");
$dDefault = $dbc->getValue($deptP, array($this->department));
if ($dDefault && $dDefault == 'L') {
return array('', 'selected', '');
} elseif ($dDefault && $dDefault == 'C') {
return array('', '', 'selected');
} elseif ($dDefault) {
return array('selected', '', '');
}
$superP = $dbc->prepare("SELECT lossContribute FROM ShrinkDefaults WHERE superID=?");
$sDefault = $dbc->getValue($superP, array($this->superID));
if ($sDefault && $sDefault == 'L') {
return array('', 'selected', '');
} elseif ($sDefault && $sDefault == 'C') {
return array('', '', 'selected');
} elseif ($sDefault) {
return array('selected', '', '');
}
return array('', 'selected', '');
}
private function getDefaultReason($dbc)
{
$deptP = $dbc->prepare("SELECT shrinkReasonID FROM ShrinkDefaults WHERE deptID=?");
$dDefault = $dbc->getValue($deptP, array($this->department));
if ($dDefault) {
return $dDefault;
}
$superP = $dbc->prepare("SELECT shrinkReasonID FROM ShrinkDefaults WHERE superID=?");
$sDefault = $dbc->getValue($superP, array($this->superID));
if ($sDefault) {
return $sDefault;
}
return 0;
}
public function get_id_view()
{
global $FANNIE_OP_DB;
$dbc = FannieDB::get($FANNIE_OP_DB);
$this->add_onload_command("\$('#qty-field').focus();\n");
$reasons = new ShrinkReasonsModel($dbc);
$reasons->disabled(0);
$default = $this->getDefaultReason($dbc);
$shrink_opts = '';
foreach ($reasons->find('description') as $reason) {
$shrink_opts .= sprintf('<option %s value="%d">%s</option>',
($default == $reason->shrinkReasonID() ? 'selected' : ''),
$reason->shrinkReasonID(), $reason->description());
}
list($choose,$loss,$contrib) = $this->getLossContribute($dbc);
$this->addOnloadCommand("\$(document).keyup(keyToType);");
$ret = <<<HTML
<script type="text/javascript">
function keyToType(e) {
var focused = $(':focus');
if (focused.attr('id') != 'reason-other-text') {
console.log(e.which);
if (e.which == 32) {
if ($('#select-type').val() == 'Loss') {
$('#select-type').val('Contribute');
} else {
$('#select-type').val('Loss');
}
}
}
}
</script>
<form method="post">
<div class="form-group">
<label>UPC</label> {{upc}} {{description}}
<input type="hidden" name="upc" value="{{upc}}" />
<input type="hidden" name="description" value="{{description}}" />
<input type="hidden" name="department" value="{{department}}" />
</div>
<div class="row">
<div class="col-sm-6">
<div class="row form-group">
<label class="col-sm-3 text-right">Unit Cost</label>
<div class="col-sm-9">
<div class="input-group">
<span class="input-group-addon">$</span>
<input type="number" name="cost" class="form-control" value="{{cost}}"
min="0" max="9999" step="0.001" />
</div>
</div>
</div>
<div class="row form-group">
<label class="col-sm-3 text-right">Quantity</label>
<div class="col-sm-9">
<input type="number" name="qty" id="qty-field" class="form-control"
value="{$this->quantity}" min="-9999" max="9999" step="0.01" required />
</div>
</div>
<div class="row form-group">
<label class="col-sm-3 text-right">Type</label>
<div class="col-sm-9">
<select name="type" required id="select-type" class="form-control">
<option value="" {$choose}>Select one...</option>
<option {$loss}>Loss</option>
<option {$contrib}>Contribute</option>
</select>
</div>
</div>
</div> <!-- end left column col-sm-6 -->
<div class="col-sm-6">
<div class="form-group row">
<label class="col-sm-3 text-right">Unit Price</label>
<div class="col-sm-9">
<div class="input-group">
<span class="input-group-addon">$</span>
<input type="number" name="price" class="form-control" value="{{price}}"
min="0" max="9999" step="0.01" />
</div>
</div>
</div>
<div class="row form-group">
<label class="col-sm-3 text-right">Reason</label>
<div class="col-sm-9">
<select name="reason" id="select-reason" class="form-control">
{{shrink_opts}}
</select>
</div>
</div>
<div class="row form-group" id="reason-other" style="display: none;">
<label class="col-sm-3 text-right">Explain <i>(Optional)</i></label>
<div class="col-sm-9">
<div class="input-group">
<input name="reason-other-text" type="text" id="reason-other-text" class="form-control" value=''>
<span class="input-group-addon" type="disabled" id="reason-other-counter">30</span>
</div>
</div>
</div>
<div class="row form-group">
<label class="col-sm-3 text-right">Store</label>
<div class="col-sm-9">
{{store_select}}
</div>
</div>
</div> <!-- end right column col-sm-6 -->
</div> <!-- end row containing two col-sm-6 columns -->
<div class="row form-group">
<div class="col-sm-2">
<button type="submit" class="btn btn-default">Enter Shrink</button>
</div>
<div class="col-sm-2">
<a href="{{PHP_SELF}}" class="btn btn-default">Go Back</a>
</div>
</div>
</form>
HTML;
$ret = str_replace('{{upc}}', $this->upc, $ret);
$ret = str_replace('{{description}}', $this->description, $ret);
$ret = str_replace('{{department}}', $this->department, $ret);
$ret = str_replace('{{price}}', $this->price, $ret);
$ret = str_replace('{{cost}}', $this->cost, $ret);
$ret = str_replace('{{shrink_opts}}', $shrink_opts, $ret);
$stores = FormLib::storePicker('store', false);
$ret = str_replace('{{store_select}}', $stores['html'], $ret);
$ret = str_replace('{{PHP_SELF}}', $_SERVER['PHP_SELF'], $ret);
return $ret;
}
public function get_view()
{
global $FANNIE_URL;
$this->addScript('../autocomplete.js');
$ws = $FANNIE_URL . 'ws/';
$this->addOnloadCommand("bindAutoComplete('#upc-field', '$ws', 'item');\n");
$this->addOnloadCommand("\$('#upc-field').focus();");
$this->addOnloadCommand("enableLinea('#upc-field');\n");
return '<form action="' . $_SERVER['PHP_SELF'] . '" method="get">
<div id="alert-area"></div>
<div class="form-group">
<label>UPC</label>
<input type="text" id="upc-field" name="id" class="form-control"
placeholder="Type UPC or description" />
</div>
<p>
<button type="submit" class="btn btn-default">Continue</button>
<a href="ShrinkEditor.php" class="btn btn-default">Edit Entries From Today</a>
</p>
</form>';
}
public function javascriptContent()
{
return <<<JAVASCRIPT
$('#select-reason').change(function(){
let option = $(this).find(":selected").text();
if (option == "OTHER") {
$('#reason-other').show();
$('#reason-other-text').focus();
}
});
$('#reason-other-text').keydown(function(e){
let length = $(this).val().length;
let counter = $('#reason-other-counter');
counter.text(30 - length)
if (length > 29 && e.keyCode !== 8) {
e.preventDefault();
}
});
JAVASCRIPT;
}
public function helpContent()
{
return '<p>
The back end tool for entering shrink. Enter a UPC,
then on the next screen specify a quantity lost
and a reason. The price and cost should be correct
but can be adjusted if needed.
</p>
<p>
Loss vs Contribute may be WFC specific. From an inventory
standpoint, the item is gone either way but if it
can be donated ("contributed") to charity that may
be relevant for tax accounting.
</p>';
}
public function unitTest($phpunit)
{
$phpunit->assertNotEquals(0, strlen($this->get_view()));
$this->id = 'foo';
$phpunit->assertEquals(true, $this->get_id_handler());
$this->id = '4011';
$phpunit->assertEquals(true, $this->get_id_handler());
//$phpunit->assertNotEquals(0, strlen($this->get_id_view()));
}
}
FannieDispatch::conditionalExec();