Brendt\Stitcher\Adapter\OrderAdapter

Complexity

Total Complexity

6

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	validateConfig()	0	5	3
B	transformPage()	0	26	3

<?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:
 *              variable: example
 *              field: id
 *              direction: desc
 */
class OrderAdapter extends AbstractAdapter
{

    /**
     * A collection of keywords which would reverse the data set.
     *
     * @var array
     */
    private static $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);

        $this->validateConfig($config);
        $variable = $config['variable'];
        $field = $config['field'];
        $direction = isset($config['direction']) ? $config['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['variable']) || !isset($config['field'])) {
            throw new ConfigurationException('Both the configuration entry `field` and `variable` are required when using the Order adapter.');
        }
    }
}