mQueue\Controller\ActionHelper\CreateSorting

Complexity

Total Complexity

6

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	createSorting()	0	17	2
A	getSorting()	0	9	3
A	direct()	0	3	1

<?php

namespace mQueue\Controller\ActionHelper;

use Zend_Controller_Action_Helper_Abstract;

class CreateSorting extends Zend_Controller_Action_Helper_Abstract
{
    /**
     * Initialize the view for sorting based on $sortParameterName and store/retrieve values from session
     * It will look for parameter "{name}Key" and "{name}Order" in request.
     * It will add variables to the view:
     *    - sortParameterName
     *  - sortSelectedKey
     *  - sortSelectedOrder
     *
     * @param string $sortParameterName used to look for parameters in request and as key in $_SESSION
     * @param array $allowedKeys
     *
     * @return string similar to 'name DESC'
     */
    public function createSorting($sortParameterName, array $allowedKeys)
    {
        $sortOrderParameterName = $sortParameterName . 'Order';
        $key = $this->getRequest()->getParam($sortParameterName);
        $order = $this->getRequest()->getParam($sortOrderParameterName);

        $view = $this->getActionController()->view;
        $view->sortParameterName = $sortParameterName;
        $view->sortSelectedKey = $key;
        $view->sortSelectedOrder = $order;

        if (is_array($view->permanentParams)) {

Accessing permanentParams on the interface Zend_View_Interface suggest that you code against a concrete implementation. How about adding an instanceof check?

            $view->permanentParams[$sortParameterName] = $key;
            $view->permanentParams[$sortOrderParameterName] = $order;
        }

        return self::getSorting($key, $order, $allowedKeys);
    }

    /**
     * Returns a valid SQL sorting snippet
     *
     * @param string $key
     * @param string $order
     * @param array $allowedKeys
     *
     * @return string similar to 'name DESC'
     */
    private static function getSorting($key, $order, array $allowedKeys)
    {
        if (!in_array($key, $allowedKeys)) {
            $key = reset($allowedKeys);
        }

        $order = strcasecmp($order, 'desc') == 0 ? 'DESC' : 'ASC';

        return $key . ' ' . $order;
    }

    /**
     * Strategy pattern: call helper as broker method
     *
     * @param string $sortParameterName used to look for parameters in request and as key in $_SESSION
     * @param array $allowedKeys
     *
     * @return string similar to 'name DESC'
     */
    public function direct($sortParameterName, array $allowedKeys)
    {
        return $this->createSorting($sortParameterName, $allowedKeys);
    }
}