ILIAS  Release_4_2_x_branch Revision 61807
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilPublicSectionSelector Class Reference
+ Inheritance diagram for ilPublicSectionSelector:
+ Collaboration diagram for ilPublicSectionSelector:

Public Member Functions

 ilPublicSectionSelector ($a_target, &$a_lm_obj, $a_gui_class)
 Constructor public.
 formatHeader ($tpl, $a_obj_id, $a_option)
 overwritten method from base class public
 getOutput ()
 Creates output recursive method public.
 formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
 Creates output recursive method private.
- 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
 isClickable ($a_type, $a_obj_id=0)
 check if links for certain object type are activated
- Public Member Functions inherited from ilExplorer
 ilExplorer ($a_target)
 Constructor public.
 setAsynchExpanding ($a_val)
 Set asynch expanding.
 getAsynchExpanding ()
 Get asynch expanding.
 initItemCounter ($a_number)
 Init item counter.
 setTitle ($a_val)
 Set title.
 setTitleLength ($a_length)
 Set max title length.
 getTitleLength ()
 Get max title length.
 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
 isVisible ($a_ref_id, $a_type)
 setTreeLead ($a_val)
 Set tree leading content.
 getTreeLead ()
 Get tree leading content.
 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.
 getChildsOfNode ($a_parent_id)
 Get childs of node.
 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.
 forceExpanded ($a_obj_id)
 force expansion of node
 getMaximumTreeDepth ()
 Get maximum tree depth.
 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 (
 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
 buildLinkTarget ($a_node_id, $a_type)
 get link target (may be overwritten by derived classes)
 buildOnClick ($a_node_id, $a_type, $a_title)
 get onclick event handling (may be overwritten by derived classes)
 buildTitle ($a_title, $a_id, $a_type)
 standard implementation for title, 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, $a_append_anch=true)
 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

 $root_id
 $output
 $ctrl
 $selectable_type
 $ref_id
- 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 35 of file class.ilPublicSectionSelector.php.

Member Function Documentation

ilPublicSectionSelector::formatHeader (   $tpl,
  $a_obj_id,
  $a_option 
)

overwritten method from base class public

Parameters
integerobj_id
integerarray options
Returns
string

Definition at line 75 of file class.ilPublicSectionSelector.php.

References ilExplorer\$ilias, $lng, $tpl, and ilUtil\shortenText().

Referenced by getOutput().

{
global $lng, $ilias;
//$tpl = new ilTemplate("tpl.tree_form.html", true, true);
return;
$tpl->setCurrentBlock("link");
$tpl->setVariable("TITLE", ilUtil::shortenText($this->lm_obj->getTitle(), $this->textwidth, true));
$tpl->setVariable("LINK_TARGET", $this->target);
$tpl->setVariable("TARGET", " target=\"".$this->frame_target."\"");
$tpl->parseCurrentBlock();
$tpl->setCurrentBlock("element");
$tpl->parseCurrentBlock();
//$this->output[] = $tpl->get();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilPublicSectionSelector::formatObject ( $tpl,
  $a_node_id,
  $a_option,
  $a_obj_id = 0 
)

Creates output recursive method private.

Parameters
integer
array
Returns
string

Reimplemented from ilExplorer.

Definition at line 162 of file class.ilPublicSectionSelector.php.

References $lng, $tpl, ilLMObject\_isPagePublic(), ilUtil\array_php2js(), ilUtil\getImagePath(), and ilUtil\shortenText().

Referenced by getOutput().

