LoanDisplay.php

Go to the documentation of this file.

<?php
// {{{ license

// +----------------------------------------------------------------------+
// | FastFrame Application Framework                                      |
// +----------------------------------------------------------------------+
// | Copyright (c) 2002-2006 The Codejanitor Loan                        |
// +----------------------------------------------------------------------+
// | 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>                          |
// | Authors: Greg Gilbert <ggilbert@codejanitor.com>                     |
// +----------------------------------------------------------------------+

// }}}
// {{{ requires

require_once FASTFRAME_ROOT . 'lib/FastFrame/Action/Display.php';

// }}}
// {{{ class FF_Action_Display_Loan 

// }}}
class FF_Action_Display_Loan extends FF_Action_Display {
    // {{{ renderDisplay()

    function renderDisplay()
    {
        if ($this->o_model->isDeleted()) {
            $this->o_output->setMessage(sprintf(_('This is a deleted %s.'), $this->getSingularText()), FASTFRAME_WARNING_MESSAGE);
        }

        require_once FASTFRAME_ROOT . '/lib/FastFrame/Output/Table.php';
        $o_table =& new FF_Output_Table('twoColumn');
        $o_table->setTableHeaderText($this->getPageName());
        $o_table->setTableHeaders($this->getTableData());
        $o_table->setAlternateRowColors(true);
        $o_table->render();
        $o_tableWidget =& $o_table->getWidgetObject();
        // Make the table header color distinct for reservations and
        // loans so it is clear what has been done
        if (FF_Request::getParam('isReceipt', 'g', false)) {
            if ($this->o_model->getType() != LOANS_TYPE_RESERVATION) {
                $this->o_output->o_tpl->assign('css', '.color2 { background-color: #6aa652; }');
            }
        }

        $this->o_output->o_tpl->append('content_middle', $o_tableWidget->fetch());
        $this->renderAdditionalLinks();
        if (FF_Request::getParam('isReceipt', 'g', false) &&
            (($this->o_model->getType() == LOANS_TYPE_RESERVATION &&
              $this->o_registry->getConfigParam('checkout/email_borrower_on_reservation')) ||
             ($this->o_model->getType() == LOANS_TYPE_LOAN &&
              $this->o_registry->getConfigParam('checkout/email_borrower_on_loan')))) {
            $this->sendConfirmationToBorrower();
        }
    }

    // }}}
    // {{{ renderAdditionalLinks()

    function renderAdditionalLinks()
    {
        $s_actionId = FF_Request::getParam('returnActionId', 'g');
        if (FF_Request::getParam('isPopup', 'g', false)) {
            $this->o_output->o_tpl->append('page_links', $this->o_output->link(
                        '#', _('Close Window'), array('onclick' => 'self.close();')));
        }
        else {
            if ($s_actionId == ACTION_LIST_BORROWER_LOANS ||
                $s_actionId == ACTION_LIST_ITEM_LOANS ||
                $s_actionId == ACTION_LIST_GROUP_LOANS) {
                $s_linkText = sprintf(_('Return to Loan History for %s'), FF_Request::getParam('objectDesc', 's'));
            }
            elseif ($s_actionId == ACTION_DISPLAY_SUMMARY) {
                $s_linkText = false;
            }
            elseif ($s_actionId == ACTION_SHOP_SUMMARY) {
                $s_linkText = _('Return to Summary');
            }
            else {
                $s_linkText = sprintf(_('Return to %s List'), $this->getSingularText());
            }

            if ($s_linkText) {
                $this->o_output->o_tpl->append('page_links', $this->o_output->link(
                            FastFrame::selfURL(array('actionId' => $s_actionId)), $s_linkText));
            }
        }

        if ((FF_Request::getParam('isReceipt', 'g', false) || 
             FF_Request::getParam('isPopup', 'g', false))) {
            $this->o_output->o_tpl->append('page_links', $this->o_output->link(
                        '#', _('Print'), array('onclick' => 'self.print();')));
        }
    }

    // }}}
    // {{{ renderSearchBox()

    function renderSearchBox()
    {
        return;
    }

    // }}}
    // {{{ getTableData()

