ilObjRootFolderListGUI Class Reference
Class ilObjRootFolderListGUI. More...
Inheritance diagram for ilObjRootFolderListGUI:
Collaboration diagram for ilObjRootFolderListGUI:
Public Member Functions | |
| init () | |
| initialisation More... | |
| getCommandLink (string $cmd) | |
| Get command link url. More... | |
| Public Member Functions inherited from ilObjectListGUI | |
| setContainerObject (object $container_obj) | |
| getContainerObject () | |
| init () | |
| initialisation More... | |
| enableProperties (bool $status) | |
| getPropertiesStatus () | |
| enablePreconditions (bool $status) | |
| getPreconditionsStatus () | |
| enableNoticeProperties (bool $status) | |
| getNoticePropertiesStatus () | |
| enableDescription (bool $status) | |
| getDescriptionStatus () | |
| enableSearchFragments (bool $status) | |
| getSearchFragmentStatus () | |
| enableLinkedPath (bool $status) | |
| enableRelevance (bool $status) | |
| enabledRelevance () | |
| setRelevance (int $rel) | |
| getRelevance () | |
| enableIcon (bool $status) | |
| getIconStatus () | |
| enableCheckbox (bool $status) | |
| getCheckboxStatus () | |
| enableExpand (bool $status) | |
| getExpandStatus () | |
| setExpanded (bool $status) | |
| isExpanded () | |
| setPositionInputField (string $field_index, string $position_value) | |
| enableDelete (bool $status) | |
| getDeleteStatus () | |
| enableCut (bool $status) | |
| getCutStatus () | |
| enableCopy (bool $status) | |
| getCopyStatus () | |
| enableSubscribe (bool $status) | |
| getSubscribeStatus () | |
| enableLink (bool $status) | |
| getLinkStatus () | |
| enablePath (bool $path, int $start_node=0, \ilPathGUI $path_gui=null) | |
| getPathStatus () | |
| enableCommands (bool $status, bool $std_only=false) | |
| getCommandsStatus () | |
| enableInfoScreen (bool $info_screen) | |
| getInfoScreenStatus () | |
| addSubItemHTML (string $html) | |
| Add HTML for sub item (used for sessions) More... | |
| enableProgressInfo (bool $status) | |
| getProgressInfoStatus () | |
| enableSubstitutions (bool $status) | |
| getSubstitutionStatus () | |
| enableItemDetailLinks (bool $status) | |
| enable item detail links E.g Direct links to chapters or pages More... | |
| getItemDetailLinkStatus () | |
| get item detail link status More... | |
| setItemDetailLinks (array $detail_links, string $intro_txt='') | |
| set items detail links More... | |
| insertItemDetailLinks () | |
| setTitle (string $title) | |
| getTitle () | |
| getTitle overwritten in class.ilObjLinkResourceList.php More... | |
| setDescription (string $description) | |
| getDescription () | |
| getDescription overwritten in class.ilObjLinkResourceList.php More... | |
| setSearchFragment (string $text) | |
| getSearchFragment () | |
| setSeparateCommands (bool $val) | |
| getSeparateCommands () | |
| getCommandId () | |
| get command id Normally the ref id. More... | |
| setAdditionalInformation (?string $val) | |
| getAdditionalInformation () | |
| setDetailsLevel (int $level) | |
| Details level Currently used in Search which shows only limited properties of forums Currently used for Sessions (switch between minimal and extended view for each session) More... | |
| getDetailsLevel () | |
| enableRepositoryTransfer (bool $value) | |
| Enable copy/move to repository (from personal workspace) More... | |
| restrictToGoto (bool $value) | |
| Restrict all actions/links to goto. More... | |
| getDefaultCommand () | |
| checkCommandAccess (string $permission, string $cmd, int $ref_id, string $type, ?int $obj_id=null) | |
| initItem (int $ref_id, int $obj_id, string $type, string $title="", string $description="") | |
| initialize new item (is called by getItemHTML()) More... | |
| setConditionTarget (int $ref_id, int $obj_id, string $target_type) | |
| resetConditionTarget () | |
| disableTitleLink (bool $status) | |
| setDefaultCommandParameters (array $params) | |
| createDefaultCommand (array $command) | |
| Get default command link Overwritten for e.g categories,courses => they return a goto link If search engine visibility is enabled these object type return a goto_CLIENT_ID_cat_99.html link. More... | |
| getCommandLink (string $cmd) | |
| Get command link url. More... | |
| getCommandFrame (string $cmd) | |
| Get command target frame. More... | |
| getCommandImage (string $cmd) | |
| Get command icon image. More... | |
| getProperties () | |
| Get item properties. More... | |
| addCustomProperty (string $property="", string $value="", bool $alert=false, bool $newline=false) | |
| getCustomProperties (array $prop) | |
| getAlertProperties () | |
| getNoticeProperties () | |
| addCustomCommand (string $link, string $lang_var, string $frame="", string $onclick="") | |
| addCustomCommandButton (Button $button, ?Modal $triggeredModal=null) | |
| forceVisibleOnly (bool $stat) | |
| isVisibleOnlyForced () | |
| getCommands () | |
| get all current commands for a specific ref id (in the permission context of the current user) More... | |
| getIconImageType () | |
| Returns the icon image type. More... | |
| insertTitle () | |
| insertSubstitutions () | |
| insertDescription () | |
| insertSearchFragment () | |
| Insert highlighted search fragment. More... | |
| insertRelevance () | |
| setMode (string $mode) | |
| set output mode More... | |
| getMode () | |
| get output mode More... | |
| setConditionDepth (int $depth) | |
| set depth for precondition output (stops at level 5) More... | |
| isMode (string $mode) | |
| check current output mode More... | |
| determineProperties () | |
| insertProperties () | |
| insertNoticeProperties () | |
| insertPreconditions () | |
| insert all missing preconditions More... | |
| insertCommand (string $href, string $text, string $frame="", string $img="", string $cmd="", string $onclick="") | |
| insert command button More... | |
| insertDeleteCommand () | |
| insertLinkCommand () | |
| insertCutCommand (bool $to_repository=false) | |
| insertCopyCommand (bool $to_repository=false) | |
| insertPasteCommand () | |
| insertSubscribeCommand () | |
| insertInfoScreenCommand () | |
| insertCommonSocialCommands (bool $header_actions=false) | |
| Insert common social commands (comments, notes, tagging) More... | |
| insertTimingsCommand () | |
| insertCommands (bool $use_async=false, bool $get_async_commands=false, string $async_url="", bool $header_actions=false) | |
| insert all commands into html code More... | |
| enableComments (bool $value, bool $enable_comments_settings=true) | |
| enableNotes (bool $value) | |
| enableTags (bool $value) | |
| enableRating (bool $value, string $text=null, bool $categories=false, array $ctrl_path=null, bool $force_rate_parent=false) | |
| enableMultiDownload (bool $value) | |
| Toggles whether multiple objects can be downloaded at once or not. More... | |
| insertMultiDownloadCommand () | |
| enableDownloadCheckbox (int $ref_id) | |
| getDownloadCheckboxState () | |
| setHeaderSubObject (?string $type, ?int $id) | |
| addHeaderIcon (string $id, string $img, string $tooltip=null, string $onclick=null, string $status_text=null, string $href=null) | |
| addHeaderIconHTML (string $id, string $html) | |
| addHeaderGlyph (string $id, ILIAS\UI\Component\Symbol\Glyph\Glyph $glyph, $onclick=null) | |
| setAjaxHash (string $hash) | |
| getHeaderAction (ilGlobalTemplateInterface $main_tpl=null) | |
| appendRepositoryFrameParameter (string $link) | |
| workaround: all links into the repository (from outside) must tell repository to set up the frameset More... | |
| modifySAHSlaunch (string $link, string $wtarget) | |
| workaround: SAHS in new javavasript-created window or iframe More... | |
| insertPath () | |
| insertProgressInfo () | |
| insertIconsAndCheckboxes () | |
| getTypeIcon () | |
| Get object type specific type icon. More... | |
| insertSubItems () | |
| insertPositionField () | |
| adminCommandsIncluded () | |
| returns whether any admin commands (link, delete, cut) are included in the output More... | |
| storeAccessCache () | |
| getListItemHTML (int $ref_id, int $obj_id, string $title, string $description, bool $use_async=false, bool $get_async_commands=false, string $async_url="") | |
| Get all item information (title, commands, description) in HTML. More... | |
| setParentRefId (int $ref_id) | |
| Set current parent ref id to enable unique js-ids (sessions, etc.) More... | |
| getUniqueItemId (bool $as_div=false) | |
| Get unique item identifier (for js-actions) More... | |
| getCommandsHTML () | |
| Get commands HTML (must be called after get list item html) More... | |
| isSideBlock () | |
| Returns whether current item is a block in a side column or not. More... | |
| setBoldTitle (bool $bold_title) | |
| isTitleBold () | |
| enableTimings (bool $status) | |
| enable timings link More... | |
| getAsListItem (int $ref_id, int $obj_id, string $type, string $title, string $description) | |
| Get list item ui object. More... | |
| getAsCard (int $ref_id, int $obj_id, string $type, string $title, string $description) | |
| Get card object. More... | |
| checkInfoPageOnAsynchronousRendering () | |
| insertLPCommand () | |
| insert learning progress command More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ilObjectListGUI | |
| static | prepareJsLinks (string $redraw_url, string $notes_url, string $tags_url, ilGlobalTemplateInterface $tpl=null) |
| Insert js/ajax links into template. More... | |
| static | preloadCommonProperties (array $obj_ids, int $context) |
| Data Fields inherited from ilObjectListGUI | |
| const | IL_LIST_AS_TRIGGER = "trigger" |
| const | IL_LIST_FULL = "full" |
| const | DETAILS_MINIMAL = 10 |
| const | DETAILS_SEARCH = 20 |
| const | DETAILS_ALL = 30 |
| const | CONTEXT_REPOSITORY = 1 |
| const | CONTEXT_WORKSPACE = 2 |
| const | CONTEXT_WORKSPACE_SHARING = 4 |
| const | CONTEXT_PERSONAL_DESKTOP = 5 |
| const | CONTEXT_SEARCH = 6 |
| const | DOWNLOAD_CHECKBOX_NONE = 0 |
| const | DOWNLOAD_CHECKBOX_ENABLED = 1 |
| const | DOWNLOAD_CHECKBOX_DISABLED = 2 |
| Protected Member Functions inherited from ilObjectListGUI | |
| enableLearningProgress (bool $enabled) | |
| buildGotoLink () | |
| parseConditions (int $toggle_id, array $conditions, bool $obligatory=true) | |
| modifyTitleLink (string $default_link) | |
| resetCustomData () | |
| reset properties and commands More... | |
| isCommentsActivated (string $type, int $ref_id, int $obj_id, bool $header_actions, bool $check_write_access=true) | |
| Check comments status against comments settings and context. More... | |
| getTileImagePath () | |
| Static Protected Attributes inherited from ilObjectListGUI | |
| static array | $cnt_notes = [] |
| static array | $cnt_tags = [] |
| static array | $tags = [] |
| static array | $comments_activation = [] |
| static bool | $preload_done = false |
| static int | $js_unique_id = 0 |
| static string | $tpl_file_name = "tpl.container_list_item.html" |
| static string | $tpl_component = "Services/Container" |
Detailed Description
Class ilObjRootFolderListGUI.
Definition at line 25 of file class.ilObjRootFolderListGUI.php.
Member Function Documentation
◆ getCommandLink()
| ilObjRootFolderListGUI::getCommandLink | ( | string | $cmd | ) |
Get command link url.
Overwrite this method, if link target is not build by ctrl class (e.g. "forum.php"). This is the case for all links now, but bringing everything to ilCtrl should be realised in the future.
Reimplemented from ilObjectListGUI.
Definition at line 57 of file class.ilObjRootFolderListGUI.php.
57 : string
58 {
59 global $ilCtrl;
60
61 $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $this->ref_id);
62 $cmd_link = $ilCtrl->getLinkTargetByClass("ilrepositorygui", $cmd);
63 $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $this->root_request->getRefId());
64
65 return $cmd_link;
66 }
◆ init()
| ilObjRootFolderListGUI::init | ( | ) |
initialisation
this method should be overwritten by derived classes
Reimplemented from ilObjectListGUI.
Definition at line 43 of file class.ilObjRootFolderListGUI.php.
43 : void
44 {
45 $this->copy_enabled = false;
46 $this->delete_enabled = true;
47 $this->cut_enabled = true;
48 $this->subscribe_enabled = true;
49 $this->link_enabled = false;
50 $this->type = "root";
51 $this->gui_class_name = "ilobjrootfoldergui";
52
53 // general commands array
54 $this->commands = ilObjRootFolderAccess::_getCommands();
55 }
References ilObjRootFolderAccess\_getCommands().
Here is the call graph for this function:
Field Documentation
◆ $root_request
|
protected |
Definition at line 27 of file class.ilObjRootFolderListGUI.php.
The documentation for this class was generated from the following file:
- Modules/RootFolder/classes/class.ilObjRootFolderListGUI.php
