ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields
ilShopExplorer Class Reference
Services/Payment

Class ilShopExplorer class for explorer view. More...

+ Inheritance diagram for ilShopExplorer:
+ Collaboration diagram for ilShopExplorer:

Public Member Functions

 ilShopExplorer ($tpl, $a_target, $a_ref_id)
 Constructor public.
 renderTree ()
 setOutput ($a_parent, $a_depth=1)
 Creates output for explorer view in admin menue recursive method public.
 getOutput ()
 Creates output recursive method public.
- Public Member Functions inherited from ilExplorer
 ilExplorer ($a_target)
 Constructor public.
 setId ($a_val)
 Set id.
 getId ()
 Get id.
 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.
 isClickable ($a_type, $a_ref_id=0)
 check if links for certain object type are activated
 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 (
 formatHeader (&$tpl, $a_obj_id, $a_option)
 Creates output for header (is empty here but can be overwritten in derived classes)
 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
 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
 $target = null
 $payment_objects = array()
- Data Fields inherited from ilExplorer
 $id
 $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

Class ilShopExplorer class for explorer view.

Author
Nadia Ahmad nahma.nosp@m.d@da.nosp@m.tabay.nosp@m..de
Version
$Id:$

Definition at line 20 of file class.ilShopExplorer.php.

Member Function Documentation

ilShopExplorer::getOutput ( )

Creates output recursive method public.

Returns
string

Reimplemented from ilExplorer.

Definition at line 143 of file class.ilShopExplorer.php.

{
return true;
}
ilShopExplorer::ilShopExplorer (   $tpl,
  $a_target,
  $a_ref_id 
)

Constructor public.

Parameters
stringscriptname

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

References $tpl, ilExplorer\$tree, ilExplorer\addFilter(), ilPaymentObject\getAllBuyableObjects(), IL_FM_NEGATIVE, ilExplorer\setFiltered(), and ilExplorer\setFilterMode().

{
global $tree;
$this->tree = $tree;
$this->tpl = $tpl;
$this->target = $a_target;
$this->payment_objects = ilPaymentObject::getAllBuyableObjects();
$this->tpl->addCss('./Services/Payment/css/shop_tree.css');
$this->addFilter("root");
$this->addFilter("cat");
$this->addFilter('catr');
$this->addFilter("grp");
$this->addFilter("icrs");
$this->addFilter("crs");
$this->addFilter('crsr');
$this->addFilter('rcrs');
$this->addFilter('file');
$this->addFilter('tst');
$this->addFilter('exc');
$this->setFiltered(true);
$this->setFilterMode(IL_FM_NEGATIVE);
}

+ Here is the call graph for this function:

ilShopExplorer::renderTree ( )

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

References setOutput().

{
$this->setOutput(0);
}

+ Here is the call graph for this function:

ilShopExplorer::setOutput (   $a_parent,
  $a_depth = 1 
)

Creates output for explorer view in admin menue recursive method public.

Parameters
integerparent_node_id where to start from (default=0, 'root')
integerdepth level where to start (default=1)
Returns
string

Definition at line 85 of file class.ilShopExplorer.php.

References $ilCtrl, $ref_id, $title, ilExplorer\$tree, ilPaymentObject\_isBuyable(), and ilExplorer\checkFilter().

Referenced by renderTree().

{
global $ilCtrl, $tree;
$this->root_id = $tree->getRootId();
if($a_parent < $a_depth)
{
foreach($this->payment_objects as $ref_id)
{
$objects = $tree->getPathFull($ref_id);
foreach($objects as $object)
{
if($object['child'] == $this->root_id)
{
$href = $ilCtrl->getLinkTargetByClass('ilshopgui','');
$title ="<span style='white-space:wrap;' class='frmTitle'><a class='small' href='".$href."'>"
.stripslashes($object['title'])."</a></span>"
."<div style='white-space:nowrap; margin-bottom:5px;' class='small'></div>";
$this->tpl->setVariable('TREE_ROOT_NODE_VARIABLE', 'Node'.$object['child']);
$this->tpl->setVariable('TREE_ROOT_NODE_LINK', $title);
// Recursive
$this->setOutput($object['child'], $a_depth);
}
else
{
if($this->checkFilter($object['type']) && ilPaymentObject::_isBuyable($object['ref_id']))
{
}
else
if($this->checkFilter($object['type']) && !ilPaymentObject::_isBuyable($object['ref_id']))
{
$href = $ilCtrl->getLinkTargetByClass('ilshopgui','');
$title ="<span style='white-space:wrap;' class='frmTitle'><a class='small' href='".$href."&tree_ref_id=".$object['child']."'>"
.stripslashes($object['title'])."</a></span>"
."<div style='white-space:nowrap; margin-bottom:5px;' class='small'></div>";
$this->tpl->setCurrentBlock('nodes');
$this->tpl->setVariable('NODES_VARNAME', 'Node'.$object['child']);
$this->tpl->setVariable('NODES_PARENT_VARNAME', 'Node'.$object['parent']);
$this->tpl->setVariable('NODES_LINK', $title);
$this->tpl->parseCurrentBlock();
// Recursive
$this->setOutput($object['child'], $a_depth);
}
}
} //foreach
}
}
} //function

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Field Documentation

ilShopExplorer::$payment_objects = array()

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

ilShopExplorer::$root_id

Definition at line 27 of file class.ilShopExplorer.php.

ilShopExplorer::$target = null

Definition at line 29 of file class.ilShopExplorer.php.

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