ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Attributes | Private Attributes
ilAddressbookTableGUI Class Reference
+ Inheritance diagram for ilAddressbookTableGUI:
+ Collaboration diagram for ilAddressbookTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd= '', $is_mailing_allowed=false, $is_chat_active=false)
 Constructor.
 formatCellValue ($key, $value)
 fillRow ($row)
 Fill row.
 initFilter ()
 Init filter.
 setMailingAllowed ($mailing_allowed)
 setChatActive ($chat_active)
 setSmtpMailingAllowed ($smtp_mailing_allowed)
 getFilterQuery ()
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 Constructor.
 setOpenFormTag ($a_val)
 Set open form tag.
 getOpenFormTag ()
 Get open form tag.
 setCloseFormTag ($a_val)
 Set close form tag.
 getCloseFormTag ()
 Get close form tag.
 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, $a_multipart=false)
 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, $a_caption=null)
 Set filter command.
 getFilterCommand ()
 Get filter command.
 setResetCommand ($a_val, $a_caption=null)
 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= '', $a_id="", $a_class=null)
 Add Command button.
 addCommandButtonInstance (ilButton $a_button)
 Add Command button instance.
 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.
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result.
 setRowSelectorLabel ($row_selector_label)
 getRowSelectorLabel ()
 setPreventDoubleSubmission ($a_val)
 Set prevent double submission.
 getPreventDoubleSubmission ()
 Get prevent double submission.
- 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 Attributes

 $lng = null
 $ctrl
- 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 = 5
 $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 = true
 $nav_determined = false
 $limit_determined = false
 $filters_determined = false
 $columns_determined = false
 $open_form_tag = true
 $close_form_tag = true
 $export_formats
 $export_mode
 $print_mode
 $enable_command_for_all
 $restore_filter
 $restore_filter_values
 $sortable_fields = array()
 $prevent_double_submission = true
 $row_selector_label

Private Attributes

 $mailing_allowed = false
 $smtp_mailing_allowed = false
 $cron_upd_adrbook = false
 $chat_active = false
 $filter = array()

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all.
- 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 FILTER_DATETIME_RANGE = 8
const EXPORT_EXCEL = 1
const EXPORT_CSV = 2
const ACTION_ALL_LIMIT = 1000
- 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 Header.
 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.

Detailed Description

Author
Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de
Version
$Id$

Definition at line 16 of file class.ilAddressbookTableGUI.php.

Constructor & Destructor Documentation

ilAddressbookTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd = '',
  $is_mailing_allowed = false,
  $is_chat_active = false 
)

Constructor.

public

Parameters

Definition at line 50 of file class.ilAddressbookTableGUI.php.

