BorrowerForm.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/Action/Form.php';

// }}}
// {{{ class FF_Action_Form_Borrower

// }}}
class FF_Action_Form_Borrower extends FF_Action_Form {
    // {{{ renderAdditionalLinks()

    function renderAdditionalLinks()
    {
        if (FF_Request::getParam('returnActionId', 'g', false) !== false) {
            // Store it into session so it stays when the page is updated
            FF_Request::setParam('borrower_returnActionId', FF_Request::getParam('returnActionId', 'g'), 's');
        }

        $this->o_output->o_tpl->append('page_links', $this->o_output->link(
                    FastFrame::selfURL(array('actionId' => FF_Request::getParam('borrower_returnActionId', 's'))),
                    sprintf(_('Return to %s List'), $this->getSingularText())));
    }

    // }}}
    // {{{ createFormElements()

    function createFormElements()
    {
        $this->o_form->addElement('hidden', 'actionId');
        $this->o_form->addElement('hidden', 'objectId');
        $this->o_form->addElement('submit', 'submitbutton');
        $this->o_form->addElement('text', 'first_name', null, array('maxlength' => 30, 'size' => 30));
        $this->o_form->addElement('text', 'last_name', null, array('maxlength' => 30, 'size' => 30));
        $this->o_form->addElement('text', 'barcode', null, array('maxlength' => 20, 'size' => 20));
        $this->o_form->addElement('select', 'type', null, $this->o_registry->getConfigParam('borrower/types'));
        $this->o_form->addElement('text', 'email', null, array('maxlength' => 50, 'size' => 25));
        $this->o_form->addElement('textarea', 'comment', null, array('cols' => 35, 'rows' => 7));
        $this->o_form->setMaxFileSize($this->o_registry->getConfigParam('borrower/max_image_size'));
        $this->o_form->addElement('file', 'image');
        $this->o_form->addElement('checkbox', 'imageRemove');
        $this->o_form->addElement('hidden', 'profile_id');
        $this->o_form->addRule('first_name', _('First name cannot be blank.'), 'required', null, 'client');
        $this->o_form->addRule('last_name', _('Last name cannot be blank.'), 'required', null, 'client');
        $this->o_form->addRule('email', _('Invalid email address entered.'), 'email', null, 'client');
        // Create extra attribute fields
        foreach ($this->o_registry->getConfigParam('borrower/attributes') as $s_key => $s_desc) {
            $s_perm = "can_view_borrower_attrib_$s_key";
            if ($this->o_perms->hasPerm($s_perm)) {
                $this->o_form->addElement('text', $this->_getAttributeName($s_key), null, array('size' => 25));
            }
        }
    }

    // }}}
    // {{{ fillModelWithData()

    function fillModelWithData()
    {
        if (($tmp_model = FF_Request::getParam('selectedModel', 'g', false))) {
            $this->currentActionId = FF_Request::getParam('returnActionId', 's');
            $this->o_model->importFromArray(FF_Request::getParam('returnModel', 's'));
            if ($tmp_model == 'Profile') {
                $this->o_model->setProfileId(FF_Request::getParam('selectedId', 'g'));
            }

            return true;
        } 
        else {
            return parent::fillModelWithData();
        }
    }

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

    function getSingularText()
    {
        return _('Borrower');
    }

    // }}}
    // {{{ getPluralText()

    function getPluralText()
    {
        return _('Borrowers');
    }

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

