sunnysideup / silverstripe-ecommerce

code/control/CartResponse.php

<?php

/**
 * @description: returns the cart as JSON
 *
 * @authors: Nicolaas [at] Sunny Side Up .co.nz
 * @package: ecommerce
 * @sub-package: control
 * @inspiration: Silverstripe Ltd, Jeremy
 **/
class CartResponse extends EcommerceResponse
{
    /**
     * Should the page be reloaded rather than using AJAX?
     *
     * @var bool
     */
    private static $force_reload = false;

    /**
     * Should the page be reloaded rather than using AJAX?
     *
     * @var bool
     */
    protected $includeHeaders = true;

    /**
     * Sets the $force_reload to true;.
     */
    public static function set_force_reload()
    {
        self::$force_reload = true;
    }

    /**
     * turn the json headers on or off...
     * useful if you want to use the json data
     * but not the associated header.
     *
     * @param bool
     */
    public function setIncludeHeaders($b)
    {
        $this->includeHeaders = $b;
    }

    /**
     * Builds json object to be returned via ajax.
     *
     * @param array  $message        (Type, Message)

There is no parameter named $message. Did you maybe mean $messages?

     * @param array  $additionalData

Should the type for parameter $additionalData not be null|array?

     * @param string $status
     *
     * @return HEADER + JSON

Should the return type not be string?

     **/
    public function ReturnCartData(array $messages = array(), array $additionalData = null, $status = 'success')
    {
        //add header
        if ($this->includeHeaders) {
            $this->addHeader('Content-Type', 'application/json');
        }

        SSViewer::set_source_file_comments(false);

The method SSViewer::set_source_file_comments() has been deprecated with message: 4.0 Use the "SSViewer.source_file_comments" config setting instead

        //merge messages
        $messagesImploded = '';
        if (is_array($messages) && count($messages)) {
            foreach ($messages as $messageArray) {
                $messagesImploded .= '<span class="'.$messageArray['Type'].'">'.$messageArray['Message'].'</span>';
            }
        }

        //bad status
        if ($status != 'success') {
            $this->setStatusCode(400, $messagesImploded);
        }

        //init Order - IMPORTANT
        $currentOrder = ShoppingCart::current_order();

        //THIS LINE TAKES UP MOST OF THE TIME OF THE RESPONSE!!!
        $currentOrder->calculateOrderAttributes($force = false);

        $ajaxObject = $currentOrder->AJAXDefinitions();
        // populate Javascript
        $js = array();

        //must be first
        if (isset($_REQUEST['loadingindex'])) {
            $js[] = array(
                't' => 'loadingindex',
                'v' => $_REQUEST['loadingindex'],
            );
        }

        //order items

        $inCartArray = array();
        $items = $currentOrder->Items();
        if ($items->count()) {
            foreach ($items as $item) {
                $js = $item->updateForAjax($js);
                $buyable = $item->Buyable(true);
                if ($buyable) {
                    //products in cart
                    $inCartArray[] = $buyable->AJAXDefinitions()->UniqueIdentifier();
                    //HACK TO INCLUDE PRODUCT IN PRODUCT VARIATION
                    if (is_a($buyable, 'ProductVariation')) {
                        $inCartArray[] = $buyable->Product()->AJAXDefinitions()->UniqueIdentifier();
                    }
                }
            }
        }

        //in cart items
        $js[] = array(
            't' => 'replaceclass',
            's' => $inCartArray,
            'p' => $currentOrder->AJAXDefinitions()->ProductListItemClassName(),
            'v' => $currentOrder->AJAXDefinitions()->ProductListItemInCartClassName(),
            'without' => $currentOrder->AJAXDefinitions()->ProductListItemNotInCartClassName(),
        );

        //order modifiers
        $modifiers = $currentOrder->Modifiers();
        if ($modifiers->count()) {
            foreach ($modifiers as $modifier) {
                $js = $modifier->updateForAjax($js);
            }
        }

        //order
        $js = $currentOrder->updateForAjax($js);

        //messages
        if (is_array($messages)) {
            $js[] = array(
                't' => 'id',
                's' => $ajaxObject->TableMessageID(),
                'p' => 'innerHTML',
                'v' => $messagesImploded,
                'isOrderMessage' => true,
            );
            $js[] = array(
                't' => 'id',
                's' => $ajaxObject->TableMessageID(),
                'p' => 'hide',
                'v' => 0,
            );
        } else {
            $js[] = array(
                't' => 'id',
                's' => $ajaxObject->TableMessageID(),
                'p' => 'hide',
                'v' => 1,
            );
        }

        //TO DO: set it up in such a way that it specifically requests one of these
        $templates = EcommerceConfig::get('CartResponse', 'cart_responses_required');
        foreach ($templates as $idMethod => $template) {

The expression $templates of type array|integer|double|string|boolean is not guaranteed to be traversable. How about adding an additional type check?

            $selector = $ajaxObject->$idMethod();
            $classOrID = 'id';
            if (stripos($selector, 'class') !== false) {
                $classOrID = 'class';
            }
            $js[] = array(
                't' => $classOrID,
                's' => $selector,
                'p' => 'innerHTML',
                //note the space is a hack to return something!
                'v' => ' '.$currentOrder->renderWith($template),
            );
        }
        //now can check if it needs to be reloaded
        if (self::$force_reload) {
            $js = array(
                'reload' => 1,
            );
        } else {
            $js[] = array(
                'reload' => 0,
            );
        }

        //merge and return
        if (is_array($additionalData) && count($additionalData)) {
            $js = array_merge($js, $additionalData);
        }
        //TODO: remove doubles?
        //turn HTMLText (et al.) objects into text
        foreach ($js as $key => $node) {
            if (isset($node['v'])) {
                if ($node['v'] instanceof DBField) {
                    $js[$key]['v'] = $node['v']->forTemplate();
                }
            }
        }
        $json = json_encode($js);
        $json = str_replace('\t', ' ', $json);
        $json = str_replace('\r', ' ', $json);
        $json = str_replace('\n', ' ', $json);
        $json = preg_replace('/\s\s+/', ' ', $json);
        if (Director::isDev()) {
            $json = str_replace('{', "\r\n{", $json);
        }

        return $json;
    }
}