References $ilCtrl, $ilSetting, $lng, ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ilTableGUI\enable(), initFilter(), setChatActive(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), setMailingAllowed(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setTitle().

{
global $lng, $ilCtrl, $ilSetting;
$this->lng = $lng;
$this->ctrl = $ilCtrl;
$this->setMailingAllowed($is_mailing_allowed);
$this->setChatActive($is_chat_active);
$this->setId('addr_book');
parent::__construct($a_parent_obj, $a_parent_cmd);
$this->setFormAction($this->ctrl->getFormAction($a_parent_obj, 'setAddressbookFilter'));
$this->setTitle($lng->txt("mail_addr_entries"));
$this->setRowTemplate("tpl.mail_addressbook_row.html", "Services/Contact");
$this->setDefaultOrderField('login');
$this->cron_upd_adrbook = $ilSetting->get('cron_upd_adrbook', 0);
$width = '20%';
if($this->cron_upd_adrbook != 0)
{
$width = '16.6%';
}
$this->addColumn('', 'addr_id', '1px', true);
$this->addColumn($this->lng->txt('login'), 'login', $width);
$this->addColumn($this->lng->txt('firstname'), 'firstname', $width);
$this->addColumn($this->lng->txt('lastname'), 'lastname', $width);
$this->addColumn($this->lng->txt('email'), 'email', $width);
if($ilSetting->get('cron_upd_adrbook', 0) != 0)
{
$this->addColumn($this->lng->txt('auto_update'), 'auto_update', $width);
}
$this->addColumn($this->lng->txt('actions'), 'actions', '20%');
$this->enable('select_all');
$this->setSelectAllCheckbox('addr_id');
$this->addCommandButton('showAddressForm', $this->lng->txt('add'));
if($this->mailing_allowed)
{
$this->addMultiCommand('mailToUsers', $this->lng->txt('send_mail_to'));
}
$this->addMultiCommand('confirmDelete', $this->lng->txt('delete'));
if($this->chat_active)
{
$this->addMultiCommand('inviteToChat', $this->lng->txt('invite_to_chat'));
}
$this->initFilter();
$this->setFilterCommand('setAddressbookFilter');
$this->setResetCommand('resetAddressbookFilter');
}

+ Here is the call graph for this function:

Member Function Documentation

ilAddressbookTableGUI::fillRow (   $row)

Fill row.

public

Parameters

Reimplemented from ilTable2GUI.

Definition at line 144 of file class.ilAddressbookTableGUI.php.

References $_GET, $row, and formatCellValue().

{
foreach ($row as $key => $value)
{
$value = $this->formatCellValue($key, $value);
$this->ctrl->setParameter($this->parent_obj, 'addr_id', $row['addr_id']);
if($key == 'check')
{
$this->tpl->setVariable("VAL_LOGIN_LINKED_LOGIN", $value);
}
if($key == "login" && $value != "")
{
if($this->mailing_allowed)
{
$this->tpl->setVariable("VAL_LOGIN_LINKED_LINK", $this->ctrl->getLinkTarget($this->parent_obj, 'mailToUsers'));
$this->tpl->setVariable("VAL_LOGIN_LINKED_LOGIN", $value);
}
else
{
$this->tpl->setVariable("VAL_LOGIN_UNLINKED", $value);
}
}
if($key == "email")
{
if($_GET["baseClass"] == "ilMailGUI" && $this->smtp_mailing_allowed)
{
$this->tpl->setVariable("VAL_EMAIL_LINKED_LINK", $this->ctrl->getLinkTarget($this->parent_obj, 'mailToUsers'));
$this->tpl->setVariable("VAL_EMAIL_LINKED_EMAIL", $value);
}
else
{
$this->tpl->setVariable("VAL_EMAIL_UNLINKED", $value);
}
}
if($key == 'auto_update' && $this->cron_upd_adrbook != 0)
{
$this->tpl->setVariable("VAL_CRON_AUTO_UPDATE", $value);
}
$this->tpl->setVariable("VAL_".strtoupper($key), $value);
}
$current_selection_list = new ilAdvancedSelectionListGUI();
$current_selection_list->setListTitle($this->lng->txt("actions"));
$current_selection_list->setId("act_" . $row['addr_id']);
$current_selection_list->addItem($this->lng->txt("edit"), '', $this->ctrl->getLinkTarget($this->parent_obj, "showAddressForm"));
if($this->mailing_allowed)
{
$current_selection_list->addItem($this->lng->txt("send_mail_to"), '', $this->ctrl->getLinkTarget($this->parent_obj, "mailToUsers"));
}
$current_selection_list->addItem($this->lng->txt("delete"), '', $this->ctrl->getLinkTarget($this->parent_obj, "confirmDelete"));
if($this->chat_active)
{
$current_selection_list->addItem($this->lng->txt("invite_to_chat"), '', $this->ctrl->getLinkTarget($this->parent_obj, "inviteToChat"));
}
$this->tpl->setVariable("VAL_ACTIONS", $current_selection_list->getHTML());
}

+ Here is the call graph for this function:

ilAddressbookTableGUI::formatCellValue (   $key,
  $value 
)
Parameters
$key
$value
Returns
string

Definition at line 115 of file class.ilAddressbookTableGUI.php.

References ilUtil\formCheckbox().

Referenced by fillRow().

{
switch($key)
{
case 'addr_id':
$value = ilUtil::formCheckbox(0, 'addr_id[]', $value);
break;
case 'auto_update':
if($this->cron_upd_adrbook != 0)
{
$value = $value == 1 ? $this->lng->txt('yes') : $this->lng->txt('no');
}
else
{
$value = '';
}
break;
}
return $value;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilAddressbookTableGUI::getFilterQuery ( )
Returns
mixed

Definition at line 249 of file class.ilAddressbookTableGUI.php.

{
return $this->filter['query'];
}
ilAddressbookTableGUI::initFilter ( )

Init filter.

Overwrite this to initialize all filter input property objects.

Reimplemented from ilTable2GUI.

Definition at line 212 of file class.ilAddressbookTableGUI.php.

References ilTable2GUI\addFilterItem(), and ilTextInputGUI\setDataSource().

Referenced by __construct().

{
include_once 'Services/Form/classes/class.ilTextInputGUI.php';
$ul = new ilTextInputGUI($this->lng->txt('login').'/'.$this->lng->txt('email').'/'.$this->lng->txt('name'), 'query');
$ul->setDataSource($this->ctrl->getLinkTarget($this->getParentObject(), 'lookupAddressbookAsync', '', true));
$ul->setSize(20);
$ul->setSubmitFormOnEnter(true);
$this->addFilterItem($ul);
$ul->readFromSession();
$this->filter['query'] = $ul->getValue();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilAddressbookTableGUI::setChatActive (   $chat_active)
Parameters
$chat_active

Definition at line 233 of file class.ilAddressbookTableGUI.php.

References $chat_active.

Referenced by __construct().

{
$this->chat_active = $chat_active;
}

+ Here is the caller graph for this function:

ilAddressbookTableGUI::setMailingAllowed (   $mailing_allowed)

Definition at line 225 of file class.ilAddressbookTableGUI.php.

References $mailing_allowed.

Referenced by __construct().

{
$this->mailing_allowed = $mailing_allowed;
}

+ Here is the caller graph for this function:

ilAddressbookTableGUI::setSmtpMailingAllowed (   $smtp_mailing_allowed)
Parameters
$smtp_mailing_allowed

Definition at line 241 of file class.ilAddressbookTableGUI.php.

References $smtp_mailing_allowed.

{
$this->smtp_mailing_allowed = $smtp_mailing_allowed;
}

Field Documentation

ilAddressbookTableGUI::$chat_active = false
private

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

Referenced by setChatActive().

ilAddressbookTableGUI::$cron_upd_adrbook = false
private

Definition at line 32 of file class.ilAddressbookTableGUI.php.

ilAddressbookTableGUI::$ctrl
protected

Definition at line 19 of file class.ilAddressbookTableGUI.php.

ilAddressbookTableGUI::$filter = array()
private

Definition at line 41 of file class.ilAddressbookTableGUI.php.

ilAddressbookTableGUI::$lng = null
protected

Definition at line 18 of file class.ilAddressbookTableGUI.php.

Referenced by __construct().

ilAddressbookTableGUI::$mailing_allowed = false
private

Definition at line 24 of file class.ilAddressbookTableGUI.php.

Referenced by setMailingAllowed().

ilAddressbookTableGUI::$smtp_mailing_allowed = false
private

Definition at line 28 of file class.ilAddressbookTableGUI.php.

Referenced by setSmtpMailingAllowed().

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