ilClipboardTableGUI Class Reference

TableGUI clipboard items. More...

Inheritance diagram for ilClipboardTableGUI:

Collaboration diagram for ilClipboardTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd)
	Constructor.
	getItems ()
	Get items from user clipboard.
Public Member Functions inherited from ilTable2GUI
	getParentObject ()
	Get parent object.
	getParentCmd ()
	Get parent command.
	setNoEntriesText ($a_text)
	Set text for an empty table.
	getNoEntriesText ()
	Get text for an empty table.
	setEnableTitle ($a_enabletitle)
	Set Enable Title.
	getEnableTitle ()
	Get Enable Title.
	setEnableHeader ($a_enableheader)
	Set Enable Header.
	getEnableHeader ()
	Get Enable Header.
	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	set table title public
	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
	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.
	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.
	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.
	addCommandButton ($a_cmd, $a_text)
	Add Command button.
	setCloseCommand ($a_link)
	Add command for closing table.
	addMultiCommand ($a_cmd, $a_text)
	Add Command button.
	addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
	Add Header Command (Link) (Image needed for now)
	addColumn ($a_text, $a_sort_field="", $a_width="")
	Add a column to the header.
	getNavParameter ()
	setOrderLink ($sort_field, $order_dir)
	fillHeader ()
	getHTML ()
	numericOrdering ($a_field)
	Should this field be sorted numeric?
	render ()
	render table public
	fillFooter ()
	Fill footer row.
	getLinkbar ($a_num)
	Get previous/next linkbar.
	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 public
	disable ($a_module_name)
	diesables particular modules of table public
	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)
	Standard Version of Fill Row.

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 = ""

Detailed Description

TableGUI clipboard items.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

ilClipboardTableGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd
	)

Constructor.

Reimplemented from ilTable2GUI.

Definition at line 40 of file class.ilClipboardTableGUI.php.

References $ilCtrl, $lng, ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), getItems(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setTitle().

        {
                global $ilCtrl, $lng, $ilAccess;
                
                parent::__construct($a_parent_obj, $a_parent_cmd);
                $lng->loadLanguageModule("mep");

                $this->addColumn("", "", "1");  // checkbox
                $this->addColumn($lng->txt("mep_thumbnail"), "", "1");
                $this->addColumn($lng->txt("mep_title_and_description"), "", "100%");
                $this->setEnableHeader(true);
                $this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
                $this->setRowTemplate("tpl.clipboard_tbl_row.html",
                        "Services/Clipboard");
                $this->getItems();
                
                // title
                $this->setTitle($lng->txt("clipboard"), "icon_clip.gif", $lng->txt("clipboard"));

                $this->setDefaultOrderField("title");
                
                // action commands
                if ($this->parent_obj->mode == "getObject")
                {
                        $this->addMultiCommand("insert", $this->parent_obj->getInsertButtonTitle());
                }
                $this->addMultiCommand("remove", $lng->txt("remove"));
                
                $this->setSelectAllCheckbox("id");
        }

Here is the call graph for this function:

Member Function Documentation

ilClipboardTableGUI::fillRow (   $a_set )

protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Reimplemented from ilTable2GUI.

Definition at line 88 of file class.ilClipboardTableGUI.php.

References $ilCtrl, $lng, and ilObjMediaObjectGUI\_getMediaInfoHTML().

        {
                global $lng, $ilCtrl, $ilAccess;

                // output thumbnail
                $mob = new ilObjMediaObject($a_set["id"]);
                $med = $mob->getMediaItem("Standard");
                $target = $med->getThumbnailTarget();
                if ($target != "")
                {
                        $this->tpl->setCurrentBlock("thumbnail");
                        $this->tpl->setVariable("IMG_THUMB", $target);
                        $this->tpl->parseCurrentBlock();
                }

                // allow editing of media objects
                if ($this->parent_obj->mode != "getObject")
                {                                       
                        // output edit link
                        $this->tpl->setCurrentBlock("edit");
                        $ilCtrl->setParameter($this->parent_obj, "clip_mob_id", $a_set["id"]);
                        $this->tpl->setVariable("EDIT_LINK",
                                $ilCtrl->getLinkTargetByClass("ilObjMediaObjectGUI", "edit",
                                        array("ilEditClipboardGUI")));
                        $this->tpl->setVariable("TEXT_OBJECT", $a_set["title"].
                                " [".$a_set["id"]."]");
                        $this->tpl->parseCurrentBlock();
                }
                else            // just list elements for selection
                {
                        $this->tpl->setCurrentBlock("show");
                        $this->tpl->setVariable("TEXT_OBJECT2", $a_set["title"].
                                " [".$a_set["id"]."]");
                        $this->tpl->parseCurrentBlock();
                }
                
                include_once("./Services/MediaObjects/classes/class.ilObjMediaObjectGUI.php");
                $this->tpl->setVariable("MEDIA_INFO",
                        ilObjMediaObjectGUI::_getMediaInfoHTML($mob));
                $this->tpl->setVariable("CHECKBOX_ID", $a_set["id"]);
        }

Here is the call graph for this function:

ilClipboardTableGUI::getItems

(

)

Get items from user clipboard.

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

References $_GET, ilTable2GUI\setData(), and ilUtil\sortArray().

Referenced by __construct().

        {
                global $ilUser;
                
                $objs = $ilUser->getClipboardObjects("mob");
                $objs = ilUtil::sortArray($objs, $_GET["sort_by"], $_GET["sort_order"]);

                $this->setData($objs);
        }

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/Clipboard/classes/class.ilClipboardTableGUI.php