ilObjFileBasedLMListGUI Class Reference

Class ilObjFileBasedLMListGUI. More...

Inheritance diagram for ilObjFileBasedLMListGUI:

Collaboration diagram for ilObjFileBasedLMListGUI:

Public Member Functions
	ilObjFileBasedLMListGUI ()
	constructor
	init ()
	initialisation
	getCommandLink ($a_cmd)
	Overwrite this method, if link target is not build by ctrl class (e.g.
	getCommandFrame ($a_cmd)
	Get command target frame.
	getProperties ()
	Get item properties.
Public Member Functions inherited from ilObjectListGUI
	ilObjectListGUI ()
	constructor
	setContainerObject (&$container_obj)
	set the container object (e.g categorygui) Used for link, delete ...
	getContainerObject ()
	get container object
	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 ()
	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 ()
	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
	getCommandId ()
	get command id Normally the ref id.
	checkCommandAccess ($a_permission, $a_cmd, $a_ref_id, $a_type)
	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.
	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
	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="")
	insert command button
	insertDeleteCommand ()
	insert cut command
	insertLinkCommand ()
	insert link command
	insertCutCommand ()
	insert cut command
	insertSubscribeCommand ()
	insert subscribe command
	insertInfoScreenCommand ()
	insert info screen command
	insertCommands ()
	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
	getListItemHTML ($a_ref_id, $a_obj_id, $a_title, $a_description)
	Get all item information (title, commands, description) in 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

Additional Inherited Members
Data Fields inherited from ilObjectListGUI
	$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 inherited from ilObjectListGUI
	insertPaymentCommand ()
Protected Attributes inherited from ilObjectListGUI
	$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 = ''
	$expand_enabled = false
	$is_expanded = true
	$bold_title = false

Detailed Description

Class ilObjFileBasedLMListGUI.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Id:

class.ilObjFileBasedLMListGUI.php 22716 2010-01-15 11:28:32Z mjansen

Definition at line 37 of file class.ilObjFileBasedLMListGUI.php.

Member Function Documentation

ilObjFileBasedLMListGUI::getCommandFrame

(

$a_cmd

)

Get command target frame.

Parameters

string

$a_cmd

command

Returns

string command target frame

Reimplemented from ilObjectListGUI.

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

References ilFrameTargetInfo\_getFrame(), ilPaymentObject\_hasAccess(), and ilPaymentObject\_isBuyable().

        {
                global $ilias;

                switch($a_cmd)
                {
                        case "view":
                                include_once 'payment/classes/class.ilPaymentObject.php';

                                //$showViewInFrameset = $ilias->ini->readVariable("layout","view_target") == "frame";
                                $showViewInFrameset = true;
                                $isBuyable = ilPaymentObject::_isBuyable($this->ref_id);
                                if (($isBuyable && ilPaymentObject::_hasAccess($this->ref_id) == false) ||
                                        $showViewInFrameset)
                                {
                                        //$frame = ilFrameTargetInfo::_getFrame("MainContent");
                                        $frame = "ilContObj".$this->obj_id;
                                }
                                else
                                {
                                        $frame = "ilContObj".$this->obj_id;
                                }
                                break;

                        case "edit":
                                $frame = ilFrameTargetInfo::_getFrame("MainContent");
                                break;

                        default:
                                $frame = "";
                                break;
                }

                return $frame;
        }

Here is the call graph for this function:

ilObjFileBasedLMListGUI::getCommandLink

(

$a_cmd

)

Overwrite this method, if link target is not build by ctrl class (e.g.

"forum.php"). This is the case for all links now, but bringing everything to ilCtrl should be realised in the future.

Parameters

string

$a_cmd

command

Reimplemented from ilObjectListGUI.

Definition at line 79 of file class.ilObjFileBasedLMListGUI.php.

        {
                switch($a_cmd)
                {
                        case "view":
                                $cmd_link = "ilias.php?baseClass=ilHTLMPresentationGUI&ref_id=".$this->ref_id;
                                break;

                        case "edit":
                                $cmd_link = "ilias.php?baseClass=ilHTLMEditorGUI&ref_id=".$this->ref_id;
                                break;

                        default:
                                $cmd_link = "repository.php?ref_id=".$this->ref_id."&cmd=$a_cmd";
                                break;
                }

                return $cmd_link;
        }

ilObjFileBasedLMListGUI::getProperties

(

)

Get item properties.

Returns

array array of property arrays: "alert" (boolean) => display as an alert property (usually in red) "property" (string) => property name "value" (string) => property value

Definition at line 152 of file class.ilObjFileBasedLMListGUI.php.

References $lng, ilObjFileBasedLMAccess\_determineStartUrl(), and ilObjFileBasedLMAccess\_lookupOnline().

        {
                global $lng, $rbacsystem;

                $props = array();

                include_once("./Modules/HTMLLearningModule/classes/class.ilObjFileBasedLMAccess.php");

                if (!ilObjFileBasedLMAccess::_lookupOnline($this->obj_id))
                {
                        $props[] = array("alert" => true, "property" => $lng->txt("status"),
                                "value" => $lng->txt("offline"));
                }
                else if (!ilObjFileBasedLMAccess::_determineStartUrl($this->obj_id))
                {
                        $props[] = array("alert" => true, "property" => $lng->txt("status"),
                                "value" => $lng->txt("no_start_file"));
                }

                if ($rbacsystem->checkAccess("write", $this->ref_id))
                {
                        $props[] = array("alert" => false, "property" => $lng->txt("type"),
                                "value" => $lng->txt("htlm"));
                }

                return $props;
        }

Here is the call graph for this function:

ilObjFileBasedLMListGUI::ilObjFileBasedLMListGUI

(

)

constructor

Definition at line 43 of file class.ilObjFileBasedLMListGUI.php.

References ilObjectListGUI\ilObjectListGUI().

        {
                $this->ilObjectListGUI();
        }

Here is the call graph for this function:

ilObjFileBasedLMListGUI::init

(

)

initialisation

this method should be overwritten by derived classes

Reimplemented from ilObjectListGUI.

Definition at line 53 of file class.ilObjFileBasedLMListGUI.php.

References ilObjFileBasedLMAccess\_getCommands().

        {
                #$this->static_link_enabled = true;
                $this->delete_enabled = true;
                $this->cut_enabled = true;
                $this->subscribe_enabled = true;
                $this->link_enabled = true;
                $this->payment_enabled = true;
                $this->info_screen_enabled = true;
                $this->type = "htlm";
                $this->gui_class_name = "ilobjfilebasedlmgui";
                
                // general commands array
                include_once('class.ilObjFileBasedLMAccess.php');
                $this->commands = ilObjFileBasedLMAccess::_getCommands();
        }

Here is the call graph for this function:

---

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

• Modules/HTMLLearningModule/classes/class.ilObjFileBasedLMListGUI.php