ilObjiLincClassroomListGUI Class Reference
Class ilObjiLincClassroomListGUI. More...
Inheritance diagram for ilObjiLincClassroomListGUI:
Collaboration diagram for ilObjiLincClassroomListGUI:
Public Member Functions | |
| ilObjiLincClassroomListGUI () | |
| constructor More... | |
| init () | |
| initialisation More... | |
| getListItemHTML ($a_icrs_ref_id, $a_icla_id, $a_title, $a_description, $a_item) | |
| Get all item information (title, commands, description) in HTML. More... | |
| initItem ($a_icrs_ref_id, $a_icla_id, $a_title, $a_description) | |
| inititialize new item (is called by getItemHTML()) More... | |
| getCommands () | |
| get all current commands for a specific ref id (in the permission context of the current user) More... | |
| getCommandLink ($a_cmd) | |
| Get command link url. More... | |
| getCommandFrame ($a_cmd) | |
| Get command target frame. More... | |
| getProperties ($a_item='') | |
| Get item properties. 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 ilObjiLincClassroomListGUI.
- Version
- $Id$
Definition at line 38 of file class.ilObjiLincClassroomListGUI.php.
Member Function Documentation
◆ getCommandFrame()
| ilObjiLincClassroomListGUI::getCommandFrame | ( | $a_cmd | ) |
Get command target frame.
Overwrite this method if link frame is not current frame
- Parameters
-
string $a_cmd command
- Returns
- string command target frame
Reimplemented from ilObjectListGUI.
Definition at line 242 of file class.ilObjiLincClassroomListGUI.php.
243 {
244 switch($a_cmd)
245 {
246 case "joinClassroom":
247 case "agendaClassroom":
248 $frame = "_blank";
249 break;
250
251 default:
252 $frame = "";
253 break;
254 }
255
256 return $frame;
257 }
Referenced by getCommands().
Here is the caller graph for this function:
◆ getCommandLink()
| ilObjiLincClassroomListGUI::getCommandLink | ( | $a_cmd | ) |
Get command link url.
Overwrite this method, if link target is not build by ctrl class (e.g. "lm_presentation.php", "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
- Returns
- string command link url
Reimplemented from ilObjectListGUI.
Definition at line 230 of file class.ilObjiLincClassroomListGUI.php.
231 {
232 // pass current class_id as ref_id
234 $this->ctrl->setParameterByClass($this->gui_class_name,"class_id",$this->ref_id);
235
236 // separate method for this line
237 $cmd_link = $this->ctrl->getLinkTargetByClass($this->gui_class_name,
238 $a_cmd);
239 return $cmd_link;
240 }
References $_GET.
Referenced by getCommands().
Here is the caller graph for this function:
◆ getCommands()
| ilObjiLincClassroomListGUI::getCommands | ( | ) |
get all current commands for a specific ref id (in the permission context of the current user)
!!!NOTE!!!: Please use getListHTML() if you want to display the item including all commands
!!!NOTE 2!!!: Please do not overwrite this method in derived classes becaus it will get pretty large and much code will be simply copy-and-pasted. Insert smaller object type related method calls instead. (like getCommandLink() or getCommandFrame())
@access public
- Parameters
-
int $a_ref_id ref id of object
- Returns
- array array of command arrays including "permission" => permission name "cmd" => command "link" => command link url "frame" => command link frame "lang_var" => language variable of command "granted" => true/false: command granted or not "access_info" => access info object (to do: implementation)
Reimplemented from ilObjectListGUI.
Definition at line 172 of file class.ilObjiLincClassroomListGUI.php.
173 {
174 global $ilAccess, $ilBench;
175
176 $ref_commands = array();
177
178 foreach($this->commands as $command)
179 {
180 $permission = $command["permission"];
182 $lang_var = $command["lang_var"];
183
184 // all access checking should be made within $ilAccess and
185 // the checkAccess of the ilObj...Access classes
187 $ilAccess->enable("cache",false);
188 $access = $ilAccess->doStatusCheck($permission, $cmd, $this->obj_id, $item_data,$this->ref_id,"icla");
189 $ilAccess->enable("cache",true);
190
191 if ($access)
192 {
195 $access_granted = true;
196 }
197 else
198 {
199 $access_granted = false;
200 //$info_object = $ilAccess->getInfo();
201 }
202
203 $ref_commands[] = array(
204 "permission" => $permission,
206 "link" => $cmd_link,
207 "frame" => $cmd_frame,
208 "lang_var" => $lang_var,
209 "granted" => $access_granted,
210 "access_info" => $info_object,
211 "default" => $command["default"]
212 );
213 }
214
215 return $ref_commands;
216 }
getCommandFrame($a_cmd)
Get command target frame.
Definition: class.ilObjiLincClassroomListGUI.php:242
References $cmd, $ilBench, ilObjectListGUI\$ref_id, getCommandFrame(), and getCommandLink().
Here is the call graph for this function:
◆ getListItemHTML()
| ilObjiLincClassroomListGUI::getListItemHTML | ( | $a_icrs_ref_id, | |
| $a_icla_id, | |||
| $a_title, | |||
| $a_description, | |||
| $a_item | |||
| ) |
Get all item information (title, commands, description) in HTML.
@access public
- Parameters
-
int $a_ref_id item reference id int $a_obj_id item object id int $a_title item title int $a_description item description
- Returns
- string html code
Definition at line 78 of file class.ilObjiLincClassroomListGUI.php.
79 {
80 // this variable stores wheter any admin commands
81 // are included in the output
82 $this->adm_commands_included = false;
83
84 // initialization
86 "Services/Container");
87
88 $this->initItem($a_icrs_ref_id, $a_icla_id, $a_title, $a_description);
89
90 // commands
91 $cmdSelList = $this->insertCommands();
92
94 {
96 {
97 $this->tpl->setVariable("COMMAND_SELECTION_LIST", $cmdSelList);
98 }
99 }
100
101 // insert title and describtion
102 $this->insertTitle();
103
105 {
107 {
108 $this->insertDescription();
109 }
110 }
111
112 // properties
114 {
115 $this->insertProperties($a_item);
116 }
117
118 // preconditions
119 //if ($this->getPreconditionsStatus())
120 //{
121 // $this->insertPreconditions();
122 //}
123
124 // path
125 //$this->insertPath();
126
127 return $this->tpl->get();
128 }
insertCommands($a_use_asynch=false, $a_get_asynch_commands=false, $a_asynch_url="", $a_header_actions=false)
insert all commands into html code
Definition: class.ilObjectListGUI.php:2704
initItem($a_icrs_ref_id, $a_icla_id, $a_title, $a_description)
inititialize new item (is called by getItemHTML())
Definition: class.ilObjiLincClassroomListGUI.php:138
special template class to simplify handling of ITX/PEAR
Definition: class.ilTemplate.php:12
References ilObjectListGUI\getCommandsStatus(), ilObjectListGUI\getDescriptionStatus(), ilObjectListGUI\getPropertiesStatus(), ilObjectListGUI\getSeparateCommands(), IL_LIST_AS_TRIGGER, initItem(), ilObjectListGUI\insertCommands(), ilObjectListGUI\insertDescription(), ilObjectListGUI\insertProperties(), ilObjectListGUI\insertTitle(), and ilObjectListGUI\isMode().
Here is the call graph for this function:
◆ getProperties()
| ilObjiLincClassroomListGUI::getProperties | ( | $a_item = '' | ) |
Get item properties.
Overwrite this method to add properties at the bottom of the item html
- Returns
- array array of property arrays: "alert" (boolean) => display as an alert property (usually in red) "property" (string) => property name "value" (string) => property value
Reimplemented from ilObjectListGUI.
Definition at line 270 of file class.ilObjiLincClassroomListGUI.php.
271 {
272 //var_dump($a_item);
273
274 global $ilias;
275
276 $props = array();
277
278 // docent
279 include_once ('./Modules/ILinc/classes/class.ilObjiLincClassroom.php');
281
282 if (!$docent)
283 {
284 $props[] = array("alert" => true, "property" => $this->lng->txt(ILINC_MEMBER_DOCENT), "value" => $this->lng->txt('ilinc_no_docent_assigned'));
285 }
286 else
287 {
288 $props[] = array("alert" => false, "property" => $this->lng->txt(ILINC_MEMBER_DOCENT), "value" => $docent);
289 }
290
291 // display offline/online status
292 if ($a_item['alwaysopen'])
293 {
294 $props[] = array("alert" => false, "property" => $this->lng->txt("status"),
295 "value" => $this->lng->txt("ilinc_classroom_always_open"));
296 }
297 else
298 {
299 $props[] = array("alert" => true, "property" => $this->lng->txt("status"),
300 "value" => $this->lng->txt("ilinc_classroom_closed"));
301 }
302
303 // display cost centers if active
304 /*
305 if ($ilias->getSetting("ilinc_akclassvalues_active"))
306 {
307$akclassvalues = ilObjiLincClassroom::_getDocent($a_item['instructoruserid']);
308
309 $value = "";
310
311 if (!empty($akclassvalues[0]))
312 {
313 $value = $akclassvalues[0];
314 $property = $lng->txt("ilinc_akclassvalue");
315
316 if (!empty($akclassvalues[1]))
317 {
318 $value .= " / ".$akclassvalues[1];
319 $property = $lng->txt("ilinc_akclassvalues");
320 }
321 }
322 elseif (!empty($akclassvalues[1]))
323 {
324 $value = $akclassvalues[1];
325 $property = $lng->txt("ilinc_akclassvalue");
326 }
327 else
328 {
329 $property = $lng->txt("ilinc_akclassvalues");
330 $value = $lng->txt("ilinc_no_akclassvalues");
331 }
332 }*/
333
334
335 return $props;
336 }
_getDocent($a_ilinc_user_id)
Definition: class.ilObjiLincClassroom.php:244
References ilObjiLincClassroom\_getDocent().
Here is the call graph for this function:
◆ ilObjiLincClassroomListGUI()
| ilObjiLincClassroomListGUI::ilObjiLincClassroomListGUI | ( | ) |
constructor
Definition at line 44 of file class.ilObjiLincClassroomListGUI.php.
45 {
46 $this->ilObjectListGUI();
47 }
References ilObjectListGUI\ilObjectListGUI().
Here is the call graph for this function:
◆ init()
| ilObjiLincClassroomListGUI::init | ( | ) |
initialisation
Reimplemented from ilObjectListGUI.
Definition at line 52 of file class.ilObjiLincClassroomListGUI.php.
53 {
54 $this->copy_enabled = false;
55 $this->delete_enabled = false;
56 $this->cut_enabled = false;
57 $this->subscribe_enabled = false;
58 $this->link_enabled = false;
59 $this->payment_enabled = false;
60 $this->type = "icla";
61 $this->gui_class_name = "ilobjilincclassroomgui";
62
63 // general commands array
64 include_once('./Modules/ILinc/classes/class.ilObjiLincClassroomAccess.php');
65 $this->commands = ilObjiLincClassroomAccess::_getCommands();
66 }
References ilObjiLincClassroomAccess\_getCommands().
Here is the call graph for this function:
◆ initItem()
| ilObjiLincClassroomListGUI::initItem | ( | $a_icrs_ref_id, | |
| $a_icla_id, | |||
| $a_title, | |||
| $a_description | |||
| ) |
inititialize new item (is called by getItemHTML())
- Parameters
-
int $a_ref_id reference id int $a_obj_id object id string $a_title title string $a_description description
Definition at line 138 of file class.ilObjiLincClassroomListGUI.php.
139 {
140 $this->ref_id = $a_icla_id;
141 $this->obj_id = $a_icrs_ref_id;
142 $this->title = $a_title;
143 $this->description = $a_description;
144
145 // checks, whether any admin commands are included in the output
146 $this->adm_commands_included = false;
147 }
Referenced by getListItemHTML().
Here is the caller graph for this function:
The documentation for this class was generated from the following file:
- Modules/ILinc/classes/class.ilObjiLincClassroomListGUI.php
