ilObjCloudListGUI Class Reference

Class ilObjCloudListGUI. More...

Inheritance diagram for ilObjCloudListGUI:

Collaboration diagram for ilObjCloudListGUI:

Public Member Functions
	init ()
	initialisation More...
	getCommands ()
	get all current commands for a specific ref id (in the permission context of the current user) More...
	getProperties ()
Public Member Functions inherited from ilObjectListGUI
	__construct ($a_context=self::CONTEXT_REPOSITORY)
	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 ()
	enableLink ($a_status)
	En/disable link. More...
	getLinkStatus ()
	enablePath ($a_path, $a_start_node=null, \ilPathGUI $path_gui=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...
	getDefaultCommand ()
	Get default command. 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="")
	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 ()
	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...
	determineProperties ()
	Determine properties. More...
	insertProperties ()
	insert properties More...
	insertNoticeProperties ()
	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)
	addHeaderGlyph ($a_id, $a_glyph, $a_onclick=null)
	setAjaxHash ($a_hash)
	getHeaderAction (ilTemplate $a_main_tpl=null)
	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...
	getTypeIcon ()
	Get object type specific type icon. 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="")
	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...
	getUniqueItemId ($a_as_div=false)
	Get unique item identifier (for js-actions) More...
	getCommandsHTML ()
	Get commands HTML (must be called after get list item html) More...
	isSideBlock ()
	Returns whether current item is a block in a side column or not. More...
	setBoldTitle ($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...
	checkInfoPageOnAsynchronousRendering ()

Private Member Functions
	neutralizeCommands (array &$commands, array $custom_list_actions)
	Remove recently added custom actions from dynamic field "commands" as it may pass onto other ListGUIs and mess them up. More...
	injectCustomUrlsInCommands ($custom_urls, &$ref_commands)
	Inject predefined custom URLs into ref_commands and change its destination. More...
	fetchCustomUrlsFromCustomActions (array $custom_list_actions, &$custom_urls)
	Fetches custom URLs from predefined actions and structures them appropriately. 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_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 ()
	parseConditions ($toggle_id, $conditions, $obligatory=true)
	modifyTitleLink ($a_default_link)
	resetCustomData ()
	reset properties and commands 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...
Protected Attributes inherited from ilObjectListGUI
	$access
	$lng
	$user
	$obj_definition
	$tree
	$settings
	$tpl
	$obj_id
	$ref_id
	$type
	$sub_obj_id
	$sub_obj_type
	$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
	$reference_ref_id = false
	$separate_commands = false
	$search_fragment_enabled = false
	$additional_information = false
	$static_link_enabled = false
	$repository_transfer_enabled = false
	$shared = false
	$restrict_to_goto = false
	$comments_enabled = false
	$comments_settings_enabled = false
	$notes_enabled = false
	$tags_enabled = false
	$rating_enabled = false
	$rating_categories_enabled = false
	$rating_text = false
	$rating_ctrl_path = false
	$timings_enabled = true
	$force_visible_only = false
	$prevent_duplicate_commands = array()
	$parent_ref_id
	$context
	$title_link = ''
	$title_link_disabled = false
	$path_gui = null
	$ui
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

Class ilObjCloudListGUI.

Author

Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch $Id:

Definition at line 14 of file class.ilObjCloudListGUI.php.

Member Function Documentation

fetchCustomUrlsFromCustomActions()

ilObjCloudListGUI::fetchCustomUrlsFromCustomActions ( array  $custom_list_actions, &  $custom_urls  )

private

Fetches custom URLs from predefined actions and structures them appropriately.

Parameters

array	$custom_list_actions
	$custom_urls

Definition at line 143 of file class.ilObjCloudListGUI.php.

    {
        foreach ($custom_list_actions as $custom_list_action) {
            if (array_key_exists("custom_url", $custom_list_action)) {
                array_push(
                    $custom_urls,
                    [
                        "id" => $custom_list_action["lang_var"],
                        "link" => $custom_list_action["custom_url"],
                    ]
                );
            }
        }
    }

Referenced by getCommands().

Here is the caller graph for this function:

getCommands()

ilObjCloudListGUI::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 42 of file class.ilObjCloudListGUI.php.

    {
        $object = ilObjectFactory::getInstanceByRefId($this->ref_id);
        $header_action_gui = ilCloudConnector::getHeaderActionGUIClass(ilCloudConnector::getServiceClass($object->getServiceName(), $object->getId(), false));
        $custom_urls = [];
 
        if (method_exists($header_action_gui, "getCustomListActions")) {
            // Fetch custom actions
            $custom_list_actions = $header_action_gui->getCustomListActions();
 
            if (is_array($custom_list_actions)) {
                // Fetch custom URLs from the custom actions, if available
                $this->fetchCustomUrlsFromCustomActions($custom_list_actions, $custom_urls);
                // Adjust commands of this object by adding the new custom ones
                $this->commands = array_merge($this->commands, $custom_list_actions);
            }
        }
 
        // Generate ilias link, check permissions, etc...
        $ref_commands = parent::getCommands();
 
        // Remove recently added custom actions from dynamic field "commands" as
        // it may pass onto other ListGUIs and mess them up
        if (method_exists($header_action_gui, "getCustomListActions")) {
            $this->neutralizeCommands($this->commands, $custom_list_actions);
        }
 
        // Inject custom urls, if avilable
        if (!empty($custom_urls)) {
            $this->injectCustomUrlsInCommands($custom_urls, $ref_commands);
        }
 
        return $ref_commands;
    }

References fetchCustomUrlsFromCustomActions(), ilCloudConnector\getHeaderActionGUIClass(), ilObjectFactory\getInstanceByRefId(), ilCloudConnector\getServiceClass(), injectCustomUrlsInCommands(), and neutralizeCommands().

Here is the call graph for this function:

getProperties()

ilObjCloudListGUI::getProperties

(

)

Returns

array

Reimplemented from ilObjectListGUI.

Definition at line 81 of file class.ilObjCloudListGUI.php.

    {
        global $DIC;
        $lng = $DIC['lng'];
 
        $props = array();
        include_once('./Modules/Cloud/classes/class.ilObjCloudAccess.php');
        if (!ilObjCloudAccess::checkAuthStatus($this->obj_id)) {
            $props[] = array("alert" => true, "property" => $lng->txt("status"),
                             "value" => $lng->txt("cld_not_authenticated_offline"));
        } elseif (!ilObjCloudAccess::checkOnline($this->obj_id)) {
            $props[] = array("alert" => true, "property" => $lng->txt("status"),
                             "value" => $lng->txt("offline"));
        }
 
        return $props;
    }

References $DIC, ilObjectListGUI\$lng, ilObjCloudAccess\checkAuthStatus(), and ilObjCloudAccess\checkOnline().

Here is the call graph for this function:

init()

ilObjCloudListGUI::init

(

)

initialisation

Reimplemented from ilObjectListGUI.

Definition at line 20 of file class.ilObjCloudListGUI.php.

    {
        global $DIC;
        $lng = $DIC['lng'];
 
        $this->copy_enabled = false;
        $this->delete_enabled = true;
        $this->cut_enabled = false;
        $this->subscribe_enabled = true;
        $this->link_enabled = false;
        $this->info_screen_enabled = true;
        $this->timings_enabled = true;
        $this->type = "cld";
        $this->gui_class_name = "ilobjcloudgui";
 
        // general commands array
        include_once('./Modules/Cloud/classes/class.ilObjCloudAccess.php');
        $this->commands = ilObjCloudAccess::_getCommands();
        $lng->loadLanguageModule("cld");
    }

References $DIC, ilObjectListGUI\$lng, and ilObjCloudAccess\_getCommands().

Here is the call graph for this function:

injectCustomUrlsInCommands()

ilObjCloudListGUI::injectCustomUrlsInCommands (   $custom_urls, &  $ref_commands  )

private

Inject predefined custom URLs into ref_commands and change its destination.

Parameters

$custom_urls
$ref_commands

Definition at line 125 of file class.ilObjCloudListGUI.php.

    {
        foreach ($custom_urls as $custom_url) {
            foreach ($ref_commands as &$ref_command) {
                if ($custom_url["id"] === $ref_command["lang_var"]) {
                    $ref_command["link"] = $custom_url["link"];
                }
            }
        }
    }

Referenced by getCommands().

Here is the caller graph for this function:

neutralizeCommands()

ilObjCloudListGUI::neutralizeCommands ( array &  $commands, array  $custom_list_actions  )

private

Remove recently added custom actions from dynamic field "commands" as it may pass onto other ListGUIs and mess them up.

Parameters

array	$commands
array	$custom_list_actions

Definition at line 107 of file class.ilObjCloudListGUI.php.

    {
        foreach ($custom_list_actions as $custom_list_action) {
            for ($i = 0; $i < count($commands); $i++) {
                if ($commands[$i]["lang_var"] == $custom_list_action["lang_var"]) {
                    unset($commands[$i]);
                }
            }
        }
    }

References $i.

Referenced by getCommands().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• Modules/Cloud/classes/class.ilObjCloudListGUI.php