Model/Borrower.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_Borrower

// }}}
class FF_Model_Borrower extends FF_Model {
    // {{{ properties

    var $firstName;

    var $lastName;
    
    var $barcode;

    var $type;

    var $email;
    
    var $profileId;

    var $attributes = array();

    var $demos = array();

    var $demosToRemove = array();

    var $newComment;

    var $commentsToRemove = array();

    var $o_demoDataAccess;

    // }}}
    // {{{ save()

    function save($in_isUpdate)
    {
        $o_result =& parent::save($in_isUpdate);
            
        // Handle comments
        if ($o_result->isSuccess()) {
            require_once dirname(__FILE__) . '/Comment.php';
            $o_commentModel =& new FF_Model_Comment();
            $o_commentModel->processComments($this->getId(), $this->newComment, 
                    $this->getCommentsToRemove(), $o_result);
        }

        return $o_result;
    }

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

    function reset()
    {
        $this->id = null;
        $this->firstName = null;
        $this->lastName = null;
        $this->barcode = null;
        $this->type = null;
        $this->email = null;
        $this->attributes = array();
        $this->newComment = null; 
        $this->commentsToRemove = array();
        $this->demos = array();
        $this->demosToRemove = array();
    }

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

    function importFromArray($in_data)
    {
        $this->setId($in_data['id']);
        $this->setFirstName($in_data['first_name']);
        $this->setLastName($in_data['last_name']);
        $this->setBarcode($in_data['barcode']);
        $this->setType($in_data['type']);
        $this->setEmail($in_data['email']);
        $this->setProfileId($in_data['profile_id']);
        if (isset($in_data['attributes'])) {
            $this->attributes = $in_data['attributes'];
        }

        if (isset($in_data['demos'])) {
            $this->demos = $in_data['demos'];
        }

        if (isset($in_data['demosToRemove'])) {
            $this->demosToRemove = $in_data['demosToRemove'];
        }

        if (isset($in_data['newComment'])) {
            $this->setNewComment($in_data['newComment']);
        }

        if (isset($in_data['commentsToRemove'])) {
            $this->commentsToRemove = $in_data['commentsToRemove'];
        }
    }

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

    function exportToArray()
    {
        $a_data = array();
        $a_data['id'] = $this->getId();
        $a_data['first_name'] = $this->getFirstName();
        $a_data['last_name'] = $this->getLastName();
        $a_data['barcode'] = $this->getBarcode();
        $a_data['type'] = $this->getType();
        $a_data['email'] = $this->getEmail();
        $a_data['profile_id'] = $this->getProfileId();
        $a_data['attributes'] = $this->attributes;
        $a_data['demos'] = $this->demos;
        $a_data['newComment'] = $this->getNewComment();
        $a_data['commentsToRemove'] = $this->commentsToRemove;
        return $a_data;
    }

    // }}}
    // {{{ getDataToExport()

    function &getDataToExport($in_fields, $in_limited, $in_file, $in_fieldNum)
    {
        $o_result = new FF_Result();
        // Extract the borrower list
        if ($in_limited) {
            if (!preg_match('/csv$/i', $in_file['name']) || $in_file['size'] == 0) {
                $o_result->setSuccess(false);
                $o_result->addMessage(_('You did not upload a valid CSV file'));
                return $o_result;
            }

            $handle = fopen($in_file['tmp_name'], 'r');
            $a_borrowers = array();
            while (($a_data = fgetcsv($handle, 1000, ',')) !== false) {
                $a_borrowers[] = $a_data[$in_fieldNum];
            }
        }
        else {
            $a_borrowers = array();
        }

        $o_result =& $this->o_dataAccess->getDataToExport($in_fields, $a_borrowers);
        return $o_result;
    }

    // }}}
    // {{{ getFields()

    function getFields()
    {
        $a_fields = array(
            'id' => 'Id',
            'first_name' => 'First Name',
            'last_name' => 'Last Name',
            'barcode' => 'Barcode',
            'email' => 'Email',
            'type' => 'Type');

        $o_registry = FF_Registry::singleton();
        $o_perms = FF_Perms::factory();
        foreach ($o_registry->getConfigParam('borrower/attributes') as $s_key => $s_desc) {
            $s_perm = "can_view_borrower_attrib_$s_key";
            if ($o_perms->hasPerm($s_perm)) {
                $a_fields["attrib.$s_key"] = $s_desc;
            }
        }

        return $a_fields;
    }

    // }}}
    // {{{ getNumComments()

    function getNumComments()
    {
        $o_commentDataAccess =& FF_DataAccess::factory('Comment');
        return $o_commentDataAccess->getCommentCount($this->getId());
    }

    // }}}
    // {{{ getBorrowerIdByBarcode()

    function getBorrowerIdByBarcode( $in_barcode)
    {
        return $this->o_dataAccess->getBorrowerIdByBarcode($in_barcode);
    }

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

    function getBorrowerName()
    {
        $s_name = $this->o_dataAccess->getBorrowerName($this->getId());
        return empty($s_name) ? false : $s_name;
    }

