ecommerce_order.inc

<?php
require_once SQ_INCLUDE_PATH.'/asset.inc';

define('SQ_ECOM_ORDER_STATUS_PROCESSING', 0);
define('SQ_ECOM_ORDER_STATUS_SUCCESS', 1);
define('SQ_ECOM_ORDER_STATUS_FAILED', 2);


class Ecommerce_Order extends Asset
{


    function Ecommerce_Order($assetid=0)
    {
        $this->_ser_attrs = true;
        $this->Asset($assetid);

    }//end constructor


    function _createAdditional(&$link)
    {
        if (!parent::_createAdditional($link)) return false;

        // set an initial web path
        $initial_path = $this->id;
        require_once SQ_INCLUDE_PATH.'/general_occasional.inc';
        $valid_paths = make_valid_web_paths(Array($initial_path));
        $good_paths = $GLOBALS['SQ_SYSTEM']->am->webPathsInUse($link['asset'], $valid_paths, $this->id, true);
        return $this->saveWebPaths($good_paths);

    }//end _createAdditional()


    function _getAllowedLinks()
    {
        $allowed_links = parent::_getAllowedLinks();
        $allowed_links[SQ_LINK_NOTICE]['product'] = Array('card' => 'M', 'exclusive' => false);

        return $allowed_links;

    }//end _getAllowedLinks()


    function create(&$link)
    {
        return parent::create($link);

    }//end create()


    function setAttrValue($name, $value)
    {
        switch ($name) {
            case 'products':
                $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
                $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');

                $this->_linkProducts($value);

                $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
                $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
            break;
        }
        return parent::setAttrValue($name, $value);

    }//end setAttrValue()


    function _linkProducts($products)
    {
        if (empty($products)) {
            trigger_localised_error('ECOM0014', E_USER_WARNING);
            return false;
        }

        // set run level
        $run_level_changed = false;
        if (!$GLOBALS['SQ_SYSTEM']->runLevelEnables(SQ_RUN_LEVEL_FORCED)) {
            $GLOBALS['SQ_SYSTEM']->setRunLevel(SQ_RUN_LEVEL_FORCED);
            $run_level_changed = true;
        }

        // add items
        $success = true;
        foreach ($products as $id => $value) {
            // put notice link
            $product = $GLOBALS['SQ_SYSTEM']->am->getAsset($id);

            if ($GLOBALS['SQ_SYSTEM']->am->createAssetLink($this, $product, SQ_LINK_NOTICE) == 0) {
                trigger_localised_error('ECOM0019', E_USER_WARNING);
                $success = false;
            }
            $GLOBALS['SQ_SYSTEM']->am->forgetAsset($product);
        }

        // reset run level to old value
        if ($run_level_changed) {
            $GLOBALS['SQ_SYSTEM']->restoreRunLevel();
        }

        return $success;

    }//end _linkProducts()


    function setOrderStatus($status, $message='')
    {
        // set status
        if (is_numeric($status)) {

            switch ($status) {
                case SQ_ECOM_ORDER_STATUS_PROCESSING :
                    $new_status = SQ_ECOM_ORDER_STATUS_PROCESSING;
                    if (empty($message)) {
                        $status_message = translate('ecom_order_status_processing');
                    } else {
                        $status_message = $message;
                    }
                break;
                case SQ_ECOM_ORDER_STATUS_SUCCESS :
                    $new_status = SQ_ECOM_ORDER_STATUS_SUCCESS;
                    $status_message = translate('ecom_order_status_success');
                break;
                case SQ_ECOM_ORDER_STATUS_FAILED :
                    $new_status = SQ_ECOM_ORDER_STATUS_FAILED;
                    $status_message = translate('ecom_order_status_failed');
                break;
                default:
                    return false;
                break;
            }

            $success = true;

            $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
            $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');

            // set runlevel
            $GLOBALS['SQ_SYSTEM']->setRunLevel(SQ_RUN_LEVEL_FORCED);

            // set status
            $this->setAttrValue('status', $new_status);

            // set status message
            if (!empty($status_message)) {
                $this->setAttrValue('status_message', $status_message);
            } else {
                $success = false;
            }

            // save attributes
            if (!$GLOBALS['SQ_SYSTEM']->am->acquireLock($this->id, 'attributes')) {
                $success = false;
            } else if (!$this->saveAttributes()) {
                $success = false;
            }
            $GLOBALS['SQ_SYSTEM']->am->releaseLock($this->id, 'attributes');

            // restore runlevel
            $GLOBALS['SQ_SYSTEM']->restoreRunLevel();

            if ($success) {
                $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
            } else {
                $GLOBALS['SQ_SYSTEM']->doTransaction('ROLLBACK');
            }

            $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
            return $success;

        } else {
            return false;
        }

    }//end setOrderStatus()


