Public Member Functions | Data Fields

ilSearchRootSelector Class Reference

Inheritance diagram for ilSearchRootSelector:
Collaboration diagram for ilSearchRootSelector:

Public Member Functions

 ilSearchRootSelector ($a_target)
 Constructor public.
 setSelectableType ($a_type)
 setRefId ($a_ref_id)
 buildLinkTarget ($a_node_id, $a_type)
 get link target (may be overwritten by derived classes)
 buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
 get frame target (may be overwritten by derived classes)
 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

Data Fields

 $root_id
 $output
 $ctrl
 $selectable_type
 $ref_id

Detailed Description

Definition at line 35 of file class.ilSearchRootSelector.php.


Member Function Documentation

ilSearchRootSelector::buildFrameTarget ( a_type,
a_child = 0,
a_obj_id = 0 
)

get frame target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 98 of file class.ilSearchRootSelector.php.

        {
                return '';
        }

ilSearchRootSelector::buildLinkTarget ( a_node_id,
a_type 
)

get link target (may be overwritten by derived classes)

Reimplemented from ilExplorer.

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

        {
                $this->ctrl->setParameterByClass('ilsearchgui',"root_id",$a_node_id);
                
                return $this->ctrl->getLinkTargetByClass('ilsearchgui','selectRoot');

        }

ilSearchRootSelector::formatHeader ( a_obj_id,
a_option 
)

overwritten method from base class public

Parameters:
integer obj_id
integer array options
Returns:
string

Reimplemented from ilExplorer.

Definition at line 130 of file class.ilSearchRootSelector.php.

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

        {
                global $lng, $ilias;

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

                $tpl->setCurrentBlock("link");
                $tpl->setVariable("LINK_NAME",$lng->txt('repository'));
                
                $this->ctrl->setParameterByClass('ilsearchgui','root_id',ROOT_FOLDER_ID);
                $tpl->setVariable("LINK_TARGET",$this->ctrl->getLinkTargetByClass('ilsearchgui','selectRoot'));
                $tpl->setVariable("TITLE", $lng->txt("repository"));
                
                $tpl->parseCurrentBlock();
                $tpl->setCurrentBlock("row");
                $tpl->parseCurrentBlock();

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

                return true;
        }

ilSearchRootSelector::ilSearchRootSelector ( a_target  ) 

Constructor public.

Parameters:
string scriptname
int user_id

Definition at line 55 of file class.ilSearchRootSelector.php.

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

        {
                global $tree,$ilCtrl;

                $this->ctrl = $ilCtrl;

                parent::ilExplorer($a_target);
                $this->tree = $tree;
                $this->root_id = $this->tree->readRootId();
                $this->order_column = "title";

                $this->setSessionExpandVariable("search_root_expand");

                // add here all container objects
                $this->addFilter("root");
                $this->addFilter("cat");
                $this->addFilter("grp");
                $this->addFilter("fold");
                $this->addFilter("crs");

                $this->setFiltered(true);
                $this->setFilterMode(IL_FM_POSITIVE);

        }

Here is the call graph for this function:

ilSearchRootSelector::setRefId ( a_ref_id  ) 

Definition at line 84 of file class.ilSearchRootSelector.php.

        {
                $this->ref_id = $a_ref_id;
        }

ilSearchRootSelector::setSelectableType ( a_type  ) 

Definition at line 80 of file class.ilSearchRootSelector.php.

        {
                $this->selectable_type  = $a_type;
        }

ilSearchRootSelector::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 103 of file class.ilSearchRootSelector.php.

References $rbacsystem.

        {
                global $rbacsystem;

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

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


Field Documentation

ilSearchRootSelector::$ctrl

Definition at line 45 of file class.ilSearchRootSelector.php.

ilSearchRootSelector::$output

Reimplemented from ilExplorer.

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

ilSearchRootSelector::$ref_id

Definition at line 48 of file class.ilSearchRootSelector.php.

ilSearchRootSelector::$root_id

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

ilSearchRootSelector::$selectable_type

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


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