    // }}}
    // {{{ getFirstName()

    function getFirstName()
    {
        return $this->firstName;
    }

    // }}}
    // {{{ setFirstName()

    function setFirstName($in_value)
    {
        $this->firstName = $in_value;
    }

    // }}}
    // {{{ getLastName()

    function getLastName()
    {
        return $this->lastName;
    }

    // }}}
    // {{{ setLastName()

    function setLastName($in_value)
    {
        $this->lastName = $in_value;
    }

    // }}}
    // {{{ getBarcode()

    function getBarcode()
    {
        return $this->barcode;
    }

    // }}}
    // {{{ setBarcode()

    function setBarcode($in_value)
    {
        $this->barcode = $in_value;
    }

    // }}}
    // {{{ getFormattedType()

    function getFormattedType()
    {
        $o_registry =& FF_Registry::singleton();
        $a_types = $o_registry->getConfigParam('borrower/types', array());
        if (isset($a_types[$this->getType()])) {
            return $a_types[$this->getType()];
        }
        else {
            return _('Unknown Type');
        }
    }

    // }}}
    // {{{ getType()

    function getType()
    {
        return $this->type;
    }

    // }}}
    // {{{ setType()

    function setType($in_value)
    {
        $this->type = $in_value;
    }

    // }}}
    // {{{ getEmail()

    function getEmail()
    {
        return $this->email;
    }

    // }}}
    // {{{ setEmail()

    function setEmail($in_value)
    {
        $this->email = $in_value;
    }

    // }}}
    // {{{ getProfileUsername()

    function getProfileUsername()
    {
        $o_profileDataAccess =& FF_DataAccess::factory('Profile', 'profile');
        if ($this->getProfileId() == 0) {
            return _('No Profile Associated');
        }
        else {
            return $o_profileDataAccess->getUsernameById($this->getProfileId());
        }
    }

    // }}}
    // {{{ isProfileIdUnique()

    function isProfileIdUnique($in_isUpdate)
    {
        return $this->o_dataAccess->isProfileIdUnique($this->getProfileId(), $this->getId(), $in_isUpdate);
    }

    // }}}
    // {{{ getIdByProfileId()

    function getIdByProfileId($in_profileId)
    {
        $s_id = $this->o_dataAccess->getIdByProfileId($in_profileId);
        return empty($s_id) ? false : $s_id;
    }

    // }}}
    // {{{ getProfileId()

    function getProfileId()
    {
        return $this->profileId;
    }

    // }}}
    // {{{ setProfileId()

    function setProfileId($in_value)
    {
        $this->profileId = $in_value;
    }

    // }}}
    // {{{ getAttribute()

    function getAttribute($in_attr)
    {
        return isset($this->attributes[$in_attr]) ? $this->attributes[$in_attr] : null;
    }

    // }}}
    // {{{ setAttribute()

    function setAttribute($in_attr, $in_value)
    {
        $this->attributes[$in_attr] = $in_value;
    }

    // }}}
    // {{{ getAllDemos()

    function getAllDemos()
    {
        if (!$this->getId()) {
            return array();
        }

        return $this->o_demoDataAccess->getDemosByBorrowerId($this->getId());
    }

    // }}}
    // {{{ addDemo()

    function addDemo($in_demoId)
    {
        if (!FastFrame::isEmpty($in_demoId, false)) {
            $this->comments[$s_id] = $in_comment;
        }
    }

    // }}}
    // {{{ removeDemo()

    function removeDemo($in_demoId)
    {
        if (!FastFrame::isEmpty($in_demoId, false)) {
            $this->commentsToRemove[] = $in_demoId;
        }
    }

    // }}}
    // {{{ removeComments()

    function removeDemos()
    {
        $o_result = new FF_Result();
        foreach ($this->demosToRemove as $s_id) {
            $tmp_result =& $this->o_dataAccess->removeDemo($this->getId(),$s_id);
            if (!$tmp_result->isSuccess()) {
                $o_result->addMessage($tmp_result->getMessages());
                $o_result->setSuccess(false);
            }
        }

        return $o_result;
    }

    // }}}
    // {{{ getNewComment()

    function getNewComment()
    {
        return $this->newComment;
    }

    // }}}
    // {{{ setNewComment()

    function setNewComment($in_comment)
    {
        $this->newComment = $in_comment;
    }

    // }}}
    // {{{ getCommentsToRemove()

    function getCommentsToRemove($in_formize = false)
    {
        $a_comments = $this->commentsToRemove;
        if ($in_formize) {
            foreach ($a_comments as $s_key => $s_val) {
                unset($a_comments[$s_key]);
                $a_comments['comments'][$s_val] = 1;
            }
        }

        return $a_comments;
    }

    // }}}
    // {{{ setCommentsToRemove()

    function setCommentsToRemove($in_comments)
    {
        $this->commentsToRemove = array_keys((array) $in_comments);
    }

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

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

    // }}}
}
?>

---