ilObjLearningModuleListGUI Class Reference
Class ilObjLearningModuleListGUI. More...
Inheritance diagram for ilObjLearningModuleListGUI:
Collaboration diagram for ilObjLearningModuleListGUI:
Public Member Functions | |
| ilObjLearningModuleListGUI () | |
| constructor More... | |
| init () | |
| initialisation More... | |
| setChildId ($a_child_id) | |
| getChildId () | |
| getCommandLink ($a_cmd) | |
| Overwrite this method, if link target is not build by ctrl class (e.g. More... | |
| getCommandFrame ($a_cmd) | |
| Get command target frame. More... | |
| getProperties () | |
| Get item properties. More... | |
| getCommandImage ($a_cmd) | |
| Get command icon image. More... | |
| Public Member Functions inherited from ilObjectListGUI | |
| ilObjectListGUI () | |
| constructor More... | |
| setContainerObject ($container_obj) | |
| set the container object (e.g categorygui) Used for link, delete ... commands More... | |
| getContainerObject () | |
| get container object More... | |
| init () | |
| initialisation More... | |
| enableProperties ($a_status) | |
| En/disable properties. More... | |
| getPropertiesStatus () | |
| enablePreconditions ($a_status) | |
| En/disable preconditions. More... | |
| getNoticePropertiesStatus () | |
| enableNoticeProperties ($a_status) | |
| En/disable notices. More... | |
| getPreconditionsStatus () | |
| enableDescription ($a_status) | |
| En/disable description. More... | |
| getDescriptionStatus () | |
| getSearchFragmentStatus () | |
| Show hide search result fragments. More... | |
| enableSearchFragments ($a_status) | |
| En/disable description. More... | |
| enableLinkedPath ($a_status) | |
| Enable linked path. More... | |
| enabledRelevance () | |
| enabled relevance More... | |
| enableRelevance ($a_status) | |
| enable relevance More... | |
| setRelevance ($a_rel) | |
| set relevance More... | |
| getRelevance () | |
| get relevance More... | |
| enableIcon ($a_status) | |
| En/Dis-able icons. More... | |
| getIconStatus () | |
| Are icons enabled? More... | |
| enableCheckbox ($a_status) | |
| En/Dis-able checkboxes. More... | |
| getCheckboxStatus () | |
| Are checkboxes enabled? More... | |
| enableExpand ($a_status) | |
| En/Dis-able expand/collapse link. More... | |
| getExpandStatus () | |
| Is expand/collapse enabled. More... | |
| setExpanded ($a_status) | |
| isExpanded () | |
| setPositionInputField ($a_field_index, $a_position_value) | |
| Set position input field. More... | |
| enableDelete ($a_status) | |
| En/disable delete. More... | |
| getDeleteStatus () | |
| enableCut ($a_status) | |
| En/disable cut. More... | |
| getCutStatus () | |
| enableCopy ($a_status) | |
| En/disable copy. More... | |
| getCopyStatus () | |
| enableSubscribe ($a_status) | |
| En/disable subscribe. More... | |
| getSubscribeStatus () | |
| enablePayment ($a_status) | |
| En/disable payment. More... | |
| getPaymentStatus () | |
| enableLink ($a_status) | |
| En/disable link. More... | |
| getLinkStatus () | |
| enablePath ($a_path, $a_start_node=null) | |
| En/disable path. More... | |
| getPathStatus () | |
| enableCommands ($a_status, $a_std_only=false) | |
| En/disable commands. More... | |
| getCommandsStatus () | |
| enableInfoScreen ($a_info_screen) | |
| En/disable path. More... | |
| addSubItemHTML ($a_html) | |
| Add HTML for subitem (used for sessions) More... | |
| getInfoScreenStatus () | |
| enableProgressInfo ($a_status) | |
| enable progress info More... | |
| getProgressInfoStatus () | |
| get progress info status More... | |
| enableSubstitutions ($a_status) | |
| Enable substitutions. More... | |
| getSubstitutionStatus () | |
| Get substitution status. More... | |
| enableItemDetailLinks ($a_status) | |
| enable item detail links E.g Direct links to chapters or pages More... | |
| getItemDetailLinkStatus () | |
| get item detail link status More... | |
| setItemDetailLinks ($a_detail_links, $a_intro_txt='') | |
| set items detail links More... | |
| insertItemDetailLinks () | |
| insert item detail links More... | |
| setTitle ($a_title) | |
| getTitle () | |
| getTitle overwritten in class.ilObjLinkResourceList.php More... | |
| setDescription ($a_description) | |
| getDescription () | |
| getDescription overwritten in class.ilObjLinkResourceList.php More... | |
| setSearchFragment ($a_text) | |
| set search fragment More... | |
| getSearchFragment () | |
| get search fragment More... | |
| setSeparateCommands ($a_val) | |
| Set separate commands. More... | |
| getSeparateCommands () | |
| Get separate commands. More... | |
| getCommandId () | |
| get command id Normally the ref id. More... | |
| setAdditionalInformation ($a_val) | |
| Set additional information. More... | |
| getAdditionalInformation () | |
| Get additional information. More... | |
| setDetailsLevel ($a_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 () | |
| Get current details level. More... | |
| enableRepositoryTransfer ($a_value) | |
| Enable copy/move to repository (from personal workspace) More... | |
| restrictToGoto ($a_value) | |
| Restrict all actions/links to goto. More... | |
| checkCommandAccess ($a_permission, $a_cmd, $a_ref_id, $a_type, $a_obj_id="") | |
| initItem ($a_ref_id, $a_obj_id, $a_title="", $a_description="", $a_context=self::CONTEXT_REPOSITORY) | |
| inititialize new item (is called by getItemHTML()) More... | |
| setConditionTarget ($a_ref_id, $a_obj_id, $a_target_type) | |
| resetConditionTarget () | |
| disableTitleLink ($a_status) | |
| setDefaultCommandParameters (array $a_params) | |
| createDefaultCommand ($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 ($a_cmd) | |
| Get command link url. More... | |
| getCommandFrame ($a_cmd) | |
| Get command target frame. More... | |
| getCommandImage ($a_cmd) | |
| Get command icon image. More... | |
| getProperties ($a_item='') | |
| Get item properties. More... | |
| addCustomProperty ($a_property="", $a_value="", $a_alert=false, $a_newline=false) | |
| add custom property More... | |
| getCustomProperties ($a_prop) | |
| get custom properties More... | |
| getAlertProperties () | |
| get all alert properties More... | |
| getNoticeProperties () | |
| get notice properties More... | |
| addCustomCommand ($a_link, $a_lang_var, $a_frame="", $onclick="") | |
| add a custom command More... | |
| forceVisibleOnly ($a_stat) | |
| Force visible access only. More... | |
| isVisibleOnlyForced () | |
| Force unreadable. More... | |
| 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 () | |
| insert item title More... | |
| insertSubstitutions () | |
| Insert substitutions. More... | |
| insertDescription () | |
| insert item description More... | |
| insertSearchFragment () | |
| Insert highlighted search fragment. More... | |
| insertRelevance () | |
| insert relevance More... | |
| setMode ($a_mode) | |
| set output mode More... | |
| getMode () | |
| get output mode More... | |
| setConditionDepth ($a_depth) | |
| set depth for precondition output (stops at level 5) More... | |
| isMode ($a_mode) | |
| check current output mode More... | |
| insertProperties ($a_item='') | |
| insert properties More... | |
| insertNoticeProperties () | |
| insertPayment () | |
| insert payment information More... | |
| insertPreconditions () | |
| insert all missing preconditions More... | |
| insertCommand ($a_href, $a_text, $a_frame="", $a_img="", $a_cmd="", $a_onclick="") | |
| insert command button More... | |
| insertDeleteCommand () | |
| insert cut command More... | |
| insertLinkCommand () | |
| insert link command More... | |
| insertCutCommand ($a_to_repository=false) | |
| insert cut command More... | |
| insertCopyCommand ($a_to_repository=false) | |
| Insert copy command. More... | |
| insertPasteCommand () | |
| Insert paste command. More... | |
| insertSubscribeCommand () | |
| insert subscribe command More... | |
| insertInfoScreenCommand () | |
| insert info screen command More... | |
| insertCommonSocialCommands ($a_header_actions=false) | |
| Insert common social commands (comments, notes, tagging) More... | |
| insertTimingsCommand () | |
| insert edit timings command More... | |
| insertCommands ($a_use_asynch=false, $a_get_asynch_commands=false, $a_asynch_url="", $a_header_actions=false) | |
| insert all commands into html code More... | |
| enableComments ($a_value, $a_enable_comments_settings=true) | |
| Toogle comments action status. More... | |
| enableNotes ($a_value) | |
| Toogle notes action status. More... | |
| enableTags ($a_value) | |
| Toogle tags action status. More... | |
| enableRating ($a_value, $a_text=null, $a_categories=false, array $a_ctrl_path=null) | |
| Toogle rating action status. More... | |
| enableMultiDownload ($a_value) | |
| Toggles whether multiple objects can be downloaded at once or not. More... | |
| insertMultiDownloadCommand () | |
| enableDownloadCheckbox ($a_ref_id, $a_value) | |
| getDownloadCheckboxState () | |
| setHeaderSubObject ($a_type, $a_id) | |
| Set sub object identifier. More... | |
| addHeaderIcon ($a_id, $a_img, $a_tooltip=null, $a_onclick=null, $a_status_text=null, $a_href=null) | |
| addHeaderIconHTML ($a_id, $a_html) | |
| setAjaxHash ($a_hash) | |
| getHeaderAction () | |
| Get header action. More... | |
| appendRepositoryFrameParameter ($a_link) | |
| workaround: all links into the repository (from outside) must tell repository to setup the frameset More... | |
| modifySAHSlaunch ($a_link, $wtarget) | |
| workaround: SAHS in new javavasript-created window or iframe More... | |
| insertPath () | |
| insert path More... | |
| insertProgressInfo () | |
| insert progress info More... | |
| insertIconsAndCheckboxes () | |
| Insert icons and checkboxes. More... | |
| insertSubItems () | |
| Insert subitems. More... | |
| insertPositionField () | |
| Insert field for positioning. More... | |
| adminCommandsIncluded () | |
| returns whether any admin commands (link, delete, cut) are included in the output More... | |
| storeAccessCache () | |
| Store access cache. More... | |
| getListItemHTML ($a_ref_id, $a_obj_id, $a_title, $a_description, $a_use_asynch=false, $a_get_asynch_commands=false, $a_asynch_url="", $a_context=self::CONTEXT_REPOSITORY) | |
| Get all item information (title, commands, description) in HTML. More... | |
| setParentRefId ($a_ref_id) | |
| Set current parent ref id to enable unique js-ids (sessions, etc.) 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 ($a_bold_title) | |
| @access public @params boolean $a_bold_title set the item title bold More... | |
| isTitleBold () | |
| @access public More... | |
| enableTimings ($a_status) | |
| enable timings link More... | |
| isFileUploadAllowed () | |
| Gets a value indicating whether file uploads to this object are allowed or not. More... | |
| insertFileUpload () | |
| Inserts a file upload component. More... | |
Detailed Description
Class ilObjLearningModuleListGUI.
Definition at line 15 of file class.ilObjLearningModuleListGUI.php.
Member Function Documentation
◆ getChildId()
| ilObjLearningModuleListGUI::getChildId | ( | ) |
Definition at line 53 of file class.ilObjLearningModuleListGUI.php.
54 {
55 return $this->child_id;
56 }
◆ getCommandFrame()
| ilObjLearningModuleListGUI::getCommandFrame | ( | $a_cmd | ) |
Get command target frame.
- Parameters
-
string $a_cmd command
- Returns
- string command target frame
Reimplemented from ilObjectListGUI.
Definition at line 124 of file class.ilObjLearningModuleListGUI.php.
125 {
126 global $ilias;
127
128 switch($a_cmd)
129 {
130 case "view":
131 case "continue":
132 case 'list':
133
134 include_once 'Services/Payment/classes/class.ilPaymentObject.php';
136 !ilPaymentObject::_hasAccess($this->ref_id))
137 {
138 $frame = '';
139 }
140 else
141 {
143 //$frame = "ilContObj".$this->obj_id;
144 }
145 break;
146
147 case "edit":
148 case "properties":
150 break;
151
152 case "infoScreen":
154 break;
155
156 default:
157 $frame = "";
158 break;
159 }
160
161 return $frame;
162 }
static _getFrame($a_class, $a_type='')
Get content frame name.
Definition: class.ilFrameTargetInfo.php:18
static _isBuyable($a_ref_id, $a_subtype='')
Definition: class.ilPaymentObject.php:543
static _hasAccess($a_ref_id, $a_transaction=0, $a_subtype='')
Definition: class.ilPaymentObject.php:484
References ilFrameTargetInfo\_getFrame(), ilPaymentObject\_hasAccess(), and ilPaymentObject\_isBuyable().
Here is the call graph for this function:
◆ getCommandImage()
| ilObjLearningModuleListGUI::getCommandImage | ( | $a_cmd | ) |
Get command icon image.
Reimplemented from ilObjectListGUI.
Definition at line 222 of file class.ilObjLearningModuleListGUI.php.
223 {
224 switch ($a_cmd)
225 {
226 default:
227 return "";
228 }
229 }
◆ getCommandLink()
| ilObjLearningModuleListGUI::getCommandLink | ( | $a_cmd | ) |
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.
- Parameters
-
string $a_cmd command
Reimplemented from ilObjectListGUI.
Definition at line 67 of file class.ilObjLearningModuleListGUI.php.
68 {
69 global $ilCtrl;
70
71 switch($a_cmd)
72 {
73 case "continue":
74 $cmd_link = "ilias.php?baseClass=ilLMPresentationGUI&ref_id=".$this->ref_id.
75 "&cmd=resume";
76 break;
77
78 case "page":
79 // Used for presentation of single pages chapters in search results
80 $cmd_link = "ilias.php?baseClass=ilLMPresentationGUI&ref_id=".$this->ref_id.
81 "&obj_id=".$this->getChildId();
82 break;
83
84 case "view":
85 $cmd_link = "ilias.php?baseClass=ilLMPresentationGUI&ref_id=".$this->ref_id;
86 break;
87
88 case "edit":
89 $cmd_link = "ilias.php?baseClass=ilLMEditorGUI&ref_id=".$this->ref_id;
90 break;
91
92 case "properties":
93 $cmd_link = "ilias.php?baseClass=ilLMEditorGUI&ref_id=".$this->ref_id."&to_props=1";
94 break;
95
96 case "infoScreen":
97 $cmd_link = "ilias.php?baseClass=ilLMPresentationGUI&ref_id=".$this->ref_id.
98 "&cmd=infoScreen&file_id".$this->getChildId();
99 break;
100
101 case 'downloadFile':
102 $cmd_link = 'ilias.php?baseClass=ilLMPresentationGUI&ref_id='.$this->ref_id.
103 '&cmd=downloadFile&file_id='.$this->getChildId();
104 break;
105
106 default:
110 break;
111 }
112
113 return $cmd_link;
114 }
◆ getProperties()
| ilObjLearningModuleListGUI::getProperties | ( | ) |
Get item properties.
- Returns
- array array of property arrays: "alert" (boolean) => display as an alert property (usually in red) "property" (string) => property name "value" (string) => property value
Definition at line 173 of file class.ilObjLearningModuleListGUI.php.
174 {
175 global $lng, $rbacsystem;
176
177 $props = array();
178
179 include_once("./Modules/LearningModule/classes/class.ilObjLearningModuleAccess.php");
180
182 {
185 }
186
187 if ($rbacsystem->checkAccess('write',$this->ref_id))
188 {
191 }
192
193 if(IS_PAYMENT_ENABLED)
194 {
195 include_once("Services/Payment/classes/class.ilPaymentObject.php");
196
198 {
200 {
203 }
205 {
208 }
209 else
210 {
213 }
214 }
215 }
216 return $props;
217 }
static _isOffline($a_obj_id)
Type-specific implementation of general status.
Definition: class.ilObjContentObjectAccess.php:241
References $lng, ilPaymentObject\_hasAccess(), ilPaymentObject\_isBuyable(), ilPaymentObject\_isInCart(), and ilObjContentObjectAccess\_isOffline().
Here is the call graph for this function:
◆ ilObjLearningModuleListGUI()
| ilObjLearningModuleListGUI::ilObjLearningModuleListGUI | ( | ) |
constructor
Definition at line 21 of file class.ilObjLearningModuleListGUI.php.
22 {
23 $this->ilObjectListGUI();
24 }
References ilObjectListGUI\ilObjectListGUI().
Here is the call graph for this function:
◆ init()
| ilObjLearningModuleListGUI::init | ( | ) |
initialisation
this method should be overwritten by derived classes
Reimplemented from ilObjectListGUI.
Definition at line 31 of file class.ilObjLearningModuleListGUI.php.
32 {
33 $this->static_link_enabled = true;
34 $this->delete_enabled = true;
35 $this->cut_enabled = true;
36 $this->copy_enabled = true;
37 $this->subscribe_enabled = true;
38 $this->link_enabled = true;
39 $this->payment_enabled = true;
40 $this->info_screen_enabled = true;
41 $this->type = "lm";
42 $this->gui_class_name = "ilobjlearningmodulegui";
43
44 // general commands array
45 include_once('./Modules/LearningModule/classes/class.ilObjLearningModuleAccess.php');
46 $this->commands = ilObjLearningModuleAccess::_getCommands();
47 }
References ilObjLearningModuleAccess\_getCommands().
Here is the call graph for this function:
◆ setChildId()
| ilObjLearningModuleListGUI::setChildId | ( | $a_child_id | ) |
Definition at line 49 of file class.ilObjLearningModuleListGUI.php.
50 {
51 $this->child_id = $a_child_id;
52 }
The documentation for this class was generated from the following file:
- Modules/LearningModule/classes/class.ilObjLearningModuleListGUI.php
