ilShopRepositoryExplorer Class Reference

Inheritance diagram for ilShopRepositoryExplorer:

Collaboration diagram for ilShopRepositoryExplorer:

Public Member Functions
	__construct ($a_target, $a_top_node=0)
	setForceOpenPath ($a_path)
	set force open path More...
	buildLinkTarget ($a_node_id, $a_type)
	note: most of this stuff is used by ilCourseContentInterface too More...
	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path More...
	isClickable ($a_type, $a_ref_id, $a_obj_id=0)
	showChilds ($a_ref_id, $a_obj_id=0)
	isVisible ($a_ref_id, $a_type)
	formatHeader (&$tpl, $a_obj_id, $a_option)
	overwritten method from base class public More...
	sortNodes ($a_nodes, $a_parent_obj_id)
	sort nodes More...
	forceExpanded ($a_node)
	Force expansion of node. More...
Public Member Functions inherited from ilExplorer
	ilExplorer ($a_target)
	Constructor public. More...
	setId ($a_val)
	Set id. More...
	getId ()
	Get id. More...
	setAsynchExpanding ($a_val)
	Set asynch expanding. More...
	getAsynchExpanding ()
	Get asynch expanding. More...
	initItemCounter ($a_number)
	Init item counter. More...
	setTitle ($a_val)
	Set title. More...
	setTitleLength ($a_length)
	Set max title length. More...
	getTitleLength ()
	Get max title length. More...
	getTitle ()
	Get title. More...
	setRoot ($a_root_id)
	Set root node. More...
	getRoot ()
	get root id More...
	setOrderColumn ($a_column)
	set the order column public More...
	setOrderDirection ($a_direction)
	set the order direction public More...
	setTargetGet ($a_target_get)
	set the varname in Get-string public More...
	setParamsGet ($a_params_get)
	set additional params to be passed in Get-string public More...
	setExpandTarget ($a_exp_target)
	target script for expand icons More...
	setFrameUpdater ($a_up_frame, $a_up_script, $a_params="")
	Set Explorer Updater. More...
	highlightNode ($a_id)
	set highlighted node More...
	checkPermissions ($a_check)
	check permissions via rbac More...
	setSessionExpandVariable ($a_var_name="expand")
	set name of expand session variable More...
	outputIcons ($a_icons)
	output icons More...
	setClickable ($a_type, $a_clickable)
	(de-)activates links for a certain object type More...
	isVisible ($a_ref_id, $a_type)
	setTreeLead ($a_val)
	Set tree leading content. More...
	getTreeLead ()
	Get tree leading content. More...
	isClickable ($a_type, $a_ref_id=0)
	check if links for certain object type are activated More...
	setPostSort ($a_sort)
	process post sorting More...
	setFilterMode ($a_mode=IL_FM_NEGATIVE)
	set filter mode More...
	getFilterMode ()
	get filter mode More...
	setUseStandardFrame ($a_val)
	Set use standard frame. More...
	getUseStandardFrame ()
	Get use standard explorer frame. More...
	getChildsOfNode ($a_parent_id)
	Get childs of node. More...
	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. More...
	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. More...
	forceExpanded ($a_obj_id)
	force expansion of node More...
	getMaximumTreeDepth ()
	Get maximum tree depth. More...
	getOutput ()
	Creates output recursive method public. More...
	handleListEndTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list end tags ( and ) More...
	handleListStartTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list start tags ( More...
	formatHeader (&$tpl, $a_obj_id, $a_option)
	Creates output for header (is empty here but can be overwritten in derived classes) More...
	formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
	Creates output recursive method private. More...
	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path (may be overwritten by derived classes) More...
	getImageAlt ($a_default_text, $a_type="", $a_obj_id="")
	get image alt text More...
	getNodeStyleClass ($a_id, $a_type)
	get style class for node More...
	buildLinkTarget ($a_node_id, $a_type)
	get link target (may be overwritten by derived classes) More...
	buildOnClick ($a_node_id, $a_type, $a_title)
	get onclick event handling (may be overwritten by derived classes) More...
	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, may be overwritten by derived classes More...
	buildDescription ($a_desc, $a_id, $a_type)
	standard implementation for description, may be overwritten by derived classes More...
	buildSelect ($a_node_id, $a_type)
	standard implementation for adding an option select box between image and title More...
	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	get frame target (may be overwritten by derived classes) More...
	createTarget ($a_type, $a_node_id, $a_highlighted_subtree=false, $a_append_anch=true)
	Creates Get Parameter private. More...
	setFrameTarget ($a_target)
	set target frame or not frame? More...
	createLines ($a_depth)
	Creates lines for explorer view private. More...
	is_in_array ($a_start, $a_depth)
	DESCRIPTION MISSING private. More...
	getIndex ($a_data)
	get index of format_options array from specific ref_id,parent_id private More...
	addFilter ($a_item)
	adds item to the filter public More...
	delFilter ($a_item)
	removes item from the filter public More...
	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 More...
	forceExpandAll ($a_mode, $a_show_minus=true)
	force expandAll. More...
	setFiltered ($a_bool)
	active/deactivate the filter public More...
	checkFilter ($a_item)
	check if item is in filter private More...
	sortNodes ($a_nodes, $a_parent_obj_id)
	sort nodes and put adm object to the end of sorted array private More...

Data Fields
	$root_id
	$output
	$ctrl
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

Definition at line 9 of file class.ilShopRepositoryExplorer.php.

Constructor & Destructor Documentation

__construct()

ilShopRepositoryExplorer::__construct	(		$a_target,
			$a_top_node = 0
	)

Parameters

	$a_target
int	$a_top_node

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

References $ilCtrl, ilExplorer\$tree, ilExplorer\addFilter(), IL_FM_POSITIVE, ilExplorer\setFiltered(), ilExplorer\setFilterMode(), and ilExplorer\setSessionExpandVariable().

        {
                global $tree, $ilCtrl;

                $this->ctrl = $ilCtrl;

                $this->force_open_path = array();

                parent::ilExplorer($a_target);
                $this->tree = $tree;
                $this->root_id = $this->tree->readRootId();
                $this->order_column = "title";
                $this->frame_target = false;
                $this->setSessionExpandVariable("repexpand");
                #$this->setTitle($lng->txt("overview"));

# Es sollen nur container angezeigt werden, die entweder als container (z.B. Kurse) kaufbar sind oder kaufbare Objekte enthalten können!

/*              if ($ilSetting->get("repository_tree_pres") == "" ||
                        ($ilSetting->get("rep_tree_limit_grp_crs") && $a_top_node == 0))
                {*/
                        $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_POSITIVE);
/*              }
                else if ($ilSetting->get("repository_tree_pres") == "all_types")
                {
                        foreach ($objDefinition->getAllRBACObjects() as $rtype)
                        {
                                $this->addFilter($rtype);
                        }
                        $this->setFiltered(true);
                        $this->setFilterMode(IL_FM_POSITIVE);
                }*/
        }

