ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions
ilWikiContributorsTableGUI Class Reference
Modules/Wiki

TableGUI class for listing users that contributed to the wiki. More...

+ Inheritance diagram for ilWikiContributorsTableGUI:
+ Collaboration diagram for ilWikiContributorsTableGUI:

Public Member Functions

 ilWikiContributorsTableGUI ($a_parent_obj, $a_parent_cmd="", $a_wiki_id)
 getContributors ()
 Get contributors of wiki.
- 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.

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

Detailed Description

TableGUI class for listing users that contributed to the 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.ilWikiContributorsTableGUI.php.

Member Function Documentation

ilWikiContributorsTableGUI::fillRow (   $a_set)
protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Reimplemented from ilTable2GUI.

Definition at line 77 of file class.ilWikiContributorsTableGUI.php.

References $ilCtrl, $img, $lng, $login, ilTableGUI\$title, $user, ilObject\_exists(), ilObjUser\_getPersonalPicturePath(), ilLPMarks\_lookupComment(), ilLPMarks\_lookupMark(), ilWikiContributor\_lookupStatus(), ilWikiContributor\_lookupStatusTime(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), IL_CAL_DATETIME, ilWikiPage\lookupTitle(), ilUtil\prepareFormOutput(), ilWikiContributor\STATUS_FAILED, ilWikiContributor\STATUS_NOT_GRADED, and ilWikiContributor\STATUS_PASSED.

{
global $lng, $ilCtrl, $lng;
include_once("./Services/Tracking/classes/class.ilLPMarks.php");
include_once("./Modules/Wiki/classes/class.ilWikiContributor.php");
if (ilObject::_exists($a_set["user_id"]))
{
arsort($a_set["pages"]);
// pages
foreach ($a_set["pages"] as $page_id => $cnt)
{
if ($page_id > 0)
{
include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
$title = ilWikiPage::lookupTitle($page_id);
$this->tpl->setCurrentBlock("page");
$this->tpl->setVariable("PAGE", $title);
$this->tpl->setVariable("CNT", $cnt);
$this->tpl->parseCurrentBlock();
}
}
$this->tpl->setVariable("TXT_LINKED_USER",
$user["lastname"].", ".$user["firstname"]." [".$login."]");
// profile link
//$ilCtrl->setParameterByClass("ilpublicuserprofilegui", "user", $a_set["user"]);
//$ilCtrl->setParameterByClass("ilpublicuserprofilegui", "back_url",
// rawurlencode($ilCtrl->getLinkTarget($this->getParentObject(), $this->getParentCmd())));
//$this->tpl->setVariable("USER_LINK",
// $ilCtrl->getLinkTargetByClass("ilpublicuserprofilegui", "getHTML"));
$img = ilObjUser::_getPersonalPicturePath($a_set["user_id"], "xsmall");
$this->tpl->setVariable("IMG_USER", $img);
$this->tpl->setVariable("TXT_NAME",
$a_set["lastname"].", ".$a_set["firstname"]);
$this->tpl->setVariable("USER_ID", $a_set["user_id"]);
// comment for learner
$this->tpl->setVariable("TXT_LCOMMENT", $lng->txt("wiki_comment_for_learner"));
$this->tpl->setVariable("NAME_LCOMMENT",
"lcomment[".$a_set["user_id"]."]");
$lpcomment = ilLPMarks::_lookupComment($a_set["user_id"],
$this->parent_obj->object->getId());
$this->tpl->setVariable("VAL_LCOMMENT",
ilUtil::prepareFormOutput($lpcomment));
// status
//$status = ilExerciseMembers::_lookupStatus($this->object->getId(), $member_id);
$status = ilWikiContributor::_lookupStatus($this->parent_obj->object->getId(), $a_set["user_id"]);
$this->tpl->setVariable("SEL_".$status, ' selected="selected" ');
$this->tpl->setVariable("TXT_NOTGRADED", $lng->txt("wiki_notgraded"));
$this->tpl->setVariable("TXT_PASSED", $lng->txt("wiki_passed"));
$this->tpl->setVariable("TXT_FAILED", $lng->txt("wiki_failed"));
$this->tpl->setVariable("VAL_NOTGRADED", ilWikiContributor::STATUS_NOT_GRADED);
$this->tpl->setVariable("VAL_PASSED", ilWikiContributor::STATUS_PASSED);
$this->tpl->setVariable("VAL_FAILED", ilWikiContributor::STATUS_FAILED);
if (($sd = ilWikiContributor::_lookupStatusTime($this->parent_obj->object->getId(), $a_set["user_id"])) > 0)
{
$this->tpl->setCurrentBlock("status_date");
$this->tpl->setVariable("TXT_LAST_CHANGE", $lng->txt("last_change"));
$this->tpl->setVariable("VAL_STATUS_DATE",
ilDatePresentation::formatDate(new ilDateTime($sd,IL_CAL_DATETIME)));
$this->tpl->parseCurrentBlock();
}
switch($status)
{
case ilWikiContributor::STATUS_PASSED: $pic = "scorm/passed.gif"; break;
case ilWikiContributor::STATUS_FAILED: $pic = "scorm/failed.gif"; break;
default: $pic = "scorm/not_attempted.gif"; break;
}
$this->tpl->setVariable("IMG_STATUS", ilUtil::getImagePath($pic));
$this->tpl->setVariable("ALT_STATUS", $lng->txt("wiki_".$status));
// mark
$this->tpl->setVariable("TXT_MARK", $lng->txt("wiki_mark"));
$this->tpl->setVariable("NAME_MARK",
"mark[".$a_set["user_id"]."]");
$mark = ilLPMarks::_lookupMark($a_set["user_id"], $this->parent_obj->object->getId());
$this->tpl->setVariable("VAL_MARK",
ilUtil::prepareFormOutput($mark));
}
}

+ Here is the call graph for this function:

ilWikiContributorsTableGUI::getContributors ( )

Get contributors of wiki.

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

References ilWikiPage\getParentObjectContributors(), ilTable2GUI\setData(), ilTable2GUI\setDefaultOrderDirection(), and ilTable2GUI\setDefaultOrderField().

Referenced by ilWikiContributorsTableGUI().

{
include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
$contributors = ilWikiPage::getParentObjectContributors($this->wiki_id);
$this->setDefaultOrderField("lastname");
$this->setDefaultOrderDirection("asc");
$this->setData($contributors);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilWikiContributorsTableGUI::ilWikiContributorsTableGUI (   $a_parent_obj,
  $a_parent_cmd = "",
  $a_wiki_id 
)

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

References $ilCtrl, $lng, ilTable2GUI\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), getContributors(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setTitle().

{
global $ilCtrl, $lng;
parent::__construct($a_parent_obj, $a_parent_cmd);
$this->wiki_id = $a_wiki_id;
$this->addColumn("", "", "1");
$this->addColumn("", "", "1");
$this->addColumn($lng->txt("wiki_contributor"), "", "33%");
$this->addColumn($lng->txt("wiki_page_changes"), "", "33%");
$this->addColumn($lng->txt("wiki_grading"), "", "33%");
$this->setEnableHeader(true);
$this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
$this->setRowTemplate("tpl.table_row_contributors.html",
"Modules/Wiki");
$this->getContributors();
$this->setFormAction($ilCtrl->getFormAction($this->getParentObject(), "saveGrading"));
$this->addMultiCommand("saveGrading", $lng->txt("save"));
$this->setTitle($lng->txt("wiki_contributors"));
}

+ Here is the call graph for this function:

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