tao-test/app/taoQtiItem/model/Export/ItemMetadataByClassExportHandler.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) 2016 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
 *
 */

namespace oat\taoQtiItem\model\Export;

use common_report_Report as Report;
use core_kernel_classes_Resource;
use oat\generis\model\OntologyAwareTrait;
use oat\oatbox\event\EventManagerAwareTrait;
use oat\oatbox\service\ServiceManager;
use oat\taoQtiItem\model\event\QtiItemMetadataExportEvent;
use oat\taoQtiItem\model\flyExporter\extractor\ExtractorException;
use oat\taoQtiItem\model\flyExporter\simpleExporter\ItemExporter;
use oat\taoQtiItem\model\flyExporter\simpleExporter\SimpleExporter;
use oat\taoQtiItem\model\ItemModel;
use oat\oatbox\PhpSerializable;
use oat\oatbox\PhpSerializeStateless;

class ItemMetadataByClassExportHandler implements \tao_models_classes_export_ExportHandler, PhpSerializable
{
    use OntologyAwareTrait;
    use PhpSerializeStateless;
    use EventManagerAwareTrait;

    /**
     * Get label form
     *
     * @return string
     */
    public function getLabel()
    {
        return __('QTI Metadata');
    }

    /**
     * Create MetadataExporterForm with class uri
     *
     * @param core_kernel_classes_Resource $resource
     * @return \tao_helpers_form_Form
     */
    public function getExportForm(core_kernel_classes_Resource $resource)
    {
        if ($resource instanceof \core_kernel_classes_Class) {
            $formData = ['class' => $resource];
        } else {
            $formData = ['class' => $this->getClass($resource)];
        }
        $form = new MetadataExporterForm($formData);

        return $form->getForm();
    }

    /**
     * @param array  $formValues
     * @param string $destination
     * @return Report
     * @throws \common_exception_BadRequest
     */
    public function export($formValues, $destination)
    {
        $report = Report::createSuccess();

        if (isset($formValues['filename']) && isset($formValues['classUri'])) {
            $classToExport = $this->getClassToExport($formValues['classUri']);

            if ($classToExport->exists()) {
                try {
                    $fileName = $formValues['filename'] . '_' . time() . '.csv';

                    if (!\tao_helpers_File::securityCheck($fileName, true)) {
                        throw new \Exception('Unauthorized file name');
                    }

                    /** @var ItemExporter $exporterService */
                    $exporterService = $this->getServiceManager()->get(SimpleExporter::SERVICE_ID);
                    $exporterService->setOption(ItemExporter::OPTION_FILE_LOCATION, $fileName);

                    $filePath = $exporterService->export($this->getInstances($classToExport));

                    $report->setData($filePath);
                    $report->setMessage(__('Item metadata successfully exported.'));

                    $this->getEventManager()->trigger(new QtiItemMetadataExportEvent($classToExport));
                } catch (ExtractorException $e) {
                    $report = Report::createFailure('Selected object does not have any item to export.');
                }
            }
        }

        return $report;
    }

    protected function getInstances($classToExport)
    {
        $instances = [];
        $itemService = \taoItems_models_classes_ItemsService::singleton();
        foreach ($classToExport->getInstances(true) as $item) {
            if ($itemService->hasItemModel($item, [ItemModel::MODEL_URI])) {
                $instances[] = $item;
            }
        }

        return $instances;
    }

    /**
     * Get class to export, from resource uri or class uri
     * If parameter is null, check id http parameter
     *
     * @param null $uri
     * @return \core_kernel_classes_Class|mixed
     * @throws \common_exception_BadRequest
     */
    protected function getClassToExport($uri)
    {
        $resource = $this->getResource($uri);

        if ($resource->isClass()) {
            $classToExport = $this->getClass($uri);
        } else {
            $classToExport = reset($resource->getTypes());
        }

        return $classToExport;
    }

    /**
     * @return ServiceManager
     */
    protected function getServiceManager()
    {
        return ServiceManager::getServiceManager();
    }
}