    function getOrderStatus()
    {
        $result = Array(
                    'status'            => $this->attr('status'),
                    'status_message'    => $this->attr('status_message'),
                  );

        return $result;

    }//end getOrderStatus()


//--        KEYWORDS        --//


    function getAvailableKeywords()
    {
        $keywords = parent::getAvailableKeywords();

        $keywords['checkout_assetid']   = translate('ecom_order_keyword_checkout_assetid');
        $keywords['order_summary']      = translate('ecom_order_keyword_order_summary');
        $keywords['status']             = translate('ecom_order_keyword_status');
        $keywords['status_message']     = translate('ecom_order_keyword_status_message');
        $keywords['edit_url']           = translate('ecom_order_keyword_edit_url');
        $keywords['order_xml']          = translate('ecom_order_keyword_order_xml');
        $keywords['order_grand_total']  = translate('ecom_order_keyword_order_grand_total');
        
        return $keywords;

    }//end getAvailableKeywords()


    function _getCheckoutAssetId()
    {
        if (!isset($this->_tmp['checkout_asset'])) {
            $link_to_checkout = $GLOBALS['SQ_SYSTEM']->am->getLink($this->id, SQ_LINK_NOTICE, 'ecommerce_checkout', true, 'checkout', 'minor');
            $this->_tmp['checkout_asset'] = array_get_index($link_to_checkout, 'majorid', 0);
        }

        return $this->_tmp['checkout_asset'];

    }//end _getCheckoutAssetId()


    function getCheckoutAssetidKeywordReplacement()
    {
        return $this->_getCheckoutAssetId();

    }//end getCheckoutAssetidKeywordReplacement()


    function getOrderSummaryKeywordReplacement()
    {
        return $this->attr('summary');

    }//end getOrderSummaryKeywordReplacement()


    function getStatusKeywordReplacement()
    {
        return $this->attr('status');

    }//end getStatusKeywordReplacement()


    function getStatusMessageKeywordReplacement()
    {
        return $this->attr('status_message');

    }//end getStatusMessageKeywordReplacement()


    function getEditUrlKeywordReplacement()
    {
        // get ecommerce checkout asset id
        $id = $this->_getCheckoutAssetId();

        // get url of checkout form and append extra variable
        $url = $GLOBALS['SQ_SYSTEM']->am->getAssetURL($id);

        $connector = '';
        if (empty($url)) {
            return '';
        } else {
            strstr($url, '?') ? $connector = '&' : $connector = '?';
        }
        $url .= $connector.'edit_order_id='.$this->id;

        return '<a href="'.$url.'">'.$url.'</a>';

    }//end getEditUrlKeywordReplacement()

    
    function getOrderXmlKeywordReplacement()
    {
        return $this->attr('order_xml');

    }//end getOrderXmlKeywordReplacement()


    function getOrderGrandTotalKeywordReplacement()
    {
        return $this->attr('order_grand_total');

    }//end getCheckoutAssetidKeywordReplacement()
    

    function &getDeliveryMethod()
    {
        $method = null;
        if ($this->attr('delivery_id') != 0) {
            $method =& $GLOBALS['SQ_SYSTEM']->am->getAsset($this->attr('delivery_id'));
        }

        return $method;

    }//end getDeliveryMethod()


    function appendAuditLog($msg)
    {
        $order_history = $this->attr('order_history');
        $index = date('r');
        while (isset($order_history[$index])) {
            $index .= ' ';
        }
        $order_history[$index] = $msg;
        $this->setAttrValue('order_history', $order_history);

        $GLOBALS['SQ_SYSTEM']->setRunLevel(SQ_RUN_LEVEL_FORCED);

            $this->saveAttributes();

        $GLOBALS['SQ_SYSTEM']->restoreRunLevel();

    }//end appendAuditLog()


}//end class

?>