Inheritance diagram for ilObjSessionListGUI:

Collaboration diagram for ilObjSessionListGUI:

Public Member Functions
	__construct ()
	Constructor.
	init ()
	Initialisation.
	getTitle ()
	get title Overwritten since sessions prepend the date of the session to the title
	getCommandLink ($a_cmd)
	Get command link url.
	getProperties ()
	get 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)
	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.
	getCommandFrame ($a_cmd)
	Get command target frame.
	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

Protected Member Functions
	getAppointmentInfo ()
	get appointment info
Protected Member Functions inherited from ilObjectListGUI
	insertPaymentCommand ()

Protected Attributes
	$app_info = array()
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

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()

Detailed Description

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 35 of file class.ilObjSessionListGUI.php.

Constructor & Destructor Documentation

ilObjSessionListGUI::__construct ( )

Constructor.

public

Returns

Definition at line 46 of file class.ilObjSessionListGUI.php.

References $lng.

        {
                global $lng;
                
                $lng->loadLanguageModule('crs');
                parent::__construct();
        }

Member Function Documentation

ilObjSessionListGUI::getAppointmentInfo ( )

protected

get appointment info

protected

Returns: array

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

References ilSessionAppointment\_lookupAppointment().

Referenced by getProperties(), and getTitle().

        {
                if(isset($this->app_info[$this->obj_id]))
                {
                        return $this->app_info[$this->obj_id];
                }
                include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
                return $this->app_info[$this->obj_id] = ilSessionAppointment::_lookupAppointment($this->obj_id); 
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjSessionListGUI::getCommandLink ( $a_cmd )

Get command link url.

Parameters

int	$a_ref_id	reference id
string	$a_cmd	command

Reimplemented from ilObjectListGUI.

Definition at line 118 of file class.ilObjSessionListGUI.php.

        {
                // separate method for this line
                return "repository.php?ref_id=".$this->ref_id."&cmd=$a_cmd";
        }

ilObjSessionListGUI::getProperties ( )

get properties

public

Parameters

@return

Definition at line 131 of file class.ilObjSessionListGUI.php.

References $app_info, ilSessionAppointment\_appointmentToString(), and getAppointmentInfo().

        {
                $app_info = $this->getAppointmentInfo(); 
                
                $props = parent::getProperties();
                $props[] = array(
                        'alert'         => false,
                        'property'      => $this->lng->txt('event_date'),
                        'value'         => ilSessionAppointment::_appointmentToString($app_info['start'],$app_info['end'],$app_info['fullday']));
                
                return $props;
        }

Here is the call graph for this function:

ilObjSessionListGUI::getTitle ( )

get title Overwritten since sessions prepend the date of the session to the title

public

Parameters

@return

Reimplemented from ilObjectListGUI.

Definition at line 86 of file class.ilObjSessionListGUI.php.

References $app_info, $title, ilDatePresentation\formatDate(), getAppointmentInfo(), and IL_CAL_UNIX.

        {
                $app_info = $this->getAppointmentInfo();
                if($app_info['fullday'])
                {
                        $date = new ilDate($app_info['start'],IL_CAL_UNIX);
                }
                else
                {
                        $date = new ilDate($app_info['start'],IL_CAL_UNIX);
                        #$date = new ilDateTime($app_info['start'],IL_CAL_UNIX);
                }
                if(strlen($this->title))
                {
                        return ilDatePresentation::formatDate($date).': '.$this->title;
                }
                else
                {
                        return ilDatePresentation::formatDate($date);
                }
        }

Here is the call graph for this function:

ilObjSessionListGUI::init ( )

Initialisation.

public

Returns: void

Reimplemented from ilObjectListGUI.

Definition at line 60 of file class.ilObjSessionListGUI.php.

References ilObjSessionAccess\_getCommands().

        {
                $this->delete_enabled = true;
                $this->cut_enabled = false;
                $this->subscribe_enabled = true;
                $this->link_enabled = false;
                $this->payment_enabled = false;
                $this->info_screen_enabled = true;
                $this->subitems_enabled = true;
                $this->type = "sess";
                $this->gui_class_name = "ilobjsessiongui";
                
                // general commands array
                include_once('./Modules/Session/classes/class.ilObjSessionAccess.php');
                $this->commands = ilObjSessionAccess::_getCommands();
        }

Here is the call graph for this function:

Field Documentation

ilObjSessionListGUI::$app_info = array()

protected

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

Referenced by getProperties(), and getTitle().

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

Modules/Session/classes/class.ilObjSessionListGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation