DcmmsPage Class Reference

Inheritance diagram for DcmmsPage:

[legend]List of all members.

Public Member Functions
	DcmmsPage ($strPageTitle, $strPathInDcmms= './')
	setPageName ($strPageName)
	toHtml ()
	add ($strHtml)
	addMessage ($strMessage)
	setIconImage ($strImagePath)
	setCvsDate ($strDate)
	getTimestamp ($offYear=0, $offMonth=0, $offDay=0)
Public Attributes
	$logger
	$strTitle = ""
	$strPathInDcmms = ""
	$strBody = ""
	$strIconImage = ""
	$strScript
	$strH1 = ""
	$strCvsDate = "2004-06-11"
	$postgis = null
	$strMessage = ''
	$strPageName = ''

---

Detailed Description

The skeleton of the DCMMS pages.

---

Constructor & Destructor Documentation

DcmmsPage::DcmmsPage (  $  strPageTitle, $  strPathInDcmms = './' )

Create a new DCMMS page. Parameters: $strPageTitle  is the page title. $strPathInDcmms  is the path to the DCMMS base directory ('./' or '../'). Returns: the DcmmsPage object. Adjust include path if necessary. Set the locale

---

Member Function Documentation

DcmmsPage::add (  $  strHtml  )

Add HTML code to the page body Parameters: $strHtml  is the HTML code to be added to the body. Returns: nothing Reimplemented in DcmmsAdminPage.

DcmmsPage::addMessage (  $  strMessage  )

Add an important message to be displayed. The message will be automatically enclosed in a paragraph. Parameters: $strMessage  is the message to be displayed. Returns: Nothing.

DcmmsPage::getTimestamp (  $  offYear = 0, $  offMonth = 0, $  offDay = 0 )

Return a string timestamp that is compatible with the time format used in the database Parameters: $offYear  is a negative integer offset for the year. $offMonth  is a negative integer offset for the month. $offDay  is a negative integer offset for the day. Returns: The timestamp as a string in ISO date format.

DcmmsPage::setCvsDate (  $  strDate  )

Set the CVS date that appears in the footer. Parameters: $strDate  is the date when the page was last modified. Returns: nothing

DcmmsPage::setIconImage (  $  strImagePath  )

Set the icon used in heading 1. Parameters: $strImagePath  is the path to the image. Returns: nothing

DcmmsPage::setPageName (  $  strPageName  )

Set the name of the page that was opened. Parameters: $strPageName  is a string containing the page name. Usually basename(__FILE__) should be used for this. Returns: Nothing.

DcmmsPage::toHtml (   )

Output the page as HTML Returns: the HTML code of the page Redirect to logon.php if not logged on Recreate the request. Display messages. Insert the HTML body Reimplemented in WorkorderPage.

---

Member Data Documentation

DcmmsPage::$logger

The PEAR logger object.

DcmmsPage::$postgis = null

The DcmmsPostGis object to handle database functionality

DcmmsPage::$strBody = ""

The HTML code for the body.

DcmmsPage::$strCvsDate = "2004-06-11"

The date when the page was last modified

DcmmsPage::$strH1 = ""

The heading 1 on the page.

DcmmsPage::$strIconImage = ""

The path to the descriptive icon image.

DcmmsPage::$strMessage = ''

A set of messages to be displayed at the top of the page.

DcmmsPage::$strPageName = ''

The name of the page that was opened. Used in the help link.

DcmmsPage::$strPathInDcmms = ""

The path of the current DCMMS page in the application.

DcmmsPage::$strScript

An optional script section for the header

DcmmsPage::$strTitle = ""

The page title

---

The documentation for this class was generated from the following file:

• dcmmspage.php

---