class.ilAsqFactory.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilAsqFactory
{
    public function service() : ilAsqService
    {
        return new ilAsqService();
    }

    public function getQuestionDataArray($parentObjectId) : array
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        global $ilPluginAdmin; /* @var ilPluginAdmin $ilPluginAdmin */

        $list = new ilAssQuestionList($DIC->database(), $DIC->language(), $DIC['refinery'], $ilPluginAdmin);
        $list->setParentObjIdsFilter(array($parentObjectId));
        $list->load();

        return $list->getQuestionDataArray(); // returns an array of arrays containing the question data

    }

    public function getQuestionInstances($parentObjectId) : array
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        global $ilPluginAdmin; /* @var ilPluginAdmin $ilPluginAdmin */

        $list = new ilAssQuestionList($DIC->database(), $DIC->language(), $DIC['refinery'], $ilPluginAdmin);
        $list->setParentObjIdsFilter(array($parentObjectId));
        $list->load();

        $questionInstances = array();

        foreach ($list->getQuestionDataArray() as $questionId => $questionData) {
            $questionInstances[] = $this->getQuestionInstance($questionId);
        }

        return $questionInstances;
    }

    public function getAuthoringCommandInstance($questionInstance) : ilAsqQuestionAuthoring
    {
        $authoringGUI; /* @var ilAsqQuestionAuthoring $authoringGUI */

        $authoringGUI->setQuestion($questionInstance);

        return $authoringGUI;
    }

    const RENDER_PURPOSE_PLAYBACK = 'renderPurposePlayback'; // e.g. Test Player
    const RENDER_PURPOSE_DEMOPLAY = 'renderPurposeDemoplay'; // e.g. Page Editing View in Test
    const RENDER_PURPOSE_PREVIEW = 'renderPurposePreview'; // e.g. Preview Player
    const RENDER_PURPOSE_PRINT_PDF = 'renderPurposePrintPdf'; // When used for PDF rendering
    const RENDER_PURPOSE_INPUT_VALUE = 'renderPurposeInputValue'; // When used as RTE Input Content

    public function getQuestionPresentationInstance($questionInstance, $renderPurpose) : ilAsqQuestionPresentation
    {
        $presentationGUI; /* @var ilAsqQuestionPresentation $presentationGUI */

        $presentationGUI->setQuestion($questionInstance);

        return $presentationGUI;
    }

    public function getQuestionInstance($questionId) : ilAsqQuestion
    {
        $questionInstance; /* @var ilAsqQuestion $questionInstance */

        $questionInstance->setId($questionId);
        $questionInstance->load();

        return $questionInstance;
    }

    public function getEmptyQuestionInstance($questionType) : ilAsqQuestion
    {
        $questionInstance; /* @var ilAsqQuestion $questionInstance */

        return $questionInstance;
    }

    public function getOfflineExportableQuestionInstance($questionId, $a_image_path = null, $a_output_mode = 'presentation') : ilAsqQuestion
    {
        $questionInstance; /* @var ilAsqQuestion $questionInstance */

        $questionInstance->setId($questionId);
        $questionInstance->load();

        $questionInstance->setOfflineExportImagePath($a_image_path);
        $questionInstance->setOfflineExportPagePresentationMode($a_output_mode);

        return $questionInstance;
    }

    public function getQuestionOfflinePresentationExporter(ilAsqQuestion $offlineExportableQuestionInstance)
    {
        $qstOffPresentationExporter; /* @var ilAsqQuestionOfflinePresentationExporter $qstOffPresentationExporter */

        $qstOffPresentationExporter->setQuestion($offlineExportableQuestionInstance);

        return $qstOffPresentationExporter;
    }

    public function getQuestionResourcesCollector()
    {
        return new ilAsqQuestionResourcesCollector();
    }

    public function getQuestionSolutionInstance($questionId, $solutionId) : ilAsqQuestionSolution
    {
        $questionSolutionInstance; /* @var ilAsqQuestionSolution $questionSolutionInstance */

        $questionSolutionInstance->setQuestionId($questionId);
        $questionSolutionInstance->setSolutionId($solutionId);
        $questionSolutionInstance->load();

        return $questionSolutionInstance;
    }

    public function getEmptyQuestionSolutionInstance($questionId) : ilAsqQuestionSolution
    {
        $emptySolutionInstance; /* @var ilAsqQuestionSolution $questionSolutionInstance */

        $emptySolutionInstance->setQuestionId($questionId);

        return $emptySolutionInstance;
    }

    public function getResultCalculator(ilAsqQuestion $questionInstance, ilAsqQuestionSolution $solutionInstance) : ilAsqResultCalculator
    {
        $resultCalculator; /* @var ilAsqResultCalculator $resultCalculator */

        $resultCalculator->setQuestion($questionInstance);
        $resultCalculator->setSolution($solutionInstance);

        return $resultCalculator;
    }
}