[core] element index

Package indexes

All elements
$ a b c d e f g h i k l m n o p r s t u v w x
$
top
Constant $defname
$defname in response-defs.php
a
top
Variable $accept
response::$accept in response-defs.php
The browser accept string, as submitted by user-agent
Variable $accept_encoding
response::$accept_encoding in response-defs.php
The browser accept-encoding string
Variable $accept_language
response::$accept_language in response-defs.php
The browser accept-language string
Variable $active
globals::$active in globals-defs.php
Whether the globals registration is active
Variable $agent
setting::$agent in application-defs.php
Agent which will action this setting
Variable $attr
application::$attr in application-defs.php
Attributes array for current/last tag
Variable $attributes
tag::$attributes in renderable.php
Variable $auth_code
user::$auth_code in user-defs.php
Optional authorisation hash code
Variable $auth_fail_option
response::$auth_fail_option in response-defs.php
Option to take on auth failure
Variable $auth_fail_redirect
response::$auth_fail_redirect in response-defs.php
URL to redirect to on auth failure
Variable $auth_type
response::$auth_type in response-defs.php
Type of authentication in effect
Method add
page_section::add() in plugin-defs.php
Add new content to the page section.
Method add
webpage::add() in webpage-defs.php
Add to the body content
Method addparameter
setting::addparameter() in application-defs.php
Add the given parameter to this setting.
Method addto
pluginset::addto() in plugin-defs.php
Adds content to the given plugin. If the plugin doesn't exist yet, then we create it first. If it already exists, then we append the new content to it.
Method add_attribute
tag::add_attribute() in renderable.php
Adds an attribute to this tag.
Method add_content
plugin::add_content() in plugin-defs.php
Allows adding of any type of content to the plugin. This could be
Method add_content
webstream::add_content() in webpage-defs.php
Add new content to the webstream..
Method add_database
response::add_database() in response-defs.php
Add database Add a new database to the list of datasources which are going to be used to serve this response. The dbtype and the name are the only mandatory parameters.
Method add_language
response::add_language() in response-defs.php
Adds another language for the current webpage. Webpages might contain content in multiple languages, hence the need for a list.
Method add_language
head::add_language() in webpage-defs.php
Adds another language for the current head. Webpages might contain content in multiple languages, hence the need for a list.
Method add_named_script
This adds a specific lump of script to the webpage under a unique name.
Method add_named_script
webpage::add_named_script() in webpage-defs.php
Add named script This adds a specific lump of script to the body under a unique name.
Method add_plugin
pluginset::add_plugin() in plugin-defs.php
Add a new plugin to the plugin set. The type of plugin is determined from the content passed as the second paramter. Allowed data-types for content: object (must inherit RenderableObject), a function definition, a file-path, or just literal content.
Method add_popup_script
Add popup window scripting.
Method add_script
page_section::add_script() in plugin-defs.php
Add more scripting to this page section.
Method add_script
webpage::add_script() in webpage-defs.php
Add named script to the body
Method add_scriptsrc
webpage::add_scriptsrc() in webpage-defs.php
Add script URL to the body
Method add_scriptsrc
Add script reference link Add more scripting to this section in the form of a link to a script source file.
Method add_style
head::add_style() in webpage-defs.php
Add the given content to the current style. Appends style statements to the style string, which is rendered when the page gets rendered.
Method allowed_groups
response::allowed_groups() in response-defs.php
Allowed groups This defines the allowed user-groups for this response, otherwise they get an error page returned. The list of allowed groups should be a comma-delimited string.
Constant ALL_MIMES
ALL_MIMES in mime-types.php
Page antihack.php
antihack.php in antihack.php
Method anypermitted
This is a variant permitted query method, which takes a comma-delimited list of agent IDs, and returns true if ANY one or more of these has the required permissions. This facilitates passing of a group membership list for a given user, for example.
Method application
application::application() in application-defs.php
Construct a new application. Creating the application will also attempt to read in the XML configuration file as specified (or defaulted). If the file is read successfully, then the valid flag is set true.
Class application
application in application-defs.php
Class comprising the functionality of an application. This is used to contain and manage the basic configuration properties of an application. This class knows how to read the configuration in, store the values, and write it out again.
Page application-defs.php
application-defs.php in application-defs.php
Method assign_DTD
webpage::assign_DTD() in webpage-defs.php
Assign the DTD for the resident head page section. We have two ways to do this: directly via passed parameter $DTD, or indirectly by using the content (browser) type, and looking up the DTD from the array of DTD specifiers created in the response object.
Constant AUDIO_MIMES
AUDIO_MIMES in mime-types.php
Method authenticate
user::authenticate() in user-defs.php
Authenticate a user Tries all types of authentication we know about using the parameters passed to it.
Method authenticate_authid
Authenticate a user by authorisation ID
Method authenticate_ipaddress
Authenticate a user by IP address
Method authenticate_userid
Authenticate a user by userid/password.
Constant AUTHFAIL_DIE_MSG
AUTHFAIL_DIE_MSG in response-defs.php
Failed authentication: Die, with 'not authorised' message.
Constant AUTHFAIL_DIE_SILENT
AUTHFAIL_DIE_SILENT in response-defs.php
Failed authentication: Die silently.
Constant AUTHFAIL_GUEST
AUTHFAIL_GUEST in response-defs.php
Failed authentication: Welcome the user as a guest instead.
Constant AUTHFAIL_REDIRECT
AUTHFAIL_REDIRECT in response-defs.php
Failed authentication: Re-direct to specified URL.
Method authorised_user
Constructor Create a new authorised user object.
Class authorised_user
authorised_user in user-defs.php
The Authorised User class This derived class just allows us a different way of defining a new user, when we know their authorisation code.
b
top
Variable $body
webpage::$body in webpage-defs.php
Webpage body object
Variable $browser
response::$browser in response-defs.php
The make of browser
Variable $browser_type
response::$browser_type in response-defs.php
The type of browser requesting this response
Variable $browser_version
response::$browser_version in response-defs.php
The version of browser requesting this response
Variable $buffered
webstream::$buffered in webpage-defs.php
Whether to use Php buffering
Variable $buffering_mode
response::$buffering_mode in response-defs.php
Buffering option to use
Method body
body::body() in webpage-defs.php
Constructor Create a new body object.
Class body
body in webpage-defs.php
The body class The class is a special kind of page section. It contains all of the main page content.
Constant BROWSER_IE
BROWSER_IE in response-defs.php
Microsoft internet Explorer
Constant BROWSER_MOZILLA
BROWSER_MOZILLA in response-defs.php
Netscape, Mozilla
Constant BROWSER_NETSCAPE
BROWSER_NETSCAPE in response-defs.php
Netscape only, this is Mozilla <5.0
Constant BROWSER_NONE
BROWSER_NONE in response-defs.php
Browser detection: No browser; command line interface
Constant BROWSER_OPERA
BROWSER_OPERA in response-defs.php
Opera
Constant BROWSER_OTHER
BROWSER_OTHER in response-defs.php
Browser detection: Other browsers
Constant BROWSER_PHONE
BROWSER_PHONE in response-defs.php
Browser detection: Any WAP phone browser
Constant BROWSER_TYPE_CLI
BROWSER_TYPE_CLI in renderable.php
Not really a browser, a command-line script..
Constant BROWSER_TYPE_DEFAULT
BROWSER_TYPE_DEFAULT in renderable.php
Default browser type, in absence of true knowledge..
Constant BROWSER_TYPE_HTML
BROWSER_TYPE_HTML in renderable.php
Standard HTML web browser
Constant BROWSER_TYPE_UNKNOWN
BROWSER_TYPE_UNKNOWN in renderable.php
Undefined/unknown browser type
Constant BROWSER_TYPE_WML
BROWSER_TYPE_WML in renderable.php
Standard WAP phone
Constant BROWSER_TYPE_WMLUP
BROWSER_TYPE_WMLUP in renderable.php
WAP phone with Phone.com extensions
Constant BROWSER_TYPE_XHTML
BROWSER_TYPE_XHTML in renderable.php
XHTML (HTML 5.0) capable web browser, phone, or PDA
Constant BROWSER_TYPE_XML
BROWSER_TYPE_XML in renderable.php
XML-only-capable browser, an unlikely beast
Constant BUFFERED
BUFFERED in webpage-defs.php
The webpage is buffered using Php buffering
Constant BUILTIN_COMPRESSION
BUILTIN_COMPRESSION in response-defs.php
Webpage compression: Use the builtin Php compression system. Requires Php >= v4.04
c
top
Variable $cachecontrol
response::$cachecontrol in response-defs.php
Cache control directive, usually passed on URL
Variable $cached
webstream::$cached in webpage-defs.php
Page is cached or dynamic
Variable $cache_expiry
webstream::$cache_expiry in webpage-defs.php
Seconds expiry for cached webpages
Variable $cache_path
webstream::$cache_path in webpage-defs.php
Path to use to save cached version of webpage
Variable $cache_regen
webstream::$cache_regen in webpage-defs.php
If true, force regeneration of cached webpage
Variable $charset
response::$charset in response-defs.php
Charset for this page
Variable $charset
head::$charset in webpage-defs.php
Charset for content of the page
Variable $class
webdebugger::$class in debugger.php
Classes of debugging to accumulate
Variable $compression_minsize
response::$compression_minsize in response-defs.php
Minimum size in bytes before invoking compression
Variable $compression_type
response::$compression_type in response-defs.php
Compression type to use for response content
Variable $configpath
application::$configpath in application-defs.php
Path to application configuration file
Variable $content
page_section::$content in plugin-defs.php
Page section content
Variable $content
webstream::$content in webpage-defs.php
The content to send to browser
Variable $content
webdebugger::$content in debugger.php
Accumulated debugging output content
Variable $cookiename
session::$cookiename in session-defs.php
The session cookie name
Variable $cookiename
keep::$cookiename in keep-defs.php
The name of the cookie to use
Method cache
webstream::cache() in webpage-defs.php
Cache this webpage Causes the current webpage to be regarded as a cached page.
Constant CACHED
CACHED in webpage-defs.php
The webpage is cached
Method card
response::card() in response-defs.php
Set up the Wap page (card) attributes for our response. This is the exact equivalent to the page() method above, but for WAP phones instead.
Method cdata
application::cdata() in application-defs.php
Method invoked when character data is available
Method check_group_membership
Check group membership
Method clear
pluginset::clear() in plugin-defs.php
Clear all plugins from the set
Method clear
page_section::clear() in plugin-defs.php
Clear all content from the page section.
Method close_webstream
webstream::close_webstream() in webpage-defs.php
Close the webstream. Return any current webpage content. Clear the current content. This method clears content, but leaves any replacement definitions untouched for further processing. It is designed to be called as part of the final webpage rendering process.
Constant CONTENT_AIFF
CONTENT_AIFF in mime-types.php
AIFF sound files
Constant CONTENT_ASF
CONTENT_ASF in mime-types.php
Media player ASF, ASX Movies
Constant CONTENT_AUDIO
CONTENT_AUDIO in mime-types.php
AU/SND basic audio files
Constant CONTENT_AVI
CONTENT_AVI in mime-types.php
AVI Movies
Constant CONTENT_BMP
CONTENT_BMP in mime-types.php
BMP attachment
Constant CONTENT_CSV
CONTENT_CSV in mime-types.php
CSV attachments
Constant CONTENT_FLASH
CONTENT_FLASH in mime-types.php
Shockwave Flash movies
Constant CONTENT_GIF
CONTENT_GIF in mime-types.php
GIF attachment
Constant CONTENT_HTML
CONTENT_HTML in mime-types.php
HTML attachments
Constant CONTENT_JPEG
CONTENT_JPEG in mime-types.php
Jpeg image attachment
Constant CONTENT_LATEX
CONTENT_LATEX in mime-types.php
Latex format
Constant CONTENT_MP3
CONTENT_MP3 in mime-types.php
MP3 audio files
Constant CONTENT_MPEG
CONTENT_MPEG in mime-types.php
MPEG Movies
Constant CONTENT_MSACCESS
CONTENT_MSACCESS in mime-types.php
M$ Word docs
Constant CONTENT_MSDOS
CONTENT_MSDOS in mime-types.php
EXE files, binaries of poor parentage
Constant CONTENT_MSEXCEL
CONTENT_MSEXCEL in mime-types.php
M$ Excel spreadsheets
Constant CONTENT_MSPROJECT
CONTENT_MSPROJECT in mime-types.php
M$ Project files
Constant CONTENT_MSWORD
CONTENT_MSWORD in mime-types.php
M$ Word docs
Constant CONTENT_OCTET
CONTENT_OCTET in mime-types.php
Binaries of questionable parentage
Constant CONTENT_OGG
CONTENT_OGG in mime-types.php
OGG sound files
Constant CONTENT_PDF
CONTENT_PDF in mime-types.php
Adobe PDF's
Constant CONTENT_PHOTO
CONTENT_PHOTO in mime-types.php
Photo Jpeg image attachment
Constant CONTENT_PNG
CONTENT_PNG in mime-types.php
PNG attachment
Constant CONTENT_PSCRIPT
CONTENT_PSCRIPT in mime-types.php
Postscript format
Constant CONTENT_QUICKTIME
CONTENT_QUICKTIME in mime-types.php
Quicktime movies
Constant CONTENT_RA
CONTENT_RA in mime-types.php
REALAUDIO sound files
Constant CONTENT_RTF
CONTENT_RTF in mime-types.php
Rich text format
Constant CONTENT_TEX
CONTENT_TEX in mime-types.php
Tex format
Constant CONTENT_TEXT
CONTENT_TEXT in mime-types.php
TEXT
Constant CONTENT_TIFF
CONTENT_TIFF in mime-types.php
TIFF attachment
Constant CONTENT_WAV
CONTENT_WAV in mime-types.php
WAV sound files
Constant CONTENT_WINMEDIA
CONTENT_WINMEDIA in mime-types.php
Windows Media Player
Constant CONTENT_XML
CONTENT_XML in mime-types.php
XML attachments
Constant CONTENT_ZIP
CONTENT_ZIP in mime-types.php
ZIP archive
Page control-panel.php
control-panel.php in control-panel.php
Method crash
response::crash() in response-defs.php
Crash the response with message A fatal error ocurred. We die with a message to the system log and to the user. Code supplied is optional.
Constant CUSTOM_COMPRESSION
CUSTOM_COMPRESSION in response-defs.php
Webpage compression: Use custom Phplib compression. For Php < v4.04
d
top
Variable $datasource
response::$datasource in response-defs.php
Datasources associated with this response
Variable $db_backed
session::$db_backed in session-defs.php
The type of this session
Variable $debugger
response::$debugger in response-defs.php
The debugger for this response
Variable $definitions
application::$definitions in application-defs.php
Variable $DTD
head::$DTD in webpage-defs.php
The Document Type Definition for this head section
Variable $DTD
response::$DTD in response-defs.php
Array of DTD specifiers for this response. @see set_dtd()
Constant DBG_ALL
DBG_ALL in debugger.php
Everything. Warning, this can be VERBOSE!
Constant DBG_DEBUG
DBG_DEBUG in debugger.php
Ad-hoc debugging output
Constant DBG_DEFAULT
DBG_DEFAULT in debugger.php
DEBUG and DIAGNOSTICS as default setting
Constant DBG_DIAGNOSTIC
DBG_DIAGNOSTIC in debugger.php
Diagnostic output
Constant DBG_DUMP
DBG_DUMP in debugger.php
Dump HTTP and PHP page vars
Constant DBG_NONE
DBG_NONE in debugger.php
No debugging (redundant)
Constant DBG_O_ALL
DBG_O_ALL in debugger.php
Ubiquitous output mode
Constant DBG_O_CLI
DBG_O_CLI in debugger.php
Output for CLI: echoed raw ASCII, LF end-of-line
Constant DBG_O_DEFAULT
DBG_O_DEFAULT in debugger.php
Default output mode (stored)
Constant DBG_O_ECHO
DBG_O_ECHO in debugger.php
Output via direct echo
Constant DBG_O_LOG
DBG_O_LOG in debugger.php
Output to system log
Constant DBG_O_LOGFILE
DBG_O_LOGFILE in debugger.php
To logfile (not implemented yet)
Constant DBG_O_NONE
DBG_O_NONE in debugger.php
No output
Constant DBG_O_STORED
DBG_O_STORED in debugger.php
Output stored in $content
Constant DBG_PROFILE
DBG_PROFILE in debugger.php
Show debugging profiler output
Constant DBG_SQL
DBG_SQL in debugger.php
SQL queries to database
Constant DBG_SQLDATA
DBG_SQLDATA in debugger.php
SQL SELECT data from database
Constant DBG_TABLES
DBG_TABLES in debugger.php
Show table borders and validation checks
Constant DBG_TRACE
DBG_TRACE in debugger.php
Provide debug traceback info
Constant DBG_UNDEFINED
DBG_UNDEFINED in debugger.php
Dummy value
Function debug
debug() in debugger.php
Add content to debug content Adds the string content to the debugger output. This is done in raw fashion without any
or linefeed chars appended.
Function debugbr
debugbr() in debugger.php
Add content to debug content with
Adds the string content to the debugger output and appends
to it. This is intended for output to HTML pages.
Page debugger.php
debugger.php in debugger.php
Function debugging
debugging() in debugger.php
Return debugger status Function for external routines to determine whether debugging is enabled or not..
Function debug_class
debug_class() in debugger.php
Set debugging class(es) Sets the class or classes (OR'ed together) of debug output which will be accepted/rendered on ouput.
Method debug_class
Set debug class(es) to accept
Function debug_dump
debug_dump() in debugger.php
Sets flag for debugger to include global vars in output.
Method debug_hascontent
Return whether we have any content, true or false.
Function debug_hex
debug_hex() in debugger.php
Add string to debug content as hexdump
Method debug_mode
Set debug mode
Function debug_off
debug_off() in debugger.php
Set debugging off
Function debug_on
debug_on() in debugger.php
Set debugging on Sets the debugging on. Sets class(es) to accept.
Function debug_output
debug_output() in debugger.php
Set debugger output mode This function allows setting of the debugger output mode which determines where output goes.
Method debug_output
Set debug output mode
Function debug_phpinfo
debug_phpinfo() in debugger.php
Calls Php phpinfo() function
Function debug_profile
debug_profile() in debugger.php
Insert an entry into the profiler. This label will have a line in the profile output against the time elapsed since the last line.
Function debug_profiling
debug_profiling() in debugger.php
Returns true if the RESPONSE is in profiling mode
Function debug_render
debug_render() in debugger.php
Render the debug output as a string.
Function debug_trace
debug_trace() in debugger.php
DEBUG TRACEBACK Usage: In your function you bracket the statements you want to label for tracing as in the following example..
Method debug_write
Set debug output mode Register content for debugging output. Check that it is of an acceptable class and direct it all to the right place(s).
Method deck
deck::deck() in webpage-defs.php
Constructor Create a new deck object.
Class deck
deck in webpage-defs.php
The deck class The class is a special kind of body section. It contains all of the main page content for a WAP phone (wml).
Constant DEFAULT_AGENT
DEFAULT_AGENT in user-defs.php
The default agent ID
Method delete
keep::delete() in keep-defs.php
Delete registered variables.
Method delete_cookie
session::delete_cookie() in session-defs.php
Delete session cookie Deletes the session cookie from the user's browser.
Method discard
webstream::discard() in webpage-defs.php
Discard all webpage content For discarding the content so far with immediate effect.
Function displayvar
displayvar() in debugger.php
Display a variable nicely Variables might be other than simple scalars. This function is used internally by the debugger to make sure we show them off in their best light.
Constant DOCUMENT_MIMES
DOCUMENT_MIMES in mime-types.php
e
top
Variable $email
user::$email in user-defs.php
User e-mail address
Variable $enabled
webdebugger::$enabled in debugger.php
Status of the debugger
Variable $enabled
user::$enabled in user-defs.php
True of user is active/enabled
Variable $encrypted_passwords
Password encryption flag
Variable $error_message
session::$error_message in session-defs.php
Error condition message if any
Function entryField
entryField() in control-panel.php
Method error_page
error_page::error_page() in webpage-defs.php
Constructor Create a new error page object.
Class error_page
error_page in webpage-defs.php
The error page class Allows us to render errors as either HTML or WML.
f
top
Variable $foot
webpage::$foot in webpage-defs.php
Webpage foot object
Constant FLASH_MIMES
FLASH_MIMES in mime-types.php
Method foot
foot::foot() in webpage-defs.php
Constructor Create a new foot object.
Class foot
foot in webpage-defs.php
The foot class
Method forget
response::forget() in response-defs.php
Forget kept variables by name. The named variables will have been passed to the remember() function beforehand, and this method causes them to be forgotten.
Method forget
keep::forget() in keep-defs.php
Forget variable names Un-register the given comma-delimited list of varnames in the current session..
Method forgetall
keep::forgetall() in keep-defs.php
Unset all registered variables.
Constant FORM_AUTHENTICATION
FORM_AUTHENTICATION in response-defs.php
Authentication option: Username/password from custom form fields
Method friendlyName
user::friendlyName() in user-defs.php
Get friendly name
g
top
Variable $generated
webpage::$generated in webpage-defs.php
True if page has been generated
Variable $globals
response::$globals in response-defs.php
Globals object. Manages the global vars in this response
Variable $globals
application::$globals in application-defs.php
Variable $group_info
user::$group_info in user-defs.php
Group membership details in full, as associative array
Variable $group_names
user::$group_names in user-defs.php
Array of group membership names (strings)
Variable $guest_browser_lifetime
True if we should limit 'guest' to browser lifetime
Method generate
webpage::generate() in webpage-defs.php
Generate the webpage content This routine is usually called after all the set-up calls for the head, body etc. have been made. This echoes each page section to the buffer, in preparation for delivery to the browser.
Method getparameter
application::getparameter() in application-defs.php
Get the value of a named parameter from a named setting. This only works for settings which are unique - ie. it won't work well for parms which can occur multiple times, eg: 'database'. Option to specify the element name for arrayed parameters.
Method getparameter
setting::getparameter() in application-defs.php
Get the value of a named parameter.
Method getvalue
parameter::getvalue() in application-defs.php
Get the parameter value. If the element name is given (for an array type parameter) then we return the value of that element.
Method get_auth_code
user::get_auth_code() in user-defs.php
Get user Authorisation Code Return this user's unique authorisation code; generate one if it isn't there yet, from userid and current time.
Method get_decodedvalue
parameter::get_decodedvalue() in application-defs.php
Return decoded value (or array of values) so that applications can use the data unencumbered with URL encoding etc.
Method get_groups
user::get_groups() in user-defs.php
Get user groups info
Method get_setting
application::get_setting() in application-defs.php
Return setting by name. NB: some settings can have multiple entries under the same name, eg. 'database'. In this case we return an array of setting objects, otherwise the single setting object.
Function get_settingindex
get_settingindex() in application-defs.php
Return the index of the given named setting, or -1 if not found.
Method get_stylesheets
webpage::get_stylesheets() in webpage-defs.php
Get the filenames for the main stylesheet and (optionally) the
Method get_template
page_section::get_template() in plugin-defs.php
Read in the template for this page section.
Method get_trimcontent
Return content, if not null or newline.
Method get_user_by_auth_code
Get user by Authorisation Code Internal function to return the user record from auth_code. The authorisation code is usually a string containing a complex key generated by something like MD5 or better.
Method get_user_by_id
user::get_user_by_id() in user-defs.php
Get user by ID Internal function to return the user record from id.
Method get_user_by_ip
user::get_user_by_ip() in user-defs.php
Get user by IP Internal function to return the user record which has IP address(es) which coincide with the client IP address being used for this access.
Method globalise
response::globalise() in response-defs.php
Globalise specific vars
Method globalise
globals::globalise() in globals-defs.php
Globalise the variables which have already been registered. Also
Method globalise_all
globals::globalise_all() in globals-defs.php
Globalises all variables from all possible sources. This duplicates the effect of Php register_globals = On in the Php configuration .ini file.
Method globalise_all
response::globalise_all() in response-defs.php
Set globalise all
Class globals
globals in globals-defs.php
A class to handle globalisation of specific variables. This class
Method globals
globals::globals() in globals-defs.php
Creates the object which contains the vars to globalise and the methods to globalise them. Takes optional parameters which are vars to globalise.
Page globals-defs.php
globals-defs.php in globals-defs.php
Method group_ids_list
user::group_ids_list() in user-defs.php
Get group IDs list
Method group_names_list
user::group_names_list() in user-defs.php
Get group names list
h
top
Variable $hascontent
pluginset::$hascontent in plugin-defs.php
Flag indicating whether plugins exist
Variable $hasgroups
user::$hasgroups in user-defs.php
True if user has a group membership
Variable $hasIPlist
user::$hasIPlist in user-defs.php
Flag, true if user has auto-login IP addresses
Variable $head
webpage::$head in webpage-defs.php
Webpage head object
Variable $heading
error_page::$heading in webpage-defs.php
Heading or subject of the error
Variable $http_host
response::$http_host in response-defs.php
The host of this website ie. 'foo.thingy.co.nz'
Function hasSQL
hasSQL() in antihack.php
Filters out potential hacking
Class head
head in webpage-defs.php
The head class.
Method head
head::head() in webpage-defs.php
Constructor Create a new head object.
Method html
webdebugger::html() in debugger.php
Use render() to render the debugger output.
Method html
error_page::html() in webpage-defs.php
This renders the error page section as HTML. We do this simply as a heading at level 3 (h3), and the message content.
Method html
foot::html() in webpage-defs.php
This renders the foot as HTML.
Method html
deck::html() in webpage-defs.php
This renders the body as HTML.
Method html
body::html() in webpage-defs.php
This renders the body as HTML.
Method html
RenderableObject::html() in renderable.php
Return output suitable for normal HTML-capable device. This method must be over-ridden by a method of the same name in the descendant class which renders output to web browsers.
Method html
page_section::html() in plugin-defs.php
This renders the page section as HTML.
Method html
head::html() in webpage-defs.php
This renders the head as HTML. After the title and the meta tags
Method htmldump
parameter::htmldump() in application-defs.php
Dump this parameter
Method htmldump
setting::htmldump() in application-defs.php
Dump setting
Method htmldump
application::htmldump() in application-defs.php
Return dump of the application content as a string. Useful for diagnostics mainly.
Constant HTTP_AUTHENTICATION
HTTP_AUTHENTICATION in response-defs.php
Authentication option: Browser popup form
i
top
Variable $IP
user::$IP in user-defs.php
List of IP addresses this user will be auto-logged-in from.
Method identify_user
session::identify_user() in session-defs.php
Identify the user/client
Constant IMAGE_MIMES
IMAGE_MIMES in mime-types.php
Function infoField
infoField() in control-panel.php
Method inline_end
webpage::inline_end() in webpage-defs.php
End inline buffering Usually used as in: <?php $s = $page->inline_end(); Then $s will contain all the HTML between inline_start/inline_end.
Method inline_start
webpage::inline_start() in webpage-defs.php
Begin inline buffering
Method InPersistentHostsList
Is host in peristent list
Method insert_metatag
webpage::insert_metatag() in webpage-defs.php
Insert a ready-made meta tag object into the webpage head section.
Method insert_metatag
head::insert_metatag() in webpage-defs.php
Insert a ready-made meta tag object into the metatags array.
Function integerField
integerField() in control-panel.php
Method ismemberof_group
user::ismemberof_group() in user-defs.php
Is user a member of a named group. The argument passed in must be a single group name string (ie. not a numeric group id) which is defined in the database.
Method ismemberof_group_in
Is user a member of one group of many Check user against a list of groups, return true if member of at least one of them. The list in $groupnames can be either a comma-delimited string of group names, OR an array of group names.
Method ismemberof_group_with_id
Is user a member of a group with ID Return true if the user is a member of the group with given ID.
Method ispermitted
This is the main method for querying permission access rights for a given agent. Returns a boolean value, true if the agent is permitted to access in the given way, else false. If the agent ID is unrecognised, then the method uses the 'default agent' permissions.
Method isvalid
user::isvalid() in user-defs.php
Return true if the current user is a valid one. This is false when the user has not been authorised, or the user ID wasn't found etc. It is an error condition for this to be false.
k
top
Variable $keep
response::$keep in response-defs.php
Our keep. Keeps variables alive in session
Variable $keep_enabled
response::$keep_enabled in response-defs.php
Our keep enabled flag (default enabled)
Method keep
keep::keep() in keep-defs.php
Constructor Create a new keep object. Sets basic field attributes.
Class keep
keep in keep-defs.php
Keep class A simple class for remembering variables or forgetting them using the PHP session handling routines..
Page keep-defs.php
keep-defs.php in keep-defs.php
Constant KEEP_DISABLED
KEEP_DISABLED in response-defs.php
Disable keeping variables across requests using Php session handling
Constant KEEP_ENABLED
KEEP_ENABLED in response-defs.php
Enable keeping variables across requests using Php session handling
l
top
Variable $languages
response::$languages in response-defs.php
IDs of all languages contained in this page
Variable $languages
head::$languages in webpage-defs.php
Languages used in content of the page
Variable $last_logintime
session::$last_logintime in session-defs.php
Time of last login (Unix timestamp)
Variable $lifetime
session::$lifetime in session-defs.php
The session lifetime, in seconds
Variable $limit_logins
user::$limit_logins in user-defs.php
Limit of logins allowed (0=unlimited)
Variable $logins_exceeded_msg
session::$logins_exceeded_msg in session-defs.php
Custom message to deliver when blocking
Variable $logins_exceeded_option
Option to take on logins exceeded for user
Variable $logins_exceeded_redirect
URL to redirect to on logins exceeded
Variable $login_type
session::$login_type in session-defs.php
Login type for this session
Method length
webstream::length() in webpage-defs.php
Length of output buffer
Method load_template
head::load_template() in webpage-defs.php
Load given template content.
Constant LOGIN_BY_AUTHCODE
LOGIN_BY_AUTHCODE in session-defs.php
Login by using authorisation code (MD5 string usually)
Constant LOGIN_BY_GUEST
LOGIN_BY_GUEST in session-defs.php
Login by using guest account
Constant LOGIN_BY_IP
LOGIN_BY_IP in session-defs.php
Login by remote IP address match
Constant LOGIN_BY_PASSWD
LOGIN_BY_PASSWD in session-defs.php
Login by standard username/password
Constant LOGIN_UNKNOWN
LOGIN_UNKNOWN in session-defs.php
No known login has been achieved
m
top
Variable $mbstring_avail
response::$mbstring_avail in response-defs.php
Whether we have multi-byte string fns available
Variable $meta
head::$meta in webpage-defs.php
Meta tags array
Variable $metadata_mode
response::$metadata_mode in response-defs.php
Metadata edit/generation mode we are in
Variable $microsites_mode
response::$microsites_mode in response-defs.php
Microsites edit/generation mode we are in
Variable $microsite_detected
response::$microsite_detected in response-defs.php
Name of the microsite detected, or undefined
Variable $msg
error_page::$msg in webpage-defs.php
Actual error message in detail
Variable $multilang
response::$multilang in response-defs.php
Whether we are in multi-language mode or not, If this is true then
Constant METADATA_DISABLED
METADATA_DISABLED in response-defs.php
Disable metadata editing and generation enhancements
Constant METADATA_ENABLED
METADATA_ENABLED in response-defs.php
Enable metadata editing and generation enhancements
Constant MICROSITES_DISABLED
MICROSITES_DISABLED in response-defs.php
Disable microsites editing and generation enhancements
Constant MICROSITES_ENABLED
MICROSITES_ENABLED in response-defs.php
Enable microsites editing and generation enhancements
Page mime-types.php
mime-types.php in mime-types.php
Function mimetype_category
mimetype_category() in mime-types.php
Returns the category associated with the given mimetype. This just allows you to ascertain what basic group of objects the mimetype belongs to, like 'image', 'document', 'movie', 'sound', etc.
Function mimetype_from_filename
mimetype_from_filename() in mime-types.php
Returns the mimetype associated with the given filepath or false of no match was found..
Constant MOVIE_MIMES
MOVIE_MIMES in mime-types.php
Constant MULTILANG_DISABLED
MULTILANG_DISABLED in response-defs.php
Disable multi-language extensions
Constant MULTILANG_ENABLED
MULTILANG_ENABLED in response-defs.php
Enable multi-language extensions
n
top
Variable $name
user::$name in user-defs.php
Full name
Variable $name
setting::$name in application-defs.php
Name of this setting
Variable $name
parameter::$name in application-defs.php
Parameter name
Method newparameter
setting::newparameter() in application-defs.php
Add a new parameter to this setting, with given value and type. For arrays we also specify the name of the array value.
Constant NOT_CACHED
NOT_CACHED in webpage-defs.php
The webpage is not cached
Constant NO_AUTHENTICATION
NO_AUTHENTICATION in response-defs.php
Authentication option: Redundant case, no authentication
Constant NO_COMPRESSION
NO_COMPRESSION in response-defs.php
Webpage compression: None. Just straight HTML
o
top
Variable $onload
body::$onload in webpage-defs.php
The script to execute when the page has loaded
Variable $output_mode
Modes of output for debugging content
Method on_authentication_fail
Set authentication failure option
Method on_logins_exceeded
session::on_logins_exceeded() in session-defs.php
Set logins exceeded action
Method open_webstream
webstream::open_webstream() in webpage-defs.php
Start webstream output channel..
p
top
Variable $page_expiry_secs
response::$page_expiry_secs in response-defs.php
Dynamic page expiry in seconds. Time to allow a dynamic page to
Variable $page_id
response::$page_id in response-defs.php
Page ID - key to ax_sitepage record
Variable $parameters
setting::$parameters in application-defs.php
Variable $parms
body::$parms in webpage-defs.php
Miscellaneous content for the body tag
Variable $password
user::$password in user-defs.php
Text password (encrypted or plain)
Variable $perms
permissions::$perms in user-defs.php
Array of permisssions. This is an associative array with the
Variable $persistent_hosts
response::$persistent_hosts in response-defs.php
Array of hosts we wish to connect persistently to
Variable $pluginid
plugin::$pluginid in plugin-defs.php
ID or name of this plugin
Variable $plugins
pluginset::$plugins in plugin-defs.php
Array of plugins in this set
Variable $pluginset
webpage::$pluginset in webpage-defs.php
Set of plugins with content
Variable $plugin_contents
plugin::$plugin_contents in plugin-defs.php
Array of plugin content objects
Variable $profile
webdebugger::$profile in debugger.php
Profiler data array
Variable $profile_timer
Microtimer object for profiling
Method page
response::page() in response-defs.php
Set up the page attributes for our response. This is an important call, and should be made just after including response-defs.php in your source code. It sets up the page title, the template file which defines the page structure, the theme and stylesheet.
Class page_section
page_section in plugin-defs.php
The page section class
Method page_section
page_section::page_section() in plugin-defs.php
Constructor Create a new page section object.
Method parameter
parameter::parameter() in application-defs.php
Make a new parameter.
Class parameter
parameter in application-defs.php
A parameter class to contain setting parameter information. Every parameter has an idetifying name, and a type. The value of a parameter can be an array of name=>value pairs, or a scalar type such as a string, integer or boolean.
Method parse
application::parse() in application-defs.php
Parse the application XML which is provided.
Method permission
permissions::permission() in user-defs.php
Low-level method for returning the permission for the given agent and perm. We return one of three states: agent is allowed, agent is disallowed, or agent permission status is undefined/unknown. The latter would occur if the agent ID is unrecognised in this class (ie. not in the $perms array).
Class permissions
permissions in user-defs.php
The permissions class. This class encpasulates a set of permissions which can be managed and tested by the associated methods.
Method permissions
Constructor Create a new permissions object with an optional permissions set.
Method permit
permissions::permit() in user-defs.php
Assign the given agent(s) the given access permission. The first paramter is a (comma) delimited list of agent IDs to assign the permission to.
Constant PERM_ALL
PERM_ALL in user-defs.php
All permitted
Constant PERM_ALLOWED
PERM_ALLOWED in user-defs.php
Permission is given
Constant PERM_CREATE
PERM_CREATE in user-defs.php
Permission to create items
Constant PERM_DELETE
PERM_DELETE in user-defs.php
Permission to delete items
Constant PERM_DISALLOWED
PERM_DISALLOWED in user-defs.php
Permission is refused
Constant PERM_NONE
PERM_NONE in user-defs.php
Nothing permitted
Constant PERM_READ
PERM_READ in user-defs.php
Permission to read/view items
Constant PERM_UNDEFINED
PERM_UNDEFINED in user-defs.php
Permission is undefined
Constant PERM_UPDATE
PERM_UPDATE in user-defs.php
Permission to update/modify items
Method plugin
plugin::plugin() in plugin-defs.php
Constructor Create a new plugin object.
Class plugin
plugin in plugin-defs.php
Plugin class A plugin is something which can be used by the system to render content to be plugged into a webpage in any specified place.
Method plugin
webpage::plugin() in webpage-defs.php
Add content to a plugin Plugins are regions of a webpage which you want to plug content into.
Page plugin-defs.php
plugin-defs.php in plugin-defs.php
Method pluginset
pluginset::pluginset() in plugin-defs.php
Constructor Create a new plugin set. This is just a container for plugins.
Class pluginset
pluginset in plugin-defs.php
Pluginset class This class manages plugins as a set. It is designed for use by webpages, which can have many types of plugin content defined for them.
Method plugin_inline
webpage::plugin_inline() in webpage-defs.php
Start/stop inline plugin content definition
Method plugin_replace
webpage::plugin_replace() in webpage-defs.php
Define or redefine a plugin. This acts similarly to the above plugin() method, except that here we replace the existing content, if any is present, with this content.
Method profile
webdebugger::profile() in debugger.php
Profile breakpoint.
Method profiling
webdebugger::profiling() in debugger.php
Returns true if this debugger is in profiling mode.
r
top
Variable $remote_address
response::$remote_address in response-defs.php
The remote IP address
Variable $replacement
webstream::$replacement in webpage-defs.php
Replacements to make in template
Variable $requested
response::$requested in response-defs.php
Path to the requested script/page
Variable $requested_query
response::$requested_query in response-defs.php
Query string (if any) supplied to requested page
Method recover
session::recover() in session-defs.php
Recover session Recover an existing session. This will obliterate any pre-existing session information in this object, since we expect it to succeed..
Method register
globals::register() in globals-defs.php
Register the given comma-delimited list of varnames, These are the names of global variables which can come from 'outside sources'.
Method register
response::register() in response-defs.php
Register vars Register given variables for globalisation.
Method remember
keep::remember() in keep-defs.php
Remember variable names Register the given comma-delimited list of varnames in the current session..
Method remember
response::remember() in response-defs.php
Remember variables by name, across page requests using our keep functionality. This utilises Php session handling to maintain the value of variables named here. Pass a list of vars as a string delimited by a comma.
Method render
webpage::render() in webpage-defs.php
Generate the content into the buffer, then return the content.
Method render
pluginset::render() in plugin-defs.php
This method takes the given template, and renders the plugins on it one by one. Each plugin is applied to the template, replacing all occurences of the appropriate tag based on the pluginid. Then finally the resulting string is returned.
Method render
templated_webpage::render() in webpage-defs.php
Return content to caller
Method render
RenderableObject::render() in renderable.php
Render output
Method render
plugin::render() in plugin-defs.php
Returns the string which represents all of the content
Method RenderableObject
Constructor Create a renderable object. Any object which you want to be able to deliver content to a device such as a web browser or wap phone etc. should inherit this class.
Class RenderableObject
RenderableObject in renderable.php
RenderableObject class This object should be inherited by all classes which are intended to output content for the client browser.
Page renderable.php
renderable.php in renderable.php
Method replace
webstream::replace() in webpage-defs.php
Replace pattern in webpage content
Method replace
page_section::replace() in plugin-defs.php
Replaces multiple occurrences of the given tag (pattern) in the body content with the specified new stuff.
Method replace_content
webstream::replace_content() in webpage-defs.php
Replace all webpage content For replacing the total contents of the buffer so far with a new content. Throw buffer away and start anew with immediate effect.
Method report_classes
List classes debugger is accepting
Method reset_webstream
webstream::reset_webstream() in webpage-defs.php
Reset the webstream. This method clears any current content, and also clears any stored replacement definitions. This resets the stream to the point at which it was created - a virgin webstream.
Method response
response::response() in response-defs.php
Constructor Create a new response.
Class response
response in response-defs.php
THE RESPONSE CLASS
Page response-defs.php
response-defs.php in response-defs.php
s
top
Variable $script
page_section::$script in plugin-defs.php
Script content for this page section
Variable $scriptsrc
page_section::$scriptsrc in plugin-defs.php
Scripts which are sourced via a URL
Variable $session_id
session::$session_id in session-defs.php
The ID of this session
Variable $session_record
session::$session_record in session-defs.php
The session record complete
Variable $settings
application::$settings in application-defs.php
Variable $site_docroot
response::$site_docroot in response-defs.php
Path to the site document root
Variable $site_url
response::$site_url in response-defs.php
The URL of this website
Variable $state
application::$state in application-defs.php
State of processing
Variable $style
head::$style in webpage-defs.php
Style settings for the webpage
Variable $stylesheet
head::$stylesheet in webpage-defs.php
Name of the stylesheet associated with the webpage
Variable $stylesheet_ie
head::$stylesheet_ie in webpage-defs.php
Name of the IE stylesheet
Variable $stylesheet_ns
head::$stylesheet_ns in webpage-defs.php
Name of the Netscape stylesheet
Method save
application::save() in application-defs.php
Save the application as XML file back to the same filename it was read in from, ie. after changes have been made. This generates the whole file as fresh XML, and writes it out.
Method script
page_section::script() in plugin-defs.php
Returns all of the defined script. Literal script is rendered for each language if more than one language is being used. Each language is bracketed with the usual <script language=foo></script> tags. Any script sources (URL references to scripts) are also rendered.
Method select_database
response::select_database() in response-defs.php
Selects a database to use This will connect it if it isn't already connected. Calling this with no database name will select the default one. Returns the database unique identifier, or false if none was selected.
Method send
webpage::send() in webpage-defs.php
Generate the content and then send it to the user browser.
Method send
templated_webpage::send() in webpage-defs.php
Send content to user browser
Method send_errorcode_and_die
Send HTTP error code and die Generic function to abort and send an error code notification to the user. These are lookalike errors for generic ones like 404: Page not found etc. This function will not return.
Method send_error_and_die
Send error and die Generic function to abort and send an error notification to the user instead. This function is a one-way trip to oblivion.
Method send_to_browser
webstream::send_to_browser() in webpage-defs.php
Send content to user browser
Method send_to_file
webstream::send_to_file() in webpage-defs.php
Send content to file Deliver the content to a given file.
Method send_to_file
Send debug output to a file.
Method session
session::session() in session-defs.php
Constructor Create a new session.
Class session
session in session-defs.php
THE SESSION CLASS A class to manage user sessions. A session is simply a thing which contains information about a user who has logged on to the system, so in fact the session is just an extension of a user.
Page session-defs.php
session-defs.php in session-defs.php
Method session_clear
session::session_clear() in session-defs.php
Clear session vars Common method for clearing out the current session info from the object variables.
Method session_create
session::session_create() in session-defs.php
Create new session Make a brand new session for the user.
Method session_delete
session::session_delete() in session-defs.php
Delete the session Delete the current session from the system.
Method session_valid
session::session_valid() in session-defs.php
Is session valid Return validity status. If there is a session ID and a valid user then the whole session is deemed valid, otherwise not.
Constant SESS_1_DAY
SESS_1_DAY in session-defs.php
Session lasts for 24 hours
Constant SESS_1_HOUR
SESS_1_HOUR in session-defs.php
Session lasts for 1 hour
Constant SESS_1_MONTH
SESS_1_MONTH in session-defs.php
Session lasts for 1 month
Constant SESS_1_WEEK
SESS_1_WEEK in session-defs.php
Session lasts for 1 week
Constant SESS_1_YEAR
SESS_1_YEAR in session-defs.php
Session lasts for 1 year
Constant SESS_4_HOURS
SESS_4_HOURS in session-defs.php
Session lasts for 4 hours
Constant SESS_8_HOURS
SESS_8_HOURS in session-defs.php
Session lasts for 8 hours
Constant SESS_12_HOURS
SESS_12_HOURS in session-defs.php
Session lasts for 12 hours
Constant SESS_20_MINS
SESS_20_MINS in session-defs.php
Session lasts for 20 minutes
Constant SESS_ALLOW
SESS_ALLOW in session-defs.php
Login limit exceeded: Allow, assume app. takes action
Constant SESS_ALLOW_CULL
SESS_ALLOW_CULL in session-defs.php
Login limit exceeded: Allow session, cull oldest
Constant SESS_BLOCK_GUEST
SESS_BLOCK_GUEST in session-defs.php
Login limit exceeded: Block session, login as guest instead
Constant SESS_BLOCK_MSG
SESS_BLOCK_MSG in session-defs.php
Login limit exceeded: Block session, nice message
Constant SESS_BLOCK_REDIRECT
SESS_BLOCK_REDIRECT in session-defs.php
Login limit exceeded: Block session, redirect to URL
Constant SESS_BLOCK_SILENT
SESS_BLOCK_SILENT in session-defs.php
Login limit exceeded: Block session, no message
Constant SESS_BROWSER_LIFETIME
SESS_BROWSER_LIFETIME in session-defs.php
Session lasts as long as user browser is open
Constant SESS_DATABASE_BACKED
SESS_DATABASE_BACKED in session-defs.php
Session is backed by a database connection
Constant SESS_FOREVER
SESS_FOREVER in session-defs.php
Session lasts forever.. well, 10 years is near enough.
Constant SESS_STANDALONE
SESS_STANDALONE in session-defs.php
Session is standalone, no database
Constant SESS_ZERO_LIFETIME
SESS_ZERO_LIFETIME in session-defs.php
Session has no lifetime, immediate expiry
Method setdefault
permissions::setdefault() in user-defs.php
Assign the default permission. This is the permission which is applied if the supplied agent is not recognised.
Method setparameter
application::setparameter() in application-defs.php
Set the value of a named parameter for a named setting. Optionally provide the element name for arrayed parameters.
Method setparameter
setting::setparameter() in application-defs.php
Set the value of a parameter which already exists in this setting.
Method setting
setting::setting() in application-defs.php
Make a new setting
Class setting
setting in application-defs.php
Application settings class. This class contains one or more parameters.
Method setvalue
parameter::setvalue() in application-defs.php
Set the parameter to given value. If the parameter has an array of values, the name is also given.
Method set_authentication_type
Set website authentication
Method set_blocked_ips
response::set_blocked_ips() in response-defs.php
define a blocked IP list.
Method set_buffering_mode
response::set_buffering_mode() in response-defs.php
Set buffering option
Method set_charset
head::set_charset() in webpage-defs.php
Set the charset for this head section
Method set_compression_minsize
Set compression threshold Set the threshold size of content before we use compression.
Method set_compression_type
Set compression type
Method set_cookie
session::set_cookie() in session-defs.php
Set the session cookie.
Method set_cookiename
session::set_cookiename() in session-defs.php
Set session cookie name
Method set_dtd
head::set_dtd() in webpage-defs.php
Set the DTD specifier string for this head section.
Method set_dtd
response::set_dtd() in response-defs.php
Set the DTDs array for all possible content types for this webpage.
Method set_encoding
response::set_encoding() in response-defs.php
Sets the content-type header characterset encoding, and (optionally)
Method set_encrypted_passwords
Set the password encryption flag. If passed in true, then we will be assuming that new passwords should be encrypted, and password checks will try encryption first, then fall back to basic.
Method set_guest_browser_lifetime
Set session guest browser lifetime flag If set True this causes the cookie lifetime to be forced to the browser lifetime if the user is 'guest'.
Method set_keep
response::set_keep() in response-defs.php
Set keep enable status. If the keep is enabled then there is access to the remember() and forget() methods to control persistent vars using Php session handling functions.
Method set_lifetime
session::set_lifetime() in session-defs.php
Set session lifetime Set the session cookie lifetime in seconds.
Method set_metadata_mode
response::set_metadata_mode() in response-defs.php
Set metadata mode
Method set_metatag
head::set_metatag() in webpage-defs.php
Add meta tag to the section
Method set_metatag
webpage::set_metatag() in webpage-defs.php
Add a meta tag to the webpage head section.
Method set_microsites_mode
response::set_microsites_mode() in response-defs.php
Set microsites mode
Method set_multilang
response::set_multilang() in response-defs.php
Sets the status of the multi-language flag 'multilang'. If this flag is true then multi-language facilities are enabled. This allows the setting of tags to indicate webpage language(s), and for inputting different character encodings via form elements etc.
Method set_onload
body::set_onload() in webpage-defs.php
Define the script to execute after page has loaded
Method set_onload
webpage::set_onload() in webpage-defs.php
Define the script to execute after page has loaded
Method set_page_expirysecs
response::set_page_expirysecs() in response-defs.php
Set page expiry in seconds. This affects all of the pages returned by Axyl.
Method set_parms
body::set_parms() in webpage-defs.php
Define other miscellaneous content to be put into the body tag.
Method set_password
user::set_password() in user-defs.php
Set the user login password. Store it according to the encryption mode. We assume a plain text password is being supplied.
Method set_persistent_hosts
Define persistent hosts list.
Method set_sessiontype
session::set_sessiontype() in session-defs.php
Set session database backing type The database backing 'type' can be either SESS_DATABASE_BACKED, or SESS_STANDALONE.
Method set_style
webpage::set_style() in webpage-defs.php
Define the style settings for the webpage. Usually the stylesheet will be all you require, however occasionally it is necessary to have specific styles for a page. Set these here, but make sure to provide the FULL style complete with <style></style> tags.
Method set_style
head::set_style() in webpage-defs.php
Define the style NB: The way this is currently done, you are expected to supply your style WITHOUT style tags here.
Method set_stylesheet
webpage::set_stylesheet() in webpage-defs.php
Set the filenames for the main stylesheet and (optionally) the stylesheet for Internet Explorer compatible browsers.
Method set_stylesheet
head::set_stylesheet() in webpage-defs.php
Set the stylesheet to use. This should be a valid pathname to an existing file. The second parm is for special styles for Internet Explorer-compatible browsers.
Method set_template
webpage::set_template() in webpage-defs.php
Define the template for the webpage.
Method set_template
Set the template file Base webpage content on a template. We echo this to the buffer.
Method set_theme
webpage::set_theme() in webpage-defs.php
Define the theme
Method set_title
webpage::set_title() in webpage-defs.php
Define the webpage title
Method set_title
head::set_title() in webpage-defs.php
Define the title
Method synchronize
application::synchronize() in application-defs.php
Make this current application object the same structure as the
t
top
Variable $tag
application::$tag in application-defs.php
Current/last tag opened
Variable $tag_name
tag::$tag_name in renderable.php
Variable $tag_value
tag::$tag_value in renderable.php
Variable $template
webpage::$template in webpage-defs.php
The name of the template which was applied, if any
Variable $templatefile
webpage::$templatefile in webpage-defs.php
The file the template content is to be found in
Variable $theme
webpage::$theme in webpage-defs.php
Theme to apply to the page. This should be a single-word ID, and
Variable $title
head::$title in webpage-defs.php
Title of the webpage
Variable $total_logins
user::$total_logins in user-defs.php
Total logins so far
Variable $trace
webdebugger::$trace in debugger.php
Array of traced locations
Variable $tracedepth
webdebugger::$tracedepth in debugger.php
Depth of tracing
Variable $type
parameter::$type in application-defs.php
Parameter type
Method tag
tag::tag() in renderable.php
Constructor
Class tag
tag in renderable.php
A renderable tag of some kind. Basically a tag is a language construct designed to render at least an identifying name and a value. More specific variants might add other properties, and control the way the tag is actually rendered.
Method tag_close
application::tag_close() in application-defs.php
Method invoked when a tag is closed
Method tag_open
application::tag_open() in application-defs.php
Method invoked when a tag is opened
Method templated_webpage
Constructor Create a new templated webpage object.
Class templated_webpage
templated_webpage in webpage-defs.php
The templated webpage page class
Method traceback
webdebugger::traceback() in debugger.php
Traceback list Return a string of the form "label->label->label" forming the traceback level labels in order.
u
top
Variable $userid
user::$userid in user-defs.php
Login user id, string
Variable $user_agent
response::$user_agent in response-defs.php
The user-agent
Variable $user_groups_cnt
user::$user_groups_cnt in user-defs.php
Group membership count
Variable $user_record
user::$user_record in user-defs.php
Complete user record as an associative array
Variable $user_type
user::$user_type in user-defs.php
User type: arbitrary textual type
Constant UNBUFFERED
UNBUFFERED in webpage-defs.php
The webpage is not buffered
Method unpermit
permissions::unpermit() in user-defs.php
Un-assign the given agent(s) the given access permission. The first paramter is a (comma) delimited list of agent IDs to unassign the permission from.
Method user
user::user() in user-defs.php
Constructor Create a new user object.
Class user
user in user-defs.php
The user class This class managed users. It pre-supposes a particular database structure based on three tables: uuser, ugroup, and uuser_group.
Page user-defs.php
user-defs.php in user-defs.php
v
top
Variable $valid
application::$valid in application-defs.php
True if response was valid, ie. no errors
Variable $valid
user::$valid in user-defs.php
True if user record is valid
Variable $value
parameter::$value in application-defs.php
Parameter value
Variable $varnames
globals::$varnames in globals-defs.php
Array containing vars to globalise, and their sources
w
top
Variable $WMLtemplate
deck::$WMLtemplate in webpage-defs.php
Template object for WML deck
Class webdebugger
webdebugger in debugger.php
The debugger class. Responsible for accumulating, filtering and then
Method webdebugger
Constructor
Class webpage
webpage in webpage-defs.php
The webpage page class.
Method webpage
webpage::webpage() in webpage-defs.php
Constructor Create a new webpage object. When this object is created it implicitly starts buffering with the ob_start() call by creating a webstream.
Page webpage-defs.php
webpage-defs.php in webpage-defs.php
Method webpage_content
webstream::webpage_content() in webpage-defs.php
Return webpage content Builds all of the webpage content and returns it to the caller.
Method webstream
webstream::webstream() in webpage-defs.php
Constructor
Class webstream
webstream in webpage-defs.php
The webstream class
Method wml
head::wml() in webpage-defs.php
Use render() to render this element in your page.
Method wml
foot::wml() in webpage-defs.php
This renders the foot as WML.
Method wml
deck::wml() in webpage-defs.php
This renders the deck content.
Method wml
RenderableObject::wml() in renderable.php
Return output suitable for normal wap-capable device. This method must be over-ridden by a method of the same name in the descendant class which renders output to wap devices.
Method wml
error_page::wml() in webpage-defs.php
This renders the error page section as WML. We do this simply as a single card with the appropriate title, and the content on the card in paragraph tags.
Method wml
body::wml() in webpage-defs.php
This renders the body as WML.
Method wml
webdebugger::wml() in debugger.php
Use render() to render the debugger output.
Method wml
page_section::wml() in plugin-defs.php
This renders the page section as WML.
Method wmlup
RenderableObject::wmlup() in renderable.php
Return output suitable for normal wap-capable device which has Phone.com extensions. This method must be over-ridden by a method of the same name in the descendant class which renders output to wap devices.
Method wml_template
deck::wml_template() in webpage-defs.php
Defines the template section for the deck.
x
top
Method xml
RenderableObject::xml() in renderable.php
Return output suitable for XML-capable devices or agents.
$ a b c d e f g h i k l m n o p r s t u v w x