|
ILIAS
trunk Revision v13.0_alpha-62-g3b72d83f2e5
|
Inheritance diagram for ilObjLearningSequenceContentGUI:
Collaboration diagram for ilObjLearningSequenceContentGUI:Public Member Functions | |
| __construct (protected \ilObjLearningSequenceGUI|ilObjLearningSequenceContentGUI $parent_gui, protected \ilCtrl $ctrl, protected \ilGlobalTemplateInterface $tpl, protected \ilLanguage $lng, protected \ilAccessHandler $access, protected \ilConfirmationGUI $confirmation_gui, protected \LSItemOnlineStatus $ls_item_online_status, protected RequestWrapper $query_wrapper, protected RequestWrapper $post_wrapper, protected Factory $refinery, protected \ILIAS\UI\Factory $ui_factory, protected Renderer $ui_renderer, protected ServerRequestInterface $request) | |
| Creates the content management GUI. More... | |
| setContent (string $html) | |
| Sets the page content. More... | |
| showPossibleSubObjects () | |
| Renders the "add new object" drilldown (AddNewItemGUI) into the toolbar of the content management view. More... | |
| executeCommand () | |
| Executes the requested content management command. More... | |
| getUnsafeGetCommands () | |
| All commands modifying the learning sequence or its items. More... | |
| getSafePostCommands () | |
| @inheritDoc More... | |
| getTableActionHandler () | |
| Creates a handler for table actions. More... | |
| setConditionAlways () | |
| Sets the selected item's postcondition to always allow proceeding. More... | |
| setConditionLP () | |
| Sets the selected item's postcondition to require learning progress. More... | |
| cut () | |
| Forwards the cut command to the parent GUI. More... | |
| copy () | |
| Forwards the copy command to the parent GUI. More... | |
| link () | |
| Forwards the link command to the parent GUI. More... | |
| settings () | |
| Opens the settings page of the selected item. More... | |
| setOnline () | |
| Sets the selected item online. More... | |
| setOffline () | |
| Sets the selected item offline. More... | |
| extractItemRefId () | |
| Extracts the selected item reference ID from the request. More... | |
| getUnsafeGetCommands () | |
| This method must return a list of unsafe GET commands. More... | |
| getSafePostCommands () | |
| This method must return a list of safe POST commands. More... | |
Data Fields | |
| const string | CMD_MANAGE_CONTENT = "manageContent" |
| const string | CMD_SAVE = "save" |
| const string | CMD_DELETE = "delete" |
| const string | CMD_CONFIRM_DELETE = "confirmDelete" |
| const string | CMD_CANCEL = "cancel" |
| const string | CMD_SET_ONLINE = "setOnline" |
| const string | CMD_SET_OFFLINE = "setOffline" |
| const string | CMD_SET_START_OBJECT = "setStartObject" |
| const string | CMD_UNSET_START_OBJECT = "unsetStartObject" |
| const string | CMD_SET_END_OBJECT = "setEndObject" |
| const string | CMD_UNSET_END_OBJECT = "unsetEndObject" |
| const string | CMD_SET_CONDITION_ALWAYS = "setConditionAlways" |
| const string | CMD_SET_CONDITION_LP = "setConditionLP" |
| const string | CMD_REORDER = "reorder" |
| const string | CMD_CUT = "cut" |
| const string | CMD_COPY = "copy" |
| const string | CMD_LINK = "link" |
| const string | CMD_SETTINGS = "settings" |
| const string | CMD_VIEW = "view" |
| const string | FIELD_ORDER = 'f_order' |
| const string | FIELD_ONLINE = 'f_online' |
| const string | FIELD_POSTCONDITION_TYPE = 'f_pct' |
Private Member Functions | |
| assertWriteAccess () | |
| Guards the whole gui: without write permission the user is sent back to the object view. More... | |
| forwardToConditionsGUI () | |
| Forwards to the conditions gui when it is the next class in the control flow. More... | |
| resolveCommand () | |
| Determines the command to run, resolving the aliases used by the ordering table and the generic "cancel"/"view" commands. More... | |
| dispatchCommand (string $cmd) | |
| Main controller logic: a command is either delegated to the mode specific content controller or executed by one of the few internal methods of this gui. More... | |
| createContentController () | |
| Builds the content controller matching the current LSO mode. More... | |
| setPostConditionOperator (string $operator) | |
| Sets the postcondition operator of the selected item. More... | |
| forwardClipboardCommand (string $cmd) | |
| Forwards a clipboard command for the selected item to the parent GUI. More... | |
| getObjectSettingsLink (int $ref_id) | |
| Determines the "settings" link of the given item by asking its object list gui, so the action points to the object's own settings and not to the content gui. More... | |
Private Attributes | |
| const array | INTERNAL_COMMANDS |
| Commands handled by this gui itself (a few internal object actions). More... | |
Definition at line 48 of file class.ilObjLearningSequenceContentGUI.php.
| ilObjLearningSequenceContentGUI::__construct | ( | protected \ilObjLearningSequenceGUI|ilObjLearningSequenceContentGUI | $parent_gui, |
| protected \ilCtrl | $ctrl, | ||
| protected \ilGlobalTemplateInterface | $tpl, | ||
| protected \ilLanguage | $lng, | ||
| protected \ilAccessHandler | $access, | ||
| protected \ilConfirmationGUI | $confirmation_gui, | ||
| protected \LSItemOnlineStatus | $ls_item_online_status, | ||
| protected RequestWrapper | $query_wrapper, | ||
| protected RequestWrapper | $post_wrapper, | ||
| protected Factory | $refinery, | ||
| protected \ILIAS\UI\Factory | $ui_factory, | ||
| protected Renderer | $ui_renderer, | ||
| protected ServerRequestInterface | $request | ||
| ) |
Creates the content management GUI.
Definition at line 92 of file class.ilObjLearningSequenceContentGUI.php.
|
private |
Guards the whole gui: without write permission the user is sent back to the object view.
Definition at line 145 of file class.ilObjLearningSequenceContentGUI.php.
References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().
Referenced by executeCommand().
Here is the call graph for this function:
Here is the caller graph for this function:| ilObjLearningSequenceContentGUI::copy | ( | ) |
Forwards the copy command to the parent GUI.
Definition at line 361 of file class.ilObjLearningSequenceContentGUI.php.
References forwardClipboardCommand().
Here is the call graph for this function:
|
private |
Builds the content controller matching the current LSO mode.
Definition at line 273 of file class.ilObjLearningSequenceContentGUI.php.
References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilLearningSequenceSettings\MODE_ADAPTIVE.
Referenced by dispatchCommand().
Here is the call graph for this function:
Here is the caller graph for this function:| ilObjLearningSequenceContentGUI::cut | ( | ) |
Forwards the cut command to the parent GUI.
Definition at line 353 of file class.ilObjLearningSequenceContentGUI.php.
References ilObjLearningSequenceGUI\CMD_CUT, and forwardClipboardCommand().
Here is the call graph for this function:
|
private |
Main controller logic: a command is either delegated to the mode specific content controller or executed by one of the few internal methods of this gui.
Definition at line 253 of file class.ilObjLearningSequenceContentGUI.php.
References createContentController().
Referenced by executeCommand().
Here is the call graph for this function:
Here is the caller graph for this function:| ilObjLearningSequenceContentGUI::executeCommand | ( | ) |
Executes the requested content management command.
Definition at line 130 of file class.ilObjLearningSequenceContentGUI.php.
References assertWriteAccess(), dispatchCommand(), forwardToConditionsGUI(), and resolveCommand().
Here is the call graph for this function:| ilObjLearningSequenceContentGUI::extractItemRefId | ( | ) |
Extracts the selected item reference ID from the request.
Definition at line 480 of file class.ilObjLearningSequenceContentGUI.php.
References ILIAS\Repository\int().
Referenced by forwardClipboardCommand(), setOffline(), setOnline(), setPostConditionOperator(), and settings().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Forwards a clipboard command for the selected item to the parent GUI.
Definition at line 377 of file class.ilObjLearningSequenceContentGUI.php.
References ILIAS\Repository\ctrl(), extractItemRefId(), and ILIAS\Repository\lng().
Referenced by copy(), cut(), and link().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Forwards to the conditions gui when it is the next class in the control flow.
Returns true when the command was handled here.
| ilCtrlException |
Definition at line 158 of file class.ilObjLearningSequenceContentGUI.php.
References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().
Referenced by executeCommand().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Determines the "settings" link of the given item by asking its object list gui, so the action points to the object's own settings and not to the content gui.
Definition at line 414 of file class.ilObjLearningSequenceContentGUI.php.
References ilObjectListGUIFactory\_getListGUIByType(), ilObject\_lookupObjId(), and ilObject\_lookupType().
Referenced by settings().
Here is the call graph for this function:
Here is the caller graph for this function:| ilObjLearningSequenceContentGUI::getSafePostCommands | ( | ) |
@inheritDoc
Implements ilCtrlSecurityInterface.
Definition at line 211 of file class.ilObjLearningSequenceContentGUI.php.
| ilObjLearningSequenceContentGUI::getTableActionHandler | ( | ) |
Creates a handler for table actions.
Definition at line 298 of file class.ilObjLearningSequenceContentGUI.php.
References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().
Here is the call graph for this function:| ilObjLearningSequenceContentGUI::getUnsafeGetCommands | ( | ) |
All commands modifying the learning sequence or its items.
They are reached by links (dropdown entries, table actions) and therefore need to be protected by an ilCtrl CSRF token.
@inheritDoc
Implements ilCtrlSecurityInterface.
Definition at line 192 of file class.ilObjLearningSequenceContentGUI.php.
References CMD_DELETE, CMD_REORDER, CMD_SET_CONDITION_ALWAYS, CMD_SET_CONDITION_LP, CMD_SET_END_OBJECT, CMD_SET_OFFLINE, CMD_SET_ONLINE, CMD_SET_START_OBJECT, CMD_UNSET_END_OBJECT, and CMD_UNSET_START_OBJECT.
| ilObjLearningSequenceContentGUI::link | ( | ) |
Forwards the link command to the parent GUI.
Definition at line 369 of file class.ilObjLearningSequenceContentGUI.php.
References ilObjLearningSequenceGUI\CMD_LINK, and forwardClipboardCommand().
Here is the call graph for this function:
|
private |
Determines the command to run, resolving the aliases used by the ordering table and the generic "cancel"/"view" commands.
The ordering table's actions carry their command in the query parameter "lso_content_seq_cmd" and target the table's form action (cmd=post with fallback command "reorder"). ilCtrl only resolves "reorder" for such a request if the CSRF token is valid, so the table command is only accepted in that case. Otherwise the token check could be bypassed.
Definition at line 226 of file class.ilObjLearningSequenceContentGUI.php.
References CMD_MANAGE_CONTENT, and ILIAS\Repository\ctrl().
Referenced by executeCommand().
Here is the call graph for this function:
Here is the caller graph for this function:| ilObjLearningSequenceContentGUI::setConditionAlways | ( | ) |
Sets the selected item's postcondition to always allow proceeding.
Definition at line 313 of file class.ilObjLearningSequenceContentGUI.php.
References ilLSPostCondition\OPERATOR_ALWAYS, and setPostConditionOperator().
Here is the call graph for this function:| ilObjLearningSequenceContentGUI::setConditionLP | ( | ) |
Sets the selected item's postcondition to require learning progress.
Definition at line 321 of file class.ilObjLearningSequenceContentGUI.php.
References ilLSPostCondition\OPERATOR_LP, and setPostConditionOperator().
Here is the call graph for this function:| ilObjLearningSequenceContentGUI::setContent | ( | string | $html | ) |
Sets the page content.
Definition at line 112 of file class.ilObjLearningSequenceContentGUI.php.
| ilObjLearningSequenceContentGUI::setOffline | ( | ) |
Sets the selected item offline.
Definition at line 458 of file class.ilObjLearningSequenceContentGUI.php.
References ILIAS\Repository\ctrl(), extractItemRefId(), ilObjLearningSequence\getInstanceByRefId(), and ILIAS\Repository\lng().
Here is the call graph for this function:| ilObjLearningSequenceContentGUI::setOnline | ( | ) |
Sets the selected item online.
Definition at line 436 of file class.ilObjLearningSequenceContentGUI.php.
References ILIAS\Repository\ctrl(), extractItemRefId(), ilObjLearningSequence\getInstanceByRefId(), and ILIAS\Repository\lng().
Here is the call graph for this function:
|
private |
Sets the postcondition operator of the selected item.
Definition at line 329 of file class.ilObjLearningSequenceContentGUI.php.
References ILIAS\Repository\ctrl(), extractItemRefId(), ilObjLearningSequence\getInstanceByRefId(), and ILIAS\Repository\lng().
Referenced by setConditionAlways(), and setConditionLP().
Here is the call graph for this function:
Here is the caller graph for this function:| ilObjLearningSequenceContentGUI::settings | ( | ) |
Opens the settings page of the selected item.
Definition at line 392 of file class.ilObjLearningSequenceContentGUI.php.
References ILIAS\Repository\ctrl(), extractItemRefId(), getObjectSettingsLink(), and ILIAS\Repository\lng().
Here is the call graph for this function:| ilObjLearningSequenceContentGUI::showPossibleSubObjects | ( | ) |
Renders the "add new object" drilldown (AddNewItemGUI) into the toolbar of the content management view.
Delegates to the parent object gui which knows the creatable sub object types.
Definition at line 122 of file class.ilObjLearningSequenceContentGUI.php.
| const string ilObjLearningSequenceContentGUI::CMD_CANCEL = "cancel" |
Definition at line 54 of file class.ilObjLearningSequenceContentGUI.php.
| const string ilObjLearningSequenceContentGUI::CMD_CONFIRM_DELETE = "confirmDelete" |
Definition at line 53 of file class.ilObjLearningSequenceContentGUI.php.
Referenced by ILIAS\LearningSequence\Content\Sequential\LSOSequentialTable\buildTable(), and ILIAS\LearningSequence\Content\Sequential\LSOSequentialContent\getSupportedCommands().
| const string ilObjLearningSequenceContentGUI::CMD_COPY = "copy" |
Definition at line 65 of file class.ilObjLearningSequenceContentGUI.php.
| const string ilObjLearningSequenceContentGUI::CMD_CUT = "cut" |
Definition at line 64 of file class.ilObjLearningSequenceContentGUI.php.
| const string ilObjLearningSequenceContentGUI::CMD_DELETE = "delete" |
Definition at line 52 of file class.ilObjLearningSequenceContentGUI.php.
Referenced by ILIAS\LearningSequence\Content\buildDeleteModal(), ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveTable\buildDeleteModal(), ILIAS\LearningSequence\Content\Sequential\LSOSequentialContent\confirmDelete(), ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveContent\getSupportedCommands(), ILIAS\LearningSequence\Content\Sequential\LSOSequentialContent\getSupportedCommands(), and getUnsafeGetCommands().
| const string ilObjLearningSequenceContentGUI::CMD_LINK = "link" |
Definition at line 66 of file class.ilObjLearningSequenceContentGUI.php.
| const string ilObjLearningSequenceContentGUI::CMD_MANAGE_CONTENT = "manageContent" |
Definition at line 50 of file class.ilObjLearningSequenceContentGUI.php.
Referenced by ILIAS\LearningSequence\Content\Sequential\LSOSequentialContent\confirmDelete(), ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveContent\getSupportedCommands(), ILIAS\LearningSequence\Content\Sequential\LSOSequentialContent\getSupportedCommands(), ILIAS\LearningSequence\Content\Sequential\LSOSequentialContent\manageContent(), ILIAS\LearningSequence\Content\Sequential\LSOSequentialContent\reorder(), resolveCommand(), ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveContent\setEndObject(), ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveContent\setStartObject(), ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveContent\unsetEndObject(), and ILIAS\LearningSequence\Content\Adaptive\LSOAdaptiveContent\unsetStartObject().
| const string ilObjLearningSequenceContentGUI::CMD_REORDER = "reorder" |
Definition at line 63 of file class.ilObjLearningSequenceContentGUI.php.
Referenced by ILIAS\LearningSequence\Content\Sequential\LSOSequentialContent\getSupportedCommands(), getUnsafeGetCommands(), ILIAS\LearningSequence\Content\Sequential\LSOSequentialContent\manageContent(), and ILIAS\LearningSequence\Content\Sequential\LSOSequentialContent\reorder().
| const string ilObjLearningSequenceContentGUI::CMD_SAVE = "save" |
Definition at line 51 of file class.ilObjLearningSequenceContentGUI.php.
| const string ilObjLearningSequenceContentGUI::CMD_SET_CONDITION_ALWAYS = "setConditionAlways" |
Definition at line 61 of file class.ilObjLearningSequenceContentGUI.php.
Referenced by ILIAS\LearningSequence\Content\Sequential\LSOSequentialContent\getSpecificActions(), and getUnsafeGetCommands().
| const string ilObjLearningSequenceContentGUI::CMD_SET_CONDITION_LP = "setConditionLP" |
Definition at line 62 of file class.ilObjLearningSequenceContentGUI.php.
Referenced by ILIAS\LearningSequence\Content\Sequential\LSOSequentialContent\getSpecificActions(), and getUnsafeGetCommands().
| const string ilObjLearningSequenceContentGUI::CMD_SET_END_OBJECT = "setEndObject" |
| const string ilObjLearningSequenceContentGUI::CMD_SET_OFFLINE = "setOffline" |
Definition at line 56 of file class.ilObjLearningSequenceContentGUI.php.
Referenced by ILIAS\LearningSequence\Content\LSOTableActionHandler\appendOnlineOfflineActions(), and getUnsafeGetCommands().
| const string ilObjLearningSequenceContentGUI::CMD_SET_ONLINE = "setOnline" |
Definition at line 55 of file class.ilObjLearningSequenceContentGUI.php.
Referenced by ILIAS\LearningSequence\Content\LSOTableActionHandler\appendOnlineOfflineActions(), and getUnsafeGetCommands().
| const string ilObjLearningSequenceContentGUI::CMD_SET_START_OBJECT = "setStartObject" |
| const string ilObjLearningSequenceContentGUI::CMD_SETTINGS = "settings" |
Definition at line 67 of file class.ilObjLearningSequenceContentGUI.php.
| const string ilObjLearningSequenceContentGUI::CMD_UNSET_END_OBJECT = "unsetEndObject" |
| const string ilObjLearningSequenceContentGUI::CMD_UNSET_START_OBJECT = "unsetStartObject" |
| const string ilObjLearningSequenceContentGUI::CMD_VIEW = "view" |
Definition at line 68 of file class.ilObjLearningSequenceContentGUI.php.
| const string ilObjLearningSequenceContentGUI::FIELD_ONLINE = 'f_online' |
Definition at line 86 of file class.ilObjLearningSequenceContentGUI.php.
| const string ilObjLearningSequenceContentGUI::FIELD_ORDER = 'f_order' |
Definition at line 85 of file class.ilObjLearningSequenceContentGUI.php.
| const string ilObjLearningSequenceContentGUI::FIELD_POSTCONDITION_TYPE = 'f_pct' |
Definition at line 87 of file class.ilObjLearningSequenceContentGUI.php.
|
private |
Commands handled by this gui itself (a few internal object actions).
Everything else is delegated to the mode specific content controller.
Definition at line 74 of file class.ilObjLearningSequenceContentGUI.php.