ILIAS  Release_4_1_x_branch Revision 61804
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
ilObjectListGUI Class Reference

Class ilObjectListGUI. More...

+ Inheritance diagram for ilObjectListGUI:
+ Collaboration diagram for ilObjectListGUI:

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="", $a_cmd="")
 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 ()
 getUniqueItemId ($a_as_div=false)
 Get unique item identifier (for js-actions)

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
 $reference_ref_id = false
 $separate_commands = false
 $search_fragment_enabled = false
 $additional_information = false
 $static_link_enabled = false

Detailed Description

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.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Id:
class.ilObjectListGUI.php 32002 2011-12-06 11:00:29Z jluetzen

Definition at line 24 of file class.ilObjectListGUI.php.

Member Function Documentation

ilObjectListGUI::addCustomCommand (   $a_link,
  $a_lang_var,
  $a_frame = "" 
)

add a custom command

Definition at line 1169 of file class.ilObjectListGUI.php.

{
$this->cust_commands[] =
array("link" => $a_link, "lang_var" => $a_lang_var,
"frame" => $a_frame);
}
ilObjectListGUI::addCustomProperty (   $a_property = "",
  $a_value = "",
  $a_alert = false,
  $a_newline = false 
)

add custom property

Definition at line 1129 of file class.ilObjectListGUI.php.

Referenced by ilObjRemoteCourseListGUI\getProperties(), and insertCommands().

{
$this->cust_prop[] = array("property" => $a_property, "value" => $a_value,
"alert" => $a_alert, "newline" => $a_newline);
}

+ Here is the caller graph for this function:

ilObjectListGUI::addSubItemHTML (   $a_html)

Add HTML for subitem (used for sessions)

Parameters
string$a_htmlsubitems HTML

Definition at line 577 of file class.ilObjectListGUI.php.

{
$this->sub_item_html[] = $a_html;
}
ilObjectListGUI::adminCommandsIncluded ( )

returns whether any admin commands (link, delete, cut) are included in the output

Definition at line 2386 of file class.ilObjectListGUI.php.

{
return $this->adm_commands_included;
}
ilObjectListGUI::appendRepositoryFrameParameter (   $a_link)

workaround: all links into the repository (from outside) must tell repository to setup the frameset

Definition at line 2234 of file class.ilObjectListGUI.php.

References ilUtil\appendUrlParameterString().

Referenced by insertCommands(), and insertTitle().

