Model/Group.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';

// }}}
// {{{ class FF_Model_Group

// }}}
class FF_Model_Group extends FF_Model {
    // {{{ properties

    var $name;
    
    var $description;

    var $categoryId;

    var $storeId;

    var $shopperViewable = true;

    var $isKit = false;

    var $items = array();

    var $itemsToRemove = array();

    var $rules = array();

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

    function save($in_isUpdate)
    {
        $o_result =& parent::save($in_isUpdate);
            
        // Handle items that were set to be removed and rules
        if ($o_result->isSuccess()) {
            $tmp_result =& $this->removeItems();
            if (!$tmp_result->isSuccess()) {
                $o_result->addMessage($tmp_result->getMessages());
            }

            $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());
            }

            $this->o_dataAccess->updateRelationships($this->getId(), $this->getAllItems());
        }

        return $o_result;
    }

    // }}}
    // {{{ remove()

    /* Removes the current model or the one specified
     *
     * @param int $in_id (optional) The id to delete.  If not specified then the
     *            current id is used
     *
     * @access public
     * @return object A result object 
     */
    function remove($in_id = null)
    {
        $s_id = $in_id ? $in_id : $this->getId();
        $o_result =& parent::remove($in_id);
        $this->o_dataAccess->updateRelationships($s_id, array());
        return $o_result;
    }

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

    function reset()
    {
        $this->id = null;
        $this->name = null;
        $this->description = null;
        $this->categoryId = null;
        $this->shopperViewable = true;
        $this->isKit = false;
        $this->items = array();
        $this->itemsToRemove = array();
    }

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

    function importFromArray($in_data)
    {
        $this->setId($in_data['id']);
        $this->setName($in_data['name']);
        $this->setDescription($in_data['description']);
        $this->setCategoryId($in_data['category_id']);
        $this->setShopperViewable($in_data['shopper_viewable']);
        $this->setIsKit($in_data['is_kit']);
        $this->setStoreId($in_data['store_id']);
        if (isset($in_data['items'])) {
            $this->items = $in_data['items'];
        }

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

        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['store_id'] = $this->getStoreId();
        $a_data['shopper_viewable'] = $this->getShopperViewable();
        $a_data['is_kit'] = $this->getIsKit();
        $a_data['items'] = $this->items;
        $a_data['itemsToRemove'] = $this->itemsToRemove;
        $a_data['rules'] = $this->getRules();
        return $a_data;
    }

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

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

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

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

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

    // }}}
    // {{{ getIsKit()

    function getIsKit()
    {
        return $this->isKit;
    }

    // }}}
    // {{{ setIsKit()

    function setIsKit($in_value)
    {
        $this->isKit = $this->_scalarToBool($in_value);
    }

    // }}}
    // {{{ setItemsByBarcode()

    function setItemsByBarcode($in_barcodes)
    {
        if (!FastFrame::isEmpty($in_barcodes, false)) {
            require_once dirname(__FILE__) . '/Item.php';
            $o_itemModel =& new FF_Model_Item();
            $a_barcodes = preg_split('/\s/', $in_barcodes, -1, PREG_SPLIT_NO_EMPTY);
            foreach ($a_barcodes as $s_barcode) {
                $this->setItem($o_itemModel->getItemIdByBarcode($s_barcode), $s_barcode);
            }
        }
    }

    // }}}
    // {{{ getBarcodeList()

    function getBarcodeList()
    {
        $s_items = '';
        foreach ($this->getLoadedItems() as $a_item) {
            if (!is_null($a_item['barcode'])) {
                $s_items .= $a_item['barcode'] . ' ';
            }
        }

        return $s_items;
    }

    // }}}
    // {{{ setItemsToRemove()

    function setItemsToRemove($in_items)
    {
        $this->itemsToRemove = (array) $in_items;
    }

    // }}}
    // {{{ getItemsToRemove()

    function getItemsToRemove()
    {
        return $this->itemsToRemove;
    }

    // }}}
    // {{{ removeItems()

    function removeItems()
    {
        $o_result = new FF_Result();
        $a_items = $this->getItemsToRemove();
        foreach (array_keys($a_items) as $s_key) {
            foreach (array_keys($a_items[$s_key]) as $s_itemId) {
                $this->o_dataAccess->removeItem($this->getId(), $s_itemId, $o_result);
            }
        }

        return $o_result;
    }

    // }}}
    // {{{ getAllItems()

    function getAllItems()
    {
        if (!FastFrame::isEmpty($this->id)) {
            return $this->o_dataAccess->getGroupItems($this->getId());
        }
        else {
            return array();
        }
    }

    // }}}
    // {{{ getLoadedItems()

    function getLoadedItems()
    {
        return $this->items;
    }

    // }}}
    // {{{ getItem()

    function getItem($in_id)
    {
        return isset($this->items[$in_id]) ? $this->items[$in_id] : '';
    }

    // }}}
    // {{{ setItem()

    function setItem($in_itemId, $in_barcode = null)
    {
        $this->items[] = array('itemId' => $in_itemId, 'barcode' => $in_barcode);
    }

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

    // }}}
}
?>

---