HTML_Table
[ class tree: HTML_Table ] [ index: HTML_Table ] [ all elements ]

Class: GradebookTable

Source Location: /main/gradebook/lib/fe/gradebooktable.class.php

Class Overview

HTML_Common
   |
   --HTML_Table
      |
      --SortableTable
         |
         --GradebookTable

Table to display categories, evaluations and links


Author(s):

  • Bert Stepp� (refactored, optimised)
  • Stijn Konings

Version:

  • Release: @package_version@

Copyright:

  • 2005 The PHP Group

Variables

Methods


Inherited Variables

Inherited Methods

Class: SortableTable

SortableTable::SortableTable()
Create a new SortableTable
SortableTable::display()
Displays the table, complete with navigation buttons to browse through the data-pages.
SortableTable::filter_data()
Transform all data in a table-row, using the filters defined by the function set_column_filter(...) defined elsewhere in this class.
SortableTable::get_additional_url_paramstring()
Get the parameter-string with additional parameters to use in the URLs
SortableTable::get_navigation_html()
Get the HTML-code with the navigational buttons to browse through the data-pages.
SortableTable::get_pager()
Get the Pager object to split the showed data in several pages
SortableTable::get_page_select_form()
Get the HTML-code wich represents a form to select how many items a page should contain.
SortableTable::get_sortable_table_param_string()
Get the parameter-string with the SortableTable-related parameters to use
SortableTable::get_table_data()
Get the data to display. This function calls the function given as 2nd argument in the constructor of a SortableTable. Make sure your function has the same parameters as defined here.
SortableTable::get_table_html()
Get the HTML-code with the data-table.
SortableTable::get_table_title()
Get the table title.
SortableTable::get_total_number_of_items()
Get the total number of items. This function calls the function given as 2nd argument in the constructor of a SortableTable. Make sure your function has the same parameters as defined here.
SortableTable::set_additional_parameters()
Define a list of additional parameters to use in the generated URLs
SortableTable::set_column_filter()
Add a filter to a column. If another filter was allready defined for the given column, it will be overwritten.
SortableTable::set_form_actions()
Define a list of actions which can be performed on the table-date.
SortableTable::set_header()
Set the header-label
SortableTable::set_other_tables()
Set other tables on the same page.

Class: HTML_Table

HTML_Table::HTML_Table()
Class constructor
HTML_Table::addCol()
Adds a table column and returns the column identifier
HTML_Table::addRow()
Adds a table row and returns the row identifier
HTML_Table::altRowAttributes()
Alternates the row attributes starting at $start
HTML_Table::apiVersion()
Returns the API version
HTML_Table::getAutoFill()
Returns the autoFill value
HTML_Table::getAutoGrow()
Returns the autoGrow value
HTML_Table::getBody()
Returns the HTML_Table_Storage object for <tbody>
HTML_Table::getCellAttributes()
Returns the attributes for a given cell
HTML_Table::getCellContents()
Returns the cell contents for an existing cell
HTML_Table::getColCount()
Gets the number of columns in the table
HTML_Table::getFooter()
Returns the HTML_Table_Storage object for <tfoot>
HTML_Table::getHeader()
Returns the HTML_Table_Storage object for <thead>
HTML_Table::getRowAttributes()
Returns the attributes for a given row as contained in the TR tag
HTML_Table::getRowCount()
Returns the number of rows in the table
HTML_Table::setAllAttributes()
Sets the attributes for all cells
HTML_Table::setAutoFill()
Sets the autoFill value
HTML_Table::setAutoGrow()
Sets the autoGrow value
HTML_Table::setCaption()
Sets the table caption
HTML_Table::setCellAttributes()
Sets the cell attributes for an existing cell.
HTML_Table::setCellContents()
Sets the cell contents for an existing cell
HTML_Table::setColAttributes()
Sets the column attributes for an existing column
HTML_Table::setColCount()
Sets the number of columns in the table
HTML_Table::setColGroup()
Sets the table columns group specifications, or removes existing ones.
HTML_Table::setColType()
Sets a columns type 'TH' or 'TD'
HTML_Table::setHeaderContents()
Sets the contents of a header cell
HTML_Table::setRowAttributes()
Sets the row attributes for an existing row
HTML_Table::setRowCount()
Sets the number of rows in the table
HTML_Table::setRowType()
Sets a rows type 'TH' or 'TD'
HTML_Table::toHtml()
Returns the table structure as HTML
HTML_Table::updateAllAttributes()
Updates the attributes for all cells
HTML_Table::updateCellAttributes()
Updates the cell attributes passed but leaves other existing attributes in tact
HTML_Table::updateColAttributes()
Updates the column attributes for an existing column
HTML_Table::updateRowAttributes()
Updates the row attributes for an existing row

