ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions
ilWikiPagesTableGUI Class Reference
Modules/Wiki

TableGUI class for wiki pages table. More...

+ Inheritance diagram for ilWikiPagesTableGUI:
+ Collaboration diagram for ilWikiPagesTableGUI:

Public Member Functions

 ilWikiPagesTableGUI ($a_parent_obj, $a_parent_cmd="", $a_wiki_id, $a_mode=IL_WIKI_ALL_PAGES, $a_page_id=0)
 getPages ()
 Get pages for list.
- 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)

Protected Member Functions

 fillRow ($a_set)
 Standard Version of Fill Row.

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

Detailed Description

TableGUI class for wiki pages table.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 40 of file class.ilWikiPagesTableGUI.php.

Member Function Documentation

ilWikiPagesTableGUI::fillRow (   $a_set)
protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Reimplemented from ilTable2GUI.

Definition at line 145 of file class.ilWikiPagesTableGUI.php.

References $_GET, $ilCtrl, $img, $lng, $user, ilObject\_exists(), ilObjUser\_getPersonalPicturePath(), ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), ilDatePresentation\formatDate(), ilObjWikiGUI\getGotoLink(), ilTable2GUI\getParentCmd(), IL_CAL_DATETIME, IL_WIKI_NEW_PAGES, and IL_WIKI_POPULAR_PAGES.

{
global $lng, $ilCtrl;
if ($this->pg_list_mode == IL_WIKI_NEW_PAGES)
{
$this->tpl->setVariable("TXT_PAGE_TITLE", $a_set["title"]);
$this->tpl->setVariable("DATE",
ilDatePresentation::formatDate(new ilDateTime($a_set["created"], IL_CAL_DATETIME)));
}
else if ($this->pg_list_mode == IL_WIKI_POPULAR_PAGES)
{
$this->tpl->setVariable("TXT_PAGE_TITLE", $a_set["title"]);
$this->tpl->setVariable("HITS", $a_set["cnt"]);
}
else
{
$this->tpl->setVariable("TXT_PAGE_TITLE", $a_set["title"]);
$this->tpl->setVariable("DATE",
ilDatePresentation::formatDate(new ilDateTime($a_set["date"], IL_CAL_DATETIME)));
}
$this->tpl->setVariable("HREF_PAGE",
ilObjWikiGUI::getGotoLink($_GET["ref_id"], $a_set["title"]));
if (ilObject::_exists($a_set["user"]))
{
// user name
$user = ilObjUser::_lookupName($a_set["user"]);
$login = ilObjUser::_lookupLogin($a_set["user"]);
$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"], "xxsmall");
$this->tpl->setVariable("IMG_USER", $img);
}
}

+ Here is the call graph for this function:

ilWikiPagesTableGUI::getPages ( )

Get pages for list.

Definition at line 104 of file class.ilWikiPagesTableGUI.php.

References ilWikiPage\getAllPages(), ilWikiPage\getLinksToPage(), ilWikiPage\getNewPages(), ilWikiPage\getOrphanedPages(), ilWikiPage\getPopularPages(), IL_WIKI_ALL_PAGES, IL_WIKI_NEW_PAGES, IL_WIKI_ORPHANED_PAGES, IL_WIKI_POPULAR_PAGES, IL_WIKI_WHAT_LINKS_HERE, ilTable2GUI\setData(), ilTable2GUI\setDefaultOrderDirection(), and ilTable2GUI\setDefaultOrderField().

Referenced by ilWikiPagesTableGUI().

{
include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
$pages = array();
$this->setDefaultOrderField("title");
switch ($this->pg_list_mode)
{
case IL_WIKI_WHAT_LINKS_HERE:
$pages = ilWikiPage::getLinksToPage($this->wiki_id, $this->page_id);
break;
case IL_WIKI_ALL_PAGES:
$pages = ilWikiPage::getAllPages($this->wiki_id);
break;
case IL_WIKI_NEW_PAGES:
$this->setDefaultOrderField("created");
$this->setDefaultOrderDirection("desc");
$pages = ilWikiPage::getNewPages($this->wiki_id);
break;
case IL_WIKI_POPULAR_PAGES:
$this->setDefaultOrderField("cnt");
$this->setDefaultOrderDirection("desc");
$pages = ilWikiPage::getPopularPages($this->wiki_id);
break;
case IL_WIKI_ORPHANED_PAGES:
$pages = ilWikiPage::getOrphanedPages($this->wiki_id);
break;
}
$this->setData($pages);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilWikiPagesTableGUI::ilWikiPagesTableGUI (   $a_parent_obj,
  $a_parent_cmd = "",
  $a_wiki_id,
  $a_mode = IL_WIKI_ALL_PAGES,
  $a_page_id = 0 
)

Definition at line 43 of file class.ilWikiPagesTableGUI.php.

References $ilCtrl, $lng, ilTable2GUI\__construct(), ilTable2GUI\addColumn(), getPages(), IL_WIKI_NEW_PAGES, IL_WIKI_ORPHANED_PAGES, IL_WIKI_POPULAR_PAGES, IL_WIKI_WHAT_LINKS_HERE, ilWikiPage\lookupTitle(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setTitle().

{
global $ilCtrl, $lng;
parent::__construct($a_parent_obj, $a_parent_cmd);
$this->pg_list_mode = $a_mode;
$this->wiki_id = $a_wiki_id;
$this->page_id = $a_page_id;
switch($this->pg_list_mode)
{
case IL_WIKI_NEW_PAGES:
$this->addColumn($lng->txt("created"), "", "33%");
$this->addColumn($lng->txt("wiki_page"), "", "33%");
$this->addColumn($lng->txt("wiki_created_by"), "", "34%");
$this->setRowTemplate("tpl.table_row_wiki_new_page.html",
"Modules/Wiki");
break;
case IL_WIKI_POPULAR_PAGES:
$this->addColumn($lng->txt("wiki_page"), "", "50%");
$this->addColumn($lng->txt("wiki_page_hits"), "", "50%");
$this->setRowTemplate("tpl.table_row_wiki_popular_page.html",
"Modules/Wiki");
break;
case IL_WIKI_ORPHANED_PAGES:
$this->addColumn($lng->txt("wiki_page"), "", "100%");
$this->setRowTemplate("tpl.table_row_wiki_orphaned_page.html",
"Modules/Wiki");
break;
default:
$this->addColumn($lng->txt("wiki_page"), "", "33%");
$this->addColumn($lng->txt("wiki_last_changed"), "", "33%");
$this->addColumn($lng->txt("wiki_last_changed_by"), "", "34%");
$this->setRowTemplate("tpl.table_row_wiki_page.html",
"Modules/Wiki");
break;
}
$this->setEnableHeader(true);
$this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
$this->getPages();
switch($this->pg_list_mode)
{
case IL_WIKI_WHAT_LINKS_HERE:
$this->setTitle(sprintf($lng->txt("wiki_what_links_to_page"),
ilWikiPage::lookupTitle($this->page_id)));
break;
default:
$this->setTitle($lng->txt("wiki_".$a_mode."_pages"));
break;
}
}

+ Here is the call graph for this function:

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