ilAdminSubItemsTableGUI Class Reference

TableGUI class for sub items listed in repository administration. More...

Inheritance diagram for ilAdminSubItemsTableGUI:

Collaboration diagram for ilAdminSubItemsTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_ref_id)
	Constructor.
	getItems ()
	Get items.
Public Member Functions inherited from ilTable2GUI
	__construct ($a_parent_obj, $a_parent_cmd="")
	Constructor.
&	executeCommand ()
	Execute command.
	resetOffset ($a_in_determination=false)
	Reset offset.
	initFilter ()
	Init filter.
	getParentObject ()
	Get parent object.
	getParentCmd ()
	Get parent command.
	setTopAnchor ($a_val)
	Set top anchor.
	getTopAnchor ()
	Get top anchor.
	setNoEntriesText ($a_text)
	Set text for an empty table.
	getNoEntriesText ()
	Get text for an empty table.
	setIsDataTable ($a_val)
	Set is data table.
	getIsDataTable ()
	Get is data table.
	setEnableTitle ($a_enabletitle)
	Set Enable Title.
	getEnableTitle ()
	Get Enable Title.
	setEnableHeader ($a_enableheader)
	Set Enable Header.
	getEnableHeader ()
	Get Enable Header.
	setEnableNumInfo ($a_val)
	Set enable num info.
	getEnableNumInfo ()
	Get enable num info.
	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	Set title and title icon.
	setDescription ($a_val)
	Set description.
	getDescription ()
	Get description.
	setOrderField ($a_order_field)
	set order column
	getOrderField ()
	setData ($a_data)
	set table data public
	getData ()
	dataExists ()
	setPrefix ($a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) public
	getPrefix ()
	addFilterItem ($a_input_item, $a_optional=false)
	Add filter item.
	getFilterItems ($a_optionals=false)
	Get filter items.
	getFilterItemByPostVar ($a_post_var)
	setFilterCols ($a_val)
	Set filter columns.
	getFilterCols ()
	Get filter columns.
	setDisableFilterHiding ($a_val=true)
	Set disable filter hiding.
	getDisableFilterHiding ()
	Get disable filter hiding disable filter hiding.
	setCustomPreviousNext ($a_prev_link, $a_next_link)
	Set custom previous/next links.
	setFormAction ($a_form_action)
	Set Form action parameter.
	getFormAction ()
	Get Form action parameter.
	setFormName ($a_formname)
	Set Form name.
	getFormName ()
	Get Form name.
	setId ($a_val)
	Set id.
	getId ()
	Get element id.
	setDisplayAsBlock ($a_val)
	Set display as block.
	getDisplayAsBlock ()
	Get display as block.
	getSelectAllCheckbox ()
	Get the name of the checkbox that should be toggled with a select all button.
	setSelectAllCheckbox ($a_select_all_checkbox)
	Set the name of the checkbox that should be toggled with a select all button.
	setExternalSorting ($a_val)
	Set external sorting.
	getExternalSorting ()
	Get external sorting.
	setFilterCommand ($a_val)
	Set filter command.
	getFilterCommand ()
	Get filter command.
	setResetCommand ($a_val)
	Set reset filter command.
	getResetCommand ()
	Get reset filter command.
	setExternalSegmentation ($a_val)
	Set external segmentation.
	getExternalSegmentation ()
	Get external segmentation.
	setRowTemplate ($a_template, $a_template_dir="")
	Set row template.
	setDefaultOrderField ($a_defaultorderfield)
	Set Default order field.
	getDefaultOrderField ()
	Get Default order field.
	setDefaultOrderDirection ($a_defaultorderdirection)
	Set Default order direction.
	getDefaultOrderDirection ()
	Get Default order direction.
	clearCommandButtons ()
	addCommandButton ($a_cmd, $a_text, $a_onclick= '')
	Add Command button.
	addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection= '')
	Add Selection List + Command button.
	addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection= '')
	Add Selection List + Command button for selected items.
	setCloseCommand ($a_link)
	Add command for closing table.
	addMultiCommand ($a_cmd, $a_text)
	Add Command button.
	addHiddenInput ($a_name, $a_value)
	Add Hidden Input field.
	addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
	Add Header Command (Link) (Image needed for now)
	setTopCommands ($a_val)
	Set top commands (display command buttons on top of table, too)
	getTopCommands ()
	Get top commands (display command buttons on top of table, too)
	addColumn ($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="")
	Add a column to the header.
	getNavParameter ()
	setOrderLink ($sort_field, $order_dir)
	fillHeader ()
	determineOffsetAndOrder ($a_omit_offset=false)
	Determine offset and order.
	storeNavParameter ()
	getHTML ()
	Get HTML.
	numericOrdering ($a_field)
	Should this field be sorted numeric?
	render ()
	render table public
	writeFilterToSession ()
	Write filter values to session.
	resetFilter ()
	Reset filter.
	fillFooter ()
	Fill footer row.
	getLinkbar ($a_num)
	Get previous/next linkbar.
	fillHiddenRow ()
	fillActionRow ()
	Fill Action Row.
	setHeaderHTML ($html)
	set header html
