Collaboration diagram for ilObjLearningSequenceContentGUI:

Public Member Functions
	__construct (ilObjLearningSequenceGUI $parent_gui, ilCtrl $ctrl, ilGlobalTemplateInterface $tpl, ilLanguage $lng, ilAccess $access, ilConfirmationGUI $confirmation_gui, LSItemOnlineStatus $ls_item_online_status, ArrayBasedRequestWrapper $post_wrapper, Factory $refinery, ILIAS\UI\Factory $ui_factory, ILIAS\UI\Renderer $ui_renderer)

	executeCommand ()

	getPossiblePostConditionsForType (string $type)

	getFieldName (string $field_name, int $ref_id)

Data Fields
const	CMD_MANAGE_CONTENT = "manageContent"

const	CMD_SAVE = "save"

const	CMD_DELETE = "delete"

const	CMD_CONFIRM_DELETE = "confirmDelete"

const	CMD_CANCEL = "cancel"

const	FIELD_ORDER = 'f_order'

const	FIELD_ONLINE = 'f_online'

const	FIELD_POSTCONDITION_TYPE = 'f_pct'

Protected Member Functions
	manageContent ()

	renderTable (array $ls_items)

	confirmDelete ()
	Handle the confirmDelete command. More...

	delete ()

	save ()

Protected Attributes
ilObjLearningSequenceGUI	$parent_gui

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilAccess	$access

ilConfirmationGUI	$confirmation_gui

LSItemOnlineStatus	$ls_item_online_status

ArrayBasedRequestWrapper	$post_wrapper

ILIAS Refinery Factory	$refinery

ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$ui_renderer

Detailed Description

Definition at line 24 of file class.ilObjLearningSequenceContentGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjLearningSequenceContentGUI::__construct	(	ilObjLearningSequenceGUI	$parent_gui,
		ilCtrl	$ctrl,
		ilGlobalTemplateInterface	$tpl,
		ilLanguage	$lng,
		ilAccess	$access,
		ilConfirmationGUI	$confirmation_gui,
		LSItemOnlineStatus	$ls_item_online_status,
		ArrayBasedRequestWrapper	$post_wrapper,
		Factory	$refinery,
		ILIAS\UI\Factory	$ui_factory,
		ILIAS\UI\Renderer	$ui_renderer
	)

Definition at line 48 of file class.ilObjLearningSequenceContentGUI.php.

References $access, $confirmation_gui, $ctrl, $lng, $ls_item_online_status, $parent_gui, $post_wrapper, $refinery, $tpl, $ui_factory, $ui_renderer, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

       {
         $this->parent_gui = $parent_gui;
         $this->ctrl = $ctrl;
         $this->tpl = $tpl;
         $this->lng = $lng;
         $this->access = $access;
         $this->confirmation_gui = $confirmation_gui;
         $this->ls_item_online_status = $ls_item_online_status;
         $this->post_wrapper = $post_wrapper;
         $this->refinery = $refinery;
         $this->ui_factory = $ui_factory;
         $this->ui_renderer = $ui_renderer;
     }

Here is the call graph for this function:

Member Function Documentation

◆ confirmDelete()

ilObjLearningSequenceContentGUI::confirmDelete ( )

protected

Handle the confirmDelete command.

Definition at line 130 of file class.ilObjLearningSequenceContentGUI.php.

References $ref_id, $refinery, ILIAS\Repository\ctrl(), ilObjectFactory\getInstanceByRefId(), and ILIAS\Repository\lng().

                                       : void
     {
         $r = $this->refinery;
         $ref_ids = $this->post_wrapper->retrieve(
             "id",
             $r->byTrying([
                 $r->kindlyTo()->listOf($r->kindlyTo()->int()),
                 $r->always([])
             ])
         );
 
         if (!$ref_ids || count($ref_ids) < 1) {
             $this->tpl->setOnScreenMessage("info", $this->lng->txt('no_entries_selected_for_delete'), true);
             $this->ctrl->redirect($this, self::CMD_MANAGE_CONTENT);
         }
 
         foreach ($ref_ids as $ref_id) {
             $obj = ilObjectFactory::getInstanceByRefId($ref_id);
             $this->confirmation_gui->addItem("id[]", (string) $ref_id, $obj->getTitle());
         }
 
         $this->confirmation_gui->setFormAction($this->ctrl->getFormAction($this));
         $this->confirmation_gui->setHeaderText($this->lng->txt("delete_confirmation"));
         $this->confirmation_gui->setConfirm($this->lng->txt("confirm"), self::CMD_DELETE);
         $this->confirmation_gui->setCancel($this->lng->txt("cancel"), self::CMD_CANCEL);
 
         $this->tpl->setContent($this->confirmation_gui->getHTML());
     }

Here is the call graph for this function:

◆ delete()

ilObjLearningSequenceContentGUI::delete ( )

protected

