ilObjCategoryReferenceListGUI Class Reference
Inheritance diagram for ilObjCategoryReferenceListGUI:
Collaboration diagram for ilObjCategoryReferenceListGUI:
Public Member Functions | |
| __construct () | |
| Constructor. More... | |
| getIconImageType () | |
| Returns the icon image type. More... | |
| getCommandId () | |
| get command id More... | |
| init () | |
| initialisation More... | |
| initItem ($a_ref_id, $a_obj_id, $a_title="", $a_description="") | |
| inititialize new item Course reference inits the course item More... | |
| getProperties () | |
| checkCommandAccess ($a_permission, $a_cmd, $a_ref_id, $a_type) | |
| getCommandLink ($a_cmd) | |
| get command link More... | |
| Public Member Functions inherited from ilObjCategoryListGUI | |
| ilObjCategoryListGUI () | |
| constructor More... | |
| init () | |
| initialisation More... | |
| getInfoScreenStatus () | |
| getCommandFrame ($a_cmd) | |
| Get command target frame. More... | |
| getCommandLink ($a_cmd) | |
| Get command link url. 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... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ilObjectListGUI | |
| static | prepareJsLinks ($a_redraw_url, $a_notes_url, $a_tags_url, $a_tpl=null) |
| Insert js/ajax links into template More... | |
| static | preloadCommonProperties ($a_obj_ids, $a_context) |
| Preload common properties. More... | |
| Data Fields inherited from ilObjectListGUI | |
| const | DETAILS_MINIMAL = 10 |
| const | DETAILS_SEARCH = 20 |
| const | DETAILS_ALL = 30 |
| const | CONTEXT_REPOSITORY = 1 |
| const | CONTEXT_WORKSPACE = 2 |
| const | CONTEXT_SHOP = 3 |
| 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 |
| $ctrl | |
| $description_enabled = true | |
| $preconditions_enabled = true | |
| $properties_enabled = true | |
| $notice_properties_enabled = true | |
| $commands_enabled = true | |
| $cust_prop = array() | |
| $cust_commands = array() | |
| $info_screen_enabled = false | |
| $condition_depth = 0 | |
| $std_cmd_only = false | |
| $sub_item_html = array() | |
| $multi_download_enabled = false | |
| $download_checkbox_state = self::DOWNLOAD_CHECKBOX_NONE | |
| Protected Member Functions inherited from ilObjectListGUI | |
| buildGotoLink () | |
| insertPaymentCommand ($has_extension_prices=false) | |
| parseConditions ($toggle_id, $conditions, $obligatory=true) | |
| modifyTitleLink ($a_default_link) | |
| resetCustomData () | |
| reset properties and commands More... | |
| getUniqueItemId ($a_as_div=false) | |
| Get unique item identifier (for js-actions) More... | |
| isCommentsActivated ($a_type, $a_ref_id, $a_obj_id, $a_header_actions, $a_check_write_access=true) | |
| Check comments status against comments settings and context. More... | |
| Static Protected Attributes inherited from ilObjectListGUI | |
| static | $cnt_notes = array() |
| static | $cnt_tags = array() |
| static | $tags = array() |
| static | $comments_activation = array() |
| static | $preload_done = false |
| static | $js_unique_id = 0 |
| static | $tpl_file_name = "tpl.container_list_item.html" |
| static | $tpl_component = "Services/Container" |
Detailed Description
- Version
- $Id$
Definition at line 34 of file class.ilObjCategoryReferenceListGUI.php.
Constructor & Destructor Documentation
◆ __construct()
| ilObjCategoryReferenceListGUI::__construct | ( | ) |
Constructor.
@access public
Definition at line 47 of file class.ilObjCategoryReferenceListGUI.php.
48 {
49 parent::__construct();
50 }
Member Function Documentation
◆ checkCommandAccess()
| ilObjCategoryReferenceListGUI::checkCommandAccess | ( | $a_permission, | |
| $a_cmd, | |||
| $a_ref_id, | |||
| $a_type | |||
| ) |
- Parameters
-
return
Definition at line 161 of file class.ilObjCategoryReferenceListGUI.php.
162 {
163
164 // Check edit reference against reference edit permission
165 switch($a_cmd)
166 {
167 case 'editReference':
169 }
170
171 switch($a_permission)
172 {
173 case 'copy':
174 case 'delete':
175 // check against target ref_id
177
178 default:
179 // check against reference
180 return parent::checkCommandAccess($a_permission, $a_cmd, $a_ref_id, $a_type);
181 }
182 }
References getCommandId().
Here is the call graph for this function:
◆ getCommandId()
| ilObjCategoryReferenceListGUI::getCommandId | ( | ) |
get command id
@access public
- Parameters
-
return
Reimplemented from ilObjectListGUI.
Definition at line 64 of file class.ilObjCategoryReferenceListGUI.php.
References $reference_ref_id.
Referenced by checkCommandAccess(), and getCommandLink().
Here is the caller graph for this function:
◆ getCommandLink()
| ilObjCategoryReferenceListGUI::getCommandLink | ( | $a_cmd | ) |
get command link
@access public
- Parameters
-
string $a_cmd
- Returns
Reimplemented from ilObjCategoryListGUI.
Definition at line 191 of file class.ilObjCategoryReferenceListGUI.php.
192 {
193 global $ilCtrl;
194
195 switch($a_cmd)
196 {
197 case 'editReference':
201 return $cmd_link;
202
203 default:
207 return $cmd_link;
208 }
209 }
References $_GET, $ilCtrl, and getCommandId().
Here is the call graph for this function:
◆ getIconImageType()
| ilObjCategoryReferenceListGUI::getIconImageType | ( | ) |
Returns the icon image type.
For most objects, this is same as the object type, e.g. 'cat','fold'. We can return here other values, to express a specific state of an object, e.g. 'crs_offline", and/or to express a specific kind of object, e.g. 'file_inline'.
Reimplemented from ilObjectListGUI.
Definition at line 52 of file class.ilObjCategoryReferenceListGUI.php.
53 {
54 return 'catr';
55 }
◆ getProperties()
| ilObjCategoryReferenceListGUI::getProperties | ( | ) |
Definition at line 140 of file class.ilObjCategoryReferenceListGUI.php.
141 {
143
144 $props = parent::getProperties();
145
146 // offline
147 if($tree->isDeleted($this->ref_id))
148 {
151 }
152
153 return $props ? $props : array();
154 }
◆ init()
| ilObjCategoryReferenceListGUI::init | ( | ) |
initialisation
Reimplemented from ilObjCategoryListGUI.
Definition at line 72 of file class.ilObjCategoryReferenceListGUI.php.
73 {
74 $this->copy_enabled = false;
75 $this->static_link_enabled = false;
76 $this->delete_enabled = true;
77 $this->cut_enabled = true;
78 $this->subscribe_enabled = true;
79 $this->link_enabled = false;
80 $this->payment_enabled = true;
81 $this->info_screen_enabled = true;
82 $this->type = "cat";
83 $this->gui_class_name = "ilobjcategorygui";
84
85 include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDSubstitution.php');
86 $this->substitutions = ilAdvancedMDSubstitution::_getInstanceByObjectType($this->type);
87 if($this->substitutions->isActive())
88 {
89 $this->substitutions_enabled = true;
90 }
91 }
static _getInstanceByObjectType($a_type)
Singleton: use this method to get an instance.
Definition: class.ilAdvancedMDSubstitution.php:77
References ilAdvancedMDSubstitution\_getInstanceByObjectType().
Here is the call graph for this function:
◆ initItem()
| ilObjCategoryReferenceListGUI::initItem | ( | $a_ref_id, | |
| $a_obj_id, | |||
$a_title = "", |
|||
$a_description = "" |
|||
| ) |
inititialize new item Course reference inits the course item
- Parameters
-
int $a_ref_id reference id int $a_obj_id object id string $a_title title string $a_description description
Definition at line 104 of file class.ilObjCategoryReferenceListGUI.php.
105 {
106 global $ilBench,$ilAccess,$tree;
107
108 $this->reference_ref_id = $a_ref_id;
109 $this->reference_obj_id = $a_obj_id;
110
111 include_once('./Services/ContainerReference/classes/class.ilContainerReference.php');
112 $target_obj_id = ilContainerReference::_lookupTargetId($a_obj_id);
113
114 $target_ref_ids = ilObject::_getAllReferences($target_obj_id);
115 $target_ref_id = current($target_ref_ids);
116 $target_title = ilContainerReference::_lookupTitle($a_obj_id);
117 $target_description = ilObject::_lookupDescription($target_obj_id);
118
119 $this->deleted = $tree->isDeleted($target_ref_id);
120
121
122
123 parent::initItem($target_ref_id, $target_obj_id,$target_title,$target_description);
124
125 // general commands array
126 include_once('./Modules/CategoryReference/classes/class.ilObjCategoryReferenceAccess.php');
127 $this->commands = ilObjCategoryReferenceAccess::_getCommands($this->reference_ref_id);
128
129 if($ilAccess->checkAccess('write','',$this->reference_ref_id) or $this->deleted)
130 {
131 $this->info_screen_enabled = false;
132 }
133 else
134 {
135 $this->info_screen_enabled = true;
136 }
137 }
static _lookupTitle($a_obj_id)
Overwitten from base class.
Definition: class.ilContainerReference.php:105
References $ilBench, ilObject\_getAllReferences(), ilObjectAccess\_getCommands(), ilObject\_lookupDescription(), ilContainerReference\_lookupTargetId(), and ilContainerReference\_lookupTitle().
Here is the call graph for this function:
Field Documentation
◆ $deleted
|
protected |
Definition at line 39 of file class.ilObjCategoryReferenceListGUI.php.
◆ $reference_obj_id
|
protected |
Definition at line 36 of file class.ilObjCategoryReferenceListGUI.php.
◆ $reference_ref_id
|
protected |
Definition at line 37 of file class.ilObjCategoryReferenceListGUI.php.
Referenced by getCommandId().
The documentation for this class was generated from the following file:
- Modules/CategoryReference/classes/class.ilObjCategoryReferenceListGUI.php
