claro_datagrid Class Reference

Public Member Functions

 claro_datagrid ($datagrid=null)
 set_grid ($datagrid)
 set_option_list ($option_list)
 set_idLineType ($idLineType)
 set_idLineShift ($idLineShift)
 set_hideColsWithoutTitle ($hideColsWithoutTitle)
 set_orderColBy ($orderCols)
 set_colTitleList ($colTitleList, $hideColsWithoutTitle=false)
 set_colAttributeList ($colAttributeList)
 set_noRowMessage ($htmlNoRowMessage)
 set_caption ($caption)
 set_colHead ($colHeadName)
 showCounterLine ()
 set_colDecoration ($colName, $decorationPattern, $tag)
 render ()

Private Attributes

 $datagrid
 $idLineType = 'numeric'
 $idLineShift = 1
 $colTitleList = null
 $colAttributeList = array()
 $caption = ''
 $counterLine
 $dispCounter = false
 $colHead = null
 $htmlNoRowMessage = null
 $hideColsWithoutTitle = false
 $orderCols = DG_ORDER_COLS_BY_GRID
 $decorationList = array()
 $dispIdCol = true
 $internalKey = 0

Detailed Description

Definition at line 680 of file html.lib.php.


Member Function Documentation

claro_datagrid ( datagrid = null  ) 

Definition at line 699 of file html.lib.php.

render (  ) 

Build attributes for column In W3C <COL> seems be the good usage but browser don't follow the tag So all attribute would be in each td of column.

Definition at line 913 of file html.lib.php.

set_caption ( caption  ) 

set the caption

Parameters:
string $caption array('colName'=>'colTitle')

Definition at line 854 of file html.lib.php.

set_colAttributeList ( colAttributeList  ) 

set the colAttributeList option

Parameters:
array $colAttributeList array('colName'=> array('attribName'=>'attribValue'))

Definition at line 830 of file html.lib.php.

set_colDecoration ( colName,
decorationPattern,
tag 
)

Add a decoration on a column

add, or overide a column by a content build from a template and where tags are replace by data from each lines

$myDataList[]=array('id'=>1,'pid'=>'foo',); $dg = new claro_datagrid($myDataList); $dg->set_colDecoration('edit','edit', array('id','pid')); $dg->set_colDecoration('foo','foo', array('foo'));

The first decoration add a third column called edit. and using id and pid from line to fill id and pid; The second decoration overite the existing column 'foo' by the same content between tags

Parameters:
string $colName
string $decorationPattern
array $tag
Since:
1.9
Returns:
the current list

Definition at line 906 of file html.lib.php.

set_colHead ( colHeadName  ) 

set the caption option

Parameters:
string $caption array('colName'=>'colTitle')

Definition at line 866 of file html.lib.php.

set_colTitleList ( colTitleList,
hideColsWithoutTitle = false 
)

set the colTitleList option

Parameters:
array $colTitleList array('colName'=>'colTitle')

Definition at line 816 of file html.lib.php.

set_grid ( datagrid  ) 

set data grid

Parameters:
array $datagrid

Definition at line 711 of file html.lib.php.

set_hideColsWithoutTitle ( hideColsWithoutTitle  ) 

set the hideColsWithoutTitle option if hideColsWithoutTitle is true, only cols present in the colTitleList are shown in the rendered grid

Parameters:
boolean $hideColsWithoutTitle set if the cols of grid withouth title would be displayed

Definition at line 785 of file html.lib.php.

set_idLineShift ( idLineShift  ) 

set the idLineShift option

Parameters:
integer $idLineShift

Definition at line 773 of file html.lib.php.

set_idLineType ( idLineType  ) 

set the isLineType option

Parameters:
string $line_type 'blank' 'numeric' 'key' 'none' default:'none'

Definition at line 753 of file html.lib.php.

set_noRowMessage ( htmlNoRowMessage  ) 

set the colAttributeList option

Parameters:
array $colAttributeList array('colName'=> array('attribName'=>'attribValue'))

Definition at line 842 of file html.lib.php.

set_option_list ( option_list  ) 

Definition at line 723 of file html.lib.php.

set_orderColBy ( orderCols  ) 

set the hideColsWithoutTitle option if hideColsWithoutTitle is true, only cols present in the colTitleList are shown in the rendered grid

Parameters:
boolean $hideColsWithoutTitle set if the cols of grid withouth title would be displayed

Definition at line 798 of file html.lib.php.

showCounterLine (  ) 

set the counterLine option

Parameters:
integer $counterLine

Definition at line 878 of file html.lib.php.


Field Documentation

$caption = '' [private]

Definition at line 688 of file html.lib.php.

$colAttributeList = array() [private]

Definition at line 687 of file html.lib.php.

$colHead = null [private]

Definition at line 691 of file html.lib.php.

$colTitleList = null [private]

Definition at line 686 of file html.lib.php.

$counterLine [private]

Definition at line 689 of file html.lib.php.

$datagrid [private]

Definition at line 682 of file html.lib.php.

$decorationList = array() [private]

Definition at line 695 of file html.lib.php.

$dispCounter = false [private]

Definition at line 690 of file html.lib.php.

$dispIdCol = true [private]

Definition at line 696 of file html.lib.php.

$hideColsWithoutTitle = false [private]

Definition at line 693 of file html.lib.php.

$htmlNoRowMessage = null [private]

Definition at line 692 of file html.lib.php.

$idLineShift = 1 [private]

Definition at line 685 of file html.lib.php.

$idLineType = 'numeric' [private]

Definition at line 684 of file html.lib.php.

$internalKey = 0 [private]

Definition at line 697 of file html.lib.php.

$orderCols = DG_ORDER_COLS_BY_GRID [private]

Definition at line 694 of file html.lib.php.


The documentation for this class was generated from the following file:
Generated on Tue Jun 8 12:28:38 2010 for Claroline API by  doxygen 1.6.3