SSpkS\Package\PackageFilter

Complexity

Total Complexity

25

Size/Duplication

Total Lines	156
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setArchitectureFilter()	0	4	1
A	setFirmwareVersionFilter()	0	4	1
A	setChannelFilter()	0	4	1
A	setOldVersionFilter()	0	4	1
A	isMatchingArchitecture()	0	8	2
A	isMatchingFirmwareVersion()	0	7	2
B	isMatchingChannel()	0	12	6
A	removeObsoleteVersions()	0	12	4
B	getFilteredPackageList()	0	21	6

<?php

namespace SSpkS\Package;

use \SSpkS\Package\Package;

/**
 * SPK PackageFinder class
 */
class PackageFilter
{
    private $pkgList;
    /** @var bool|string[] $filterArch Array of allowed architectures, or FALSE to ignore. */
    private $filterArch = false;
    /** @var bool|string $filterFwVersion Target firmware version, or FALSE to ignore. */
    private $filterFwVersion = false;
    /** @var bool|string $filterChannel Channel 'stable' or 'beta', or FALSE to ignore. */
    private $filterChannel = false;
    /** @var bool $filterOldVersions TRUE to return unique packages with latest version only. */
    private $filterOldVersions = false;

    /**
     * @param \SSpkS\Package\Package[] $pkgList List of Package objects to filter
     */
    public function __construct(array $pkgList)
    {
        $this->pkgList = $pkgList;
    }

    /**
     * Sets the architecture to filter for.
     *
     * @param string $arch Architecture.
     */
    public function setArchitectureFilter($arch)
    {
        $this->filterArch = array('noarch', $arch);
    }

    /**
     * Sets the firmware version to filter for.
     *
     * @param string|bool $version Firmware version in dotted notation ('1.2.3456') or FALSE to ignore.
     */
    public function setFirmwareVersionFilter($version)
    {
        $this->filterFwVersion = $version;
    }

    /**
     * Sets the channel to filter for.
     *
     * @param string $channel Channel ('stable' or 'beta')
     */
    public function setChannelFilter($channel)
    {
        $this->filterChannel = $channel;
    }

    /**
     * Enables or disables omitting older versions of the same package from the result set.
     *
     * @param bool $status TRUE to enable the filter, FALSE to disable.
     */
    public function setOldVersionFilter($status)
    {
        $this->filterOldVersions = $status;
    }

    /**
     * If filter is enabled, checks if architecture of $package is compatible to requested one.
     *
     * @param \SSpkS\Package\Package $package Package to test.
     * @return bool TRUE if matching, or FALSE.
     */
    public function isMatchingArchitecture($package)
    {
        if ($this->filterArch === false) {
            return true;
        }
        $matches = array_intersect($this->filterArch, $package->arch);
        return (count($matches) > 0);
    }

    /**
     * If filter is enabled, checks if minimal firmware required of $package is
     * smaller or equal to system firmware.
     *
     * @param \SSpkS\Package\Package $package Package to test.
     * @return bool TRUE if matching, or FALSE.
     */
    public function isMatchingFirmwareVersion($package)
    {
        if ($this->filterFwVersion === false) {
            return true;
        }
        return (version_compare($package->firmware, $this->filterFwVersion, '<='));
    }

    /**
     * If filter is enabled, checks if channel of $package matches requested one.
     * 'beta' will show ALL packages, also those from 'stable'.
     *
     * @param \SSpkS\Package\Package $package Package to test.
     * @return bool TRUE if matching, or FALSE.
     */
    public function isMatchingChannel($package)
    {
        if ($this->filterChannel === false) {
            return true;
        }
        if ($this->filterChannel == 'stable' && (!isset($package->beta) || $package->beta === false)) {
            return true;
        } elseif ($this->filterChannel == 'beta') {
            return true;
        }
        return false;
    }

    /**
     * Removes older versions of same package from $pkgList.
     *
     * @param \SSpkS\Package\Package[] $pkgList List of packages
     * @return \SSpkS\Package\Package[] List of unique packages
     */
    public function removeObsoleteVersions($pkgList)
    {
        $uniqueList = array();
        foreach ($pkgList as $package) {
            $pkgId = $package->package;
            if (isset($uniqueList[$pkgId]) && version_compare($uniqueList[$pkgId]->version, $package->version, '>=')) {
                continue;
            }
            $uniqueList[$pkgId] = $package;
        }
        return array_values($uniqueList);
    }

    /**
     * Returns the list of packages matching the currently set filters.
     *
     * @return \SSpkS\Package\Package[] List of Package objects matching filters.
     */
    public function getFilteredPackageList()
    {
        $filteredPackages = array();
        foreach ($this->pkgList as $package) {
            if (!$this->isMatchingArchitecture($package)) {
                continue;
            }
            if (!$this->isMatchingFirmwareVersion($package)) {
                continue;
            }
            if (!$this->isMatchingChannel($package)) {
                continue;
            }
            $filteredPackages[] = $package;
        }
        if ($this->filterOldVersions) {
            // remove older versions of duplicate packages from $filteredPackages
            $filteredPackages = $this->removeObsoleteVersions($filteredPackages);
        }
        return $filteredPackages;
    }
}