sTEFANs Subversion Web Contol (SWC)
Inc
[ class tree: Swc ] [ index: Swc ] [ all elements ]

Procedural File: page.inc.php

Source Location: /swc/inc/page.inc.php

Page Details

This file contains functions that prints HTML tags for several purposes.

This file contains functions that prints HTML tags for several purposes.

Since:  v1.0.0
Filesource:  Source Code for this file
Version:  v1.1.0
License:  GNU Lesser General Public License
Copyright:  Copyright 2006 by sTEFANs
Author:  Stefan Schraml
Includes
include_once ('inc/var.inc.php') [line 37]

Common defines

Common defines

[ Top ]


Functions
CloseFormCell  [line 306]

void CloseFormCell( string $form_action, string $form_method, string $form_target  )

Prints HTML tags to close a form that has been opened via OpenFormCell.

Prints HTML tags to close a form that has been opened via OpenFormCell.

Parameters:
string   $form_action:  Action (URL) for form.
string   $form_method:  Method of form action.
string   $form_target:  Target of form action.

API Tags:
See:  OpenFormCell()

Information Tags:
Since:  v1.0.0

[ Top ]
CloseTable  [line 621]

void CloseTable( )

Prints HTML tags to close a table which was opened with OpenTable.

Prints HTML tags to close a table which was opened with OpenTable.


Information Tags:
Since:  v1.0.0

[ Top ]
CloseTableCell  [line 269]

void CloseTableCell( )

Prints HTML tags to close a table cell which has been opened with OpenTableCell.

Prints HTML tags to close a table cell which has been opened with OpenTableCell. Can be used between OpenTable and CloseTable.


API Tags:
See:  CloseTable()
See:  OpenTable()
See:  OpenTableCell()

Information Tags:
Since:  v1.0.0

[ Top ]
GetSessionUrl  [line 637]

string GetSessionUrl( string $url  )

Attaches the session ID argument to the given URL if sessions are not handled via cookies. ID is only added to relative URLs (without any scheme).

Attaches the session ID argument to the given URL if sessions are not handled via cookies. The session ID is only added to relative URLs (without any scheme).

Parameters:
string   $url:  URL to which the session argument is attached.

API Tags:
Return:  URL containing the session ID argument in a wellformed way or the untouched URL if sessions are handled via cookies.

Information Tags:
Since:  v1.1.0

[ Top ]
NewTableRow  [line 191]

void NewTableRow( )

Prints HTML tags close a HTML table row and open a new one. and CloseTable.

Prints HTML tags close a HTML table row and open a new one. Can be used between OpenTable and CloseTable.


API Tags:
See:  CloseTable()
See:  OpenTable()

Information Tags:
Since:  v1.0.0

[ Top ]
OpenFormCell  [line 288]

void OpenFormCell( string $form_action, [string $cell_style = NULL], [int $colspan = 0], [int $rowspan = 0], [string $valign = NULL], [string $form_method = 'post'], [string $form_target = '_self']  )

Prints HTML tags to open a tabel cell and a form without content.

Prints HTML tags to open a tabel cell and a form without content. A form cell opened this way must be close via CloseFormCell.

Parameters:
string   $form_action:  Action (URL) for form.
string   $form_method:  Method of form action.
string   $form_target:  Target of form action.
string   $cell_style:  CSS style class for cell
int   $colspan:  Cell HTML colspan
int   $rowspan:  Cell HTML rowspan
string   $valign:  HTML vertical cell content alignment

API Tags:
See:  CloseFormCell()

Information Tags:
Since:  v1.0.0

[ Top ]
OpenTable  [line 175]

void OpenTable( [int $border = 0], [int $cellspacing = 0], [int $cellpadding = 0], [string $style = NULL]  )

Prints HTML tags to open a table and opens a row. opened with this statement must be closed via CloseTable.

Prints HTML tags to open a table and opens a row. A table opened with this statement must be closed via CloseTable.

Parameters:
int   $border:  Table border width.
int   $cellspacing:  Table cellspacing.
int   $cellpadding:  Table cellpadding.
string   $style:  CSS class name for table style.

