Packageindex Classtrees Elementlist XML Files
a B C c d D E f F G g H I i L l M m N O P q R r s S T t U

a

alreadyLoggedIn Function in class IWARE
Checks if a user is already logged into the application by checking for the presence of a defined PHP session variable. If the variable is defined then the method will return TRUE
authUserControl Function in class IWARE
This method is now deprecated

B

Button Function in class GUI
Returns a HTML submit button for use in forms

C

CloseWidget Function in class GUI
Outputs a closing container table for a program interface
CloseForm Function in class GUI
Outputs a closing HTML form element
CheckBox Function in class GUI
Returns a HTML checkbox element
CloseListBox Function in class GUI
Outputs an closing HTML select box element
Client_GetMETATitle Function in class IWARE
Returns the META title for a given document by its record ID
Client_GetMETAKeywords Function in class IWARE
Returns the META keywords for a given document by its record ID
Client_GetMETADescription Function in class IWARE
Returns the META description for a given document by its record ID
Client_GetSkin Function in class IWARE
Returns the current active skin name for the site
Client_GetNav Function in class IWARE
Returns the current active navigation style for the site
Client_GetContent Function in class IWARE
Outputs the content for a requested document, and also optionally processes variables posted for use with any embedded modules in a given doument
Client_GetHeader Function in class IWARE
Ouputs the site header as HTML / text or as an image dependingon the configured header display mode
Client_GetFooter Function in class IWARE
Outputs the site footer as HTML / text

c

connectDb Function in class IWARE
Connects to the configured MySQL database and stores the connection handle returned to class variable
closeDb Function in class IWARE
Closes an open connection to the MySQL database (if open)
countResult Function in class IWARE
Returns the total number of rows returned from a sql query

d

displayLogInDialog Function in class IWARE
Outputs the user login interface in two states - first time login and failed login
$dbcon Variable in Class IWARE
Variable used to store the active database connection handle

D

Docs_Recurse Function in class IWARE
Works with Docs_Manager () to recursively output the site document structure to the user
Docs_Manager Function in class IWARE
Outputs the documents manager interface
Docs_GetNextDocOrder Function in class IWARE
Returns the next available document navigation ordering value for use when creating a new document in the system
Docs_GetName Function in class IWARE
Returns the link text for a given document by its record ID
Docs_Add Function in class IWARE
Adds a document to the system
Docs_Update Function in class IWARE
Updates changes made to an existing document in the system
Docs_Delete Function in class IWARE
Deletes an existing document from the system
Docs_GetCount Function in class IWARE
Returns a total count of all documents defined within the system
Docs_ListBox Function in class IWARE
Outputs a number of HTML form option elements containing names of documents defined in the system

E

EncryptPassword Function in class IWARE
Returns an encrypted versionof a supplied password string

f

freeResult Function in class IWARE
Frees a existing MySQL result set from memory

F

Footer_Manager Function in class IWARE
Outputs the site footer management interface
Footer_Update Function in class IWARE
Updates changes made to the site footer
File_UploadForm Function in class IWARE
Outputs the file upload interface
File_Upload Function in class IWARE
Uploads a file from the users local hard disk to the webserver and if indicated to do so uses resizeImage () to resixze an image to the specified dimensions after upload
File_Manager Function in class IWARE
Outputs the file management interface
File_Delete Function in class IWARE
Deletes a file from the files/ directory of the installation
File_ListBox Function in class IWARE
Outputs a number of HTML form option elements containg file names from the files/ directory of the installation
File_GetCount Function in class IWARE
Returns a total count of files available to the system located in the files/ directory of the installation

G

GUI Class GUI.
Abstraction class used to generate HTML interfaces
Group_Manager Function in class IWARE
Outputs the group management interface
Group_AddForm Function in class IWARE
Outputs the add new group interface
Group_Add Function in class IWARE
Adds a user group to the system
Group_UpdateForm Function in class IWARE
Outputs the edit user group interface
Group_Update Function in class IWARE
Updates an existing user group in the system
Group_Delete Function in class IWARE
Deletes a user group from the system
Group_GetCount Function in class IWARE
Returns a total count of all user groups defined in the system
Group_GetGroupList Function in class IWARE
Returns an array containing the record ID of all user groups defined in the system
Group_GetGroupName Function in class IWARE
Retuns the name of a user group by its record ID
Group_GetGroupAuth Function in class IWARE
Returns an associative array of permission levels for control panel functions for a given user group
GetFontsArray Function in class IWARE
Returns an array of font names avaialble to the system from the fonts/DEFAULT support file

g

getId Function in class IWARE
Returns the value of an existing PHP session variable

H

Hidden Function in class GUI
Returns a HTML hidden form element
Hyperlink Function in class GUI
Outputs a textual hyperlink
Header_Manager Function in class IWARE
Outputs the site header management interface
Header_Update Function in class IWARE
Updates changes made to the site header
Header_ImageListBox Function in class IWARE
Outputs a number of HTML form option tags containing names of images present in the system from the files/ directory of the installation
Header_FontListBox Function in class IWARE
This method is an alias to LoadFontsListBox ()
Header_FontSizeListBox Function in class IWARE
Outputs a number of HTML form option elements containing font size in points from 1 to 8

I

IWARE Class IWARE.
Core iWare application class
IWARE Function in class IWARE
Class constructor (runs upon intialization of the class). Establishes a datbase connection and selectes the database for use by the application.

i

