<?php
/**
 * Copyright since 2007 PrestaShop SA and Contributors
 * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/OSL-3.0
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@prestashop.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
 * versions in the future. If you wish to customize PrestaShop for your
 * needs please refer to https://devdocs.prestashop.com/ for more information.
 *
 * @author    PrestaShop SA and Contributors <contact@prestashop.com>
 * @copyright Since 2007 PrestaShop SA and Contributors
 * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 */

namespace PrestaShop\PrestaShop\Core\Form\ChoiceProvider;

use PrestaShop\PrestaShop\Core\Form\FormChoiceProviderInterface;
use PrestaShop\PrestaShop\Core\Module\ModuleCollection;
use PrestaShop\PrestaShop\Core\Module\ModuleInterface;

/**
 * Class ModuleByNameChoiceProvider provides module choices with name values.
 */
final class ModuleByNameChoiceProvider implements FormChoiceProviderInterface
{
    /**
     * @var ModuleCollection collection of installed modules
     */
    private $installedModules;

    /**
     * @param ModuleCollection $installedModules
     */
    public function __construct(ModuleCollection $installedModules)
    {
        $this->installedModules = $installedModules;
    }

    /**
     * {@inheritdoc}
     */
    public function getChoices()
    {
        $moduleChoices = [];

        /** @var ModuleInterface $module */
        foreach ($this->installedModules as $module) {
            $moduleChoices[$module->get('displayName')] = $module->get('name');
        }

        // Order modules alphabetically
        ksort($moduleChoices);

        return $moduleChoices;
    }
}
