phpDocumentor CYap
[ Back ] [ class tree: CYap ] [ index: CYap ] [ all elements ]

Class: CYap_TableView

Source Location: /CYap_Table.php

Class CYap_TableView

Property Summary
array   $colSpecial   Momerize the columne where are placed the special link MODIFY, DETAIL, DELETE
integer   $CurrentCol   Last column set by Cell()
boolean   $EchoText   Should the class echoed the HTML code or cache it
array   $formats   Store the output fotmats command
string   $HtmlCode   Text not echoed
array   $Lang   Language text
boolean   $PendingHeader   Do i have any pending table headr?
boolean   $PendingRow   Do i have any pending row?

[ Top ]
Method Summary
CYap_TableView   CYap_TableView()  
void   AddRowCell()   Add a new row that contains only one cell: the new row link
void   BeginTable()   Shows the open table tag, and initialise the module to print the
void   Cell()   Set the cell contents. First cell
void   EndTable()  
void   FlushCode()  
void   HeaderCell()   Set the header cell contents. First cell
void   HeaderClose()   Close the table header (if any). After this function, the class may accept the table contents.
void   HeaderStart()   Start a new table header row
void   LoadFormats()   Load the formats used to display the fields. The formats are loaded from yap's configuration file.
void   NewRow()   Start a new table row and close the prevoius one
void   Out()   Check according to the class set if
void   SpecialCell()  

[ Top ]
Properties
array   $colSpecial [line 81]

Momerize the columne where are placed the special link MODIFY, DETAIL, DELETE


[ Top ]
integer   $CurrentCol [line 51]

Last column set by Cell()

API Tags:
See:  CYap_TableView::Cell()


[ Top ]
boolean   $EchoText [line 66]

Should the class echoed the HTML code or cache it


[ Top ]
array   $formats [line 88]

Store the output fotmats command

API Tags:
Uses:  Cyap::_ManageFormats() - build the array
Uses:  CYap_TableView::LoadFormats() - Set this var


[ Top ]
string   $HtmlCode [line 71]

Text not echoed


[ Top ]
array   $Lang [line 76]

Language text


[ Top ]
boolean   $PendingHeader [line 61]

Do i have any pending table headr?


[ Top ]
boolean   $PendingRow [line 56]

Do i have any pending row?


[ Top ]
Methods
Constructor CYap_TableView  [line 90]

  CYap_TableView CYap_TableView( mixed $Lang  )



[ Top ]
AddRowCell  [line 270]

  void AddRowCell( string $link  )

Add a new row that contains only one cell: the new row link

Parameters:
string   $link:  the link code to write into the cell

API Tags:
Access:  public


[ Top ]
BeginTable  [line 121]

  void BeginTable( )

Shows the open table tag, and initialise the module to print the

the table contents


API Tags:
Access:  public


[ Top ]
Cell  [line 213]

  void Cell( mixed $txt_in, string $FieldName, [integer $offset = -1], [format $fmt = 'NONE'], string $text  )

Set the cell contents. First cell

Fieldname: 'DETAIL', 'MODIFY' and 'DELETE' point the link to this functions

Parameters:
string   $text:  cell's text
string   $FieldName:  Name of the field to be printed
integer   $offset:  nth cell to set. default the next one. The first cell is 0
format   $fmt:  name. It is the index of $formats and it set the format to use to show the cell contents

API Tags:
Access:  public
Uses:  Cyap::_ManageFormats() - build the array


[ Top ]
EndTable  [line 281]

  void EndTable( )



[ Top ]
FlushCode  [line 286]

  void FlushCode( )



[ Top ]
HeaderCell  [line 152]

  void HeaderCell( string $Href, string $Label, [integer $offset = -1]  )

Set the header cell contents. First cell

Parameters:
string   $Href:  Page to call when the user click on the column's header
string   $Label:  Column's label
integer   $offset:  nth cell to set. default the next one. The first cell is 0

API Tags:
Access:  public


[ Top ]
HeaderClose  [line 172]

  void HeaderClose( )

Close the table header (if any). After this function, the class may accept the table contents.


API Tags:
Access:  public


[ Top ]
HeaderStart  [line 133]

  void HeaderStart( )

Start a new table header row

if exists


API Tags:
Access:  public


[ Top ]
LoadFormats  [line 111]

  void LoadFormats( $fmt $fmt  )

Load the formats used to display the fields. The formats are loaded from yap's configuration file.

Parameters:
$fmt   $fmt:  array it contains the formats command. The array is build by CYap::_ManageFormats

API Tags:
Access:  public
See:  Cyap::_ManageFormats()

Information Tags:
Usedby:  CYap_DetailView::$formats - Set this var
Usedby:  CYap_TableView::$formats - Set this var

[ Top ]
NewRow  [line 186]

  void NewRow( )

Start a new table row and close the prevoius one

if exists


API Tags:
Access:  public


[ Top ]
Out  [line 296]

  void Out( string $text  )

Check according to the class set if

echo the HTML code or not

Parameters:
string   $text: 

API Tags:
Access:  private


[ Top ]
SpecialCell  [line 243]

  void SpecialCell( mixed $link, mixed $type, [mixed $offset = -1]  )



[ Top ]

Documentation generated on Sat, 26 Feb 2005 14:10:05 +0100 by phpDocumentor 1.3.0RC3