    function getTableData()
    {
        $a_headers = array();
        $a_headers[] = array(
            'title' => '* ' . _('First Name'),
                        'titleStyle' => 'style="font-weight: bold;"',
            'data' => $this->o_renderer->elementToHtml('first_name'), 
        );
        $a_headers[] = array(
            'title' => '* ' . _('Last Name'),
                        'titleStyle' => 'style="font-weight: bold;"',
            'data' => $this->o_renderer->elementToHtml('last_name'), 
        );
        $o_fileCache =& FF_FileCache::singleton();
        $tmp_path = $o_fileCache->exists(array('subdir' => 'borrower_images', 'name' => $this->o_model->getId()), true) ? 
            $o_fileCache->getPath(array('subdir' => 'borrower_images', 'name' => $this->o_model->getId()), true, FASTFRAME_WEBPATH) :
            $this->o_registry->getRootFile('general/no_image.gif', 'graphics', FASTFRAME_WEBPATH);
        $a_headers[] = array(
            'title' => _('Image'),
            'data' => $this->o_output->imgTag($tmp_path, null, array('style' => 'vertical-align: top;')) .
            '<div style="margin: 5px 0px 5px 0px;">' . _('Check to Remove Current Image: ') .
            $this->o_renderer->elementToHtml('imageRemove') . '</div>' .
            $this->o_renderer->elementToHtml('image'), 
        );
        $a_headers[] = array(
            'title' => _('Barcode'),
            'data' => $this->o_renderer->elementToHtml('barcode'), 
        );
        $a_headers[] = array(
            'title' => _('Email Address'),
            'data' => $this->o_renderer->elementToHtml('email'), 
        );
        $a_headers[] = array(
            'title' => _('Type'),
            'data' => $this->o_renderer->elementToHtml('type'), 
        );
        if ($this->o_perms->hasPerm('can_edit_borrower_profile_id')) {
            $tmp_help = _('Associating a user\'s profile with this borrower will allow that user to log in and use the shopping module to make reservations of items.  Note that a user\'s profile can only be associated with one borrower.');
            $a_headers[] = array(
                'title' => sprintf(_('Associated Profile %s'), $this->o_output->getHelpLink($tmp_help)),
                'data' => $this->o_model->getProfileUsername() . ' ' . 
                    $this->o_output->imgTag('view.gif', 'actions', 
                        array('title' => _('Select a Profile'), 'name' => 'selectProfile', 'type' => 'input')),
            );
        }

        // create extra attribute fields
        foreach ($this->o_registry->getConfigParam('borrower/attributes') as $s_key => $s_desc) {
            $s_perm = "can_view_borrower_attrib_$s_key";
            if ($this->o_perms->hasPerm($s_perm)) {
                $a_headers[] = array(
                    'title' => $s_desc . ':',
                    'data' => $this->o_renderer->elementToHtml($this->_getAttributeName($s_key)), 
                );
            }
        }

        // Show comments
        require_once dirname(__FILE__) . '/../Output/Checkout.php';
        require_once dirname(__FILE__) . '/../Model/Comment.php';
        $o_chkoutOutput =& new FF_Output_Checkout();
        $o_chkoutOutput->setFormObject($this->o_form);
        $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), true)
                );
        }

        $a_headers[] = array(
            'title' => _('Add a New Comment'),
            'data' => $this->o_renderer->elementToHtml('comment'), 
        );

        return $a_headers;
    }

    // }}}
    // {{{ getFormConstants()

    function getFormConstants()
    {
        // Comment should always start out blank on success
        if (FF_Request::getParam('submitWasSuccess', 'g', false)) {
            return array_merge(parent::getFormConstants(), array('comment' => ''));
        }
        else {
            return parent::getFormConstants();
        }
    }

    // }}}
    // {{{ getFormDefaults()

    function getFormDefaults()
    {
        $a_fields = array();
        $a_fields['objectId'] = $this->o_model->getId();
        $a_fields['first_name'] = $this->o_model->getFirstName();
        $a_fields['last_name'] = $this->o_model->getLastName();
        $a_fields['barcode'] = $this->o_model->getBarcode();
        $a_fields['type'] = $this->o_model->getType();
        $a_fields['email'] = $this->o_model->getEmail();
        $a_fields['profile_id'] = $this->o_model->getProfileId();
        $a_fields['toRemove'] = $this->o_model->getCommentsToRemove(true);
        // create extra attribute fields
        foreach ($this->o_registry->getConfigParam('borrower/attributes') as $s_key => $s_desc) {
            $s_perm = "can_view_borrower_attrib_$s_key";
            if ($this->o_perms->hasPerm($s_perm)) {
                $a_fields[$this->_getAttributeName($s_key)] = $this->o_model->getAttribute($s_key);
            }
        }

        return $a_fields;
    }

    // }}}
    // {{{ checkPerms()

    function checkPerms()
    {
        switch ($this->currentActionId) {
            case ACTION_EDIT:
                if (($this->o_perms->hasPerm('can_edit_borrower'))) {
                    return true;
                }
                else {
                    $this->o_nextAction->setNextActionId(ACTION_PROBLEM);
                    $this->o_output->setMessage(_('You do not have permission to edit borrowers'), FASTFRAME_ERROR_MESSAGE);
                    return false;
                }
            break;
            case ACTION_ADD:
                if (($this->o_perms->hasPerm('can_add_borrower'))) {
                    return true;
                }
                else {
                    $this->o_nextAction->setNextActionId(ACTION_PROBLEM);
                    $this->o_output->setMessage(_('You do not have permission to add borrowers'), FASTFRAME_ERROR_MESSAGE);
                    return false;
                }
            break;
            default:
                $this->o_nextAction->setNextActionId(ACTION_PROBLEM);
                $this->o_output->setMessage(_('Could not determine the intended action'), FASTFRAME_ERROR_MESSAGE);
                return false;
            break;
        }
    }

    // }}}
    // {{{ _getAttributeName()

    function _getAttributeName($in_attr)
    {
        return 'attributes[' . $in_attr . ']';
    }

    // }}}
}
?>

---