    function getTableData($in_isEmail = false)
    {
        require_once dirname(__FILE__) . '/../Output/Checkout.php';
        $o_chkoutOutput =& new FF_Output_Checkout();
        $a_headers = array();
        if (!$in_isEmail && FF_Request::getParam('returnActionId', 'g') != ACTION_SHOP_SUMMARY) {
            $a_headers[] = array(
                    'title' => _('Borrower:'),
                    'data' => $o_chkoutOutput->getLinkedBorrower($this->o_model->getBorrowerId(), false,
                        $this->o_model->getBorrowerName()),
                    'dataIsSafe' => true,
                    );
        }
         
        if ($this->o_model->getType() == LOANS_TYPE_LOAN ||
            $this->o_model->getType() == LOANS_TYPE_RESERVATION) {
            $a_headers[] = array(
                    'title' => _('Start Date:'),
                    'data' => $this->o_model->getFormattedStartDate(),
                    );
            $a_headers[] = array(
                    'title' => _('Due Date:'),
                    'data' => $this->o_model->getFormattedDueDate(),
                    );

            $a_headers[] = array(
                    'title' => _('Processed By:'),
                    'data' => $this->o_model->getUserFullName(),
                    );
        }

        $a_headers[] = array(
                'title' => sprintf(_('%s ID:'), $this->getSingularText()),
                'data' => $this->o_model->getId(),
                );

        if ($this->o_registry->getConfigParam('checkout/use_is_complete') &&
            ($this->o_model->getType() == LOANS_TYPE_CART ||
             $this->o_model->getType() == LOANS_TYPE_RESERVATION) &&
            FF_Request::getParam('returnActionId', 'g') != ACTION_SHOP_SUMMARY &&
            !FF_Request::getParam('isReceipt', 'g', false)) {
            $a_headers[] = array(
                    'title' => _('Is Complete:'),
                    'data' => $this->_boolToString($this->o_model->getIsComplete(), $in_isEmail),
                    'dataIsSafe' => true,
                    );
        }

        if (count($a_items = $this->o_model->getAllItems()) == 0) {
            $tmp_data = sprintf(_('No Items Are In This %s'), $this->getSingularText());
            $tmp_dataStyle = 'style="font-style: italic;"';
        }
        else {
            $tmp_dataStyle = '';
            $tmp_data = '';
            $b_allReturned = true;
            $b_startedHiddenDiv = false;
            foreach ($a_items as $a_item) {
                if ($this->o_model->getType() != LOANS_TYPE_LOAN) {
                    $tmp_date = false;
                }
                elseif ($a_item['return_date'] == 0) {
                    $tmp_date = _('Not Returned');
                    $b_allReturned = false;
                }
                else {
                    $tmp_date = $this->o_model->formatTimestamp($a_item['return_date']); 
                }

                $a_item['returnDate'] = $tmp_date;
                $b_hideDetails = (FF_Request::getParam('returnActionId', 'g') == ACTION_SHOP_SUMMARY);
                // Put those items that are already returned in a div that can't be seen by default
                if (!$in_isEmail && !$b_startedHiddenDiv && $a_item['returnDate'] != 0) {
                    $b_startedHiddenDiv = true;
                    $tmp_data .= '<div style="cursor: pointer; padding: 2px; margin-top: 5px;" class="info color6" onclick="Element.toggle(\'returnedItems\');">' .  _('Click to Show Returned Items') .  '</div><div style="display: none;" id="returnedItems">';
                }

                $tmp_data .= $o_chkoutOutput->getItemTable($a_item, false, $b_hideDetails, $in_isEmail);
            }

            if ($b_startedHiddenDiv) {
                $tmp_data .= '</div>';
            }

            if ($this->o_model->getType() == LOANS_TYPE_LOAN && !FF_Request::getParam('isReceipt', 'g', false)) {
               $a_headers[] = array(
                    'title' => _('Return Status:'),
                    'data' => $b_allReturned ? _('All items have been returned.') : _('Not all items have been returned.'),
                    'dataStyle' => 'style="font-style: italic;"',
               );
            }
        }

        $a_headers[] = array(
                'title' => _('Items:'),
                'data' => $tmp_data, 
                'dataStyle' => $tmp_dataStyle, 
                'dataIsSafe' => true,
                );

        if (FF_Request::getParam('isReceipt', 'g', false) && !$in_isEmail) {
            $s_noticeKey = $this->o_model->getType() == LOANS_TYPE_LOAN ? 'loan_notice' : 'reservation_notice';
            if (!FastFrame::isEmpty($s_notice = $this->o_registry->getConfigParam("checkout/$s_noticeKey"))) {
                $a_headers[] = array(
                        'title' => _('Legal Notice:'),
                        'data' => $s_notice, 
                        'dataIsSafe' => true,
                        );
            }

            $a_headers[] = array(
                    'title' => _('Borrower Signature:'),
                    'data' => '', 
                    );
        }

        if ($this->o_perms->hasPerm('can_view_transaction_comments') &&
            !FF_Request::getParam('isReceipt', 'g', false) && !$in_isEmail) {
            require_once dirname(__FILE__) . '/../Model/Comment.php';
            $o_commentModel =& new FF_Model_Comment();
            foreach ($o_commentModel->getCommentsByTransactionId($this->o_model->getId()) as $a_data) {
                $o_commentModel->reset();
                $o_commentModel->importFromArray($a_data);
                $a_headers[] = array(
                    'title' => _('Comment:'),
                    'data' => $o_chkoutOutput->getCommentTable(array('o_comment' => &$o_commentModel), false),
                    'dataIsSafe' => true,
                    );
            }
        }

        if ($this->o_perms->hasPerm('can_view_transaction_history') &&
            !FF_Request::getParam('isReceipt', 'g', false) && !$in_isEmail) {
            $a_headers[] = array(
                    'title' => _('History:'),
                    'data' => $o_chkoutOutput->getLoanHistory($this->o_model->getId()), 
                    'dataIsSafe' => true,
                    );
        }

        return $a_headers;
    }

