<?php

/**
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2017-2019 (original work) Open Assessment Technologies SA;
 */

namespace oat\taoTests\models\runner\providers;

use common_ext_ExtensionsManager;
use oat\tao\model\modules\AbstractModuleRegistry;

/**
 * Store the <b>available</b> test runner providers, even if not activated,
 * providers have to be registered.
 *
 * @author Bertrand Chevrier <bertrand@taotesting.com>
 * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
 */
class ProviderRegistry extends AbstractModuleRegistry
{
    /**
     * @see \oat\oatbox\AbstractRegistry::getConfigId()
     */
    protected function getConfigId()
    {
        return 'test_runner_provider_registry';
    }

    /**
     * @see \oat\oatbox\AbstractRegistry::getExtension()
     */
    protected function getExtension()
    {
        return common_ext_ExtensionsManager::singleton()->getExtensionById('taoTests');
    }

    /**
     * Get all modules that belong to a category
     * @param string $category - the provider category (runner, proxy,etc.)
     * @return array the matching providers
     */
    public function getByCategory($category = null)
    {
        if ($category === null) {
            return [];
        }

        return array_filter(
            $this->getMap(),
            function ($provider) use ($category) {
                return isset($provider['category']) && $provider['category'] === $category;
            }
        );
    }

    /**
     * Unregister all modules that belong to a category
     * @param string $category - the provider category (runner, proxy,etc.)
     */
    public function removeByCategory($category = null)
    {
        foreach ($this->getByCategory($category) as $provider) {
            if (isset($provider['module'])) {
                $this->remove($provider['module']);
            }
        }
    }
}