ilSearchResultExplorer Class Reference

Inheritance diagram for ilSearchResultExplorer:

Collaboration diagram for ilSearchResultExplorer:

Public Member Functions
	ilSearchResultExplorer ($a_target, $a_user_id)
	Constructor public.
	getUserId ()
	buildLinkTarget ($a_node_id, $a_type)
	get link target (may be overwritten by derived classes)
	buildFrameTarget ($a_type)
	isClickable ($a_type, $a_ref_id)
	check if links for certain object type are activated
	showChilds ($a_ref_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.
	formatHeader ($a_obj_id, $a_option)
	overwritten method from base class public
	__setRootId ()
Public Member Functions inherited from ilExplorer
	ilExplorer ($a_target)
	Constructor public.
	initItemCounter ($a_number)
	Init item counter.
	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
	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)
	setPostSort ($a_sort)
	process post sorting
	setFilterMode ($a_mode=IL_FM_NEGATIVE)
	set filter mode
	getFilterMode ()
	get filter mode
	setOutput ($a_parent_id, $a_depth=1, $a_obj_id=0)
	Creates output for explorer view in admin menue recursive method public.
	modifyChilds ($a_parent_id, $a_objects)
	forceExpanded ($a_obj_id)
	force expansion of node
	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 (
	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
	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)
	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
	$user_id
	$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

Detailed Description

Definition at line 34 of file class.ilSearchResultExplorer.php.

Member Function Documentation

ilSearchResultExplorer::__setRootId

(

)

Definition at line 175 of file class.ilSearchResultExplorer.php.

References $res, and DB_FETCHMODE_OBJECT.

Referenced by ilSearchResultExplorer().

        {
                $query = "SELECT * FROM search_tree ".
                        "WHERE tree = '".$this->user_id."' ".
                        "AND parent = '0'";

                $res = $this->ilias->db->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        define(ROOT_ID,$row->child);
                }
                return true;
        }

Here is the caller graph for this function:

ilSearchResultExplorer::buildFrameTarget

(

$a_type

)

Definition at line 90 of file class.ilSearchResultExplorer.php.

        {
                switch($a_type)
                {
                        case "seaf":

                                return "";
                }
        }

ilSearchResultExplorer::buildLinkTarget	(		$a_node_id,
			$a_type
	)

get link target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 81 of file class.ilSearchResultExplorer.php.

        {
                switch($a_type)
                {
                        case "seaf":
                                return "search_administration.php?viewmode=flat&folder_id=".$a_node_id;
                }
        }

ilSearchResultExplorer::formatHeader	(		$a_obj_id,
			$a_option
	)

overwritten method from base class public

Parameters

integer	obj_id
integer	array options

Returns

string

Definition at line 156 of file class.ilSearchResultExplorer.php.

References ilExplorer\$ilias, $lng, and $tpl.

        {
                global $lng, $ilias;

                $tpl = new ilTemplate("tpl.tree.html", true, true);

                $lng->loadLanguageModule("search");

                $tpl->setCurrentBlock("link");
                $tpl->setVariable("TITLE", $lng->txt("search_my_search_results"));
                $tpl->setVariable("LINK_TARGET", "search_administration.php");
                $tpl->parseCurrentBlock();

                $tpl->setCurrentBlock("row");
                $tpl->parseCurrentBlock();

                $this->output[] = $tpl->get();
        }

ilSearchResultExplorer::getUserId

(

)

Definition at line 76 of file class.ilSearchResultExplorer.php.

References $user_id.

Referenced by ilSearchResultExplorer().

        {
                return $this->user_id;
        }

Here is the caller graph for this function:

ilSearchResultExplorer::ilSearchResultExplorer	(		$a_target,
			$a_user_id
	)

Constructor public.

Parameters

string	scriptname
int	user_id

Definition at line 52 of file class.ilSearchResultExplorer.php.

References __setRootId(), ilExplorer\addFilter(), getUserId(), ilExplorer\ilExplorer(), ilExplorer\setFiltered(), ilExplorer\setFilterMode(), and ilExplorer\setSessionExpandVariable().

        {
                define("TABLE_SEARCH_DATA","search_data");
                define("TABLE_SEARCH_TREE","search_tree");

                parent::ilExplorer($a_target);

                $this->user_id = $a_user_id;
                
                $this->__setRootId();
                $this->tree = new ilTree($this->getUserId(),ROOT_ID);
                $this->tree->setTableNames(TABLE_SEARCH_TREE,TABLE_SEARCH_DATA);

                $this->root_id = ROOT_ID;
                $this->order_column = "title";
                $this->setSessionExpandVariable("sea_expand");

                $this->setFilterMode(IL_FM_POSITIV);
                $this->addFilter("seaf");
                #$this->addFilter("sea");
                $this->setFiltered(true);

        }

Here is the call graph for this function:

ilSearchResultExplorer::isClickable	(		$a_type,
			$a_ref_id
	)

check if links for certain object type are activated

Parameters

string

$a_type

object type

Returns

boolean true if linking is activated

Reimplemented from ilExplorer.

Definition at line 100 of file class.ilSearchResultExplorer.php.

        {
                global $rbacsystem;

                return true;
                switch ($a_type)
                {
                        // visible groups can allways be clicked; group processing decides
                        // what happens next
                        case "grp":
                                return true;
                                break;

                        // all other types are only clickable, if read permission is given
                        default:
                                if ($rbacsystem->checkAccess("read", $a_ref_id))
                                {
                                        return true;
                                }
                                else
                                {
                                        return false;
                                }
                                break;
                }
        }

ilSearchResultExplorer::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.

ilRepositoryExplorerGUI)

Reimplemented from ilExplorer.

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

        {
                global $rbacsystem;

                return true;

                if ($a_ref_id == 0)
                {
                        return true;
                }

                if ($rbacsystem->checkAccess("read", $a_ref_id))
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

Field Documentation

ilSearchResultExplorer::$output

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

ilSearchResultExplorer::$root_id

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

ilSearchResultExplorer::$user_id

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

Referenced by getUserId().

---

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

• Services/Search/classes/class.ilSearchResultExplorer.php