    // }}}
    // {{{ getSingularText()

    function getSingularText()
    {
        if ($this->o_model->getType() == LOANS_TYPE_LOAN) {
            return _('Loan');
        }
        elseif ($this->o_model->getType() == LOANS_TYPE_RESERVATION) {
            return _('Reservation');
        }
        else {
            return _('Cart');
        }
    }

    // }}}
    // {{{ getPageName()

    function getPageName()
    {
        if (FF_Request::getParam('isReceipt', 'g', false)) {
            return sprintf(_('%s Receipt'), $this->getSingularText());
        }
        else {
            return sprintf(_('%s Display'), $this->getSingularText());
        }
    }

    // }}}
    // {{{ sendConfirmationToBorrower()

    function sendConfirmationToBorrower()
    {
        $s_email = $this->o_model->getBorrowerEmail();
        if (!empty($s_email)) {
            $a_headers = array();
            $a_headers['Subject'] = sprintf(_('Your %s Confirmation'), $this->getSingularText());
            $a_headers['From'] = $this->o_registry->getConfigParam('mailer/default_from');
            $a_data = $this->getTableData(true);
            $s_body = sprintf(_('%s, below is a confirmation of your %s.'), $this->o_model->getBorrowerName(),
                    strtolower($this->getSingularText()));
            $s_body .= "\n\n";
            foreach ($a_data as $a_element) {
                $s_body .= $a_element['title'] . ' ' . $a_element['data'] . "\n";
            }

            require_once 'Mail.php';
            $o_mail =& Mail::factory($this->o_registry->getConfigParam('mailer/type'),
                    $this->o_registry->getConfigParam('mailer/params'));
            if (PEAR::isError($o_mail)) {
                return false;
            }
            else {
                return $o_mail->send($s_email, $a_headers, $s_body);
            }
        }
        else {
            return false;
        }
    }

    // }}}
    // {{{ _boolToString()

    function _boolToString($in_bool, $in_isEmail)
    {
        if ($in_isEmail) {
            return $in_bool ? _('Yes') : _('No');
        }
        else {
            return $in_bool ?
                 $this->o_output->imgTag('select.gif', 'actions', array('title' => _('Yes'))) :
                 $this->o_output->imgTag('cancel.gif', 'actions', array('title' => _('No')));
        }
    }

    // }}}
}
?>

---