ilMediaCastTableGUI Class Reference

TableGUI class for table NewsForContext. More...

Inheritance diagram for ilMediaCastTableGUI:

Collaboration diagram for ilMediaCastTableGUI:

Public Member Functions
	ilMediaCastTableGUI ($a_parent_obj, $a_parent_cmd="")
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)
	Standard Version of Fill Row.
Protected Member Functions inherited from ilTable2GUI
	prepareOutput ()
	Anything that must be done before HTML is generated.

Protected Attributes
	$downloadable = false
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

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

Detailed Description

TableGUI class for table NewsForContext.

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

Member Function Documentation

ilMediaCastTableGUI::fillRow (   $a_set )

protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Reimplemented from ilTable2GUI.

Definition at line 62 of file class.ilMediaCastTableGUI.php.

References $_GET, $file, $ilCtrl, $lng, ilObjMediaCast\$purposes, $size, ilObject\_exists(), ilObjMediaObject\_getURL(), ilObjMediaObject\_lookupItemPath(), ilDatePresentation\formatDate(), IL_CAL_DATETIME, and NEWS_PUBLIC.

        {
                global $lng, $ilCtrl, $ilAccess;
                
                include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                
                $news_set = new ilSetting("news");
                $enable_internal_rss = $news_set->get("enable_rss_for_internal");

                // edit link
                $ilCtrl->setParameterByClass("ilobjmediacastgui", "item_id", $a_set["id"]);
                if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
                {
                        $this->tpl->setCurrentBlock("edit");
                        $this->tpl->setVariable("TXT_EDIT", $lng->txt("edit"));
                        $this->tpl->setVariable("CMD_EDIT",
                                $ilCtrl->getLinkTargetByClass("ilobjmediacastgui", "editCastItem"));
                        $this->tpl->setVariable("TXT_DET_PLAYTIME", $lng->txt("mcst_det_playtime"));
                        $this->tpl->setVariable("CMD_DET_PLAYTIME",
                                $ilCtrl->getLinkTargetByClass("ilobjmediacastgui", "determinePlaytime"));
                        $this->tpl->parseCurrentBlock();
                        $this->tpl->setCurrentBlock("edit_checkbox");
                        $this->tpl->setVariable("VAL_ID", $a_set["id"]);
                        $this->tpl->parseCurrentBlock();
                }

                        
                // access
                if ($enable_internal_rss)
                {
                        $this->tpl->setCurrentBlock("access");
                        $this->tpl->setVariable("TXT_ACCESS", $lng->txt("news_news_item_visibility"));
                        if ($a_set["visibility"] == NEWS_PUBLIC)
                        {
                                $this->tpl->setVariable("VAL_ACCESS", $lng->txt("news_visibility_public"));
                        }
                        else
                        {
                                $this->tpl->setVariable("VAL_ACCESS", $lng->txt("news_visibility_users"));
                        }
                        $this->tpl->parseCurrentBlock();
                }
                
                $ilCtrl->setParameterByClass("ilobjmediacastgui", "item_id", "");

                if (ilObject::_exists($a_set["mob_id"]))
                {
                        if ($a_set["update_date"] != "")
                        {
                                $this->tpl->setCurrentBlock("last_update");
                                $this->tpl->setVariable("TXT_LAST_UPDATE",
                                        $lng->txt("last_update"));
                                $this->tpl->setVariable("VAL_LAST_UPDATE",
                                        ilDatePresentation::formatDate(new ilDateTime($a_set["update_date"], IL_CAL_DATETIME)));
                                $this->tpl->parseCurrentBlock();
                        }
                        
                        $mob = new ilObjMediaObject($a_set["mob_id"]);
                        $med = $mob->getMediaItem("Standard");
                        
                        $this->tpl->setVariable("VAL_TITLE",
                                $a_set["title"]);
                        $this->tpl->setVariable("VAL_DESCRIPTION",
                                $a_set["content"]);
                        $this->tpl->setVariable("TXT_FILENAME",
                                $lng->txt("filename"));
                        $this->tpl->setVariable("VAL_FILENAME",
                                $mob->getTitle());
                        $this->tpl->setVariable("TXT_CREATED",
                                $lng->txt("created"));
                        $this->tpl->setVariable("VAL_CREATED",
                                ilDatePresentation::formatDate(new ilDateTime($a_set["creation_date"], IL_CAL_DATETIME)));
                        $this->tpl->setVariable("TXT_DURATION",
                                $lng->txt("mcst_play_time"));
                        $this->tpl->setVariable("VAL_DURATION",
                                $a_set["playtime"]);
                        if ($this->downloadable) {
                                $ilCtrl->setParameterByClass("ilobjmediacastgui", "item_id", $a_set["id"]);
                                // to keep always the order of the purposes
                                // iterate through purposes and display the according mediaitems                                
                                foreach (ilObjMediaCast::$purposes as $purpose) 
                                {
                                $a_mob = $mob->getMediaItem($purpose);
                                if (!is_object($a_mob))
                                    continue;
                                        $ilCtrl->setParameterByClass("ilobjmediacastgui", "purpose", $a_mob->getPurpose());
                                        $file = ilObjMediaObject::_lookupItemPath($a_mob->getMobId(), false, false, $a_mob->getPurpose());
                                        if (is_file($file))
                                        {
                                                $size = filesize($file);
                                                $size = ", ".sprintf("%.1f MB",$size/1024/1024);
                                        }
                                        $format = ($a_mob->getFormat()!= "")?$a_mob->getFormat():"audio/mpeg";                                  
                                        $this->tpl->setCurrentBlock("downloadable");
                                        $this->tpl->setVariable("TXT_DOWNLOAD", $lng->txt("mcst_download_" . strtolower($a_mob->getPurpose())));
                                        $this->tpl->setVariable("CMD_DOWNLOAD", $ilCtrl->getLinkTargetByClass("ilobjmediacastgui", "downloadItem"));
                                        $this->tpl->setVariable("TITLE_DOWNLOAD", "(".$format.$size.")");
                                        $this->tpl->parseCurrentBlock();
                                }
                        }
                                
                        include_once("./Services/MediaObjects/classes/class.ilMediaPlayerGUI.php");
                        $mpl = new ilMediaPlayerGUI();
                        if (is_object($med))
                        {
                            if (strcasecmp("Reference", $med->getLocationType()) == 0)
                                $mpl->setFile($med->getLocation());
                            else
                               $mpl->setFile(ilObjMediaObject::_getURL($mob->getId())."/".$med->getLocation());
                            $mpl->setMimeType ($med->getFormat());
                            $mpl->setDisplayHeight($med->getHeight());
                        }

                        $this->tpl->setVariable("PLAYER", $mpl->getMp3PlayerHtml());

                }
                
        }       

Here is the call graph for this function:

ilMediaCastTableGUI::ilMediaCastTableGUI	(		$a_parent_obj,
			$a_parent_cmd = ""
	)

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

References $ilCtrl, $lng, ilTable2GUI\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFormAction(), and ilTable2GUI\setRowTemplate().

        {
                global $ilCtrl, $lng;
                
                parent::__construct($a_parent_obj, $a_parent_cmd);
                
                // Check whether download-buttons will be displayed
                $mediacast = new ilObjMediaCast($a_parent_obj->id);
                $this->downloadable = $mediacast->getDownloadable();

                $this->addColumn("", "f", "1");
                $this->addColumn($lng->txt("mcst_entry"), "", "33%");
                $this->addColumn("", "", "33%");
                $this->addColumn("", "", "34%");
                $this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
                $this->setRowTemplate("tpl.table_media_cast_row.html",
                        "Modules/MediaCast");
                $this->setDefaultOrderField("creation_date");
                $this->setDefaultOrderDirection("desc");
        }

Here is the call graph for this function:

Field Documentation

ilMediaCastTableGUI::$downloadable = false

protected

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

---

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

• Modules/MediaCast/classes/class.ilMediaCastTableGUI.php