iWare Professional Package

L

Label Function in class GUI
Returns a text label
ListOption Function in class GUI
Outputs a HTML select box option element
LoadFontsListBox Function in class IWARE
Ouputs a number of HTML form option elements containing names of fonts available to the system from the fonts/DEFAULT support file

l

logon Function in class IWARE
Attempts to authenticate a user by credentials posted from the login interface. If authentication is sucessfull then this method will return FALSE, otherwise it will return TRUE
logoff Function in class IWARE
Log a user out of the application by destroying the existing PHP session variable

M

Message Function in class GUI
Outputs JavaScript used to send an alert message
Mod_Manager Function in class IWARE
Outputs the initial modules management interface to the user, if no modules are present in the mods/ directory of the installation the interface will not be displayed
Mod_ListBox Function in class IWARE
Outputs a number of HTML form option elements containing names of modules avaialable to the system from the mods/ directory of the installation
Mod_GetCount Function in class IWARE
Returns a total count of all modules avalable to the system from the mods/ directory of the installation
Mod_MissingDB Function in class IWARE
This method is now deprecated

m

maybeOpenLogInWindow Function in class IWARE
Determines whether or not to display the login interface based on whether or not a user has logged into the system and established a valid PHP session variable. If a sesion variable has been defined ( the user is logged in ) then the method will simply return. If the session has not yet been defined then the login dialog will be displayed.

N

Navigate Function in class GUI
Outputs JavaScript used to redirect a browser window
Nav_Manager Function in class IWARE
Outputs the navigation manager interface
Nav_Choose Function in class IWARE
Updates the active navigation for the site at a global level
Nav_ListBox Function in class IWARE
Outputs a number of HTML form option elements containing navigation styles available to the system form the navbar/ directory of the installation
Nav_Recurse Function in class IWARE
Works with Nav_Order () to recursively output the site document structure to the user
Nav_Order Function in class IWARE
Outputs the navigation ordering interface
Nav_OrderUpdateRecurse Function in class IWARE
Works with Nav_OrderUpdate () to recursively update the site document structure navigation ordering
Nav_OrderUpdate Function in class IWARE
Updates changes made to the site navigation order
Nav_GetLinkText Function in class IWARE
Returns the link text for a given document by its record ID
Nav_GetNav Function in class IWARE
Returns an array containg the ID of all documents defined in the system for use with navigation
Nav_GetSubNav Function in class IWARE
Returns an array containg the ID of all documents defined in the system beneath a given document by its record ID
Nav_HasSubNav Function in class IWARE
Returns TRUE if a given document has existing documents defined as child documents beneath it, returns FALSE otherwise
Nav_GetCount Function in class IWARE
Retuns a total count of all navigation styles availabkle to the system from the navbar/ directory of the installation

O

OpenWidget Function in class GUI
Outputs an opening container table for a program interface with a titlebar and set width
OpenForm Function in class GUI
Outputs an opening HTML form for POST data
OpenListBox Function in class GUI
Outputs an opening HTML select box element

P

PwdBox Function in class GUI
Returns a HTML password box
PageBody Function in class GUI
Outputs an opening HTML body tag with defined attributes

q

query Function in class IWARE
Issues a MySQL query and returns the returned result from the query where applicable

R

RadioOption Function in class GUI
Returns a HTML radio option element

r

result Function in class IWARE
Returns the data present in a result set for a specific row number and field name
resizeImage Function in class IWARE
Uses GDLib supprt in PHP to resize an uploaded image to specified dimensions. Returns FALSE if the required GDLib support is not enabled for PHP, TRUE otherwise.

s

selectDb Function in class IWARE
Selects the configured MySQL database for use

S

StatDB Function in class IWARE
Returns the current version of the installed MySQL server software
SystemSummary Function in class IWARE
Outputs the system summary interface
Skins_Manager Function in class IWARE
Outputs the choose active skin interface
Skins_Choose Function in class IWARE
Sets the active skin for the site at a global level
Skins_ListBox Function in class IWARE
Outputs a number of HTML form option elements containing names of skins available to the system from the skins/ directory of the installation
Skins_PreviewImage Function in class IWARE
Outputs a thumbnail screenshot of the currently active skin in the system. If a thumbnail is not available for the given skin name then a no screenshot available message will be displayed instead. The thumbnail image for a given skin must be named screenshot.jpg.
Skins_GetCount Function in class IWARE
Returns a total count of all skins available to the system

T

TextBox Function in class GUI
Returns a HTML text box
TextArea Function in class GUI
Returns a HTML text area box

t

tableExists Function in class IWARE
Checks if a given table exists in the configured database. Returns TRUE if the table exists, false otherwise.

U

Users_Manager Function in class IWARE
Outputs the user management interface
Users_AddForm Function in class IWARE
Outputs the add new user interface
Users_Add Function in class IWARE
Adds a user account to the system
Users_UpdateForm Function in class IWARE
Outputs the edit user account interface
Users_Update Function in class IWARE
Updates an existing user account in the system
Users_Delete Function in class IWARE
Deletes a user account from the system
Users_GetCount Function in class IWARE
Returns a total count of all user accounts defined in the system
Users_GetUserName Function in class IWARE
Returns the name of a user account by the user accounts record ID
Users_GetUserGroup Function in class IWARE
Returns the ID of a user group of which a user account belongs by the user accounts record ID
Packageindex Classtrees Elementlist XML Files
PHPDoc 1.0beta