ilMediaPoolTableGUI Class Reference

TableGUI class for recent changes in wiki. More...

Inheritance diagram for ilMediaPoolTableGUI:

Collaboration diagram for ilMediaPoolTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_media_pool, $a_folder_par="obj_id", $a_mode=ilMediaPoolTableGUI::IL_MEP_EDIT)
	Constructor.
	setMode ($a_mode)
	Set Mode.
	getMode ()
	Get Mode.
	getItems ()
	Get items of current folder.
Public Member Functions inherited from ilTable2GUI
	__construct ($a_parent_obj, $a_parent_cmd="")
	Constructor.
	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)

Data Fields
const	IL_MEP_SELECT = "select"
const	IL_MEP_EDIT = "edit"

Protected Member Functions
	fillRow ($a_set)
	Standard Version of Fill Row.

Additional Inherited Members
Protected Attributes inherited from ilTable2GUI
	$close_command = ""

Detailed Description

TableGUI class for recent changes in wiki.

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.ilMediaPoolTableGUI.php.

Constructor & Destructor Documentation

ilMediaPoolTableGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd,
			$a_media_pool,
			$a_folder_par = "obj_id",
			$a_mode = ilMediaPoolTableGUI::IL_MEP_EDIT
	)

Constructor.

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

References $_GET, $_SESSION, $ilCtrl, $lng, ilObject\_lookupTitle(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addHeaderCommand(), ilTable2GUI\addMultiCommand(), getItems(), getMode(), ilObjMediaPool\getPoolTree(), IL_MEP_EDIT, IL_MEP_SELECT, ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), setMode(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setTitle().

        {
                global $ilCtrl, $lng, $ilAccess, $lng;
                
                parent::__construct($a_parent_obj, $a_parent_cmd);
                $this->setMode($a_mode);
                $lng->loadLanguageModule("mep");
                
                $this->media_pool = $a_media_pool;
                $this->tree = ilObjMediaPool::getPoolTree($this->media_pool->getId());
                $this->folder_par = $a_folder_par;
                
                // folder determination
                if ($_GET[$this->folder_par] > 0)
                {
                        $this->current_folder = $_GET[$this->folder_par];
                }
                else if ($_SESSION["mep_pool_folder"] > 0  && $this->tree->isInTree($_SESSION["mep_pool_folder"]))
                {
                        $this->current_folder = $_SESSION["mep_pool_folder"];
                }
                else
                {
                        $this->current_folder = $this->tree->getRootId();
                }
                $_SESSION["mep_pool_folder"] = $this->current_folder;

                $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.mep_list_row.html", "Modules/MediaPool");
                $this->getItems();

                // title
                if ($this->current_folder != $this->tree->getRootId())
                {
                        $node = $this->tree->getNodeData($this->current_folder);
                        $this->setTitle($node["title"], "icon_fold.gif",
                                $node["title"]);
                }
                else
                {
                        $this->setTitle(ilObject::_lookupTitle($this->media_pool->getId()),
                                "icon_mep.gif",
                                ilObject::_lookupTitle($this->media_pool->getId()));
                }
                
                // action commands
                if ($ilAccess->checkAccess("write", "", $this->media_pool->getRefId()) &&
                        $this->getMode() == ilMediaPoolTableGUI::IL_MEP_EDIT)
                {
                        $this->addMultiCommand("copyToClipboard", $lng->txt("cont_copy_to_clipboard"));
                        $this->addMultiCommand("confirmRemove", $lng->txt("remove"));
                        
                        $this->addCommandButton("createFolderForm", $lng->txt("mep_create_folder"));
                        $this->addCommandButton("createMediaObject", $lng->txt("mep_create_mob"));
                }
                
                if ($this->getMode() == ilMediaPoolTableGUI::IL_MEP_SELECT)
                {
                        // maybe this is a little bit to strong coupled with ilpcmediaobjectgui
                        $this->addMultiCommand("create_mob", $lng->txt("insert"));
                        $this->addCommandButton("cancelCreate", $lng->txt("cancel"));
                }
                
                if ($this->getMode() == ilMediaPoolTableGUI::IL_MEP_EDIT)
                {
                        $this->setSelectAllCheckbox("id");
                }
                
                if ($this->current_folder != $this->tree->getRootId())
                {
                        $ilCtrl->setParameter($this->parent_obj, $this->folder_par,
                                $this->tree->getParentId($this->current_folder));
                        $this->addHeaderCommand($ilCtrl->getLinkTarget($this->parent_obj, $this->parent_cmd),
                                $lng->txt("mep_parent_folder"));
                }

        }

Here is the call graph for this function:

Member Function Documentation

ilMediaPoolTableGUI::fillRow (   $a_set )

protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Reimplemented from ilTable2GUI.

Definition at line 178 of file class.ilMediaPoolTableGUI.php.

References $ilCtrl, $lng, ilObjMediaObjectGUI\_getMediaInfoHTML(), ilUtil\getImagePath(), getMode(), IL_MEP_EDIT, and IL_MEP_SELECT.

        {
                global $lng, $ilCtrl, $ilAccess;

                $this->tpl->setCurrentBlock("link");
                
                switch($a_set["type"])
                {
                        case "fold":
                                $this->tpl->setVariable("TXT_TITLE", $a_set["title"]);
                                $ilCtrl->setParameter($this->parent_obj, $this->folder_par, $a_set["obj_id"]);
                                $this->tpl->setVariable("LINK_VIEW",
                                        $ilCtrl->getLinkTarget($this->parent_obj, $this->parent_cmd));
                                $this->tpl->parseCurrentBlock();
                                
                                if ($ilAccess->checkAccess("write", "", $this->media_pool->getRefId()) &&
                                        $this->getMode() == ilMediaPoolTableGUI::IL_MEP_EDIT)
                                {
                                        $this->tpl->setCurrentBlock("edit");
                                        $this->tpl->setVariable("TXT_EDIT", $lng->txt("edit"));
                                        $ilCtrl->setParameterByClass("ilobjfoldergui", $this->folder_par, $a_set["obj_id"]);
                                        $this->tpl->setVariable("EDIT_LINK",
                                                $ilCtrl->getLinkTargetByClass("ilobjfoldergui", "edit"));
                                        $this->tpl->parseCurrentBlock();
                                }
                                
                                $this->tpl->setCurrentBlock("tbl_content");
                                $this->tpl->setVariable("IMG_OBJ", ilUtil::getImagePath("icon_".$a_set["type"].".gif"));
                                $ilCtrl->setParameter($this->parent_obj, $this->folder_par, $this->current_folder);
                                break;

                        case "mob":
                                if ($this->getMode() == ilMediaPoolTableGUI::IL_MEP_SELECT)
                                {
                                        $this->tpl->setVariable("TXT_NO_LINK_TITLE", $a_set["title"]);
                                }
                                else
                                {
                                        $this->tpl->setVariable("TXT_TITLE", $a_set["title"]);
                                        $this->tpl->touchBlock("nf");
                                        $ilCtrl->setParameterByClass("ilobjmediaobjectgui", "obj_id", $a_set["obj_id"]);
                                        $ilCtrl->setParameter($this->parent_obj, "mob_id", $a_set["obj_id"]);
                                        $this->tpl->setVariable("LINK_VIEW",
                                                $ilCtrl->getLinkTarget($this->parent_obj, "showMedia"));
                                }
                                        
                                // edit link
                                if ($ilAccess->checkAccess("write", "", $this->media_pool->getRefId()) &&
                                        $this->getMode() == ilMediaPoolTableGUI::IL_MEP_EDIT)
                                {
                                        $this->tpl->setCurrentBlock("edit");
                                        $this->tpl->setVariable("TXT_EDIT", $lng->txt("edit"));
                                        $this->tpl->setVariable("EDIT_LINK",
                                                $ilCtrl->getLinkTargetByClass("ilobjmediaobjectgui", "edit"));
                                        $this->tpl->parseCurrentBlock();
                                }
                                
                                $this->tpl->setCurrentBlock("link");
                                $this->tpl->setCurrentBlock("tbl_content");
                                
                                // output thumbnail (or mob icon)
                                $mob = new ilObjMediaObject($a_set["obj_id"]);
                                $med = $mob->getMediaItem("Standard");
                                $target = $med->getThumbnailTarget();
                                if ($target != "")
                                {
                                        $this->tpl->setVariable("IMG_OBJ", $target);
                                }
                                else
                                {
                                        $this->tpl->setVariable("IMG_OBJ", ilUtil::getImagePath("icon_".$a_set["type"].".gif"));
                                }
                                
                                // output media info
                                include_once("./Services/MediaObjects/classes/class.ilObjMediaObjectGUI.php");
                                $this->tpl->setVariable("MEDIA_INFO",
                                        ilObjMediaObjectGUI::_getMediaInfoHTML($mob));
                                $ilCtrl->setParameter($this->parent_obj, $this->folder_par, $this->current_folder);
                                break;
                }

                if ($ilAccess->checkAccess("write", "", $this->media_pool->getRefId()) &&
                        ($this->getMode() == ilMediaPoolTableGUI::IL_MEP_EDIT || $a_set["type"] == "mob"))
                {
                        $this->tpl->setCurrentBlock("chbox");
                        $this->tpl->setVariable("CHECKBOX_ID", $a_set["obj_id"]);
                        $this->tpl->parseCurrentBlock();
                        $this->tpl->setCurrentBlock("tbl_content");
                }
        }

Here is the call graph for this function:

ilMediaPoolTableGUI::getItems

(

)

Get items of current folder.

Definition at line 149 of file class.ilMediaPoolTableGUI.php.

References ilTable2GUI\setData().

Referenced by __construct().

        {
                $fobjs = $this->media_pool->getChilds($this->current_folder, "fold");
                $f2objs = array();
                foreach ($fobjs as $obj)
                {
                        $f2objs[$obj["title"].":".$obj["id"]] = $obj;
                }
                ksort($f2objs);
                
                // get current media objects
                $mobjs = $this->media_pool->getChilds($this->current_folder, "mob");
                $m2objs = array();
                foreach ($mobjs as $obj)
                {
                        $m2objs[$obj["title"].":".$obj["id"]] = $obj;
                }
                ksort($m2objs);
                
                // merge everything together
                $objs = array_merge($f2objs, $m2objs);

                $this->setData($objs);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMediaPoolTableGUI::getMode

(

)

Get Mode.

Returns

string Mode

Definition at line 141 of file class.ilMediaPoolTableGUI.php.

Referenced by __construct(), and fillRow().

        {
                return $this->mode;
        }

Here is the caller graph for this function:

ilMediaPoolTableGUI::setMode

(

$a_mode

)

Set Mode.

Parameters

string

$a_mode

Mode

Definition at line 131 of file class.ilMediaPoolTableGUI.php.

Referenced by __construct().

        {
                $this->mode = $a_mode;
        }

Here is the caller graph for this function:

Field Documentation

const ilMediaPoolTableGUI::IL_MEP_EDIT = "edit"

Definition at line 37 of file class.ilMediaPoolTableGUI.php.

Referenced by __construct(), and fillRow().

const ilMediaPoolTableGUI::IL_MEP_SELECT = "select"

Definition at line 36 of file class.ilMediaPoolTableGUI.php.

Referenced by __construct(), fillRow(), and ilPCMediaObjectGUI\insertFromPool().

---

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

• Modules/MediaPool/classes/class.ilMediaPoolTableGUI.php