Definition at line 159 of file class.ilObjLearningSequenceContentGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                : void
     {
         $ref_ids = $this->post_wrapper->retrieve(
             "id",
             $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
         );
 
         $this->parent_gui->getObject()->deletePostConditionsForSubObjects($ref_ids);
 
         $this->tpl->setOnScreenMessage("success", $this->lng->txt('entries_deleted'), true);
         $this->ctrl->redirect($this, self::CMD_MANAGE_CONTENT);
     }

Here is the call graph for this function:

◆ executeCommand()

ilObjLearningSequenceContentGUI::executeCommand ( )

Definition at line 74 of file class.ilObjLearningSequenceContentGUI.php.

References ILIAS\Repository\ctrl().

                                     : void
     {
         $cmd = $this->ctrl->getCmd();
 
         switch ($cmd) {
             case self::CMD_CANCEL:
                 $this->ctrl->redirect($this, self::CMD_MANAGE_CONTENT);
                 break;
             case self::CMD_MANAGE_CONTENT:
             case self::CMD_SAVE:
             case self::CMD_DELETE:
             case self::CMD_CONFIRM_DELETE:
                 $this->$cmd();
                 break;
             default:
                 throw new ilException("ilObjLearningSequenceContentGUI: Command not supported: $cmd");
         }
     }

Here is the call graph for this function:

◆ getFieldName()

ilObjLearningSequenceContentGUI::getFieldName	(	string	$field_name,
		int	$ref_id
	)

Definition at line 181 of file class.ilObjLearningSequenceContentGUI.php.

Referenced by save().

                                                                  : string
     {
         return implode('_', [$field_name, (string) $ref_id]);
     }

Here is the caller graph for this function:

◆ getPossiblePostConditionsForType()

ilObjLearningSequenceContentGUI::getPossiblePostConditionsForType ( string $type )

Returns: array<"value" => "option_text">

Definition at line 175 of file class.ilObjLearningSequenceContentGUI.php.

                                                                   : array
     {
         return $this->parent_gui->getObject()->getPossiblePostConditionsForType($type);
     }

◆ manageContent()

ilObjLearningSequenceContentGUI::manageContent ( )

protected

Definition at line 93 of file class.ilObjLearningSequenceContentGUI.php.

References $data, and renderTable().

                                       : void
     {
         // Adds a btn to the gui which allows adding possible objects.
         $this->parent_gui->showPossibleSubObjects();
 
         $data = $this->parent_gui->getObject()->getLSItems();
         // Sadly, ilTable2 only wants an array for fillRow, so we need to wrap this...
         $data = array_map(fn ($s) => [$s], $data);
         $this->renderTable($data);
     }

Here is the call graph for this function:

◆ renderTable()

ilObjLearningSequenceContentGUI::renderTable ( array $ls_items )

protected

Definition at line 104 of file class.ilObjLearningSequenceContentGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by manageContent().

                                                    : void
     {
         $table = new ilObjLearningSequenceContentTableGUI(
             $this,
             $this->parent_gui,
             self::CMD_MANAGE_CONTENT,
             $this->ctrl,
             $this->lng,
             $this->access,
             $this->ui_factory,
             $this->ui_renderer,
             new ilAdvancedSelectionListGUI(),
             $this->ls_item_online_status
         );
 
         $table->setData($ls_items);
         $table->addMultiCommand(self::CMD_CONFIRM_DELETE, $this->lng->txt("delete"));
 
         $table->addCommandButton(self::CMD_SAVE, $this->lng->txt("save"));
 
         $this->tpl->setContent($table->getHtml());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilObjLearningSequenceContentGUI::save ( )

protected

Definition at line 186 of file class.ilObjLearningSequenceContentGUI.php.

References $data, $ref_id, $refinery, ILIAS\LTI\ToolProvider\$updated, ILIAS\Repository\ctrl(), getFieldName(), and ILIAS\Repository\lng().

                              : void
     {
         $data = $this->parent_gui->getObject()->getLSItems();
         $r = $this->refinery;
 
         $updated = [];
         foreach ($data as $lsitem) {
             $ref_id = $lsitem->getRefId();
             $online = $this->getFieldName(self::FIELD_ONLINE, $ref_id);
             $order = $this->getFieldName(self::FIELD_ORDER, $ref_id);
             $condition_type = $this->getFieldName(self::FIELD_POSTCONDITION_TYPE, $ref_id);
 
             $condition_type = $this->post_wrapper->retrieve($condition_type, $r->kindlyTo()->string());
             $online = $this->post_wrapper->retrieve($online, $r->byTrying([$r->kindlyTo()->bool(), $r->always(false)]));
             $order = $this->post_wrapper->retrieve($order, $r->kindlyTo()->int());
 
             $condition = $lsitem->getPostCondition()
                 ->withConditionOperator($condition_type);
             $updated[] = $lsitem
                 ->withOnline($online)
                 ->withOrderNumber($order)
                 ->withPostCondition($condition);
         }
 
         $this->parent_gui->getObject()->storeLSItems($updated);
         $this->tpl->setOnScreenMessage("success", $this->lng->txt('entries_updated'), true);
         $this->ctrl->redirect($this, self::CMD_MANAGE_CONTENT);
     }