Public Member Functions inherited from ilTableGUI
	ilTableGUI ($a_data=0, $a_global_tpl=true)
	Constructor.
	setTemplate (&$a_tpl)
	set template public
&	getTemplateObject ()
	setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
	set table help page public
	setHeaderNames ($a_header_names)
	set table header names public
	getColumnCount ()
	Returns the column count based on the number of the header row columns public.
	setHeaderVars ($a_header_vars, $a_header_params=0)
	set table header vars public
	setColumnWidth ($a_column_width)
	set table column widths public
	setOneColumnWidth ($a_column_width, $a_column_number)
	set one table column width public
	setMaxCount ($a_max_count)
	set max.
	setLimit ($a_limit=0, $a_default_limit=0)
	set max.
	getLimit ()
	Get limit.
	setOffset ($a_offset)
	set dataset offset public
	getOffset ()
	Get offset.
	setOrderColumn ($a_order_column=0, $a_default_column=0)
	set order column public
	getOrderColumn ()
	Get order column.
	setOrderDirection ($a_order_direction)
	set order direction public
	getOrderDirection ()
	Get order direction.
	setFooter ($a_style, $a_previous=0, $a_next=0)
	set order direction public
	enable ($a_module_name)
	enables particular modules of table
	disable ($a_module_name)
	diesables particular modules of table
	sortData ()
	renderHeader ()
	setStyle ($a_element, $a_style)
	getStyle ($a_element)
	setBase ($a_base)
	Set Base script name (deprecated, only use this for workarounds).
	getBase ()
	Get Base script name (deprecated, only use this for workarounds).
	clearActionButtons ()
	addActionButton ($btn_name, $btn_value)

Protected Member Functions
	fillRow ($a_set)
	Fill table row.
Protected Member Functions inherited from ilTable2GUI
	prepareOutput ()
	Anything that must be done before HTML is generated.

Additional Inherited Members
Data Fields inherited from ilTableGUI
	$title
	$icon
	$icon_alt
	$help_page
	$help_icon
	$help_icon_alt
	$header_names
	$header_vars
	$linkbar_vars
	$data
	$column_count
	$column_width
	$max_count
	$limit
	$max_limit = false
	$offset
	$order_column
	$order_direction
	$footer_style
	$footer_previous
	$footer_next
	$lang_support = true
	$global_tpl
	$form_name
	$select_all_checkbox
	$action_buttons
	$prefix
	$base = ""
	$enabled
	$styles
Protected Attributes inherited from ilTable2GUI
	$close_command = ""
	$top_anchor = "il_table_top"
	$filters = array()
	$optional_filters = array()
	$filter_cmd = 'applyFilter'
	$reset_cmd = 'resetFilter'
	$filter_cols = 4
	$ext_sort = false
	$ext_seg = false
	$mi_sel_buttons = null
	$disable_filter_hiding = false
	$top_commands = false

Detailed Description

TableGUI class for sub items listed in repository administration.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 14 of file class.ilAdminSubItemsTableGUI.php.

Constructor & Destructor Documentation

ilAdminSubItemsTableGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd,
			$a_ref_id
	)

Constructor.

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

