Menu
▾
▴
[Openposs-cvs-commits] CVS: Server/theme/Default theme.php,1.1,1.2
|
From: <ope...@li...> - 2002-06-25 05:45:46
|
Update of /cvsroot/openposs/Server/theme/Default
In directory usw-pr-cvs1:/tmp/cvs-serv32455
Modified Files:
theme.php
Log Message:
Added documentation
Index: theme.php
===================================================================
RCS file: /cvsroot/openposs/Server/theme/Default/theme.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** theme.php 25 Jun 2002 03:18:00 -0000 1.1
--- theme.php 25 Jun 2002 05:45:43 -0000 1.2
***************
*** 1,4 ****
--- 1,16 ----
<?
+ /******************************************************************************
+ * Function: Theme_Open_Page() *
+ * -------------------------------------------------------------------------- *
+ * This function is used to generate the HTML code for the start of a webpage *
+ * and should be called before any of the functions below. *
+ * *
+ * Returned Values *
+ * HTML code snippet. *
+ * *
+ * Input Values *
+ * $Title: This is a string of text to be used in the page title. *
+ ******************************************************************************/
function Theme_Open_Page($Title) {
$Output = "<HTML><HEAD><TITLE>"._OPENPOSTITLE." :: $Title</TITLE>";
***************
*** 7,10 ****
--- 19,35 ----
}
+ /******************************************************************************
+ * Function: Theme_Close_Page() *
+ * -------------------------------------------------------------------------- *
+ * This function is used to generate the HTML code to finish off the webpage *
+ * and should be called after all other function calls within this module *
+ * have been completed. *
+ * *
+ * Returned Values *
+ * HTML code snippet. *
+ * *
+ * Input Values *
+ * None. *
+ ******************************************************************************/
function Theme_Close_Page() {
$Output = "</BODY></HTML>";
***************
*** 12,15 ****
--- 37,53 ----
}
+ /******************************************************************************
+ * Function: Theme_Open_Table() *
+ * -------------------------------------------------------------------------- *
+ * This function is used to generate the <TABLE> HTML tags for the beginning *
+ * of a HTML table. *
+ * *
+ * Returned Values *
+ * HTML code snippet. *
+ * *
+ * Input Values *
+ * $Width: (OPTIONAL) the value of the table width which can be either a *
+ * fixed number of pixels, or a percentage. *
+ ******************************************************************************/
function Theme_Open_Table($Width = "") {
$Output = "<TABLE BORDER=\"0\" CELLPADDING=\"2\" CELLSPACING=\"2\"";
***************
*** 21,24 ****
--- 59,73 ----
}
+ /******************************************************************************
+ * Function: Theme_Close_Table() *
+ * -------------------------------------------------------------------------- *
+ * This function is used to generate the closing tag for a HTML table. *
+ * *
+ * Returned Values *
+ * HTML code snippet. *
+ * *
+ * Input Values *
+ * None. *
+ ******************************************************************************/
function Theme_Close_Table() {
$Output = "</TABLE>";
***************
*** 26,29 ****
--- 75,90 ----
}
+ /******************************************************************************
+ * Function: Theme_Open_Row() *
+ * -------------------------------------------------------------------------- *
+ * This function is used to generate the HTML snippet for starting a row in a *
+ * HTML webpage table. *
+ * *
+ * Returned Values *
+ * HTML code snippet. *
+ * *
+ * Input Values *
+ * None. *
+ ******************************************************************************/
function Theme_Open_Row() {
$Output = "<TR>";
***************
*** 31,34 ****
--- 92,107 ----
}
+ /******************************************************************************
+ * Function: Theme_Close_Row() *
+ * -------------------------------------------------------------------------- *
+ * This function is used to generate the HTML snippet for finishing a row in *
+ * a HTML webpage table. *
+ * *
+ * Returned Values *
+ * HTML code snippet. *
+ * *
+ * Input Values *
+ * None. *
+ ******************************************************************************/
function Theme_Close_Row() {
$Output = "</TR>";
***************
*** 36,39 ****
--- 109,124 ----
}
+ /******************************************************************************
+ * Function: Theme_Open_Header_Cell() *
+ * -------------------------------------------------------------------------- *
+ * This function is used to generate the HTML snippet used to create a header *
+ * cell in a HTML table. *
+ * *
+ * Returned Values *
+ * HTML code snippet. *
+ * *
+ * Input Values *
+ * $Align: (OPTIONAL) alignment of the contents of the cell. *
+ ******************************************************************************/
function Theme_Open_Header_Cell($Align = "LEFT") {
$Output = "<TH ALIGN=\"$Align\">";
***************
*** 41,44 ****
--- 126,141 ----
}
+ /******************************************************************************
+ * Function: Theme_Close_Header_Cell() *
+ * -------------------------------------------------------------------------- *
+ * This function is used to generate the HTML snippet used to end a header *
+ * cell in a HTML table. *
+ * *
+ * Returned Values *
+ * HTML code snippet. *
+ * *
+ * Input Values *
+ * None. *
+ ******************************************************************************/
function Theme_Close_Header_Cell() {
$Output = "</TH>";
***************
*** 46,49 ****
--- 143,159 ----
}
+ /******************************************************************************
+ * Function: Theme_Open_Data_Cell() *
+ * -------------------------------------------------------------------------- *
+ * This function is used to generate a HTML snippet to create a normal data *
+ * cell within a HTML table. *
+ * *
+ * Returned Values *
+ * HTML code snippet. *
+ * *
+ * Input Values *
+ * $Align: (OPTIONAL) alignment of the contents of the cell. *
+ * $Width: (OPTIONAL) width of the cell relative to the width of the table. *
+ ******************************************************************************/
function Theme_Open_Data_Cell($Align = "LEFT", $Width = "") {
$Output = "<TD ALIGN=\"$Align\"";
***************
*** 55,58 ****
--- 165,180 ----
}
+ /******************************************************************************
+ * Function: Theme_Close_Data_Cell() *
+ * -------------------------------------------------------------------------- *
+ * This function is used to generate a HTML snippet to close off a normal *
+ * data cell within a HTML table. *
+ * *
+ * Returned Values *
+ * HTML code snippet. *
+ * *
+ * Input Values *
+ * None. *
+ ******************************************************************************/
function Theme_Close_Data_Cell() {
$Output = "</TD>";
***************
*** 60,63 ****
--- 182,197 ----
}
+ /******************************************************************************
+ * Function: ReadConfigFromDatabase() *
+ * -------------------------------------------------------------------------- *
+ * This function is used to create a HTML link snippet. *
+ * *
+ * Returned Values *
+ * HTML code snippet. *
+ * *
+ * Input Values *
+ * $URI: URI of the location the link points to. *
+ * $Label: The text of the link. *
+ ******************************************************************************/
function Theme_Add_Link($URI, $Label) {
$Output = "<A HREF=\"$URI\">$Label</A>";
***************
*** 65,68 ****
--- 199,214 ----
}
+ /******************************************************************************
+ * Function: Theme_Login_Screen() *
+ * -------------------------------------------------------------------------- *
+ * This function is used to produce a HTML web page that is used as the login *
+ * page for the openPOS System. *
+ * *
+ * Returned Values *
+ * HTML Webpage. *
+ * *
+ * Input Values *
+ * None. *
+ ******************************************************************************/
function Theme_Login_Screen() {
$Output = Theme_Open_Page(_OPENPOSLOGINTITLE)."<DIV ALIGN=\"CENTER\">";
|
