List booking objects (for booking type) More...

Inheritance diagram for ilBookingReservationsTableGUI:

Collaboration diagram for ilBookingReservationsTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_ref_id)
	Constructor.
	initFilter ()
	Init filter.
	getCurrentFilter ()
	Get current filter settings.
	getItems (array $filter)
	Gather data and build rows.
Public Member Functions inherited from ilTable2GUI
	determineLimit ()
	Determine the limit.
	getSelectableColumns ()
	Get selectable columns.
	determineSelectedColumns ()
	Determine selected columns.
	isColumnSelected ($a_col)
	Is given column selected?
	getSelectedColumns ()
	Get selected columns.
&	executeCommand ()
	Execute command.
	resetOffset ($a_in_determination=false)
	Reset offset.
	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.
	addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
	Add filter by standard type.
	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.
	isFilterSelected ($a_col)
	Is given filter selected?
	getSelectedFilters ()
	Get selected filters.
	determineSelectedFilters ()
	Determine selected filters.
	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="", $a_tooltip="")
	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
	storeProperty ($type, $value)
	Store table property.
	loadProperty ($type)
	Load table property.
	getCurrentState ()
	get current settings for order, limit, columns and filter
	setContext ($id)
	Set context.
	getContext ()
	Get context.
	setShowRowsSelector ($a_value)
	Toggle rows-per-page selector.
	getShowRowsSelector ()
	Get rows-per-page selector state.
	setShowTemplates ($a_value)
	Toggle templates.
	getShowTemplates ()
	Get template state.
	restoreTemplate ($a_name)
	Restore state from template.
	saveTemplate ($a_name)
	Save current state as template.
	deleteTemplate ($a_name)
	Delete template.
	getLimit ()
	Get limit.
	getOffset ()
	Get offset.
	setExportFormats (array $formats)
	Set available export formats.
	setPrintMode ($a_value=false)
	Toogle print mode.
	getPrintMode ()
	Get print mode.
	getExportMode ()
	Was export activated?
	exportData ($format, $send=false)
	Export and optionally send current table data.
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.
	setOffset ($a_offset)
	set dataset offset public
	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.
	getFilterValue (ilFormPropertyGUI $a_item)
	Get current filter value.
	SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
	Set current filter value.
	fillMetaExcel ($worksheet, &$a_row)
	Add meta information to excel export.
	fillHeaderExcel ($worksheet, &$a_row)
	Excel Version of Fill Row.
	fillRowExcel ($a_worksheet, &$a_row, $a_set)
	Excel Version of Fill Row.
	fillMetaCSV ($a_csv)
	Add meta information to csv export.
	fillHeaderCSV ($a_csv)
	CSV Version of Fill Header.
	fillRowCSV ($a_csv, $a_set)
	CSV Version of Fill Row.

Protected Attributes
	$ref_id
	$filter
	$pool
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
	$context = ""
	$mi_sel_buttons = null
	$disable_filter_hiding = false
	$selected_filter = false
	$top_commands = true
	$selectable_columns = array()
	$selected_column = array()
	$show_templates = false
	$show_rows_selector = false
	$nav_determined = false
	$limit_determined = false
	$filters_determined = false
	$columns_determined = false
	$export_formats
	$export_mode
	$print_mode

Additional Inherited Members
Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1
const	FILTER_SELECT = 2
const	FILTER_DATE = 3
const	FILTER_LANGUAGE = 4
const	FILTER_NUMBER_RANGE = 5
const	FILTER_DATE_RANGE = 6
const	FILTER_DURATION_RANGE = 7
const	EXPORT_EXCEL = 1
const	EXPORT_CSV = 2

Detailed Description

List booking objects (for booking type)

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

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

Constructor & Destructor Documentation

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

Constructor.

Parameters

object	$a_parent_obj
string	$a_parent_cmd
int	$a_ref_id
int	$a_type_id

Reimplemented from ilTable2GUI.

Definition at line 27 of file class.ilBookingReservationsTableGUI.php.

