<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 3.0                                                |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2009                                |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM.                                    |
|                                                                    |
| CiviCRM is free software; you can copy, modify, and distribute it  |
| under the terms of the GNU Affero General Public License           |
| Version 3, 19 November 2007.                                       |
|                                                                    |
| CiviCRM 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 Affero General Public License for more details.        |
|                                                                    |
| You should have received a copy of the GNU Affero General Public   |
| License along with this program; if not, contact CiviCRM LLC       |
| at info[AT]civicrm[DOT]org. If you have questions about the        |
| GNU Affero General Public License or the licensing of CiviCRM,     |
| see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+--------------------------------------------------------------------+
*/
/**
 *
 * @package CRM
 * @copyright CiviCRM LLC (c) 2004-2009
 * $Id$
 *
 */
require_once 'CRM/Core/DAO.php';
require_once 'CRM/Utils/Type.php';
class CRM_Grant_DAO_Grant extends CRM_Core_DAO
{
    /**
     * static instance to hold the table name
     *
     * @var string
     * @static
     */
    static $_tableName = 'civicrm_grant';
    /**
     * static instance to hold the field values
     *
     * @var array
     * @static
     */
    static $_fields = null;
    /**
     * static instance to hold the FK relationships
     *
     * @var string
     * @static
     */
    static $_links = null;
    /**
     * static instance to hold the values that can
     * be imported / apu
     *
     * @var array
     * @static
     */
    static $_import = null;
    /**
     * static instance to hold the values that can
     * be exported / apu
     *
     * @var array
     * @static
     */
    static $_export = null;
    /**
     * static value to see if we should log any modifications to
     * this table in the civicrm_log table
     *
     * @var boolean
     * @static
     */
    static $_log = false;
    /**
     * Unique Grant id
     *
     * @var int unsigned
     */
    public $id;
    /**
     * Contact ID of contact record given grant belongs to.
     *
     * @var int unsigned
     */
    public $contact_id;
    /**
     * Date on which grant application was received by donor.
     *
     * @var date
     */
    public $application_received_date;
    /**
     * Date on which grant decision was made.
     *
     * @var date
     */
    public $decision_date;
    /**
     * Date on which grant money transfer was made.
     *
     * @var date
     */
    public $money_transfer_date;
    /**
     * Date on which grant report is due.
     *
     * @var date
     */
    public $grant_due_date;
    /**
     * Yes/No field stating whether grant report was received by donor.
     *
     * @var boolean
     */
    public $grant_report_received;
    /**
     * Type of grant. Implicit FK to civicrm_option_value in grant_type option_group.
     *
     * @var int unsigned
     */
    public $grant_type_id;
    /**
     * Requested grant amount, in default currency.
     *
     * @var float
     */
    public $amount_total;
    /**
     * Requested grant amount, in original currency (optional).
     *
     * @var float
     */
    public $amount_requested;
    /**
     * Granted amount, in default currency.
     *
     * @var float
     */
    public $amount_granted;
    /**
     * Grant rationale.
     *
     * @var text
     */
    public $rationale;
    /**
     * Id of Grant status.
     *
     * @var int unsigned
     */
    public $status_id;
    /**
     * class constructor
     *
     * @access public
     * @return civicrm_grant
     */
    function __construct() 
    {
        parent::__construct();
    }
    /**
     * return foreign links
     *
     * @access public
     * @return array
     */
    function &links() 
    {
        if (!(self::$_links)) {
            self::$_links = array(
                'contact_id' => 'civicrm_contact:id',
            );
        }
        return self::$_links;
    }
    /**
     * returns all the column names of this table
     *
     * @access public
     * @return array
     */
    function &fields() 
    {
        if (!(self::$_fields)) {
            self::$_fields = array(
                'id' => array(
                    'name' => 'id',
                    'type' => CRM_Utils_Type::T_INT,
                    'required' => true,
                ) ,
                'grant_contact_id' => array(
                    'name' => 'contact_id',
                    'type' => CRM_Utils_Type::T_INT,
                    'required' => true,
                    'export' => true,
                    'where' => 'civicrm_grant.contact_id',
                    'headerPattern' => '',
                    'dataPattern' => '',
                ) ,
                'application_received_date' => array(
                    'name' => 'application_received_date',
                    'type' => CRM_Utils_Type::T_DATE,
                    'title' => ts('Application Received Date') ,
                    'export' => true,
                    'where' => 'civicrm_grant.application_received_date',
                    'headerPattern' => '',
                    'dataPattern' => '',
                ) ,
                'decision_date' => array(
                    'name' => 'decision_date',
                    'type' => CRM_Utils_Type::T_DATE,
                    'title' => ts('Decision Date') ,
                ) ,
                'money_transfer_date' => array(
                    'name' => 'money_transfer_date',
                    'type' => CRM_Utils_Type::T_DATE,
                    'title' => ts('Money Transfer Date') ,
                ) ,
                'grant_due_date' => array(
                    'name' => 'grant_due_date',
                    'type' => CRM_Utils_Type::T_DATE,
                    'title' => ts('Grant Due Date') ,
                ) ,
                'grant_report_received' => array(
                    'name' => 'grant_report_received',
                    'type' => CRM_Utils_Type::T_BOOLEAN,
                    'title' => ts('Grant Report Received') ,
                ) ,
                'grant_type_id' => array(
                    'name' => 'grant_type_id',
                    'type' => CRM_Utils_Type::T_INT,
                    'required' => true,
                    'export' => true,
                    'where' => 'civicrm_grant.grant_type_id',
                    'headerPattern' => '',
                    'dataPattern' => '',
                ) ,
                'amount_total' => array(
                    'name' => 'amount_total',
                    'type' => CRM_Utils_Type::T_MONEY,
                    'title' => ts('Amount Total') ,
                    'required' => true,
                ) ,
                'amount_requested' => array(
                    'name' => 'amount_requested',
                    'type' => CRM_Utils_Type::T_MONEY,
                    'title' => ts('Amount Requested') ,
                ) ,
                'amount_granted' => array(
                    'name' => 'amount_granted',
                    'type' => CRM_Utils_Type::T_MONEY,
                    'title' => ts('Amount Granted') ,
                ) ,
                'rationale' => array(
                    'name' => 'rationale',
                    'type' => CRM_Utils_Type::T_TEXT,
                    'title' => ts('Rationale') ,
                    'rows' => 4,
                    'cols' => 60,
                    'import' => true,
                    'where' => 'civicrm_grant.rationale',
                    'headerPattern' => '',
                    'dataPattern' => '',
                    'export' => true,
                ) ,
                'grant_status_id' => array(
                    'name' => 'status_id',
                    'type' => CRM_Utils_Type::T_INT,
                    'required' => true,
                ) ,
            );
        }
        return self::$_fields;
    }
    /**
     * returns the names of this table
     *
     * @access public
     * @return string
     */
    function getTableName() 
    {
        return self::$_tableName;
    }
    /**
     * returns if this table needs to be logged
     *
     * @access public
     * @return boolean
     */
    function getLog() 
    {
        return self::$_log;
    }
    /**
     * returns the list of fields that can be imported
     *
     * @access public
     * return array
     */
    function &import($prefix = false) 
    {
        if (!(self::$_import)) {
            self::$_import = array();
            $fields = &self::fields();
            foreach($fields as $name => $field) {
                if (CRM_Utils_Array::value('import', $field)) {
                    if ($prefix) {
                        self::$_import['grant'] = &$fields[$name];
                    } else {
                        self::$_import[$name] = &$fields[$name];
                    }
                }
            }
        }
        return self::$_import;
    }
    /**
     * returns the list of fields that can be exported
     *
     * @access public
     * return array
     */
    function &export($prefix = false) 
    {
        if (!(self::$_export)) {
            self::$_export = array();
            $fields = &self::fields();
            foreach($fields as $name => $field) {
                if (CRM_Utils_Array::value('export', $field)) {
                    if ($prefix) {
                        self::$_export['grant'] = &$fields[$name];
                    } else {
                        self::$_export[$name] = &$fields[$name];
                    }
                }
            }
        }
        return self::$_export;
    }
}
