Brendt\Stitcher\Adapter\OrderAdapter

Complexity

Total Complexity

6

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	transformPage()	0	29	4
A	validateConfig()	0	5	2

<?php

namespace Brendt\Stitcher\Adapter;

use Brendt\Stitcher\Exception\ConfigurationException;
use Brendt\Stitcher\Factory\AdapterFactory;
use Brendt\Stitcher\Site\Page;

/**
 * Order a collection of variables by a specified field.
 *
 * Sample configuration:
 *
 *  /examples:
 *      template: examples/detail
 *      data:
 *          example: collection.yml
 *      adapters:
 *          order:
 *              variableName:
 *                  field: id
 *                  direction: desc
 */
class OrderAdapter extends AbstractAdapter
{

    /**
     * A collection of keywords which would reverse the data set.
     *
     * @var array
     */
    const REVERSE = [
        'desc',
        'DESC',
        '-',
    ];

    /**
     * @param Page        $page
     * @param string|null $filter
     *
     * @return Page[]
     */
    public function transformPage(Page $page, $filter = null) : array {
        $config = $page->getAdapterConfig(AdapterFactory::ORDER_ADAPTER);
        $config = isset($config['variable']) ? [$config['variable'] => $config] : $config;

        foreach ($config as $variable => $order) {
            $this->validateConfig($order);

It seems like $order defined by $order on line 48 can also be of type null; however, Brendt\Stitcher\Adapter\OrderAdapter::validateConfig() does only seem to accept array, maybe add an additional type check?

            $field = $order['field'];
            $direction = $order['direction'] ?? null;

            $entries = $this->getData($page->getVariable($variable));

            uasort($entries, function ($a, $b) use ($field) {
                return strcmp($a[$field], $b[$field]);
            });

            if (in_array($direction, self::REVERSE)) {
                $entries = array_reverse($entries, true);
            }

            $page->setVariableValue($variable, $entries)
                ->setVariableIsParsed($variable);
        }

        /** @var Page[] $result */
        $result = [$page->getId() => $page];

        return $result;
    }

    /**
     * @param array $config
     *
     * @throws ConfigurationException
     */
    private function validateConfig(array $config) {
        if (!isset($config['field'])) {
            throw ConfigurationException::requiredAdapterOptions(AdapterFactory::ORDER_ADAPTER, 'field');
        }
    }
}