RunOpenCode\ExchangeRate\Utils\FilterUtilHelper

Complexity

Total Complexity

10

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	extractArrayCriteria()	0	12	3
A	extractDateCriteria()	0	14	4
A	matchesArrayCriteria()	0	16	3

<?php
/*
 * This file is part of the Exchange Rate package, an RunOpenCode project.
 *
 * (c) 2017 RunOpenCode
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace RunOpenCode\ExchangeRate\Utils;

use RunOpenCode\ExchangeRate\Exception\InvalidArgumentException;
use RunOpenCode\ExchangeRate\Exception\RuntimeException;

/**
 * Class BaseFilterUtil
 *
 * Common shared functions for filter utilities.
 *
 * @package RunOpenCode\ExchangeRate\Utils
 */
trait FilterUtilHelper
{
    /**
     * Extract array criteria from criterias.
     *
     * @param string $key Criteria name.
     * @param array $criteria Filter criterias.
     * @return array Extracted array criterias.
     */
    private static function extractArrayCriteria($key, array $criteria)
    {
        if (!empty($criteria[$key])) {
            return array($criteria[$key]);
        }

        if (!empty($criteria[$key.'s'])) {
            return $criteria[$key.'s'];
        }

        return array();
    }

    /**
     * Extract date from filter criterias.
     *
     * @param string $key Criteria name.
     * @param array $criteria Filter criterias.
     * @return \DateTime|null Extracted date criteria.
     */
    private static function extractDateCriteria($key, array $criteria)
    {
        $date = (!empty($criteria[$key])) ? $criteria[$key] : null;

        if (is_string($date)) {
            $date = \DateTime::createFromFormat('Y-m-d', $date);
        }

        if (false === $date) {
            throw new InvalidArgumentException(sprintf('Invalid date/time format provided "%s", expected "%s", or instance of \DateTime class.', $criteria[$key], 'Y-m-d'));
        }

        return $date;
    }

    /**
     * Check if array|string criteria is matched.
     *
     * @param string $key Array|string criteria key.
     * @param object $object Object to check for match.
     * @param array $criteria Filter criterias.
     * @return bool TRUE if there is a match.
     */
    private static function matchesArrayCriteria($key, $object, array $criteria)
    {
        $criteria = self::extractArrayCriteria($key, $criteria);

        if (count($criteria) === 0) {
            return true;
        }

        $getter = sprintf('get%s', ucfirst($key));

        if (!method_exists($object, $getter)) {
            throw new RuntimeException(sprintf('Object instance of "%s" does not have required getter "%s" to be used for filtering.', get_class($object), $getter));
        }

        return in_array($object->{$getter}(), $criteria, true);
    }
}