References $ilCtrl, $lng, ilTable2GUI\addColumn(), getCurrentFilter(), getItems(), initFilter(), ilTable2GUI\setDisableFilterHiding(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setTitle().

        {
                global $ilCtrl, $lng, $ilAccess, $lng, $ilObjDataCache;
                $this->pool = $a_parent_obj->object;
                $this->ref_id = $a_ref_id;
                $this->setId("bkrsv");
                parent::__construct($a_parent_obj, $a_parent_cmd);
                $this->setTitle($lng->txt("book_reservations_list"));
                $this->addColumn($this->lng->txt("title"));
                $this->addColumn($this->lng->txt("book_period"));
                $this->addColumn($this->lng->txt("user"));
                $this->addColumn($this->lng->txt("status"));
                $this->addColumn($this->lng->txt("actions"));
                
                $this->setExternalSegmentation(true);
                $this->setEnableHeader(true);
                $this->setFormAction($ilCtrl->getFormAction($a_parent_obj, $a_parent_cmd));
                $this->setRowTemplate("tpl.booking_reservation_row.html", "Modules/BookingManager");
                $this->setResetCommand("resetLogFilter");
                $this->setFilterCommand("applyLogFilter");
                $this->setDisableFilterHiding(true);
                include_once 'Modules/BookingManager/classes/class.ilBookingReservation.php';
                $this->initFilter();
                $this->getItems($this->getCurrentFilter());
        }

Here is the call graph for this function:

Member Function Documentation

ilBookingReservationsTableGUI::fillRow ( $a_set )

protected

Fill table row.

Parameters

array $a_set

Reimplemented from ilTable2GUI.

Definition at line 146 of file class.ilBookingReservationsTableGUI.php.

References $ilCtrl, $lng, ilDatePresentation\formatPeriod(), IL_CAL_UNIX, ilBookingReservation\STATUS_CANCELLED, and ilBookingReservation\STATUS_IN_USE.

        {
                global $lng, $ilAccess, $ilCtrl, $ilUser;
            $this->tpl->setVariable("TXT_TITLE", $a_set["title"]);
            $this->tpl->setVariable("RESERVATION_ID", $a_set["booking_reservation_id"]);
                $date_from = new ilDateTime($a_set['date_from'], IL_CAL_UNIX);
                $date_to = new ilDateTime($a_set['date_to'], IL_CAL_UNIX);
                if(in_array($a_set['status'], array(ilBookingReservation::STATUS_CANCELLED, ilBookingReservation::STATUS_IN_USE)))
                {
                        $this->tpl->setVariable("TXT_STATUS", $lng->txt('book_reservation_status_'.$a_set['status']));
                }
                
                $this->tpl->setVariable("TXT_CURRENT_USER", ilObjUser::_lookupFullName($a_set['user_id']));
                $ilCtrl->setParameter($this->parent_obj, 'user_id', $a_set['user_id']);
                $this->tpl->setVariable("HREF_PROFILE", $ilCtrl->getLinkTarget($this->parent_obj, 'showprofile'));
                $ilCtrl->setParameter($this->parent_obj, 'user_id', '');
                $this->tpl->setVariable("VALUE_DATE", ilDatePresentation::formatPeriod($date_from, $date_to));
                
                if ($date_from->get(IL_CAL_UNIX) > time())
                {
                        include_once("./Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
                        $alist = new ilAdvancedSelectionListGUI();
                        $alist->setId($a_set['booking_reservation_id']);
                        $alist->setListTitle($lng->txt("actions"));
                        $ilCtrl->setParameter($this->parent_obj, 'reservation_id', $a_set['booking_reservation_id']);
                        if($ilAccess->checkAccess('write', '', $this->ref_id))
                        {
                                if($a_set['status'] == ilBookingReservation::STATUS_CANCELLED)
                                {
                                        /*
                                        // can be uncancelled?
                                        if(ilBookingReservation::getAvailableObject(array($a_set['object_id']), $date_from->get(IL_CAL_UNIX), $date_to->get(IL_CAL_UNIX)))
                                        {
                                                $alist->addItem($lng->txt('book_set_not_cancel'), 'not_cancel', $ilCtrl->getLinkTarget($this->parent_obj, 'rsvUncancel'));
                                        }
                                        */
                                }
                                else if($a_set['status'] != ilBookingReservation::STATUS_IN_USE)
                                {
                                        $alist->addItem($lng->txt('book_set_in_use'), 'in_use', $ilCtrl->getLinkTarget($this->parent_obj, 'rsvInUse'));
                                        $alist->addItem($lng->txt('book_set_cancel'), 'cancel', $ilCtrl->getLinkTarget($this->parent_obj, 'rsvCancel'));
                                }
                                else
                                {
                                        $alist->addItem($lng->txt('book_set_not_in_use'), 'not_in_use', $ilCtrl->getLinkTarget($this->parent_obj, 'rsvNotInUse'));
                                }
                        }
                        else if($a_set['user_id'] == $ilUser->getId() && $a_set['status'] != ilBookingReservation::STATUS_CANCELLED)
                        {
                                $alist->addItem($lng->txt('book_set_cancel'), 'cancel', $ilCtrl->getLinkTarget($this->parent_obj, 'rsvCancel'));
                        }
                        $this->tpl->setVariable('LAYER', $alist->getHTML());
                }
        }

Here is the call graph for this function:

ilBookingReservationsTableGUI::getCurrentFilter ( )

Get current filter settings.

Returns: array

Definition at line 100 of file class.ilBookingReservationsTableGUI.php.

References $filter, and IL_CAL_UNIX.

Referenced by __construct().

        {
                $filter = array();
                if($this->filter["type"])
                {
                        $filter["type"] = $this->filter["type"];
                }
                if($this->filter["status"])
                {
                        $filter["status"] = $this->filter["status"];
                }
                if($this->filter["fromto"]["from"] || $this->filter["fromto"]["to"])
                {
                        if($this->filter["fromto"]["from"])
                        {
                                $filter["from"] = $this->filter["fromto"]["from"]->get(IL_CAL_UNIX);
                        }
                        if($this->filter["fromto"]["to"])
                        {
                                $filter["to"] = $this->filter["fromto"]["to"]->get(IL_CAL_UNIX);
                        }
                }
                return $filter;
        }

Here is the caller graph for this function:

ilBookingReservationsTableGUI::getItems ( array $filter )

Gather data and build rows.

Parameters

array $filter

Definition at line 129 of file class.ilBookingReservationsTableGUI.php.

References ilTableGUI\$data, $filter, $lng, ilTable2GUI\determineOffsetAndOrder(), ilBookingObject\getByPoolId(), ilTable2GUI\getLimit(), ilBookingReservation\getList(), ilTable2GUI\getOffset(), ilTable2GUI\setData(), and ilTableGUI\setMaxCount().

Referenced by __construct().

        {
                global $lng;
                $this->determineOffsetAndOrder();
                include_once "Modules/BookingManager/classes/class.ilBookingObject.php";
                $data = ilBookingReservation::getList(ilBookingObject::getByPoolId($this->pool->getId()), $this->getLimit(), $this->getOffset(), $filter);
                
                $this->setMaxCount($data['counter']);
                $this->setData($data['data']);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBookingReservationsTableGUI::initFilter ( )

Init filter.

Reimplemented from ilTable2GUI.

Definition at line 64 of file class.ilBookingReservationsTableGUI.php.

References ilTable2GUI\addFilterItemByMetaType(), ilTable2GUI\FILTER_DATE_RANGE, ilTable2GUI\FILTER_SELECT, ilBookingType\getList(), ilBookingReservation\STATUS_CANCELLED, and ilBookingReservation\STATUS_IN_USE.

Referenced by __construct().

        {
                include_once "Modules/BookingManager/classes/class.ilBookingType.php";
                $options = array(""=>$this->lng->txt('book_all'));
                foreach(ilBookingType::getList($this->pool->getId()) as $item)
                {
                        $options[$item["booking_type_id"]] = $item["title"];
                }
                $item = $this->addFilterItemByMetaType("type", ilTable2GUI::FILTER_SELECT);
                $item->setOptions($options);
                $this->filter["type"] = $item->getValue();
                $options = array(""=>$this->lng->txt('book_all'));
                foreach(array(ilBookingReservation::STATUS_IN_USE, ilBookingReservation::STATUS_CANCELLED, -ilBookingReservation::STATUS_IN_USE, -ilBookingReservation::STATUS_CANCELLED) as $loop)
            {
                        if($loop > 0)
                        {
                                $options[$loop] = $this->lng->txt('book_reservation_status_'.$loop);
                        }
                        else
                        {
                                $options[$loop] = $this->lng->txt('book_not').' '.$this->lng->txt('book_reservation_status_'.-$loop);
                        }
                }
                $item = $this->addFilterItemByMetaType("status", ilTable2GUI::FILTER_SELECT);
                $item->setOptions($options);
                $this->filter["status"] = $item->getValue();
                $item = $this->addFilterItemByMetaType("fromto", ilTable2GUI::FILTER_DATE_RANGE, false, $this->lng->txt('book_fromto'));
                $this->filter["fromto"] = $item->getDate();
        }