{
$script = substr(strrchr($_SERVER["PHP_SELF"],"/"),1);
if (substr($script,0,14) != "repository.php" &&
is_int(strpos($a_link,"repository.php")))
{
if ($this->type != "frm")
{
$a_link =
ilUtil::appendUrlParameterString($a_link, "rep_frame=1");
}
}
return $a_link;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::checkCommandAccess (   $a_permission,
  $a_cmd,
  $a_ref_id,
  $a_type,
  $a_obj_id = "" 
)
Parameters
@return

Reimplemented in ilObjSessionListGUI, and ilObjCourseListGUI.

Definition at line 847 of file class.ilObjectListGUI.php.

Referenced by getCommands(), getListItemHTML(), insertCopyCommand(), insertCutCommand(), insertDeleteCommand(), insertLinkCommand(), and insertSubscribeCommand().

{
global $ilAccess;
if (isset($this->access_cache[$a_permission]["-".$a_cmd][$a_ref_id]))
{
return $this->access_cache[$a_permission]["-".$a_cmd][$a_ref_id];
}
$access = $ilAccess->checkAccess($a_permission,$a_cmd,$a_ref_id,$a_type,$a_obj_id);
if ($ilAccess->getPreventCachingLastResult())
{
$this->prevent_access_caching = true;
}
$this->access_cache[$a_permission]["-".$a_cmd][$a_ref_id] = $access;
return $access;
}

+ Here is the caller graph for this function:

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

Parameters
intcommand link

Reimplemented in ilObjTestListGUI.

Definition at line 895 of file class.ilObjectListGUI.php.

References $command, and ilLink\_getStaticLink().

Referenced by insertCommands(), and insertPaymentCommand().

{
if($this->static_link_enabled)
{
include_once('classes/class.ilLink.php');
if($link = ilLink::_getStaticLink($this->ref_id,$this->type,false))
{
$command['link'] = $link;
$command['frame'] = '_top';
}
}
return $command;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::enableCheckbox (   $a_status)

En/Dis-able checkboxes.

Parameters
booleancheckbox on/off

Definition at line 331 of file class.ilObjectListGUI.php.

{
$this->checkboxes_enabled = $a_status;
}
ilObjectListGUI::enableCommands (   $a_status,
  $a_std_only = false 
)

En/disable commands.

Parameters
bool
Returns
void

Definition at line 546 of file class.ilObjectListGUI.php.

{
$this->commands_enabled = $a_status;
$this->std_cmd_only = $a_std_only;
}
ilObjectListGUI::enableCopy (   $a_status)

En/disable copy.

Parameters
bool
Returns
void

Definition at line 439 of file class.ilObjectListGUI.php.

{
$this->copy_enabled = $a_status;
return;
}
ilObjectListGUI::enableCut (   $a_status)

En/disable cut.

Parameters
bool
Returns
void

Definition at line 417 of file class.ilObjectListGUI.php.

{
$this->cut_enabled = $a_status;
return;
}
ilObjectListGUI::enableDelete (   $a_status)

En/disable delete.

Parameters
bool
Returns
void

Definition at line 394 of file class.ilObjectListGUI.php.

{
$this->delete_enabled = $a_status;
return;
}
ilObjectListGUI::enableDescription (   $a_status)

En/disable description.

Parameters
bool
Returns
void

Definition at line 217 of file class.ilObjectListGUI.php.

{
$this->description_enabled = $a_status;
return;
}
ilObjectListGUI::enabledRelevance ( )

enabled relevance

Returns

Definition at line 272 of file class.ilObjectListGUI.php.

References $enabled_relevance.

Referenced by getListItemHTML(), and insertRelevance().

{
return $this->enabled_relevance;
}

+ Here is the caller graph for this function:

ilObjectListGUI::enableExpand (   $a_status)

En/Dis-able expand/collapse link.

Parameters
booleancheckbox on/off

Definition at line 351 of file class.ilObjectListGUI.php.

{
$this->expand_enabled = $a_status;
}
ilObjectListGUI::enableIcon (   $a_status)

En/Dis-able icons.

Parameters
booleanicons on/off

Definition at line 311 of file class.ilObjectListGUI.php.

{
$this->icons_enabled = $a_status;
}
ilObjectListGUI::enableInfoScreen (   $a_info_screen)

En/disable path.

Parameters
bool
Returns
void

Definition at line 567 of file class.ilObjectListGUI.php.

{
$this->info_screen_enabled = $a_info_screen;
}
ilObjectListGUI::enableItemDetailLinks (   $a_status)

enable item detail links E.g Direct links to chapters or pages

public

Parameters
bool
Returns

Definition at line 647 of file class.ilObjectListGUI.php.

{
$this->item_detail_links_enabled = $a_status;
}
ilObjectListGUI::enableLink (   $a_status)

En/disable link.

Parameters
bool
Returns
void

Definition at line 503 of file class.ilObjectListGUI.php.

{
$this->link_enabled = $a_status;
return;
}
ilObjectListGUI::enableLinkedPath (   $a_status)

Enable linked path.

Parameters
bool
Returns

Definition at line 263 of file class.ilObjectListGUI.php.

{
$this->path_linked = $a_status;
}
ilObjectListGUI::enableNoticeProperties (   $a_status)

En/disable notices.

Parameters
bool
Returns
void

Definition at line 195 of file class.ilObjectListGUI.php.

{
$this->notice_properties_enabled = $a_status;
return;
}
ilObjectListGUI::enablePath (   $a_path)

En/disable path.

Parameters
bool
Returns
void

Definition at line 525 of file class.ilObjectListGUI.php.

{
$this->path_enabled = $a_path;
}
ilObjectListGUI::enablePayment (   $a_status)

En/disable payment.

Parameters
bool
Returns
void

Definition at line 482 of file class.ilObjectListGUI.php.

{
$this->payment_enabled = $a_status;
return;
}
ilObjectListGUI::enablePreconditions (   $a_status)

En/disable preconditions.

Parameters
bool
Returns
void

Definition at line 177 of file class.ilObjectListGUI.php.

{
$this->preconditions_enabled = $a_status;
return;
}
ilObjectListGUI::enableProgressInfo (   $a_status)

enable progress info

public

Parameters
@return

Definition at line 599 of file class.ilObjectListGUI.php.

{
$this->progress_enabled = $a_status;
}
ilObjectListGUI::enableProperties (   $a_status)

En/disable properties.

Parameters
bool
Returns
void

Definition at line 155 of file class.ilObjectListGUI.php.

Referenced by insertCommands().

{
$this->properties_enabled = $a_status;
return;
}

+ Here is the caller graph for this function:

ilObjectListGUI::enableRelevance (   $a_status)

enable relevance

Returns

Definition at line 281 of file class.ilObjectListGUI.php.

{
$this->enabled_relevance = $a_status;
}
ilObjectListGUI::enableSearchFragments (   $a_status)

En/disable description.

Parameters
bool
Returns
void

Definition at line 251 of file class.ilObjectListGUI.php.

{
$this->search_fragment_enabled = $a_status;
return;
}
ilObjectListGUI::enableSubscribe (   $a_status)

En/disable subscribe.

Parameters
bool
Returns
void

Definition at line 461 of file class.ilObjectListGUI.php.

{
$this->subscribe_enabled = $a_status;
return;
}
ilObjectListGUI::enableSubstitutions (   $a_status)

Enable substitutions.

public

Parameters

Definition at line 623 of file class.ilObjectListGUI.php.

{
$this->substitutions_enabled = $a_status;
}
ilObjectListGUI::getAdditionalInformation ( )

Get additional information.

Returns
string additional information

Definition at line 816 of file class.ilObjectListGUI.php.

References $additional_information.

Referenced by getListItemHTML().

{
return $this->additional_information;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getCheckboxStatus ( )

Are checkboxes enabled?

Returns
boolean icons enabled?

Definition at line 341 of file class.ilObjectListGUI.php.

References $checkboxes_enabled.

Referenced by insertIconsAndCheckboxes().

{
return $this->checkboxes_enabled;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getCommandFrame (   $a_cmd)

Get command target frame.

Overwrite this method if link frame is not current frame

Parameters
string$a_cmdcommand
Returns
string command target frame

Reimplemented in ilObjForumListGUI, ilObjiLincClassroomListGUI, ilObjGroupListGUI, ilObjLearningModuleListGUI, ilObjFolderListGUI, ilObjDlBookListGUI, ilObjRemoteCourseListGUI, ilObjSAHSLearningModuleListGUI, ilObjLinkResourceListGUI, ilObjGlossaryListGUI, ilObjFileBasedLMListGUI, ilObjTestListGUI, ilObjChatListGUI, ilObjSurveyListGUI, ilObjSurveyQuestionPoolListGUI, ilObjQuestionPoolListGUI, ilObjMediaPoolListGUI, ilObjectPluginListGUI, ilObjFileListGUI, ilObjExternalFeedListGUI, ilObjMediaCastListGUI, ilObjWikiListGUI, ilObjBookingPoolListGUI, ilObjCategoryListGUI, and ilObjExerciseListGUI.

Definition at line 959 of file class.ilObjectListGUI.php.

References ilDAVActivationChecker\_isActive().

Referenced by getCommands(), and insertInfoScreenCommand().

{
// BEGIN WebDAV Get mount webfolder link.
require_once ('Services/WebDAV/classes/class.ilDAVActivationChecker.php');
if ($a_cmd == 'mount_webfolder' && ilDAVActivationChecker::_isActive())
{
return '_blank';
}
return "";
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::getCommandId ( )

get command id Normally the ref id.

Overwritten for course and category references

public

Parameters
@return

Reimplemented in ilObjCategoryReferenceListGUI, and ilObjCourseReferenceListGUI.

Definition at line 796 of file class.ilObjectListGUI.php.

References $ref_id.

Referenced by insertCopyCommand(), insertCutCommand(), insertDeleteCommand(), insertIconsAndCheckboxes(), insertLinkCommand(), insertPasteCommand(), and insertSubscribeCommand().

{
return $this->ref_id;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getCommandImage (   $a_cmd)

Get command icon image.

Overwrite this method if an icon is provided

Parameters
string$a_cmdcommand
Returns
string image path

Reimplemented in ilObjLearningModuleListGUI, ilObjFileListGUI, and ilObjTestListGUI.

Definition at line 979 of file class.ilObjectListGUI.php.

Referenced by getCommands().

{
return "";
}

+ Here is the caller graph for this function:

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.

Parameters
string$a_cmdcommand
Returns
string command link url

Reimplemented in ilObjForumListGUI, ilObjiLincClassroomListGUI, ilObjCourseReferenceListGUI, ilObjCategoryReferenceListGUI, ilObjSurveyListGUI, ilObjLinkResourceListGUI, ilObjTestListGUI, ilObjSurveyQuestionPoolListGUI, ilObjQuestionPoolListGUI, ilObjMediaCastListGUI, ilObjWikiListGUI, ilObjMediaPoolListGUI, ilObjExternalFeedListGUI, ilObjectPluginListGUI, ilObjExerciseListGUI, ilObjSessionListGUI, ilObjLearningModuleListGUI, ilObjFolderListGUI, ilObjCategoryListGUI, ilObjBookingPoolListGUI, ilObjDlBookListGUI, ilObjChatListGUI, ilObjGlossaryListGUI, ilObjFileBasedLMListGUI, ilObjSAHSLearningModuleListGUI, ilObjGroupListGUI, ilObjiLincCourseListGUI, and ilObjRootFolderListGUI.

Definition at line 922 of file class.ilObjectListGUI.php.

References ilDAVActivationChecker\_isActive(), and ilDAVServer\getInstance().

Referenced by getCommands(), and insertInfoScreenCommand().

{
// BEGIN WebDAV Get mount webfolder link.
require_once ('Services/WebDAV/classes/class.ilDAVActivationChecker.php');
if ($a_cmd == 'mount_webfolder' && ilDAVActivationChecker::_isActive())
{
require_once ('Services/WebDAV/classes/class.ilDAVServer.php');
$davServer = ilDAVServer::getInstance();
// XXX: The following is a very dirty, ugly trick.
// To mount URI needs to be put into two attributes:
// href and folder. This hack returns both attributes
// like this: http://...mount_uri..." folder="http://...folder_uri...
return $davServer->getMountURI($this->ref_id).
'" folder="'.$davServer->getFolderURI($this->ref_id);
}
// END WebDAV Get mount webfolder link.
// don't use ctrl here in the moment
return 'repository.php?ref_id='.$this->getCommandId().'&cmd='.$a_cmd;
// separate method for this line
$cmd_link = $this->ctrl->getLinkTargetByClass($this->gui_class_name,
$a_cmd);
return $cmd_link;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Parameters
int$a_ref_idref 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 in ilObjiLincClassroomListGUI.

Definition at line 1200 of file class.ilObjectListGUI.php.

References $cmd, $command, $ilBench, checkCommandAccess(), getCommandFrame(), getCommandImage(), and getCommandLink().

Referenced by insertCommands(), and insertPaymentCommand().

{
global $ilAccess, $ilBench;
$ref_commands = array();
foreach($this->commands as $command)
{
$permission = $command["permission"];
$cmd = $command["cmd"];
$lang_var = $command["lang_var"];
$txt = "";
$info_object = null;
if (isset($command["txt"]))
{
$txt = $command["txt"];
}
// BEGIN WebDAV: Suppress commands that don't make sense for anonymous users.
// Suppress commands that don't make sense for anonymous users
global $ilias;
if ($ilias->account->getId() == ANONYMOUS_USER_ID &&
$command['enable_anonymous'] == 'false')
{
continue;
}
// END WebDAV: Suppress commands that don't make sense for anonymous users.
// all access checking should be made within $ilAccess and
// the checkAccess of the ilObj...Access classes
$ilBench->start("ilObjectListGUI", "4110_get_commands_check_access");
//$access = $ilAccess->checkAccess($permission, $cmd, $this->ref_id, $this->type);
$access = $this->checkCommandAccess($permission,$cmd,$this->ref_id,$this->type);
$ilBench->stop("ilObjectListGUI", "4110_get_commands_check_access");
if ($access)
{
$cmd_link = $this->getCommandLink($command["cmd"]);
$cmd_frame = $this->getCommandFrame($command["cmd"]);
$cmd_image = $this->getCommandImage($command["cmd"]);
$access_granted = true;
}
else
{
$access_granted = false;
$info_object = $ilAccess->getInfo();
}
if (!isset($command["default"]))
{
$command["default"] = "";
}
$ref_commands[] = array(
"permission" => $permission,
"cmd" => $cmd,
"link" => $cmd_link,
"frame" => $cmd_frame,
"lang_var" => $lang_var,
"txt" => $txt,
"granted" => $access_granted,
"access_info" => $info_object,
"img" => $cmd_image,
"default" => $command["default"]
);
}
return $ref_commands;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::getCommandsHTML ( )

Get commands HTML (must be called after get list item html)

Definition at line 2596 of file class.ilObjectListGUI.php.

{
return $this->ctpl->get();
}
ilObjectListGUI::getCommandsStatus ( )
Parameters
bool
Returns
bool

Definition at line 556 of file class.ilObjectListGUI.php.

References $commands_enabled.

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), getListItemHTML(), insertCommands(), ilCourseObjectiveListGUI\insertTitle(), and insertTitle().

{
return $this->commands_enabled;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getContainerObject ( )

get container object

public

Parameters
@returnobject container

Definition at line 116 of file class.ilObjectListGUI.php.

Referenced by insertCutCommand(), insertDeleteCommand(), insertLinkCommand(), insertPasteCommand(), ilCourseObjectiveListGUI\insertProgressInfo(), insertSubscribeCommand(), and ilCourseObjectiveListGUI\insertTitle().

{
return $this->container_obj;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getCopyStatus ( )
Parameters
bool
Returns
bool

Definition at line 450 of file class.ilObjectListGUI.php.

References $copy_enabled.

{
return $this->copy_enabled;
}
ilObjectListGUI::getCustomProperties (   $a_prop)

get custom properties

Definition at line 1139 of file class.ilObjectListGUI.php.

Referenced by insertProperties().

{
if (is_array($this->cust_prop))
{
foreach($this->cust_prop as $prop)
{
$a_prop[] = $prop;
}
}
return $a_prop;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getCutStatus ( )
Parameters
bool
Returns
bool

Definition at line 428 of file class.ilObjectListGUI.php.

{
return $this->cut_enabled;
}
ilObjectListGUI::getDeleteStatus ( )
Parameters
bool
Returns
bool

Definition at line 406 of file class.ilObjectListGUI.php.

{
return $this->delete_enabled;
}
ilObjectListGUI::getDescription ( )

getDescription overwritten in class.ilObjLinkResourceList.php

Returns
string description

Reimplemented in ilObjLinkResourceListGUI.

Definition at line 744 of file class.ilObjectListGUI.php.

Referenced by insertDescription().

{
return $this->description;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getDescriptionStatus ( )
Parameters
bool
Returns
bool

Definition at line 229 of file class.ilObjectListGUI.php.

References $description_enabled.

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().

{
return $this->description_enabled;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getDetailsLevel ( )

Get current details level.

Returns

Definition at line 837 of file class.ilObjectListGUI.php.

References $details_level.

Referenced by ilObjForumListGUI\getProperties(), ilObjSessionListGUI\getProperties(), and getProperties().

{
return $this->details_level;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getExpandStatus ( )

Is expand/collapse enabled.

Returns
boolean icons enabled?

Definition at line 361 of file class.ilObjectListGUI.php.

References $expand_enabled.

Referenced by insertIconsAndCheckboxes().

{
return $this->expand_enabled;
}

+ Here is the caller graph for this function:

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 1277 of file class.ilObjectListGUI.php.

Referenced by insertIconsAndCheckboxes().

{
return $this->type;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getIconStatus ( )

Are icons enabled?

Returns
boolean icons enabled?

Definition at line 321 of file class.ilObjectListGUI.php.

References $icons_enabled.

Referenced by insertIconsAndCheckboxes().

{
return $this->icons_enabled;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getInfoScreenStatus ( )
Parameters
bool
Returns
bool

Definition at line 587 of file class.ilObjectListGUI.php.

References $info_screen_enabled.

Referenced by insertCommands().

{
return $this->info_screen_enabled;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getItemDetailLinkStatus ( )

get item detail link status

public

Returns
bool

Definition at line 658 of file class.ilObjectListGUI.php.

References $item_detail_links_enabled.

Referenced by getListItemHTML().

{
return $this->item_detail_links_enabled;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getLinkStatus ( )
Parameters
bool
Returns
bool

Definition at line 514 of file class.ilObjectListGUI.php.

{
return $this->link_enabled;
}
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

Parameters
int$a_ref_iditem reference id
int$a_obj_iditem object id
int$a_titleitem title
int$a_descriptionitem description
Returns
string html code

Definition at line 2415 of file class.ilObjectListGUI.php.

References $ilBench, $ilCtrl, ilGeneralSettings\_getInstance(), ilObject\_lookupType(), checkCommandAccess(), enabledRelevance(), getAdditionalInformation(), getCommandsStatus(), getDescriptionStatus(), getItemDetailLinkStatus(), getNoticePropertiesStatus(), getPreconditionsStatus(), getProgressInfoStatus(), getPropertiesStatus(), getSearchFragmentStatus(), getSeparateCommands(), getUniqueItemId(), IL_LIST_AS_TRIGGER, initItem(), insertCommands(), insertDescription(), insertIconsAndCheckboxes(), insertItemDetailLinks(), insertNoticeProperties(), insertPath(), insertPayment(), insertPositionField(), insertPreconditions(), insertProgressInfo(), insertProperties(), insertRelevance(), insertSearchFragment(), insertSubItems(), insertTitle(), isMode(), and storeAccessCache().

{
global $ilAccess, $ilBench, $ilUser, $ilCtrl;
// this variable stores wheter any admin commands
// are included in the output
$this->adm_commands_included = false;
// only for permformance exploration
$type = ilObject::_lookupType($a_obj_id);
// initialization
$ilBench->start("ilObjectListGUI", "1000_getListHTML_init$type");
$this->tpl = new ilTemplate ("tpl.container_list_item.html", true, true, false, "DEFAULT", false, true);
$this->ctpl = new ilTemplate ("tpl.container_list_item_commands.html", true, true, false, "DEFAULT", false, true);
$this->initItem($a_ref_id, $a_obj_id, $a_title, $a_description);
$ilBench->stop("ilObjectListGUI", "1000_getListHTML_init$type");
if ($a_use_asynch && $a_get_asynch_commands)
{
return $this->insertCommands(true, true);
}
// read from cache
include_once("Services/Object/classes/class.ilListItemAccessCache.php");
$this->acache = new ilListItemAccessCache();
$cres = $this->acache->getEntry($ilUser->getId().":".$a_ref_id);
if($this->acache->getLastAccessStatus() == "hit")
{
$this->access_cache = unserialize($cres);
}
// visible check
$ilBench->start("ilObjectListGUI", "2000_getListHTML_check_visible");
if (!$this->checkCommandAccess("visible", "", $a_ref_id, "", $a_obj_id))
{
$this->storeAccessCache();
$ilBench->stop("ilObjectListGUI", "2000_getListHTML_check_visible");
return "";
}
$ilBench->stop("ilObjectListGUI", "2000_getListHTML_check_visible");
// commands
$ilBench->start("ilObjectListGUI", "4000_insert_commands");
$this->insertCommands($a_use_asynch, $a_get_asynch_commands, $a_asynch_url);
$ilBench->stop("ilObjectListGUI", "4000_insert_commands");
// write to cache
$this->storeAccessCache();
// payment
// todo
$ilBench->start("ilObjectListGUI", "5000_insert_pay");
$this->insertPayment();
$ilBench->stop("ilObjectListGUI", "5000_insert_pay");
if($this->getProgressInfoStatus())
{
$this->insertProgressInfo();
}
if ($this->getCommandsStatus() ||
($this->payment_enabled && (bool)ilGeneralSettings::_getInstance()->get('shop_enabled')))
{
if (!$this->getSeparateCommands())
{
$this->tpl->setVariable("COMMANDS", $this->ctpl->get());
}
}
// insert title and describtion
$ilBench->start("ilObjectListGUI", "3000_insert_title_desc");
$this->insertTitle();
if (!$this->isMode(IL_LIST_AS_TRIGGER))
{
if ($this->getDescriptionStatus())
{
$this->insertDescription();
}
}
$ilBench->stop("ilObjectListGUI", "3000_insert_title_desc");
if($this->getSearchFragmentStatus())
{
$this->insertSearchFragment();
}
if($this->enabledRelevance())
{
$this->insertRelevance();
}
// properties
$ilBench->start("ilObjectListGUI", "6000_insert_properties$type");
if ($this->getPropertiesStatus())
{
$this->insertProperties();
}
$ilBench->stop("ilObjectListGUI", "6000_insert_properties$type");
// notice properties
$ilBench->start("ilObjectListGUI", "6500_insert_notice_properties$type");
if($this->getNoticePropertiesStatus())
{
$this->insertNoticeProperties();
}
$ilBench->stop("ilObjectListGUI", "6500_insert_notice_properties$type");
// preconditions
$ilBench->start("ilObjectListGUI", "7000_insert_preconditions");
if ($this->getPreconditionsStatus())
{
$this->insertPreconditions();
}
$ilBench->stop("ilObjectListGUI", "7000_insert_preconditions");
// path
$ilBench->start("ilObjectListGUI", "8000_insert_path");
$this->insertPath();
$ilBench->stop("ilObjectListGUI", "8000_insert_path");
$ilBench->start("ilObjectListGUI", "8500_item_detail_links");
if($this->getItemDetailLinkStatus())
{
$this->insertItemDetailLinks();
}
$ilBench->stop("ilObjectListGUI", "8500_item_detail_links");
// icons and checkboxes
$this->insertIconsAndCheckboxes();
// input field for position
$this->insertPositionField();
// subitems
$this->insertSubItems();
// reset properties and commands
$this->cust_prop = array();
$this->cust_commands = array();
$this->sub_item_html = array();
$this->position_enabled = false;
$this->tpl->setVariable("DIV_CLASS",'ilContainerListItemOuter');
$this->tpl->setVariable("DIV_ID", 'id = "'.$this->getUniqueItemId(true).'"');
$this->tpl->setVariable("ADDITIONAL", $this->getAdditionalInformation());
return $this->tpl->get();
}

+ Here is the call graph for this function:

ilObjectListGUI::getMode ( )

get output mode

Returns
string output mode (IL_LIST_FULL | IL_LIST_AS_TRIGGER)

Definition at line 1448 of file class.ilObjectListGUI.php.

{
return $this->mode;
}
ilObjectListGUI::getNoticeProperties ( )

get notice properties

Definition at line 1154 of file class.ilObjectListGUI.php.

Referenced by insertNoticeProperties().

{
$this->notice_prop = array();
if($infos = $this->ldap_mapping->getInfoStrings($this->obj_id,true))
{
foreach($infos as $info)
{
$this->notice_prop[] = array('value' => $info);
}
}
return $this->notice_prop ? $this->notice_prop : array();
}

+ Here is the caller graph for this function:

ilObjectListGUI::getNoticePropertiesStatus ( )

Definition at line 184 of file class.ilObjectListGUI.php.

References $notice_properties_enabled.

Referenced by getListItemHTML().

{
return $this->notice_properties_enabled;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getPathStatus ( )
Parameters
bool
Returns
bool

Definition at line 535 of file class.ilObjectListGUI.php.

Referenced by insertPath().

{
return $this->path_enabled;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getPaymentStatus ( )
Parameters
bool
Returns
bool

Definition at line 493 of file class.ilObjectListGUI.php.

{
return $this->payment_enabled;
}
ilObjectListGUI::getPreconditionsStatus ( )
Parameters
bool
Returns
bool

Definition at line 207 of file class.ilObjectListGUI.php.

References $preconditions_enabled.

Referenced by getListItemHTML().

{
return $this->preconditions_enabled;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getProgressInfoStatus ( )

get progress info status

public

Parameters
@return

Definition at line 611 of file class.ilObjectListGUI.php.

References $progress_enabled.

Referenced by getListItemHTML().

{
return $this->progress_enabled;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getProperties (   $a_item = '')

Get item properties.

Overwrite this method to add properties at the bottom of the item html

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

Reimplemented in ilObjiLincClassroomListGUI.

Definition at line 995 of file class.ilObjectListGUI.php.

References $lng, ilDAVActivationChecker\_isActive(), ilChangeEvent\_isActive(), ilChangeEvent\_lookupChangeState(), ilChangeEvent\_lookupInsideChangeState(), DETAILS_SEARCH, and getDetailsLevel().

Referenced by insertProperties().

{
$props = array();
// please list alert properties first
// example (use $lng->txt instead of "Status"/"Offline" strings):
// $props[] = array("alert" => true, "property" => "Status", "value" => "Offline");
// $props[] = array("alert" => false, "property" => ..., "value" => ...);
// ...
// BEGIN WebDAV Display locking information
require_once ('Services/WebDAV/classes/class.ilDAVActivationChecker.php');
if (ilDAVActivationChecker::_isActive())
{
require_once ('Services/WebDAV/classes/class.ilDAVServer.php');
global $ilias, $lng;
// Show lock info
require_once('Services/WebDAV/classes/class.ilDAVLocks.php');
$davLocks = new ilDAVLocks();
if ($ilias->account->getId() != ANONYMOUS_USER_ID)
{
$locks =& $davLocks->getLocksOnObjectObj($this->obj_id);
if (count($locks) > 0)
{
$lockUser = new ilObjUser($locks[0]['ilias_owner']);
$props[] = array(
"alert" => false,
"property" => $lng->txt("in_use_by"),
"value" => $lockUser->getLogin(),
"link" => "./ilias.php?user=".$locks[0]['ilias_owner'].'&cmd=showUserProfile&cmdClass=ilpersonaldesktopgui&cmdNode=1&baseClass=ilPersonalDesktopGUI',
);
}
}
// END WebDAV Display locking information
if($this->getDetailsLevel() == self::DETAILS_SEARCH)
{
return $props;
}
// BEGIN WebDAV Display warning for invisible Unix files and files with special characters
if (preg_match('/^(\\.|\\.\\.)$/', $this->title))
{
$props[] = array("alert" => true, "property" => $lng->txt("filename_interoperability"),
"value" => $lng->txt("filename_special_filename"),
'propertyNameVisible' => false);
}
else if (preg_match('/^\\./', $this->title))
{
$props[] = array("alert" => true, "property" => $lng->txt("filename_visibility"),
"value" => $lng->txt("filename_hidden_unix_file"),
'propertyNameVisible' => false);
}
else if (preg_match('/~$/', $this->title))
{
$props[] = array("alert" => true, "property" => $lng->txt("filename_visibility"),
"value" => $lng->txt("filename_hidden_backup_file"),
'propertyNameVisible' => false);
}
else if (preg_match('/[\\/]/', $this->title))
{
$props[] = array("alert" => true, "property" => $lng->txt("filename_interoperability"),
"value" => $lng->txt("filename_special_characters"),
'propertyNameVisible' => false);
}
else if (preg_match('/[\\\\\\/:*?"<>|]/', $this->title))
{
$props[] = array("alert" => true, "property" => $lng->txt("filename_interoperability"),
"value" => $lng->txt("filename_windows_special_characters"),
'propertyNameVisible' => false);
}
else if (preg_match('/\\.$/', $this->title))
{
$props[] = array("alert" => true, "property" => $lng->txt("filename_interoperability"),
"value" => $lng->txt("filename_windows_empty_extension"),
'propertyNameVisible' => false);
}
else if (preg_match('/^(\\.|\\.\\.)$/', $this->title))
{
$props[] = array("alert" => true, "property" => $lng->txt("filename_interoperability"),
"value" => $lng->txt("filename_special_filename"),
'propertyNameVisible' => false);
}
else if (preg_match('/#/', $this->title))
{
$props[] = array("alert" => true, "property" => $lng->txt("filename_interoperability"),
"value" => $lng->txt("filename_windows_webdav_issue"),
'propertyNameVisible' => false);
}
}
// END WebDAV Display warning for invisible files and files with special characters
// BEGIN ChangeEvent: display changes.
require_once('Services/Tracking/classes/class.ilChangeEvent.php');
if (ilChangeEvent::_isActive())
{
global $ilias, $lng, $ilUser;
if ($ilias->account->getId() != ANONYMOUS_USER_ID)
{
// Performance improvement: for container objects
// we only display 'changed inside' events, for
// leaf objects we only display 'object new/changed'
// events
$isContainer = in_array($this->type, array('cat','fold','crs','grp'));
if ($isContainer)
{
$state = ilChangeEvent::_lookupInsideChangeState($this->obj_id, $ilUser->getId());
if ($state > 0)
{
$props[] = array("alert" => true, "property" => $lng->txt("event"),
"value" => $lng->txt('state_changed_inside'),
'propertyNameVisible' => false);
}
}
else
{
$state = ilChangeEvent::_lookupChangeState($this->obj_id, $ilUser->getId());
if ($state > 0)
{
$props[] = array("alert" => true, "property" => $lng->txt("event"),
"value" => $lng->txt(($state == 1) ? 'state_unread' : 'state_changed'),
'propertyNameVisible' => false);
}
}
}
}
// END ChangeEvent: display changes.
return $props;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::getPropertiesStatus ( )
Parameters
bool
Returns
bool

Definition at line 167 of file class.ilObjectListGUI.php.

References $properties_enabled.

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().

{
return $this->properties_enabled;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getRelevance ( )

get relevance

Parameters
@return

Definition at line 301 of file class.ilObjectListGUI.php.

References $relevance.

Referenced by insertRelevance().

{
return $this->relevance;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getSearchFragment ( )

get search fragment

Returns

Definition at line 763 of file class.ilObjectListGUI.php.

References $search_fragment.

Referenced by insertSearchFragment().

{
return $this->search_fragment;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getSearchFragmentStatus ( )

Show hide search result fragments.

Parameters
bool
Returns
bool

Definition at line 240 of file class.ilObjectListGUI.php.

References $search_fragment_enabled.

Referenced by getListItemHTML().

{
return $this->search_fragment_enabled;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getSeparateCommands ( )

Get separate commands.

Returns
boolean separate commands

Definition at line 783 of file class.ilObjectListGUI.php.

References $separate_commands.

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().

{
return $this->separate_commands;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getSubscribeStatus ( )
Parameters
bool
Returns
bool

Definition at line 472 of file class.ilObjectListGUI.php.

{
return $this->subscribe_enabled;
}
ilObjectListGUI::getSubstitutionStatus ( )

Get substitution status.

public

Definition at line 634 of file class.ilObjectListGUI.php.

References $substitutions_enabled.

Referenced by insertDescription().

{
return $this->substitutions_enabled;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getTitle ( )

getTitle overwritten in class.ilObjLinkResourceList.php

Returns
string title

Reimplemented in ilObjFileListGUI, ilObjSessionListGUI, and ilObjLinkResourceListGUI.

Definition at line 725 of file class.ilObjectListGUI.php.

References $title.

Referenced by ilCourseObjectiveListGUI\insertTitle(), and insertTitle().

{
return $this->title;
}

+ Here is the caller graph for this function:

ilObjectListGUI::getUniqueItemId (   $a_as_div = false)
protected

Get unique item identifier (for js-actions)

Parameters
bool$a_as_div
Returns
string

Definition at line 2572 of file class.ilObjectListGUI.php.

Referenced by getListItemHTML(), insertCommands(), and insertPaymentCommand().

{
$id_ref = ($this->reference_ref_id > 0)
? $this->reference_ref_id
: $this->ref_id;
if($this->condition_depth)
{
$id_ref .= "_pc".$this->condition_depth;
}
if(!$a_as_div)
{
return $id_ref;
}
else
{
return "lg_div_".$id_ref;
}
}

+ Here is the caller graph for this function:

ilObjectListGUI::ilObjectListGUI ( )

constructor

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

References $ilCtrl, $lng, ilLDAPRoleGroupMapping\_getInstance(), IL_LIST_FULL, and init().

Referenced by ilObjBookingPoolListGUI\__construct(), 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().

{
global $rbacsystem, $ilCtrl, $lng, $ilias;
$this->rbacsystem = $rbacsystem;
$this->ilias = $ilias;
$this->ctrl = $ilCtrl;
$this->lng = $lng;
$this->mode = IL_LIST_FULL;
$this->path_enabled = false;
//echo "list";
$this->init();
include_once('Services/LDAP/classes/class.ilLDAPRoleGroupMapping.php');
$this->ldap_mapping = ilLDAPRoleGroupMapping::_getInstance();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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, ilObjBookingPoolListGUI, ilObjExternalFeedListGUI, ilObjMediaCastListGUI, ilObjWikiListGUI, ilObjExerciseListGUI, and ilObjectPluginListGUI.

Definition at line 127 of file class.ilObjectListGUI.php.

References ilObjectAccess\_getCommands().

Referenced by ilObjectListGUI().

{
// Create static links for default command (linked title) or not
$this->static_link_enabled = true;
$this->delete_enabled = true;
$this->cut_enabled = true;
$this->subscribe_enabled = true;
$this->link_enabled = false;
$this->copy_enabled = false;
$this->payment_enabled = false;
$this->progress_enabled = false;
$this->notice_properties_enabled = true;
$this->info_screen_enabled = false;
$this->type = ""; // "cat", "course", ...
$this->gui_class_name = ""; // "ilobjcategorygui", "ilobjcoursegui", ...
// general commands array, e.g.
include_once('classes/class.ilObjectAccess.php');
$this->commands = ilObjectAccess::_getCommands();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

inititialize new item (is called by getItemHTML())

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

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 872 of file class.ilObjectListGUI.php.

References setDescription(), and setTitle().

Referenced by ilCourseObjectiveListGUI\getListItemHTML(), and getListItemHTML().

{
$this->access_cache = array();
$this->ref_id = $a_ref_id;
$this->obj_id = $a_obj_id;
$this->setTitle($a_title);
$this->setDescription($a_description);
#$this->description = $a_description;
// checks, whether any admin commands are included in the output
$this->adm_commands_included = false;
$this->prevent_access_caching = false;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertCommand (   $a_href,
  $a_text,
  $a_frame = "",
  $a_img = "",
  $a_cmd = "" 
)

insert command button

private

Parameters
string$a_hreflink url target
string$a_textlink text
string$a_framelink frame target

Definition at line 1765 of file class.ilObjectListGUI.php.

Referenced by insertCommands(), insertCopyCommand(), insertCutCommand(), insertDeleteCommand(), insertInfoScreenCommand(), insertLinkCommand(), insertPasteCommand(), and insertSubscribeCommand().

{
if ($a_frame != "")
{
$this->ctpl->setCurrentBlock("item_frame");
$this->ctpl->setVariable("TARGET_COMMAND", $a_frame);
$this->ctpl->parseCurrentBlock();
}
$this->ctpl->setCurrentBlock("item_command");
$this->ctpl->setVariable("HREF_COMMAND", $a_href);
$this->ctpl->setVariable("TXT_COMMAND", $a_text);
$this->ctpl->parseCurrentBlock();
$prevent_background_click = false;
if ($a_cmd =='mount_webfolder')
{
$prevent_background_click = true;
}
$this->current_selection_list->addItem($a_text, "", $a_href, $a_img, $a_text, $a_frame,
"", $prevent_background_click);
}

+ Here is the caller graph for this function:

ilObjectListGUI::insertCommands (   $a_use_asynch = false,
  $a_get_asynch_commands = false,
  $a_asynch_url = "" 
)

insert all commands into html code

private

Parameters
object$a_tpltemplate object
int$a_ref_iditem reference id

Definition at line 2078 of file class.ilObjectListGUI.php.

References $command, $lng, addCustomProperty(), appendRepositoryFrameParameter(), createDefaultCommand(), ilAdvancedSelectionListGUI\DOWN_ARROW_DARK, enableProperties(), getCommands(), getCommandsStatus(), ilUtil\getImagePath(), getInfoScreenStatus(), getUniqueItemId(), IL_LIST_AS_TRIGGER, IL_NO_LICENSE, insertCommand(), insertCopyCommand(), insertCutCommand(), insertDeleteCommand(), insertInfoScreenCommand(), insertLinkCommand(), insertPasteCommand(), insertSubscribeCommand(), and isMode().

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().

{
global $lng;
if (!$this->getCommandsStatus())
{
return;
}
include_once("Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
$this->current_selection_list = new ilAdvancedSelectionListGUI();
$this->current_selection_list->setAsynch($a_use_asynch && !$a_get_asynch_commands);
$this->current_selection_list->setAsynchUrl($a_asynch_url);
$this->current_selection_list->setListTitle($lng->txt("actions"));
$this->current_selection_list->setId("act_".$this->getUniqueItemId());
$this->current_selection_list->setSelectionHeaderClass("small");
$this->current_selection_list->setItemLinkClass("xsmall");
$this->current_selection_list->setLinksMode("il_ContainerItemCommand2");
$this->current_selection_list->setHeaderIcon(ilAdvancedSelectionListGUI::DOWN_ARROW_DARK);
$this->current_selection_list->setUseImages(false);
$this->current_selection_list->setAdditionalToggleElement($this->getUniqueItemId(true), "ilContainerListItemOuterHighlight");
include_once 'Services/Payment/classes/class.ilPaymentObject.php';
$this->ctrl->setParameterByClass($this->gui_class_name, "ref_id", $this->ref_id);
$commands = $this->getCommands($this->ref_id, $this->obj_id);
// only standard command?
$only_default = false;
if ($a_use_asynch && !$a_get_asynch_commands)
{
$only_default = true;
}
$this->default_command = false;
foreach($commands as $command)
{
if ($command["granted"] == true )
{
if (!$command["default"] === true)
{
if (!$this->std_cmd_only && !$only_default)
{
// workaround for repository frameset
$command["link"] =
$this->appendRepositoryFrameParameter($command["link"]);
// standard edit icon
if ($command["lang_var"] == "edit" && $command["img"] == "")
{
$command["img"] = ilUtil::getImagePath("cmd_edit_s.gif");
}
$cmd_link = $command["link"];
$txt = ($command["lang_var"] == "")
? $command["txt"]
: $this->lng->txt($command["lang_var"]);
$this->insertCommand($cmd_link, $txt,
$command["frame"], $command["img"], $command["cmd"]);
}
}
else
{
$this->default_command = $this->createDefaultCommand($command);
//$this->default_command = $command;
}
}
elseif($command["default"] === true)
{
$items =& $command["access_info"];
foreach ($items as $item)
{
if ($item["type"] == IL_NO_LICENSE)
{
$this->addCustomProperty($this->lng->txt("license"),$item["text"],true);
$this->enableProperties(true);
break;
}
}
}
}
// custom commands
if (is_array($this->cust_commands))
{
foreach ($this->cust_commands as $command)
{
$this->insertCommand($command["link"], $this->lng->txt($command["lang_var"]),
$command["frame"], "", $command["cmd"]);
}
}
// info screen commmand
if ($this->getInfoScreenStatus() && !$only_default)
{
$this->insertInfoScreenCommand();
}
if (!$this->isMode(IL_LIST_AS_TRIGGER) && !$only_default)
{
// delete
if ($this->delete_enabled)
{
$this->insertDeleteCommand();
}
// link
if ($this->link_enabled)
{
$this->insertLinkCommand();
}
// cut
if ($this->cut_enabled)
{
$this->insertCutCommand();
}
// copy
if ($this->copy_enabled)
{
$this->insertCopyCommand();
}
// subscribe
if ($this->subscribe_enabled)
{
$this->insertSubscribeCommand();
}
// BEGIN PATCH Lucene search
if($this->cut_enabled or $this->link_enabled)
{
$this->insertPasteCommand();
}
// END PATCH Lucene Search
}
$this->ctrl->clearParametersByClass($this->gui_class_name);
if ($a_use_asynch && $a_get_asynch_commands)
{
return $this->current_selection_list->getHTML(true);
}
$this->ctpl->setVariable("COMMAND_SELECTION_LIST",
$this->current_selection_list->getHTML());
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertCopyCommand ( )

Insert copy command.

Returns

Definition at line 1924 of file class.ilObjectListGUI.php.

References checkCommandAccess(), getCommandId(), and insertCommand().

Referenced by insertCommands().

{
if($this->std_cmd_only)
{
return;
}
if($this->checkCommandAccess('copy', 'copy', $this->ref_id, $this->type))
{
$this->ctrl->setParameterByClass('ilobjectcopygui','source_id',$this->getCommandId());
$cmd_copy = $this->ctrl->getLinkTargetByClass('ilobjectcopygui','initTargetSelection');
$this->insertCommand($cmd_copy, $this->lng->txt('copy'));
$this->adm_commands_included = true;
}
return;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertCutCommand ( )

insert cut command

protected

Definition at line 1882 of file class.ilObjectListGUI.php.

References checkCommandAccess(), getCommandId(), getContainerObject(), ilUtil\getImagePath(), and insertCommand().

Referenced by insertCommands().

{
global $ilAccess;
if ($this->std_cmd_only)
{
return;
}
// BEGIN PATCH Lucene search
if(is_object($this->getContainerObject()) and
$this->getContainerObject() instanceof ilAdministrationCommandHandling)
{
if($this->checkCommandAccess('delete','',$this->ref_id,$this->type))
{
$this->ctrl->setParameter($this->getContainerObject(),'item_ref_id',$this->getCommandId());
$cmd_link = $this->ctrl->getLinkTarget($this->getContainerObject(), "cut");
$this->insertCommand($cmd_link, $this->lng->txt("move"));
$this->adm_commands_included = true;
return true;
}
return false;
}
// END PATCH Lucene Search
// if the permission is changed here, it has
// also to be changed in ilContainerContentGUI, determineAdminCommands
if($this->checkCommandAccess('delete','',$this->ref_id,$this->type))
{
$this->ctrl->setParameter($this->container_obj, "ref_id",
$this->container_obj->object->getRefId());
$this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->getCommandId());
$cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "cut");
$this->insertCommand($cmd_link, $this->lng->txt("move"), "",
ilUtil::getImagePath("cmd_move_s.gif"));
$this->adm_commands_included = true;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertDeleteCommand ( )

insert cut command

private

Parameters
object$a_tpltemplate object
int$a_ref_iditem reference id

Definition at line 1795 of file class.ilObjectListGUI.php.

References checkCommandAccess(), getCommandId(), getContainerObject(), ilUtil\getImagePath(), and insertCommand().

Referenced by insertCommands().

{
if ($this->std_cmd_only)
{
return;
}
if(is_object($this->getContainerObject()) and
$this->getContainerObject() instanceof ilAdministrationCommandHandling)
{
if($this->checkCommandAccess('delete','',$this->ref_id,$this->type))
{
$this->ctrl->setParameter($this->getContainerObject(),'item_ref_id',$this->getCommandId());
$cmd_link = $this->ctrl->getLinkTarget($this->getContainerObject(), "delete");
$this->insertCommand($cmd_link, $this->lng->txt("delete"));
$this->adm_commands_included = true;
return true;
}
return false;
}
if($this->checkCommandAccess('delete','',$this->ref_id,$this->type))
{
$this->ctrl->setParameter($this->container_obj, "ref_id",
$this->container_obj->object->getRefId());
$this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->getCommandId());
$cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "delete");
$this->insertCommand($cmd_link, $this->lng->txt("delete"), "",
ilUtil::getImagePath("cmd_delete_s.gif"));
$this->adm_commands_included = true;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertDescription ( )

insert item description

private

Parameters
object$a_tpltemplate object
string$a_descitem description

Definition at line 1375 of file class.ilObjectListGUI.php.

References getDescription(), getSubstitutionStatus(), and insertSubstitutions().

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), ilCourseObjectiveListGUI\getListItemHTML(), and getListItemHTML().

{
if($this->getSubstitutionStatus())
{
$this->insertSubstitutions();
if(!$this->substitutions->isDescriptionEnabled())
{
return true;
}
}
$this->tpl->setCurrentBlock("item_description");
$this->tpl->setVariable("TXT_DESC", $this->getDescription());
$this->tpl->parseCurrentBlock();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertIconsAndCheckboxes ( )

Insert icons and checkboxes.

Definition at line 2291 of file class.ilObjectListGUI.php.

References $lng, ilObject\_getIcon(), getCheckboxStatus(), getCommandId(), getExpandStatus(), getIconImageType(), getIconStatus(), ilUtil\getImagePath(), isExpanded(), and ilPlugin\lookupTxt().

Referenced by ilCourseObjectiveListGUI\getListItemHTML(), and getListItemHTML().

{
global $lng, $objDefinition;
$cnt = 0;
if ($this->getCheckboxStatus())
{
$this->tpl->setCurrentBlock("check");
$this->tpl->setVariable("VAL_ID", $this->getCommandId());
$this->tpl->parseCurrentBlock();
$cnt += 1;
}
elseif($this->getExpandStatus())
{
$this->tpl->setCurrentBlock('expand');
if($this->isExpanded())
{
$this->ctrl->setParameter($this->container_obj,'expand',-1 * $this->obj_id);
$this->tpl->setVariable('EXP_HREF',$this->ctrl->getLinkTarget($this->container_obj,'',$this->getUniqueItemId(true)));
$this->ctrl->clearParameters($this->container_obj);
$this->tpl->setVariable('EXP_IMG',ilUtil::getImagePath('browser/minus.gif'));
$this->tpl->setVariable('EXP_ALT',$this->lng->txt('collapse'));
}
else
{
$this->ctrl->setParameter($this->container_obj,'expand',$this->obj_id);
$this->tpl->setVariable('EXP_HREF',$this->ctrl->getLinkTarget($this->container_obj,'',$this->getUniqueItemId(true)));
$this->ctrl->clearParameters($this->container_obj);
$this->tpl->setVariable('EXP_IMG',ilUtil::getImagePath('browser/plus.gif'));
$this->tpl->setVariable('EXP_ALT',$this->lng->txt('expand'));
}
$this->tpl->parseCurrentBlock();
$cnt += 1;
}
if ($this->getIconStatus())
{
if ($cnt == 1)
{
$this->tpl->touchBlock("i_1"); // indent
}
$this->tpl->setCurrentBlock("icon");
if (!$objDefinition->isPlugin($this->getIconImageType()))
{
$this->tpl->setVariable("ALT_ICON", $lng->txt("icon")." ".$lng->txt("obj_".$this->getIconImageType()));
}
else
{
include_once("Services/Component/classes/class.ilPlugin.php");
$this->tpl->setVariable("ALT_ICON", $lng->txt("icon")." ".
ilPlugin::lookupTxt("rep_robj", $this->getIconImageType(), "obj_".$this->getIconImageType()));
}
$this->tpl->setVariable("SRC_ICON",
ilObject::_getIcon($this->obj_id, "small", $this->getIconImageType()));
$this->tpl->parseCurrentBlock();
$cnt += 1;
}
$this->tpl->touchBlock("d_".$cnt); // indent main div
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertInfoScreenCommand ( )

insert info screen command

Definition at line 2059 of file class.ilObjectListGUI.php.

References getCommandFrame(), getCommandLink(), ilUtil\getImagePath(), and insertCommand().

Referenced by insertCommands().

{
if ($this->std_cmd_only)
{
return;
}
$cmd_link = $this->getCommandLink("infoScreen");
$cmd_frame = $this->getCommandFrame("infoScreen");
$this->insertCommand($cmd_link, $this->lng->txt("info_short"), $cmd_frame,
ilUtil::getImagePath("cmd_info_s.gif"));
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertItemDetailLinks ( )

insert item detail links

public

Parameters
@return

Definition at line 683 of file class.ilObjectListGUI.php.

Referenced by getListItemHTML().

{
if(!count($this->item_detail_links))
{
return true;
}
if(strlen($this->item_detail_links_intro))
{
$this->tpl->setCurrentBlock('item_detail_intro');
$this->tpl->setVariable('ITEM_DETAIL_INTRO_TXT',$this->item_detail_links_intro);
$this->tpl->parseCurrentBlock();
}
foreach($this->item_detail_links as $info)
{
$this->tpl->setCurrentBlock('item_detail_link');
$this->tpl->setVariable('ITEM_DETAIL_LINK_TARGET',$info['target']);
$this->tpl->setVariable('ITEM_DETAIL_LINK_DESC',$info['desc']);
$this->tpl->setVariable('ITEM_DETAIL_LINK_HREF',$info['link']);
$this->tpl->setVariable('ITEM_DETAIL_LINK_NAME',$info['name']);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock('item_detail_links');
$this->tpl->parseCurrentBlock();
}

+ Here is the caller graph for this function:

ilObjectListGUI::insertLinkCommand ( )

insert link command

private

Parameters
object$a_tpltemplate object
int$a_ref_iditem reference id

Definition at line 1835 of file class.ilObjectListGUI.php.

References ilObject\_lookupType(), checkCommandAccess(), getCommandId(), getContainerObject(), ilUtil\getImagePath(), and insertCommand().

Referenced by insertCommands().

{
global $ilAccess;
if ($this->std_cmd_only)
{
return;
}
// BEGIN PATCH Lucene search
if(is_object($this->getContainerObject()) and
$this->getContainerObject() instanceof ilAdministrationCommandHandling)
{
global $objDefinition;
if($this->checkCommandAccess('delete','',$this->ref_id,$this->type) and
$objDefinition->allowLink(ilObject::_lookupType($this->obj_id)))
{
$this->ctrl->setParameter($this->getContainerObject(),'item_ref_id',$this->getCommandId());
$cmd_link = $this->ctrl->getLinkTarget($this->getContainerObject(), "link");
$this->insertCommand($cmd_link, $this->lng->txt("link"));
$this->adm_commands_included = true;
return true;
}
return false;
}
// END PATCH Lucene Search
// if the permission is changed here, it has
// also to be changed in ilContainerGUI, admin command check
if($this->checkCommandAccess('delete','',$this->ref_id,$this->type))
{
$this->ctrl->setParameter($this->container_obj, "ref_id",
$this->container_obj->object->getRefId());
$this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->getCommandId());
$cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "link");
$this->insertCommand($cmd_link, $this->lng->txt("link"), "",
ilUtil::getImagePath("cmd_link_s.gif"));
$this->adm_commands_included = true;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertNoticeProperties ( )

Definition at line 1557 of file class.ilObjectListGUI.php.

References getNoticeProperties().

Referenced by getListItemHTML().

{
$this->getNoticeProperties();
foreach($this->notice_prop as $property)
{
$this->tpl->setCurrentBlock('notice_item');
$this->tpl->setVariable('NOTICE_ITEM_VALUE',$property['value']);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock('notice_property');
$this->tpl->parseCurrentBlock();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertPasteCommand ( )

Insert paste command.

Definition at line 1946 of file class.ilObjectListGUI.php.

References $_SESSION, ilObject\_lookupType(), getCommandId(), getContainerObject(), and insertCommand().

Referenced by insertCommands().

{
global $ilAccess, $objDefinition;
if ($this->std_cmd_only)
{
return;
}
if(!$objDefinition->isContainer(ilObject::_lookupType($this->obj_id)))
{
return false;
}
if(is_object($this->getContainerObject()) and
$this->getContainerObject() instanceof ilAdministrationCommandHandling and
isset($_SESSION['clipboard']))
{
$this->ctrl->setParameter($this->getContainerObject(),'item_ref_id',$this->getCommandId());
$cmd_link = $this->ctrl->getLinkTarget($this->getContainerObject(), "paste");
$this->insertCommand($cmd_link, $this->lng->txt("paste"));
$this->adm_commands_included = true;
return true;
}
return false;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertPath ( )

insert path

Definition at line 2254 of file class.ilObjectListGUI.php.

References $lng, and getPathStatus().

Referenced by getListItemHTML().

{
global $tree, $lng;
if($this->getPathStatus() != false)
{
include_once 'Services/Tree/classes/class.ilPathGUI.php';
$path_gui = new ilPathGUI();
$path_gui->enableTextOnly(!$this->path_linked);
$path_gui->setUseImages(false);
$this->tpl->setCurrentBlock("path_item");
$this->tpl->setVariable('PATH_ITEM',$path_gui->getPath(ROOT_FOLDER_ID,$this->ref_id));
$this->tpl->parseCurrentBlock();
$this->tpl->setCurrentBlock("path");
$this->tpl->setVariable("TXT_LOCATION", $lng->txt("locator"));
$this->tpl->parseCurrentBlock();
return true;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertPayment ( )

insert payment information

private

Definition at line 1576 of file class.ilObjectListGUI.php.

References ilGeneralSettings\_getInstance(), ilPaymentObject\_hasAccess(), ilPaymentObject\_isBuyable(), ilPaymentObject\_isInCart(), ilUtil\getImagePath(), and insertPaymentCommand().

Referenced by getListItemHTML().

{
include_once 'Services/Payment/classes/class.ilPaymentObject.php';
if((bool)ilGeneralSettings::_getInstance()->get('shop_enabled') &&
$this->payment_enabled &&
ilPaymentObject::_isBuyable($this->ref_id))
{
if(ilPaymentObject::_hasAccess($this->ref_id))
{
$this->ctpl->setCurrentBlock('payment');
$this->ctpl->setVariable('PAYMENT_TYPE_IMG', ilUtil::getImagePath('icon_pays_access.gif'));
$this->ctpl->setVariable('PAYMENT_ALT_IMG', $this->lng->txt('payment_system') . ': ' . $this->lng->txt('payment_payed_access'));
$this->ctpl->parseCurrentBlock();
}
else if(ilPaymentObject::_isInCart($this->ref_id))
{
$this->ctpl->setCurrentBlock('payment');
$this->ctpl->setVariable('PAYMENT_TYPE_IMG', ilUtil::getImagePath('icon_pays_cart.gif'));
$this->ctpl->setVariable('PAYMENT_ALT_IMG', $this->lng->txt('payment_system') . ': ' . $this->lng->txt('payment_in_sc'));
$this->ctpl->parseCurrentBlock();
$this->insertPaymentCommand();
}
else
{
$this->ctpl->setCurrentBlock('payment');
$this->ctpl->setVariable('PAYMENT_TYPE_IMG', ilUtil::getImagePath('icon_pays.gif'));
$this->ctpl->setVariable('PAYMENT_ALT_IMG', $this->lng->txt('payment_system') . ': ' . $this->lng->txt('payment_buyable'));
$this->ctpl->parseCurrentBlock();
$this->insertPaymentCommand();
}
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertPaymentCommand ( )
protected

Definition at line 1612 of file class.ilObjectListGUI.php.

References $command, createDefaultCommand(), ilAdvancedSelectionListGUI\DOWN_ARROW_DARK, getCommands(), and getUniqueItemId().

Referenced by insertPayment().

{
include_once 'Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php';
$this->current_selection_list = new ilAdvancedSelectionListGUI();
$this->current_selection_list->setListTitle($this->lng->txt("shop_actions"));
$this->current_selection_list->setId("act_".$this->getUniqueItemId());
$this->current_selection_list->setSelectionHeaderClass("small");
$this->current_selection_list->setItemLinkClass("xsmall");
$this->current_selection_list->setLinksMode("il_ContainerItemCommand2");
$this->current_selection_list->setHeaderIcon(ilAdvancedSelectionListGUI::DOWN_ARROW_DARK);
$this->current_selection_list->setUseImages(false);
$this->current_selection_list->setAdditionalToggleElement($this->getUniqueItemId(true), "ilContainerListItemOuterHighlight");
$commands = $this->getCommands($this->ref_id, $this->obj_id);
foreach($commands as $command)
{
if($command['default'] === true)
{
$command = $this->createDefaultCommand($command);
if(is_null($command['link']))
{
switch($this->type)
{
case 'sahs':
$command['link'] = 'ilias.php?baseClass=ilSAHSPresentationGUI&ref_id='.$this->ref_id;
break;
case 'lm':
$command['link'] = 'ilias.php?baseClass=ilLMPresentationGUI&ref_id='.$this->ref_id;
break;
default:
$command['link'] = 'repository.php?ref_id='.$this->ref_id;
break;
}
}
$type = $this->type;
if(strpos($command['link'], '_'.$type.'_') !== false)
{
$demo_link = str_replace('_'.$type.'_', '_'.$type.'purchasetypedemo_', $command['link']);
$buy_link = str_replace('_'.$type.'_', '_'.$type.'purchasetypebuy_', $command['link']);
}
else
{
$demo_link = $command['link'].(strpos($command['link'], '?') === false ? '?' : '&').'purchasetype=demo';
$buy_link = $command['link'].(strpos($command['link'], '?') === false ? '?' : '&').'purchasetype=buy';
}
#$this->current_selection_list->addItem($this->lng->txt('payment_demo'), "", $command['link'].'&purchasetype=demo', $a_img, $this->lng->txt('payment_demo'), $command['frame']);
#$this->current_selection_list->addItem($this->lng->txt('buy'), "", $command['link'].'&purchasetype=buy', $a_img, $this->lng->txt('buy'), $command['frame']);
$this->current_selection_list->addItem($this->lng->txt('payment_demo'), "", $demo_link, $a_img, $this->lng->txt('payment_demo'), $command['frame']);
$this->current_selection_list->addItem($this->lng->txt('buy'), "", $buy_link, $a_img, $this->lng->txt('buy'), $command['frame']);
}
}
$this->ctrl->clearParametersByClass($this->gui_class_name);
$this->ctpl->setVariable("COMMAND_SELECTION_LIST",
$this->current_selection_list->getHTML());
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertPositionField ( )

Insert field for positioning.

Definition at line 2371 of file class.ilObjectListGUI.php.

Referenced by getListItemHTML().

{
if ($this->position_enabled)
{
$this->tpl->setCurrentBlock("position");
$this->tpl->setVariable("POS_ID", $this->position_field_index);
$this->tpl->setVariable("POS_VAL", $this->position_value);
$this->tpl->parseCurrentBlock();
}
}

+ Here is the caller graph for this function:

ilObjectListGUI::insertPreconditions ( )

insert all missing preconditions

Definition at line 1678 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().

{
global $ilAccess, $lng, $objDefinition, $tree;
include_once("classes/class.ilConditionHandler.php");
$missing_cond_exist = false;
// do not show multi level conditions (messes up layout)
if ($this->condition_depth > 0)
{
return;
}
// Sort by title
foreach(ilConditionHandler::_getConditionsOfTarget($this->ref_id, $this->obj_id) as $condition)
{
$condition['title'] = ilObject::_lookupTitle($condition['trigger_obj_id']);
}
$conditions = ilConditionHandler::_getConditionsOfTarget($this->ref_id, $this->obj_id);
for($i = 0; $i < count($conditions); $i++)
{
$conditions[$i]['title'] = ilObject::_lookupTitle($conditions[$i]['trigger_obj_id']);
}
$conditions = ilUtil::sortArray($conditions,'title','DESC');
foreach($conditions as $condition)
{
if($tree->isDeleted($condition['trigger_ref_id']))
{
continue;
}
include_once 'Services/Container/classes/class.ilMemberViewSettings.php';
if(ilConditionHandler::_checkCondition($condition['id']) and
!ilMemberViewSettings::getInstance()->isActive())
{
continue;
}
$cond_txt = $lng->txt("condition_".$condition["operator"])." ".
$condition["value"];
// display trigger item
$class = $objDefinition->getClassName($condition["trigger_type"]);
$location = $objDefinition->getLocation($condition["trigger_type"]);
if ($class == "" && $location == "")
{
continue;
}
$missing_cond_exist = true;
$full_class = "ilObj".$class."ListGUI";
include_once($location."/class.".$full_class.".php");
$item_list_gui = new $full_class($this);
$item_list_gui->setMode(IL_LIST_AS_TRIGGER);
$item_list_gui->enablePath(true);
$item_list_gui->setConditionDepth($this->condition_depth + 1);
$trigger_html = $item_list_gui->getListItemHTML($condition['trigger_ref_id'],
$condition['trigger_obj_id'], trim($cond_txt).": ".ilObject::_lookupTitle($condition["trigger_obj_id"]),
"");
$this->tpl->setCurrentBlock("precondition");
if ($trigger_html == "")
{
$trigger_html = $this->lng->txt("precondition_not_accessible");
}
//$this->tpl->setVariable("TXT_CONDITION", trim($cond_txt));
$this->tpl->setVariable("TRIGGER_ITEM", $trigger_html);
$this->tpl->parseCurrentBlock();
}
if ($missing_cond_exist)
{
$this->tpl->setCurrentBlock("preconditions");
$this->tpl->setVariable("TXT_PRECONDITIONS", $lng->txt("preconditions"));
$this->tpl->parseCurrentBlock();
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertProgressInfo ( )

insert progress info

public

Returns

Reimplemented in ilCourseObjectiveListGUI.

Definition at line 2282 of file class.ilObjectListGUI.php.

Referenced by getListItemHTML().

{
return true;
}

+ Here is the caller graph for this function:

ilObjectListGUI::insertProperties (   $a_item = '')

insert properties

private

Definition at line 1485 of file class.ilObjectListGUI.php.

References $lng, getCustomProperties(), and getProperties().

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().

{
global $ilAccess, $lng;
$props = $this->getProperties($a_item);
$props = $this->getCustomProperties($props);
// add no item access note in public section
// for items that are visible but not readable
if ($this->ilias->account->getId() == ANONYMOUS_USER_ID)
{
if (!$ilAccess->checkAccess("read", "", $this->ref_id, $this->type, $this->obj_id))
{
$props[] = array("alert" => true,
"value" => $lng->txt("no_access_item_public"),
"newline" => true);
}
}
$cnt = 1;
if (is_array($props) && count($props) > 0)
{
foreach($props as $prop)
{
// BEGIN WebDAV: Display a separator between properties.
if ($cnt > 1)
{
$this->tpl->touchBlock("separator_prop");
}
// END WebDAV: Display a separator between properties.
if ($prop["alert"] == true)
{
$this->tpl->touchBlock("alert_prop");
}
else
{
$this->tpl->touchBlock("std_prop");
}
if ($prop["newline"] == true && $cnt > 1)
{
$this->tpl->touchBlock("newline_prop");
}
//BEGIN WebDAV: Support hidden property names.
if (isset($prop["property"]) && $prop['propertyNameVisible'] !== false)
//END WebDAV: Support hidden property names.
{
$this->tpl->setCurrentBlock("prop_name");
$this->tpl->setVariable("TXT_PROP", $prop["property"]);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("item_property");
//BEGIN WebDAV: Support links in property values.
if ($prop['link'])
{
$this->tpl->setVariable("LINK_PROP", $prop['link']);
$this->tpl->setVariable("LINK_VAL_PROP", $prop["value"]);
}
else
{
$this->tpl->setVariable("VAL_PROP", $prop["value"]);
}
//END WebDAV: Support links in property values.
$this->tpl->parseCurrentBlock();
$cnt++;
}
$this->tpl->setCurrentBlock("item_properties");
$this->tpl->parseCurrentBlock();
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertRelevance ( )

insert relevance

Parameters
@return

Definition at line 1410 of file class.ilObjectListGUI.php.

References $lng, enabledRelevance(), ilUtil\getImagePath(), and getRelevance().

Referenced by getListItemHTML().

{
global $lng;
if(!$this->enabledRelevance() or !(int) $this->getRelevance())
{
return false;
}
$width1 = (int) $this->getRelevance();
$width2 = (int) (100 - $width1);
$this->tpl->setCurrentBlock('relevance');
#$this->tpl->setVariable('TXT_RELEVANCE',$lng->txt('search_relevance'));
$this->tpl->setVariable('VAL_REL',sprintf("%.02f %%",$this->getRelevance()));
$this->tpl->setVariable('WIDTH_A',$width1);
$this->tpl->setVariable('WIDTH_B',$width2);
$this->tpl->setVariable('IMG_A',ilUtil::getImagePath("relevance_blue.gif"));
$this->tpl->setVariable('IMG_B',ilUtil::getImagePath("relevance_dark.gif"));
$this->tpl->parseCurrentBlock();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertSearchFragment ( )

Insert highlighted search fragment.

Returns

Definition at line 1395 of file class.ilObjectListGUI.php.

References getSearchFragment().

Referenced by getListItemHTML().

{
if(strlen($this->getSearchFragment()))
{
$this->tpl->setCurrentBlock('search_fragment');
$this->tpl->setVariable('TXT_SEARCH_FRAGMENT',$this->getSearchFragment().' ...');
$this->tpl->parseCurrentBlock();
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertSubItems ( )

Insert subitems.

Definition at line 2358 of file class.ilObjectListGUI.php.

Referenced by ilCourseObjectiveListGUI\getListItemHTML(), and getListItemHTML().

{
foreach ($this->sub_item_html as $sub_html)
{
$this->tpl->setCurrentBlock("subitem");
$this->tpl->setVariable("SUBITEM", $sub_html);
$this->tpl->parseCurrentBlock();
}
}

+ Here is the caller graph for this function:

ilObjectListGUI::insertSubscribeCommand ( )

insert subscribe command

private

Parameters
object$a_tpltemplate object
int$a_ref_iditem reference id

Definition at line 1980 of file class.ilObjectListGUI.php.

References $ilSetting, ilObject\_lookupObjId(), ilObject\_lookupType(), checkCommandAccess(), getCommandId(), getContainerObject(), ilUtil\getImagePath(), and insertCommand().

Referenced by insertCommands().

{
global $ilSetting;
if ($this->std_cmd_only)
{
return;
}
if((int)$ilSetting->get('disable_my_offers'))
{
return;
}
$type = ilObject::_lookupType(ilObject::_lookupObjId($this->getCommandId()));
if ($this->ilias->account->getId() != ANONYMOUS_USER_ID)
{
// BEGIN WebDAV: Lock/Unlock objects
/* This code section is temporarily commented out.
I will reactivate it at a later point, when I get the
the backend working properly. - Werner Randelshofer 2008-04-17
if (is_object($this->container_obj) && $this->rbacsystem->checkAccess("write", $this->ref_id))
{
require_once 'Services/WebDAV/classes/class.ilDAVServer.php';
if (ilDAVServer::_isActive() && ilDAVServer::_isActionsVisible())
{
$this->ctrl->setParameter($this->container_obj, "ref_id",
$this->container_obj->object->getRefId());
$this->ctrl->setParameter($this->container_obj, "type", $this->type);
$this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->ref_id);
$cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "lock");
$this->insertCommand($cmd_link, $this->lng->txt("lock"));
$this->ctrl->setParameter($this->container_obj, "ref_id",
$this->container_obj->object->getRefId());
$this->ctrl->setParameter($this->container_obj, "type", $this->type);
$this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->ref_id);
$cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "unlock");
$this->insertCommand($cmd_link, $this->lng->txt("unlock"));
}
}
*/
// END WebDAV: Lock/Unlock objects
if (!$this->ilias->account->isDesktopItem($this->getCommandId(), $type))
{
// Pass type and object ID to ilAccess to improve performance
global $ilAccess;
if ($this->checkCommandAccess("read", "", $this->ref_id, $this->type, $this->obj_id))
{
if($this->getContainerObject() instanceof ilDesktopItemHandling)
{
$this->ctrl->setParameter($this->container_obj, "type", $type);
$this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->getCommandId());
$cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "addToDesk");
$this->insertCommand($cmd_link, $this->lng->txt("to_desktop"), "",
ilUtil::getImagePath("cmd_pd_put_s.gif"));
}
}
}
else
{
if ($this->getContainerObject() instanceof ilDesktopItemHandling)
{
$this->ctrl->setParameter($this->container_obj, "type", $type);
$this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->getCommandId());
$cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "removeFromDesk");
$this->insertCommand($cmd_link, $this->lng->txt("unsubscribe"), "",
ilUtil::getImagePath("cmd_pd_rem_s.gif"));
}
}
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::insertSubstitutions ( )

Insert substitutions.

public

Definition at line 1335 of file class.ilObjectListGUI.php.

References $data.

Referenced by insertDescription().

{
$fields_shown = false;
foreach($this->substitutions->getParsedSubstitutions($this->ref_id,$this->obj_id) as $data)
{
if($data['bold'])
{
$data['name'] = '<strong>'.$data['name'].'</strong>';
$data['value'] = '<strong>'.$data['value'].'</strong>';
}
$this->tpl->touchBlock("std_prop");
$this->tpl->setCurrentBlock('item_property');
if($data['show_field'])
{
$this->tpl->setVariable('TXT_PROP',$data['name']);
}
$this->tpl->setVariable('VAL_PROP',$data['value']);
$this->tpl->parseCurrentBlock();
if($data['newline'])
{
$this->tpl->touchBlock('newline_prop');
}
$fields_shown = false;
}
if($fields_shown)
{
$this->tpl->touchBlock('newline_prop');
}
}

+ Here is the caller graph for this function:

ilObjectListGUI::insertTitle ( )

insert item title

private

Parameters
object$a_tpltemplate object
string$a_titleitem title

Reimplemented in ilCourseObjectiveListGUI.

Definition at line 1290 of file class.ilObjectListGUI.php.

References appendRepositoryFrameParameter(), getCommandsStatus(), and getTitle().

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().

{
if (!$this->default_command || !$this->getCommandsStatus())
{
$this->tpl->setCurrentBlock("item_title");
$this->tpl->setVariable("TXT_TITLE", $this->getTitle());
$this->tpl->parseCurrentBlock();
}
else
{
if ($this->default_command["frame"] != "")
{
$this->tpl->setCurrentBlock("title_linked_frame");
$this->tpl->setVariable("TARGET_TITLE_LINKED", $this->default_command["frame"]);
$this->tpl->parseCurrentBlock();
}
// workaround for repository frameset
#var_dump("<pre>",$this->default_command['link'],"</pre>");
$this->default_command["link"] =
$this->appendRepositoryFrameParameter($this->default_command["link"]);
#var_dump("<pre>",$this->default_command['link'],"</pre>");
// the default command is linked with the title
$this->tpl->setCurrentBlock("item_title_linked");
$this->tpl->setVariable("TXT_TITLE_LINKED", $this->getTitle());
$this->tpl->setVariable("HREF_TITLE_LINKED", $this->default_command["link"]);
$this->tpl->parseCurrentBlock();
}
if ($this->bold_title == true)
{
$this->tpl->touchBlock('bold_title_start');
$this->tpl->touchBlock('bold_title_end');
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjectListGUI::isExpanded ( )

Definition at line 371 of file class.ilObjectListGUI.php.

References $is_expanded.

Referenced by insertIconsAndCheckboxes().

{
return $this->is_expanded;
}

+ Here is the caller graph for this function:

ilObjectListGUI::isMode (   $a_mode)

check current output mode

Parameters
string$a_mode(IL_LIST_FULL | IL_LIST_AS_TRIGGER)
Returns
boolen true if current mode is $a_mode

Definition at line 1468 of file class.ilObjectListGUI.php.

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), getListItemHTML(), and insertCommands().

{
if ($a_mode == $this->mode)
{
return true;
}
else
{
return false;
}
}

+ Here is the caller graph for this function:

ilObjectListGUI::isSideBlock ( )

Returns whether current item is a block in a side column or not.

Reimplemented in ilObjExternalFeedListGUI.

Definition at line 2604 of file class.ilObjectListGUI.php.

{
return false;
}
ilObjectListGUI::isTitleBold ( )

public

Returns
boolean returns if the item title is bold or not

Definition at line 2625 of file class.ilObjectListGUI.php.

References $bold_title.

{
return $this->bold_title;
}
ilObjectListGUI::setAdditionalInformation (   $a_val)

Set additional information.

Parameters
stringadditional information

Definition at line 806 of file class.ilObjectListGUI.php.

{
$this->additional_information = $a_val;
}
ilObjectListGUI::setBoldTitle (   $a_bold_title)

public boolean $a_bold_title set the item title bold

Definition at line 2614 of file class.ilObjectListGUI.php.

{
$this->bold_title = $a_bold_title;
}
ilObjectListGUI::setConditionDepth (   $a_depth)

set depth for precondition output (stops at level 5)

Definition at line 1456 of file class.ilObjectListGUI.php.

{
$this->condition_depth = $a_depth;
}
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 104 of file class.ilObjectListGUI.php.

{
$this->container_obj =& $container_obj;
}
ilObjectListGUI::setDescription (   $a_description)
Parameters
stringdescription
Returns
bool

Definition at line 734 of file class.ilObjectListGUI.php.

Referenced by initItem().

{
$this->description = $a_description;
}

+ Here is the caller graph for this function:

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)

Parameters
int$a_level
Returns

Definition at line 828 of file class.ilObjectListGUI.php.

{
$this->details_level = $a_level;
}
ilObjectListGUI::setExpanded (   $a_status)

Definition at line 366 of file class.ilObjectListGUI.php.

{
$this->is_expanded = $a_status;
}
ilObjectListGUI::setItemDetailLinks (   $a_detail_links,
  $a_intro_txt = '' 
)

set items detail links

public

Parameters
arraye.g. array(0 => array('desc' => 'Page: ','link' => 'ilias.php...','name' => 'Page XYZ')
Returns

Definition at line 670 of file class.ilObjectListGUI.php.

{
$this->item_detail_links = $a_detail_links;
$this->item_detail_links_intro = $a_intro_txt;
}
ilObjectListGUI::setMode (   $a_mode)

set output mode

Parameters
string$a_modeoutput mode (IL_LIST_FULL | IL_LIST_AS_TRIGGER)

Definition at line 1438 of file class.ilObjectListGUI.php.

{
$this->mode = $a_mode;
}
ilObjectListGUI::setPositionInputField (   $a_field_index,
  $a_position_value 
)

Set position input field.

Parameters
string$a_field_indexe.g. "[crs][34]"
string$a_position_valuee.g. "2.0"

Definition at line 381 of file class.ilObjectListGUI.php.

{
$this->position_enabled = true;
$this->position_field_index = $a_field_index;
$this->position_value = $a_position_value;
}
ilObjectListGUI::setRelevance (   $a_rel)

set relevance

Parameters
int
Returns

Definition at line 291 of file class.ilObjectListGUI.php.

{
$this->relevance = $a_rel;
}
ilObjectListGUI::setSearchFragment (   $a_text)

set search fragment

Parameters
string$a_texthighlighted search fragment
Returns

Definition at line 754 of file class.ilObjectListGUI.php.

{
$this->search_fragment = $a_text;
}
ilObjectListGUI::setSeparateCommands (   $a_val)

Set separate commands.

Parameters
booleanseparate commands

Definition at line 773 of file class.ilObjectListGUI.php.

{
$this->separate_commands = $a_val;
}
ilObjectListGUI::setTitle (   $a_title)
Parameters
stringtitle
Returns
bool

Definition at line 715 of file class.ilObjectListGUI.php.

Referenced by initItem().

{
$this->title = $a_title;
}

+ Here is the caller graph for this function:

ilObjectListGUI::storeAccessCache ( )

Store access cache.

Definition at line 2394 of file class.ilObjectListGUI.php.

References $ref_id.

Referenced by getListItemHTML().

{
global $ilUser;
if($this->acache->getLastAccessStatus() == "miss" &&
!$this->prevent_access_caching)
{
$this->acache->storeEntry($ilUser->getId().":".$this->ref_id,
serialize($this->access_cache), $this->ref_id);
}
}

+ Here is the caller graph for this function:

Field Documentation

ilObjectListGUI::$additional_information = false
protected

Definition at line 72 of file class.ilObjectListGUI.php.

Referenced by getAdditionalInformation().

ilObjectListGUI::$bold_title = false
protected

Definition at line 63 of file class.ilObjectListGUI.php.

Referenced by isTitleBold().

ilObjectListGUI::$checkboxes_enabled = false
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.

ilObjectListGUI::$copy_enabled = true
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().

ilObjectListGUI::$details_level = self::DETAILS_ALL
protected

Definition at line 67 of file class.ilObjectListGUI.php.

Referenced by getDetailsLevel().

ilObjectListGUI::$enabled_relevance = false
protected

Definition at line 58 of file class.ilObjectListGUI.php.

Referenced by enabledRelevance().

ilObjectListGUI::$expand_enabled = false
protected

Definition at line 61 of file class.ilObjectListGUI.php.

Referenced by getExpandStatus().

ilObjectListGUI::$icons_enabled = false
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().

ilObjectListGUI::$is_expanded = true
protected

Definition at line 62 of file class.ilObjectListGUI.php.

Referenced by isExpanded().

ilObjectListGUI::$item_detail_links = array()
protected

Definition at line 51 of file class.ilObjectListGUI.php.

ilObjectListGUI::$item_detail_links_enabled = false
protected

Definition at line 50 of file class.ilObjectListGUI.php.

Referenced by getItemDetailLinkStatus().

ilObjectListGUI::$item_detail_links_intro = ''
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().

ilObjectListGUI::$path_linked = false
protected

Definition at line 56 of file class.ilObjectListGUI.php.

ilObjectListGUI::$position_enabled = false
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().

ilObjectListGUI::$progress_enabled = false
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().

ilObjectListGUI::$reference_ref_id = false
protected

Definition at line 69 of file class.ilObjectListGUI.php.

ilObjectListGUI::$relevance = 0
protected

Definition at line 59 of file class.ilObjectListGUI.php.

Referenced by getRelevance().

ilObjectListGUI::$search_fragment = ''
protected

Definition at line 55 of file class.ilObjectListGUI.php.

Referenced by getSearchFragment().

ilObjectListGUI::$search_fragment_enabled = false
protected

Definition at line 71 of file class.ilObjectListGUI.php.

Referenced by getSearchFragmentStatus().

ilObjectListGUI::$search_fragments_enabled = false
protected

Definition at line 54 of file class.ilObjectListGUI.php.

ilObjectListGUI::$separate_commands = false
protected

Definition at line 70 of file class.ilObjectListGUI.php.

Referenced by getSeparateCommands().

ilObjectListGUI::$static_link_enabled = false
protected

Definition at line 73 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.

ilObjectListGUI::$substitutions = null
protected

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

ilObjectListGUI::$substitutions_enabled = false
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().

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