ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields
ilObjLinkResourceListGUI Class Reference
Modules/WebResource

Class ilObjLinkResourceListGUI. More...

+ Inheritance diagram for ilObjLinkResourceListGUI:
+ Collaboration diagram for ilObjLinkResourceListGUI:

Public Member Functions

 ilObjLinkResourceListGUI ()
 constructor
 getTitle ()
 overwritten from base class
 getDescription ()
 overwritten from base class
 init ()
 initialisation
 initItem ($a_ref_id, $a_obj_id, $a_title="", $a_description="")
 inititialize new item
 getCommandFrame ($a_cmd)
 Get command target frame.
 getProperties ()
 Get item properties.
 getCommandLink ($a_cmd)
 Get command link url.
 __checkDirectLink ()
 Check whether there is only one active link in the web resource.
 __readLink ()
 Get data of first active link resource.
- 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 ()
 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)
 setDescription ($a_description)
 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="")
 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.
 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

 $single_link = null
 $link_data = array()
- Data Fields inherited from ilObjectListGUI
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()

Additional Inherited Members

- 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 = ''
 $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

Detailed Description

Class ilObjLinkResourceListGUI.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Id:
class.ilObjLinkResourceListGUI.php 21664 2009-09-14 15:04:46Z smeyer

Definition at line 34 of file class.ilObjLinkResourceListGUI.php.

Member Function Documentation

ilObjLinkResourceListGUI::__checkDirectLink ( )

Check whether there is only one active link in the web resource.

In this case this link is shown in a new browser window

Definition at line 196 of file class.ilObjLinkResourceListGUI.php.

References ilLinkResourceItems\_isSingular().

Referenced by getCommandFrame(), getCommandLink(), getDescription(), and getTitle().

{
if(isset($this->single_link[$this->obj_id]))
{
return $this->single_link[$this->obj_id];
}
include_once './Modules/WebResource/classes/class.ilLinkResourceItems.php';
return $this->single_link[$this->obj_id] = ilLinkResourceItems::_isSingular($this->obj_id);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjLinkResourceListGUI::__readLink ( )

Get data of first active link resource.

Returns
array link data array

Definition at line 211 of file class.ilObjLinkResourceListGUI.php.

References ilParameterAppender\_append(), ilLinkResourceItems\_getFirstLink(), and ilParameterAppender\_isEnabled().

Referenced by getCommandLink(), getDescription(), and getTitle().

{
include_once './Modules/WebResource/classes/class.ilLinkResourceItems.php';
include_once './Modules/WebResource/classes/class.ilParameterAppender.php';
if(ilParameterAppender::_isEnabled())
{
return $this->link_data = ilParameterAppender::_append($tmp =& ilLinkResourceItems::_getFirstLink($this->obj_id));
}
return $this->link_data = ilLinkResourceItems::_getFirstLink($this->obj_id);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjLinkResourceListGUI::getCommandFrame (   $a_cmd)

Get command target frame.

Parameters
string$a_cmdcommand
Returns
string command target frame

Reimplemented from ilObjectListGUI.

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

References __checkDirectLink(), and ilFrameTargetInfo\_getFrame().

{
switch($a_cmd)
{
case "":
if($this->__checkDirectLink())
{
$frame = '_blank';
}
else
{
$frame = ilFrameTargetInfo::_getFrame("RepositoryContent");
}
break;
default:
}
return $frame;
}

+ Here is the call graph for this function:

ilObjLinkResourceListGUI::getCommandLink (   $a_cmd)

Get command link url.

Parameters
int$a_ref_idreference id
string$a_cmdcommand

Reimplemented from ilObjectListGUI.

Definition at line 166 of file class.ilObjLinkResourceListGUI.php.

References __checkDirectLink(), and __readLink().

{
// separate method for this line
switch($a_cmd)
{
case '':
if($this->__checkDirectLink())
{
$this->__readLink();
$cmd_link = $this->link_data['target'];
}
else
{
$cmd_link = "ilias.php?baseClass=ilLinkResourceHandlerGUI&ref_id=".$this->ref_id."&cmd=$a_cmd";
}
break;
default:
$cmd_link = "ilias.php?baseClass=ilLinkResourceHandlerGUI&ref_id=".$this->ref_id."&cmd=$a_cmd";
}
return $cmd_link;
}

+ Here is the call graph for this function:

ilObjLinkResourceListGUI::getDescription ( )

overwritten from base class

Reimplemented from ilObjectListGUI.

Definition at line 65 of file class.ilObjLinkResourceListGUI.php.

References __checkDirectLink(), and __readLink().

{
if($this->__checkDirectLink())
{
$this->__readLink();
return $this->link_data['description'];
}
return parent::getDescription();
}

+ Here is the call graph for this function:

ilObjLinkResourceListGUI::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 149 of file class.ilObjLinkResourceListGUI.php.

References $lng.

{
global $lng, $ilUser;
$props = array();
return $props;
}
ilObjLinkResourceListGUI::getTitle ( )

overwritten from base class

Reimplemented from ilObjectListGUI.

Definition at line 52 of file class.ilObjLinkResourceListGUI.php.

References __checkDirectLink(), and __readLink().

{
if($this->__checkDirectLink())
{
$this->__readLink();
return $this->link_data['title'];
}
return parent::getTitle();
}

+ Here is the call graph for this function:

ilObjLinkResourceListGUI::ilObjLinkResourceListGUI ( )

constructor

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

References ilObjectListGUI\ilObjectListGUI().

{
$this->ilObjectListGUI();
}

+ Here is the call graph for this function:

ilObjLinkResourceListGUI::init ( )

initialisation

Reimplemented from ilObjectListGUI.

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

References ilObjLinkResourceAccess\_getCommands().

{
$this->delete_enabled = true;
$this->cut_enabled = true;
$this->copy_enabled = true;
$this->subscribe_enabled = true;
$this->link_enabled = true;
$this->payment_enabled = false;
$this->type = "webr";
$this->gui_class_name = "ilobjlinkresourcegui";
$this->info_screen_enabled = true;
// general commands array
include_once('class.ilObjLinkResourceAccess.php');
$this->commands = ilObjLinkResourceAccess::_getCommands();
}

+ Here is the call graph for this function:

ilObjLinkResourceListGUI::initItem (   $a_ref_id,
  $a_obj_id,
  $a_title = "",
  $a_description = "" 
)

inititialize new item

Parameters
int$a_ref_idreference id
int$a_obj_idobject id
string$a_titletitle
string$a_descriptiondescription

Reimplemented from ilObjectListGUI.

Definition at line 105 of file class.ilObjLinkResourceListGUI.php.

{
parent::initItem($a_ref_id, $a_obj_id, $a_title, $a_description);
}

Field Documentation

ilObjLinkResourceListGUI::$link_data = array()

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

ilObjLinkResourceListGUI::$single_link = null

Definition at line 36 of file class.ilObjLinkResourceListGUI.php.

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