Model/OverrideCode.php

Go to the documentation of this file.

<?php
// {{{ license

// +----------------------------------------------------------------------+
// | FastFrame Application Framework                                      |
// +----------------------------------------------------------------------+
// | Copyright (c) 2002-2006 The Codejanitor Group                        |
// +----------------------------------------------------------------------+
// | This source file is subject to the GNU Lesser Public License (LGPL), |
// | that is bundled with this package in the file LICENSE, and is        |
// | available at through the world-wide-web at                           |
// | http://www.fsf.org/copyleft/lesser.html                              |
// | If you did not receive a copy of the LGPL and are unable to          |
// | obtain it through the world-wide-web, you can get it by writing the  |
// | Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, |
// | MA 02111-1307, USA.                                                  |
// +----------------------------------------------------------------------+
// | Authors: Jason Rust <jrust@codejanitor.com>                          |
// +----------------------------------------------------------------------+

// }}}
// {{{ requires

require_once FASTFRAME_ROOT . 'lib/FastFrame/Model.php';

// }}}
// {{{ class FF_Model_OverrideCode

// }}}
class FF_Model_OverrideCode extends FF_Model {
    // {{{ properties

    var $code;

    var $creatorId;
    
    var $startDate;
    
    var $endDate;
    
    var $useDate;
    
    var $transactionId;
    
    var $borrowerId;

    var $o_borrowerDataAccess;

    var $multiUse;

    // }}}
    // {{{ reset()

    function reset()
    {
        $this->id = null;
        $this->code = null;
        $this->creatorId = null;
        $this->startDate = null;
        $this->endDate = null;
        $this->useDate = null;
        $this->transactionId = null;
        $this->borrowerId = null;
    }

    // }}}
    // {{{ importFromArray()

    function importFromArray($in_data)
    {
        $this->setId($in_data['id']);
        $this->setCode($in_data['code']);
        $this->setCreatorId($in_data['creator_id']);
        $this->setStartDate($in_data['start_date']);
        $this->setEndDate($in_data['end_date']);
        $this->setUseDate($in_data['use_date']);
        $this->setTransactionId($in_data['transaction_id']);
        $this->setBorrowerId($in_data['borrower_id']);
        $this->setMultiUse($in_data['multi_use']);
    }

    // }}}
    // {{{ exportToArray()

    function exportToArray()
    {
        $a_data = array();
        $a_data['id'] = $this->getId();
        $a_data['code'] = $this->getCode();
        $a_data['creator_id'] = $this->getCreatorId();
        $a_data['start_date'] = $this->getStartDate();
        $a_data['end_date'] = $this->getEndDate();
        $a_data['use_date'] = $this->getUseDate();
        $a_data['transaction_id'] = $this->getTransactionId();
        $a_data['borrower_id'] = $this->getBorrowerId();
        $a_data['multi_use'] = $this->getMultiUse();
        return $a_data;
    }

    // }}}
    // {{{ getLogEntryDescription()

    function getLogEntryDescription($in_id)
    {
        if ($this->fillById($in_id)) {
            return $this->getCode() . '(' . $this->getFormattedStartDate() . 
                ' - ' . $this->getFormattedEndDate() . ')';
        }
        else {
            return false;
        }
    }

    // }}}
    // {{{ isCodeValid()

    function isCodeValid($in_code, $in_borrowerId)
    {
        return $this->o_dataAccess->isCodeValid($in_code, $in_borrowerId);
    }

    // }}}
    // {{{ useCode()

    function useCode($in_code, $in_transactionId)
    {
        return $this->o_dataAccess->useCode($in_code, $in_transactionId);
    }

    // }}}
    // {{{ getNewCode()

    function getNewCode()
    {
        require_once FASTFRAME_ROOT . 'lib/FastFrame/Util.php';
        $o_registry =& FF_Registry::singleton();
        $s_length = $o_registry->getConfigParam('override_code/length');
        $s_chars = $o_registry->getConfigParam('override_code/characters');
        while (true) {
            $s_code = strtolower(FF_Util::getRandomString($s_length, $s_chars));
            if ($this->o_dataAccess->isDataUnique('code', $s_code, null, false)) {
                break;
            }
        }

        return $s_code;
    }

    // }}}
    // {{{ getCode()

    function getCode()
    {
        return $this->code;
    }

    // }}}
    // {{{ setCode()

    function setCode($in_value)
    {
        $this->code = $in_value;
    }

    // }}}
    // {{{ getFormattedMultiUse()

    function getFormattedMultiUse()
    {
        return $this->getMultiUse() ? _('Yes') : _('No');
    }

    // }}}
    // {{{ setMultiUse()

    function setMultiUse($in_value)
    {
        $this->multiUse = $this->_scalarToBool($in_value);
    }

    // }}}
    // {{{ getMultiUse()

    function getMultiUse()
    {
        return $this->multiUse;
    }

    // }}}
    // {{{ getCreatorName()

    function getCreatorName()
    {
        $o_profileDataAccess =& FF_DataAccess::factory('Profile', 'profile');
        return $o_profileDataAccess->getFullNameById($this->getCreatorId());
    }

    // }}}
    // {{{ getCreatorId()

    function getCreatorId()
    {
        return $this->creatorId;
    }

    // }}}
    // {{{ setCreatorId()

    function setCreatorId($in_value)
    {
        $this->creatorId = $in_value;
    }

    // }}}
    // {{{ getFormattedStartDate()

    function getFormattedStartDate()
    {
        return $this->formatTimestamp($this->getStartDate());
    }

    // }}}
    // {{{ getStartDate()

    function getStartDate()
    {
        return is_null($this->startDate) ? time() : $this->startDate;
    }

    // }}}
    // {{{ setStartDate()

    function setStartDate($in_value)
    {
        $this->startDate = $in_value;
    }

    // }}}
    // {{{ getFormattedEndDate()

    function getFormattedEndDate()
    {
        return $this->formatTimestamp($this->getEndDate());
    }

    // }}}
    // {{{ getEndDate()

    function getEndDate()
    {
        $o_registry =& FF_Registry::singleton();
        if (is_null($this->endDate)) {
            return mktime(date('H'), date('i'), 
                    date('s') + $o_registry->getConfigParam('override_code/default_duration'),
                    date('m'), date('d'), date('Y'));
        }
        else {
            return $this->endDate;
        }
    }

    // }}}
    // {{{ setEndDate()

    function setEndDate($in_value)
    {
        $this->endDate = $in_value;
    }

    // }}}
    // {{{ getFormattedUseDate()

    function getFormattedUseDate()
    {
        return $this->formatTimestamp($this->getUseDate());
    }

    // }}}
    // {{{ getUseDate()

    function getUseDate()
    {
        return $this->useDate;
    }

    // }}}
    // {{{ setUseDate()

    function setUseDate($in_value)
    {
        $this->useDate = $in_value;
    }

    // }}}
    // {{{ getTransactionId()

    function getTransactionId()
    {
        return $this->transactionId;
    }

    // }}}
    // {{{ setTransactionId()

    function setTransactionId($in_value)
    {
        $this->transactionId = $in_value;
    }

    // }}}
    // {{{ setBorrowerIdByBarcode()

    function setBorrowerIdByBarcode($in_barcode)
    {
        $o_borrowerDataAccess =& FF_DataAccess::factory('Borrower');
        $s_id = $o_borrowerDataAccess->getBorrowerIdByBarcode($in_barcode);
        // If it's a bad barcode set the id to an invalid number
        $s_id = is_null($s_id) ? -1 : $s_id;
        $this->setBorrowerId($s_id);
    }

    // }}}
    // {{{ getBorrowerName()

    function getBorrowerName()
    {
        $this->_initBorrowerDataAccess();
        $s_name = $this->o_borrowerDataAccess->getBorrowerName($this->getBorrowerId());
        return empty($s_name) ? false : $s_name ;
    }

    // }}}
    // {{{ getBorrowerId()

    function getBorrowerId()
    {
        return $this->borrowerId;
    }

    // }}}
    // {{{ setBorrowerId()

    function setBorrowerId($in_value)
    {
        $this->borrowerId = $in_value;
    }

    // }}}
    // {{{ formatTimestamp()

    function formatTimestamp($in_timestamp)
    {
        if ($in_timestamp == 0) {
            return _('N/A');
        }
        else {
            return date('m/d/Y h:i a', $in_timestamp);
        }
    }

    // }}}
    // {{{ _initBorrowerDataAccess()

    function _initBorrowerDataAccess()
    {
        if (!is_object($this->o_borrowerDataAccess)) {
            $this->o_borrowerDataAccess =& FF_DataAccess::factory('Borrower');
        }
    }

    // }}}
    // {{{ _initDataAccess()

    function _initDataAccess()
    {
        $this->o_dataAccess =& FF_DataAccess::factory('OverrideCode');
    }

    // }}}
}
?>

---