tao-test/app/taoItems/actions/class.ItemImport.php

<?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) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
 *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER);
 *               2009-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
 *               2012-2021 (update and modification) Open Assessment Technologies SA;
 */

declare(strict_types=1);

use oat\taoQtiItem\model\import\CsvItemImporter;
use oat\tao\model\featureFlag\FeatureFlagChecker;
use oat\tao\model\featureFlag\FeatureFlagCheckerInterface;

/**
 * This controller provide the actions to import items
 *
 * @author  CRP Henri Tudor - TAO Team - {@link http://www.tao.lu}
 * @license GPLv2  http://www.opensource.org/licenses/gpl-2.0.php
 * @package taoItems
 *
 */
class taoItems_actions_ItemImport extends tao_actions_Import
{
    /** @deprecated Use oat\tao\model\featureFlag\FeatureFlagCheckerInterface::FEATURE_FLAG_TABULAR_IMPORT */
    public const FEATURE_FLAG_TABULAR_IMPORT = FeatureFlagCheckerInterface::FEATURE_FLAG_TABULAR_IMPORT;

    /**
     * overwrite the parent index to add the requiresRight for Items only
     *
     * @requiresRight id WRITE
     * @requiresRight classUri WRITE
     */
    public function index()
    {
        parent::index();
    }

    protected function getAvailableImportHandlers()
    {
        $returnValue = $this->replaceAvailableImportHandlers();

        $itemModelClass = $this->getClass(taoItems_models_classes_itemModel::CLASS_URI_MODELS);
        foreach ($itemModelClass->getInstances() as $model) {
            $impl = taoItems_models_classes_ItemsService::singleton()->getItemModelImplementation($model);
            if (in_array('tao_models_classes_import_ImportProvider', class_implements($impl))) {
                foreach ($impl->getImportHandlers() as $handler) {
                    array_unshift($returnValue, $handler);
                }
            }
        }

        return $returnValue;
    }

    private function replaceAvailableImportHandlers(): array
    {
        $returnValue = parent::getAvailableImportHandlers();

        foreach (array_keys($returnValue) as $key) {
            if ($returnValue[$key] instanceof \tao_models_classes_import_CsvImporter) {
                if ($this->getFeatureFlagChecker()->isEnabled(FeatureFlagCheckerInterface::FEATURE_FLAG_TABULAR_IMPORT)) {
                    $importer = new CsvItemImporter($this->getPsrRequest());
                    $importer->setServiceLocator($this->getServiceLocator());
                    $returnValue[$key] = $importer;

                    continue;
                }

                unset($returnValue[$key]);
            }
        }

        return $returnValue;
    }

    private function getFeatureFlagChecker(): FeatureFlagCheckerInterface
    {
        return $this->getServiceLocator()->get(FeatureFlagChecker::class);
    }
}