References $_GET, $_SESSION, $ilCtrl, $lng, ilObject\_lookupType(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), getItems(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFormAction(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setSelectAllCheckbox().

        {
                global $ilCtrl, $lng, $ilAccess, $lng;
                
                $this->ref_id = $a_ref_id;
                
                parent::__construct($a_parent_obj, $a_parent_cmd);
//              $this->setTitle($lng->txt("items"));
                $this->setSelectAllCheckbox("id[]");
                
                $this->addColumn("", "", "1", 1);
                $this->addColumn($this->lng->txt("type"), "", "1");
                $this->addColumn($this->lng->txt("title"), "title");
                $this->addColumn($this->lng->txt("last_change"), "last_update", "25%");
                
                $this->setEnableHeader(true);
                $this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
                $this->setRowTemplate("tpl.admin_sub_items_row.html", "Services/Repository");
                //$this->disable("footer");
                $this->setEnableTitle(true);
                $this->setDefaultOrderField("title");
                $this->setDefaultOrderDirection("asc");

                // TODO: Needs other solution
                if(ilObject::_lookupType((int) $_GET['ref_id'],true) == 'chac')
                {
                        $this->getItems();
                        return true;
                }
                

                if (ilObject::_lookupType($_GET["ref_id"], true) != "recf")
                {
                        if ($_SESSION["clipboard"])
                        {
                                $this->addCommandButton("paste", $lng->txt("paste"));
                                $this->addCommandButton("clear", $lng->txt("clear"));
                        }
                        else
                        {
                                $this->addMultiCommand("cut", $lng->txt("cut"));
                                $this->addMultiCommand("delete", $lng->txt("delete"));
                                $this->addMultiCommand("link", $lng->txt("link"));
                        }
                }
                else
                {
                        if ($_SESSION["clipboard"])
                        {
                                $this->addCommandButton("clear", $lng->txt("clear"));
                        }
                        else
                        {
                                $this->addMultiCommand("cut", $lng->txt("cut"));
                                $this->addMultiCommand("removeFromSystem", $lng->txt("btn_remove_system"));
                        }
                }
                $this->getItems();
        }

Here is the call graph for this function:

Member Function Documentation

ilAdminSubItemsTableGUI::fillRow (   $a_set )

protected

Fill table row.

Reimplemented from ilTable2GUI.

Definition at line 121 of file class.ilAdminSubItemsTableGUI.php.

References $_GET, $_SESSION, $ilCtrl, $lng, ilTableGUI\$title, ilObject\_getIcon(), ilUtil\img(), ilPlugin\lookupTxt(), and ilUtil\shortenText().

        {
                global $lng, $objDefinition, $ilCtrl;

//              $this->tpl->setVariable("", );
                
                // surpress checkbox for particular object types AND the system role
                if (!$objDefinition->hasCheckbox($a_set["type"]) ||
                        $a_set["obj_id"] == SYSTEM_ROLE_ID ||
                        $a_set["obj_id"] == SYSTEM_USER_ID ||
                        $a_set["obj_id"] == ANONYMOUS_ROLE_ID)
                {
                        $this->tpl->touchBlock("no_checkbox");
                }
                else
                {
                        $this->tpl->setCurrentBlock("checkbox");
                        $this->tpl->setVariable("ID", $a_set["ref_id"]);
                        $this->tpl->parseCurrentBlock();
                }

                //build link
                $class_name = $objDefinition->getClassName($a_set["type"]);
                $class = strtolower("ilObj".$class_name."GUI");
                $ilCtrl->setParameterByClass($class, "ref_id", $a_set["ref_id"]);
                $this->tpl->setVariable("HREF_TITLE", $ilCtrl->getLinkTargetByClass($class, "view"));
                $ilCtrl->setParameterByClass($class, "ref_id", $_GET["ref_id"]);
                                        
                // TODO: broken! fix me
                $title = $a_set["title"];
                if (is_array($_SESSION["clipboard"]["ref_ids"]))
                {
                        if (in_array($a_set["ref_id"], $_SESSION["clipboard"]["ref_ids"]))
                        {
                                switch($_SESSION["clipboard"]["cmd"])
                                {
                                        case "cut":
                                                $title = "<del>".$title."</del>";
                                                break;
        
                                        case "copy":
                                                $title = "<font color=\"green\">+</font>  ".$title;
                                                break;
                                                        
                                        case "link":
                                                $title = "<font color=\"black\"><</font> ".$title;
                                                break;
                                }
                        }
                }
                $this->tpl->setVariable("VAL_TITLE", $title);
                $this->tpl->setVariable("VAL_DESC", ilUtil::shortenText($a_set["desc"] ,MAXLENGTH_OBJ_DESC, true));
                $this->tpl->setVariable("VAL_LAST_CHANGE", $a_set["last_update"]);
                $alt = ($objDefinition->isPlugin($a_set["type"]))
                        ? $lng->txt("icon")." ".ilPlugin::lookupTxt("rep_robj", $a_set["type"], "obj_".$a_set["type"])
                        : $lng->txt("icon")." ".$lng->txt("obj_".$a_set["type"]);
                $this->tpl->setVariable("IMG_TYPE", ilUtil::img(ilObject::_getIcon($a_set["obj_id"], "small"), $alt));
                //$this->tpl->setVariable("IMG_TYPE", ilObject::_getIcon($a_set["obj_id"], "small", $this->getIconImageType()),
                //      $lng->txt("icon")." ".$lng->txt("obj_".$a_set["type"])));
        }

Here is the call graph for this function:

ilAdminSubItemsTableGUI::getItems

(

)

Get items.

Definition at line 83 of file class.ilAdminSubItemsTableGUI.php.

References $key, and ilTable2GUI\setData().

Referenced by __construct().

        {
                global $rbacsystem, $objDefinition, $tree;
                
                $items = array();
                $childs = $tree->getChilds($this->ref_id);
                foreach ($childs as $key => $val)
            {
                        // visible
                        if (!$rbacsystem->checkAccess("visible",$val["ref_id"]))
                        {
                                continue;
                        }
                        
                        // hide object types in devmode
                        if ($objDefinition->getDevMode($val["type"]))
                        {
                                continue;
                        }
                        
                        // don't show administration in root node list
                        if ($val["type"] == "adm")
                        {
                                continue;
                        }
                        if (!$this->parent_obj->isVisible($val["ref_id"], $val["type"]))
                        {
                                continue;
                        }
                        $items[] = $val;
                }
                $this->setData($items);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Services/Repository/classes/class.ilAdminSubItemsTableGUI.php