ilExerciseGSToolProvider Class Reference

Taxonomy GS tool provider. More...

Inheritance diagram for ilExerciseGSToolProvider:

Collaboration diagram for ilExerciseGSToolProvider:

Public Member Functions
	isInterestedInContexts ()
	getToolsForContextStack (CalledContexts $called_contexts)
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Tool\Provider\AbstractDynamicToolProvider
	__construct (Container $dic)
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()

Data Fields
const	SHOW_EXC_ASSIGNMENT_INFO = 'show_exc_assignment_info'
const	EXC_ASS_IDS = 'exc_ass_ids'
const	EXC_ASS_BUTTONS = "exc_ass_buttons"

Protected Member Functions
	addSection (ilTemplate $tpl, string $title, string $content)
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Private Member Functions
	getAssignmentInfo (array $ass_ids, array $buttons)

Additional Inherited Members
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Tool\Provider\AbstractDynamicToolProvider
ToolIdentificationProviderInterface	$identification_provider
ContextCollection	$context_collection
ToolFactory	$factory
Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
Container	$dic

Detailed Description

Taxonomy GS tool provider.

Author

Alex Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..com

Definition at line 29 of file class.ilExerciseGSToolProvider.php.

Member Function Documentation

addSection()

ilExerciseGSToolProvider::addSection ( ilTemplate  $tpl, string  $title, string  $content  )

protected

Definition at line 172 of file class.ilExerciseGSToolProvider.php.

References ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by getAssignmentInfo().

     : void {
        $tpl->setCurrentBlock("section");
        $tpl->setVariable("TITLE", $title);
        $tpl->setVariable("CONTENT", $content);
        $tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssignmentInfo()

ilExerciseGSToolProvider::getAssignmentInfo ( array  $ass_ids, array  $buttons  )

private

Parameters

int[]	$ass_ids
Button[][]	$buttons

Returns

string

Exceptions

ilDateTimeException
ilExcUnknownAssignmentTypeException

Definition at line 90 of file class.ilExerciseGSToolProvider.php.

References Vendor\Package\$b, $DIC, $lng, $ref_id, ilObject\_getAllReferences(), ilObject\_lookupTitle(), addSection(), and ilExAssignment\lookupExerciseId().

Referenced by getToolsForContextStack().

     : string {
        global $DIC;

        $lng = $DIC->language();
        $user = $DIC->user();
        $ui = $DIC->ui();
        $access = $DIC->access();
        $link_service = $DIC->exercise()->internal()->gui()->permanentLink();

        $html = "";

        foreach ($ass_ids as $ass_id) {
            $info = new ilExAssignmentInfo($ass_id, $user->getId());
            $exc_id = ilExAssignment::lookupExerciseId($ass_id);
            $readable_ref_id = 0;
            foreach (ilObject::_getAllReferences($exc_id) as $ref_id) {
                if ($access->checkAccess("read", "", $ref_id)) {
                    $readable_ref_id = $ref_id;
                }
            }

            $tpl = new ilTemplate("tpl.ass_info_tool.html", true, true, "Modules/Exercise");
            $assignment = new ilExAssignment($ass_id);

            $title = ilObject::_lookupTitle($exc_id) . ": " . $assignment->getTitle();
            if ($readable_ref_id > 0) {
                $title = $ui->renderer()->render(
                    $ui->factory()->link()->standard($title, $link_service->getPermanentLink($readable_ref_id, $ass_id))
                );
            }

            $this->addSection($tpl, $lng->txt("exc_assignment"), $title);

            // schedule info
            $schedule = $info->getScheduleInfo();
            $list = $ui->factory()->listing()->unordered(array_map(function ($i) {
                return $i["txt"] . ": " . $i["value"];
            }, $schedule));
            $this->addSection($tpl, $lng->txt("exc_schedule"), $ui->renderer()->render($list));

            // latest submission
            $subm = $info->getSubmissionInfo();
            if (isset($subm["submitted"])) {
                $this->addSection($tpl, $subm["submitted"]["txt"], $subm["submitted"]["value"]);
            }

            // instruction
            $inst = $info->getInstructionInfo();
            if (count($inst)) {
                $this->addSection($tpl, $inst["instruction"]["txt"], $inst["instruction"]["value"]);
            }

            // instruction files
            $files = $info->getInstructionFileInfo($readable_ref_id);
            if (is_array($files)) {
                $list = $ui->factory()->listing()->unordered(array_map(function ($i) use ($ui) {
                    $v = $i["txt"];
                    if ($i["value"] != "") {
                        $v = $ui->renderer()->render($ui->factory()->button()->shy($v, $i["value"]));
                    }
                    return $v;
                }, $files));
                $this->addSection($tpl, $lng->txt("exc_instruction_files"), $ui->renderer()->render($list));
            }

            // buttons
            if (isset($buttons[$ass_id])) {
                $tpl->setVariable("BUTTONS", implode(" ", array_map(function ($b) use ($ui) {
                    return $ui->renderer()->render($b);
                }, $buttons[$ass_id])));
            }

            $tpl->setCurrentBlock("ass_info");
            $tpl->parseCurrentBlock();
            $html .= $tpl->get();
        }
        return $html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getToolsForContextStack()

ilExerciseGSToolProvider::getToolsForContextStack

(

CalledContexts

$called_contexts

)

Parameters

CalledContexts

$called_contexts

Returns

Tool[] These Slates can be passed to the MainMenu dynamic for a specific location/context.

See also

DynamicProvider

Exceptions

ilExcUnknownAssignmentTypeException
ilDateTimeException

Implements ILIAS\GlobalScreen\Scope\Tool\Provider\DynamicToolProvider.

Definition at line 40 of file class.ilExerciseGSToolProvider.php.

References $DIC, $id, $lng, ILIAS\GlobalScreen\ScreenContext\Stack\CalledContexts\current(), and getAssignmentInfo().

     : array {
        global $DIC;

        $lng = $DIC->language();
        $lng->loadLanguageModule("exc");

        $title = $lng->txt("exc_assignment");
        $icon = $this->dic->ui()->factory()->symbol()->icon()->standard("exc", $title);

        $tools = [];
        $additional_data = $called_contexts->current()->getAdditionalData();
        if ($additional_data->is(self::SHOW_EXC_ASSIGNMENT_INFO, true)) {
            $iff = function ($id) {
                return $this->identification_provider->contextAwareIdentifier($id);
            };
            $l = function (string $content) {
                return $this->dic->ui()->factory()->legacy($content);
            };
            $tools[] = $this->factory->tool($iff("exc_ass_info"))
                ->withTitle($title)
                ->withSymbol($icon)
                ->withContentWrapper(
                    function () use ($l, $additional_data) {
                        $buttons = $additional_data->exists(self::EXC_ASS_BUTTONS)
                            ? $additional_data->get(self::EXC_ASS_BUTTONS)
                            : [];
                        return $l($this->getAssignmentInfo(
                            $additional_data->get(self::EXC_ASS_IDS),
                            $buttons
                        ));
                    }
                );
        }

        return $tools;
    }

Here is the call graph for this function:

isInterestedInContexts()

ilExerciseGSToolProvider::isInterestedInContexts

(

)

Returns

ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 35 of file class.ilExerciseGSToolProvider.php.

References ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\main().

                                            : ContextCollection
    {
        return $this->context_collection->main()->main();
    }

Here is the call graph for this function:

Field Documentation

EXC_ASS_BUTTONS

const ilExerciseGSToolProvider::EXC_ASS_BUTTONS = "exc_ass_buttons"

Definition at line 33 of file class.ilExerciseGSToolProvider.php.

Referenced by ilObjPortfolioGUI\triggerAssignmentTool(), ilObjBlogGUI\triggerAssignmentTool(), and ilObjWikiGUI\triggerAssignmentTool().

EXC_ASS_IDS

const ilExerciseGSToolProvider::EXC_ASS_IDS = 'exc_ass_ids'

Definition at line 32 of file class.ilExerciseGSToolProvider.php.

Referenced by ilExSubmissionBaseGUI\triggerAssignmentTool(), ilObjPortfolioGUI\triggerAssignmentTool(), ilObjBlogGUI\triggerAssignmentTool(), and ilObjWikiGUI\triggerAssignmentTool().

SHOW_EXC_ASSIGNMENT_INFO

const ilExerciseGSToolProvider::SHOW_EXC_ASSIGNMENT_INFO = 'show_exc_assignment_info'

Definition at line 31 of file class.ilExerciseGSToolProvider.php.

Referenced by ilExSubmissionBaseGUI\triggerAssignmentTool(), ilObjPortfolioGUI\triggerAssignmentTool(), ilObjBlogGUI\triggerAssignmentTool(), and ilObjWikiGUI\triggerAssignmentTool().

---

The documentation for this class was generated from the following file:

• Modules/Exercise/GlobalScreen/classes/class.ilExerciseGSToolProvider.php