Here is the call graph for this function:

Member Function Documentation

buildLinkTarget()

ilShopRepositoryExplorer::buildLinkTarget	(		$a_node_id,
			$a_type
	)

note: most of this stuff is used by ilCourseContentInterface too

Definition at line 82 of file class.ilShopRepositoryExplorer.php.

References $_GET, $ilCtrl, and ilLink\_getStaticLink().

        {
                global $ilCtrl;
                switch($a_type)
                {

                        case "cat":
                                return "ilias.php?baseClass=ilshopcontroller&ref_id=".$a_node_id;

                        case "catr":
                                return "ilias.php?cmd=redirect&baseClass=ilshopcontroller&ref_id=".$a_node_id;

                        case "grp":
                                return "ilias.php?baseClass=ilshopcontroller&ref_id=".$a_node_id;

                        case "crs":
                                return "ilias.php?baseClass=ilshopcontroller&ref_id=".$a_node_id;

                        case "crsr":
                                return "ilias.php?cmd=redirect&baseClass=ilshopcontroller&ref_id=".$a_node_id;

                        case "icrs":
                                $ilCtrl->setParameterByClass("ilobjilinccoursegui", "ref_id", $a_node_id);
                                $link = $ilCtrl->getLinkTargetByClass(array("ilrepositorygui", "ilobjilinccoursegui"), "");
                                $ilCtrl->setParameterByClass("ilobjilinccoursegui", "ref_id", $_GET["ref_id"]);
                                return $link;

                        case 'rcrs':
                                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $a_node_id);
                                $link = $ilCtrl->getLinkTargetByClass("ilrepositorygui", "infoScreen");
                                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $_GET["ref_id"]);
                                return $link;

                        default:
                                include_once('./Services/Link/classes/class.ilLink.php');
                                return ilLink::_getStaticLink($a_node_id, $a_type, true);

                }
        }

Here is the call graph for this function:

forceExpanded()

ilShopRepositoryExplorer::forceExpanded

(

$a_node

)

Force expansion of node.

Parameters

Definition at line 403 of file class.ilShopRepositoryExplorer.php.

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

formatHeader()

ilShopRepositoryExplorer::formatHeader	(	&	$tpl,
			$a_obj_id,
			$a_option
	)

overwritten method from base class public

Parameters

integer	a_obj_id
integer	array options

Returns

string

Definition at line 296 of file class.ilShopRepositoryExplorer.php.

