ILIAS
Release_4_0_x_branch Revision 61816
|
Class ilObjectListGUI. More...
Public Member Functions | |
ilObjectListGUI () | |
constructor | |
setContainerObject (&$container_obj) | |
set the container object (e.g categorygui) Used for link, delete ... | |
getContainerObject () | |
get container object | |
init () | |
initialisation | |
enableProperties ($a_status) | |
En/disable properties. | |
getPropertiesStatus () | |
enablePreconditions ($a_status) | |
En/disable preconditions. | |
getNoticePropertiesStatus () | |
enableNoticeProperties ($a_status) | |
En/disable notices. | |
getPreconditionsStatus () | |
enableDescription ($a_status) | |
En/disable description. | |
getDescriptionStatus () | |
getSearchFragmentStatus () | |
Show hide search result fragments. | |
enableSearchFragments ($a_status) | |
En/disable description. | |
enableLinkedPath ($a_status) | |
Enable linked path. | |
enabledRelevance () | |
enabled relevance | |
enableRelevance ($a_status) | |
enable relevance | |
setRelevance ($a_rel) | |
set relevance | |
getRelevance () | |
get relevance | |
enableIcon ($a_status) | |
En/Dis-able icons. | |
getIconStatus () | |
Are icons enabled? | |
enableCheckbox ($a_status) | |
En/Dis-able checkboxes. | |
getCheckboxStatus () | |
Are checkboxes enabled? | |
enableExpand ($a_status) | |
En/Dis-able expand/collapse link. | |
getExpandStatus () | |
Is expand/collapse enabled. | |
setExpanded ($a_status) | |
isExpanded () | |
setPositionInputField ($a_field_index, $a_position_value) | |
Set position input field. | |
enableDelete ($a_status) | |
En/disable delete. | |
getDeleteStatus () | |
enableCut ($a_status) | |
En/disable cut. | |
getCutStatus () | |
enableCopy ($a_status) | |
En/disable copy. | |
getCopyStatus () | |
enableSubscribe ($a_status) | |
En/disable subscribe. | |
getSubscribeStatus () | |
enablePayment ($a_status) | |
En/disable payment. | |
getPaymentStatus () | |
enableLink ($a_status) | |
En/disable link. | |
getLinkStatus () | |
enablePath ($a_path) | |
En/disable path. | |
getPathStatus () | |
enableCommands ($a_status, $a_std_only=false) | |
En/disable commands. | |
getCommandsStatus () | |
enableInfoScreen ($a_info_screen) | |
En/disable path. | |
addSubItemHTML ($a_html) | |
Add HTML for subitem (used for sessions) | |
getInfoScreenStatus () | |
enableProgressInfo ($a_status) | |
enable progress info | |
getProgressInfoStatus () | |
get progress info status | |
enableSubstitutions ($a_status) | |
Enable substitutions. | |
getSubstitutionStatus () | |
Get substitution status. | |
enableItemDetailLinks ($a_status) | |
enable item detail links E.g Direct links to chapters or pages | |
getItemDetailLinkStatus () | |
get item detail link status | |
setItemDetailLinks ($a_detail_links, $a_intro_txt= '') | |
set items detail links | |
insertItemDetailLinks () | |
insert item detail links | |
setTitle ($a_title) | |
getTitle () | |
getTitle overwritten in class.ilObjLinkResourceList.php | |
setDescription ($a_description) | |
getDescription () | |
getDescription overwritten in class.ilObjLinkResourceList.php | |
setSearchFragment ($a_text) | |
set search fragment | |
getSearchFragment () | |
get search fragment | |
setSeparateCommands ($a_val) | |
Set separate commands. | |
getSeparateCommands () | |
Get separate commands. | |
getCommandId () | |
get command id Normally the ref id. | |
setAdditionalInformation ($a_val) | |
Set additional information. | |
getAdditionalInformation () | |
Get additional information. | |
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) | |
getDetailsLevel () | |
Get current details level. | |
checkCommandAccess ($a_permission, $a_cmd, $a_ref_id, $a_type, $a_obj_id="") | |
initItem ($a_ref_id, $a_obj_id, $a_title="", $a_description="") | |
inititialize new item (is called by getItemHTML()) | |
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. | |
getCommandLink ($a_cmd) | |
Get command link url. | |
getCommandFrame ($a_cmd) | |
Get command target frame. | |
getCommandImage ($a_cmd) | |
Get command icon image. | |
getProperties ($a_item= '') | |
Get item properties. | |
addCustomProperty ($a_property="", $a_value="", $a_alert=false, $a_newline=false) | |
add custom property | |
getCustomProperties ($a_prop) | |
get custom properties | |
getNoticeProperties () | |
get notice properties | |
addCustomCommand ($a_link, $a_lang_var, $a_frame="") | |
add a custom command | |
getCommands () | |
get all current commands for a specific ref id (in the permission context of the current user) | |
getIconImageType () | |
Returns the icon image type. | |
insertTitle () | |
insert item title | |
insertSubstitutions () | |
Insert substitutions. | |
insertDescription () | |
insert item description | |
insertSearchFragment () | |
Insert highlighted search fragment. | |
insertRelevance () | |
insert relevance | |
setMode ($a_mode) | |
set output mode | |
getMode () | |
get output mode | |
setConditionDepth ($a_depth) | |
set depth for precondition output (stops at level 5) | |
isMode ($a_mode) | |
check current output mode | |
insertProperties ($a_item= '') | |
insert properties | |
insertNoticeProperties () | |
insertPayment () | |
insert payment information | |
insertPreconditions () | |
insert all missing preconditions | |
insertCommand ($a_href, $a_text, $a_frame="", $a_img="") | |
insert command button | |
insertDeleteCommand () | |
insert cut command | |
insertLinkCommand () | |
insert link command | |
insertCutCommand () | |
insert cut command | |
insertCopyCommand () | |
Insert copy command. | |
insertPasteCommand () | |
Insert paste command. | |
insertSubscribeCommand () | |
insert subscribe command | |
insertInfoScreenCommand () | |
insert info screen command | |
insertCommands ($a_use_asynch=false, $a_get_asynch_commands=false, $a_asynch_url="") | |
insert all commands into html code | |
appendRepositoryFrameParameter ($a_link) | |
workaround: all links into the repository (from outside) must tell repository to setup the frameset | |
insertPath () | |
insert path | |
insertProgressInfo () | |
insert progress info | |
insertIconsAndCheckboxes () | |
Insert icons and checkboxes. | |
insertSubItems () | |
Insert subitems. | |
insertPositionField () | |
Insert field for positioning. | |
adminCommandsIncluded () | |
returns whether any admin commands (link, delete, cut) are included in the output | |
storeAccessCache () | |
Store access cache. | |
getListItemHTML ($a_ref_id, $a_obj_id, $a_title, $a_description, $a_use_asynch=false, $a_get_asynch_commands=false, $a_asynch_url="") | |
Get all item information (title, commands, description) in HTML. | |
getCommandsHTML () | |
Get commands HTML (must be called after get list item html) | |
isSideBlock () | |
Returns whether current item is a block in a side column or not. | |
setBoldTitle ($a_bold_title) | |
public boolean $a_bold_title set the item title bold | |
isTitleBold () | |
public |
Data Fields | |
const | DETAILS_MINIMAL = 10 |
const | DETAILS_SEARCH = 20 |
const | DETAILS_ALL = 30 |
$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() |
Protected Member Functions | |
insertPaymentCommand () |
Protected Attributes | |
$substitutions = null | |
$substitutions_enabled = false | |
$icons_enabled = false | |
$checkboxes_enabled = false | |
$position_enabled = false | |
$progress_enabled = false | |
$item_detail_links_enabled = false | |
$item_detail_links = array() | |
$item_detail_links_intro = '' | |
$search_fragments_enabled = false | |
$search_fragment = '' | |
$path_linked = false | |
$enabled_relevance = false | |
$relevance = 0 | |
$expand_enabled = false | |
$is_expanded = true | |
$bold_title = false | |
$copy_enabled = true | |
$details_level = self::DETAILS_ALL |
Class ilObjectListGUI.
Important note:
All access checking should be made within $ilAccess and the checkAccess of the ilObj...Access classes. Do not additionally enable or disable any commands within this GUI class or in derived classes, except when the container (e.g. a search result list) generally refuses them.
Definition at line 24 of file class.ilObjectListGUI.php.
ilObjectListGUI::addCustomCommand | ( | $a_link, | |
$a_lang_var, | |||
$a_frame = "" |
|||
) |
add a custom command
Definition at line 1163 of file class.ilObjectListGUI.php.
ilObjectListGUI::addCustomProperty | ( | $a_property = "" , |
|
$a_value = "" , |
|||
$a_alert = false , |
|||
$a_newline = false |
|||
) |
add custom property
Definition at line 1123 of file class.ilObjectListGUI.php.
Referenced by ilObjRemoteCourseListGUI\getProperties(), and insertCommands().
ilObjectListGUI::addSubItemHTML | ( | $a_html | ) |
Add HTML for subitem (used for sessions)
string | $a_html | subitems HTML |
Definition at line 571 of file class.ilObjectListGUI.php.
ilObjectListGUI::adminCommandsIncluded | ( | ) |
returns whether any admin commands (link, delete, cut) are included in the output
Definition at line 2367 of file class.ilObjectListGUI.php.
ilObjectListGUI::appendRepositoryFrameParameter | ( | $a_link | ) |
workaround: all links into the repository (from outside) must tell repository to setup the frameset
Definition at line 2215 of file class.ilObjectListGUI.php.
References ilUtil\appendUrlParameterString().
Referenced by insertCommands(), and insertTitle().
ilObjectListGUI::checkCommandAccess | ( | $a_permission, | |
$a_cmd, | |||
$a_ref_id, | |||
$a_type, | |||
$a_obj_id = "" |
|||
) |
@return |
Reimplemented in ilObjSessionListGUI, and ilObjCourseListGUI.
Definition at line 841 of file class.ilObjectListGUI.php.
Referenced by getCommands(), getListItemHTML(), insertCopyCommand(), insertCutCommand(), insertDeleteCommand(), insertLinkCommand(), and insertSubscribeCommand().
ilObjectListGUI::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.
public
int | command link |
Reimplemented in ilObjTestListGUI.
Definition at line 889 of file class.ilObjectListGUI.php.
References $command, and ilLink\_getStaticLink().
Referenced by insertCommands(), and insertPaymentCommand().
ilObjectListGUI::enableCheckbox | ( | $a_status | ) |
En/Dis-able checkboxes.
boolean | checkbox on/off |
Definition at line 325 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableCommands | ( | $a_status, | |
$a_std_only = false |
|||
) |
En/disable commands.
bool |
Definition at line 540 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableCopy | ( | $a_status | ) |
En/disable copy.
bool |
Definition at line 433 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableCut | ( | $a_status | ) |
En/disable cut.
bool |
Definition at line 411 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableDelete | ( | $a_status | ) |
En/disable delete.
bool |
Definition at line 388 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableDescription | ( | $a_status | ) |
En/disable description.
bool |
Definition at line 211 of file class.ilObjectListGUI.php.
ilObjectListGUI::enabledRelevance | ( | ) |
enabled relevance
Definition at line 266 of file class.ilObjectListGUI.php.
References $enabled_relevance.
Referenced by getListItemHTML(), and insertRelevance().
ilObjectListGUI::enableExpand | ( | $a_status | ) |
En/Dis-able expand/collapse link.
boolean | checkbox on/off |
Definition at line 345 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableIcon | ( | $a_status | ) |
En/Dis-able icons.
boolean | icons on/off |
Definition at line 305 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableInfoScreen | ( | $a_info_screen | ) |
En/disable path.
bool |
Definition at line 561 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableItemDetailLinks | ( | $a_status | ) |
enable item detail links E.g Direct links to chapters or pages
public
bool |
Definition at line 641 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableLink | ( | $a_status | ) |
En/disable link.
bool |
Definition at line 497 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableLinkedPath | ( | $a_status | ) |
Enable linked path.
bool |
Definition at line 257 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableNoticeProperties | ( | $a_status | ) |
En/disable notices.
bool |
Definition at line 189 of file class.ilObjectListGUI.php.
ilObjectListGUI::enablePath | ( | $a_path | ) |
En/disable path.
bool |
Definition at line 519 of file class.ilObjectListGUI.php.
ilObjectListGUI::enablePayment | ( | $a_status | ) |
En/disable payment.
bool |
Definition at line 476 of file class.ilObjectListGUI.php.
ilObjectListGUI::enablePreconditions | ( | $a_status | ) |
En/disable preconditions.
bool |
Definition at line 171 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableProgressInfo | ( | $a_status | ) |
enable progress info
public
@return |
Definition at line 593 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableProperties | ( | $a_status | ) |
En/disable properties.
bool |
Definition at line 149 of file class.ilObjectListGUI.php.
Referenced by insertCommands().
ilObjectListGUI::enableRelevance | ( | $a_status | ) |
enable relevance
Definition at line 275 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableSearchFragments | ( | $a_status | ) |
En/disable description.
bool |
Definition at line 245 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableSubscribe | ( | $a_status | ) |
En/disable subscribe.
bool |
Definition at line 455 of file class.ilObjectListGUI.php.
ilObjectListGUI::enableSubstitutions | ( | $a_status | ) |
Enable substitutions.
public
Definition at line 617 of file class.ilObjectListGUI.php.
ilObjectListGUI::getAdditionalInformation | ( | ) |
Get additional information.
Definition at line 810 of file class.ilObjectListGUI.php.
Referenced by getListItemHTML().
ilObjectListGUI::getCheckboxStatus | ( | ) |
Are checkboxes enabled?
Definition at line 335 of file class.ilObjectListGUI.php.
References $checkboxes_enabled.
Referenced by insertIconsAndCheckboxes().
ilObjectListGUI::getCommandFrame | ( | $a_cmd | ) |
Get command target frame.
Overwrite this method if link frame is not current frame
string | $a_cmd | command |
Reimplemented in ilObjForumListGUI, ilObjiLincClassroomListGUI, ilObjGroupListGUI, ilObjLearningModuleListGUI, ilObjFolderListGUI, ilObjDlBookListGUI, ilObjRemoteCourseListGUI, ilObjSAHSLearningModuleListGUI, ilObjLinkResourceListGUI, ilObjGlossaryListGUI, ilObjFileBasedLMListGUI, ilObjTestListGUI, ilObjChatListGUI, ilObjSurveyListGUI, ilObjSurveyQuestionPoolListGUI, ilObjQuestionPoolListGUI, ilObjMediaPoolListGUI, ilObjectPluginListGUI, ilObjFileListGUI, ilObjExternalFeedListGUI, ilObjMediaCastListGUI, ilObjWikiListGUI, ilObjCategoryListGUI, and ilObjExerciseListGUI.
Definition at line 953 of file class.ilObjectListGUI.php.
References ilDAVActivationChecker\_isActive().
Referenced by getCommands(), and insertInfoScreenCommand().
ilObjectListGUI::getCommandId | ( | ) |
get command id Normally the ref id.
Overwritten for course and category references
public
@return |
Reimplemented in ilObjCategoryReferenceListGUI, and ilObjCourseReferenceListGUI.
Definition at line 790 of file class.ilObjectListGUI.php.
References $ref_id.
Referenced by insertCopyCommand(), insertCutCommand(), insertDeleteCommand(), insertIconsAndCheckboxes(), insertLinkCommand(), insertPasteCommand(), and insertSubscribeCommand().
ilObjectListGUI::getCommandImage | ( | $a_cmd | ) |
Get command icon image.
Overwrite this method if an icon is provided
string | $a_cmd | command |
Reimplemented in ilObjLearningModuleListGUI, ilObjFileListGUI, and ilObjTestListGUI.
Definition at line 973 of file class.ilObjectListGUI.php.
Referenced by getCommands().
ilObjectListGUI::getCommandLink | ( | $a_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.
string | $a_cmd | command |
Reimplemented in ilObjForumListGUI, ilObjiLincClassroomListGUI, ilObjCourseReferenceListGUI, ilObjCategoryReferenceListGUI, ilObjSurveyListGUI, ilObjLinkResourceListGUI, ilObjTestListGUI, ilObjSurveyQuestionPoolListGUI, ilObjQuestionPoolListGUI, ilObjMediaCastListGUI, ilObjWikiListGUI, ilObjMediaPoolListGUI, ilObjExternalFeedListGUI, ilObjectPluginListGUI, ilObjExerciseListGUI, ilObjSessionListGUI, ilObjLearningModuleListGUI, ilObjFolderListGUI, ilObjCategoryListGUI, ilObjDlBookListGUI, ilObjChatListGUI, ilObjGlossaryListGUI, ilObjFileBasedLMListGUI, ilObjSAHSLearningModuleListGUI, ilObjGroupListGUI, ilObjiLincCourseListGUI, and ilObjRootFolderListGUI.
Definition at line 916 of file class.ilObjectListGUI.php.
References ilDAVActivationChecker\_isActive().
Referenced by getCommands(), and insertInfoScreenCommand().
ilObjectListGUI::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())
public
int | $a_ref_id | ref id of object |
Reimplemented in ilObjiLincClassroomListGUI.
Definition at line 1194 of file class.ilObjectListGUI.php.
References $cmd, $command, $ilBench, checkCommandAccess(), getCommandFrame(), getCommandImage(), and getCommandLink().
Referenced by insertCommands(), and insertPaymentCommand().
ilObjectListGUI::getCommandsHTML | ( | ) |
Get commands HTML (must be called after get list item html)
Definition at line 2553 of file class.ilObjectListGUI.php.
ilObjectListGUI::getCommandsStatus | ( | ) |
bool |
Definition at line 550 of file class.ilObjectListGUI.php.
References $commands_enabled.
Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), getListItemHTML(), insertCommands(), ilCourseObjectiveListGUI\insertTitle(), and insertTitle().
ilObjectListGUI::getContainerObject | ( | ) |
get container object
public
@return | object container |
Definition at line 110 of file class.ilObjectListGUI.php.
Referenced by insertCutCommand(), insertDeleteCommand(), insertLinkCommand(), insertPasteCommand(), ilCourseObjectiveListGUI\insertProgressInfo(), insertSubscribeCommand(), and ilCourseObjectiveListGUI\insertTitle().
ilObjectListGUI::getCopyStatus | ( | ) |
bool |
Definition at line 444 of file class.ilObjectListGUI.php.
References $copy_enabled.
ilObjectListGUI::getCustomProperties | ( | $a_prop | ) |
get custom properties
Definition at line 1133 of file class.ilObjectListGUI.php.
Referenced by insertProperties().
ilObjectListGUI::getCutStatus | ( | ) |
bool |
Definition at line 422 of file class.ilObjectListGUI.php.
ilObjectListGUI::getDeleteStatus | ( | ) |
bool |
Definition at line 400 of file class.ilObjectListGUI.php.
ilObjectListGUI::getDescription | ( | ) |
getDescription overwritten in class.ilObjLinkResourceList.php
Reimplemented in ilObjLinkResourceListGUI.
Definition at line 738 of file class.ilObjectListGUI.php.
Referenced by insertDescription().
ilObjectListGUI::getDescriptionStatus | ( | ) |
bool |
Definition at line 223 of file class.ilObjectListGUI.php.
References $description_enabled.
Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().
ilObjectListGUI::getDetailsLevel | ( | ) |
Get current details level.
Definition at line 831 of file class.ilObjectListGUI.php.
References $details_level.
Referenced by ilObjForumListGUI\getProperties(), ilObjSessionListGUI\getProperties(), and getProperties().
ilObjectListGUI::getExpandStatus | ( | ) |
Is expand/collapse enabled.
Definition at line 355 of file class.ilObjectListGUI.php.
References $expand_enabled.
Referenced by insertIconsAndCheckboxes().
ilObjectListGUI::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 in ilObjFileListGUI, ilObjCategoryReferenceListGUI, and ilObjCourseReferenceListGUI.
Definition at line 1261 of file class.ilObjectListGUI.php.
References $type.
Referenced by insertIconsAndCheckboxes().
ilObjectListGUI::getIconStatus | ( | ) |
Are icons enabled?
Definition at line 315 of file class.ilObjectListGUI.php.
References $icons_enabled.
Referenced by insertIconsAndCheckboxes().
ilObjectListGUI::getInfoScreenStatus | ( | ) |
bool |
Definition at line 581 of file class.ilObjectListGUI.php.
References $info_screen_enabled.
Referenced by insertCommands().
ilObjectListGUI::getItemDetailLinkStatus | ( | ) |
get item detail link status
public
Definition at line 652 of file class.ilObjectListGUI.php.
References $item_detail_links_enabled.
Referenced by getListItemHTML().
ilObjectListGUI::getLinkStatus | ( | ) |
bool |
Definition at line 508 of file class.ilObjectListGUI.php.
ilObjectListGUI::getListItemHTML | ( | $a_ref_id, | |
$a_obj_id, | |||
$a_title, | |||
$a_description, | |||
$a_use_asynch = false , |
|||
$a_get_asynch_commands = false , |
|||
$a_asynch_url = "" |
|||
) |
Get all item information (title, commands, description) in HTML.
public
int | $a_ref_id | item reference id |
int | $a_obj_id | item object id |
int | $a_title | item title |
int | $a_description | item description |
Definition at line 2396 of file class.ilObjectListGUI.php.
References $ilBench, $ilCtrl, $type, ilGeneralSettings\_getInstance(), ilObject\_lookupType(), checkCommandAccess(), enabledRelevance(), getAdditionalInformation(), getCommandsStatus(), getDescriptionStatus(), getItemDetailLinkStatus(), getNoticePropertiesStatus(), getPreconditionsStatus(), getProgressInfoStatus(), getPropertiesStatus(), getSearchFragmentStatus(), getSeparateCommands(), IL_LIST_AS_TRIGGER, initItem(), insertCommands(), insertDescription(), insertIconsAndCheckboxes(), insertItemDetailLinks(), insertNoticeProperties(), insertPath(), insertPayment(), insertPositionField(), insertPreconditions(), insertProgressInfo(), insertProperties(), insertRelevance(), insertSearchFragment(), insertSubItems(), insertTitle(), isMode(), and storeAccessCache().
ilObjectListGUI::getMode | ( | ) |
get output mode
Definition at line 1432 of file class.ilObjectListGUI.php.
ilObjectListGUI::getNoticeProperties | ( | ) |
get notice properties
Definition at line 1148 of file class.ilObjectListGUI.php.
Referenced by insertNoticeProperties().
ilObjectListGUI::getNoticePropertiesStatus | ( | ) |
Definition at line 178 of file class.ilObjectListGUI.php.
References $notice_properties_enabled.
Referenced by getListItemHTML().
ilObjectListGUI::getPathStatus | ( | ) |
bool |
Definition at line 529 of file class.ilObjectListGUI.php.
Referenced by insertPath().
ilObjectListGUI::getPaymentStatus | ( | ) |
bool |
Definition at line 487 of file class.ilObjectListGUI.php.
ilObjectListGUI::getPreconditionsStatus | ( | ) |
bool |
Definition at line 201 of file class.ilObjectListGUI.php.
References $preconditions_enabled.
Referenced by getListItemHTML().
ilObjectListGUI::getProgressInfoStatus | ( | ) |
get progress info status
public
@return |
Definition at line 605 of file class.ilObjectListGUI.php.
References $progress_enabled.
Referenced by getListItemHTML().
ilObjectListGUI::getProperties | ( | $a_item = '' | ) |
Get item properties.
Overwrite this method to add properties at the bottom of the item html
Reimplemented in ilObjiLincClassroomListGUI.
Definition at line 989 of file class.ilObjectListGUI.php.
References $lng, ilDAVActivationChecker\_isActive(), ilChangeEvent\_isActive(), ilChangeEvent\_lookupChangeState(), ilChangeEvent\_lookupInsideChangeState(), DETAILS_SEARCH, and getDetailsLevel().
Referenced by insertProperties().
ilObjectListGUI::getPropertiesStatus | ( | ) |
bool |
Definition at line 161 of file class.ilObjectListGUI.php.
References $properties_enabled.
Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().
ilObjectListGUI::getRelevance | ( | ) |
get relevance
@return |
Definition at line 295 of file class.ilObjectListGUI.php.
References $relevance.
Referenced by insertRelevance().
ilObjectListGUI::getSearchFragment | ( | ) |
get search fragment
Definition at line 757 of file class.ilObjectListGUI.php.
References $search_fragment.
Referenced by insertSearchFragment().
ilObjectListGUI::getSearchFragmentStatus | ( | ) |
Show hide search result fragments.
bool |
Definition at line 234 of file class.ilObjectListGUI.php.
Referenced by getListItemHTML().
ilObjectListGUI::getSeparateCommands | ( | ) |
Get separate commands.
Definition at line 777 of file class.ilObjectListGUI.php.
Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().
ilObjectListGUI::getSubscribeStatus | ( | ) |
bool |
Definition at line 466 of file class.ilObjectListGUI.php.
ilObjectListGUI::getSubstitutionStatus | ( | ) |
Get substitution status.
public
Definition at line 628 of file class.ilObjectListGUI.php.
References $substitutions_enabled.
Referenced by insertDescription().
ilObjectListGUI::getTitle | ( | ) |
getTitle overwritten in class.ilObjLinkResourceList.php
Reimplemented in ilObjFileListGUI, ilObjSessionListGUI, and ilObjLinkResourceListGUI.
Definition at line 719 of file class.ilObjectListGUI.php.
References $title.
Referenced by ilCourseObjectiveListGUI\insertTitle(), and insertTitle().
ilObjectListGUI::ilObjectListGUI | ( | ) |
constructor
Definition at line 73 of file class.ilObjectListGUI.php.
References $ilCtrl, $lng, ilLDAPRoleGroupMapping\_getInstance(), IL_LIST_FULL, and init().
Referenced by ilObjCategoryListGUI\ilObjCategoryListGUI(), ilObjChatListGUI\ilObjChatListGUI(), ilObjCourseListGUI\ilObjCourseListGUI(), ilObjDlBookListGUI\ilObjDlBookListGUI(), ilObjExerciseListGUI\ilObjExerciseListGUI(), ilObjExternalFeedListGUI\ilObjExternalFeedListGUI(), ilObjFileBasedLMListGUI\ilObjFileBasedLMListGUI(), ilObjFileListGUI\ilObjFileListGUI(), ilObjFolderListGUI\ilObjFolderListGUI(), ilObjForumListGUI\ilObjForumListGUI(), ilObjGlossaryListGUI\ilObjGlossaryListGUI(), ilObjGroupListGUI\ilObjGroupListGUI(), ilObjiLincClassroomListGUI\ilObjiLincClassroomListGUI(), ilObjiLincCourseListGUI\ilObjiLincCourseListGUI(), ilObjLearningModuleListGUI\ilObjLearningModuleListGUI(), ilObjLinkResourceListGUI\ilObjLinkResourceListGUI(), ilObjMediaCastListGUI\ilObjMediaCastListGUI(), ilObjMediaPoolListGUI\ilObjMediaPoolListGUI(), ilObjQuestionPoolListGUI\ilObjQuestionPoolListGUI(), ilObjRootFolderListGUI\ilObjRootFolderListGUI(), ilObjSAHSLearningModuleListGUI\ilObjSAHSLearningModuleListGUI(), ilObjSurveyListGUI\ilObjSurveyListGUI(), ilObjSurveyQuestionPoolListGUI\ilObjSurveyQuestionPoolListGUI(), ilObjTestListGUI\ilObjTestListGUI(), and ilObjWikiListGUI\ilObjWikiListGUI().
ilObjectListGUI::init | ( | ) |
initialisation
this method should be overwritten by derived classes
Reimplemented in ilObjLinkResourceListGUI, ilObjCategoryReferenceListGUI, ilObjCourseReferenceListGUI, ilObjForumListGUI, ilObjSessionListGUI, ilObjTestListGUI, ilCourseObjectiveListGUI, ilObjSurveyQuestionPoolListGUI, ilObjQuestionPoolListGUI, ilObjChatListGUI, ilObjGlossaryListGUI, ilObjFileBasedLMListGUI, ilObjSAHSLearningModuleListGUI, ilObjSurveyListGUI, ilObjiLincClassroomListGUI, ilObjRemoteCourseListGUI, ilObjCourseListGUI, ilObjFolderListGUI, ilObjGroupListGUI, ilObjiLincCourseListGUI, ilObjRootFolderListGUI, ilObjDlBookListGUI, ilObjLearningModuleListGUI, ilObjCategoryListGUI, ilObjFileListGUI, ilObjMediaPoolListGUI, ilObjExternalFeedListGUI, ilObjMediaCastListGUI, ilObjWikiListGUI, ilObjExerciseListGUI, and ilObjectPluginListGUI.
Definition at line 121 of file class.ilObjectListGUI.php.
References ilObjectAccess\_getCommands().
Referenced by ilObjectListGUI().
ilObjectListGUI::initItem | ( | $a_ref_id, | |
$a_obj_id, | |||
$a_title = "" , |
|||
$a_description = "" |
|||
) |
inititialize new item (is called by getItemHTML())
int | $a_ref_id | reference id |
int | $a_obj_id | object id |
string | $a_title | title |
string | $a_description | description |
Reimplemented in ilObjiLincClassroomListGUI, ilObjLinkResourceListGUI, ilObjCategoryReferenceListGUI, ilObjCourseListGUI, ilObjCourseReferenceListGUI, ilObjRemoteCourseListGUI, ilObjForumListGUI, ilObjTestListGUI, ilObjSurveyListGUI, ilObjSurveyQuestionPoolListGUI, ilObjQuestionPoolListGUI, ilObjLearningModuleListGUI, ilObjMediaPoolListGUI, ilObjectPluginListGUI, ilObjFileListGUI, ilObjExternalFeedListGUI, ilObjMediaCastListGUI, ilObjWikiListGUI, ilObjDlBookListGUI, and ilObjExerciseListGUI.
Definition at line 866 of file class.ilObjectListGUI.php.
References setDescription(), and setTitle().
Referenced by ilCourseObjectiveListGUI\getListItemHTML(), and getListItemHTML().
ilObjectListGUI::insertCommand | ( | $a_href, | |
$a_text, | |||
$a_frame = "" , |
|||
$a_img = "" |
|||
) |
insert command button
private
string | $a_href | link url target |
string | $a_text | link text |
string | $a_frame | link frame target |
Definition at line 1749 of file class.ilObjectListGUI.php.
Referenced by insertCommands(), insertCopyCommand(), insertCutCommand(), insertDeleteCommand(), insertInfoScreenCommand(), insertLinkCommand(), insertPasteCommand(), and insertSubscribeCommand().
ilObjectListGUI::insertCommands | ( | $a_use_asynch = false , |
|
$a_get_asynch_commands = false , |
|||
$a_asynch_url = "" |
|||
) |
insert all commands into html code
private
object | $a_tpl | template object |
int | $a_ref_id | item reference id |
Definition at line 2056 of file class.ilObjectListGUI.php.
References $command, $lng, addCustomProperty(), appendRepositoryFrameParameter(), createDefaultCommand(), ilAdvancedSelectionListGUI\DOWN_ARROW_DARK, elseif(), enableProperties(), getCommands(), getCommandsStatus(), ilUtil\getImagePath(), getInfoScreenStatus(), IL_LIST_AS_TRIGGER, IL_NO_LICENSE, insertCommand(), insertCopyCommand(), insertCutCommand(), insertDeleteCommand(), insertInfoScreenCommand(), insertLinkCommand(), insertPasteCommand(), insertSubscribeCommand(), and isMode().
Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().
ilObjectListGUI::insertCopyCommand | ( | ) |
Insert copy command.
Definition at line 1902 of file class.ilObjectListGUI.php.
References checkCommandAccess(), getCommandId(), and insertCommand().
Referenced by insertCommands().
ilObjectListGUI::insertCutCommand | ( | ) |
insert cut command
protected
Definition at line 1860 of file class.ilObjectListGUI.php.
References checkCommandAccess(), getCommandId(), getContainerObject(), ilUtil\getImagePath(), and insertCommand().
Referenced by insertCommands().
ilObjectListGUI::insertDeleteCommand | ( | ) |
insert cut command
private
object | $a_tpl | template object |
int | $a_ref_id | item reference id |
Definition at line 1773 of file class.ilObjectListGUI.php.
References checkCommandAccess(), getCommandId(), getContainerObject(), ilUtil\getImagePath(), and insertCommand().
Referenced by insertCommands().
ilObjectListGUI::insertDescription | ( | ) |
insert item description
private
object | $a_tpl | template object |
string | $a_desc | item description |
Definition at line 1359 of file class.ilObjectListGUI.php.
References getDescription(), getSubstitutionStatus(), and insertSubstitutions().
Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), ilCourseObjectiveListGUI\getListItemHTML(), and getListItemHTML().
ilObjectListGUI::insertIconsAndCheckboxes | ( | ) |
Insert icons and checkboxes.
Definition at line 2272 of file class.ilObjectListGUI.php.
References $lng, ilObject\_getIcon(), elseif(), getCheckboxStatus(), getCommandId(), getExpandStatus(), getIconImageType(), getIconStatus(), ilUtil\getImagePath(), isExpanded(), and ilPlugin\lookupTxt().
Referenced by ilCourseObjectiveListGUI\getListItemHTML(), and getListItemHTML().
ilObjectListGUI::insertInfoScreenCommand | ( | ) |
insert info screen command
Definition at line 2037 of file class.ilObjectListGUI.php.
References getCommandFrame(), getCommandLink(), ilUtil\getImagePath(), and insertCommand().
Referenced by insertCommands().
ilObjectListGUI::insertItemDetailLinks | ( | ) |
insert item detail links
public
@return |
Definition at line 677 of file class.ilObjectListGUI.php.
Referenced by getListItemHTML().
ilObjectListGUI::insertLinkCommand | ( | ) |
insert link command
private
object | $a_tpl | template object |
int | $a_ref_id | item reference id |
Definition at line 1813 of file class.ilObjectListGUI.php.
References ilObject\_lookupType(), checkCommandAccess(), getCommandId(), getContainerObject(), ilUtil\getImagePath(), and insertCommand().
Referenced by insertCommands().
ilObjectListGUI::insertNoticeProperties | ( | ) |
Definition at line 1541 of file class.ilObjectListGUI.php.
References getNoticeProperties().
Referenced by getListItemHTML().
ilObjectListGUI::insertPasteCommand | ( | ) |
Insert paste command.
Definition at line 1924 of file class.ilObjectListGUI.php.
References $_SESSION, ilObject\_lookupType(), getCommandId(), getContainerObject(), and insertCommand().
Referenced by insertCommands().
ilObjectListGUI::insertPath | ( | ) |
insert path
Definition at line 2235 of file class.ilObjectListGUI.php.
References $lng, and getPathStatus().
Referenced by getListItemHTML().
ilObjectListGUI::insertPayment | ( | ) |
insert payment information
private
Definition at line 1560 of file class.ilObjectListGUI.php.
References ilGeneralSettings\_getInstance(), ilPaymentObject\_hasAccess(), ilPaymentObject\_isBuyable(), ilPaymentObject\_isInCart(), ilUtil\getImagePath(), and insertPaymentCommand().
Referenced by getListItemHTML().
|
protected |
Definition at line 1596 of file class.ilObjectListGUI.php.
References $command, $type, createDefaultCommand(), ilAdvancedSelectionListGUI\DOWN_ARROW_DARK, and getCommands().
Referenced by insertPayment().
ilObjectListGUI::insertPositionField | ( | ) |
Insert field for positioning.
Definition at line 2352 of file class.ilObjectListGUI.php.
Referenced by getListItemHTML().
ilObjectListGUI::insertPreconditions | ( | ) |
insert all missing preconditions
Definition at line 1662 of file class.ilObjectListGUI.php.
References $lng, $location, ilConditionHandler\_checkCondition(), ilConditionHandler\_getConditionsOfTarget(), ilObject\_lookupTitle(), ilMemberViewSettings\getInstance(), IL_LIST_AS_TRIGGER, and ilUtil\sortArray().
Referenced by getListItemHTML().
ilObjectListGUI::insertProgressInfo | ( | ) |
insert progress info
public
Reimplemented in ilCourseObjectiveListGUI.
Definition at line 2263 of file class.ilObjectListGUI.php.
Referenced by getListItemHTML().
ilObjectListGUI::insertProperties | ( | $a_item = '' | ) |
insert properties
private
Definition at line 1469 of file class.ilObjectListGUI.php.
References $lng, getCustomProperties(), and getProperties().
Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().
ilObjectListGUI::insertRelevance | ( | ) |
insert relevance
@return |
Definition at line 1394 of file class.ilObjectListGUI.php.
References $lng, enabledRelevance(), ilUtil\getImagePath(), and getRelevance().
Referenced by getListItemHTML().
ilObjectListGUI::insertSearchFragment | ( | ) |
Insert highlighted search fragment.
Definition at line 1379 of file class.ilObjectListGUI.php.
References getSearchFragment().
Referenced by getListItemHTML().
ilObjectListGUI::insertSubItems | ( | ) |
Insert subitems.
Definition at line 2339 of file class.ilObjectListGUI.php.
Referenced by ilCourseObjectiveListGUI\getListItemHTML(), and getListItemHTML().
ilObjectListGUI::insertSubscribeCommand | ( | ) |
insert subscribe command
private
object | $a_tpl | template object |
int | $a_ref_id | item reference id |
Definition at line 1958 of file class.ilObjectListGUI.php.
References $ilSetting, $type, ilObject\_lookupObjId(), ilObject\_lookupType(), checkCommandAccess(), getCommandId(), getContainerObject(), ilUtil\getImagePath(), and insertCommand().
Referenced by insertCommands().
ilObjectListGUI::insertSubstitutions | ( | ) |
Insert substitutions.
public
Definition at line 1319 of file class.ilObjectListGUI.php.
References $data.
Referenced by insertDescription().
ilObjectListGUI::insertTitle | ( | ) |
insert item title
private
object | $a_tpl | template object |
string | $a_title | item title |
Reimplemented in ilCourseObjectiveListGUI.
Definition at line 1274 of file class.ilObjectListGUI.php.
References appendRepositoryFrameParameter(), getCommandsStatus(), and getTitle().
Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().
ilObjectListGUI::isExpanded | ( | ) |
Definition at line 365 of file class.ilObjectListGUI.php.
References $is_expanded.
Referenced by insertIconsAndCheckboxes().
ilObjectListGUI::isMode | ( | $a_mode | ) |
check current output mode
string | $a_mode | (IL_LIST_FULL | IL_LIST_AS_TRIGGER) |
Definition at line 1452 of file class.ilObjectListGUI.php.
Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), getListItemHTML(), and insertCommands().
ilObjectListGUI::isSideBlock | ( | ) |
Returns whether current item is a block in a side column or not.
Reimplemented in ilObjExternalFeedListGUI.
Definition at line 2561 of file class.ilObjectListGUI.php.
ilObjectListGUI::isTitleBold | ( | ) |
public
Definition at line 2582 of file class.ilObjectListGUI.php.
References $bold_title.
ilObjectListGUI::setAdditionalInformation | ( | $a_val | ) |
Set additional information.
string | additional information |
Definition at line 800 of file class.ilObjectListGUI.php.
ilObjectListGUI::setBoldTitle | ( | $a_bold_title | ) |
public boolean $a_bold_title set the item title bold
Definition at line 2571 of file class.ilObjectListGUI.php.
ilObjectListGUI::setConditionDepth | ( | $a_depth | ) |
set depth for precondition output (stops at level 5)
Definition at line 1440 of file class.ilObjectListGUI.php.
ilObjectListGUI::setContainerObject | ( | & | $container_obj | ) |
set the container object (e.g categorygui) Used for link, delete ...
commands
this method should be overwritten by derived classes
Definition at line 98 of file class.ilObjectListGUI.php.
ilObjectListGUI::setDescription | ( | $a_description | ) |
string | description |
Definition at line 728 of file class.ilObjectListGUI.php.
Referenced by initItem().
ilObjectListGUI::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)
int | $a_level |
Definition at line 822 of file class.ilObjectListGUI.php.
ilObjectListGUI::setExpanded | ( | $a_status | ) |
Definition at line 360 of file class.ilObjectListGUI.php.
ilObjectListGUI::setItemDetailLinks | ( | $a_detail_links, | |
$a_intro_txt = '' |
|||
) |
set items detail links
public
array | e.g. array(0 => array('desc' => 'Page: ','link' => 'ilias.php...','name' => 'Page XYZ') |
Definition at line 664 of file class.ilObjectListGUI.php.
ilObjectListGUI::setMode | ( | $a_mode | ) |
set output mode
string | $a_mode | output mode (IL_LIST_FULL | IL_LIST_AS_TRIGGER) |
Definition at line 1422 of file class.ilObjectListGUI.php.
ilObjectListGUI::setPositionInputField | ( | $a_field_index, | |
$a_position_value | |||
) |
Set position input field.
string | $a_field_index | e.g. "[crs][34]" |
string | $a_position_value | e.g. "2.0" |
Definition at line 375 of file class.ilObjectListGUI.php.
ilObjectListGUI::setRelevance | ( | $a_rel | ) |
set relevance
int |
Definition at line 285 of file class.ilObjectListGUI.php.
ilObjectListGUI::setSearchFragment | ( | $a_text | ) |
set search fragment
string | $a_text | highlighted search fragment |
Definition at line 748 of file class.ilObjectListGUI.php.
ilObjectListGUI::setSeparateCommands | ( | $a_val | ) |
Set separate commands.
boolean | separate commands |
Definition at line 767 of file class.ilObjectListGUI.php.
ilObjectListGUI::setTitle | ( | $a_title | ) |
string | title |
Definition at line 709 of file class.ilObjectListGUI.php.
Referenced by initItem().
ilObjectListGUI::storeAccessCache | ( | ) |
Store access cache.
Definition at line 2375 of file class.ilObjectListGUI.php.
References $ref_id.
Referenced by getListItemHTML().
|
protected |
Definition at line 63 of file class.ilObjectListGUI.php.
Referenced by isTitleBold().
|
protected |
Definition at line 47 of file class.ilObjectListGUI.php.
Referenced by getCheckboxStatus().
ilObjectListGUI::$commands_enabled = true |
Definition at line 35 of file class.ilObjectListGUI.php.
Referenced by getCommandsStatus().
ilObjectListGUI::$condition_depth = 0 |
Definition at line 39 of file class.ilObjectListGUI.php.
|
protected |
Definition at line 65 of file class.ilObjectListGUI.php.
Referenced by getCopyStatus().
ilObjectListGUI::$ctrl |
Definition at line 30 of file class.ilObjectListGUI.php.
ilObjectListGUI::$cust_commands = array() |
Definition at line 37 of file class.ilObjectListGUI.php.
ilObjectListGUI::$cust_prop = array() |
Definition at line 36 of file class.ilObjectListGUI.php.
ilObjectListGUI::$description_enabled = true |
Definition at line 31 of file class.ilObjectListGUI.php.
Referenced by getDescriptionStatus().
|
protected |
Definition at line 67 of file class.ilObjectListGUI.php.
Referenced by getDetailsLevel().
|
protected |
Definition at line 58 of file class.ilObjectListGUI.php.
Referenced by enabledRelevance().
|
protected |
Definition at line 61 of file class.ilObjectListGUI.php.
Referenced by getExpandStatus().
|
protected |
Definition at line 46 of file class.ilObjectListGUI.php.
Referenced by getIconStatus().
ilObjectListGUI::$info_screen_enabled = false |
Definition at line 38 of file class.ilObjectListGUI.php.
Referenced by getInfoScreenStatus().
|
protected |
Definition at line 62 of file class.ilObjectListGUI.php.
Referenced by isExpanded().
|
protected |
Definition at line 51 of file class.ilObjectListGUI.php.
|
protected |
Definition at line 50 of file class.ilObjectListGUI.php.
Referenced by getItemDetailLinkStatus().
|
protected |
Definition at line 52 of file class.ilObjectListGUI.php.
ilObjectListGUI::$notice_properties_enabled = true |
Definition at line 34 of file class.ilObjectListGUI.php.
Referenced by getNoticePropertiesStatus().
|
protected |
Definition at line 56 of file class.ilObjectListGUI.php.
|
protected |
Definition at line 48 of file class.ilObjectListGUI.php.
ilObjectListGUI::$preconditions_enabled = true |
Definition at line 32 of file class.ilObjectListGUI.php.
Referenced by getPreconditionsStatus().
|
protected |
Definition at line 49 of file class.ilObjectListGUI.php.
Referenced by getProgressInfoStatus().
ilObjectListGUI::$properties_enabled = true |
Definition at line 33 of file class.ilObjectListGUI.php.
Referenced by getPropertiesStatus().
|
protected |
Definition at line 59 of file class.ilObjectListGUI.php.
Referenced by getRelevance().
|
protected |
Definition at line 55 of file class.ilObjectListGUI.php.
Referenced by getSearchFragment().
|
protected |
Definition at line 54 of file class.ilObjectListGUI.php.
ilObjectListGUI::$std_cmd_only = false |
Definition at line 40 of file class.ilObjectListGUI.php.
ilObjectListGUI::$sub_item_html = array() |
Definition at line 41 of file class.ilObjectListGUI.php.
|
protected |
Definition at line 43 of file class.ilObjectListGUI.php.
|
protected |
Definition at line 44 of file class.ilObjectListGUI.php.
Referenced by getSubstitutionStatus().
const ilObjectListGUI::DETAILS_ALL = 30 |
Definition at line 28 of file class.ilObjectListGUI.php.
Referenced by ilObjForumListGUI\getProperties(), ilObjSessionListGUI\getProperties(), and ilContainerContentGUI\renderItem().
const ilObjectListGUI::DETAILS_MINIMAL = 10 |
Definition at line 26 of file class.ilObjectListGUI.php.
Referenced by ilObjSessionListGUI\getProperties(), and ilContainerContentGUI\renderItem().
const ilObjectListGUI::DETAILS_SEARCH = 20 |
Definition at line 27 of file class.ilObjectListGUI.php.
Referenced by ilLuceneSearchObjectListGUIFactory\factory(), and getProperties().