ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields
ilLMTOCExplorer Class Reference
+ Inheritance diagram for ilLMTOCExplorer:
+ Collaboration diagram for ilLMTOCExplorer:

Public Member Functions

 ilLMTOCExplorer ($a_target, &$a_lm_obj)
 Constructor public.
 setOfflineMode ($a_offline=true)
 set offline mode
 offlineMode ()
 get offline mode
 setForceOpenPath ($a_path)
 set force open path
 buildTitle ($a_title, $a_id, $a_type)
 standard implementation for title, maybe overwritten by derived classes
 getImage ($a_name)
 get image path (may be overwritten by derived classes)
 isClickable ($a_type, $a_node_id)
 check if links for certain object type are activated
 buildLinkTarget ($a_node_id, $a_type)
 build link target
 forceExpanded ($a_obj_id)
 force expansion of node
 isVisible ($a_id, $a_type)
- Public Member Functions inherited from ilLMExplorer
 ilLMExplorer ($a_target, &$a_lm_obj)
 Constructor public.
 formatHeader (&$tpl, $a_obj_id, $a_option)
 overwritten method from base class public
- Public Member Functions inherited from ilExplorer
 ilExplorer ($a_target)
 Constructor public.
 initItemCounter ($a_number)
 Init item counter.
 setTitle ($a_val)
 Set title.
 getTitle ()
 Get title.
 setRoot ($a_root_id)
 Set root node.
 getRoot ()
 get root id
 setOrderColumn ($a_column)
 set the order column public
 setOrderDirection ($a_direction)
 set the order direction public
 setTargetGet ($a_target_get)
 set the varname in Get-string public
 setParamsGet ($a_params_get)
 set additional params to be passed in Get-string public
 setExpandTarget ($a_exp_target)
 target script for expand icons
 setFrameUpdater ($a_up_frame, $a_up_script, $a_params="")
 Set Explorer Updater.
 highlightNode ($a_id)
 set highlighted node
 checkPermissions ($a_check)
 check permissions via rbac
 setSessionExpandVariable ($a_var_name="expand")
 set name of expand session variable
 outputIcons ($a_icons)
 output icons
 setClickable ($a_type, $a_clickable)
 (de-)activates links for a certain object type
 setPostSort ($a_sort)
 process post sorting
 setFilterMode ($a_mode=IL_FM_NEGATIVE)
 set filter mode
 getFilterMode ()
 get filter mode
 setUseStandardFrame ($a_val)
 Set use standard frame.
 getUseStandardFrame ()
 Get use standard explorer frame.
 setOutput ($a_parent_id, $a_depth=1, $a_obj_id=0, $a_highlighted_subtree=false)
 Creates output for explorer view in admin menue recursive method public.
 modifyChilds ($a_parent_id, $a_objects)
 showChilds ($a_parent_id)
 determines wether the childs of an object should be shown or not note: this standard implementation always returns true but it could be overwritten by derived classes (e.g.
 getOutput ()
 Creates output recursive method public.
 handleListEndTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
 handle list end tags ( and )
 handleListStartTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
 handle list start tags (
 formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
 Creates output recursive method private.
 getImage ($a_name, $a_type="", $a_obj_id="")
 get image path (may be overwritten by derived classes)
 getImageAlt ($a_default_text, $a_type="", $a_obj_id="")
 get image alt text
 getNodeStyleClass ($a_id, $a_type)
 get style class for node
 buildOnClick ($a_node_id, $a_type, $a_title)
 get onclick event handling (may be overwritten by derived classes)
 buildDescription ($a_desc, $a_id, $a_type)
 standard implementation for description, may be overwritten by derived classes
 buildSelect ($a_node_id, $a_type)
 standard implementation for adding an option select box between image and title
 buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
 get frame target (may be overwritten by derived classes)
 createTarget ($a_type, $a_node_id, $a_highlighted_subtree=false)
 Creates Get Parameter private.
 setFrameTarget ($a_target)
 set target frame or not frame?
 createLines ($a_depth)
 Creates lines for explorer view private.
 is_in_array ($a_start, $a_depth)
 DESCRIPTION MISSING private.
 getIndex ($a_data)
 get index of format_options array from specific ref_id,parent_id private
 addFilter ($a_item)
 adds item to the filter public
 delFilter ($a_item)
 removes item from the filter public
 setExpand ($a_node_id)
 set the expand option this value is stored in a SESSION variable to save it different view (lo view, frm view,...) private
 forceExpandAll ($a_mode, $a_show_minus=true)
 force expandAll.
 setFiltered ($a_bool)
 active/deactivate the filter public
 checkFilter ($a_item)
 check if item is in filter private
 sortNodes ($a_nodes, $a_parent_obj_id)
 sort nodes and put adm object to the end of sorted array private

Data Fields

 $offline
- Data Fields inherited from ilLMExplorer
 $root_id
 $lm_obj
 $output
- Data Fields inherited from ilExplorer
 $ilias
 $output
 $format_options
 $tree
 $target
 $target_get
 $params_get
 $expanded
 $order_column
 $order_direction = "asc"
 $expand_target
 $rbac_check
 $output_icons
 $expand_variable
 $is_clickable
 $post_sort
 $filtered = false
 $filter_mode
 $expand_all = false
 $root_id = null
 $use_standard_frame = false

Detailed Description

Definition at line 15 of file class.ilLMTOCExplorer.php.

Member Function Documentation

ilLMTOCExplorer::buildLinkTarget (   $a_node_id,
  $a_type 
)

build link target

Reimplemented from ilExplorer.

Reimplemented in ilShopPublicSectionSelector.

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

References ilPageObject\_lookupActive(), and offlineMode().

{
if (!$this->offlineMode())
{
return parent::buildLinkTarget($a_node_id, $a_type);
}
else
{
if ($a_node_id < 1)
{
$a_node_id = $this->tree->getRootId();
}
if ($a_type != "pg")
{
// get next activated page
$found = false;
while (!$found)
{
$a_node = $this->tree->fetchSuccessorNode($a_node_id, "pg");
$a_node_id = $a_node["child"];
include_once("./Services/COPage/classes/class.ilPageObject.php");
$active = ilPageObject::_lookupActive($a_node_id, $this->lm_obj->getType(),
$this->lm_set->get("time_scheduled_page_activation"));
if ($a_node_id > 0 && !$active)
{
$found = false;
}
else
{
$found = true;
}
}
}
if (!$this->lm_obj->cleanFrames())
{
return "frame_".$a_node_id."_maincontent.html";
}
else
{
return "lm_pg_".$a_node_id.".html";
}
}
}

+ Here is the call graph for this function:

ilLMTOCExplorer::buildTitle (   $a_title,
  $a_id,
  $a_type 
)

standard implementation for title, maybe overwritten by derived classes

Reimplemented from ilExplorer.

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

References ilStructureObject\_getPresentationTitle(), and ilLMPageObject\_getPresentationTitle().

{
//echo "<br>-$a_title-$a_type-$a_id-";
if ($a_type == "st")
{
return ilStructureObject::_getPresentationTitle($a_id,
$this->lm_obj->isActiveNumbering());
}
if ($this->lm_obj->getTOCMode() == "chapters" || $a_type != "pg")
{
return $a_title;
}
else
{
if ($a_type == "pg")
{
return ilLMPageObject::_getPresentationTitle($a_id,
$this->lm_obj->getPageHeader(), $this->lm_obj->isActiveNumbering(),
$this->lm_set->get("time_scheduled_page_activation"));
}
}
}

+ Here is the call graph for this function:

ilLMTOCExplorer::forceExpanded (   $a_obj_id)

force expansion of node

Reimplemented from ilExplorer.

Definition at line 215 of file class.ilLMTOCExplorer.php.

References offlineMode().

{
if ($this->offlineMode())
{
return true;
}
else
{
if (in_array($a_obj_id, $this->force_open_path))
{
return true;
}
return false;
}
}

+ Here is the call graph for this function:

ilLMTOCExplorer::getImage (   $a_name)

get image path (may be overwritten by derived classes)

Definition at line 89 of file class.ilLMTOCExplorer.php.

References ilUtil\getImagePath(), and offlineMode().

{
return ilUtil::getImagePath($a_name, false, "output", $this->offlineMode());
}

+ Here is the call graph for this function:

ilLMTOCExplorer::ilLMTOCExplorer (   $a_target,
&  $a_lm_obj 
)

Constructor public.

Parameters
stringscriptname
intuser_id

Definition at line 25 of file class.ilLMTOCExplorer.php.

References ilLMExplorer\ilLMExplorer().

Referenced by ilShopPublicSectionSelector\__construct().

{
$this->offline = false;
$this->force_open_path = array();
parent::ilLMExplorer($a_target, $a_lm_obj);
$this->lm_set = new ilSetting("lm");
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilLMTOCExplorer::isClickable (   $a_type,
  $a_obj_id 
)

check if links for certain object type are activated

Parameters
string$a_typeobject type
Returns
boolean true if linking is activated

Reimplemented from ilLMExplorer.

Reimplemented in ilShopPublicSectionSelector.

Definition at line 95 of file class.ilLMTOCExplorer.php.

References ilLMObject\_isPagePublic(), ilPageObject\_lookupActive(), ilPaymentObject\_requiresPurchaseToAccess(), and offlineMode().

{
global $ilUser;
$orig_node_id = $a_node_id;
if ($a_type == "st")
{
if (!$this->offlineMode())
{
$a_node = $this->tree->fetchSuccessorNode($a_node_id, "pg");
$a_node_id = $a_node["child"];
if ($a_node_id == 0)
{
return false;
}
}
else
{
// get next activated page
$found = false;
while (!$found)
{
$a_node = $this->tree->fetchSuccessorNode($a_node_id, "pg");
$a_node_id = $a_node["child"];
include_once("./Services/COPage/classes/class.ilPageObject.php");
$active = ilPageObject::_lookupActive($a_node_id, $this->lm_obj->getType(),
$this->lm_set->get("time_scheduled_page_activation"));
if ($a_node_id > 0 && !$active)
{
$found = false;
}
else
{
$found = true;
}
}
if ($a_node_id <= 0)
{
return false;
}
else
{
$path = $this->tree->getPathId($a_node_id);
if (!in_array($orig_node_id, $path))
{
return false;
}
}
}
}
if ($a_type == "pg")
{
// check public area mode
include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
include_once 'payment/classes/class.ilPaymentObject.php';
if (($ilUser->getId() == ANONYMOUS_USER_ID ||
ilPaymentObject::_requiresPurchaseToAccess((int)$this->lm_obj->getRefId())) &&
!ilLMObject::_isPagePublic($a_node_id, true))
{
return false;
}
}
return true;
}

+ Here is the call graph for this function:

ilLMTOCExplorer::isVisible (   $a_id,
  $a_type 
)

Reimplemented from ilExplorer.

Definition at line 231 of file class.ilLMTOCExplorer.php.

References ilPageObject\_lookupActive().

{
include_once("./Services/COPage/classes/class.ilPageObject.php");
$active = ilPageObject::_lookupActive($a_id, $this->lm_obj->getType(),
$this->lm_set->get("time_scheduled_page_activation"));
if(!$active && $a_type == "pg")
{
return false;
}
else
{
return true;
}
}

+ Here is the call graph for this function:

ilLMTOCExplorer::offlineMode ( )

get offline mode

Definition at line 44 of file class.ilLMTOCExplorer.php.

References $offline.

Referenced by ilShopPublicSectionSelector\buildLinkTarget(), buildLinkTarget(), forceExpanded(), getImage(), and isClickable().

{
return $this->offline;
}

+ Here is the caller graph for this function:

ilLMTOCExplorer::setForceOpenPath (   $a_path)

set force open path

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

{
$this->force_open_path = $a_path;
}
ilLMTOCExplorer::setOfflineMode (   $a_offline = true)

set offline mode

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

{
$this->offline = $a_offline;
}

Field Documentation

ilLMTOCExplorer::$offline

Definition at line 17 of file class.ilLMTOCExplorer.php.

Referenced by offlineMode().

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