References $lng, $path, $tpl, ilExplorer\$tree, and ilObject\_getIcon().

        {
                global $lng, $tree;

                // custom icons
                /*
                if ($this->ilias->getSetting("custom_icons"))
                {
                        require_once("./Services/Container/classes/class.ilContainer.php");
                        if (($path = ilContainer::_lookupIconPath($a_obj_id, "tiny")) == "")
                        {
                                $path = ilUtil::getImagePath("icon_root_s.png");
                        }
                }*/

                $path = ilObject::_getIcon($a_obj_id, "tiny", "root");

                $tpl->setCurrentBlock("icon");
                $nd = $tree->getNodeData(ROOT_FOLDER_ID);
                $title = $nd["title"];

                if ($title == "ILIAS")
                {
                        $title = $lng->txt("repository");
                }

                $tpl->setVariable("ICON_IMAGE", $path);
                $tpl->setVariable("TXT_ALT_IMG", $lng->txt("icon")." ".$title);
                $tpl->parseCurrentBlock();

                $tpl->setCurrentBlock("link");
                $tpl->setVariable("TITLE", $title);
                $tpl->setVariable("LINK_TARGET", "ilias.php?baseClass=ilshopcontroller&ref_id=1");

                #$tpl->setVariable("TARGET", " target=\"_self\"");
                $tpl->parseCurrentBlock();

                $tpl->setCurrentBlock("element");
                $tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

getImage()

ilShopRepositoryExplorer::getImage	(		$a_name,
			$a_type = "",
			$a_obj_id = ""
	)

get image path

Definition at line 125 of file class.ilShopRepositoryExplorer.php.

References ilObject\_getIcon().

        {
                if ($a_type != "")
                {
                        return ilObject::_getIcon($a_obj_id, "tiny", $a_type);
                }

                return parent::getImage($a_name);
        }

Here is the call graph for this function:

isClickable()

ilShopRepositoryExplorer::isClickable	(		$a_type,
			$a_ref_id,
			$a_obj_id = 0
	)

Definition at line 135 of file class.ilShopRepositoryExplorer.php.

References $ilUser, $query, $res, $row, ilConditionHandler\_checkAllConditionsOfTarget(), ilContainerReferenceAccess\_isAccessible(), ilObject\_lookupObjectId(), ilObjGlossary\_lookupOnline(), and DB_FETCHMODE_OBJECT.

        {
                global $rbacsystem,$ilDB,$ilUser,$ilAccess;

                if(!ilConditionHandler::_checkAllConditionsOfTarget($a_ref_id,$a_obj_id))
                {
                        return false;
                }

                switch ($a_type)
                {
                        case "crs":
                                return $ilAccess->checkAccess("read", "", $a_ref_id);   

                        // visible groups can allways be clicked; group processing decides
                        // what happens next
                        case "grp":
                                return true;

                        case 'tst':
                                if(!$rbacsystem->checkAccess("read", $a_ref_id))
                                {
                                        return false;
                                }

                                $query = sprintf("SELECT * FROM tst_tests WHERE obj_fi=%s",$a_obj_id);
                                $res = $ilDB->query($query);
                                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                                {
                                        return (bool) $row->complete;
                                }
                                return false;

                        case 'svy':
                                if(!$rbacsystem->checkAccess("read", $a_ref_id))
                                {
                                        return false;
                                }

                                $query = sprintf("SELECT * FROM svy_svy WHERE obj_fi=%s",$a_obj_id);
                                $res = $ilDB->query($query);
                                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                                {
                                        return (bool) $row->complete;
                                }
                                return false;

                        // media pools can only be edited
                        case "mep":
                                if ($rbacsystem->checkAccess("read", $a_ref_id))
                                {
                                        return true;
                                }
                                else
                                {
                                        return false;
                                }
                                break;

                        case 'crsr':
                        case 'catr':
                                include_once('./Services/ContainerReference/classes/class.ilContainerReferenceAccess.php');
                                return ilContainerReferenceAccess::_isAccessible($a_ref_id);


                        // all other types are only clickable, if read permission is given
                        default:
                                if ($rbacsystem->checkAccess("read", $a_ref_id))
                                {
                                        // check if lm is online
                                        if ($a_type == "lm")
                                        {
                                                include_once("./Modules/LearningModule/classes/class.ilObjLearningModule.php");
                                                $lm_obj =& new ilObjLearningModule($a_ref_id);
                                                if((!$lm_obj->getOnline()) && (!$rbacsystem->checkAccess('write',$a_ref_id)))
                                                {
                                                        return false;
                                                }
                                        }
                                        // check if fblm is online
                                        if ($a_type == "htlm")
                                        {
                                                include_once("./Modules/HTMLLearningModule/classes/class.ilObjFileBasedLM.php");
                                                $lm_obj =& new ilObjFileBasedLM($a_ref_id);
                                                if((!$lm_obj->getOnline()) && (!$rbacsystem->checkAccess('write',$a_ref_id)))
                                                {
                                                        return false;
                                                }
                                        }
                                        // check if fblm is online
                                        if ($a_type == "sahs")
                                        {
                                                include_once("./Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php");
                                                $lm_obj =& new ilObjSAHSLearningModule($a_ref_id);
                                                if((!$lm_obj->getOnline()) && (!$rbacsystem->checkAccess('write',$a_ref_id)))
                                                {
                                                        return false;
                                                }
                                        }
                                        // check if glossary is online
                                        if ($a_type == "glo")
                                        {
                                                $obj_id = ilObject::_lookupObjectId($a_ref_id);
                                                include_once("./Modules/Glossary/classes/class.ilObjGlossary.php");
                                                if((!ilObjGlossary::_lookupOnline($obj_id)) &&
                                                        (!$rbacsystem->checkAccess('write',$a_ref_id)))
                                                {
                                                        return false;
                                                }
                                        }

                                        return true;
                                }
                                else
                                {
                                        return false;
                                }
                                break;
                }
        }

Here is the call graph for this function:

isVisible()

ilShopRepositoryExplorer::isVisible	(		$a_ref_id,
			$a_type
	)

Definition at line 278 of file class.ilShopRepositoryExplorer.php.

References ilExplorer\$tree.

        {
                global $ilAccess,$tree;

                if(!$ilAccess->checkAccess('visible', '', $a_ref_id))
                {
                        return false;
                }
                return true;
        }

setForceOpenPath()

ilShopRepositoryExplorer::setForceOpenPath

(

$a_path

)

set force open path

Definition at line 74 of file class.ilShopRepositoryExplorer.php.

        {
                $this->force_open_path = $a_path;
        }

showChilds()

ilShopRepositoryExplorer::showChilds	(		$a_ref_id,
			$a_obj_id = 0
	)

Definition at line 256 of file class.ilShopRepositoryExplorer.php.

References ilConditionHandler\_checkAllConditionsOfTarget().

        {
                global $rbacsystem;

                if ($a_ref_id == 0)
                {
                        return true;
                }
                if(!ilConditionHandler::_checkAllConditionsOfTarget($a_ref_id,$a_obj_id))
                {
                        return false;
                }
                if ($rbacsystem->checkAccess("read", $a_ref_id))
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

Here is the call graph for this function:

sortNodes()

ilShopRepositoryExplorer::sortNodes	(		$a_nodes,
			$a_parent_obj_id
	)

sort nodes

public

Parameters

Definition at line 344 of file class.ilShopRepositoryExplorer.php.

References $t, ilContainerSorting\_getInstance(), and ilObject\_lookupType().

        {
                global $objDefinition;

                if ($a_parent_obj_id > 0)
                {
                        $parent_type = ilObject::_lookupType($a_parent_obj_id);
                }
                else
                {
                        $parent_type  = "dummy";
                        $this->type_grps["dummy"] = array("root" => "dummy");
                }

                if (empty($this->type_grps[$parent_type]))
                {
                        $this->type_grps[$parent_type] =
                                $objDefinition->getGroupedRepositoryObjectTypes($parent_type);
                }
                $group = array();

                foreach ($a_nodes as $node)
                {
                        $g = $objDefinition->getGroupOfObj($node["type"]);
                        if ($g == "")
                        {
                                $g = $node["type"];
                        }
                        $group[$g][] = $node;
                }

                $nodes = array();
                foreach ($this->type_grps[$parent_type] as $t => $g)
                {
                        if (is_array($group[$t]))
                        {
                                // do we have to sort this group??
                                include_once("./Services/Container/classes/class.ilContainer.php");
                                include_once("./Services/Container/classes/class.ilContainerSorting.php");
                                $sort = ilContainerSorting::_getInstance($a_parent_obj_id);
                                $group = $sort->sortItems($group);

                                foreach ($group[$t] as $k => $item)
                                {
                                        $nodes[] = $item;
                                }
                        }
                }

                return $nodes;
                //return parent::sortNodes($a_nodes,$a_parent_obj_id);
        }

Here is the call graph for this function:

Field Documentation

$ctrl

ilShopRepositoryExplorer::$ctrl

Definition at line 18 of file class.ilShopRepositoryExplorer.php.

$output

ilShopRepositoryExplorer::$output

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

$root_id

ilShopRepositoryExplorer::$root_id

Definition at line 16 of file class.ilShopRepositoryExplorer.php.

---

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

• Services/Payment/classes/class.ilShopRepositoryExplorer.php