<?php
/*******************************************************************************

    Copyright 2013 Whole Foods Co-op

    This file is part of CORE-POS.

    IT CORE 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.

    IT CORE 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

*********************************************************************************/

/**
  @class HouseCouponsModel
*/
class HouseCouponsModel extends BasicModel
{

    protected $name = "houseCoupons";
    protected $preferred_db = 'op';
    protected $normalize_lanes = true;

    protected $columns = array(
    'coupID' => array('type'=>'INT', 'primary_key'=>true),
    'description' => array('type'=>'VARCHAR(30)'),
    'startDate' => array('type'=>'DATETIME'),
    'endDate' => array('type'=>'DATETIME'),
    'limit' => array('type'=>'SMALLINT'),
    'memberOnly' => array('type'=>'SMALLINT'),
    'discountType' => array('type'=>'VARCHAR(2)'),
    'discountValue' => array('type'=>'MONEY'),
    'minType' => array('type'=>'VARCHAR(2)'),
    'minValue' => array('type'=>'MONEY'),
    'department' => array('type'=>'INT'),
    'auto' => array('type'=>'TINYINT', 'default'=>0),
    'virtualOnly' => array('type'=>'TINYINT', 'default'=>0),
    'maxValue' => array('type'=>'MONEy', 'default'=>0),
    'superID' => array('type'=>'INT'),
    'summary' => array('type'=>'VARCHAR(65)'),
    'label' => array('type'=>'VARCHAR(30)'),
    'salesCode' => array('type'=>'VARCHAR(255)'),
    );

    public function doc()
    {
        return '
Use:
WFC runs custom barcoded coupons with
upc prefix 499999, then the coupon ID
(zero padded to 5 digits). There\'s a
tool in legacy for putting these together
that may eventually make it into fannie.

startDate is the first day the coupon is valid

endDate is the last day the coupon is valid

limit is the number of times the coupon can be
used in one transaction

memberOnly means the coupon can only be used
by a member (custdata.Type=\'PC\')

virtualOnly means that the coupon can only be
used if a corresponding record exists in the
houseVirtualCoupons table

minType and minValue specify how one
qualifies for the coupon - certain item(s),
purchase amount, etc

* \'Q\' must purchase at least minValue
  qualifying items (by quantity)
* \'Q+\' must purchase more than minValue
  qualifying items (by quantity)
* \'D\' must purchase at least minValue
  items from qualifying departments
  (by $ value)
* \'D+\' must purchase more than minValue
  items from qualifying departments
  (by $ value)
* \'M\' is mixed. Must purchase at least
  minValue qualifying items and at least
  one discount item
* \'$\' must puchase at least minValue
  goods (by $ value)
* \'$+\' must puchase more than minValue
  goods (by $ value)
* \'\' blank means no minimum purchase

discountType and discountValue specify
how the discount is calculated

(item related discounts)
* \'Q\' discount equals discountValue times
  unitPrice for the cheapest qualifying 
  item (essentially percent discount)
* \'P\' discount equals unitPrice minus
  discountValue for the cheapest qualifying
  item (essentially an sale price)
* \'FI\' discount equals discountValues times
  quantity for the cheapest qualifying item
  (works with by-weight items)

(department related discounts)
* \'FD\' discount equals discountValue times
  quantity for the cheapest qualifying item
* \'AD\' discount equals discountValue times
  sum(quantity) for ALL qualifying items

(other discounts)
* \'F\' discount equals discountValue
* \'%\' discountValue is a percent discount for
  all discountable items

Qualifying items are stored in houseCouponItems. Not
all coupons require entries here. Records can be
items (by UPC) or departments (by department number).
Some minimum and discount types only work with one
or the other.

houseCouponItems.coupID is the coupon ID

houseCouponItems.upc is an item UPC or a department number.

houseCouponItems.type is only relevant to the mixed (M)
minimum type. Values are:
* \'QUALIFIER\' counts as a qualifying item for mixed
* \'DISCOUNT\' counts as a discount item for mixed
* \'BOTH\' can be a qualfying item or a discount item
If not using the mixed minimum, always choose \'BOTH\'

The nuts and bolts of this are in
the UPC.php parser module (IT CORE).
        ';
    }
}