API Tags:
See:  CloseTable()

Information Tags:
Since:  v1.0.0

[ Top ]
OpenTableCell  [line 249]

void OpenTableCell( [string $style = NULL], [int $colspan = 0], [int $rowspan = 0], [string $valign = NULL]  )

Prints HTML tags to open a table cell.

Prints HTML tags to open a table cell. A table cell opened with this function must be closed with CloseTableCell. Can be used between OpenTable and CloseTable.

Parameters:
string   $style:  CSS style class for cell.
int   $colspan:  Cell HTML colspan.
int   $rowspan:  Cell HTML rowspan.
string   $valign:  HTML vertical cell content alignment.

API Tags:
See:  CloseTable()

Information Tags:
Since:  v1.0.0

[ Top ]
PrintEmptyTableCell  [line 231]

void PrintEmptyTableCell( [int $colspan = 0], [int $rowspan = 0]  )

Prints HTML tags for empty table cells.

Prints HTML tags for empty table cells. Can be used between OpenTable and CloseTable.

Parameters:
int   $colspan:  Cell HTML colspan.
int   $rowspan:  Cell HTML rowspan.

API Tags:
See:  CloseTable()
See:  OpenTable()

Information Tags:
Since:  v1.0.0

[ Top ]
PrintFormButton  [line 108]

void PrintFormButton( string $button_text, [array $button_actions = NULL], [boolean $selected = false], [boolean $enabled = true], [boolean $submit_btn = true]  )

Prints HTML tags for a submit button and additional form arguments (hidden fields) without surrounding table cell.

Prints HTML tags for a submit button and additional form arguments (hidden fields) without surrounding table cell. Can be used between OpenFormCell and CloseFormCell.

Parameters:
string   $button_text:  Button text
array   $button_actions:  Array (or array of arrays) containing action name at index 0 and action value at index 1. An array containing array with format above can also be applied. For every name/value pair a hidden field for the form is created.
boolean   $selected:  True if button should be rendered as selected.
boolean   $enabled:  True if button should be rendered as enabled.
boolean   $submit_btn:  True if button should be a submit button of a form. (CSS class button.selected).

API Tags:
See:  CloseFormCell()
See:  OpenFormCell()

Information Tags:
Since:  v1.0.0

[ Top ]
PrintFormTextField  [line 150]

void PrintFormTextField( string $label, string $name, [int $size = 0], [string $text = NULL], [int $max_length = 0], [string $text_field_style = NULL]  )

Prints HTML tags for a text field form element including label but no surrounding cell or form.

Prints HTML tags for a text field form element including label but no surrounding cell or form. Can be used between OpenFormCell and CloseFormCell.

Parameters:
string   $label:  Label for the text field.
string   $name:  Text field form name, index for text field value
int   $size:  Size in characters of the text field.
string   $text:  Initial text of the text field If NULL, text field keeps empty.
int   $max_length:  Maximum numbers of characters that can inputed into the text field.
string   $text_field_style:  CSS style class for the text field.

API Tags:
See:  CloseFormCell()
See:  OpenFormCell()

Information Tags:
Since:  v1.0.0

[ Top ]
PrintPageFooter  [line 669]

void PrintPageFooter( )

Prints HTML footer for the page which has been opened with PrintPageHeader.

Prints HTML footer for the page which has been opened with PrintPageHeader.


API Tags:
See:  PrintPageHeader()

Information Tags:
Since:  v1.0.0

[ Top ]
PrintPageHeader  [line 50]

void PrintPageHeader( [string $title = NULL], [string $style = NULL], [string $on_load_js = NULL]  )

Prints a common header for any HTML page.

Prints a common header for any HTML page. A HTML opened with this function can be closed with PrintPageFooter

Parameters:
string   $title:  Page title
string   $style:  Body style
string   $on_load_js:  Javascript for body onOpen.

API Tags:
See:  PrintPageFooter()

Information Tags:
Since:  v1.0.0

[ Top ]
PrintTableButtonCell  [line 336]

