Model/Item.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>                          |
// | Authors: Greg Gilbert <ggilbert@codejanitor.com>                     |
// +----------------------------------------------------------------------+

// }}}
// {{{ requires

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

// }}}
// {{{ constants

// The available item statuses
define('ITEM_STATUS_AVAILABLE', 'AVAILABLE');
define('ITEM_STATUS_ONLOAN', 'ONLOAN');
define('ITEM_STATUS_UNAVAILABLE', 'UNAVAILABLE');
define('ITEM_STATUS_MISSING', 'MISSING');
define('ITEM_STATUS_REPAIR', 'REPAIR');

// }}}
// {{{ class FF_Model_Item

// }}}
class FF_Model_Item extends FF_Model {
    // {{{ properties

    var $name;

    var $description;

    var $status;

    var $categoryId;
    
    var $vendorId;
    
    var $barcode;

    var $serialNum;

    var $storeId;

    var $shopperViewable = true;

    var $isGroup = false;

    var $isDeleted = false;

    var $attributes = array();

    var $newComment;

    var $commentsToRemove = array();

    var $rules = array();

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

    function save($in_isUpdate)
    {
        $o_result =& parent::save($in_isUpdate);
            
        // Handle comments and rules
        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);

            $o_rulesDataAccess =& FF_DataAccess::factory('Rule');
            $tmp_result =& $o_rulesDataAccess->updateRulesForItem($this->getId(), $this->getRules());
            if (!$tmp_result->isSuccess()) {
                $o_result->addMessage($tmp_result->getMessages());
            }
        }

        return $o_result;
    }

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

    function reset()
    {
        $this->id = null;
        $this->name = null;
        $this->description = null;
        $this->status = null;
        $this->categoryId = null;
        $this->barcode = null;
        $this->serialNum = null;
        $this->storeId = null;
        $this->shopperViewable = true;
        $this->isGroup = false;
        $this->attributes = array();
        $this->newComment = null; 
        $this->commentsToRemove = array();
        $this->rules = array();
    }

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

    function importFromArray($in_data)
    {
        $this->setId($in_data['id']);
        $this->setName($in_data['name']);
        $this->setDescription($in_data['description']);
        $this->setStatus($in_data['status']);
        $this->setSerialNum($in_data['serial_num']);
        $this->setBarcode($in_data['barcode']);
        
        if (isset($in_data['deleted'])) {
            $this->setIsDeleted($in_data['deleted']);
        }

        // Many of these aren't used on the list page
        if (isset($in_data['shopper_viewable'])) {
            $this->setShopperViewable($in_data['shopper_viewable']);
        }

        if (isset($in_data['store_id'])) {
            $this->setStoreId($in_data['store_id']);
        }

        if (isset($in_data['category_id'])) {
            $this->setCategoryId($in_data['category_id']);
        }

        if (isset($in_data['vendor_id'])) {
            $this->setVendorId($in_data['vendor_id']);
        }

        if (isset($in_data['isGroup'])) {
            $this->setIsGroup($in_data['isGroup']);
        }

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

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

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

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

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

    function exportToArray()
    {
        $a_data = array();
        $a_data['id'] = $this->getId();
        $a_data['name'] = $this->getName();
        $a_data['description'] = $this->getDescription();
        $a_data['category_id'] = $this->getCategoryId();
        $a_data['vendor_id'] = $this->getVendorId();
        $a_data['status'] = $this->getStatus();
        $a_data['barcode'] = $this->getBarcode();
        $a_data['serial_num'] = $this->getSerialNum();
        $a_data['store_id'] = $this->getStoreId();
        $a_data['shopper_viewable'] = $this->getShopperViewable();
        $a_data['isGroup'] = $this->getIsGroup();
        $a_data['attributes'] = $this->attributes;
        $a_data['newComment'] = $this->getNewComment();
        $a_data['commentsToRemove'] = $this->commentsToRemove;
        $a_data['rules'] = $this->getRules();
        return $a_data;
    }

    // }}}
    // {{{ isBarcodeUnique()

    function isBarcodeUnique($in_isUpdate)
    {
        return $this->o_dataAccess->isBarcodeUnique($this->getBarcode(), $this->getId(), $in_isUpdate);
    }

    // }}}
    // {{{ getItemIdByBarcode()

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

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

    function getLogEntryDescription($in_id)
    {
        if ($this->fillById($in_id)) {
            return $this->name . ' (' . $this->barcode . ')';
        }
        else {
            return false;
        }
    }

    // }}}
    // {{{ getMostRecentBorrower()
    
    function getMostRecentBorrower()
    {
        $o_dao =& FF_DataAccess::factory('Transaction');
        return $o_dao->getMostRecentBorrower($this->getId());
    }

    // }}}
    // {{{ setName()

    function setName($in_value)
    {
        $this->name = $in_value;
    }

    // }}}
    // {{{ getName()

    function getName()
    {
        return $this->name;
    }

    // }}}
    // {{{ getFormattedDescription()

    function getFormattedDescription()
    {
        return nl2br(htmlspecialchars($this->description));
    }

    // }}}
    // {{{ setDescription()

    function setDescription($in_value)
    {
        $this->description = $in_value;
    }

    // }}}
    // {{{ getDescription()

    function getDescription()
    {
        return $this->description;
    }

    // }}}
    // {{{ getVendorName()

    function getVendorName()
    {
        if (!FastFrame::isEmpty($this->vendorId)) {
            require_once dirname(__FILE__) . '/Vendor.php';
            $o_vendorModel =& new FF_Model_Vendor();
            if ($o_vendorModel->fillById($this->vendorId)) {
                return $o_vendorModel->getName();
            }
        }

        return _('No Vendor Selected');
    }

    // }}}
    // {{{ getVendorId()

    function getVendorId()
    {
        return $this->vendorId;
    }

    // }}}
    // {{{ setVendorId()

    function setVendorId($in_value)
    {
        $this->vendorId = $in_value;
    }

    // }}}
    // {{{ getCategoryName()

    function getCategoryName()
    {
        if (!FastFrame::isEmpty($this->categoryId)) {
            require_once dirname(__FILE__) . '/Category.php';
            $o_categoryModel =& new FF_Model_Category();
            if ($o_categoryModel->fillById($this->categoryId)) {
                return $o_categoryModel->getName();
            }
        }

        return _('No Category Selected');
    }

    // }}}
    // {{{ getCategoryId()

    function getCategoryId()
    {
        return $this->categoryId;
    }

    // }}}
    // {{{ setCategoryId()

    function setCategoryId($in_value)
    {
        $this->categoryId = $in_value;
    }

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

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

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

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

    // }}}
    // {{{ getStatusOptions()

    function getStatusOptions()
    {
        return array(
                ITEM_STATUS_AVAILABLE => _('Available'),
                ITEM_STATUS_ONLOAN => _('On Loan'), 
                ITEM_STATUS_UNAVAILABLE => _('Unavailable'),
                ITEM_STATUS_MISSING => _('Missing'), 
                ITEM_STATUS_REPAIR=>_('Repair')
            );
    }

    // }}}
    // {{{ getFormattedStatus()

    function getFormattedStatus()
    {
        if ($this->getIsGroup()) {
            return _('N/A');
        }
        else {
            $a_options = $this->getStatusOptions();
            return isset($a_options[$this->status]) ? $a_options[$this->status] : _('Invalid Status');
        }
    }

    // }}}
    // {{{ getStatus()

    function getStatus()
    {
        return $this->status;
    }

    // }}}
    // {{{ setStatus()

    function setStatus($in_value)
    {
        $this->status = $in_value;
    }

    // }}}
    // {{{ getSerialNum()

    function getSerialNum()
    {
        return $this->serialNum;
    }

    // }}}
    // {{{ setSerialNum()

    function setSerialNum($in_value)
    {
        $this->serialNum = $in_value;
    }

    // }}}
    // {{{ getShopperViewable()

    function getShopperViewable()
    {
        return $this->shopperViewable;
    }

    // }}}
    // {{{ setShopperViewable()

    function setShopperViewable($in_value)
    {
        $this->shopperViewable = $this->_scalarToBool($in_value);
    }

    // }}}
    // {{{ getStoreId()

    function getStoreId()
    {
        return $this->storeId;
    }

    // }}}
    // {{{ setStoreId()

    function setStoreId($in_value)
    {
        $this->storeId = $in_value;
    }

    // }}}
    // {{{ getFormattedIsGroup()

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

    // }}}
    // {{{ getIsGroup()

    function getIsGroup()
    {
        return $this->isGroup;
    }

    // }}}
    // {{{ setIsGroup()

    function setIsGroup($in_value)
    {
        $this->isGroup = $in_value;
    }

    // }}}
    // {{{ getIsDeleted()

    function getIsDeleted()
    {
        return $this->isDeleted;
    }

    // }}}
    // {{{ setIsDeleted()

    function setIsDeleted($in_value)
    {
        $this->isDeleted = $this->_scalarToBool($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;
    }

    // }}}
    // {{{ 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);
    }

    // }}}
    // {{{ getRuleOptions()

    function getRuleOptions()
    {
        $o_rulesDataAccess =& FF_DataAccess::factory('Rule');
        return $o_rulesDataAccess->getRuleOptions($this->getId());
    }

    // }}}
    // {{{ getRules()

    function getRules()
    {
        return $this->rules;
    }

    // }}}
    // {{{ setRules()

    function setRules($in_value)
    {
        $this->rules = $in_value;
    }

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

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

    // }}}
}
?>

---