/user/plugins/gantry5/src/classes/Gantry/Component/Assignments/AssignmentFilter.php

<?php
/**
 * @package   Gantry5
 * @author    RocketTheme http://www.rockettheme.com
 * @copyright Copyright (C) 2007 - 2016 RocketTheme, LLC
 * @license   Dual License: MIT or GNU/GPLv2 and later
 *
 * http://opensource.org/licenses/MIT
 * http://www.gnu.org/licenses/gpl-2.0.html
 *
 * Gantry Framework code that extends GPL code is considered GNU/GPLv2 and later
 */

namespace Gantry\Component\Assignments;

/**
 * Class AssignmentFilter
 * @package Gantry\Assignments
 */
class AssignmentFilter
{
    protected $method;

    /**
     * Return all matching candidates with their score. Candidates are ordered by their scores.
     *
     * @param array $candidates  In format of candidates[name][section][rule].
     * @param array $page        In format of page[section][rule].
     * @return array
     */
    public function scores(array &$candidates, array &$page)
    {
        $matches = $this->matches($candidates, $page);

        $scores = [];
        foreach ($matches as $type => $candidate) {
            $scores[$type] = $this->getScore($candidate);
        }

        ksort($scores, SORT_STRING);
        arsort($scores);

        return $scores;
    }

    /**
     * Returns all matching candidates with matching rules.
     *
     * @param array $candidates  In format of candidates[name][section][rule].
     * @param array $page        In format of page[section][rule].
     * @return array
     */
    public function matches(array &$candidates, array &$page)
    {
        $matches = [];
        foreach ($candidates as $type => $candidate) {
            foreach ($candidate as $section => $list) {
                foreach ($list as $name => $rules) {
                    if (isset($page[$section][$name])) {
                        $match =\array_intersect_key($page[$section][$name], $rules);
                        if ($match) {
                            $matches[$type][$section][$name] = $match;
                        }
                    }
                }
            }
        }

        return $matches;
    }

    /**
     * Returns the calculated score for the assignment.
     *
     * @param array $matches
     * @param string $method
     * @return int
     */
    public function getScore(array &$matches, $method = 'max')
    {
        $this->method = 'calc' . ucfirst($method);

        if (!method_exists($this, $this->method)) {
            $this->method = 'calcMax';
        }

        return $this->calcArray(null, $matches);
    }

    /**
     * @param int|float $carry
     * @param int|float|array $item
     * @return int|float
     * @internal
     */
    protected function calcArray($carry, $item)
    {
        if (is_array($item)) {
            return array_reduce($item, [$this, 'calcArray'], $carry);
        }

        $method = $this->method;
        return $this->{$method}($carry, $item);
    }

    /**
     * @param int|float $carry
     * @param int|float $item
     * @return int|float
     * @internal
     */
    protected function calcOr($carry, $item)
    {
        return (int) ($carry || $item);
    }

    /**
     * @param int|float $carry
     * @param int|float $item
     * @return int|float
     * @internal
     */
    protected function calcMin($carry, $item)
    {
        return isset($carry) ? min($carry, $item) : $item;
    }

    /**
     * @param int|float $carry
     * @param int|float $item
     * @return int|float
     * @internal
     */
    protected function calcMax($carry, $item)
    {
        return max($carry, $item);
    }

    /**
     * @param int|float $carry
     * @param int|float $item
     * @return int|float
     * @internal
     */
    protected function calcSum($carry, $item)
    {
        return $carry + $item;
    }

    /**
     * @param int|float $carry
     * @param int|float $item
     * @return int|float
     * @internal
     */
    protected function calcMul($carry, $item)
    {
        return isset($carry) ? $carry * $item : $item;
    }
}