void PrintTableButtonCell( string $button_text, string $form_action, array $button_actions, [string $cell_style = NULL], [boolean $selected = false], [boolean $enabled = true], [string $form_method = 'post'], [string $form_target = '_self']  )

Prints HTML tags for a entire table cell encapsulated within a form to relize a single submit button.

Prints HTML tags for a entire table cell encapsulated within a form to relize a single submit button. Can be used between OpenTable and CloseTable.

Parameters:
string   $button_text:  Button text.
string   $form_action:  Action (URL) for form.
array   $button_actions:  Array (or array of arrays) containing action name at index 0 and action value at index 1. An array containing array with format above can also be applied. For every name/value pair a hidden field for the form is created.
string   $cell_style:  CSS style class for cell.
boolean   $selected:  True if button should be rendered as selected.
boolean   $enabled:  True if button should be rendered as enabled. (CSS class button.selected)
string   $form_method:  Method of form action.
string   $form_target:  Target of form action.

API Tags:
See:  CloseTable()
See:  OpenTable()

Information Tags:
Since:  v1.0.0

[ Top ]
PrintTableButtonSelectionCells  [line 440]

void PrintTableButtonSelectionCells( string $title, string $button_text, string $form_action, array $selections, array $button_actions, string $selection_name, [int $selection_size = 1], [string $cell_style = NULL], [string $selection_style = NULL], [boolean $selected = false], [boolean $enabled = true], [string $form_method = 'post'], [string $form_target = '_self']  )

Prints HTML tags for one entire table cell encapsulated within a form to relize a selection list and a single submit button.

Prints HTML tags for one entire table cell encapsulated within a form to relize a selection list and a single submit button. Can be used between OpenTable and CloseTable.

Parameters:
string   $title:  Title text.
string   $button_text:  Button text.
string   $form_action:  Action (URL) for form.
array   $selections:  Array of arrays containing selection name at index IDX_NAME and selection value at index IDX_VALUE. An array containing array with format above can also be applied.
array   $button_actions:  Array (or array of arrays) containing action name at index 0 and action value at index 1. An array containing array with format above can also be applied. For every name/value pair a hidden field for the form is created.
string   $selection_name:  Name for selection list.
int   $selection_size:  Number of visible list entries.
string   $cell_style:  CSS style class for cell.
string   $selection_style:  CSS style class for selection list.
boolean   $selected:  True if button should be rendered as selected.
boolean   $enabled:  True if button should be rendered as enabled. (CSS class button.selected).
string   $form_method:  Method of form action.
string   $form_target:  Target of form action.

API Tags:
See:  CloseTable()
See:  OpenTable()

Information Tags:
Since:  v1.0.0

[ Top ]
PrintTableCell  [line 211]

void PrintTableCell( string $content, [string $style = NULL], [int $colspan = 0], [int $rowspan = 0], [string $valign = NULL]  )

Prints HTML tags for a entire table cell.

Prints HTML tags for a entire table cell. Can be used between OpenTable and CloseTable.

Parameters:
string   $content:  Cell content.
string   $style:  CSS style class for cell.
int   $colspan:  Cell HTML colspan.
int   $rowspan:  Cell HTML rowspan.
string   $valign:  HTML vertical cell content alignment.

API Tags:
See:  CloseTable()
See:  OpenTable()

Information Tags:
Since:  v1.0.0

[ Top ]
PrintTableCheckboxCells  [line 536]

void PrintTableCheckboxCells( string $label, string $name, string $form_action, [array $hidden_fields = NULL], [string $cell_style = NULL], [string $checkbox_style = NULL], [boolean $checked = false], [string $form_method = 'post'], [string $form_target = '_self'], [ $no_form = false]  )

Prints HTML tags for one table cell encapsulated within a form to relize an immediate executed checkbox.

Prints HTML tags for one table cell encapsulated within a form to relize an immediate executed checkbox. Can be used between OpenTable and CloseTable.

