CORE-POS/IS4C

View on GitHub
fannie/classlib2.0/data/models/op/SuperDeptsModel.php

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
<?php
/*******************************************************************************

    Copyright 2014 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 SuperDeptsModel
*/
class SuperDeptsModel extends BasicModel
{

    protected $name = "superdepts";
    protected $preferred_db = 'op';

    protected $columns = array(
    'superID' => array('type'=>'INT', 'primary_key'=>true),
    'dept_ID' => array('type'=>'INT', 'primary_key'=>true),
    );

    public function doc()
    {
        return '
Depends on:
* departments (table)

Use:
Super departments contain departments. A department
may belong to multiple super departments, although
every department has one "master" super department
for the purpose of some reporting (by convention
the one with the lowest superID).

This is just an extra level of granularity to group
departments together when they\'re often all collected
        ';
    }
}