{
global $lng;
if (!isset($a_node_id) or !is_array($a_option))
{
$this->ilias->raiseError(get_class($this)."::formatObject(): Missing parameter or wrong datatype! ".
"node_id: ".$a_node_id." options:".var_dump($a_option),$this->ilias->error_obj->WARNING);
}
if ($this->output_icons)
{
$tpl->setCurrentBlock("icon");
$tpl->setVariable("ICON_IMAGE" ,ilUtil::getImagePath("icon_".$a_option["type"].".gif"));
$tpl->setVariable("PAGE_ID" , $a_node_id);
//$this->iconList[] = "iconid_".$a_node_id;
$tpl->setVariable("TXT_ALT_IMG", $lng->txt($a_option["desc"]));
$tpl->parseCurrentBlock();
}
if (!$a_option["container"])
{
$tpl->setCurrentBlock("checkbox");
$tpl->setVariable("PAGE_ID", $a_node_id);
if (ilLMObject::_isPagePublic($a_node_id))
{
$tpl->setVariable("CHECKED","checked=\"checked\"");
}
$tpl->parseCurrentBlock();
}
else
{
$childs = $this->tree->getChilds($a_node_id);
foreach ($childs as $node)
{
if ($node["type"] == "pg")
{
$pages[] = $node["child"];
}
}
$js_pages = ilUtil::array_php2js($pages);
$tpl->setVariable("ONCLICK", " onclick=\"alterCheckboxes('PublicSelector','page_',$js_pages); return false;\"");
}
$tpl->setCurrentBlock("text");
$tpl->setVariable("PAGE_ID", $a_node_id);
$tpl->setVariable("OBJ_TITLE", ilUtil::shortenText($a_option["title"], $this->textwidth, true));
$tpl->parseCurrentBlock();
$tpl->setCurrentBlock("element");
$tpl->parseCurrentBlock();
//$this->output[] = $tpl->get();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilPublicSectionSelector::getOutput ( )

Creates output recursive method public.

Returns
string

Reimplemented from ilExplorer.

Definition at line 99 of file class.ilPublicSectionSelector.php.

References $ilBench, $tpl, ilExplorer\createLines(), formatHeader(), formatObject(), ilExplorer\handleListEndTags(), and ilExplorer\handleListStartTags().

{
global $ilBench, $tpl;
$ilBench->start("Explorer", "getOutput");
$this->format_options[0]["tab"] = array();
$depth = $this->tree->getMaximumDepth();
for ($i=0;$i<$depth;++$i)
{
$this->createLines($i);
}
// set global body class
$tpl->setBodyClass("il_Explorer");
$tpl_tree = new ilTemplate("tpl.tree_form.html", true, true);
$cur_depth = -1;
foreach ($this->format_options as $key => $options)
{
//echo "-".$options["depth"]."-";
if (!$options["visible"])
{
continue;
}
// end tags
$this->handleListEndTags($tpl_tree, $cur_depth, $options["depth"]);
// start tags
$this->handleListStartTags($tpl_tree, $cur_depth, $options["depth"]);
$cur_depth = $options["depth"];
if ($options["visible"] and $key != 0)
{
$this->formatObject($tpl_tree, $options["child"],$options,$options['obj_id']);
}
if ($key == 0)
{
$this->formatHeader($tpl_tree, $options["child"],$options);
}
}
$this->handleListEndTags($tpl_tree, $cur_depth, -1);
$ilBench->stop("Explorer", "getOutput");
return $tpl_tree->get();
}

+ Here is the call graph for this function:

ilPublicSectionSelector::ilPublicSectionSelector (   $a_target,
$a_lm_obj,
  $a_gui_class 
)

Constructor public.

Parameters
stringscriptname
objectlm object
stringgui class name

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

References $ilCtrl, ilExplorer\forceExpandAll(), ilLMExplorer\ilLMExplorer(), and ilExplorer\setSessionExpandVariable().

{
global $ilCtrl;
$this->ctrl =& $ilCtrl;
$this->gui_class = $a_gui_class;
parent::ilLMExplorer($a_target, $a_lm_obj);
$this->forceExpandAll(true);
$this->setSessionExpandVariable("lmpublicselectorexpand");
}

+ Here is the call graph for this function:

Field Documentation

ilPublicSectionSelector::$ctrl

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

ilPublicSectionSelector::$output

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

ilPublicSectionSelector::$ref_id

Definition at line 47 of file class.ilPublicSectionSelector.php.

ilPublicSectionSelector::$root_id

Definition at line 42 of file class.ilPublicSectionSelector.php.

ilPublicSectionSelector::$selectable_type

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


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