Parameters:
string   $label:  Checkbox label.
string   $name:  Checkbox name, index for checkbox value.
string   $form_action:  Action (URL) for form.
array   $hidden_fields:  Array (or array of arrays) containing action name at index 0 and action value at index 1. An array containing array with format above can also be applied. For every name/value pair a hidden field for the form is created.
string   $cell_style:  CSS style class for cell.
string   $checkbox_style:  CSS style class for selection list.
boolean   $checked:  True if checkbox should initially be selected.
string   $form_method:  Method of form action.
string   $form_target:  Target of form action.
   $no_form: 

API Tags:
See:  CloseTable()
See:  OpenTable()

Information Tags:
Since:  v1.0.0

[ Top ]
PrintTableIFrameCell  [line 489]

void PrintTableIFrameCell( string $src, [string $name = NULL], [int $width = NULL], [int $height = NULL], [int $colspan = 0], [int $rowspan = 0], [boolean $draw_border = false], [string $cell_style = NULL], [string $desc = NULL]  )

Prints HTML tags for one table cell which encapsulates an HTML iFrame.

Prints HTML tags for one table cell which encapsulates an HTML iFrame.

Parameters:
string   $src:  iFrame source URL.
string   $name:  iFrame name.
int   $width:  Width of the frame.
int   $height:  Height of the frame.
int   $colspan:  Cell HTML colspan.
int   $rowspan:  Cell HTML rowspan.
boolean   $draw_border:  True of frame border should be drawn, false otherwise.
string   $cell_style:  CSS style class for cell.
string   $desc:  Description of the frame.

Information Tags:
Since:  v1.0.0

[ Top ]
PrintTableImmediateSelectionCell  [line 377]

void PrintTableImmediateSelectionCell( string $title, string $form_action, strnig $selected_item, array $items, string $selection_name, [int $selection_size = 1], [string $cell_style = NULL], [string $selection_style = NULL], [int $colspan = 0], [int $rowspan = 0], [string $form_method = 'post'], [string $form_target = '_self'], string $button_text, boolean $selected, boolean $enabled  )

Prints HTML tags for two entire table cells encapsulated within a form to relize a selection list and a single submit button.

Prints HTML tags for two entire table cells encapsulated within a form to relize a selection list and a single submit button. Can be used between OpenTable and CloseTable.

Parameters:
string   $title:  Title text.
string   $button_text:  Button text.
string   $form_action:  Action (URL) for form.
strnig   $selected_item:  Value of the selected item If the value corespond to an item value given in $items[IDX_VALUE] this item is preselected in the list.
array   $items:  Array of arrays of items containing selection name at index IDX_NAME and selection value at index IDX_VALUE. An array containing array with format above can also be applied.
string   $selection_name:  Name for selection list.
int   $selection_size:  Number of visible list entries.
string   $cell_style:  CSS style class for cell.
string   $selection_style:  CSS style class for selection list.
boolean   $selected:  True if button should be rendered as selected.
boolean   $enabled:  True if button should be rendered as enabled. (CSS class button.selected)
int   $colspan:  Cell HTML colspan.
int   $rowspan:  Cell HTML rowspan.
string   $form_method:  Method of form action.
string   $form_target:  Target of form action.

API Tags:
See:  CloseTable()
See:  OpenTable()

Information Tags:
Since:  v1.0.0

[ Top ]
PrintTableLinkCell  [line 603]

void PrintTableLinkCell( string $url, string $label, [string $target = '_blank'], [string $cell_style = NULL], [int $colspan = 0], [int $rowspan = 0]  )

Prints HTML tags for one table cell with a hyperlink.

Prints HTML tags for one table cell with a hyperlink. Can be used between OpenTable and CloseTable.

Parameters:
string   $url:  Link url.
string   $label:  Link label.
string   $target:  Link target.
string   $cell_style:  CSS style class for cell.
int   $colspan:  Cell HTML colspan.
int   $rowspan:  Cell HTML rowspan.

API Tags:
See:  CloseTable()
See:  OpenTable()

Information Tags:
Since:  v1.0.0

[ Top ]


Documentation generated on Fri, 03 Nov 2006 18:44:58 +0100 by phpDocumentor 1.3.0RC6
for sTEFANs POWERED BY eBC.bz