Class: HTML_Common

HTML_Common::HTML_Common()
Class constructor
HTML_Common::apiVersion()
Returns the current API version
HTML_Common::display()
Displays the HTML to the screen
HTML_Common::getAttribute()
Returns the value of the given attribute
HTML_Common::getAttributes()
Returns the assoc array (default) or string of attributes
HTML_Common::getComment()
Returns the HTML comment
HTML_Common::getTabOffset()
Returns the tabOffset
HTML_Common::removeAttribute()
Removes an attribute
HTML_Common::setAttributes()
Sets the HTML attributes
HTML_Common::setComment()
Sets the HTML comment to be displayed at the beginning of the HTML string
HTML_Common::setLineEnd()
Sets the line end style to Windows, Mac, Unix or a custom string.
HTML_Common::setTab()
Sets the string used to indent HTML
HTML_Common::setTabOffset()
Sets the tab offset
HTML_Common::toHtml()
Abstract method. Must be extended to return the objects HTML
HTML_Common::updateAttributes()
Updates the passed attributes without changing the other existing attributes
HTML_Common::_getAttrKey()
Returns the array key for the given non-name-value pair attribute
HTML_Common::_getAttrString()
Returns an HTML formatted attribute string
HTML_Common::_getLineEnd()
Returns the lineEnd
HTML_Common::_getTab()
Returns a string containing the unit for indenting HTML
HTML_Common::_getTabs()
Returns a string containing the offset for the whole HTML code
HTML_Common::_parseAttributes()
Returns a valid atrributes array from either a string or array
HTML_Common::_removeAttr()
Removes the given attribute from the given array
HTML_Common::_updateAttrArray()
Updates the attributes in $attr1 with the values in $attr2 without changing the other existing attributes

Class Details

[line 32]
Table to display categories, evaluations and links



Tags:

author:  Bert Stepp� (refactored, optimised)
author:  Stijn Konings
version:  Release: @package_version@
copyright:  2005 The PHP Group


[ Top ]


Class Variables

$currentcat =

[line 35]



Tags:

access:  private

Type:   mixed


[ Top ]

$datagen =

[line 36]



Tags:

access:  private

Type:   mixed


[ Top ]



Class Methods


constructor GradebookTable [line 42]

GradebookTable GradebookTable( $currentcat, [ $cats = array()], [ $evals = array()], [ $links = array()], [ $addparams = null])

Constructor



Parameters:

   $currentcat  
   $cats  
   $evals  
   $links  
   $addparams  

[ Top ]

method build_edit_column [line 241]

void build_edit_column( $item)



Tags:

access:  private


Parameters:

   $item  

[ Top ]

method build_id_column [line 172]

void build_id_column( $item)



Tags:

access:  private


Parameters:

   $item  

[ Top ]

method build_name_link [line 193]

void build_name_link( $item)



Tags:

access:  private


Parameters:

   $item  

[ Top ]

method build_type_column [line 188]

void build_type_column( $item)



Tags:

access:  private


Parameters:

   $item  

[ Top ]

method get_table_data [line 94]

void get_table_data( [ $from = 1])

Function used by SortableTable to generate the data to display



Overrides SortableTable::get_table_data() (Get the data to display. This function calls the function given as 2nd argument in the constructor of a SortableTable. Make sure your function has the same parameters as defined here.)

Parameters:

   $from  

[ Top ]

method get_total_number_of_items [line 85]

void get_total_number_of_items( )

Function used by SortableTable to get total number of items in the table



Overrides SortableTable::get_total_number_of_items() (Get the total number of items. This function calls the function given as 2nd argument in the constructor of a SortableTable. Make sure your function has the same parameters as defined here.)

[ Top ]


Documentation generated on Thu, 12 Jun 2008 13:33:58 -0500 by phpDocumentor 1.4.1