Full index

Package indexes


$ a b c d e f g h i j k l m n o p q r s t u v w x y
$
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_charsets
form::$accept_charsets in form-defs.php
Accept-charset attributes - comma-delimited list
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 $access
tablecell::$access in html-defs.php
Optional access permissions for cell.
Variable $accesskey
HTMLObject::$accesskey in html-defs.php
Access key of the object
Variable $accesskey
button::$accesskey in button-defs.php
Speed-key associated with button (ALT-<key>)
Variable $access_method
DB_dbindex::$access_method in pg-schema-defs.php
Access method, eg. btree, hash etc.
Variable $action
menuoption::$action in menu-defs.php
Internal field which combines the sitepage
Variable $action
form::$action in form-defs.php
Action attribute
Variable $activated
maintainer::$activated in maintainer-defs.php
True if maintainer has been activated
Variable $active
menumaintainer::$active in menumaint-defs.php
Menu active flag
Variable $active
globals::$active in globals-defs.php
Whether the globals registration is active
Variable $active
menuoption::$active in menu-defs.php
Whether menuoption is active (displayed)
Variable $address
user_self_registration::$address in selfregistration-defs.php
Variable $addr_city
contactinfo::$addr_city in pim-defs.php
addr_city
Variable $addr_code
contactinfo::$addr_code in pim-defs.php
addr_code
Variable $addr_country
addr_country
Variable $addr_other
contactinfo::$addr_other in pim-defs.php
addr_other
Variable $addr_postal
addr_postal
Variable $addr_street
addr_street
Variable $addr_suburb
addr_suburb
Variable $affectedrowcount
dbquery::$affectedrowcount in query-defs.php
Number of rows affected by query
Variable $agent
setting::$agent in application-defs.php
Agent which will action this setting
Variable $align
image::$align in image-defs.php
Image alignment with respect to the page:
Variable $Align
treemenu::$Align in treemenu-defs.php
Alignment of the menu table
Variable $align
HTMLObject::$align in html-defs.php
Alignment of the object: left, right, center
Variable $allowed_types
Array of allowed mimetypes (unset = any types)
Variable $alt
image::$alt in image-defs.php
Image ALT tag content
Variable $alt
HTMLObject::$alt in html-defs.php
ALT text for this object
Variable $application
fileindexer::$application in search-fileindex-defs.php
Application we are indexing for
Variable $args
dbtrigger::$args in schema-defs.php
Arguments to pass to the function
Variable $arg_types
dbfunction::$arg_types in schema-defs.php
Variable $aslink
EmbeddedObject::$aslink in html-defs.php
If not empty, render as a link using $aslink as the text
Variable $aslink_target
Target frame for the $aslink
Variable $attr
application::$attr in application-defs.php
Attributes array for current/last tag
Variable $attributes
tag::$attributes in renderable.php
Variable $attributes
xmltag::$attributes in xml-defs.php
Array of tag attributes
Variable $authentication_method
User authentication method
Variable $author
thread_msg::$author in forum-defs.php
Variable $author
forum_thread::$author in forum-defs.php
Variable $author_groups
block::$author_groups in block-defs.php
The group membership for Authoring privilege
Variable $author_groups
layout::$author_groups in layout-defs.php
The group membership for Authoring privilege
Variable $auth_code
user::$auth_code in user-defs.php
Optional authorisation hash code
Variable $auth_code
user_self_registration::$auth_code in selfregistration-defs.php
Variable $auth_code
menuoption::$auth_code in menu-defs.php
Whether to apply auth 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
Variable $autocomplete
form_field::$autocomplete in form-defs.php
If false, disable autocomplete on this field. Mainly used with
Variable $autoconfigurate
configuration::$autoconfigurate in configuration-defs.php
Whether to show buttons on forms and auto-process POST or not
Variable $autojustify
table::$autojustify in html-defs.php
Auto-justify numerics to the right, text to the left
Variable $autostart
MediaObject::$autostart in html-defs.php
If true the media start immediately it is loaded
Constant ABANDON_FILE
ABANDON_FILE in file-defs.php
Abandon file on close
Method abbreviate_dayname
Constant ABBREVIATE_DAYNAME
ABBREVIATE_DAYNAME in clock-defs.php
Abbreviate day name or not
Method activate_editing
layout::activate_editing() in layout-defs.php
Provide a layouteditor. This is used to instantiate a layouteditor object for when we need to change this layout somewhow. We only need one, so we check if it's already been done first.
Method activate_editing
block::activate_editing() in block-defs.php
Provide a blockeditor. This is used to instantiate a blockeditor object for when we need to change this block somewhow. We only need one, so we check if it's already been done first.
Method add
webpage::add() in webpage-defs.php
Add to the body content
Method add
form::add() in form-defs.php
Adds a form element object to the form. This is usually an object you have previously created eg. with new form_textfield(...) etc.
Method add
page_section::add() in plugin-defs.php
Add new content to the page section.
Method addcolumn
dbtable::addcolumn() in schema-defs.php
Return SQL which will create a column in this table. The $column passed in is actually a field object.
Method addcolumn
DB_dbtable::addcolumn() in pg-schema-defs.php
Return SQL which will create a column in this table. The $column passed in is actually a field object.
Method addconstraint
schema::addconstraint() in schema-defs.php
Add a constraint to the schema information.
Method addcontent
tablecell::addcontent() in html-defs.php
Add to the content for this cell
Method addfield
dbtable::addfield() in schema-defs.php
Add a field to the table.
Method addfunction
schema::addfunction() in schema-defs.php
Add a function to the schema information.
Method additem
dat_keyvalues::additem() in data-defs.php
Adds a key=>value pair item into the collection.
Method additem
Add an image item to preview. We override the combofield additem() so we can store the image URL against the key value nin our arrays.
Method additem
menu::additem() in menu-defs.php
Create new menu item Makes a new menuitem from a given label and URL and adds it to the menu.
Method additem
Add a data item Adds a key=>value pair into the combo options collection.
Method additem
catalog::additem() in catalog-defs.php
Add catalog item to the catalog. The catalog will add the new item by cat_id. If that ID already exists it is overwritten.
Method addparameter
setting::addparameter() in application-defs.php
Add the given parameter to this setting.
Method addsequence
schema::addsequence() in schema-defs.php
Add a sequence to the schema information.
Method addtable
schema::addtable() in schema-defs.php
Add a table to the schema information.
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 addtrigger
schema::addtrigger() in schema-defs.php
Add a trigger to the schema information.
Method add_annotation
form::add_annotation() in form-defs.php
Add annotation to the form Adds text content to the form in the field column. The text is added literally, so you can add in effects like <em>..</em> etc.
Method add_attribute
tag::add_attribute() in renderable.php
Adds an attribute to this tag.
Method add_attribute
embed::add_attribute() in html-defs.php
Add non-standard attribute to be rendered.
Method add_blocklet
block::add_blocklet() in block-defs.php
Add a new blocklet to the block.
Method add_button
form::add_button() in form-defs.php
Add a button Adds a button element to the form.
Method add_content
webstream::add_content() in webpage-defs.php
Add new content to the webstream..
Method add_content
email::add_content() in mail-defs.php
Append new content to the body of the email.
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_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_database
datasources::add_database() in database-defs.php
Constructor Add a new base to our list of datasources. The dbtype and the name are the only mandatory parameters.
Method add_defaults
recmaintainer::add_defaults() in recmaint-defs.php
Add an array of default values for each field.
Method add_embed
Add an embed object to provide fallback for browsers which do not support the object tag properly.
Method add_field
lucene_msg::add_field() in lucene-defs.php
Add a field to the fieldset.
Method add_field
searchengine_msg::add_field() in search-lucene-defs.php
Add a field to the fieldset.
Method add_field
WMLfieldset::add_field() in wml-defs.php
Add field Add a field object to the fields in this fieldset.
Method add_fileuploadfields
Add file upload fields Special function to add repeated fileupload fields to the form.
Method add_header
email::add_header() in mail-defs.php
Generic function to add a header. We store our headers in an associative array, keyed on the proper-cased header name, so we avoid duplicates.
Method add_holiday
holidays::add_holiday() in holiday-defs.php
Add a holiday date as a date-string in the usual kinds of form such as '25-12', or '25 December 2007' or '25/12/2007' etc. This is a friendly method for adding general holiday dates.
Method add_holiday_relative
Add a holiday which is calculated as being the Nth occurence of a given dayname, in a given month. This method is a common one for designating National holidays, eg. 'Queen's Birthday' as being the first Monday in June.
Method add_holiday_ts
holidays::add_holiday_ts() in holiday-defs.php
Add a holiday timestamp to the array. This is the internal method for adding raw holiday timestamps.
Function add_http_prefix
add_http_prefix() in utils.php
Make sure there is an http:// on a URL. If already present then string is returned untouched.
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_member
forum::add_member() in forum-defs.php
Method add_menuitem
menu::add_menuitem() in menu-defs.php
Add menu item Adds a ready-made menuitem to the menu.
Method add_menuoption
menumaintainer::add_menuoption() in menumaint-defs.php
This adds a new menuoption to the list, but does not add any records to the database.
Method add_metadata_element
Add a metadata element to our array of elements. We add it to an associative array keyed on the element_id, ensuring no duplicates.
Method add_monitor
monitor::add_monitor() in monitor-defs.php
Add a new monitor. Eg. file_monitor, postgres_monitor etc. This just stuffs the object in an array ready to be checked.
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_querydata
Add ready-made data. Populates the combo field data from a pre-run query.
Method add_querydata
Add query data
Method add_record
recmaintainer::add_record() in recmaint-defs.php
Add a record of data to the maintainer.
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_separator
form::add_separator() in form-defs.php
Add form separator row
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 add_text
form::add_text() in form-defs.php
Add text to the form Adds text content to the form spanning both columns. The text is added literally, so you can add in effects like <em>..</em> etc.
Method add_timeslot
monitor::add_timeslot() in monitor-defs.php
Add a time slot to the schedule. This requires two times as per 24hr clock which define a time interval during the day, and gives it a name. You can define any number of these. Timeslots have to be in HH:MM format, separated by a dash "-", eg: '07:30-11:45'.
Method add_timeslot
schedule::add_timeslot() in datetime-defs.php
Add timeslot. The start and end parameters can either be Unix timestamps, or string datetime specifiers.
Method add_xmltag
lucene_msg::add_xmltag() in lucene-defs.php
Add a new XML tag object to this Lucene message
Method add_xmltag
searchengine_msg::add_xmltag() in search-lucene-defs.php
Add a new XML tag object to this SearchEngine message. We usually just
Method affectedrows
database::affectedrows() in database-defs.php
This method must be defined in the child class.
Method affectedrows
datasources::affectedrows() in database-defs.php
Return the number of rows affected by a query.
Constant ALL
ALL in schema-defs.php
Run getchema() in recusrive mode - follow foreign keys
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
Constant ALTERNATIVE
ALTERNATIVE in mail-defs.php
Alternative formats of same content
Class anchor
anchor in html-defs.php
[A] - The anchor tag, otheriwse know as a clickable link.
Method anchor
anchor::anchor() in html-defs.php
Constructor
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 append_cols
table::append_cols() in html-defs.php
Append columns onto all rows in the table.
Method append_row
table::append_row() in html-defs.php
Append a row onto the table.
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
Constant APP_UNDEF
APP_UNDEF in application-defs.php
Undefined setting or parameter value..
Method AsIcon
img::AsIcon() in html-defs.php
Render the image object as an image 'icon' which can be clicked to display the object in a popup window.
Method AsIcon
DocumentObject::AsIcon() in html-defs.php
Render the document object as an image 'icon' which can be clicked to play the media. If image is specified, it must be a valid 'image' object, otherwise a generic library symbol will be used.
Method AsIcon
catalogitem::AsIcon() in catalog-defs.php
Return the catalog item as a clickable icon.
Method AsIcon
MediaObject::AsIcon() in html-defs.php
Render the media object as an image 'icon' which can be clicked to play the media. If image is specified, it must be a valid 'image' object, otherwise a generic library symbol will be used.
Method AsIcon
FlashObject::AsIcon() in html-defs.php
Render the flash object as an image 'icon' which can be clicked to play the movie. If image is specified, it must be a valid 'image' object, otherwise a generic library symbol will be used.
Method AsLink
EmbeddedObject::AsLink() in html-defs.php
Render the object as a simple link. The parameter passed will be the text of the link, and the URL is determined by the location of the object as specified in the constructor.
Method AsLink
catalogitem::AsLink() in catalog-defs.php
Return the catalog item as a clickable hyperlink.
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.
Method as_displayonly
Returns current element as text, with associated hidden field.
Method as_hiddenfield
Returns current element as a hidden field.
Method attach
email::attach() in mail-defs.php
Wrapper for general binary attachments. We assume a MIME content type of multipart/mixed for these..
Method attach_file
email::attach_file() in mail-defs.php
Attaches a 'file' to the e-mail message. Pass a file pathname to attach.
Method attach_html
email::attach_html() in mail-defs.php
Just a convenient wrapper for adding HTML attachments. Note that with
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_password
Authenticate a password according to the appropriate encryption regime.
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.
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.
Method authorised_user
Constructor Create a new authorised user object.
Method autojustify
table::autojustify() in html-defs.php
Set table auto-justify mode on or off.
Method autojustify
tablecell::autojustify() in html-defs.php
Automatically set the alignment of this cell according to content.
Method autosequence
maintainer::autosequence() in maintainer-defs.php
Auto-detect sequences for integer fields. The technique is to assume sequences are named after the field in the form: 'seq_{fieldname}' and if so then this sequence is associated with the given field named {fieldname}.
Constant AUTOSTART
AUTOSTART in html-defs.php
Used to indicate sound should start playing on load
b
top
Variable $background_colour
block::$background_colour in block-defs.php
Colour of block background
Variable $background_colours
rowmenu::$background_colours in rowmenu-defs.php
Array of background colours for each level
Variable $background_img
block::$background_img in block-defs.php
Background image - ID from ax_catalog table, if defined
Variable $base64_func
email::$base64_func in mail-defs.php
If !specified use PHP's base64
Variable $base_element
metadata_element::$base_element in metadata-defs.php
Whether this is a base element, or has a parent
Variable $base_path
Base path to image. This will be prefixed to the value field.
Variable $bcc
email::$bcc in mail-defs.php
Bcc: (blind copies to) header
Variable $before
dbtrigger::$before in schema-defs.php
When trigger fires. If true BEFORE, else AFTER event
Variable $bgcolor
HTMLObject::$bgcolor in html-defs.php
Background colour of the object
Variable $bgurl
HTMLObject::$bgurl in html-defs.php
Background image url
Variable $block
blockeditor::$block in block-editor-defs.php
The block we are providing
Variable $blockfm
block::$blockfm in block-defs.php
The form name for the current block @access private
Variable $blockformats
htmlarea_config::$blockformats in htmlarea-defs.php
The list of block format styles to allow user to choose from
Variable $blockid
block::$blockid in block-defs.php
The id of the current block
Variable $blockletid
blocklet::$blockletid in block-defs.php
blocklet ID
Variable $blocklets
block::$blocklets in block-defs.php
Array of blocklet objects in this block
Variable $blocklet_sep
block::$blocklet_sep in block-defs.php
Vertical separation of blocklets in pixels
Variable $blocklet_style
blocklet::$blocklet_style in block-defs.php
Manual style to apply to content
Variable $block_desc
block::$block_desc in block-defs.php
The description of the current block
Variable $block_style
block::$block_style in block-defs.php
Manual style entered by user
Variable $block_type
block::$block_type in block-defs.php
Type of block, ""=empty, "b"=block content, "w"=wysiwyg, "p"=plain cell
Variable $body
webpage::$body in webpage-defs.php
Webpage body object
Variable $body
WMLelement::$body in wml-defs.php
The content of the element
Variable $body
email::$body in mail-defs.php
e-mail body text
Variable $border
HTMLObject::$border in html-defs.php
Border size (pixels)
Variable $border
image_button::$border in button-defs.php
Border size, pixels
Variable $border
image::$border in image-defs.php
Image border with in pixels
Variable $BorderColor
treemenu::$BorderColor in treemenu-defs.php
Colour of top menu item border
Variable $BorderWidth
treemenu::$BorderWidth in treemenu-defs.php
Width of top menu border in px
Variable $border_colour
block::$border_colour in block-defs.php
Colour of border
Variable $border_width
block::$border_width in block-defs.php
Width of border in pixels
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
Variable $built
lucene_msg::$built in lucene-defs.php
True if message has been built
Variable $built
searchengine_msg::$built in search-lucene-defs.php
True if message has been built
Variable $bytesize
story::$bytesize in story-defs.php
Constant BACKWARDS_DATE_ONLY
BACKWARDS_DATE_ONLY in datetime-defs.php
Example: 1999/12/31
Method Bcc
email::Bcc() in mail-defs.php
Set blind copies-to Set the e-mail Bcc: e-mail addresses for blind copies to.
Function begin_transaction
begin_transaction() in query-defs.php
Begin a DB transaction
Method begin_transaction
Start a database transaction
Method begin_transaction
database::begin_transaction() in database-defs.php
Start a new database transaction.
Method block
block::block() in block-defs.php
Constructor Create a new block object.
Class block
block in block-defs.php
Block
Page block-defs.php
block-defs.php in block-defs.php
Page block-editor-defs.php
block-editor-defs.php in block-editor-defs.php
Class blockeditor
blockeditor in block-editor-defs.php
Block Editor
Method blockeditor
blockeditor::blockeditor() in block-editor-defs.php
Constructor Create a new blockeditor object.
Class blocklet
blocklet in block-defs.php
The blocklet is simply a part of a block. It is almost a 'paragraph' of
Method blocklet
blocklet::blocklet() in block-defs.php
Constructor Create a new blocklet object.
Constant BLOCK_CONTENT
BLOCK_CONTENT in block-defs.php
Layout cell content: standard block
Method body
body::body() in webpage-defs.php
Constructor Create a new body object.
Method Body
email::Body() in mail-defs.php
Set body
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.
Function bool_from_db_value
bool_from_db_value() in query-defs.php
Return true or false for boolean data returned by the current DB. This is to provide for boolean compatibility across all DBs.
Method bool_from_db_value
database::bool_from_db_value() in database-defs.php
Return a Php boolean from a database field value. The database field is expected to be a container of some form of logical value. Here is where we convert it according to the current database.
Method bool_from_db_value
Return a Php boolean from a database field value. The database field is expected to be a container of some form of logical value. Here is where we convert it according to the current database.
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
Method build
sqlquery::build() in query-defs.php
Build the SQL query This takes the various components which have been added to the object and parses them to build the full SQL statement which will be sent to the server. The result is stored in $this->sql.
Constant BUILTIN_COMPRESSION
BUILTIN_COMPRESSION in response-defs.php
Webpage compression: Use the builtin Php compression system. Requires Php >= v4.04
Class button
button in button-defs.php
A standard button for a form. Does nothing unless you define an onclick event handler for it.
Method button
button::button() in button-defs.php
Constructor Create a button object. Sets basic button attributes.
Page button-defs.php
button-defs.php in button-defs.php
c
top
Variable $cache
DB_dbsequence::$cache in pg-schema-defs.php
Sequence cache size
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 $cache_seconds
microsite_page::$cache_seconds in microsite-defs.php
How many seconds to cache this page
Variable $caption
story_media::$caption in story-defs.php
The caption for this item
Variable $cards
WMLdeck::$cards in wml-defs.php
Array of card objects
Variable $card_id
WMLcard::$card_id in wml-defs.php
Unique card identifier string
Variable $catalogitem
story_media::$catalogitem in story-defs.php
The catalogitem object
Variable $catalogitems
catalog::$catalogitems in catalog-defs.php
The array of catalogitem objects in this catalog
Variable $catalogitems
microsite::$catalogitems in microsite-defs.php
Media items in this microsite (array)
Variable $categories
catalog::$categories in catalog-defs.php
The array of categories (optional)
Variable $category
EmbeddedObject::$category in html-defs.php
Mimetype category, eg: 'movie', 'audio' etc.
Variable $category
catalogitem::$category in catalog-defs.php
Variable $cat_desc
catalogitem::$cat_desc in catalog-defs.php
Variable $cat_id
catalogitem::$cat_id in catalog-defs.php
Variable $cat_name
catalogitem::$cat_name in catalog-defs.php
Variable $cc
email::$cc in mail-defs.php
Cc: (copies to) header
Variable $cellid
tablecell::$cellid in html-defs.php
Optional unique ID for this cell. Used for form field naming.
Variable $cellpadding
table::$cellpadding in html-defs.php
Padding of cells in pixels
Variable $cellspacing
table::$cellspacing in html-defs.php
Spacing between cells in pixels
Variable $charset
head::$charset in webpage-defs.php
Charset for content of the page
Variable $charset
response::$charset in response-defs.php
Charset for this page
Variable $charset
email::$charset in mail-defs.php
character set to use for the e-mail
Variable $checked
form_checkbox::$checked in form-defs.php
True if checkbox is ticked/checked
Variable $checked
True if this element should be selected
Variable $childtags
xmltag::$childtags in xml-defs.php
Array of child tags of this tag
Variable $child_element_ids
Child element_ids of this element
Variable $cksrc
dbconstraint::$cksrc in schema-defs.php
Check constraint source
Variable $class
StylableObject::$class in html-defs.php
The stylesheet class to apply to this object
Variable $classid
EmbeddedObject::$classid in html-defs.php
URL for the object's implementation
Variable $clockid
digital_clock::$clockid in clock-defs.php
Unique ID for this clock widget
Variable $clustered
DB_dbindex::$clustered in pg-schema-defs.php
True if index is clustered
Variable $code
embed::$code in html-defs.php
Name of Java file, if java applet
Variable $codebase
EmbeddedObject::$codebase in html-defs.php
URL for relative base for accessing object
Variable $codebase
embed::$codebase in html-defs.php
Base URL for plug-in or potenial java applet (IE)
Variable $codetype
EmbeddedObject::$codetype in html-defs.php
Object MIME type
Variable $collapseimage
treemenu::$collapseimage in treemenu-defs.php
Image to use for expanded sub-menu
Variable $color
HTMLObject::$color in html-defs.php
Foreground/text colour of the object
Variable $colour
hr::$colour in html-defs.php
Colour of the element
Variable $cols
matrix::$cols in html-defs.php
Columns in table
Variable $cols
block::$cols in block-defs.php
The number of columns in this block
Variable $colspan
tablecell::$colspan in html-defs.php
Column span that this cell is anchor of
Variable $colspanned
tablecell::$colspanned in html-defs.php
Whether this cell is colspanned (invisible)
Variable $comments
enc_qualifier::$comments in metadata-defs.php
Blurb regarding this qualifier
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 $condition
monitor::$condition in monitor-defs.php
Monitor highest priority condition
Variable $config
form_wysiwygfield::$config in htmlarea-defs.php
The configuration override settings to use. This is
Variable $configpath
application::$configpath in application-defs.php
Path to application configuration file
Variable $config_id
configuration::$config_id in configuration-defs.php
Identity if the current configuration
Variable $config_name
configuration::$config_name in configuration-defs.php
The name of the current configuration
Variable $confirmation
button::$confirmation in button-defs.php
Confirmation text for onclick
Variable $confirmsubject
user_self_registration::$confirmsubject in selfregistration-defs.php
Variable $confirm_text
image_button::$confirm_text in button-defs.php
Popup confirmation text to display on button click
Variable $confirm_text
Popup confirmation text to display on button click
Variable $connected
database::$connected in database-defs.php
Flag true if database was connected ok
Variable $connected
searchengine_connection::$connected in search-lucene-defs.php
True if we are connected to socket
Variable $connected
True if we are connected to socket
Variable $constraints
schema::$constraints in schema-defs.php
Variable $constraints
dbtable::$constraints in schema-defs.php
Array of constraints on this table
Variable $constraints
dbfield::$constraints in schema-defs.php
Variable $contactinfo
Contact info object
Variable $contactinfoid
contactinfo ID
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
blocklet::$content in block-defs.php
Blocklet textual content
Variable $content
inputfile::$content in file-defs.php
Content of file after readall()
Variable $content
webdebugger::$content in debugger.php
Accumulated debugging output content
Variable $content
pages::$content in paging-defs.php
Pages content
Variable $content
tablecell::$content in html-defs.php
The cell content object
Variable $content
email::$content in mail-defs.php
E-mail body + headers minus From: and Subject:
Variable $content_colour
blocklet::$content_colour in block-defs.php
Content colour
Variable $content_size
blocklet::$content_size in block-defs.php
Content size adjustment -2 thru +2
Variable $cookiename
keep::$cookiename in keep-defs.php
The name of the cookie to use
Variable $cookiename
session::$cookiename in session-defs.php
The session cookie name
Variable $corepage
microsite_page::$corepage in microsite-defs.php
Whether this page is an Axyl core page
Variable $count
dat_keyvalues::$count in data-defs.php
The total data items in our array
Variable $created
quickfile::$created in file-defs.php
True if quickfile was created successfully
Variable $critsecs
file_monitor::$critsecs in monitor-defs.php
Seconds before error condition
Variable $css
microsite::$css in microsite-defs.php
The main stylesheet of the microsite
Variable $css_date
digital_clock::$css_date in clock-defs.php
Style or class for date display
Variable $css_ie
microsite::$css_ie in microsite-defs.php
The IE stylesheet of the microsite
Variable $css_ns
microsite::$css_ns in microsite-defs.php
The Netscape stylesheet of the microsite
Variable $css_styles
form_wysiwygfield::$css_styles in htmlarea-defs.php
CSS Styles we want to display for this field
Variable $css_time
digital_clock::$css_time in clock-defs.php
Style or class for time digits
Variable $currently_installed
microsite::$currently_installed in microsite-defs.php
Whether microsite is currently installed (built)
Variable $current_row
dbrows::$current_row in query-defs.php
An array containing the current DB row
Variable $current_row
maintainer::$current_row in maintainer-defs.php
Current record/row
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 calculate_length
Calculate the length (size) of deck Calculates the WML length from scratch.
Method Calendar
Calendar::Calendar() in calendar-defs.php
Constructor. Create a new Calendar object with optional centre date (defaults to 'today'). This date is the one we return to when the 'today' button is clicked on the calendar & is the starting point.
Class Calendar
Calendar in calendar-defs.php
Calendar
Page calendar-defs.php
calendar-defs.php in calendar-defs.php
Method capable_of
schema::capable_of() in schema-defs.php
Return database capabilities. There are specific capabilities which the diff code needs to query, and this method should be overridden in the specific database module to answer those questions.
Method capable_of
DB_schema::capable_of() in pg-schema-defs.php
Return database capabilities. There are specific capabilities which the diff code needs to query, and this method should be overridden in the specific database module to answer those questions.
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 catalog
catalog::catalog() in catalog-defs.php
Constructor
Class catalog
catalog in catalog-defs.php
This class encapsulates a media catalog, which is a collection of catalogitem objects.
Page catalog-defs.php
catalog-defs.php in catalog-defs.php
Class catalogitem
catalogitem in catalog-defs.php
A class which encpasulates an item which can be in the catalog.
Method catalogitem
catalogitem::catalogitem() in catalog-defs.php
Constructor
Method Cc
email::Cc() in mail-defs.php
Set copies-to Set the e-mail Cc: e-mail addresses for copies to.
Method cdata
application::cdata() in application-defs.php
Method invoked when character data is available
Method cdata
xmlparser::cdata() in xml-defs.php
Method invoked when character data is available
Method cellcount
table::cellcount() in html-defs.php
Return the number of cells in a specific row.
Method cell_exists
table::cell_exists() in html-defs.php
Check if given cell exists, return True is it does.
Method charset
email::charset() in mail-defs.php
Set the character set encoding for the email.
Method check
searchengine_monitor::check() in monitor-defs.php
Make the check on Lucene by firing the query off and checking for the expected number of hits coming back.
Method check
form_checkbox::check() in form-defs.php
Sets the checkbox to the checked state.
Method check
postgres_monitor::check() in monitor-defs.php
Make the check, as to whether we can connect to the Postgres DB.
Method check
monitor::check() in monitor-defs.php
Check all monitors. Just iterate through them and raise the conditions
Method check
file_monitor::check() in monitor-defs.php
Make the check on the time the file was last modified and if this is longer than this->warnsecs ago but less than this->errsecs then issue a warning. Otherwise if it is longer than this->errsecs ago then we issue an error message.
Method check
process_monitor::check() in monitor-defs.php
Make the check on the time the file was last modified and if this is longer than this->warnsecs ago but less than this->errsecs then issue a warning. Otherwise if it is longer than this->errsecs ago then we issue an error message.
Method check
diskspace_monitor::check() in monitor-defs.php
Check the space on the filesystem of the directory specified.
Method check
exec_monitor::check() in monitor-defs.php
Make the check by executing the script/program which has been
Method check
form_radiobutton::check() in form-defs.php
Sets the checkbox to the checked state.
Method check_all_monitors
monitor::check_all_monitors() in monitor-defs.php
Iterate through all our monitors, checking in each case. Each monitor will implement its own kind of checking and set its condition afterward.
Method check_authcode
user_self_registration::check_authcode() in selfregistration-defs.php
Method check_group_membership
Check group membership
Method childtag
xmltag::childtag() in xml-defs.php
Add a child tag.
Method clear
monitor::clear() in monitor-defs.php
Clear all the monitors.
Method clear
sqlquery::clear() in query-defs.php
Clear query - Wipe all of the current query definitions.
Method clear
searchengine_msg::clear() in search-lucene-defs.php
Clear all data/fields, leaving type definition alone.
Method clear
pluginset::clear() in plugin-defs.php
Clear all plugins from the set
Method clear
lucene_msg::clear() in lucene-defs.php
Clear all data/fields, leaving type definition alone.
Method clear
page_section::clear() in plugin-defs.php
Clear all content from the page section.
Method clearcontent
tablecell::clearcontent() in html-defs.php
Clear the content from this cell.
Method clearcontent
table::clearcontent() in html-defs.php
Clear the content from all rows in table. This sets the content of every cell in every row in every group to nullstring.
Method clearitems
Clears all key=>value pair items from the collection.
Method clearitems
Clears any existing items
Method clearstyle
Clear all existing style settings. This leaves any class settings alone.
Method clear_daterange
search::clear_daterange() in search-defs.php
Clear the date range for the search. Makes sure that the search will not be filtered by a date restriction.
Method clear_search
search::clear_search() in search-defs.php
Clear the search terms and any stored hits.
Method clickable_image
Constructor Creates the basic clickable image object.
Class clickable_image
clickable_image in image-defs.php
Clickable Image class A class for managing a clickable image. A clickable image is one which redirects to a given URL when clicked on.
Page clock-defs.php
clock-defs.php in clock-defs.php
Constant CLOCK_ATTRS
CLOCK_ATTRS in clock-defs.php
Clock overall clock table attributes (eg. style, width etc.)
Constant CLOCK_DATE_CSS
CLOCK_DATE_CSS in clock-defs.php
Clock date string style and/or class
Constant CLOCK_DATE_FORMAT
CLOCK_DATE_FORMAT in clock-defs.php
Clock date format M=month no, m=month name, D=day no,
Constant CLOCK_TIME_CSS
CLOCK_TIME_CSS in clock-defs.php
Clock time string style and/or class
Method closefile
inputfile::closefile() in file-defs.php
Close the file
Method closefile
outputfile::closefile() in file-defs.php
Close the file. We move the temporary file that has been built to
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.
Method colcount
table::colcount() in html-defs.php
Return the number of cols in this table.
Function commit
commit() in query-defs.php
Commit a DB transaction
Method commit
database::commit() in database-defs.php
Commit the currently open database transaction.
Method commit
datasources::commit() in database-defs.php
Commit open database transaction
Constant COND_ALL
COND_ALL in monitor-defs.php
Aggregate: all conditions
Constant COND_CRITICAL
COND_CRITICAL in monitor-defs.php
Critical error condition
Constant COND_NONE
COND_NONE in monitor-defs.php
Aggregate: no conditions
Constant COND_OK
COND_OK in monitor-defs.php
Condition for a passed test
Constant COND_UNKNOWN
COND_UNKNOWN in monitor-defs.php
Condition is undefined
Constant COND_WARNING
COND_WARNING in monitor-defs.php
Warning condition
Class configfield
configfield in configuration-defs.php
* A Configuration field.
Method configfield
configfield::configfield() in configuration-defs.php
Constructor.
Class configfile
configfile in file-defs.php
A generic system configuration file. Extend this for particular types of config file, such as .INI, shell definitions etc. Automatically calls the import_settings() method on instantiation.
Method configfile
configfile::configfile() in file-defs.php
Class configuration
configuration in configuration-defs.php
Configuration This is for accessing generic configuration files which store useful crappola like GST rate, file paths etc. This object features dynamically creatable/deletable configuration fields.
Method configuration
configuration::configuration() in configuration-defs.php
Constructor Create a new configuration object. Sets basic field attributes.
Page configuration-defs.php
configuration-defs.php in configuration-defs.php
Method configurator
configurator::configurator() in configuration-defs.php
Constructor
Class configurator
configurator in configuration-defs.php
The configurator class is simply a descendant class of configuration which sets the parent class into 'autoconfigure' mode. In this mode the forms have buttons supplied, and the instantiation of the class automatically processes form POSTs.
Method connect
datasources::connect() in database-defs.php
Connects to the database which has been selected in the mode specified, or non-peristent otherwise.
Method connect
database::connect() in database-defs.php
This method must be defined in the child class.
Method connected
datasources::connected() in database-defs.php
Returns connected status of named database, or the currently selected one if no name given.
Page constants.php
constants.php in constants.php
Method constraints_match
dbfield::constraints_match() in schema-defs.php
Return true if field constraints match those passed in.
Method constraint_exists
schema::constraint_exists() in schema-defs.php
Returns true if named constraint exists.
Method contactinfo
Constructor Create a new contactinfo object.
Class contactinfo
contactinfo in pim-defs.php
The contactinfo class manages a single set of contact information which might be associated with a person or thing.
Method contact_details
Return a standard contact details set.
Method contains_fileuploadfield
Check if form contains file upload field Check all elements for presence of file upload field. This is mainly for internal use.
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
Method content_css
blocklet::content_css() in block-defs.php
Content style.
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
Method content_style
blocklet::content_style() in block-defs.php
Content style.
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 convert_boolean_syntax
Make conversions of boolean syntax found in the SQL string and return the 'standardised' SQL. This assumes that Axyl SQL will be written in the form 'WHERE foo=TRUE'.
Constant CP_VIEW_AUTH
CP_VIEW_AUTH in control-panel.php
View of authentication & security settings
Constant CP_VIEW_DB
CP_VIEW_DB in control-panel.php
View of database settings
Constant CP_VIEW_DEBUG
CP_VIEW_DEBUG in control-panel.php
View of debugging settings
Constant CP_VIEW_DEFAULT
CP_VIEW_DEFAULT in control-panel.php
Standard (default) view
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.
Method create
catalogitem::create() in catalog-defs.php
Create this catalog item from a media file on disk. The media item should be located at a physical path on disk somewhere. It will be grabbed, moved to a new location, and the item record saved to the DB.
Method create
lockfile::create() in lockfile-defs.php
Create the lockfile. We only do this, obviously, if it doesn't already exist. If it DOES exist, then we make a lot of checks. If time-limits are set we possibly try to kill the process and remove the lockfile before creating our new one.
Method create
dbtable::create() in schema-defs.php
Return the SQL which will create this table.
Method create
DB_dbindex::create() in pg-schema-defs.php
Return SQL required to create this index.
Method create
DB_dbfunction::create() in pg-schema-defs.php
Return SQL required to create this function.
Method create
dbtrigger::create() in schema-defs.php
Return SQL required to create this trigger.
Method create
DB_dbtable::create() in pg-schema-defs.php
Return the SQL which will create this Postgres table.
Method create
DB_dbtrigger::create() in pg-schema-defs.php
Return SQL required to create this trigger.
Method create
dbconstraint::create() in schema-defs.php
Return SQL required to create this constraint outside the table
Method create
DB_dbsequence::create() in pg-schema-defs.php
Return Postgres SQL required to create this sequence.
Method create
dbsequence::create() in schema-defs.php
Method create
dbindex::create() in schema-defs.php
Return SQL required to create this index.
Method create
dbfield::create() in schema-defs.php
Return SQL to create this field in a table. This represents a portion of the CREATE TABLE script pertaining to this field and it comprises field name, type, and constraints.
Method create
dbfunction::create() in schema-defs.php
Method create_constraints
Return SQL to create all constraints for this field..
Method create_constraints
DB_dbtable::create_constraints() in pg-schema-defs.php
Return the SQL which will create the constraints on this table.
Method create_indexes
DB_dbtable::create_indexes() in pg-schema-defs.php
Return the SQL which will create the indexes on this table.
Method create_inline
Return SQL required to create this as an inline table constraint
Method csv
table::csv() in html-defs.php
Render the table as a CSV formatted stream. This is designed to facilitate the exporting of complex tables of data as CSV format for importing into spreadsheets, or databases etc.
Method csv
block::csv() in block-defs.php
Render the block content as a CSV formatted stream. This is designed to facilitate the exporting of complex tables of data as CSV format for importing into spreadsheets, or databases etc.
Method csv
blocklet::csv() in block-defs.php
Render the blocklet as a CSV stream. We split the content types for this into 'table' and 'other'. For tables we use the "|" delimiter to determine where our commas go. For other content we basically just leave it as-is, only adding quotes.
Method csv
tablecell::csv() in html-defs.php
Return the CSV content for this cell.
Class csv_inputfile
csv_inputfile in file-defs.php
CSV Inputfile class Manage CSV-formatted files for input.
Method csv_inputfile
Constructor Open the given CSV formatted file for input.
Method current_sequencevalue
Return the current sequence value, given a sequence name, the table and the field it applies to.
Method current_sequencevalue
Get the current sequence value.
Method current_sequencevalue
Return the current sequence value, given a sequence name, the table and the field it applies to.
Constant CUSTOM_COMPRESSION
CUSTOM_COMPRESSION in response-defs.php
Webpage compression: Use custom Phplib compression. For Php < v4.04
d
top
Variable $data
dat_keyvalues::$data in data-defs.php
The array containing data in key=>value pairs
Variable $data
EmbeddedObject::$data in html-defs.php
URL of data object might require
Variable $database
datasources::$database in database-defs.php
An array of database objects. All databases we can use as datasources
Variable $database
maintainer::$database in maintainer-defs.php
The name of the database containing the table
Variable $database_server
schema::$database_server in schema-defs.php
Variable $database_version
schema::$database_version in schema-defs.php
Variable $datafname
outputfile::$datafname in file-defs.php
The full path to the file
Variable $datafname
inputfile::$datafname in file-defs.php
The full path to the file
Variable $datasource
response::$datasource in response-defs.php
Datasources associated with this response
Variable $datasrc_uri
metadata_scheme::$datasrc_uri in metadata-defs.php
URI of scheme data
Variable $datestyle
database::$datestyle in database-defs.php
The database internal date format/style
Variable $date_end
search::$date_end in search-defs.php
End date range for search (false means undefined). This
Variable $date_fieldname
search::$date_fieldname in search-defs.php
Name of the field to which daterange should be applied
Variable $date_format
digital_clock::$date_format in clock-defs.php
Date format eg. 'M d, ccyy' for 'April 4, 2005'
Variable $date_last_author
forum::$date_last_author in forum-defs.php
Variable $date_posted
thread_msg::$date_posted in forum-defs.php
Variable $date_posted
forum_thread::$date_posted in forum-defs.php
Variable $date_start
search::$date_start in search-defs.php
Start date range for search (false means undefined). This
Variable $dayname
Calendar::$dayname in calendar-defs.php
Variable $days
Calendar::$days in calendar-defs.php
Variable $daysinmonth
Calendar::$daysinmonth in calendar-defs.php
Variable $days_clickable
Calendar::$days_clickable in calendar-defs.php
Variable $dbid
database::$dbid in database-defs.php
Unique identifier for database access
Variable $dbid
postgres_monitor::$dbid in monitor-defs.php
Database connection resource ID
Variable $dbname
postgres_monitor::$dbname in monitor-defs.php
Name of the database to connect to
Variable $db_backed
session::$db_backed in session-defs.php
The type of this session
Variable $db_configuration_exists
configuration::$db_configuration_exists in configuration-defs.php
Whether the configuration exists in database or not
Variable $db_config_exists
configuration::$db_config_exists in configuration-defs.php
Whether config definition exists in database or not
Variable $db_name_default
datasources::$db_name_default in database-defs.php
Default database name
Variable $db_name_selected
datasources::$db_name_selected in database-defs.php
Name of currently selected database
Variable $DD
Calendar::$DD in calendar-defs.php
Variable $debugclass
webdebugger::$debugclass in debugger.php
Classes of debugging to accumulate
Variable $debugger
response::$debugger in response-defs.php
The debugger for this response
Variable $default
configfield::$default in configuration-defs.php
Variable $defaults
recmaintainer::$defaults in recmaint-defs.php
Field defaults for new records
Variable $defaultval
dbfield::$defaultval in schema-defs.php
Variable $default_value
The default value for this element
Variable $default_value
enc_qualifier::$default_value in metadata-defs.php
Default value of this qualifier
Variable $deferrable
dbconstraint::$deferrable in schema-defs.php
True if constraint is deferrable
Variable $deferred
dbconstraint::$deferred in schema-defs.php
True if constraint is initially deferred
Variable $definitions
application::$definitions in application-defs.php
Variable $deleted
story::$deleted in story-defs.php
Variable $delete_action
dbconstraint::$delete_action in schema-defs.php
Action to take on delete
Variable $desc
blocklet::$desc in block-defs.php
The description of the current blocklet
Variable $description
menuoption::$description in menu-defs.php
Menu option descriptive text
Variable $description
metadata_scheme::$description in metadata-defs.php
A description of the scheme
Variable $description
metadata_element::$description in metadata-defs.php
Element description, usage details
Variable $description
Description
Variable $destination_dir
Destination dir to put files
Variable $detail_tables
maintainer::$detail_tables in maintainer-defs.php
Array of detail tables. Master-detail relationship.
Variable $dir
inputfile::$dir in file-defs.php
The directory prefix (if any) of the file
Variable $dir
outputfile::$dir in file-defs.php
The directory prefix (if any) of the file
Variable $disabled
form_field::$disabled in form-defs.php
True if field is disabled
Variable $displaypw
user_self_registration::$displaypw in selfregistration-defs.php
Variable $display_order
Order of display
Variable $display_order
microsite_page::$display_order in microsite-defs.php
Order (for displaying menu lables)
Variable $display_order
enc_qualifier::$display_order in metadata-defs.php
Display order
Variable $display_order
blocklet::$display_order in block-defs.php
Display order of this blocklet
Variable $display_order
Order of display
Variable $display_properties
Clock display settings. An array of booleans.
Variable $docurl
DocumentObject::$docurl in html-defs.php
Variable $do_autosequence
maintainer::$do_autosequence in maintainer-defs.php
If true we auto-detect sequences for integer fields,
Variable $DTD
response::$DTD in response-defs.php
Array of DTD specifiers for this response. @see set_dtd()
Variable $DTD
head::$DTD in webpage-defs.php
The Document Type Definition for this head section
Page data-defs.php
data-defs.php in data-defs.php
Class database
database in database-defs.php
Define a database. This is a parent class to all of the supported
Method database
database::database() in database-defs.php
Constructor
Page database-defs.php
database-defs.php in database-defs.php
Class datasources
datasources in database-defs.php
Datasources A datasources class is just a bunch of databases. If you want to access a database, register it in here first, then you can select it to perform queries on later.
Method datasources
datasources::datasources() in database-defs.php
Constructor
Class data_meta_tag
data_meta_tag in metadata-defs.php
A class which encapsulates a meta tag which itself contains particular information, which may be in a specified language, and may have been picked from a defined vocabulary/encoding scheme.
Method data_meta_tag
data_meta_tag::data_meta_tag() in metadata-defs.php
Constructor
Page datetime-defs.php
datetime-defs.php in datetime-defs.php
Function datetime_to_displaydate
datetime_to_displaydate() in datetime-defs.php
Conversion: datetime to descriptive Convert a database-compatible datetime string into a descriptive date/time format for the user display, using the given displayformat string.
Function datetime_to_timestamp
datetime_to_timestamp() in datetime-defs.php
Conversion: datetime to descriptive Returns a timestamp from a database-formatted datetime string.
Class dat_keyvalues
dat_keyvalues in data-defs.php
Dat_keyvalues
Method dat_keyvalues
Constructor
Function dayNameNow
dayNameNow() in datetime-defs.php
Day of Week now as string Returns the day name (eg. "Monday") as it is now.
Function dayNow
dayNow() in datetime-defs.php
Day of Month now as integer Returns the day of the month (1-31) as it is now.
Function daysinmonth
daysinmonth() in datetime-defs.php
Return the days in a month Given an integer month number 1-12, and an optional year (defaults to current) this function returns the number of days in the given month.
Constant DAY_AND_DATE
DAY_AND_DATE in datetime-defs.php
Example: Friday, 20th July 2001
Page db-mssql-server.php
db-mssql-server.php in db-mssql-server.php
Page db-mysql.php
db-mysql.php in db-mysql.php
Page db-odbc.php
db-odbc.php in db-odbc.php
Page db-oracle.php
db-oracle.php in db-oracle.php
Page db-postgres.php
db-postgres.php in db-postgres.php
Function dbcommand
dbcommand() in query-defs.php
Execute a DB command
Method dbconstraint
dbconstraint::dbconstraint() in schema-defs.php
Class dbconstraint
dbconstraint in schema-defs.php
Defines a database constraint.
Class dbdelete
dbdelete in query-defs.php
DB Delete class A special case of the dbquery class. This is for deleting rows from the database.
Method dbdelete
dbdelete::dbdelete() in query-defs.php
Constructor Create a new DB Delete object.
Method dbfield
dbfield::dbfield() in schema-defs.php
Class dbfield
dbfield in schema-defs.php
Class describing a database field of a table.
Class dbfunction
dbfunction in schema-defs.php
Defines a database function (procedure).
Method dbfunction
dbfunction::dbfunction() in schema-defs.php
Constant DBG_ALL
DBG_ALL in debugger.php
Everything. Warning, this can be VERBOSE!
Constant DBG_AUTH
DBG_AUTH in debugger.php
Show site authentication output
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
Method dbid
datasources::dbid() in database-defs.php
Returns the database resource ID of the given database name.
Class dbindex
dbindex in schema-defs.php
Defines a database index.
Method dbindex
dbindex::dbindex() in schema-defs.php
Class dbinsert
dbinsert in query-defs.php
DB Insert class A special case of the dbtablemod class.
Method dbinsert
dbinsert::dbinsert() in query-defs.php
Constructor Create a new DB Insert object. This is for inserting a record into the database.
Method dbquery
dbquery::dbquery() in query-defs.php
Constructor Create a new DB Query object.
Class dbquery
dbquery in query-defs.php
DB Query class This class is the one which executes queries against the connected database.
Class dbrecords
dbrecords in query-defs.php
DB Records class Renders a query into data and allows access to the data either directly or via the usual get first,last,next,previous cursor navigation.
Method dbrecords
dbrecords::dbrecords() in query-defs.php
Constructor Create a new DB Records object.
Function dbrecordset
dbrecordset() in query-defs.php
A wrapper which caters for queries which will return a record set identifier for returning data.
Class dbrows
dbrows in query-defs.php
DB Rows class Renders a query into data and allows access to the data either directly or via the usual get first,last,next,previous cursor navigation.
Method dbrows
dbrows::dbrows() in query-defs.php
Constructor Create a new DB Rows object.
Page dbsearch-defs.php
dbsearch-defs.php in dbsearch-defs.php
Method dbselect
dbselect::dbselect() in query-defs.php
Constructor Create a new DB Select object. This is for selecting rows from the database, and returning fields from those rows.
Class dbselect
dbselect in query-defs.php
DB Select class A special case of the dbrecords class.
Class dbseq
dbseq in query-defs.php
DB seq class A class which allows the management and use of sequences.
Method dbseq
dbseq::dbseq() in query-defs.php
Create a new object to manage a sequence, optionally specifying the sequence name..
Method dbsequence
dbsequence::dbsequence() in schema-defs.php
Class dbsequence
dbsequence in schema-defs.php
Defines a database sequence.
Method dbtable
dbtable::dbtable() in schema-defs.php
Construct a table of given name and array of primary key fields.
Class dbtable
dbtable in schema-defs.php
Class describing a database table.
Class dbtablemod
dbtablemod in query-defs.php
DB tablemod class Parent class for classes which only modify a single table. This means either update or inserts. This class is provided so we can define a common method for sequence definition.
Method dbtablemod
dbtablemod::dbtablemod() in query-defs.php
Constructor Create a new DB Insert object. This is for inserting a record into the database.
Class dbtrigger
dbtrigger in schema-defs.php
Defines a database trigger.
Method dbtrigger
dbtrigger::dbtrigger() in schema-defs.php
Method dbtype
datasources::dbtype() in database-defs.php
Returns the database type of the given database name.
Class dbupdate
dbupdate in query-defs.php
DB Update class A special case of the dbquery class. This is for updating data in particular rows in the database.
Method dbupdate
dbupdate::dbupdate() in query-defs.php
Constructor Create a new DB Select object.
Method DB_dbconstraint
Class DB_dbconstraint
DB_dbconstraint in pg-schema-defs.php
Defines a database constraint.
Class DB_dbfield
DB_dbfield in pg-schema-defs.php
Class describing a database field of a Postgres table.
Method DB_dbfield
DB_dbfield::DB_dbfield() in pg-schema-defs.php
Method DB_dbfunction
DB_dbfunction::DB_dbfunction() in pg-schema-defs.php
Class DB_dbfunction
DB_dbfunction in pg-schema-defs.php
Defines a database function (procedure).
Class DB_dbindex
DB_dbindex in pg-schema-defs.php
Defines a database index.
Method DB_dbindex
DB_dbindex::DB_dbindex() in pg-schema-defs.php
Class DB_dbsequence
DB_dbsequence in pg-schema-defs.php
Defines a database sequence.
Method DB_dbsequence
DB_dbsequence::DB_dbsequence() in pg-schema-defs.php
Class DB_dbtable
DB_dbtable in pg-schema-defs.php
Class describing a Postgres database table. Inherits the standard dbtable class properties and methods, but adds in the getschema specifics for acquiring Postgres table info from the metadata, and provides a specific create() method.
Method DB_dbtable
DB_dbtable::DB_dbtable() in pg-schema-defs.php
Construct a table of given name and array of primary key fields.
Class DB_dbtrigger
DB_dbtrigger in pg-schema-defs.php
Defines a database trigger.
Method DB_dbtrigger
DB_dbtrigger::DB_dbtrigger() in pg-schema-defs.php
Class DB_schema
DB_schema in pg-schema-defs.php
Class describing a Postgres database schema.
Method DB_schema
DB_schema::DB_schema() in pg-schema-defs.php
Create a schema (database) of given name & type. The name should be a valid existing database name that is currently connected.
Class db_search
db_search in dbsearch-defs.php
DB Search class This class inherits the functionality of the generic 'search' class. It extends it to implement a database search.
Method db_search
db_search::db_search() in dbsearch-defs.php
Constructor
Method db_value_from_bool
database::db_value_from_bool() in database-defs.php
Return a suitable database field value to contain the value for the given boolean.
Function db_value_from_bool
db_value_from_bool() in query-defs.php
Return boolean data compatible with the current DB, from boolean. This is to provide for boolean compatibility across all DBs.
Method db_value_from_bool
Return a suitable database field value to contain the value for the given boolean.
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..
Method debug_class
Set debug class(es) to accept
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.
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).
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).
Method deck
deck::deck() in webpage-defs.php
Constructor Create a new deck object.
Function defaulted
defaulted() in utils.php
Return a value which may be defaulted Returns the value of the variable, if it is valid, otherwise returns the specified default value.
Method defaultvalue
configfield::defaultvalue() in configuration-defs.php
Return the default field value
Constant DEFAULT_AGENT
DEFAULT_AGENT in user-defs.php
The default agent ID
Constant DEFAULT_AUTHOR_GROUPS
DEFAULT_AUTHOR_GROUPS in block-defs.php
Default Author group membership
Constant DEFAULT_DATASOURCE
DEFAULT_DATASOURCE in database-defs.php
Default datasource for queries @see add_database()
Constant DEFAULT_EDITOR_GROUPS
DEFAULT_EDITOR_GROUPS in block-defs.php
Default Editor group membership
Constant DEFAULT_ENTRY_GROUPS
DEFAULT_ENTRY_GROUPS in block-defs.php
Default Entry group membership
Constant DEFAULT_FIELD
DEFAULT_FIELD in lucene-defs.php
The name of the field Lucene should assume if none specified
Constant DEFAULT_FIELDTYPE
DEFAULT_FIELDTYPE in lucene-defs.php
Default type of field: 'Text', 'Date', 'Id'
Method define_field
Define a field. We supply the name of the field, it's type (Text, Date or Id), and whether it should be stored by Lucene for later retreival in queries. For example you would not store the raw document/content as this is usually stored elsewhere.
Method define_field
fileindexer::define_field() in search-fileindex-defs.php
Define a field. We supply the name of the field, it's type (Text, Date or Id), and whether it should be stored by the search engine for later retreival in queries. For example you would not store the raw document/content as this is usually stored elsewhere.
Method define_field
searchengine_message::define_field() in search-lucene-defs.php
Define a field. We supply the name of the field, it's type (Text, Date or Id), and whether it should be stored by SearchEngine for later retreival in queries. For example you would not store the raw document/content as this is usually stored elsewhere.
Method definition_form
Render a definition form for this metadata element as HTML. This is a self-contained table, and it has all of the element details, and fields for setting the content, language, and scheme. It is not enclosed in a form.
Method definition_form
Render this scheme as HTML. This produces a table containing the
Method delete
keep::delete() in keep-defs.php
Delete registered variables.
Method delete
microsite_page::delete() in microsite-defs.php
Delete this page from the database. We also delete all other records associated with this page, and do not rely on RI.
Method delete
microsite_template::delete() in microsite-defs.php
Delete the current microsite template, from the database.
Method delete
microsite::delete() in microsite-defs.php
Delete this microsite from the database. We do not rely on RI to delete all of the associated records, since the database in use might not support it.
Method delete
menumaintainer::delete() in menumaint-defs.php
Delete this menu from the database.
Method delete
layout::delete() in layout-defs.php
Delete the hosted layout from the database. Afterwards, the current object still exists as it was before this method was executed, but the $this->layout->exists flag will have been reset to false.
Method delete
menuoption::delete() in menu-defs.php
Delete the menuoption.
Method delete
configuration::delete() in configuration-defs.php
Delete the whole config.
Method delete
catalogitem::delete() in catalog-defs.php
Remove the catalog item from the database and disk. This method normally tries to remove the physical file first, and if that succeeds it removes the database record. If $deletefile is false then the file will be left and only the DB record deleted.
Method delete
contactinfo::delete() in pim-defs.php
Delete the contactinfo.
Method delete
blockeditor::delete() in block-editor-defs.php
Delete this block from the database. NB: we do not rely on RI to do this since various versions of Postgres don't support this nicely.
Method delete
blocklet::delete() in block-defs.php
Delete the blocklet.
Method delete
block::delete() in block-defs.php
Delete this block from the database. NB: we do not rely on RI to do this since various versions of Postgres don't support this nicely.
Method delete
layouteditor::delete() in layout-editor-defs.php
Delete the hosted layout from the database. Afterwards, the current object still exists as it was before this method was executed, but the $this->layout->exists flag will have been reset to false.
Method delete
organisation::delete() in pim-defs.php
Delete the organisation.
Method delete_cols
table::delete_cols() in html-defs.php
Remove a column from all rows in the table
Method delete_cookie
session::delete_cookie() in session-defs.php
Delete session cookie Deletes the session cookie from the user's browser.
Method delete_forum
forum::delete_forum() in forum-defs.php
Method delete_row
table::delete_row() in html-defs.php
Remove a row from the table. If the template cell is not provided then a 'vanilla' cell is used.
Method delete_story
story::delete_story() in story-defs.php
Remove the story from the system. We actually just flag it as deleted on the database, and keep the record.
Method delparameter
application::delparameter() 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 delparameter
setting::delparameter() in application-defs.php
Delete the given parameter from this setting.
Method detail_table
maintainer::detail_table() in maintainer-defs.php
Associates a detail table with the maintained table. This defines
Method diff
schema::diff() in schema-defs.php
Produce the SQL required to morph the schema described in the passed dbschema object $db, into the schema we have in this current object.
Constant DIGEST
DIGEST in mail-defs.php
A digest of multiple attachments
Class digital_clock
digital_clock in clock-defs.php
The digital_clock class. This is implemented as a 'layer' or 'div'
Method digital_clock
Constructor for the clock
Method disable_autocomplete
Disable the autocomplete form functionality of the browser for this field. Browsers have, mainly for password fields, been offering auto-completion of contents. This function will stop this from being done, in browsers which obey the "autocomplete='off'" attribute.
Method disable_autosequence
maintainer::disable_autosequence() in maintainer-defs.php
Specify that the maintainer should not auto-detect sequences which
Method disable_forum
forum::disable_forum() in forum-defs.php
disable the forum from showing
Method discard
webstream::discard() in webpage-defs.php
Discard all webpage content For discarding the content so far with immediate effect.
Method disconnect
datasources::disconnect() in database-defs.php
Disconnect the currently selected database.
Method disconnect
database::disconnect() in database-defs.php
This method must be defined in the child class.
Class diskspace_monitor
diskspace_monitor in monitor-defs.php
Class which checks for a disk free space condition.
Method diskspace_monitor
Function displaydate_to_date
displaydate_to_date() in datetime-defs.php
Conversion: descriptive to datetime without the time element.
Function displaydate_to_datetime
displaydate_to_datetime() in datetime-defs.php
Conversion: descriptive to datetime.
Function displaydate_to_timestamp
displaydate_to_timestamp() in datetime-defs.php
Conversion: descriptive to timestamp.
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 DISPLAY_24_HOURS
DISPLAY_24_HOURS in clock-defs.php
Clock display hours (am/pm)
Constant DISPLAY_DATE
DISPLAY_DATE in clock-defs.php
Show date or not
Constant DISPLAY_DATE_FIRST
DISPLAY_DATE_FIRST in clock-defs.php
Show the date first
Constant DISPLAY_DATE_FORMAT
DISPLAY_DATE_FORMAT in datetime-defs.php
Example: 31/12/1999 23:59
Constant DISPLAY_DATE_ONLY
DISPLAY_DATE_ONLY in datetime-defs.php
Example: 31/12/1999
Constant DISPLAY_DAYNAME
DISPLAY_DAYNAME in clock-defs.php
Show day name or not
Method display_disabled
Cause the maintainer to be displayed initially diabled. All form fields which are part of the maintainer will be readonly/disabled.
Constant DISPLAY_INLINE
DISPLAY_INLINE in clock-defs.php
Show date and time on one line
Method display_in_webpage
Xmenu::display_in_webpage() in xmenu-defs.php
Display in webpage Inserts the javascript necessary to embed the menu into a given webpage.
Method display_in_webpage
HVmenu::display_in_webpage() in hvmenu-defs.php
Display in webpage Inserts the javascript necessary to embed the menu into a given webpage.
Method display_msg
thread_msg::display_msg() in forum-defs.php
Constant DISPLAY_ONLY
DISPLAY_ONLY in form-defs.php
Form field is readonly/display only
Constant DISPLAY_SECONDS
DISPLAY_SECONDS in clock-defs.php
Display to seconds or mins
Constant DISPLAY_TIMESTAMP_FORMAT
DISPLAY_TIMESTAMP_FORMAT in datetime-defs.php
Example: 31/12/1999 23:59:59
Constant DISPLAY_TIME_ONLY
DISPLAY_TIME_ONLY in datetime-defs.php
Example: 23:59
Class DocumentObject
DocumentObject in html-defs.php
Document Object
Method DocumentObject
Constructor
Constant DOCUMENT_MIMES
DOCUMENT_MIMES in mime-types.php
Method does_not_match
search::does_not_match() in search-defs.php
Define a search term which the search must not match to succeed.
Method does_not_matchfield
Add search term: must not match a field value.
Method does_not_matchfield
Add search term: must not match a field value.
Constant DOW_HHMM
DOW_HHMM in datetime-defs.php
Example: Sun 23:59
Method drop
dbfield::drop() in schema-defs.php
Return the SQL to drop this field.
Method drop
dbconstraint::drop() in schema-defs.php
Method drop
DB_dbfunction::drop() in pg-schema-defs.php
Return SQL to drop this function.
Method drop
DB_dbindex::drop() in pg-schema-defs.php
Method drop
dbfunction::drop() in schema-defs.php
Method drop
dbindex::drop() in schema-defs.php
Method drop
dbtable::drop() in schema-defs.php
Return the SQL to drop this table.
Method drop
dbsequence::drop() in schema-defs.php
Method drop
dbtrigger::drop() in schema-defs.php
Method dropcolumn
dbtable::dropcolumn() in schema-defs.php
Return SQL to drop a column from the table. The $column passed is actually a field object.
Method dump
dbfunction::dump() in schema-defs.php
Dump ascii description of this function to stdout.
Method dump
dbconstraint::dump() in schema-defs.php
Dump ascii description of this constraint to stdout.
Method dump
DB_dbfield::dump() in pg-schema-defs.php
Dump field description to stdout.
Method dump
contactinfo::dump() in pim-defs.php
A diagnostic dump of the class variables for debugging purposes.
Method dump
dbfield::dump() in schema-defs.php
Dump field description to stdout.
Method dump
dbindex::dump() in schema-defs.php
Dump ascii description of this index to stdout.
Method dump
dbtrigger::dump() in schema-defs.php
Dump ascii description of this trigger to stdout.
Method dump
dbtable::dump() in schema-defs.php
Dump the table description to stdout.
Method dump
dbsequence::dump() in schema-defs.php
Method dump
schema::dump() in schema-defs.php
Dump this entire schema description to stdout.
e
top
Variable $eachrow
dbtrigger::$eachrow in schema-defs.php
If true, execute func for EACH ROW else EACH STATEMENT
Variable $editable
form_field::$editable in form-defs.php
True if field is NOT readonly
Variable $editable_cells
layout::$editable_cells in layout-defs.php
Array of layout cells with edit permission
Variable $editor_groups
block::$editor_groups in block-defs.php
The group membership for Editor privilege
Variable $editor_groups
layout::$editor_groups in layout-defs.php
The group membership for Editor privilege
Variable $edit_blocks
layout::$edit_blocks in layout-defs.php
Array of layout blocks in edit mode
Variable $edit_menuop_id
menumaintainer::$edit_menuop_id in menumaint-defs.php
The ID of the current menuoption being edited, if any
Variable $edit_parent_id
menumaintainer::$edit_parent_id in menumaint-defs.php
The parent ID of the menu-options being edited
Variable $elements
form::$elements in form-defs.php
Elements array. Contains form elements
Variable $element_id
metadata_element::$element_id in metadata-defs.php
The element ID for this item
Variable $element_name
metadata_element::$element_name in metadata-defs.php
The base name of this element
Variable $elewidth_pct
form::$elewidth_pct in form-defs.php
Width taken by element (RHS) side of the form in %
Variable $email
user_self_registration::$email in selfregistration-defs.php
Variable $email
user::$email in user-defs.php
User e-mail address
Variable $emailfrom
monitor::$emailfrom in monitor-defs.php
Address monitor messages come from
Variable $emailpager
monitor::$emailpager in monitor-defs.php
Address to email SMS txt messages
Variable $emails
contactinfo::$emails in pim-defs.php
emails
Variable $emailto
monitor::$emailto in monitor-defs.php
Address to email monitor messages
Variable $email_condition_threshold
Threshold condition for emailing
Variable $email_headers
email::$email_headers in mail-defs.php
All e-mail headers end up here, apart from To: This
Variable $embed_obj
If set, contains a EmbeddedObject_Compat object to
Variable $emit_status
monitor::$emit_status in monitor-defs.php
Whether to emit a status message to stdout. If true the monitor will emit the current status, plus the message associated with the highest priority (most severe) condition in the monitor. Format will be: 'CRITICAL: some message goes here'.
Variable $enabled
forum::$enabled in forum-defs.php
Variable $enabled
organisation::$enabled in pim-defs.php
Whether organisation is enabled
Variable $enabled
forum_thread::$enabled in forum-defs.php
Variable $enabled
thread_msg::$enabled in forum-defs.php
Variable $enabled
user_self_registration::$enabled in selfregistration-defs.php
Variable $enabled
lucene_connection::$enabled in lucene-defs.php
Whether Lucene is enabled..
Variable $enabled
microsite_page::$enabled in microsite-defs.php
Whether this page is to be published
Variable $enabled
webdebugger::$enabled in debugger.php
Status of the debugger
Variable $enabled
searchengine_connection::$enabled in search-lucene-defs.php
Whether SearchEngine is enabled..
Variable $enabled
user::$enabled in user-defs.php
True of user is active/enabled
Variable $enc
database::$enc in database-defs.php
The database character encoding
Variable $encode_with
xmltag::$encode_with in xml-defs.php
If "cdata", we use CDATA to encode the value string
Variable $enctype
maintainer::$enctype in maintainer-defs.php
Maintainers form encoding type
Variable $enctype
form::$enctype in form-defs.php
Encoding type
Variable $enc_scheme_id
The encoding scheme/vocabulary used to pick the tag content
Variable $enc_scheme_name
Name of this encoding scheme
Variable $enc_scheme_tag
The tag used to identify the encoding scheme used
Variable $endyear
Calendar::$endyear in calendar-defs.php
Variable $entry_groups
layout::$entry_groups in layout-defs.php
The group membership for Entry privilege
Variable $entry_groups
block::$entry_groups in block-defs.php
The group membership for Entry privilege
Variable $errcode
fileupload::$errcode in file-defs.php
Error code. Check to see if error occurred.
Variable $errmsg
catalogitem::$errmsg in catalog-defs.php
Variable $errmsg
fileupload::$errmsg in file-defs.php
Error message array, goes with errcode.
Variable $errmsgs
microsite::$errmsgs in microsite-defs.php
An array of error messages to report
Variable $errorcode
lockfile::$errorcode in lockfile-defs.php
Latest error code
Variable $errors
email::$errors in mail-defs.php
Accumulated errors
Variable $error_message
session::$error_message in session-defs.php
Error condition message if any
Variable $error_message
Error message string if any
Variable $error_msg
thread_msg::$error_msg in forum-defs.php
Variable $error_msg
searchengine_msg::$error_msg in search-lucene-defs.php
Error message if any error occurred
Variable $error_msg
user_self_registration::$error_msg in selfregistration-defs.php
Variable $error_msg
lucene_msg::$error_msg in lucene-defs.php
Error message if any error occurred
Variable $error_msg
forum::$error_msg in forum-defs.php
Variable $execparms
exec_monitor::$execparms in monitor-defs.php
Variable $execpath
exec_monitor::$execpath in monitor-defs.php
Variable $executable_sql
database::$executable_sql in database-defs.php
The SQL statement last executed on this database. This
Variable $executed
search::$executed in search-defs.php
Whether we have run a query
Variable $exists
lockfile::$exists in lockfile-defs.php
True if the lockfile exists
Variable $exists
menumaintainer::$exists in menumaint-defs.php
Whether this menu exists in the database
Variable $exists
layout::$exists in layout-defs.php
Whether the layout exists in database or not
Variable $exists
blocklet::$exists in block-defs.php
Whether blocklet exists in database
Variable $exists
Xmenu::$exists in xmenu-defs.php
Whether this menu exists in the database
Variable $exists
treemenu::$exists in treemenu-defs.php
Whether this menu exists in the database
Variable $exists
organisation::$exists in pim-defs.php
Whether organisation exists in database
Variable $exists
menuoption::$exists in menu-defs.php
Whether menuoption exists in database
Variable $exists
contactinfo::$exists in pim-defs.php
Whether contactinfo exists in database
Variable $exists
microsite::$exists in microsite-defs.php
Whether this microsite exists in database
Variable $exists
block::$exists in block-defs.php
Whether the block exists in database or not
Variable $expandimage
treemenu::$expandimage in treemenu-defs.php
Image to use for collapsed sub-menu
Variable $expiry_date
story::$expiry_date in story-defs.php
Variable $expiry_date_ts
story::$expiry_date_ts in story-defs.php
Variable $exportable
block::$exportable in block-defs.php
If true, then an EXPORT button will be provided for CSV dump
Variable $extn_mimetype
MIMETYPE of file by using its extension
Variable $extra_headers
email::$extra_headers in mail-defs.php
Extra ad-hoc e-mail headers added from external
Constant EDITABLE
EDITABLE in form-defs.php
Form element is editable (ie. not readonly)
Method editform
story::editform() in story-defs.php
Render the story details as an edit form.
Method edit_msg
thread_msg::edit_msg() in forum-defs.php
Method email
email::email() in mail-defs.php
Constructor Creates the basic email object.
Class email
email in mail-defs.php
email class A class which encapsulates all the functions required to compose and send an e-mail message. Also caters for MIME attachments.
Function emailthem
emailthem() in mail-defs.php
Function to send an email using the simple Php mail() call. This is a very simplistic wrapper which is kept for its cuteness, but for no other reason than that.
Constant EMAIL_BULK_LIMIT
EMAIL_BULK_LIMIT in mail-defs.php
Limit to the number of e-mails to send in one sitting.
Class embed
embed in html-defs.php
Deprecated embed Object (HTML3.2) This object supports the older embed tag used to embed objects into HTML pages. for backward compatibility. In reality there is still a lot of mileage left in this tag.
Method embed
embed::embed() in html-defs.php
Constructor
Class EmbeddedObject
EmbeddedObject in html-defs.php
Object
Method EmbeddedObject
Constructor
Constant EMPTY_CELL
EMPTY_CELL in block-defs.php
Layout cell content: empty
Method enable_forum
forum::enable_forum() in forum-defs.php
enable the forum so it's visible again
Method enable_response_timer
Set the response timer up. Set it ticking.
Constant ENC_BASE64
ENC_BASE64 in mail-defs.php
Base-64 Encoding
Constant ENC_BIT7
ENC_BIT7 in mail-defs.php
7-bit Encoding
Method enc_qualifier
enc_qualifier::enc_qualifier() in metadata-defs.php
Constructor
Class enc_qualifier
enc_qualifier in metadata-defs.php
A class which encapsulates a scheme qualifier. A qualifier is an attribute which is used in a metadata tag to qualify or refine it.
Constant ENC_QUOTP
ENC_QUOTP in mail-defs.php
Quoted-Printable Encoding
Function entryField
entryField() in control-panel.php
Method eof
inputfile::eof() in file-defs.php
Return true if at end-of-file or not opened, else false.
Method eof
dbrows::eof() in query-defs.php
Return the EOF (end-of-file) indicator for this query. Returns true if no more results can be returned with get_next(), ie. we are at the end of the results set.
Function errorcode_exit
errorcode_exit() in utils.php
Exit with HTTP error code Send a simple error code and then die.
Method errormessage
database::errormessage() in database-defs.php
This method must be defined in the child class.
Method errormessage
datasources::errormessage() in database-defs.php
Return the last error message.
Method errormsg
lockfile::errormsg() in lockfile-defs.php
Return any lockfile error message
Function error_exit
error_exit() in utils.php
Exit the application with error message Echo the message and leave. Intended to handle 'emergencies'.
Method error_message
email::error_message() in mail-defs.php
Return error messages. These may have accumulated during the email assembly or during the send process.
Method error_message
Return any error message(s).
Class error_page
error_page in webpage-defs.php
The error page class Allows us to render errors as either HTML or WML.
Method error_page
error_page::error_page() in webpage-defs.php
Constructor Create a new error page object.
Method escape_string
database::escape_string() in database-defs.php
This method may be over-ridden in the child class. The default is to apply a rather simplistic SQL-standard transformation of single quote to doubled-up single-quote ' --> ''.
Method escape_string
datasources::escape_string() in database-defs.php
Used to escape particular characters (typically the single quote) so that they can form part of the database data, rather than being interpreted as command syntax.
Function escape_string
escape_string() in query-defs.php
Escape a string according to the requirements of the current DB.
Method execute
lucene_search::execute() in lucene-defs.php
Execute the search Here we execute a lucene search, overriding the method in the parent class. This involves building the query string, sending it to the Lucene server, and receiving the search results back.
Method execute
searchengine_search::execute() in search-query-defs.php
Execute the search Here we execute a SearchEngine search, overriding the method in the parent class. This involves building the query string, sending it to the SearchEngine server, and receiving the search results back.
Method execute
db_search::execute() in dbsearch-defs.php
Execute the search Execute the database query search and store any hits.
Method execute
searchengine_purger::execute() in search-utility-defs.php
Make SearchEngine purge the index.
Method execute
searchengine_unindexer::execute() in search-index-defs.php
Unindex the given document, as identified by the unique ID. If no errors arise, then the item will be removed from the SearchEngine index.
Method execute
searchengine_indexer::execute() in search-index-defs.php
Make SearchEngine execute the indexing funtion for the document.
Method execute
dbrows::execute() in query-defs.php
Execute query Execute this query. We override the parent method here simply to ensure we are positioned at the first row.
Method execute
swish_search::execute() in swish-defs.php
Execute the swish++ search
Method execute
searchengine_utilitycmd::execute() in search-utility-defs.php
Make SearchEngine execute the given utility command.
Method execute
dbquery::execute() in query-defs.php
Exceute the query If we have an SQL phrase, execute it now. We store the result in this->valid, and also return it. If a transaction is open, update the status.
Method exec_monitor
exec_monitor::exec_monitor() in monitor-defs.php
Define a new exec check object.
Class exec_monitor
exec_monitor in monitor-defs.php
A monitor class to exec a script/program on the OS. This allows you
Method expanded_content
Process the current blocklet content for special tags. This effectively expands the special tags into 'real' content from database, or as image references etc. We return the expanded content as a string.
Method extra_header
email::extra_header() in mail-defs.php
Generic method to add an extra header. This method is now preferred over the depreceted 'add_header()' method above. We store our headers in an associative array, keyed on the proper-cased header name.
f
top
Variable $fieldname
fileupload::$fieldname in file-defs.php
Upload field name
Variable $fieldnames
dbindex::$fieldnames in schema-defs.php
Fieldnames in the index
Variable $fieldnames
dbconstraint::$fieldnames in schema-defs.php
Array of table field names in constraint
Variable $fieldnums
DB_dbconstraint::$fieldnums in pg-schema-defs.php
Field positions for fields constraint applies to
Variable $fieldnums
DB_dbindex::$fieldnums in pg-schema-defs.php
Field numbers of fields in index
Variable $fields
hit::$fields in search-defs.php
Array of fieldname/value pairs - info returned by the search
Variable $fields
dbtable::$fields in schema-defs.php
Array of field objects
Variable $fields
WMLfieldset::$fields in wml-defs.php
Array of fields
Variable $fields
recmaintainer::$fields in recmaint-defs.php
Internal array of field names being maintained
Variable $fields
configuration::$fields in configuration-defs.php
Array of configfield objects for the config
Variable $fields
sqlquery::$fields in query-defs.php
List of fields in the query
Variable $fieldschanged
configuration::$fieldschanged in configuration-defs.php
Whether field definitions have changed or not
Variable $fieldset
lucene_msg::$fieldset in lucene-defs.php
Object containing lucene fields
Variable $fieldset
searchengine_msg::$fieldset in search-lucene-defs.php
Object containing SearchEngine fields
Variable $fields_total
Total number of fields
Variable $field_definitions
fileindexer::$field_definitions in search-fileindex-defs.php
Index fields definitions array. Contains definitions
Variable $fileexists
catalogitem::$fileexists in catalog-defs.php
Variable $filename
fileupload::$filename in file-defs.php
Original filename
Variable $filepath
fileupload::$filepath in file-defs.php
Upload path to the file on the server
Variable $filepath
catalogitem::$filepath in catalog-defs.php
Variable $filepath
file_monitor::$filepath in monitor-defs.php
Path to the file to monitor
Variable $filesize
fileupload::$filesize in file-defs.php
Physical size of the file (bytes)
Variable $filesize
inputfile::$filesize in file-defs.php
Size of opened file in bytes
Variable $filesize
catalogitem::$filesize in catalog-defs.php
Variable $filetype
outputfile::$filetype in file-defs.php
Type of file 'text' or 'templated'
Variable $first_name
user::$first_name in user-defs.php
First name of the person
Variable $fk_fieldnames
dbconstraint::$fk_fieldnames in schema-defs.php
Array of referenced foreign key fieldnames
Variable $fk_fieldnums
DB_dbconstraint::$fk_fieldnums in pg-schema-defs.php
Field positions for fields FK constraint refers to
Variable $fk_table
DB_dbconstraint::$fk_table in pg-schema-defs.php
Table (object) constraint refers to
Variable $fk_tablename
dbconstraint::$fk_tablename in schema-defs.php
Foreign key table name constraint refers to
Variable $font
Link::$font in button-defs.php
Font settings for link text
Variable $fontnames
htmlarea_config::$fontnames in htmlarea-defs.php
The list of font families to allow user to choose from
Variable $fontsizes
htmlarea_config::$fontsizes in htmlarea-defs.php
The list of font sizes to allow user to choose from
Variable $foot
webpage::$foot in webpage-defs.php
Webpage foot object
Variable $force_readonly
form::$force_readonly in form-defs.php
Whether to force forma elements to be read-only
Variable $force_rebuild
Xmenu::$force_rebuild in xmenu-defs.php
Whether to force rebuild or not
Variable $format
form_textfield::$format in form-defs.php
Format specifier (WML)
Variable $format_last_modified
The format string for last modified datetime
Variable $formname
recmaintainer::$formname in recmaint-defs.php
Name of the form containing maintained fields
Variable $formname
microsite::$formname in microsite-defs.php
The name of our form
Variable $formname
The form this widget is to be displayed in
Variable $formname
Calendar::$formname in calendar-defs.php
Variable $formname
story::$formname in story-defs.php
Variable $formname
Standard form name to use
Variable $formname
maintainer::$formname in maintainer-defs.php
Name of form we will be using
Variable $formname
menumaintainer::$formname in menumaint-defs.php
The name of our form
Variable $formtype
maintainer::$formtype in maintainer-defs.php
Type of form we will be using: either "form" or "subform"
Variable $form_mode
configuration::$form_mode in configuration-defs.php
Mode to display the configuration in a form
Variable $forumemail
user_self_registration::$forumemail in selfregistration-defs.php
Variable $forumfor
user_self_registration::$forumfor in selfregistration-defs.php
Variable $forum_desc
forum::$forum_desc in forum-defs.php
Variable $forum_id
forum::$forum_id in forum-defs.php
Variable $forum_id
forum_thread::$forum_id in forum-defs.php
Variable $forum_id
thread_msg::$forum_id in forum-defs.php
Variable $forum_members
forum::$forum_members in forum-defs.php
Variable $forum_moderator
Variable $forum_name
forum::$forum_name in forum-defs.php
Variable $forum_threads
forum::$forum_threads in forum-defs.php
Variable $forum_title
forum::$forum_title in forum-defs.php
Variable $fp
outputfile::$fp in file-defs.php
File pointer
Variable $fp
inputfile::$fp in file-defs.php
The file pointer
Variable $freezefilename
lockfile::$freezefilename in lockfile-defs.php
Name of freeze lockfile to create (internal)
Variable $freezesecs
lockfile::$freezesecs in lockfile-defs.php
Lockfile age at which we should stop trying to kill hung process
Variable $from
email::$from in mail-defs.php
e-mail From address
Variable $frozen
lockfile::$frozen in lockfile-defs.php
True if the freeze lockfile exists
Variable $fsdir
diskspace_monitor::$fsdir in monitor-defs.php
Directory to check
Variable $fullPage
htmlarea_config::$fullPage in htmlarea-defs.php
if true then HTMLArea will retrieve the full HTML, starting
Variable $full_name
user_self_registration::$full_name in selfregistration-defs.php
Variable $funcname
dbtrigger::$funcname in schema-defs.php
Name of function to call when triggered
Variable $functions
schema::$functions in schema-defs.php
Method fetch_array
datasources::fetch_array() in database-defs.php
Return the specified row, as an associative array of fields in a fieldname => value format.
Method fetch_array
database::fetch_array() in database-defs.php
This method must be defined in the child class.
Method fetch_row
database::fetch_row() in database-defs.php
This method must be defined in the child class.
Method fetch_row
datasources::fetch_row() in database-defs.php
Return the specified row, as a standard (enumerated) array of field values.
Method field
dbrecords::field() in query-defs.php
Get field content Return the field content from the current database array (row).
Method fieldlist
sqlquery::fieldlist() in query-defs.php
Define field list
Method fieldlist
db_search::fieldlist() in dbsearch-defs.php
Define search fields list
Method fields
dbconstraint::fields() in schema-defs.php
Constant FIELDS_ONLY
FIELDS_ONLY in schema-defs.php
Run getschema() to get only current table fields (no recursion)
Method field_count
configuration::field_count() in configuration-defs.php
Return fields present count.
Method field_create
configuration::field_create() in configuration-defs.php
Create a new field for all configurations This retro-fits all sets of this config with the new field, and will assign the default value to each one.
Constant FIELD_DELIM
FIELD_DELIM in constants.php
Field delimiter used in record structures
Method field_exists
dbrecords::field_exists() in query-defs.php
Return whether the name field exists in the resultset, true or false.
Method field_exists
configuration::field_exists() in configuration-defs.php
Check if field exists
Method field_remove
configuration::field_remove() in configuration-defs.php
Remove a field from all sets of this config.
Page file-defs.php
file-defs.php in file-defs.php
Method fileindexer
fileindexer::fileindexer() in search-fileindex-defs.php
Constructor
Class fileindexer
fileindexer in search-fileindex-defs.php
The file indexer class.
Class fileupload
fileupload in file-defs.php
Fileupload class.
Method fileupload
fileupload::fileupload() in file-defs.php
Constructor. On instantiation this class checks the global variable space for uploaded file info and pre-processes it.
Function file_get_contents
file_get_contents() in file-defs.php
Finally got around to implementing this file content reader for backward compatibility. (Kudos to Nigel McNie). This function file_get_contents will return the entire file as a string.
Class file_monitor
file_monitor in monitor-defs.php
A monitor class to check when files/directories were last modified.
Method file_monitor
file_monitor::file_monitor() in monitor-defs.php
Define a new file check object.
Method fk_fields
dbconstraint::fk_fields() in schema-defs.php
Method FlashObject
Constructor
Class FlashObject
FlashObject in html-defs.php
Macromedia Shockwave/Flash Object
Constant FLASH_CLSID
FLASH_CLSID in html-defs.php
Macromedia Flash Windows CLASS ID
Constant FLASH_CODEBASE
FLASH_CODEBASE in html-defs.php
Macromedia Flash Codebase - where to download the player
Constant FLASH_MIMES
FLASH_MIMES in mime-types.php
Constant FLASH_MIMETYPE
FLASH_MIMETYPE in html-defs.php
Macromedia Flash MimeType
Constant FLASH_PLUGINSPAGE
FLASH_PLUGINSPAGE in html-defs.php
Macromedia Flash Plugins plage - support for other platforms
Method flushbuffer
outputfile::flushbuffer() in file-defs.php
Flush any buffered content to the stream.
Class foot
foot in webpage-defs.php
The foot class
Method foot
foot::foot() in webpage-defs.php
Constructor Create a new foot object.
Method force_readonly
form::force_readonly() in form-defs.php
Force all of the contained fields to be rendered read-only
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 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 forgetall
keep::forgetall() in keep-defs.php
Unset all registered variables.
Class form
form in form-defs.php
Form class
Method form
form::form() in form-defs.php
Constructor Create a form object. Sets basic form attributes.
Page form-defs.php
form-defs.php in form-defs.php
Method formatted_microsecs
Return the micro-seconds on the clock to 2 decimal places.
Method formatted_millisecs
Return the milli-seconds on the clock to 2 decimal places.
Method formatted_secs
Return the seconds on the clock to 2 decimal places.
Method formatted_time
Return the time on the clock in a nice 'human' format. This is in the form of a string, viz: '14d 2h 12m 13s'.
Method format_content
blocklet::format_content() in block-defs.php
Format Content.
Function format_DMY
format_DMY() in datetime-defs.php
Format date as DD/MM/YYYY
Function format_name
format_name() in utils.php
Returns the name in the form SURNAME, Firstname.
Function format_tag_name
format_tag_name() in metadata-defs.php
Function to format a tag name which might have multiple parents.
Constant FORM_AUTHENTICATION
FORM_AUTHENTICATION in response-defs.php
Authentication option: Username/password from custom form fields
Method form_buttonfield
Constructor Create a field object. Sets basic field attributes.
Class form_buttonfield
form_buttonfield in form-defs.php
Button Field class This virtual class generates a standard form button field. This is a virtual class, used to provide a basis for real buttons. Do not instantiate this as an object - use the descendants instead.
Method form_checkbox
Constructor Create a field object. Sets basic field attributes.
Class form_checkbox
form_checkbox in form-defs.php
Checkbox Field class A field which renders a checkbox form element.
Method form_combofield
Constructor Create a field object. Sets basic field attributes.
Class form_combofield
form_combofield in form-defs.php
Combo Field class A field for producing combo boxes (dropdown select menus) or multi-line list-boxes, either of which may be single-select or multiple select.
Method form_displayonlyfield
Constructor Create a disply-only field object. Sets basic field attributes.
Class form_displayonlyfield
form_displayonlyfield in form-defs.php
Displayonly Field class Extends the textfield class. This class renders a textfield as text rather than a textbox control. The form value is still submitted, but as a hidden field in the form..
Method form_field
form_field::form_field() in form-defs.php
Constructor Create a field object. Sets basic field attributes.
Class form_field
form_field in form-defs.php
Form Field class Abstract field class, for deriving various form field types.
Class form_fileuploadfield
form_fileuploadfield in form-defs.php
File Upload Field class A field for uploading files to the webserver. If used with a 'form' object, the form will be automatically rendered with the proper encoding type by setting the 'enctype' in the form tag.
Method form_fileuploadfield
Constructor Create a field object. Sets basic field attributes.
Method form_hiddenfield
Constructor Create a hidden field object. Sets basic field attributes.
Class form_hiddenfield
form_hiddenfield in form-defs.php
Hidden Field class This class generates a hidden field.
Class form_imagebutton
form_imagebutton in form-defs.php
Image Button class This class generates a standard form image button field.
Method form_imagebutton
Constructor Create a field object. Sets basic field attributes.
Method form_imagecombo
Constructor Create a field object. Sets basic field attributes.
Class form_imagecombo
form_imagecombo in form-defs.php
Image Combo class
Method form_imagefield
Constructor Create a field object. Sets basic field attributes.
Class form_imagefield
form_imagefield in form-defs.php
Image Field class This is a hybrid field. It is basically a text field where the value is expected to be the location of an image, either a real path to a file or a URI.
Method form_jumpmenu
Constructor Create a field object. Sets basic field attributes.
Class form_jumpmenu
form_jumpmenu in form-defs.php
Jumpmenu Field class A special case of combofield where we define key/value data made up of display-value and URL pairs.
Method form_labelfield
Constructor Create a label field object. Sets basic field attributes.
Class form_labelfield
form_labelfield in form-defs.php
Label Field class This is just to display a bare value where the form element would normally be, and where we dont want to use a form_textfield in non-editable mode because we don't want the hidden field..
Class form_memofield
form_memofield in form-defs.php
Memo Field class A field which renders a textarea form element. These are used to allow people to input large tracts of text by typing or copy/paste.
Method form_memofield
Constructor Create a field object. Sets basic field attributes.
Class form_passwordfield
form_passwordfield in form-defs.php
Password Field class Password field element. Same as textfield, but masks user input.
Method form_passwordfield
Constructor Create a field object. Sets basic field attributes.
Class form_radiobutton
form_radiobutton in form-defs.php
Radio Button Field class A field which renders a radio form element.
Method form_radiobutton
Constructor Create a field object. Sets basic field attributes.
Class form_radiogroup
form_radiogroup in form-defs.php
Radio Group Field class A field which groups a set of radio form elements together.
Method form_radiogroup
Constructor Create a field object. Sets basic field attributes.
Class form_resetbutton
form_resetbutton in form-defs.php
Reset Button class This class generates a standard form reset button field.
Method form_resetbutton
Constructor Create a field object. Sets basic field attributes.
Method form_submitbutton
Constructor Create a field object. Sets basic field attributes.
Class form_submitbutton
form_submitbutton in form-defs.php
Submit Button class This class generates a standard form submit button field.
Class form_tandemfield
form_tandemfield in form-defs.php
Tandem Field class
Method form_tandemfield
Constructor Create a field object. Sets basic field attributes.
Class form_textfield
form_textfield in form-defs.php
Text Field class. This class generates a text field.
Method form_textfield
Constructor Create a field object. Sets basic field attributes.
Method form_wysiwygfield
Constructor - create a wysiwyg form element..
Class form_wysiwygfield
form_wysiwygfield in htmlarea-defs.php
Wysiwyg Field class A field which renders a textarea form element as a Wysiwyg editor.
Class forum
forum in forum-defs.php
The forum class.
Method forum
forum::forum() in forum-defs.php
Page forum-defs.php
forum-defs.php in forum-defs.php
Method forum_thread
Class forum_thread
forum_thread in forum-defs.php
The forum thread class.
Method freeresult
database::freeresult() in database-defs.php
This method must be defined in the child class.
Method freeresult
datasources::freeresult() in database-defs.php
Free the result of a query
Function friendlyName
friendlyName() in mail-defs.php
Make a 'friendly' name from a full one. Good for "Dear... ,"
Method friendlyName
user::friendlyName() in user-defs.php
Get friendly name
Method from
db_search::from() in dbsearch-defs.php
Define search table FROM list
Method From
email::From() in mail-defs.php
Set from Set the e-mail From: e-mail addresses.
Method from
sqlquery::from() in query-defs.php
Define table FROM list
Constant F_CHECKBOX
F_CHECKBOX in form-defs.php
Tickbox or checkbox
Constant F_COMBO
F_COMBO in form-defs.php
Dropdown menu or listbox field
Constant F_DATETIME
F_DATETIME in form-defs.php
Date/time field
Constant F_IMAGE
F_IMAGE in form-defs.php
Text field containing image URL
Constant F_MEMO
F_MEMO in form-defs.php
Textarea memo field
Constant F_RADIO
F_RADIO in form-defs.php
Radio button
Constant F_TEXT
F_TEXT in form-defs.php
General text field
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 $go
WMLanchor::$go in wml-defs.php
Go object associated with this link
Variable $gotinfo
metadata_element::$gotinfo in metadata-defs.php
Whether info has been already got
Variable $gotschemes
metadata_element::$gotschemes in metadata-defs.php
Whether schemes have been already got
Variable $groupby
sqlquery::$groupby in query-defs.php
The GROUP BY clause
Variable $groups
table::$groups in html-defs.php
Array containing table groups
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
Variable $gutter_colour
block::$gutter_colour in block-defs.php
Colour of inter-column gutter
Variable $gutter_width
block::$gutter_width in block-defs.php
Width of inter-column gutter in pixels
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 generate_password
user::generate_password() in user-defs.php
Generate a new password. Although we take note of whether the user is local or remote, in general we don't expect to be generating passwords for remotely maintained users.
Method generic_type
DB_dbfield::generic_type() in pg-schema-defs.php
Return the generic type of the field. The generic types are as
Method generic_type
dbfield::generic_type() in schema-defs.php
Return the generic type of the field. The generic types are as
Method get
microsite_page::get() in microsite-defs.php
Get the microsite page details from the databse.
Method get
microsite_template::get() in microsite-defs.php
Get the current microsite template, as identified by the ID, from the database.
Method get
microsite::get() in microsite-defs.php
Get the microsite Retrieves the specified microsite from database. If it doesn't exist then we create a new one.
Method get
organisation::get() in pim-defs.php
Get the organisation.
Method get
layout::get() in layout-defs.php
Get the layout.
Method get
contactinfo::get() in pim-defs.php
Retrieves the specified contactinfo from database.
Method get
metadata_scheme::get() in metadata-defs.php
Get the data for this scheme.
Method get
layout_metadata_elements::get() in metadata-defs.php
Get all of the metadata elements associated with this layout. We can
Method get
blocklet::get() in block-defs.php
Get the blocklet.
Method get
block::get() in block-defs.php
Get the block.
Method get
metadata_element::get() in metadata-defs.php
Get all the relevant data for this metadata element.
Method get
menuoption::get() in menu-defs.php
Get the menuoption.
Method get
enc_qualifier::get() in metadata-defs.php
Get the data for this qualifier.
Method get
menumaintainer::get() in menumaint-defs.php
Get the menu Retrieves the specified menu from database. If it doesn't exist then we create a new one.
Method get
configuration::get() in configuration-defs.php
Get the configuration set.
Method get
catalogitem::get() in catalog-defs.php
Get current or nominated catalog item definition from the database.
Method getconstraint
schema::getconstraint() in schema-defs.php
Returns constraint object of given name
Method getfield
dbtable::getfield() in schema-defs.php
Returns field object of given name
Method getfieldbynum
dbtable::getfieldbynum() in schema-defs.php
Returns field object of given attnum (order number)
Method getfieldnum
dbtable::getfieldnum() in schema-defs.php
Returns field number of given field name
Method getfunction
schema::getfunction() in schema-defs.php
Returns function object of given name
Method getfunctions
DB_schema::getfunctions() in pg-schema-defs.php
Populates our array of functions with all user functions in this schema.
Method getindex
schema::getindex() in schema-defs.php
Returns index object of given name
Method getitem
dat_keyvalues::getitem() in data-defs.php
Return item value
Method getitemindex
Find ordinal array index Finds the ordinal array index of the element with key $key.
Method getkeyfieldnames
dbtable::getkeyfieldnames() in schema-defs.php
Returns list of names of keyfields as array
Method getlabelfield
dbtable::getlabelfield() in schema-defs.php
Returns a candidate label field name according to some fairly simple heuristics. This would be a field suitable for displaying in a listbox which is somewhat more informative than a keyfield. If nothing is found then the key is used as fallback.
Method getmenu
sitemenu::getmenu() in menu-defs.php
Get the menu Read the menuitems in from database and apply security..
Method getnonkeyfieldnames
Returns list of names of non-keyfields as array
Method getorderfield
dbtable::getorderfield() in schema-defs.php
Returns a candidate ordering field name according to some fairly simple heuristics. If nothing is found then a labelfield is used as fallback.
Method getparameter
setting::getparameter() in application-defs.php
Get the value of a named parameter.
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 getschema
dbtrigger::getschema() in schema-defs.php
Acquires the schema from database metadata.
Method getschema
dbindex::getschema() in schema-defs.php
Acquires the schema from database metadata.
Method getschema
dbfunction::getschema() in schema-defs.php
Acquires the schema from database metadata.
Method getschema
schema::getschema() in schema-defs.php
Acquire all of the schema details.
Method getschema
DB_dbtrigger::getschema() in pg-schema-defs.php
Obtain trigger schema information.
Method getschema
DB_dbtable::getschema() in pg-schema-defs.php
Acquires the table fields and constraints which apply to it.
Method getschema
DB_dbfunction::getschema() in pg-schema-defs.php
Obtain function schema information.
Method getschema
DB_dbconstraint::getschema() in pg-schema-defs.php
Obtain constraint schema information.
Method getschema
dbconstraint::getschema() in schema-defs.php
Acquires the schema from database metadata.
Method getschema
DB_dbsequence::getschema() in pg-schema-defs.php
Get schema info for sequence
Method getschema
dbtable::getschema() in schema-defs.php
Acquires the schema from database metadata.
Method getschema
dbsequence::getschema() in schema-defs.php
Acquires the schema from database metadata.
Method getschema
DB_dbindex::getschema() in pg-schema-defs.php
Obtain index schema information.
Method getschema_table
DB_schema::getschema_table() in pg-schema-defs.php
Acquire the schema details of a specific Postgres table. This method is provided to cater for the common requirement of acquiring details for a specific table, without having to endure the overhead of reading all of the database schema metadata to get it.
Method getschema_table
schema::getschema_table() in schema-defs.php
Acquire the schema details of a specific database table. This method is provided to cater for the common requirement of acquiring details for a specific table, without having to endure the overhead of reading all of the database schema metadata to get it.
Method getsequence
schema::getsequence() in schema-defs.php
Returns seqeuence object of given name
Method getsequences
schema::getsequences() in schema-defs.php
Populates schema sequences.
Method getsequences
DB_schema::getsequences() in pg-schema-defs.php
Populates our array of sequences with all user sequences in this schema.
Method getsettingix
application::getsettingix() in application-defs.php
Return the index number of the named setting.
Method gettable
schema::gettable() in schema-defs.php
Returns table object of given name
Method gettables
schema::gettables() in schema-defs.php
Populates schema tables.
Method gettables
DB_schema::gettables() in pg-schema-defs.php
Populates our array of tables with all tables in this schema.
Method gettrigger
schema::gettrigger() in schema-defs.php
Returns trigger object of given name
Method gettriggers
schema::gettriggers() in schema-defs.php
Populates schema triggers.
Method gettriggers
DB_schema::gettriggers() in pg-schema-defs.php
Populates our array of triggers with all user triggers in this schema.
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 getvalue
configfile::getvalue() in file-defs.php
Return value of named setting, if it exists..
Method getversion
DB_schema::getversion() in pg-schema-defs.php
Acquire the Postgres database version. We make some gross assumptions here with regard to standard local Postgres setup. Change as necessary.
Method getversion
schema::getversion() in schema-defs.php
Acquire the database version.
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_catalogitem
Define this story media object from the given catalog item key. This will obtain the given piece of catalog media from the database and assign the object variables accordingly.
Method get_catalogitem_by_filepath
Find a catalogitem by filepath. Just trawls the array of catalog items in this catalog comparing filepaths. Returns false if not found else a copy of the catalogitem object.
Method get_cell
table::get_cell() in html-defs.php
Return the given cell from this group
Method get_current
fileupload::get_current() in file-defs.php
Acquire the details on the current upload file. This includes the
Method get_current
dbrows::get_current() in query-defs.php
Get current row If current query is invalid, try to execute it first, then do a get_first(). If query is then valid, return the current row.
Function get_current_sequencevalue
get_current_sequencevalue() in query-defs.php
A wrapper to get the current sequence value from a named sequence..
Method get_DB_datetime
Calendar::get_DB_datetime() in calendar-defs.php
Return the currently stored calendar date as a string which will be formatted so as to go into a database field nicely. This normally means ISO format (YYYY-MM-DD).
Method get_DDstr
Calendar::get_DDstr() in calendar-defs.php
Return the currently stored day-date as a two-digit string
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.
Function get_dirlist
get_dirlist() in file-defs.php
Returns an array containing full paths to the files in the directory
Method get_displaydate
Calendar::get_displaydate() in calendar-defs.php
Return the currently stored calendar date as a string in a given date format (see Axyl datetime-defs.php for pre-defined formats).
Function get_DMY
get_DMY() in datetime-defs.php
Get date components of datetime string Returns the date components of a formatted date string.
Function get_easter_holidays
get_easter_holidays() in holiday-defs.php
Get the days of Easter for the given year (defaults to current year)
Function get_file_extn
get_file_extn() in file-defs.php
Return the file extension from a filepath.
Function get_file_stem
get_file_stem() in file-defs.php
Return the file stem (name without extn) from a filepath.
Method get_first
dbrows::get_first() in query-defs.php
Get current row If current query is invalid, try to execute it first, then do a get_first(). If query is then valid, return the current row.
Method get_first
fileupload::get_first() in file-defs.php
Acquire the details on the first upload file.
Method get_forum
forum::get_forum() in forum-defs.php
Function get_full_tag_name
get_full_tag_name() in metadata-defs.php
Function to acquire the full tag name including descendants, given the tag name, and the parent element ID of that tag.
Method get_groups
user::get_groups() in user-defs.php
Get user groups info
Function get_HMS
get_HMS() in datetime-defs.php
Get time components of datetime string Extract the HH:MM[:SS] from datetime string Returns the time components of a formatted date string.
Method get_info
microsite_page::get_info() in microsite-defs.php
Get the associated details for this page, from the database. This includes the template(s) associated with the page, and also the menuoption_id linking to the associated menu option record.
Method get_info
metadata_element::get_info() in metadata-defs.php
Get all the info which are associated with this metadata element.
Method get_last
fileupload::get_last() in file-defs.php
Get details on the last file which was uploaded. If there are no more, then this function returns false.
Method get_last
dbrows::get_last() in query-defs.php
Get last row If current query is invalid, try to execute it first, then get the last row from the resultset.
Method get_last_sql
datasources::get_last_sql() in database-defs.php
Returns SQL statement most recently executed on the current DB.
Method get_metadata_element
Return a metadata element, given its element_id.
Method get_MMstr
Calendar::get_MMstr() in calendar-defs.php
Return the currently stored month as a two-digit string
Method get_msg
thread_msg::get_msg() in forum-defs.php
Method get_next
dbrows::get_next() in query-defs.php
Get next row If current query is invalid, try to execute it first, then get the next row from the resultset.
Method get_next
fileupload::get_next() in file-defs.php
Get details on the next file which was uploaded. If there are no more, then this function returns false.
Function get_next_sequencevalue
get_next_sequencevalue() in query-defs.php
A wrapper to get the next sequence value from a named sequence..
Function get_nth_day_of_month
get_nth_day_of_month() in holiday-defs.php
Return the timestamp of the date for the Nth dayname in the given month. Returns -1 if error encountered.
Method get_previous
Get details on the previous file which was uploaded. If there are no more, then this function returns false.
Method get_previous
dbrows::get_previous() in query-defs.php
Get previous row If current query is invalid, try to execute it first, then get the previous row from the resultset.
Function get_recmaintfield
get_recmaintfield() in recmaint-defs.php
Utility function. Returns the value of the named field. Returns the value of the named field which is in the data array $rec. Uses the array $fields to determine the position of the named field in the data record.
Method get_row
table::get_row() in html-defs.php
Return a given row from the table.
Method get_row
dbrows::get_row() in query-defs.php
Get row Return the given database row from the resultset. Uses the get_row_raw() method applicable to this class.
Method get_schemes
metadata_element::get_schemes() in metadata-defs.php
Get all the schemes which are associated with this metadata element.
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_story
story::get_story() in story-defs.php
Get a story in total. We always access stories by their ID.
Method get_styles
treemenu::get_styles() in treemenu-defs.php
Obtain the non-standard styles from the stylesheet
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_thread
forum_thread::get_thread() in forum-defs.php
Method get_threads
forum::get_threads() in forum-defs.php
Method get_thread_header
Method get_timestamp
Calendar::get_timestamp() in calendar-defs.php
Return the current calendar date as a timestamp. This will return the timestamp at 00:00:00 (hh:mm:ss) ie. at the beginning of that day.
Method get_translation
story::get_translation() in story-defs.php
Returns the story_id of a translation of the current story in the
Method get_trimcontent
Return content, if not null or newline.
Method get_user
user_self_registration::get_user() in selfregistration-defs.php
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 get_width_profile
Get the width profile from the table.
Method get_YYstr
Calendar::get_YYstr() in calendar-defs.php
Return the currently stored year as a two-digit string
Constant GIGABYTE
GIGABYTE in constants.php
Gigabytes
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
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.
Class globals
globals in globals-defs.php
A class to handle globalisation of specific variables. This class
Page globals-defs.php
globals-defs.php in globals-defs.php
Method groupby
sqlquery::groupby() in query-defs.php
Define group by field list The fields can be an array, or a delimited list. If the latter, then default delimiter is a comma, unless you specify your own.
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 $hasdata
dbquery::$hasdata in query-defs.php
True if data was returned, after execute
Variable $hasfiles
fileupload::$hasfiles in file-defs.php
True if some files were uploaded
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 $has_expiry
story::$has_expiry in story-defs.php
Variable $has_media
story::$has_media in story-defs.php
Variable $has_multilang
story::$has_multilang in story-defs.php
Variable $has_multimedia
story::$has_multimedia in story-defs.php
Variable $has_precis
story::$has_precis in story-defs.php
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 $heading
tablecell::$heading in html-defs.php
Whether this is a heading cell
Variable $heading
blocklet::$heading in block-defs.php
blocklet heading
Variable $heading_colour
blocklet::$heading_colour in block-defs.php
Heading colour
Variable $heading_item_spacing
treemenu::$heading_item_spacing in treemenu-defs.php
Padding before (above) menu options which are
Variable $heading_level
blocklet::$heading_level in block-defs.php
blocklet heading level (1-6)
Variable $height
htmlarea_config::$height in htmlarea-defs.php
Height of HTMLarea element (default 'auto')
Variable $height
menuoption::$height in menu-defs.php
Height of option in pixels
Variable $height
HTMLObject::$height in html-defs.php
Height of the object
Variable $height
image::$height in image-defs.php
Height of image in pixels
Variable $height
catalogitem::$height in catalog-defs.php
Variable $height
story_media::$height in story-defs.php
Local override height
Variable $hidden
embed::$hidden in html-defs.php
If true the object is hidden
Variable $hidden
MediaObject::$hidden in html-defs.php
If true the media object is hidden
Variable $hidden_buttons
maintainer::$hidden_buttons in maintainer-defs.php
Variable $HighBgColor
treemenu::$HighBgColor in treemenu-defs.php
Colour of highlighted top menu item background
Variable $HighColor
treemenu::$HighColor in treemenu-defs.php
Colour of highlighted top menu item text
Variable $highlightclass
anchor::$highlightclass in html-defs.php
Stylesheet class name for highlighted link
Variable $highlightclass
menu::$highlightclass in menu-defs.php
Stylesheet class to use for highlighting
Variable $highlightclass
Link::$highlightclass in button-defs.php
Stylesheet class name for highlighted link
Variable $highlighted
menuitem::$highlighted in menu-defs.php
True if menu item is highlighted
Variable $hit
search::$hit in search-defs.php
Array of hits returned. Each element of this array is
Variable $hits
searchengine_monitor::$hits in monitor-defs.php
Expected no. of hits
Variable $hols
holidays::$hols in holiday-defs.php
Variable $honorific_prefix
user::$honorific_prefix in user-defs.php
Honorific prefix Eg. 'Mr.', 'Ms.', 'Mrs.' etc.
Variable $host
searchengine_monitor::$host in monitor-defs.php
Search engine host
Variable $host
postgres_monitor::$host in monitor-defs.php
For TCP connections: hostname to connect to
Variable $host
searchengine_connection::$host in search-lucene-defs.php
HOST running the SearchEngine query server
Variable $host
database::$host in database-defs.php
Host server of this database
Variable $host
lucene_connection::$host in lucene-defs.php
HOST running the Lucene query server
Variable $host
fileindexer::$host in search-fileindex-defs.php
Host to connect to
Variable $hostname
monitor::$hostname in monitor-defs.php
Local hostname we are running monitor on
Variable $host_abbrev
Search engine host abbreviation
Variable $hover
hover_button::$hover in button-defs.php
The hover image associated with the button
Variable $href
WMLgo::$href in wml-defs.php
URL to GO to
Variable $href
anchor::$href in html-defs.php
URL that clicking the link goes to
Variable $href
Link::$href in button-defs.php
The URL to go to when link is clicked
Variable $hspace
image::$hspace in image-defs.php
Padding at image sides in pixels
Variable $hspace
HTMLObject::$hspace in html-defs.php
Horizontal space around object (pixels)
Variable $htmlareaPaste
htmlarea_config::$htmlareaPaste in htmlarea-defs.php
intercept ^V and use the HTMLArea paste command
Variable $htmlRemoveTags
HTML tags to disallow (these have to be a regexp, or null
Variable $http_host
response::$http_host in response-defs.php
The host of this website ie. 'foo.thingy.co.nz'
Method hasdata
dat_keyvalues::hasdata() in data-defs.php
Returns status of data.
Function hasSQL
hasSQL() in antihack.php
Filters out potential hacking
Method has_daterange
search::has_daterange() in search-defs.php
Return true if at least one of our dates is set.
Method head
head::head() in webpage-defs.php
Constructor Create a new head object.
Class head
head in webpage-defs.php
The head class.
Constant HIDDEN
HIDDEN in html-defs.php
Used to hide the object control
Method hide_statusbar
maintainer::hide_statusbar() in maintainer-defs.php
Specify whether the maintainer should show its status bar or not.
Method highlight
Link::highlight() in button-defs.php
Defines special highlight class name
Method highlight
anchor::highlight() in html-defs.php
Defines special highlight class name
Method hit
hit::hit() in search-defs.php
Constructor Create a new search hit.
Class hit
hit in search-defs.php
The search hit class Something to contain a search hit which is defined as an array of information. The format of this array is entirely up to the search being performed, and is not enforced here.
Method hitcount
search::hitcount() in search-defs.php
Return count of hits present in this search.
Page holiday-defs.php
holiday-defs.php in holiday-defs.php
Method holidays
holidays::holidays() in holiday-defs.php
Constructor. Optionally pass in an associative array with the key of a unique holiday description, and value as the timestamp of the holiday itself.
Class holidays
holidays in holiday-defs.php
A class to handle a list of public holidays. It allows you to add holidays in various ways, and also to query whether a particular date-time falls on a holiday.
Constant HORIZONTAL
HORIZONTAL in menu-defs.php
Menu orientation set to horizontal
Class hover
hover in image-defs.php
Hover class Provides and image which changes to a second image when the mouse is over the top of it, using onmouseover and onmouseout events.
Method hover
hover::hover() in image-defs.php
Constructor Creates the hover object.
Method hover_button
hover_button::hover_button() in button-defs.php
Constructor
Class hover_button
hover_button in button-defs.php
Hover button.
Method hr
hr::hr() in html-defs.php
Constructor
Class hr
hr in html-defs.php
[HR] - Horizontal Rule
Function href_addparm
href_addparm() in utils.php
Add a parameter keyvalue pair to a URL. We check that it isn't already there, and use the right delimiter.
Function href_delparm
href_delparm() in utils.php
Remove a parameter keyvalue pair from a URL.
Function href_rewrite
href_rewrite() in wml-defs.php
Re-writes the given HREF, appending session ID if found. Appends the
Method html
named_layout::html() in layout-defs.php
Return HTML for this named layout.
Method html
treemenu::html() in treemenu-defs.php
Render the menu as HTML. Please note that the TreeMenu is by design a VERTICAL menu system, so don't expect the 'orientation' style in the stylesheet to have any effect for this class.
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
maintainer::html() in maintainer-defs.php
Render the maintainer as HTML. Use the render() method rather than directly calling this method.
Method html
body::html() in webpage-defs.php
This renders the body as HTML.
Method html
story::html() in story-defs.php
Render the story. We render the story as a table within a form containing all the form elements required to manipulate the story content, email it to someone, save it, and delete it etc...
Method html
deck::html() in webpage-defs.php
This renders the body as HTML.
Method html
menu::html() in menu-defs.php
This renders the field as HTML.
Method html
microsite::html() in microsite-defs.php
Render the block content according to the mode of operation we are in. Possible modes: 'viewing', 'editing', 'saving'.
Method html
metadata_element::html() in metadata-defs.php
Render this metadata element as HTML.
Method html
page_section::html() in plugin-defs.php
This renders the page section as HTML.
Method html
organisation::html() in pim-defs.php
Display organisation subform via the render() method.
Method html
pages::html() in paging-defs.php
Deliver HTML format page
Method html
contactinfo::html() in pim-defs.php
Display Contactinfo subform via the render() method.
Method html
Render all of the elements as HTML
Method html
menumaintainer::html() in menumaint-defs.php
Render the block content according to the mode of operation we are in. Possible modes: 'viewing', 'editing', 'saving'.
Method html
head::html() in webpage-defs.php
This renders the head as HTML. After the title and the meta tags
Method html
rowmenu::html() in rowmenu-defs.php
Render the menu 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
menuitem::html() in menu-defs.php
This renders the field as HTML.
Method html
layout::html() in layout-defs.php
Render the block content according to the mode of operation we are in. Possible modes: 'viewing', 'editing', 'saving'.
Method html
recmaintainer::html() in recmaint-defs.php
Return the HTML for this maintainer. This consists of Javascript objects to contain the data, and hidden form fields which will be used to POST changes etc. This should be rendered inside your main form element.
Method html
user_self_registration::html() in selfregistration-defs.php
Method html
tablecell::html() in html-defs.php
Return the HTML for this cell. Cell content can be displayed as either standard text, or as a form-field. The latter case is only possible if the cell has had permissions defined, and the logged-in user is found to be permitted UPDATE access to the cell.
Method html
form_checkbox::html() in form-defs.php
This renders the field as HTML.
Method html
form_combofield::html() in form-defs.php
This renders the field as HTML.
Method html
form_buttonfield::html() in form-defs.php
Renders the form button as HTML.
Method html
form::html() in form-defs.php
This renders the form as HTML, including the form tags and every form element in the form.
Method html
configuration::html() in configuration-defs.php
Render this configuration.
Method html
webdebugger::html() in debugger.php
Use render() to render the debugger output.
Method html
Use render() to render this element in your page.
Method html
This renders the field as HTML.
Method html
form_jumpmenu::html() in form-defs.php
This renders the field as HTML.
Method html
form_labelfield::html() in form-defs.php
This renders the field as HTML.
Method html
form_imagefield::html() in form-defs.php
This renders the field as HTML.
Method html
form_imagecombo::html() in form-defs.php
This renders the field as HTML. Note that because of the special nature of this widget, we need to know the name of the form it is in to do the previewing. Without it, no preview image is displayed.
Method html
form_hiddenfield::html() in form-defs.php
This renders the field as HTML.
Method html
form_imagebutton::html() in form-defs.php
This renders the image button as HTML. If we have onclick then we render
Method html
digital_clock::html() in clock-defs.php
Render the clock.
Method html
catalogitem::html() in catalog-defs.php
Render the catalog item. We render it as either and icon or a link, both being clickable to view the content.
Method html
blocklet::html() in block-defs.php
Render the blocklet.
Method html
button::html() in button-defs.php
Use render() to render this element in your page.
Method html
block::html() in block-defs.php
Render the block content according to the mode of operation we are in. Possible modes: 'viewing', 'editing', 'saving'.
Method html
WMLgo::html() in wml-defs.php
Return HTML content Use render() to render this element in your page.
Method html
WMLrefresh::html() in wml-defs.php
Return HTML content Use render() to render this element in your page.
Method html
WMLprev::html() in wml-defs.php
Return HTML content Use render() to render this element in your page.
Method html
hover_button::html() in button-defs.php
Use render() to render this element in your page.
Method html
image_button::html() in button-defs.php
Use render() to render this element in your page.
Method html
Calendar::html() in calendar-defs.php
Return the calendar HTML
Method html
catalog::html() in catalog-defs.php
Return the HTML for this catalog. Returns the list of catalog items as an HTML table.
Method html
submit_button::html() in button-defs.php
Use render() to render this element in your page.
Method html
reset_button::html() in button-defs.php
Use render() to render this element in your page.
Method html
Link::html() in button-defs.php
Use render() to render this element in your page.
Method html
form_memofield::html() in form-defs.php
This renders the field as HTML.
Method html
form_radiobutton::html() in form-defs.php
This renders the field as HTML.
Method html
foot::html() in webpage-defs.php
This renders the foot as HTML.
Method html
WMLcard::html() in wml-defs.php
Return HTML content Use render() to render this element in your page.
Method html
table::html() in html-defs.php
Render the whole table as HTML If dedbugging mode is enabled and the DBG_TABLES flag is set, then we run a simple validation check, and report findings, as well as making sure the table borders are visible.
Method html
MediaObject::html() in html-defs.php
Render the HTML
Method html
HTMLtag::html() in html-defs.php
Method html
img::html() in html-defs.php
Render as HTML
Method html
form_wysiwygfield::html() in htmlarea-defs.php
This renders the field as HTML.
Method html
WMLanchor::html() in wml-defs.php
Return HTML content Use render() to render this element in your page.
Method html
clickable_image::html() in image-defs.php
This renders the field as HTML.
Method html
hover::html() in image-defs.php
This renders the field as HTML.
Method html
HVmenu::html() in hvmenu-defs.php
This renders the field as HTML.
Method html
Xmenu::html() in xmenu-defs.php
This renders the field as HTML.
Method html
WMLtemplate::html() in wml-defs.php
Return HTML content Use render() to render this element in your page.
Method html
WMLdeck::html() in wml-defs.php
Return HTML content Use render() to render this element in your page.
Method html
WMLdo_element::html() in wml-defs.php
Produce main HTML for DO element
Method html
forum::html() in forum-defs.php
Method html
forum_thread::html() in forum-defs.php
Method html
form_textfield::html() in form-defs.php
This renders the field as HTML.
Method html
form_tandemfield::html() in form-defs.php
Use render() to render this element in your page.
Method html
form_radiogroup::html() in form-defs.php
This renders the field as HTML.
Method html
anchor::html() in html-defs.php
Render the object as HTML
Method html
DocumentObject::html() in html-defs.php
Render the HTML
Method html
hr::html() in html-defs.php
Render the object as HTML
Method html
WMLfieldset::html() in wml-defs.php
Return HTML content Use render() to render this element in your page.
Method html
FlashObject::html() in html-defs.php
Render the HTML
Method html
EmbeddedObject::html() in html-defs.php
Render the HTML
Method html
image::html() in image-defs.php
This renders the field as HTML.
Method html
embed::html() in html-defs.php
Page html-defs.php
html-defs.php in html-defs.php
Page htmlarea-defs.php
htmlarea-defs.php in htmlarea-defs.php
Method htmlarea_config
Constructor for new HTMLArea configuration object
Class htmlarea_config
htmlarea_config in htmlarea-defs.php
A container class for configuration settings for the HTMLArea
Function htmlarea_plugins
htmlarea_plugins() in htmlarea-defs.php
Function to set plugins to be loaded. When you are using one of
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.
Method htmldump
parameter::htmldump() in application-defs.php
Dump this parameter
Class HTMLObject
HTMLObject in html-defs.php
An HTMLObject is any object which will be rendered in HTML according to the basic syntax defined for HTML.
Method HTMLObject
HTMLObject::HTMLObject() in html-defs.php
Constructor Create a HTMLObject. Sets basic field attributes.
Method HTMLtag
HTMLtag::HTMLtag() in html-defs.php
Class HTMLtag
HTMLtag in html-defs.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.
Function HTTPError
HTTPError() in utils.php
Return an HTTP error message
Constant HTTP_AUTHENTICATION
HTTP_AUTHENTICATION in response-defs.php
Authentication option: Browser popup form
Class HVmenu
HVmenu in hvmenu-defs.php
HVMenu class This module is being retained for legacy applications which still use the core javascript system (version 5.41) which was written by Ger Versluis 24 December 2001.
Method HVmenu
HVmenu::HVmenu() in hvmenu-defs.php
Constructor Create the HV menu object.
Page hvmenu-defs.php
hvmenu-defs.php in hvmenu-defs.php
Function HVmenu_entry
HVmenu_entry() in hvmenu-defs.php
Recursively produce HVmenu definition entries. These array
i
top
Variable $icon
EmbeddedObject::$icon in html-defs.php
Image which acts as a play icon
Variable $icon
img::$icon in html-defs.php
Image which acts as a clickable icon
Variable $id
StylableObject::$id in html-defs.php
The ID tag to apply to this object
Variable $id
term::$id in search-defs.php
ID field provided for optional application use
Variable $idoffset
fileindexer::$idoffset in search-fileindex-defs.php
ID generation offset
Variable $idprefix
fileindexer::$idprefix in search-fileindex-defs.php
ID generation prefix
Variable $idsource
fileindexer::$idsource in search-fileindex-defs.php
ID generation source
Variable $images_defined
hover::$images_defined in image-defs.php
Flag, true if images have been defined
Variable $image_keys
Array of image IDs we have in our combo
Variable $image_type
img::$image_type in html-defs.php
The image type: "GIF", "JPG", "PNG", "TIFF", "BMP"..
Variable $image_urls
Array of image URLS, one per ID above
Variable $img
hover::$img in image-defs.php
Image object
Variable $img
image_button::$img in button-defs.php
Image object for this button
Variable $img
clickable_image::$img in image-defs.php
The image object
Variable $imgs_changed
Xmenu::$imgs_changed in xmenu-defs.php
Whether images were changed or not
Variable $img_horiz_arrow
Xmenu::$img_horiz_arrow in xmenu-defs.php
Menu image object: horizontal arrow
Variable $img_over
hover::$img_over in image-defs.php
Image over object
Variable $img_spacer
Xmenu::$img_spacer in xmenu-defs.php
Menu image object: spacer
Variable $img_vert_arrow
Xmenu::$img_vert_arrow in xmenu-defs.php
Menu image object: vertical arrow
Variable $include_maxsize
Whether to include the max size in the form
Variable $increment
DB_dbsequence::$increment in pg-schema-defs.php
Sequence increment
Variable $indexed
metadata_element::$indexed in metadata-defs.php
Whether this element should be indexed
Variable $indexed
searchengine_indexmsg::$indexed in search-lucene-defs.php
Indication that the indexing was successful
Variable $indexed
lucene_indexmsg::$indexed in lucene-defs.php
Indication that the indexing was successful
Variable $indexes
dbtable::$indexes in schema-defs.php
Array of indexes on this table
Variable $indexes
schema::$indexes in schema-defs.php
Variable $indexfields
fileindexer::$indexfields in search-fileindex-defs.php
Fields for indexing. This is an array of fieldname/value
Variable $index_category
layout::$index_category in layout-defs.php
The index category of the current layout - used with indexing
Variable $info_msg
story::$info_msg in story-defs.php
Variable $initDD
Calendar::$initDD in calendar-defs.php
Variable $initial_record_value
Value, if defined, of the record to focus to on initialisation
Variable $initial_ts
digital_clock::$initial_ts in clock-defs.php
Initial time to set the clock to
Variable $initMM
Calendar::$initMM in calendar-defs.php
Variable $initYY
Calendar::$initYY in calendar-defs.php
Variable $instantiated
metadata_element::$instantiated in metadata-defs.php
Whether this element is instantiated as layout metadata
Variable $internal_name
Internal name sans spaces
Variable $IP
user::$IP in user-defs.php
List of IP addresses this user will be auto-logged-in from.
Variable $isarray
DB_dbfield::$isarray in pg-schema-defs.php
Whether this field is an array of values
Variable $ispkey
dbfield::$ispkey in schema-defs.php
Variable $is_parent
menuoption::$is_parent in menu-defs.php
True if this menu option is the parent of sub-menu options
Variable $itemlist
Items to display, assoc. array
Variable $items
menu::$items in menu-defs.php
Array of items in this menu
Variable $item_count
menu::$item_count in menu-defs.php
Number of items in the menu
Variable $item_height
HVmenu::$item_height in hvmenu-defs.php
Height of menu items in pixels
Variable $item_spacing
treemenu::$item_spacing in treemenu-defs.php
Padding before (above) 'normal' menu options
Variable $item_width
HVmenu::$item_width in hvmenu-defs.php
Width of all menu items in pixels
Variable $ixid
fileindexer::$ixid in search-fileindex-defs.php
The index ID
Method identify_user
session::identify_user() in session-defs.php
Identify the user/client
Constant ID_FROM_FILENAME
ID_FROM_FILENAME in lucene-defs.php
Mode of index ID generation is by full filename (incl. extension)
Constant ID_FROM_INC
ID_FROM_INC in lucene-defs.php
Mode of index ID generation is by incrementing integer
Constant ID_FROM_NAME
ID_FROM_NAME in lucene-defs.php
Mode of index ID generation is by filename stripped of path and extension
Constant ID_FROM_PATH
ID_FROM_PATH in lucene-defs.php
Mode of index ID generation is by full path to file
Method id_generate
fileindexer::id_generate() in search-fileindex-defs.php
Set the source for ID generation. Since we are indexing a bunch of files, the ID's have to be generated on demand inside the loop. So we provide for various ways here, and you can extend this class to provide more if required.
Method image
image::image() in image-defs.php
Constructor Creates the basic image object.
Class image
image in image-defs.php
Image class A class for managing a standard image.
Page image-defs.php
image-defs.php in image-defs.php
Method image_button
image_button::image_button() in button-defs.php
Constructor
Class image_button
image_button in button-defs.php
Image button.
Constant IMAGE_MIMES
IMAGE_MIMES in mime-types.php
Class img
img in html-defs.php
[IMG] - The img class. This is an object which renders the img tag.
Method img
img::img() in html-defs.php
Constructor The src field is mandatory. The name is optional but if given it will also be used for the ALT tag. If a tooltip is not given then the name will also be used for that attribute.
Method import_settings
Process the configfile.
Method import_settings
Process the configfile.
Method import_settings
This will be implemented in the child class depending on config file type.
Method inc_thread_views
Method index
named_layout::index() in layout-defs.php
Index the named layout. We only do this if the layout version is LIVE or there is only a single version in existence.
Method index
block::index() in block-defs.php
Index the block.
Method index
story::index() in story-defs.php
Index this story to the search engine, if enabled for this website.
Method index
catalogitem::index() in catalog-defs.php
Index this catalog item to the search engine.
Method index
layout::index() in layout-defs.php
Index all blocks in this layout.
Constant INDEXED
INDEXED in lucene-defs.php
Used to indicate that a field should be indexed by Lucene
Method index_content
Index the given content against the given ID. This automatically
Method index_content
searchengine_indexmsg::index_content() in search-lucene-defs.php
Index the given content against the given ID. This automatically
Method index_exists
schema::index_exists() in schema-defs.php
Returns true if named index exists.
Method index_field
fileindexer::index_field() in search-fileindex-defs.php
Supply field content for indexing. This causes the search engine to take the given fieldname and index the given value against it.
Method index_field
searchengine_indexmsg::index_field() in search-lucene-defs.php
Supply field content for indexing. This causes SearchEngine to take the given fieldname and index the given value against it. NB: we silently ignore the request for nullstring, since these cause SearchEngine indexing to throw an exception, and indexing will fail.
Method index_field
Supply field content for indexing. This causes Lucene to take the given fieldname and index the given value against it. NB: we silently ignore the request for nullstring, since these cause Lucene indexing to throw an exception, and indexing will fail.
Method index_file
fileindexer::index_file() in search-fileindex-defs.php
Index a file located at the given path, using given ID.
Method index_tree
fileindexer::index_tree() in search-fileindex-defs.php
Index a tree of files starting at the path given. We index these in one of four modes, which determines how we generate the ID for each item: 'ID_FROM_INC' mode uses an incremental counter starting at 1. If $prefix holds a number, the counter will start at this number instead of one.
Function infoField
infoField() in control-panel.php
Method inherit_attributes
This sets our attributes from another object which is a descendant of HTMLObject. The attributes are specially selected to be only those which are associated with the basic appearance of the object.
Method inherit_schemes
Inherit schemes from parent metadata elements. This involves a traversal of the lineage (parentage) of this current metadata element and retreival of the schemes of each one. Where the scheme is not already associated with this element, it is added.
Class iniconfigfile
iniconfigfile in file-defs.php
A system configuration file in the form of an INI file. These are in the standard NAME=VALUE format, within sections. In this class we ignore the [sections], and just read in all of the NAME=VALUE pairs, stashing them into the 'settings' class var as an array.
Method iniconfigfile
Method initialise
search::initialise() in search-defs.php
Initialise everything about the search.
Method initialise
story::initialise() in story-defs.php
Initialise local vars..
Method initialise
Clear the object variables to default values.
Method initialise
microsite::initialise() in microsite-defs.php
Initialise this object to default values. Eg. this is done after a delete, so we don't see the deleted object data.
Method initial_record
recmaintainer::initial_record() in recmaint-defs.php
Tell the record maintainer to focus the keycombo to the record with the given value, when it first initialises.
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.
Function inline_script
inline_script() in utils.php
Method inline_start
webpage::inline_start() in webpage-defs.php
Begin inline buffering
Method InPersistentHostsList
Is host in peristent list
Method inputfile
inputfile::inputfile() in file-defs.php
Constructor Open the given file for input.
Class inputfile
inputfile in file-defs.php
The inputfile class manages files for input. It opens, reads and closes files in input-only mode.
Method insert
WMLanchor::insert() in wml-defs.php
Insert content into the anchor
Method insert
WMLelement::insert() in wml-defs.php
Insert content Append more WML content to the body. This just concatenates the given string onto the existing content.
Method insert_card
WMLdeck::insert_card() in wml-defs.php
Add card Inserts a ready-made card object into the deck.
Method insert_cols
table::insert_cols() in html-defs.php
Insert a column into all rows in the table. If the template cell is not provided, then a 'vanilla' cell is used instead.
Method insert_go
Insert GO element into container
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.
Method insert_metatags
Insert the instantiated metatags into the given webpage. This is intended to be used on the $RESPONSE object to actually jam the tags for this layout into the webapage.
Method insert_para
Insert paragraph small text Append content to the body inside a paragraph and with small text tags around it. Refinement of the standard insert_paragraph() method.
Method insert_paragraph
Insert paragraph Append content to the body inside a paragraph.
Method insert_para_scrubbed
Insert paragraph small text scrubbed Append content to the body inside a paragraph and with small text tags around it. Just like insert_para() except we also scrub the content to make sure it is clean.
Method insert_prev
Insert PREV element into container
Method insert_refresh
Insert REFRESH element into container
Method insert_row
table::insert_row() in html-defs.php
Insert a row into the table. If the template cell is not provided, then a 'vanilla' cell is used instead. We insert the new row just before the given row.
Method insert_template
Define template defines the template for the deck.
Method Insitu
catalogitem::Insitu() in catalog-defs.php
Return the catalog item as image, a clickable icon, or otherwise a link.
Method inslot
timeslot::inslot() in datetime-defs.php
Function integerField
integerField() in control-panel.php
Method into
sqlquery::into() in query-defs.php
Define table INSERT INTO list
Function ip_format
ip_format() in utils.php
Format a string (dotted) form of an IP address. We make sure we have
Function isLeapYear
isLeapYear() in datetime-defs.php
Check if year is a leap year.
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.
Constant ISO_8601
ISO_8601 in datetime-defs.php
ISO 8601 Example: YYYYMMDDTHHMMSS-HHMM
Constant ISO_DATABASE_FORMAT
ISO_DATABASE_FORMAT in datetime-defs.php
Example: 1999-07-17 23:59:59
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 istrue
dbrecords::istrue() in query-defs.php
Database independent boolean handling. Returns TRUE if the named field in the current row is boolean true according to the rules of the underlying database, else returns FALSE.
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.
Method is_holiday
holidays::is_holiday() in holiday-defs.php
Check if the given timestamp is the date of a public holiday. We
Method is_integer_class
dbfield::is_integer_class() in schema-defs.php
Return true if the field is of an integer class.
Method is_integer_class
DB_dbfield::is_integer_class() in pg-schema-defs.php
Return true if the field is of an integer class. We exclude the serial types due to the initial purpose of this method - to determine fields which are standalone integer types, without attached sequences.
Function is_ipaddress
is_ipaddress() in utils.php
Check string to see if it is in IPv4 format. This is pretty simplistic. It returns true if the string $ip is of the form 'n.n.n.n'.
Method is_pendingver
layout::is_pendingver() in layout-defs.php
Return PENDING version status.
Function is_same_day
is_same_day() in holiday-defs.php
Return true if the two timestamps are on the same day of the calendar.
Method is_serial_class
dbfield::is_serial_class() in schema-defs.php
Return true if the field is of a 'serial' class. This is a pseudo class of types which encapsulates integer fields which are able to auto-increment themselves when records are inserted.
Method is_serial_class
DB_dbfield::is_serial_class() in pg-schema-defs.php
Return true if the field is of a 'serial' class. This is a pseudo class of types which encapsulates integer fields which are able to auto-increment themselves when records are inserted.
Function is_utf8
is_utf8() in unicode-defs.php
Method is_valid
Calendar::is_valid() in calendar-defs.php
Check that currently stored Month, Day and Year make a correct date. Returns true if so.
Method itemcount
catalog::itemcount() in catalog-defs.php
Return the count of items in the catalog currently.
j
top
Variable $joined_tables
maintainer::$joined_tables in maintainer-defs.php
Array of joined tables. Tables with a 1-to-1 link.
Variable $justify
block::$justify in block-defs.php
Justification: 'left', 'center', 'right'
Variable $justify
blocklet::$justify in block-defs.php
Justification: 'left', 'right', 'centered'
Variable $justify
story_media::$justify in story-defs.php
The way to justify this item
Method javascript
img::javascript() in html-defs.php
Render image as javascript object
Method javascript
image::javascript() in image-defs.php
Render image as javascript object
Method java_applet
embed::java_applet() in html-defs.php
Specify the parameters required for a Java applet, the name of the file containing the applet code, and the URL to find the file at.
Method joined_table
maintainer::joined_table() in maintainer-defs.php
Associates a table with the maintained table. This is a table with a 1-to-1 or 1-to-many relationship with the table being maintained.
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)
Variable $keycombo
recmaintainer::$keycombo in recmaint-defs.php
Pointer to the key combo/select box
Variable $keywords
catalogitem::$keywords in catalog-defs.php
Variable $killsecs
lockfile::$killsecs in lockfile-defs.php
Lockfile age at which we should assume process is hung
Variable $killWordOnPaste
set to true if you want Word code to be cleaned upon Paste
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
Method keyinfo
story_media::keyinfo() in story-defs.php
Return the keyinfo string for this media item. This is encoded
Constant KILOBYTE
KILOBYTE in constants.php
Kilobytes
l
top
Variable $label
form_field::$label in form-defs.php
Label to put against the field. NB: this is not displayed unless you make it so.
Variable $label
menuoption::$label in menu-defs.php
Menuoption displayed label
Variable $label
Link::$label in button-defs.php
The label to display for the link
Variable $label
menuitem::$label in menu-defs.php
Label for this menu item
Variable $label
metadata_element::$label in metadata-defs.php
Label against the element value field
Variable $label
anchor::$label in html-defs.php
Link label text
Variable $label
metadata_scheme::$label in metadata-defs.php
Label for scheme
Variable $label
WMLdo_element::$label in wml-defs.php
Label for the Do element
Variable $labelcolon
form::$labelcolon in form-defs.php
Whether to append colon ":" to labels
Variable $labelcss
form::$labelcss in form-defs.php
Optional class/style for labels
Variable $labeljustify
form::$labeljustify in form-defs.php
Justification mode for labels "right" or "left"
Variable $labelside
Side to place label: 'right' or 'left'
Variable $label_padding_left
treemenu::$label_padding_left in treemenu-defs.php
Padding between menuoption image, and menu item text
Variable $lang
HTMLObject::$lang in html-defs.php
Language code for text content in this object
Variable $langdir
HTMLObject::$langdir in html-defs.php
Direction for text - 'LTR' (left-to-right) or 'RTL' (right-to-left)
Variable $language
Xmenu::$language in xmenu-defs.php
Menu language
Variable $language
HVmenu::$language in hvmenu-defs.php
Menu language
Variable $language
menumaintainer::$language in menumaint-defs.php
The language of the menu (0 = default)
Variable $language
layout::$language in layout-defs.php
The language of the layout (0 = default)
Variable $language
metadata_element::$language in metadata-defs.php
The language of the content or resource referenced by URI
Variable $language
sitemenu::$language in menu-defs.php
Language variant of this menu eg: 'fr'
Variable $language
block::$language in block-defs.php
The language of the block (0 = default)
Variable $language
treemenu::$language in treemenu-defs.php
Menu language, or default if zero
Variable $language
dbfunction::$language in schema-defs.php
Variable $language
story::$language in story-defs.php
Variable $languages
head::$languages in webpage-defs.php
Languages used in content of the page
Variable $languages
response::$languages in response-defs.php
IDs of all languages contained in this page
Variable $lang_desc
menumaintainer::$lang_desc in menumaint-defs.php
The name of the language of the menu
Variable $lang_direction
block::$lang_direction in block-defs.php
The language text direction
Variable $lang_direction
layout::$lang_direction in layout-defs.php
The language text direction
Variable $lang_encoding
layout::$lang_encoding in layout-defs.php
The language encoding code
Variable $lang_encoding
block::$lang_encoding in block-defs.php
The language encoding code
Variable $lastmodified
story::$lastmodified in story-defs.php
Variable $lastmodified_ts
story::$lastmodified_ts in story-defs.php
Variable $last_author
forum::$last_author in forum-defs.php
Variable $last_errormsg
dbquery::$last_errormsg in query-defs.php
Record last error/info message
Variable $last_installed_ts
microsite::$last_installed_ts in microsite-defs.php
When microsite was last installed (timestamp)
Variable $last_logintime
session::$last_logintime in session-defs.php
Time of last login (Unix timestamp)
Variable $last_modified
layout::$last_modified in layout-defs.php
Last modified date/time string.
Variable $last_modified
When menu option was last modified (datetime)
Variable $last_modified_ts
microsite::$last_modified_ts in microsite-defs.php
When microsite was last modified (timestamp)
Variable $last_name
user::$last_name in user-defs.php
Last name of the person
Variable $layout
layouteditor::$layout in layout-editor-defs.php
The layout we are providing
Variable $layouteditor
layout::$layouteditor in layout-defs.php
Local layouteditor object, only instantiated if the
Variable $layoutfm
layout::$layoutfm in layout-defs.php
The name of the layout form
Variable $layoutid
layout::$layoutid in layout-defs.php
The unique ID of this layout
Variable $layoutid
block::$layoutid in block-defs.php
The layout this block belongs to
Variable $layout_blocks
layout::$layout_blocks in layout-defs.php
The layout blocks, keyed on 'row|col'
Variable $layout_id
The layout these elements are for
Variable $layout_lang_direction
The language direction for the containing layout
Variable $layout_lang_encoding
The language encoding for the containing layout
Variable $layout_name
layout::$layout_name in layout-defs.php
The name of the current layout
Variable $layout_style
layout::$layout_style in layout-defs.php
Supplemental layout table style
Variable $layout_table
layout::$layout_table in layout-defs.php
The layout table itself
Variable $layout_version
block::$layout_version in block-defs.php
Version of layout this block belongs to (optional). If present
Variable $layout_version_count
Count of layout versions in existence.
Variable $leftx
digital_clock::$leftx in clock-defs.php
X-offset from left
Variable $lifetime
session::$lifetime in session-defs.php
The session lifetime, in seconds
Variable $limit
sqlquery::$limit in query-defs.php
The LIMIT value
Variable $limit_logins
user::$limit_logins in user-defs.php
Limit of logins allowed (0=unlimited)
Variable $link
menuitem::$link in menu-defs.php
Link object to associate with menu item
Variable $linked_tables
maintainer::$linked_tables in maintainer-defs.php
Array of linked tables. Tables forming many-to-many link.
Variable $linked_uri
metadata_element::$linked_uri in metadata-defs.php
Whether the tag value is actually a URL/URI
Variable $linkover_text
Text to display in statusbar when mouse over object
Variable $linkover_text
Link::$linkover_text in button-defs.php
Status bar text when link moused over
Variable $linkover_text
image::$linkover_text in image-defs.php
Text to display in status area when mouse over image
Variable $list
configfield::$list in configuration-defs.php
Variable $list_of_values
A list of permitted element values
Variable $list_of_values
enc_qualifier::$list_of_values in metadata-defs.php
Allowed list of values for this qualifier
Variable $locked
user::$locked in user-defs.php
Flag, true if this user account is locked
Variable $locked
forum_thread::$locked in forum-defs.php
Variable $locked
thread_msg::$locked in forum-defs.php
Variable $locked
monitor::$locked in monitor-defs.php
True if we are locked via lockfile
Variable $lockfile
monitor::$lockfile in monitor-defs.php
Monitor lockfile object
Variable $lockfilename
lockfile::$lockfilename in lockfile-defs.php
Name of the lockfile to create
Variable $lockfilepath
monitor::$lockfilepath in monitor-defs.php
Monitor lockfile path
Variable $lock_mins
lockfile::$lock_mins in lockfile-defs.php
Minutes process has been locked for
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
Variable $lookahead
pages::$lookahead in paging-defs.php
Number of chars to look ahead
Variable $lookback
pages::$lookback in paging-defs.php
Number of chars to look back
Variable $loop
MediaObject::$loop in html-defs.php
If true the media replays endlessly
Variable $LowBgColor
treemenu::$LowBgColor in treemenu-defs.php
Colour of normal top menu item background
Variable $LowColor
treemenu::$LowColor in treemenu-defs.php
Colour of normal top menu item text
Method layout
layout::layout() in layout-defs.php
Constructor Create a new layout object. To create a new layout then just leave leave the argument list empty.
Class layout
layout in layout-defs.php
Layout A layout can be simply viewed as a table definition. The table cells can contain blocks, and so this entity is provided to allow control of how blocks of content can be arranged on a webpage.
Page layout-defs.php
layout-defs.php in layout-defs.php
Page layout-editor-defs.php
layout-editor-defs.php in layout-editor-defs.php
Method layouteditor
layouteditor::layouteditor() in layout-editor-defs.php
Constructor Create a new layouteditor object.
Class layouteditor
layouteditor in layout-editor-defs.php
Layouteditor
Class layout_metadata_elements
layout_metadata_elements in metadata-defs.php
A class which holds multiple metadata elements, for a given layout.
Method layout_metadata_elements
Constructor
Constant LCK_E_CREFAIL
LCK_E_CREFAIL in lockfile-defs.php
Lockfile
Constant LCK_E_FROZEN
LCK_E_FROZEN in lockfile-defs.php
Lockfile was frozen
Constant LCK_E_IMMORTAL
LCK_E_IMMORTAL in lockfile-defs.php
Lockfile process could not be killed
Constant LCK_E_KILLED
LCK_E_KILLED in lockfile-defs.php
Lockfile process was killed
Constant LCK_E_KILLED9
LCK_E_KILLED9 in lockfile-defs.php
Lockfile process was killed with -9
Constant LCK_E_OK
LCK_E_OK in lockfile-defs.php
Lockfile created ok
Constant LCK_E_ORPHAN
LCK_E_ORPHAN in lockfile-defs.php
Lockfile is orphaned (no associated process)
Constant LCK_E_READFAIL
LCK_E_READFAIL in lockfile-defs.php
Lockfile could not be read
Method length
webstream::length() in webpage-defs.php
Length of output buffer
Method length
WMLdeck::length() in wml-defs.php
Length (size) of deck Return the length of the WML. NOTE: this should only be called *after* the wml() function has been called, or it will return zero.
Method limit
sqlquery::limit() in query-defs.php
Define query LIMIT
Method limit
db_search::limit() in dbsearch-defs.php
Define search LIMIT clause
Method Link
Link::Link() in button-defs.php
Constructor
Class Link
Link in button-defs.php
Clickable link
Method linked_table
maintainer::linked_table() in maintainer-defs.php
Associates a table with the maintained table via a link-table.
Method load_template
head::load_template() in webpage-defs.php
Load given template content.
Constant LOCAL_AUTH
LOCAL_AUTH in control-panel.php
User data is maintained on the local database in Axyl format This is the default.
Method lock
datasources::lock() in database-defs.php
General-purpose lock method. We pass the elements of the lock, which is the list of tables to lock, and the lock-mode. The latter mode is database-specific, and therefore flexible.
Method lock
database::lock() in database-defs.php
This method must be defined in the child class.
Function lock
lock() in query-defs.php
Take out a lock on a table or tables, in a given mode. The mode string is database-specific and will vary according to the implementation of its locking scheme.
Method lockfile
lockfile::lockfile() in lockfile-defs.php
Make a new lockfile handler object.
Class lockfile
lockfile in lockfile-defs.php
A class to handle a lockfile for a running process. The idea is you
Page lockfile-defs.php
lockfile-defs.php in lockfile-defs.php
Function lockrows_exclusive
lockrows_exclusive() in db-postgres.php
Lock table in ROW EXCLUSIVE MODE
Function lockrows_share
lockrows_share() in db-postgres.php
Lock table in ROW SHARE MODE
Function locktable_exclusive
locktable_exclusive() in db-postgres.php
Lock table in EXCLUSIVE MODE Locks the whole table exclusively. This is very restrictive and prevents any other process getting a share lock on the records (any of them) in the table.
Function locktable_share
locktable_share() in db-postgres.php
Lock table in SHARE MODE Holds the whole table in share lock mode. This makes sure that no exclusive locks can be acquired and so holds the data in the table constant for the transaction.
Method lock_thread
forum_thread::lock_thread() in forum-defs.php
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
Function log_sys
log_sys() in utils.php
Send a message to the system logfile Send message to the syslog, prefixed with APP_NAME nicely. Saves having to prefix it each time.
Constant LOOP
LOOP in html-defs.php
Used to indicate sound should loop indefinitely
Constant LOWER
LOWER in form-defs.php
Force text to lowercase
Page lucene-defs.php
lucene-defs.php in lucene-defs.php
Page lucene-fileindex-defs.php
lucene-fileindex-defs.php in lucene-fileindex-defs.php
Function lucene_backup
lucene_backup() in lucene-defs.php
Function to make a backup of the Lucene index. This would commonly
Method lucene_connection
Constructor - Lucene connection
Class lucene_connection
lucene_connection in lucene-defs.php
The lucene connection class
Method lucene_indexmsg
Constructor Make a new Lucene index message.
Class lucene_indexmsg
lucene_indexmsg in lucene-defs.php
The lucene index message class. This class inherits all the functionality of the lucene_connection, lucene_msg and lucene_message classes. It adds indexing-specific methods.
Method lucene_message
Constructor This is a more complex class which builds on the basic lucene_msg class to provide some higher level methods for adding fields in specific ways to support CONTROL, QUERY and INDEX message types.
Class lucene_message
lucene_message in lucene-defs.php
The lucene message class. This class extends its parent class lucene_msg and adds some higher level methods for adding groups of fields to the message.
Method lucene_msg
lucene_msg::lucene_msg() in lucene-defs.php
Constructor
Class lucene_msg
lucene_msg in lucene-defs.php
The lucene msg class. This is a raw class which holds the basic message fields and data and knows how to build them into a full message for sending to the lucene server.
Function lucene_optimize
lucene_optimize() in lucene-defs.php
Function to optimize the Lucene index. This would commonly be used after a batch of items have been indexed.
Function lucene_purge
lucene_purge() in lucene-defs.php
Function to purge the Lucene index of all indexes to documents. Yes, I'll repeat that - it DELETES ALL DOCUMENTS FROM THE INDEX, permanently, finito, shazam, ba-boom, as in "Omigod did I *really* mean to do that!?".
Class lucene_purgemsg
lucene_purgemsg in lucene-defs.php
The lucene purge message class. This class allows you to remove all
Method lucene_purgemsg
Constructor Make a new Lucene purge message. This message is provided to allow you to delete all items from the Lucene index.
Method lucene_querymsg
Constructor Make a new Lucene query message. You can specify the application to use here, and also an optional query string to send.
Class lucene_querymsg
lucene_querymsg in lucene-defs.php
The lucene query message class. This class inherits all the functionality of the lucene_connection, lucene_msg and lucene_message classes. It adds query-specific methods for searching.
Method lucene_search
Constructor
Class lucene_search
lucene_search in lucene-defs.php
The lucene search class
Method lucene_unindexmsg
Constructor Make a new Lucene unindex message. This message is provided to allow you to delete an item from the Lucene index. It has a single method 'unindex' which takes the ID of the item to delete.
Class lucene_unindexmsg
lucene_unindexmsg in lucene-defs.php
The lucene unindex message class. This class allows you to remove an item from the Lucene index. You must know the unique ID that identifies the document.
Class lucene_utilitymsg
lucene_utilitymsg in lucene-defs.php
The lucene utility message class. Used for special Lucene operations.
Method lucene_utilitymsg
Constructor
m
top
Variable $map
image::$map in image-defs.php
Image map to use
Variable $map
img::$map in html-defs.php
Name of an image map
Variable $matched_holiday_desc
Variable $match_type
dbconstraint::$match_type in schema-defs.php
Match type for keys
Variable $maxlength
Maximum user-enterable chars for field
Variable $maxvalue
DB_dbsequence::$maxvalue in pg-schema-defs.php
Sequence max value
Variable $max_file_size
Maximum file suze in bytes
Variable $max_results
search::$max_results in search-defs.php
Maximum results to return in query
Variable $max_size
fileupload::$max_size in file-defs.php
Max filesize, else delete (0 = any size)
Variable $mbstring_avail
response::$mbstring_avail in response-defs.php
Whether we have multi-byte string fns available
Variable $media
MediaObject::$media in html-defs.php
Variable $menu
treemenu::$menu in treemenu-defs.php
The menu instance
Variable $menu
Xmenu::$menu in xmenu-defs.php
The menu instance
Variable $menuhref
HVmenu::$menuhref in hvmenu-defs.php
WWW menu URL - theme aware
Variable $menuopimage
treemenu::$menuopimage in treemenu-defs.php
Image to use to indicate a menu option
Variable $menuoptionid
menuoption::$menuoptionid in menu-defs.php
menuoption ID
Variable $menuoptions
menumaintainer::$menuoptions in menumaint-defs.php
The array of menu options
Variable $menuoption_id
microsite_page::$menuoption_id in microsite-defs.php
Menuoption ID - FK to ax_menuoption record
Variable $menuoption_id
treemenu::$menuoption_id in treemenu-defs.php
Initial menuoption ID
Variable $menuoption_label
microsite_page::$menuoption_label in microsite-defs.php
Label for menu option of this page
Variable $menuvarsfile
HVmenu::$menuvarsfile in hvmenu-defs.php
Path to menu variables file - theme aware
Variable $menu_desc
menumaintainer::$menu_desc in menumaint-defs.php
The description of the menu
Variable $menu_id
HVmenu::$menu_id in hvmenu-defs.php
Unique database menu ID
Variable $menu_id
menumaintainer::$menu_id in menumaint-defs.php
The ID of the menu
Variable $menu_id
microsite::$menu_id in microsite-defs.php
The ID of the microsite menu
Variable $menu_id
menuoption::$menu_id in menu-defs.php
menu ID the option belongs to
Variable $menu_id
treemenu::$menu_id in treemenu-defs.php
Unique database menu ID
Variable $menu_id
Xmenu::$menu_id in xmenu-defs.php
Unique database menu ID
Variable $menu_level
menuoption::$menu_level in menu-defs.php
Menu option level
Variable $menu_level
sitemenu::$menu_level in menu-defs.php
Level of menuitems to return
Variable $menu_level
menuitem::$menu_level in menu-defs.php
Menu level of this item
Variable $menu_level
HVmenu::$menu_level in hvmenu-defs.php
Level of menu to render
Variable $menu_level
menumaintainer::$menu_level in menumaint-defs.php
The level of the menu-options
Variable $menu_name
menumaintainer::$menu_name in menumaint-defs.php
The name of the menu
Variable $menu_name
HVmenu::$menu_name in hvmenu-defs.php
Menu name eg: 'main'
Variable $menu_name
Xmenu::$menu_name in xmenu-defs.php
Menu name eg: 'main'
Variable $menu_name
treemenu::$menu_name in treemenu-defs.php
Menu name eg: 'main'
Variable $menu_name
sitemenu::$menu_name in menu-defs.php
Name of this menu eg: 'main'
Variable $menu_structure_changed
Whether menu structure was rebuilt or not
Variable $menu_type
Xmenu::$menu_type in xmenu-defs.php
Menu type from stylesheet: vertical, horizontal
Variable $menu_width
treemenu::$menu_width in treemenu-defs.php
Fixed menu width, or zero if not fixed
Variable $message
monitor::$message in monitor-defs.php
Monitor highest priority message
Variable $message
searchengine_connection::$message in search-lucene-defs.php
The message waiting to be sent
Variable $message
lucene_connection::$message in lucene-defs.php
The message waiting to be sent
Variable $message
layout::$message in layout-defs.php
Message to display (optional)
Variable $messages
lockfile::$messages in lockfile-defs.php
Latest error message
Variable $meta
head::$meta in webpage-defs.php
Meta tags array
Variable $metadata_elements
The metadata elements themselves
Variable $metadata_mode
response::$metadata_mode in response-defs.php
Metadata edit/generation mode we are in
Variable $metascan
fileindexer::$metascan in search-fileindex-defs.php
Scan for meta tags as fields in file content. Recommended.
Variable $meta_fields
fileindexer::$meta_fields in search-fileindex-defs.php
Meta fields definitions array. Contains definitions
Variable $method
form::$method in form-defs.php
Method attribute
Variable $method
WMLgo::$method in wml-defs.php
Method, eg. "post"
Variable $microsites_mode
response::$microsites_mode in response-defs.php
Microsites edit/generation mode we are in
Variable $microsite_desc
microsite::$microsite_desc in microsite-defs.php
The description of the microsite
Variable $microsite_detected
response::$microsite_detected in response-defs.php
Name of the microsite detected, or undefined
Variable $microsite_domain
microsite::$microsite_domain in microsite-defs.php
The domain of the microsite
Variable $microsite_homepage
Whether this page is the microsite home page
Variable $microsite_name
microsite::$microsite_name in microsite-defs.php
The name of the microsite
Variable $microsite_name
story::$microsite_name in story-defs.php
Variable $microsite_name
The name of the microsite this template is for
Variable $microsite_name
microsite_page::$microsite_name in microsite-defs.php
Name of microsite this page is for
Variable $microsite_page_id
Unique microsite page ID
Variable $microsite_template_id
Microsite template ID (Fk)
Variable $microsite_template_id
Unique microsite template ID
Variable $mid_names
user::$mid_names in user-defs.php
Middle names or initials of the person
Variable $mimeboundary
email::$mimeboundary in mail-defs.php
MIME boundary marker to use
Variable $mimecontenttype
email::$mimecontenttype in mail-defs.php
MIME content type for the e-mail
Variable $mimeparts
email::$mimeparts in mail-defs.php
Assembled mime attachments
Variable $mimetype
fileupload::$mimetype in file-defs.php
Mime type of the the file
Variable $mimetype
embed::$mimetype in html-defs.php
The MIME type of the object
Variable $mimetype
EmbeddedObject::$mimetype in html-defs.php
MIME type of data required by the object
Variable $mime_category
catalogitem::$mime_category in catalog-defs.php
Variable $mime_type
catalogitem::$mime_type in catalog-defs.php
Variable $minspace
diskspace_monitor::$minspace in monitor-defs.php
Threshold (bytes) before error condition
Variable $minvalue
DB_dbsequence::$minvalue in pg-schema-defs.php
Sequence minimum value
Variable $MM
Calendar::$MM in calendar-defs.php
Variable $mobile
user_self_registration::$mobile in selfregistration-defs.php
Variable $mode
microsite::$mode in microsite-defs.php
mode of operation
Variable $mode
block::$mode in block-defs.php
Mode of operation, 'viewing', 'editing', 'saving' @access private
Variable $moderator
forum::$moderator in forum-defs.php
Variable $monitors
monitor::$monitors in monitor-defs.php
Array of monitors which do the work
Variable $months
Calendar::$months in calendar-defs.php
Variable $movie
FlashObject::$movie in html-defs.php
Variable $msg
error_page::$msg in webpage-defs.php
Actual error message in detail
Variable $msgs
maintainer::$msgs in maintainer-defs.php
Array of messages to display at the top of the maintainer.
Variable $msg_id
thread_msg::$msg_id in forum-defs.php
Variable $msg_subject
thread_msg::$msg_subject in forum-defs.php
Variable $msg_text
thread_msg::$msg_text in forum-defs.php
Variable $multilang
response::$multilang in response-defs.php
Whether we are in multi-language mode or not, If this is true then
Variable $multiselect
Boolean, multiple item select
Page mail-defs.php
mail-defs.php in mail-defs.php
Method maintainer
maintainer::maintainer() in maintainer-defs.php
Create a new maintainer.
Class maintainer
maintainer in maintainer-defs.php
Class comprising functionality which allows a database table to be maintained through a user interface which allows the usual Add, Modify, Delete options, but which gets just about all the info it requires from the database schema itself. A dynamic maintainer.
Page maintainer-defs.php
maintainer-defs.php in maintainer-defs.php
Method make_precis
story::make_precis() in story-defs.php
Generate a precis from the story content.
Method match
lucene_search::match() in lucene-defs.php
Add a new search term to match. Search terms can be a single word or compound patterns, Each time one of these is added, it has an operator associated with it - whether this term is a "may have" (OR), or a "must have" (AND) term.
Method match
search::match() in search-defs.php
Add a new search term to match. Search terms can be a single word or compound patterns, Each time one of these is added, it has an operator associated with it - whether this term is a "may have" (OR), or a "must have" (AND) term.
Method match
searchengine_search::match() in search-query-defs.php
Add a new search term to match. Search terms can be a single word or compound patterns, Each time one of these is added, it has an operator associated with it - whether this term is a "may have" (OR), or a "must have" (AND) term.
Method matches
dbconstraint::matches() in schema-defs.php
Method matchfield
searchengine_search::matchfield() in search-query-defs.php
Add search term to match a field value.
Method matchfield
lucene_search::matchfield() in lucene-defs.php
Add search term to match a field value.
Method matchrange
lucene_search::matchrange() in lucene-defs.php
Add search term to match a field value range.
Method matchrange
searchengine_search::matchrange() in search-query-defs.php
Add search term to match a field value range.
Method matrix
matrix::matrix() in html-defs.php
Construct a new matrix.
Class matrix
matrix in html-defs.php
A matrix is a table with no colspans or rowspans. It is an N x M
Method may_match
search::may_match() in search-defs.php
Define a search term which the search may or may not match.
Method may_matchfield
searchengine_search::may_matchfield() in search-query-defs.php
Add search term: may match a field value.
Method may_matchfield
Add search term: may match a field value.
Method MediaObject
Constructor
Class MediaObject
MediaObject in html-defs.php
Generic Multimedia Object
Constant MEGABYTE
MEGABYTE in constants.php
Megabytes
Method menu
menu::menu() in menu-defs.php
Constructor Creates the menu object.
Class menu
menu in menu-defs.php
A menu, which is a container for menu items. This class encapsulates what is essentially a list of links which can be displayed as a 'menu'. Orientation can be VERTICAL or HORIZONTAL. A 'wrap threshold' can be defined. If it's a vertical menu, this represents the max no.
Page menu-defs.php
menu-defs.php in menu-defs.php
Method menuitem
menuitem::menuitem() in menu-defs.php
Constructor Creates the menu item object.
Class menuitem
menuitem in menu-defs.php
Standard menu item. Takes a link object as the item in the menu.
Page menumaint-defs.php
menumaint-defs.php in menumaint-defs.php
Class menumaintainer
menumaintainer in menumaint-defs.php
Menu Maintainer
Method menumaintainer
menumaintainer::menumaintainer() in menumaint-defs.php
Constructor Create a new menumaintainer.
Method menuoption
menuoption::menuoption() in menu-defs.php
Constructor Create a new menuoption object.
Class menuoption
menuoption in menu-defs.php
The menuoption is a class which contains the properties of a single option on a menu.
Constant MENU_ITEM_SEPARATOR
MENU_ITEM_SEPARATOR in menu-defs.php
The menu item is a separator line
Constant MENU_ITEM_SPACER
MENU_ITEM_SPACER in menu-defs.php
The menu item is a spacer
Constant MENU_ITEM_SUBMENU
MENU_ITEM_SUBMENU in menu-defs.php
The menu item is a sub-menu heading
Constant MENU_ITEM_URL
MENU_ITEM_URL in menu-defs.php
The menu item is an ad-hoc URL
Constant MENU_LEVEL0
MENU_LEVEL0 in menu-defs.php
Main menu level (0)
Constant MENU_LEVEL1
MENU_LEVEL1 in menu-defs.php
Menu level 1
Constant MENU_LEVEL2
MENU_LEVEL2 in menu-defs.php
Menu level 2
Constant MENU_LEVEL3
MENU_LEVEL3 in menu-defs.php
Menu level 3
Constant MENU_LEVEL4
MENU_LEVEL4 in menu-defs.php
Menu level 4
Constant MENU_LEVEL_ALL
MENU_LEVEL_ALL in menu-defs.php
All menu levels
Method merge_cols
table::merge_cols() in html-defs.php
Apply a colspan in an existing table. The row and column of the
Method merge_rows
table::merge_rows() in html-defs.php
Merge rows at a given cell column.
Page metadata-defs.php
metadata-defs.php in metadata-defs.php
Constant METADATA_DISABLED
METADATA_DISABLED in response-defs.php
Disable metadata editing and generation enhancements
Method metadata_element
Constructor
Class metadata_element
metadata_element in metadata-defs.php
A class which encapsulates a metadata element. This is the actual object which will be rendered into the end-user content (eg. the webpage), and contains everything necessary for that process.
Constant METADATA_ENABLED
METADATA_ENABLED in response-defs.php
Enable metadata editing and generation enhancements
Class metadata_scheme
metadata_scheme in metadata-defs.php
A class which encapsulates a metadata scheme. This is a set of
Method metadata_scheme
Constructor
Method metadata_tree
Returns a string containing a table which contains all of the meta data in a nice tree view.
Method metatag
metadata_element::metatag() in metadata-defs.php
Render this metadata element as a metatag object. This method creates the metatag object and returns it.
Method meta_element_count
Returns the number of meta elements in this layout.
Method meta_field
fileindexer::meta_field() in search-fileindex-defs.php
Define a field as a meta tag. This ensures that the field will be picked up from the file meta tags, if present. If it is not listed here then it will be ignored.
Class meta_tag
meta_tag in metadata-defs.php
A class which is derived from the generic tag class, and which is specifically for the HTML META tag.
Method meta_tag
meta_tag::meta_tag() in metadata-defs.php
Constructor. Creates an empty HTML meta tag object.
Constant META_TAG_FIELDS
META_TAG_FIELDS in lucene-defs.php
Indicates index fields come from meta tag extraction
Method microsecs
microtimer::microsecs() in timer-defs.php
Returns the micro-seconds on the clock.
Class microsite
microsite in microsite-defs.php
The Microsite Class
Method microsite
microsite::microsite() in microsite-defs.php
Constructor Create a new microsite instance.
Page microsite-defs.php
microsite-defs.php in microsite-defs.php
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
Class microsite_page
microsite_page in microsite-defs.php
Microsite Page - a container class.
Method microsite_page
microsite_page::microsite_page() in microsite-defs.php
Constructor
Method microsite_template
Constructor
Class microsite_template
microsite_template in microsite-defs.php
Microsite Template - a container class.
Method microtimer
microtimer::microtimer() in timer-defs.php
Constructor Create a new microtimer.
Class microtimer
microtimer in timer-defs.php
The microtimer class A generic microtimer. This timer allows elapsed times to be measured down to microseconds in theory, although depending on how 'real-time' the OS is, there may well be limitations.
Method millisecs
microtimer::millisecs() in timer-defs.php
Returns the milli-seconds on the clock.
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..
Function mins_diff
mins_diff() in datetime-defs.php
Tell minutes difference between too datetimes Returns the minutes difference between the two given datetimes.
Constant MIN_PLUGIN_SLOTS
MIN_PLUGIN_SLOTS in microsite-defs.php
Constant MIXED
MIXED in mail-defs.php
Mixture of content: text/html/etc.
Function mkpath
mkpath() in file-defs.php
Make sure path exists A utility function which makes sure a given directory path is made, using mkdir as required. This function assumes that permissions are all as needed.
Method modify_replies
Class monitor
monitor in monitor-defs.php
The monitor class. This is the entity which contains the details of what is to be monitored, how it is to be monitored and what to do if a given condition arises.
Method monitor
monitor::monitor() in monitor-defs.php
Create a new monitor object. This is the container for all of the monitors which you can define and use to monitor a complete system.
Page monitor-defs.php
monitor-defs.php in monitor-defs.php
Function monthNameNow
monthNameNow() in datetime-defs.php
Month now as string Returns the month name (eg. "January") as it is now..
Function monthno
monthno() in datetime-defs.php
Return month number Return the number of the named month, default to Jan if problems arise.
Function monthNow
monthNow() in datetime-defs.php
Month now as integer Returns the month (1-12) as it is now.
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
Class multipart_form
multipart_form in form-defs.php
multipart_form class The multipart_form is just a standard form, but with the enctype pre-set to the "multipart/form-data" setting required for file multiparts of binary form data.
Method multipart_form
Create an multipart_form object. Sets basic form attributes.
Constant MULTISELECT
MULTISELECT in form-defs.php
Combo-field is multiple-select
Method must_match
search::must_match() in search-defs.php
Define a search term which the search must match to succeed.
Method must_matchfield
Add search term: must match a field value.
Method must_matchfield
Add search term: must match a field value.
Page my-schema-defs.php
my-schema-defs.php in my-schema-defs.php
n
top
Variable $name
hover::$name in image-defs.php
Name of this element
Variable $name
HTMLObject::$name in html-defs.php
Name of the object
Variable $name
outputfile::$name in file-defs.php
The file name
Variable $name
inputfile::$name in file-defs.php
The file name
Variable $name
parameter::$name in application-defs.php
Parameter name
Variable $name
menu::$name in menu-defs.php
Name of the menu
Variable $name
WMLdo_element::$name in wml-defs.php
Name of the DO element
Variable $name
user::$name in user-defs.php
Formatted full display name of the person
Variable $name
SchemaObject::$name in schema-defs.php
Name of this schema object
Variable $name
monitor::$name in monitor-defs.php
The name of this monitor instance
Variable $name
timeslot::$name in datetime-defs.php
Variable $name
image::$name in image-defs.php
Name of the image element
Variable $name
database::$name in database-defs.php
Name of this database
Variable $name
configfield::$name in configuration-defs.php
Variable $name
setting::$name in application-defs.php
Name of this setting
Variable $name_over
hover::$name_over in image-defs.php
Name of the over version of this element
Variable $nbsp
tablecell::$nbsp in html-defs.php
Force blank content to be non-blank space
Variable $newcat
catalogitem::$newcat in catalog-defs.php
Variable $newcontext
WMLcard::$newcontext in wml-defs.php
True if card has its own context
Variable $newmsg
forum_thread::$newmsg in forum-defs.php
Variable $newstory
story::$newstory in story-defs.php
Variable $new_topic
forum::$new_topic in forum-defs.php
Variable $nice_msecs
fileindexer::$nice_msecs in search-fileindex-defs.php
Number of milli-seconds to wait nicely between indexing calls.
Variable $notnull
dbfield::$notnull in schema-defs.php
Variable $num
dbfield::$num in schema-defs.php
Class named_layout
named_layout in layout-defs.php
Named Layout. A named layout is just another way of grabbing a layout,
Method named_layout
named_layout::named_layout() in layout-defs.php
Constructor
Method newfield
DB_dbtable::newfield() in pg-schema-defs.php
Create a new field in the table with given parameters.
Method newfield
dbtable::newfield() in schema-defs.php
Create a new field in the table with given parameters.
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 NEW_BLOCK
NEW_BLOCK in block-defs.php
Identity value signifying new block
Constant NEW_BLOCKLET
NEW_BLOCKLET in block-defs.php
Identity value signifying new blocklet
Method new_card
WMLdeck::new_card() in wml-defs.php
New card Creates a card and inserts the new card object into the deck.
Constant NEW_CONTACTINFO
NEW_CONTACTINFO in pim-defs.php
Create new contact info ID value
Constant NEW_FORUM
NEW_FORUM in forum-defs.php
A brand new forum
Constant NEW_LAYOUT
NEW_LAYOUT in layout-defs.php
New layout to be created
Constant NEW_MENUOPTION
NEW_MENUOPTION in menumaint-defs.php
Create new menuoption
Constant NEW_MICROSITE_PAGE
NEW_MICROSITE_PAGE in microsite-defs.php
Constant NEW_MICROSITE_TEMPLATE
NEW_MICROSITE_TEMPLATE in microsite-defs.php
Method new_msg
forum_thread::new_msg() in forum-defs.php
Constant NEW_MSG
NEW_MSG in forum-defs.php
A new forum thread message
Method new_msg
thread_msg::new_msg() in forum-defs.php
Constant NEW_ORGANISATION
NEW_ORGANISATION in pim-defs.php
Create new organisation ID value
Constant NEW_STORY
NEW_STORY in story-defs.php
New story ID indicator
Constant NEW_THREAD
NEW_THREAD in forum-defs.php
A new forum thread
Method new_topic
forum::new_topic() in forum-defs.php
Method next_sequencevalue
dbseq::next_sequencevalue() in query-defs.php
Get the next sequence value. We can optionally specify the table and
Method next_sequencevalue
Set the next sequence value for a column, using either a named sequence or, if that is nullstring or the underlying DB does not support sequences, other means. See the next_sequencevalue() method in the underlying DB module db-xxxx.php.
Function next_sequencevalue
DEPRECATED: This global utility function is now deprecated since the
Method next_sequencevalue
Return the next sequence value, given a sequence name, the table and the field it applies to.
Method next_sequencevalue
database::next_sequencevalue() in database-defs.php
Return the next sequence value, given a sequence name, the table and the field it applies to.
Function nicebytesize
nicebytesize() in utils.php
Returns a nicely formatted size string for displaying
Function nicetime
nicetime() in utils.php
Returns a nicely formatted time string in '3d 12h 14m 33s' format, given a number of seconds. Leading elements are suppressed if they are zero.
Constant NICE_DATE
NICE_DATE in datetime-defs.php
Example: Mar 3rd 1999
Constant NICE_DATETIME
NICE_DATETIME in datetime-defs.php
Example: Mar 3rd 1:30pm
Constant NICE_DATE_NOYEAR
NICE_DATE_NOYEAR in datetime-defs.php
Example: Mar 3rd
Constant NICE_FULLDATETIME
NICE_FULLDATETIME in datetime-defs.php
Example: Mar 3rd 1999 1:30pm
Constant NICE_TIME_ONLY
NICE_TIME_ONLY in datetime-defs.php
Example: 1:30pm
Constant NONE
NONE in form-defs.php
Do not force case
Method noscantags
fileindexer::noscantags() in search-fileindex-defs.php
Flag that we should NOT do a tag scan on the content of the files.
Method noshade
hr::noshade() in html-defs.php
Cause HR to be unshaded
Method notify
monitor::notify() in monitor-defs.php
Method to send notification(s)..
Constant NOT_CACHED
NOT_CACHED in webpage-defs.php
The webpage is not cached
Constant NOT_INDEXED
NOT_INDEXED in lucene-defs.php
Used to indicate that a field should NOT be indexed by Lucene
Constant NOT_MAPPED
NOT_MAPPED in control-panel.php
Used to indicate items do not have a remote mapping
Constant NOT_PERSISTENT
NOT_PERSISTENT in database-defs.php
Connect non-persistent to DB
Constant NOT_STORED
NOT_STORED in lucene-defs.php
Used to indicate that a field should NOT be stored by Lucene
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
Constant NO_ROLLBACK_ON_FAIL
NO_ROLLBACK_ON_FAIL in query-defs.php
Transaction response to failure - do nothing
Constant NULLVALUE
NULLVALUE in query-defs.php
This value indicates a NULL field value for queries
Method numrows
datasources::numrows() in database-defs.php
Return the number of rows returned by a SELECT query.
Method numrows
database::numrows() in database-defs.php
This method must be defined in the child class.
o
top
Variable $obligation
metadata_element::$obligation in metadata-defs.php
Whether optional, mandatory, conditional or recommended
Variable $obligation_desc
Obligation, descriptive
Variable $offset
sqlquery::$offset in query-defs.php
The OFFSET value
Variable $onblur
HTMLObject::$onblur in html-defs.php
Script to call onblur
Variable $onchange
HTMLObject::$onchange in html-defs.php
Script to call onchange
Variable $onclick
button::$onclick in button-defs.php
Script to be executed onclick
Variable $onclick
HTMLObject::$onclick in html-defs.php
Script to call when mouse clicked
Variable $onclick_form_submit
Whether to allow form submit on-click
Variable $onclick_form_submit
Whether to allow form submit on-click
Variable $ondblclick
HTMLObject::$ondblclick in html-defs.php
Script to call when mouse double-clicked
Variable $ondelete
dbtrigger::$ondelete in schema-defs.php
If true, fire trigger on DELETE
Variable $onfocus
HTMLObject::$onfocus in html-defs.php
Script to call onfocus
Variable $oninsert
dbtrigger::$oninsert in schema-defs.php
If true, fire trigger on INSERT
Variable $onkeydown
HTMLObject::$onkeydown in html-defs.php
Script to call on key down
Variable $onkeypress
HTMLObject::$onkeypress in html-defs.php
Script to call on key pressed
Variable $onkeyup
HTMLObject::$onkeyup in html-defs.php
Script to call on key up
Variable $onload
HTMLObject::$onload in html-defs.php
Script to call onload
Variable $onload
body::$onload in webpage-defs.php
The script to execute when the page has loaded
Variable $onmousedown
HTMLObject::$onmousedown in html-defs.php
Script to call on mouse button down
Variable $onmousemove
HTMLObject::$onmousemove in html-defs.php
Script to call on mouse button down
Variable $onmouseout
HTMLObject::$onmouseout in html-defs.php
Script to call on mouse off object
Variable $onmouseout
image::$onmouseout in image-defs.php
Script to execute on mouse-out
Variable $onmouseout
Link::$onmouseout in button-defs.php
Script to execute on mouse out
Variable $onmouseover
image::$onmouseover in image-defs.php
Script to execute on mouse-over
Variable $onmouseover
Link::$onmouseover in button-defs.php
Script to execute on mouse over
Variable $onmouseover
HTMLObject::$onmouseover in html-defs.php
Script to call on mouse over object
Variable $onmouseup
HTMLObject::$onmouseup in html-defs.php
Script to call on mouse button up
Variable $onselect
HTMLObject::$onselect in html-defs.php
Script to call onselect
Variable $onsubmit
form::$onsubmit in form-defs.php
Script to call on form submit
Variable $ontimerhref
URL to go to when timer expires
Variable $onupdate
dbtrigger::$onupdate in schema-defs.php
If true, fire trigger on UPDATE
Variable $opened
outputfile::$opened in file-defs.php
True if file was sucessfully opened
Variable $opened
inputfile::$opened in file-defs.php
True if file was opened
Variable $operator
term::$operator in search-defs.php
Join operator, one of: 'AND', 'OR', 'NOT', 'AND NOT'
Variable $optcount
optlist::$optcount in optlist-defs.php
Number of options
Variable $optional
WMLdo_element::$optional in wml-defs.php
True if optional
Variable $opts
optlist::$opts in optlist-defs.php
Array of options
Variable $orderby
sqlquery::$orderby in query-defs.php
The ORDER BY clause
Variable $ordered
WMLcard::$ordered in wml-defs.php
True if the card is "ordered"
Variable $orgid
organisation::$orgid in pim-defs.php
Organisation ID
Variable $org_contact
Contact person name
Variable $org_name
organisation::$org_name in pim-defs.php
Organisation name
Variable $orientation
Group orientation: 'horizontal' or 'vertical'
Variable $orientation
menu::$orientation in menu-defs.php
Menu orientation: HORIZONTAL or VERTICAL
Variable $other_attributes
embed::$other_attributes in html-defs.php
Array of non-std attributes as name/value pairs
Variable $output_mode
Modes of output for debugging content
Page od-schema-defs.php
od-schema-defs.php in od-schema-defs.php
Method offset
sqlquery::offset() in query-defs.php
Define query OFFSET
Class ol
ol in html-defs.php
[OL] - Ordered list
Method ol
ol::ol() in html-defs.php
Constructor
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 openfile
inputfile::openfile() in file-defs.php
Open a new file, or the default file as defined by the path in the class variable 'datafname'. If $path is defined then this becomes the new default file.
Method open_webstream
webstream::open_webstream() in webpage-defs.php
Start webstream output channel..
Class optlist
optlist in optlist-defs.php
A class to make handling command line options a bit easier and more consistent.
Method optlist
optlist::optlist() in optlist-defs.php
Instantiate the optlist object. This does all the work since we expect that this is being done to process command line arguments/options.
Page optlist-defs.php
optlist-defs.php in optlist-defs.php
Method opt_exists
optlist::opt_exists() in optlist-defs.php
Return status of the named option. Returns true if the option exists or false if it does not exist.
Method opt_value
optlist::opt_value() in optlist-defs.php
Return the value of the named option. Returns the string associated with this option, or false if it does not exist.
Page or-schema-defs.php
or-schema-defs.php in or-schema-defs.php
Method orderby
db_search::orderby() in dbsearch-defs.php
Define search ORDER BY clause
Method orderby
sqlquery::orderby() in query-defs.php
Define order field list Defines the Sort order field list. The fields can be an array, or a delimited list. If the latter, then default delimiter is a comma, unless you specify your own.
Class organisation
organisation in pim-defs.php
The organisation class manages a single set of information related to a "organisation". This is an identity distinct from the system-oriented uuser record, and is intended to be a generic mechanism for storing data on human beings.
Method organisation
Constructor Create a new organisation object.
Method outputfile
outputfile::outputfile() in file-defs.php
Constructor
Class outputfile
outputfile in file-defs.php
The outputfile class manages files for outputting content. This includes both appending to an existing file, and creating new files. The method used in both cases is to write to a temporary file, and then rename/move it onto the final file path when closefile() is called.
Method ovenready_data
Add ready-made data Use a ready-made, piping hot source of data. This should be a normal Key/Value pair associative array..
p
top
Variable $padimage
treemenu::$padimage in treemenu-defs.php
Image to use for padding/indenting menu options
Variable $padsize
treemenu::$padsize in treemenu-defs.php
Size of level indent padding in px
Variable $pageno
pages::$pageno in paging-defs.php
Current page number
Variable $pager_condition_threshold
Threshold condition for paging
Variable $pages
microsite::$pages in microsite-defs.php
Pages in this microsite (array)
Variable $pagesize
pages::$pagesize in paging-defs.php
Size of each page in characters
Variable $pageStyle
htmlarea_config::$pageStyle in htmlarea-defs.php
style included in the iframe document (default nullstring)
Variable $pagetext
pages::$pagetext in paging-defs.php
Text for current page
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
microsite_page::$page_id in microsite-defs.php
Axyl sitepage ID (Fk)
Variable $page_id
response::$page_id in response-defs.php
Page ID - key to ax_sitepage record
Variable $page_path
microsite_page::$page_path in microsite-defs.php
Axyl sitepage page filepath
Variable $page_title
microsite_page::$page_title in microsite-defs.php
Title of this page
Variable $paginghref
pages::$paginghref in paging-defs.php
URL for getting next page
Variable $parameters
setting::$parameters in application-defs.php
Variable $params
EmbeddedObject::$params in html-defs.php
Array of parameter key-values
Variable $ParentMsg
thread_msg::$ParentMsg in forum-defs.php
Variable $parent_element_id
The element ID of the parent element of this item
Variable $parent_id
menuitem::$parent_id in menu-defs.php
ID of parent menuitem of this menuitem
Variable $parent_id
menuoption::$parent_id in menu-defs.php
Parent ID of this menu option
Variable $parms
body::$parms in webpage-defs.php
Miscellaneous content for the body tag
Variable $parser
xmlparser::$parser in xml-defs.php
Parser object
Variable $passwd
database::$passwd in database-defs.php
Default password to connect as
Variable $passwd_alphanum_mixed
Security profile: if true, passwords must be mixture of alpha & numeric
Variable $passwd_apply_stopwords
Security profile: if true, passwords must not match built-in stopword list
Variable $passwd_char_uniqueness
Security profile: char uniqueness level - none, low, medium, or high
Variable $passwd_delay_ms
user::$passwd_delay_ms in user-defs.php
Security profile: delay in millisec after a password failure
Variable $passwd_encryption
user::$passwd_encryption in user-defs.php
Security profile: how passwords are encrypted:
Variable $passwd_encryption
maintainer::$passwd_encryption in maintainer-defs.php
If true, password field content is encrypted
Variable $passwd_expiry_days
user::$passwd_expiry_days in user-defs.php
Security profile: no. of days a password lasts
Variable $passwd_expiry_ts
user::$passwd_expiry_ts in user-defs.php
Date-time that the password will expire at (Unix timestamp)
Variable $passwd_failures
user::$passwd_failures in user-defs.php
Number of consequetive password failures we have had
Variable $passwd_forever
user::$passwd_forever in user-defs.php
Flag, true if user password never expires
Variable $passwd_history
user::$passwd_history in user-defs.php
Array of previously used passwords
Variable $passwd_history_cycle
Security profile: password history cycle - number of saved passwords
Variable $passwd_max_attempts
Security profile: no. of consequetive password failures allowed
Variable $passwd_min_chars
user::$passwd_min_chars in user-defs.php
Security profile: min characters in a new password
Variable $password
user_self_registration::$password in selfregistration-defs.php
Variable $password
user::$password in user-defs.php
Text password (encrypted or plain)
Variable $password
postgres_monitor::$password in monitor-defs.php
Password of username to connect as
Variable $path
configfile::$path in file-defs.php
Path to the config file
Variable $perms
permissions::$perms in user-defs.php
Array of permisssions. This is an associative array with the
Variable $persistent
database::$persistent in database-defs.php
True if we want a persistent connection
Variable $persistent_hosts
response::$persistent_hosts in response-defs.php
Array of hosts we wish to connect persistently to
Variable $phone
contactinfo::$phone in pim-defs.php
phone
Variable $phone
user_self_registration::$phone in selfregistration-defs.php
Variable $phone_fax
contactinfo::$phone_fax in pim-defs.php
phone_fax
Variable $phone_mobile
phone_mobile
Variable $phone_work
contactinfo::$phone_work in pim-defs.php
phone_work
Variable $physicalpath
catalogitem::$physicalpath in catalog-defs.php
Variable $pid
lockfile::$pid in lockfile-defs.php
Process ID of process lockfile is for
Variable $pidfile
process_monitor::$pidfile in monitor-defs.php
Path to the PID file containing a process ID for the running process. Leave
Variable $pkey
dbtable::$pkey in schema-defs.php
Array of field attnum's which are primary keys in table
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 $plugins
form_wysiwygfield::$plugins in htmlarea-defs.php
Plugins we want to register for this field
Variable $pluginset
webpage::$pluginset in webpage-defs.php
Set of plugins with content
Variable $pluginspage
embed::$pluginspage in html-defs.php
URL of page to acquire the relevant object plugin
Variable $pluginspage
URL of page to acquire the relevant embed plugin
Variable $plugin_contents
plugin::$plugin_contents in plugin-defs.php
Array of plugin content objects
Variable $plugin_slots
microsite::$plugin_slots in microsite-defs.php
Number of plugin slots we provide to edit page plugins
Variable $port
searchengine_connection::$port in search-lucene-defs.php
PORT that the server is listening on
Variable $port
fileindexer::$port in search-fileindex-defs.php
Port to connect to
Variable $port
postgres_monitor::$port in monitor-defs.php
For TCP connections: port to connect to
Variable $port
searchengine_monitor::$port in monitor-defs.php
Search engine port
Variable $port
lucene_connection::$port in lucene-defs.php
PORT that the server is listening on
Variable $port
database::$port in database-defs.php
Port to access it via TCP
Variable $position
digital_clock::$position in clock-defs.php
Positioning mode
Variable $posted_publish
Flag to indicate POST told us to publish
Variable $posted_revert
named_layout::$posted_revert in layout-defs.php
Flag to indicate POST told us to revert
Variable $postfields
WMLgo::$postfields in wml-defs.php
Array of fields to post
Variable $posts
forum::$posts in forum-defs.php
Variable $posturl
Calendar::$posturl in calendar-defs.php
Variable $preferred
metadata_scheme::$preferred in metadata-defs.php
Whether this is the 'preferred' scheme, of many
Variable $preferred_scheme_id
ID of preferred scheme for this metadata element
Variable $prefix
recmaintainer::$prefix in recmaint-defs.php
Prefix to differentiate one set of records from anther
Variable $prefix_last_modified
The prefix string for last modified datetime
Variable $preview_img_height
Height of preview in px
Variable $preview_img_width
Width of preview in px
Variable $primary
dbindex::$primary in schema-defs.php
True if index is for a primary key
Variable $private
forum::$private in forum-defs.php
Variable $privileges
layout::$privileges in layout-defs.php
The group privilege settings for this layout, as
Variable $privilege_groups
layout::$privilege_groups in layout-defs.php
The groups which have privilege settings for this layout, as
Variable $procname
process_monitor::$procname in monitor-defs.php
Name of the process being monitored.
Variable $profile
webdebugger::$profile in debugger.php
Profiler data array
Variable $profile_timer
Microtimer object for profiling
Variable $progname
optlist::$progname in optlist-defs.php
The current program name
Variable $pseudo_item_spacing
treemenu::$pseudo_item_spacing in treemenu-defs.php
Padding before (above) 'pseudo' menu options
Variable $ps_all_cmd
process_monitor::$ps_all_cmd in monitor-defs.php
The 'ps' command to use for an 'all processes list. This allows override
Variable $ps_pid_cmd
process_monitor::$ps_pid_cmd in monitor-defs.php
The 'ps' command to use for a specific process ID#. This allows override
Variable $publish_output
exec_monitor::$publish_output in monitor-defs.php
Method page
pages::page() in paging-defs.php
Deliver page N Delivers the text content for the specified page.
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 pages
pages in paging-defs.php
Pages class
Method pages
pages::pages() in paging-defs.php
Constructor Creates the basic text paging object.
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.
Page paging-defs.php
paging-defs.php in paging-defs.php
Constant PARALLEL
PARALLEL in mail-defs.php
Parts intended to be viewed all at once
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 parameters
dbfunction::parameters() in schema-defs.php
Return the types parameter list, including brackets.
Method parse
application::parse() in application-defs.php
Parse the application XML which is provided.
Method parse
xmlparser::parse() in xml-defs.php
Parse the given XML document.
Method password_expired
user::password_expired() in user-defs.php
Check whether the password for this user has expired. Returns true if it has, else false.
Method paste_layout
layout::paste_layout() in layout-defs.php
Paste the given layout into this layout, replacing the complete
Method peek_cell
table::peek_cell() in html-defs.php
Peek content from the given row,col cell..
Method perform_hierarchy_scan
Assembles all metadata elements for this layout.
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).
Method permissions
Constructor Create a new permissions object with an optional permissions set.
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 permit
table::permit() in html-defs.php
Set cell permissions across entire table
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.
Method permit
tablecell::permit() in html-defs.php
Set permission for this cell for given agent
Method permit_cell
table::permit_cell() in html-defs.php
Set permission on given table cell. Optionally specify the group which is being targetted (default table body). The specified cell will have its access permission set to the given perm.
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
Constant PERSISTENT
PERSISTENT in database-defs.php
Connect persistent to DB
Page pg-schema-defs.php
pg-schema-defs.php in pg-schema-defs.php
Page pim-defs.php
pim-defs.php in pim-defs.php
Method plaintext_content
story::plaintext_content() in story-defs.php
Return the content of this story formatted for plaintext display
Constant PLAIN_CELL
PLAIN_CELL in block-defs.php
Layout cell content: plain cell
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
plugin::plugin() in plugin-defs.php
Constructor Create a new plugin object.
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 poke_cell
table::poke_cell() in html-defs.php
Poke some content into the given row,col cell..
Method poke_cellcss
table::poke_cellcss() in html-defs.php
Poke a css class/style onto the given row,col cell..
Method postfield
WMLgo::postfield() in wml-defs.php
Define a field to post with this GO element. When fields are defined like this the method is automatically switched to being "post" for the GO element.
Constant POSTGRES_DATE_FORMAT
POSTGRES_DATE_FORMAT in datetime-defs.php
Example: 12-31-1999 23:59:59
Class postgres_monitor
postgres_monitor in monitor-defs.php
A monitor class to check if Postgres is up and about. You need to specify a database and a user (and if required, a password) which can be use to test-connect to Postgres. Optionally you can specify the host and port number if connection is over TCP.
Method postgres_monitor
Define a new Postgres monitor object.
Constant POSTGRES_STD_FORMAT
POSTGRES_STD_FORMAT in datetime-defs.php
Example: 1999-07-17 23:59:59
Method POSTprocess
Calendar::POSTprocess() in calendar-defs.php
Process GET/POST from form.
Method POSTprocess
user_self_registration::POSTprocess() in selfregistration-defs.php
Method POSTprocess
Process a possible POST of a form with new contact info data. We only do anything here if the special var $_save_x is defined (ie. this would be from user clicking button named "_save"), and also the organisation ID $_ORG_org_id. We return true if POST was processed.
Method POSTprocess
named_layout::POSTprocess() in layout-defs.php
Process a block edit form POST.
Method POSTprocess
forum::POSTprocess() in forum-defs.php
Method POSTprocess
story::POSTprocess() in story-defs.php
Process the POST from form. This method deals with POSTed content from the edit form.
Method POSTprocess
metadata_element::POSTprocess() in metadata-defs.php
Process the POST of the form of this metadata element. We are just looking for the few fields containing the relevant data.
Method POSTprocess
Process a possible POST of a form with new contact info data. We only do anything here if the special var $_save_x is defined (ie. this would be from user clicking button named "_save"), and also the contact info IF $_CI_contactinfo_id. We return true if POST was processed.
Method post_to
Calendar::post_to() in calendar-defs.php
Set the URL of script to POST the calendar form to.
Constant PRIMARY_KEY_ONLY
PRIMARY_KEY_ONLY in schema-defs.php
Run getschema() to get primary key(s) only
Method printable
email::printable() in mail-defs.php
Return Printable Content Returns a printable version of the e-mail. Just returns the content as well as all the headers, and if for HTML, then it wraps it all in some (pre) tags. Useful for debugging.
Method process_monitor
Defines a new process monitoring object and provides matching info.
Class process_monitor
process_monitor in monitor-defs.php
A monitor class to check if a given process is running. This can be achieved by consulting a pidfile, or by checking the process status listing for the given process name (the default behaviour).
Method process_navigation
rowmenu::process_navigation() in rowmenu-defs.php
Process any menu navigation.
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.
Function prose_diff
prose_diff() in datetime-defs.php
Tell nice difference between too datetimes
Function prose_diff_ts
prose_diff_ts() in datetime-defs.php
Tell nice difference between too Unix timestamps
Function protocol_prefixed
protocol_prefixed() in utils.php
Detect a URL with the "xxx://" protocol prefix. Returns true if it does, else false.
Method publish
named_layout::publish() in layout-defs.php
Publish a pending named layout. All we do in fact, is to replicate the current pending version of the layout (this one) into a new version. That automatically makes this layout the current LIVE one, and the newly created version becomes the new PENDING one.
Method publish
microsite::publish() in microsite-defs.php
Publish this microsite. We build the dir structures which actually
Method publishto
microsite_template::publishto() in microsite-defs.php
Publish the template(s) into the given directory. The filename will be as per the Axyl standard, depending on template name and type.
Method publishto
microsite_page::publishto() in microsite-defs.php
Publish this microsite page. We create a sitepage record, and save a FK to it, create a menuoption for the page and FK to that, and we create a physical page from the microsite template.
Method publish_request
microsite::publish_request() in microsite-defs.php
Request publishing for this microsite. We just set a database flag so that the cron script will do the work.
Method push_password_history
Push the current password on the history stack. Trim the history
Method put
layout::put() in layout-defs.php
Save the layout.
Method put
menumaintainer::put() in menumaint-defs.php
Save this menu to the database. Create a new one if it doesn't already exist.
Method put
configuration::put() in configuration-defs.php
Save the config.
Method put
blocklet::put() in block-defs.php
Save the blocklet.
Method put
block::put() in block-defs.php
Save the block.
Method put
menuoption::put() in menu-defs.php
Save the menuoption.
q
top
Variable $qp_func
email::$qp_func in mail-defs.php
None at this time
Variable $qualifiers
metadata_scheme::$qualifiers in metadata-defs.php
Array of scheme qualifier objects
Variable $quality
FlashObject::$quality in html-defs.php
Quality setting for the movie
Variable $qual_label
enc_qualifier::$qual_label in metadata-defs.php
Label for qualifier
Variable $qual_name
enc_qualifier::$qual_name in metadata-defs.php
Name of this qualifier
Variable $query
search::$query in search-defs.php
Query string container
Method query
datasources::query() in database-defs.php
Execute a query on the connected database.
Method query
database::query() in database-defs.php
This method must be defined in the child class.
Page query-defs.php
query-defs.php in query-defs.php
Method quickfile
quickfile::quickfile() in file-defs.php
Creates a file containing given content quickly.
Class quickfile
quickfile in file-defs.php
This is a derived class from outputfile and is a quick way of creating a file with content in a single hit. You can check the $created property afterwards to determine success/failure.
Class quickfile_read
quickfile_read in file-defs.php
This is a derived class from inputfile and is a quick way of grabbing all content of a file in a single hit. The resulting string is available as the class 'content' variable, and the variable 'readok' indicates whether the read was a success. File is read, then immediately closed.
Method quickfile_read
Function quoted_valuestring
Returns a value inside quotes. The type of quotes (single or double) are determined from the value content. If the content already has a double quote in it, then single quotes are used, else (default) double quotes are used.
r
top
Variable $readok
quickfile_read::$readok in file-defs.php
True if file was read in successfully
Variable $records
recmaintainer::$records in recmaint-defs.php
Record data to maintain
Variable $recvalid
maintainer::$recvalid in maintainer-defs.php
True if record is valid
Variable $reference
microtimer::$reference in timer-defs.php
Reference time to base elapsed interval on
Variable $reference_url
metadata_scheme::$reference_url in metadata-defs.php
Reference URL for this scheme
Variable $regmode
user_self_registration::$regmode in selfregistration-defs.php
Variable $relative_positioned
HVmenu::$relative_positioned in hvmenu-defs.php
Positioned relatively, or not
Variable $remote_address
response::$remote_address in response-defs.php
The remote IP address
Variable $remote_auth_dbname
user::$remote_auth_dbname in user-defs.php
User authentication remote database name
Variable $remote_auth_fields
user::$remote_auth_fields in user-defs.php
User authentication remote table field mapping
Variable $remote_auth_source
user::$remote_auth_source in user-defs.php
User authentication source
Variable $remote_auth_tablename
User authentication remote user table
Variable $render_form
Calendar::$render_form in calendar-defs.php
Variable $render_subform
Calendar::$render_subform in calendar-defs.php
Variable $replacement
webstream::$replacement in webpage-defs.php
Replacements to make in template
Variable $replies
forum_thread::$replies in forum-defs.php
Variable $replyto
email::$replyto in mail-defs.php
e-mail ReplyTo address
Variable $reportmsg
monitor::$reportmsg in monitor-defs.php
Report staging for email
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
Variable $req_microsite_publish
microsite::$req_microsite_publish in microsite-defs.php
Whether microsite publish is being requested
Variable $req_microsite_remove
microsite::$req_microsite_remove in microsite-defs.php
Whether microsite removal is being requested
Variable $response
searchengine_message::$response in search-lucene-defs.php
Response object which will parse XML content
Variable $response
lucene_message::$response in lucene-defs.php
Response object which will parse XML content
Variable $responsebuf
Raw response content we receive back from the Lucene server
Variable $responsebuf
searchengine_connection::$responsebuf in search-lucene-defs.php
Raw response content we receive back from the SearchEngine server
Variable $return_type
dbfunction::$return_type in schema-defs.php
Variable $rid
dbquery::$rid in query-defs.php
Current row resource ID
Variable $rid
database::$rid in database-defs.php
The result ID last returned by a query on this DB. Also
Variable $root_translation_id
story::$root_translation_id in story-defs.php
Variable $root_translation_lang
Variable $rowcount
dbquery::$rowcount in query-defs.php
Number of rows returned after execute
Variable $rowcount
maintainer::$rowcount in maintainer-defs.php
Row count - total records in table
Variable $rowno
dbquery::$rowno in query-defs.php
Current row in the query
Variable $rows
form_memofield::$rows in form-defs.php
Number of rows in the text box
Variable $rows
matrix::$rows in html-defs.php
Rows in table
Variable $rowspan
tablecell::$rowspan in html-defs.php
Row span that this cell is anchor of
Variable $rowspanned
tablecell::$rowspanned in html-defs.php
Whether this cell is rowspanned (invisible)
Variable $ruler
blocklet::$ruler in block-defs.php
blocklet ruler: 'none', 'top', 'bottom'
Variable $ruler_colour
blocklet::$ruler_colour in block-defs.php
Ruler colour
Variable $ruler_size
blocklet::$ruler_size in block-defs.php
Ruler pixel size
Variable $ruler_width
blocklet::$ruler_width in block-defs.php
Ruler width percent: 0-100
Method raise_condition
monitor::raise_condition() in monitor-defs.php
Raise a condition. The single parameter to this method is a monitor object which will have had its check() method called. This contains the resulting condition and any messages to notify.
Method rawfield
dbrecords::rawfield() in query-defs.php
Get field content Return the field content from the current database array (row).
Method rawquery
searchengine_search::rawquery() in search-query-defs.php
Define the query text directly, without recourse to any of this class's
Method readall
inputfile::readall() in file-defs.php
Reads all of the file contents into class variable $content.
Method readln
inputfile::readln() in file-defs.php
Reads the next line of the file, up to max chars specified.
Method readln
csv_inputfile::readln() in file-defs.php
Reads the next line of the file in the form of an array of fields as delimited by the given charater. Lines can be of a length up to the specified maximum no. of chars.
Method rebuild
sqlquery::rebuild() in query-defs.php
This is useful when you change some part of the query after it has been executed once, and want it to rebuild the SQL anew before it gets executed again.
Page recmaint-defs.php
recmaint-defs.php in recmaint-defs.php
Method recmaintainer
recmaintainer::recmaintainer() in recmaint-defs.php
Define a record maintainer object.
Class recmaintainer
recmaintainer in recmaint-defs.php
The record maintainer class.
Constant RECORD_DELIM
RECORD_DELIM in constants.php
Record delimiter used in record lists
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 refresh
layouteditor::refresh() in layout-editor-defs.php
Refresh the layout reference..
Method refresh
dbrows::refresh() in query-defs.php
Refresh the query Re-run the current SQL query. If successful the row will be stored in $this->current_row.
Method register
response::register() in response-defs.php
Register vars Register given variables for globalisation.
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_button
Register a button.
Method register_field
recmaintainer::register_field() in recmaint-defs.php
Register a form field in the maintainer.
Method register_plugins
Set the plugins to register for this Wysiwyg editor. This is a subset
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.
Constant REMOTE_AUTH_LDAP
REMOTE_AUTH_LDAP in control-panel.php
User data maintained on an LDAP server (not yet implemented)
Constant REMOTE_AUTH_REMOTEDB
REMOTE_AUTH_REMOTEDB in control-panel.php
User data is maintained on a remote database
Method remove
lockfile::remove() in lockfile-defs.php
Remove the lockfile. Can't do this if the lock is frozen, which is deemed to require manual intervention.
Method remove_blocklet
block::remove_blocklet() in block-defs.php
Remove blocklet from the block.
Method remove_menuoption
Remove menuoption from the menu. Just removes the given menuoption from the list in this object - no database changes are made.
Method remove_metadata_element
Removes the layout metadata for a given element. This deletes the relevant record from the ax_layout_metadata table.
Method remove_request
microsite::remove_request() in microsite-defs.php
Remove publishing for this microsite. We just set a database flag
Method render
RenderableObject::render() in renderable.php
Render output
Method render
xmltag::render() in xml-defs.php
Render the tag as XML.
Method render
plugin::render() in plugin-defs.php
Returns the string which represents all of 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
htmlarea_config::render() in htmlarea-defs.php
Render this config as a string of Javascript which could be put into a webapage and used to set the configuration of a real HTMLArea object.
Method render
templated_webpage::render() in webpage-defs.php
Return content to caller
Method render
webpage::render() in webpage-defs.php
Generate the content into the buffer, then return the content.
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.
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.
Page renderable.php
renderable.php in renderable.php
Method render_as_subform
Calendar::render_as_subform() in calendar-defs.php
Set the calendar to be rendered in a sub-form. This is just the same as rendering in a form, except we miss off the form tags.
Method render_days_clickable
Render calendar dates (the individual days) as clickable. This will cause a form submit, with the details of the date clicked on and the calendar will be set to that date.
Method render_in_form
Calendar::render_in_form() in calendar-defs.php
Set the calendar to be rendered in its own form. If your calendar sits in an existing form, then call this method with 'false' to prevent it rendering its own form.
Function render_layouts
render_layouts() in layout-defs.php
Find content layout tags in a string.
Method render_story_icon
story::render_story_icon() in story-defs.php
Return the rendering of the story icon (if one exists) either as a standard HTML anchor tag if an icon URL exists, or as an image.
Method replace
outputfile::replace() in file-defs.php
Replace a pattern in the current $this->content with replacement string. This allows us to work on a template, replacing bits of it that represent our dynamic content.
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 replicate
blockeditor::replicate() in block-editor-defs.php
Replicate this block into a new block with a new set of blocklets as a complete content copy of this original block.
Method replicate
block::replicate() in block-defs.php
Replicate this block into a new block with a new set of blocklets as a complete content copy of this original block.
Method replicate
layouteditor::replicate() in layout-editor-defs.php
Replicate the hosted layout as a new layout. Creates a brand new
Method replicate
layout::replicate() in layout-defs.php
Replicate the hosted layout as a new layout. Creates a brand new
Method ReplyTo
email::ReplyTo() in mail-defs.php
Set replyto Set the e-mail ReplyTo: e-mail address.
Method report_classes
List classes debugger is accepting
Method reset
dat_keyvalues::reset() in data-defs.php
Reset the data Resets the internal array to the start. This is used when you need to repeatedly traverse the data.
Method reset
microtimer::reset() in timer-defs.php
Reset the timer. This zeroes the timer. If it was ticking it goes on ticking, but starting from zero.
Method reset_button
reset_button::reset_button() in button-defs.php
Constructor
Class reset_button
reset_button in button-defs.php
Reset button A standard form reset button appearing as the standard grey widget.
Method reset_search
search::reset_search() in search-defs.php
Reset search to null query and not executed status.
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.
Function resolveFK
resolveFK() in utils.php
Resolve a foreign key value Resolve a simple single-level foreign key. The variable 'display_fields' can contain multiple fields separated by the "|" char. A literal is prefixed by "#".
Method response
WMLdeck::response() in wml-defs.php
Return complete WML response content including DOCTYPE, <wml> tags, and the content-length header.
Class response
response in response-defs.php
THE RESPONSE CLASS
Method response
response::response() in response-defs.php
Constructor Create a new response.
Page response-defs.php
response-defs.php in response-defs.php
Method restart
microtimer::restart() in timer-defs.php
Restart the timer. This zeroes the timer and then starts it. Has same effect as reset() but also makes sure the timer is ticking after resetting internal timer values.
Method rollback
datasources::rollback() in database-defs.php
Roll back the current database transaction. All queries executed as part of the open transaction will be rolled back.
Method rollback
database::rollback() in database-defs.php
Rollback the currently open database transaction.
Function rollback
rollback() in query-defs.php
Rollback a DB transaction
Constant ROLLBACK_ON_FAIL
ROLLBACK_ON_FAIL in query-defs.php
Transaction response to failure - rollback
Method rowcount
table::rowcount() in html-defs.php
Return the number of rows in this table.
Method rowexists
dbrows::rowexists() in query-defs.php
Returns true if the row number exists in the returned resultset.
Method rowmenu
rowmenu::rowmenu() in rowmenu-defs.php
Constructor
Class rowmenu
rowmenu in rowmenu-defs.php
A hierarchical menu renderer which does not use Javascript to implement the menuoption display. NB: this renderer is basically the same functionally as the treemenu but is rendered differently.
Page rowmenu-defs.php
rowmenu-defs.php in rowmenu-defs.php
Method rowstripes
table::rowstripes() in html-defs.php
Define css for row striping with comma-delimted list of css. Any number of these can be added to style rows in a repeating cycle.
s
top
Variable $savehow
outputfile::$savehow in file-defs.php
How to save: default "overwrite", or "append" to append.
Variable $savepw
user_self_registration::$savepw in selfregistration-defs.php
Variable $schedule
monitor::$schedule in monitor-defs.php
Schedule of named timeslots for this monitor
Variable $schema
maintainer::$schema in maintainer-defs.php
Database schema
Variable $schema
SchemaObject::$schema in schema-defs.php
Reference to the schema object this belongs to
Variable $schema_name
metadata_element::$schema_name in metadata-defs.php
The meta schema that this item was sourced from
Variable $schema_namespace
The namespace code for the schema
Variable $schema_namespace_uri
The refence URi for the schema
Variable $schemes
metadata_element::$schemes in metadata-defs.php
Schemes associated with this metadata element. This
Variable $scheme_id
metadata_scheme::$scheme_id in metadata-defs.php
Unique encoding scheme ID
Variable $scheme_id
enc_qualifier::$scheme_id in metadata-defs.php
Unique encoding scheme ID
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 $searchable
metadata_element::$searchable in metadata-defs.php
Whether this element can be searched for
Variable $searchdir
swish_search::$searchdir in swish-defs.php
Directory to do the search from
Variable $searcher
The search engine search object
Variable $searchindex
swish_search::$searchindex in swish-defs.php
Name of index file to use (defaults to 'swish++.index')
Variable $searchquery
db_search::$searchquery in dbsearch-defs.php
The query which runs the search
Variable $searchterm
search::$searchterm in search-defs.php
Array of search terms to match
Variable $seconds
microtimer::$seconds in timer-defs.php
Current number of seconds on the timer
Variable $separator
rowmenu::$separator in rowmenu-defs.php
Separator string between menu options
Variable $separator
menu::$separator in menu-defs.php
Separator character between items
Variable $sequencename
dbseq::$sequencename in query-defs.php
The name of the sequence
Variable $sequences
schema::$sequences in schema-defs.php
Variable $serialno
searchengine_indexmsg::$serialno in search-lucene-defs.php
A unique handle to identify the index
Variable $serialno
lucene_indexmsg::$serialno in lucene-defs.php
A unique handle to identify the index
Variable $session_id
treemenu::$session_id in treemenu-defs.php
The current user session ID
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 $session_track_logins
session::$session_track_logins in session-defs.php
Whether we are tracking session logins
Variable $set
configuration::$set in configuration-defs.php
Set of configuration fields/values in this configuration set
Variable $setchanged
configuration::$setchanged in configuration-defs.php
Whether configuration data has changed or not
Variable $settings
configfile::$settings in file-defs.php
Config settings as an associative array (name=value)
Variable $settings
application::$settings in application-defs.php
Variable $shade
hr::$shade in html-defs.php
Whether HR is shaded or not
Variable $showcontrols
If true the mediaplayer controls are shown
Variable $showlabels
form::$showlabels in form-defs.php
Whether to render labels for fields
Variable $show_last_modified
layout::$show_last_modified in layout-defs.php
True if we should display last modified date
Variable $show_recfilter
maintainer::$show_recfilter in maintainer-defs.php
If true we include a built-in record filter
Variable $show_statusbar
maintainer::$show_statusbar in maintainer-defs.php
If true, status bar is displayed
Variable $sitepage
menuoption::$sitepage in menu-defs.php
Target site webpage when clicked
Variable $sitepage_parms
Paramter string to pass on webpage URL
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 $size
HTMLObject::$size in html-defs.php
Size of the object
Variable $sizeIncludesToolbar
the next parameter specifies whether the toolbar should
Variable $skip_results
search::$skip_results in search-defs.php
No. of results to skip in query (for paging)
Variable $smstxtmsg
monitor::$smstxtmsg in monitor-defs.php
Report staging for SMS txt
Variable $sockfp
lucene_connection::$sockfp in lucene-defs.php
Socket file pointer
Variable $sockfp
searchengine_connection::$sockfp in search-lucene-defs.php
Socket file pointer
Variable $sort_limit_exceeded
Set to true if sort limit was exceeded in query
Variable $sort_limit_exceeded
Set to true if sort limit was exceeded in query
Variable $sort_memory_exceeded
Set to true if Lucene blew its memory trying to sort
Variable $sort_memory_exceeded
Set to true if SearchEngine blew its memory trying to sort
Variable $sql
sqlquery::$sql in query-defs.php
The formatted SQL query itself @see build()
Variable $src
HTMLObject::$src in html-defs.php
Source URL for this object
Variable $src
dbfunction::$src in schema-defs.php
Variable $src
image::$src in image-defs.php
Image file source URL/path
Variable $standby
EmbeddedObject::$standby in html-defs.php
Standby message text
Variable $start
DB_dbsequence::$start in pg-schema-defs.php
Sequence start
Variable $startyear
Calendar::$startyear in calendar-defs.php
Variable $start_disabled
recmaintainer::$start_disabled in recmaint-defs.php
If true, maintainer will be displayed with fields disabled
Variable $state
application::$state in application-defs.php
State of processing
Variable $statusBar
htmlarea_config::$statusBar in htmlarea-defs.php
enable creation of a status bar? (default true)
Variable $sticky
thread_msg::$sticky in forum-defs.php
Variable $sticky
forum_thread::$sticky in forum-defs.php
Variable $stop_on_condition
monitor::$stop_on_condition in monitor-defs.php
Condition to stop on. If this condition is defined then we
Variable $storymode
story::$storymode in story-defs.php
Variable $story_author
story::$story_author in story-defs.php
Variable $story_author_name
story::$story_author_name in story-defs.php
Variable $story_category
story::$story_category in story-defs.php
Variable $story_category_desc
story::$story_category_desc in story-defs.php
Variable $story_content
story::$story_content in story-defs.php
Variable $story_date
story::$story_date in story-defs.php
Variable $story_date_ts
story::$story_date_ts in story-defs.php
Variable $story_headline
story::$story_headline in story-defs.php
Variable $story_icon
story::$story_icon in story-defs.php
Variable $story_icon_url
story::$story_icon_url in story-defs.php
Variable $story_id
story::$story_id in story-defs.php
Variable $story_id
story_media::$story_id in story-defs.php
ID of story this media belongs to
Variable $story_locs
story::$story_locs in story-defs.php
Variable $story_media
story::$story_media in story-defs.php
Variable $story_precis
story::$story_precis in story-defs.php
Variable $story_translations
story::$story_translations in story-defs.php
Variable $story_type
story::$story_type in story-defs.php
Variable $strict
DB_dbfunction::$strict in pg-schema-defs.php
Variable $style
StylableObject::$style in html-defs.php
The style to apply to this object
Variable $style
Link::$style in button-defs.php
Style to apply to the link text
Variable $style
head::$style in webpage-defs.php
Style settings for the webpage
Variable $stylesheet
Xmenu::$stylesheet in xmenu-defs.php
Name of stylesheet file to get menu styles from
Variable $stylesheet
HVmenu::$stylesheet in hvmenu-defs.php
Name of stylesheet file to get menu styles from
Variable $stylesheet
treemenu::$stylesheet in treemenu-defs.php
Path to the stylesheet for menu
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
Variable $SubBorderColor
treemenu::$SubBorderColor in treemenu-defs.php
Colour of sub-menu border
Variable $SubBorderWidth
treemenu::$SubBorderWidth in treemenu-defs.php
Width of sub-menu border in px
Variable $SubHighBgColor
treemenu::$SubHighBgColor in treemenu-defs.php
Colour of sub-menu highlighted item background
Variable $SubHighColor
treemenu::$SubHighColor in treemenu-defs.php
Colour of sub-menu highlighted item text
Variable $subject
forum_thread::$subject in forum-defs.php
Variable $subject
email::$subject in mail-defs.php
Subject of the e-mail
Variable $SubLowBgColor
treemenu::$SubLowBgColor in treemenu-defs.php
Colour of sub-menu item background
Variable $SubLowColor
treemenu::$SubLowColor in treemenu-defs.php
Colour of sub-menu item normal text
Variable $success_regex
exec_monitor::$success_regex in monitor-defs.php
Variable $success_value
exec_monitor::$success_value in monitor-defs.php
Variable $summaryfield
True if main field should be suppressed
Method save
organisation::save() in pim-defs.php
Save the organisation.
Method save
contactinfo::save() in pim-defs.php
Save the contactinfo.
Method save
user_self_registration::save() in selfregistration-defs.php
Method save
microsite_template::save() in microsite-defs.php
Update or create the microsite template to the database.
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 save
catalogitem::save() in catalog-defs.php
Save current catalog item definition to the database. Inserts if brand new, else performs an update.
Method save
microsite_page::save() in microsite-defs.php
Update or create the microsite page. Also saves the template data associated with it.
Method save
microsite::save() in microsite-defs.php
Save this microsite to the database. Create a new one if it doesn't already exist.
Constant SAVE_FILE
SAVE_FILE in file-defs.php
Save the file on close
Method save_forum
forum::save_forum() in forum-defs.php
Method save_metadata_element
Saves the layout metadata for a given element. This saves data to the ax_layout_metadata table.
Method save_msg
thread_msg::save_msg() in forum-defs.php
Method save_password_data
Save the password data as stored in this object, to the user record.
Method save_story
story::save_story() in story-defs.php
Routine to save the story to the database.
Method save_thread
forum_thread::save_thread() in forum-defs.php
Method scantags
fileindexer::scantags() in search-fileindex-defs.php
Flag that we should do a tag scan on the content of the files to try and extract fields to index. Note that any tags thus found will only be used if the field name has been defined with the method define_field(); This causes both the <title> tag and <meta> tags to be considered.
Class schedule
schedule in datetime-defs.php
Classes to handle a 24-hr time schedule. Covers the setting of * any number of slots, and testing whether a given time is in one of * the slots. The schedule class. Holds multiple timeslots.
Method schedule
schedule::schedule() in datetime-defs.php
Method schema
schema::schema() in schema-defs.php
Create a schema (database) of given name. The name should be a valid existing database name that is currently connected. It will be selected to ensure the correct data is obtained.
Class schema
schema in schema-defs.php
Class describing a database schema. This object hold ALL the information
Page schema-defs.php
schema-defs.php in schema-defs.php
Class SchemaObject
SchemaObject in schema-defs.php
Defines a virtual object which is used to denote something which is a part of an existing database schema.
Method SchemaObject
SchemaObject::SchemaObject() in schema-defs.php
Constructor Every schema object must belong to a schema. This is passed as the first argument, as an object reference. It must also have a name, and this is always passed as the second argument, a string.
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.
Constant SCRIPT_APPEND
SCRIPT_APPEND in utils.php
Add script by keeping current content and appending to the end
Constant SCRIPT_PREFIX
SCRIPT_PREFIX in utils.php
Add script by keeping current content and prefixing to the beginning
Constant SCRIPT_REPLACE
SCRIPT_REPLACE in utils.php
Add script by replacing current content (default)
Function scrub
scrub() in wml-defs.php
Scrubs the given string to make it acceptable to touchy WML parsers in cellphones.
Class search
search in search-defs.php
The search class is an object which can be assigned search terms, can execute a search, and can contain search hits having executed a seach.
Method search
catalog::search() in catalog-defs.php
Perform a search for catalog items. This method will use the search
Method search
search::search() in search-defs.php
Constructor Create a new search.
Page search-defs.php
search-defs.php in search-defs.php
Page search-fileindex-defs.php
search-fileindex-defs.php in search-fileindex-defs.php
Page search-index-defs.php
search-index-defs.php in search-index-defs.php
Page search-lucene-defs.php
search-lucene-defs.php in search-lucene-defs.php
Page search-query-defs.php
search-query-defs.php in search-query-defs.php
Page search-utility-defs.php
search-utility-defs.php in search-utility-defs.php
Function searchengine_backup
searchengine_backup() in search-utility-defs.php
Function to make a backup of the SearchEngine index. This would commonly be used after a batch of items have been successfully optimized (which indicates a sound index).
Class searchengine_connection
searchengine_connection in search-lucene-defs.php
The SearchEngine connection class
Method searchengine_connection
Constructor - SearchEngine connection. Normally this will just be called with no host/port, and the object is just initialised ready for the call to send(). If called with host/port, then the connection is fired up immediately.
Function searchengine_documentcount
searchengine_documentcount() in search-utility-defs.php
Function to acquire the SearchEngine index codument count. This is similar to the healthcheck function, since it uses the same utility command, but it just returns the numeric result that the command goes and acquires as part of testing whether the server is alive.
Function searchengine_healthcheck
searchengine_healthcheck() in search-utility-defs.php
Function to check the SearchEngine index for 'health'. This determines that the search engine server is alive, and can access the number of documents in its index (which is what it goes and does).
Class searchengine_indexer
searchengine_indexer in search-index-defs.php
The indexer class. This class inherits all the functionality of the searchengine_connection, searchengine_msg and searchengine_message classes. It adds indexing-specific methods.
Method searchengine_indexer
Constructor Make a new SearchEngine indexer.
Method searchengine_indexmsg
Constructor Make a new SearchEngine index message.
Class searchengine_indexmsg
searchengine_indexmsg in search-lucene-defs.php
The SearchEngine index message class. This class inherits all the functionality of the searchengine_connection, searchengine_msg and searchengine_message classes. It adds indexing-specific methods.
Method searchengine_message
Constructor This is a more complex class which builds on the basic searchengine_msg class to provide some higher level methods for adding fields in specific ways to support CONTROL, QUERY and INDEX message types.
Class searchengine_message
searchengine_message in search-lucene-defs.php
The SearchEngine message class. This class extends its parent class searchengine_msg and adds some higher level methods for adding groups of fields to the message.
Method searchengine_monitor
Define a new Search Engine monitor object. We register the query to use and the number of hits we expect. You can also specify the hostname and port of the Search server here, although Axyl users can leave these out (blank) if they have configured them with setup-system.php.
Class searchengine_monitor
searchengine_monitor in monitor-defs.php
A monitor class to check if the search engine is up and about
Class searchengine_msg
searchengine_msg in search-lucene-defs.php
The SearchEngine msg class. This is a raw class which holds the basic message fields and data and knows how to build them into a full message for sending to the SearchEngine server.
Method searchengine_msg
searchengine_msg::searchengine_msg() in search-lucene-defs.php
Constructor
Function searchengine_optimize
searchengine_optimize() in search-utility-defs.php
Function to optimize the SearchEngine index. This would commonly be used after a batch of items have been indexed.
Function searchengine_purge
searchengine_purge() in search-utility-defs.php
Function to purge the SearchEngine index of all indexes to documents. Yes, I'll repeat that - it DELETES ALL DOCUMENTS FROM THE INDEX, permanently, finito, shazam, ba-boom, as in "Omigod did I *really* mean to do that!?".
Class searchengine_purgemsg
searchengine_purgemsg in search-lucene-defs.php
The SearchEngine purge message class. This class allows you to remove all
Method searchengine_purgemsg
Constructor Make a new SearchEngine purge message. This message is provided to allow you to delete all items from the SearchEngine index. It is just a special case of the unindex message.
Method searchengine_purger
Constructor Make a new SearchEngine index purger. This message is provided to allow you to delete all items from the SearchEngine index.
Class searchengine_purger
searchengine_purger in search-utility-defs.php
The lucene purge message class. This class allows you to remove all
Class searchengine_querymsg
searchengine_querymsg in search-lucene-defs.php
The SearchEngine query message class. This class inherits all the functionality of the searchengine_connection, searchengine_msg and searchengine_message classes. It adds query-specific methods for searching.
Method searchengine_querymsg
Constructor Make a new SearchEngine query message. You can specify the application to use here, and also an optional query string to send.
Class searchengine_search
searchengine_search in search-query-defs.php
The SearchEngine search class
Method searchengine_search
Constructor
Method searchengine_unindexer
Constructor Make a new SearchEngine unindexer. This is provided to allow you to delete an item from the SearchEngine index. It has a single method 'unindex' which takes the ID of the item to delete.
Class searchengine_unindexer
searchengine_unindexer in search-index-defs.php
The SearchEngine unindexer class. This class allows you to remove an item from the SearchEngine index. You must know the unique ID that identifies the document.
Method searchengine_unindexmsg
Constructor Make a new SearchEngine unindex message. This message is provided to allow you to delete an item from the SearchEngine index. It has a single method 'unindex' which takes the ID of the item to delete.
Class searchengine_unindexmsg
searchengine_unindexmsg in search-lucene-defs.php
The SearchEngine unindex message class. This class allows you to remove an item from the SearchEngine index. You must know the unique ID that identifies the document.
Method searchengine_utilitycmd
Constructor
Class searchengine_utilitycmd
searchengine_utilitycmd in search-utility-defs.php
The SearchEngine utility message class. Used for special SearchEngine operations.
Method searchengine_utilitymsg
Constructor
Class searchengine_utilitymsg
searchengine_utilitymsg in search-lucene-defs.php
The SearchEngine utility message class. Used for special SearchEngine operations.
Method secs
microtimer::secs() in timer-defs.php
Returns the seconds on the clock as a floating point number.
Constant SECS_1_DAY
SECS_1_DAY in constants.php
One day
Constant SECS_1_HOUR
SECS_1_HOUR in constants.php
1 hour
Constant SECS_1_MONTH
SECS_1_MONTH in constants.php
One month
Constant SECS_1_WEEK
SECS_1_WEEK in constants.php
One week
Constant SECS_1_YEAR
SECS_1_YEAR in constants.php
One year
Constant SECS_4_HOURS
SECS_4_HOURS in constants.php
4 hours
Constant SECS_8_HOURS
SECS_8_HOURS in constants.php
8 hours
Constant SECS_10_YEARS
SECS_10_YEARS in constants.php
Ten years - used as 'forever'
Constant SECS_12_HOURS
SECS_12_HOURS in constants.php
12 hours
Constant SECS_20_MINS
SECS_20_MINS in constants.php
20 minutes
Method select
datasources::select() in database-defs.php
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 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.
Function select_database
select_database() in query-defs.php
Global function to set the selected database to a new database. All subsequent queries will then act on that database.
Page selfregistration-defs.php
selfregistration-defs.php in selfregistration-defs.php
Method send
searchengine_connection::send() in search-lucene-defs.php
Sends a message to the SearchEngine server, and receives the response. We operate on the understanding that every time we send something to SearchEngine we expect a response. Since this method already calls the recieve() method, there is no need to call it from your application.
Method send
lucene_indexmsg::send() in lucene-defs.php
Send the message to Lucene, and then post-process the response for indication of a successful index operation. We expect to receive a response back from Lucene which has our serialno in it. This method returns True if the indexing was successful, else False.
Method send
searchengine_msg::send() in search-lucene-defs.php
Sends the current message to SearchEngine, and checks for protocol errors in the received response.
Method send
templated_webpage::send() in webpage-defs.php
Send content to user browser
Method send
searchengine_utilitymsg::send() in search-lucene-defs.php
Send the message to SearchEngine, and then post-process the response for indication of a successful utility operation. We expect to receive a response back from SearchEngine which has nothing much it, unless there has been an error.
Method send
searchengine_unindexmsg::send() in search-lucene-defs.php
Send the message to SearchEngine, and then post-process the response for indication of a successful index operation.
Method send
lucene_connection::send() in lucene-defs.php
Sends a message to the Lucene server, and receives the response. We operate on the understanding that every time we send something to Lucene we expect a response. Since this method already calls the recieve() method, there is no need to call it from your application.
Method send
searchengine_indexmsg::send() in search-lucene-defs.php
Send the message to SearchEngine, and then post-process the response for indication of a successful index operation. We expect to receive a response back from SearchEngine which has our serialno in it. This method returns True if the indexing was successful, else False.
Method send
webpage::send() in webpage-defs.php
Generate the content and then send it to the user browser.
Method send
lucene_msg::send() in lucene-defs.php
Sends the current message to Lucene, and checks for protocol errors in the received response.
Method send
lucene_querymsg::send() in lucene-defs.php
Send the message to Lucene, and then post-process the response for
Method send
searchengine_querymsg::send() in search-lucene-defs.php
Send the message to SearchEngine, and then post-process the response for
Method send
lucene_utilitymsg::send() in lucene-defs.php
Send the message to Lucene, and then post-process the response for indication of a successful utility operation. We expect to receive a response back from Lucene which has nothing much it, unless there has been an error.
Method send
email::send() in mail-defs.php
Send the email Send mail via local mailer. This is usually the end-result of an e-mail sequence and results in the e-mail being sent.
Method send_confirmation_email
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
Send debug output to a file.
Method send_to_file
webstream::send_to_file() in webpage-defs.php
Send content to file Deliver the content to a given file.
Constant SEP_BAR
SEP_BAR in menu-defs.php
Menu item separator: "|" (pipe)
Constant SEP_DBLSPACE
SEP_DBLSPACE in menu-defs.php
Menu item separator: " " (double-space)
Constant SEP_SPACE
SEP_SPACE in menu-defs.php
Menu item separator: " " (space)
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.
Method session
session::session() in session-defs.php
Constructor Create a new session.
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 set
dbtrigger::set() in schema-defs.php
Set the vars for this trigger
Method set
dbindex::set() in schema-defs.php
Set index variables.
Method set
dbfunction::set() in schema-defs.php
Set the vars for this function
Method set
dbconstraint::set() in schema-defs.php
Set constraint variables.
Method set
sqlquery::set() in query-defs.php
Define field assignments Defines the field assignment clauses for UPDATE and INSERT queries.
Method setaccesskey
Set the access key of the object
Method setalign
HTMLObject::setalign() in html-defs.php
Set the horizontal alignment eg: left, center, right
Method setalignment
tablecell::setalignment() in html-defs.php
Set the alignment of this cell
Method setalt
HTMLObject::setalt() in html-defs.php
Set the ALT text
Method setattribute
xmltag::setattribute() in xml-defs.php
Set a tag attribute key=value pair.
Method setbackground
Set the background image (url)
Method setbgcolor
HTMLObject::setbgcolor() in html-defs.php
Set the background colour
Method setborder
HTMLObject::setborder() in html-defs.php
Border thickness (pixels)
Method setcellid
tablecell::setcellid() in html-defs.php
Set the cell ID
Method setclass
Set the class (from stylesheet) for the object
Method setcolor
HTMLObject::setcolor() in html-defs.php
Set the foreground colour
Method setcolspan
tablecell::setcolspan() in html-defs.php
Set the number of columns this cell spans
Method setcontent
tablecell::setcontent() in html-defs.php
Set the content for this cell
Method setcontentcss
Set the style or class for the content of this cell
Method setcss
StylableObject::setcss() in html-defs.php
Set class or style for the object. A style is detected by the presence of the colon (:) character in the string.
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 setdefault
dbtable::setdefault() in schema-defs.php
Return SQL to set the default for given field on this table.
Method setheight
HTMLObject::setheight() in html-defs.php
Set the height specifier of the element
Method sethspace
HTMLObject::sethspace() in html-defs.php
Horizontal spacing (pixels)
Method setid
StylableObject::setid() in html-defs.php
Set the ID tag of the object
Method setimage
Sets the image to display for this button.
Method setlabel
form_field::setlabel() in form-defs.php
Set the label associated with the field
Method setlang
HTMLObject::setlang() in html-defs.php
Set the language for text content
Method setlangdir
HTMLObject::setlangdir() in html-defs.php
Set the text direction for text content: 'rtl' or 'ltr'
Method setmetrics
tablecell::setmetrics() in html-defs.php
Set the width and height of this cell
Method setname
HTMLObject::setname() in html-defs.php
Set the name of the object
Method setnbsp
table::setnbsp() in html-defs.php
Set nbsp setting for cells in this table
Method setnullconstraint
dbtable::setnullconstraint() in schema-defs.php
Return SQL to set the NULL/NOT NULL constraint..
Method setnullconstraint
DB_dbtable::setnullconstraint() in pg-schema-defs.php
Return SQL to set the NULL/NOT NULL constraint..
Method setpadding
table::setpadding() in html-defs.php
Set the table padding and spacing amounts. This sets the table 'cellpadding' and 'cellspacing' attributes, in that order.
Method setparam
Set up a new object parameter name/value pair. This will be rendered as a param name="foo" value="bar" tag.
Method setparameter
setting::setparameter() in application-defs.php
Set the value of a parameter which already exists in this setting.
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 setrowspan
tablecell::setrowspan() in html-defs.php
Set the number of rows this cell spans
Method setsize
HTMLObject::setsize() in html-defs.php
Set the size specifier of the element
Method setsrc
HTMLObject::setsrc() in html-defs.php
Set the src URL/relative path
Method setstyle
Append a style to ant exitsing style the object has.
Method setstyle
Link::setstyle() in button-defs.php
Sets the style Sets the style for the href tag.
Method settabindex
HTMLObject::settabindex() in html-defs.php
Set the TAB index of the object (with alias)
Method settarget
HTMLObject::settarget() in html-defs.php
Set the frame target.
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 settingexists
Return true if named setting is defined
Method settingscount
Return number of config settings
Method settitle
HTMLObject::settitle() in html-defs.php
Set the title of this element
Method seturl
img::seturl() in html-defs.php
Set URL. When the image is clicked, the browser will target the URL. Note that this will not work if you have defined the onclick event handler.
Method setvalign
HTMLObject::setvalign() in html-defs.php
Set the vertical-alignment eg: top, middle, bottom
Method setvalue
form_field::setvalue() in form-defs.php
Set the value of the field
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 setvspace
HTMLObject::setvspace() in html-defs.php
Vertical spacing (pixels)
Method setwidth
HTMLObject::setwidth() in html-defs.php
Set the width specifier of the element
Method set_allowed_groups
maintainer::set_allowed_groups() in maintainer-defs.php
Restrict access. Use this method to restrict maintainer access to the specified group membership. This will cause the RESPONSE to be sent without any content.
Method set_allowed_types
Set the allowed list of filetypes. This is specified as a comma-delimited list, and replaces any already defined.
Method set_application
Specify the application. The application is the name of a configuration
Method set_application
searchengine_msg::set_application() in search-lucene-defs.php
Specify the application. The application is the name of a configuration
Method set_attribute
This defines a key=value pair which will be rendered in the form of '$attrname="$attrvalue"' inside the HTML object tag when rendered.
Method set_authentication_type
Set website authentication
Method set_background_colours
Set backgrounds colours Sets the background colours for each menu level. Provide either a delimited list of colours in a string in #nnnnnn format, or an array of same. The first colour is for LEVEL 0, second LEVEL 1 etc.
Method set_blocked_ips
response::set_blocked_ips() in response-defs.php
define a blocked IP list.
Method set_blockformats
Set a new list of selectable block formats. The array should be an
Method set_buffering_mode
response::set_buffering_mode() in response-defs.php
Set buffering option
Method set_categories
catalog::set_categories() in catalog-defs.php
Define the list of user categories which is used to categorise the catalog items in this catalog. This is submitted as an associative array with a single word string as key, and a multi-word string as the value (category description).
Method set_cell
table::set_cell() in html-defs.php
Replace the given cell with new table cell. Returns true if ok.
Method set_charset
head::set_charset() in webpage-defs.php
Set the charset for this head section
Method set_char_encoding
Set the database character encoding. This affects the encoding of characters in the database.
Method set_char_encoding
database::set_char_encoding() in database-defs.php
This method must be defined in the child class.
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_condition_thresholds
Sets the threshold at which we will send messages to email & pager.
Method set_confirmation
button::set_confirmation() in button-defs.php
Sets parameter string associated with the button.
Method set_confirm_text
Set the confirmation text to popup on click.
Method set_confirm_text
Set the confirmation text to popup on click using Javascript.
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. This method protects against silliness by detecting nullstring cookienames, and re-defining them to a default name based on the application prefix. Null cookienames are a very bad idea all around.
Method set_css_date
Set the style of class for the date display
Method set_css_time
Set the style of class for the time display
Method set_daterange
search::set_daterange() in search-defs.php
Set date range Set the date range for the search. This is just recording the given date information for use by child classes of this one. We do not even care what the format of the dates is. They are just stored.
Method set_datestyle
database::set_datestyle() in database-defs.php
This method must be defined in the child class.
Method set_datestyle
datasources::set_datestyle() in database-defs.php
Set the database date style. This affect the format that dates will be displayed in, and the format they are submitted in.
Method set_datetimeformat
maintainer::set_datetimeformat() in maintainer-defs.php
Sets a datetime format string for a specified field. This influences the formatting of displayed dates and/or times in that field.
Method set_date_format
Set the format for the date display. This is just done by replacement in a format string where d=month date, M=month name, m=month no, cc=century, and yy=year (99). Eg. 'm d, ccyy' would give 'April 4, 2005'. Another example would be 'd/m/yy' which would render '4/4/05'.
Method set_dbversion
schema::set_dbversion() in schema-defs.php
Set the database version
Method set_default
datasources::set_default() in database-defs.php
Internal function to set the name of the default database.
Method set_default_images
Xmenu::set_default_images() in xmenu-defs.php
Set the standard images up. This method just re-asserts that the Xmenu should use the standard Xmenu images for arrows, spacer etc.
Method set_disabledfields
maintainer::set_disabledfields() in maintainer-defs.php
Specify that the given fields should be disabled, not editable. Field is seen on screen, but is not modifiable.
Method set_displayonly
Set the field to be display-only (non-editable)
Method set_display_property
Set a display property for the clock. Display property IDs are defined at the top of this script, and can be any type of content. NB: Boolean properties are so arranged that the default is always false.
Method set_domain
lucene_msg::set_domain() in lucene-defs.php
Specify a domain. A domain is an identifier which groups indexed objects internally to Lucene. This allows searches on multiple archives of documents in a single Lucene installation.
Method set_domain
searchengine_msg::set_domain() in search-lucene-defs.php
Specify a domain. A domain is an identifier which groups indexed objects internally to SearchEngine. This allows searches on multiple archives of documents in a single SearchEngine installation.
Method set_dtd
response::set_dtd() in response-defs.php
Set the DTDs array for all possible content types for this webpage.
Method set_dtd
head::set_dtd() in webpage-defs.php
Set the DTD specifier string for this head section.
Method set_emit_status
monitor::set_emit_status() in monitor-defs.php
Control the emission of status and status message associated with the most sever monitor error. The monitor defaults to not doing this so you should call this method without parameters to turn it on.
Method set_encoding
response::set_encoding() in response-defs.php
Sets the content-type header characterset encoding, and (optionally)
Method set_fieldblurb
maintainer::set_fieldblurb() in maintainer-defs.php
Associates a string of text 'blurb' with the field. This will be presented just sitting below the field as explanatory text.
Method set_fieldcss
maintainer::set_fieldcss() in maintainer-defs.php
Sets the CSS style/class for a field.
Method set_fielddisplayproc
maintainer::set_fielddisplayproc() in maintainer-defs.php
Associates a function with the field which will be called when data is displayed to format the content. Only really useful for text/memo/numeric fields. The function should accept a string content parameter, and return the re-formatted string content.
Method set_fieldlabel
maintainer::set_fieldlabel() in maintainer-defs.php
Sets the label of the field, which then takes the place of the default naming which uses a proper-cased version of the field name, with underscores replaced by spaces.
Method set_fieldpostproc
maintainer::set_fieldpostproc() in maintainer-defs.php
Associates a function with the field which will be called when data is POSTed to format the content. Only really useful for text/memo/numeric fields. The function should accept a string content parameter, and return the re-formatted string content.
Method set_fieldsequence
maintainer::set_fieldsequence() in maintainer-defs.php
Associates a named sequence with a field. This is so we can create new records using that sequence to populate the record field.
Method set_fieldsize
maintainer::set_fieldsize() in maintainer-defs.php
Sets the size of the field in pixels, width x height
Method set_fieldtexttype
maintainer::set_fieldtexttype() in maintainer-defs.php
Sets the type of a text field. This is a generic type and the
Method set_fieldvalidationproc
Associates a function with the field which will be called when data is POSTed to validate the content. The function should accept a string content parameter, and return true (if valid) or false.
Method set_fieldwidth_pct
Set the proportion of the form taken up by the form field elements as opposed to the labels. This is specified as an integer which is the proportion as a percentage. Eg: 70 would be '70%'.
Method set_first
lucene_message::set_first() in lucene-defs.php
Specify query offset field 'First'. This sets the offset for the returned results. For example, if this was set to 3, and Lucene found 20 hits, then results would be sent back from the 3rd hit onwards.
Method set_first
searchengine_message::set_first() in search-lucene-defs.php
Specify query offset field 'First'. This sets the offset for the returned results. For example, if this was set to 3, and SearchEngine found 20 hits, then results would be sent back from the 3rd hit onwards.
Method set_font
Link::set_font() in button-defs.php
Sets the font Deprecated. Sets the font to use with the link text. Better to use a stylesheet these days.
Method set_font
menuitem::set_font() in menu-defs.php
Set the menu item font
Method set_fontnames
Set a new list of selectable font families. This array should be an
Method set_fontsizes
Set a new list of selectable font sizes. The sizes array should be
Method set_format
Set field format (WML)
Method set_formenctype
maintainer::set_formenctype() in maintainer-defs.php
Specify the maintainers form encoding type. This will enable us to use file upload fields within the maintainer.
Method set_formfieldwidget
maintainer::set_formfieldwidget() in maintainer-defs.php
Use given user interface element for maintaining specified table field.
Method set_formname
Set the name of the form this will be displayed in.
Method set_formname
maintainer::set_formname() in maintainer-defs.php
Set the name of the form we should use. Sometimes this is useful when other entities are using the same form.
Method set_forum_greeting
forum::set_forum_greeting() in forum-defs.php
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_hiddenbuttons
maintainer::set_hiddenbuttons() in maintainer-defs.php
Specify that the given buttons should be hidden. BY default all the usual buttons are available. This method allows you to list those which should NOT be shown. Possible button names are: 'save', 'reset', 'add', 'remove', 'cancel', 'refresh'.
Method set_hiddenfields
maintainer::set_hiddenfields() in maintainer-defs.php
Specify that the given fields should be hidden, not editable. Value will be submitted on POST (save) via hidden field in form.
Method set_host_and_port
Sets the search engine host and port for the connection
Method set_href
Link::set_href() in button-defs.php
Sets the URL Sets the URL to go to when the link is clicked. usually this is specified on instantiation.
Method set_http_host
response::set_http_host() in response-defs.php
Set the hostname of the machine serving this Axyl website. This is usually the same as that in the global $HTTP_HOST variable.
Method set_image
image_button::set_image() in button-defs.php
Sets the image to display for this button.
Method set_image
img::set_image() in html-defs.php
Set the image src and details for this image object.
Method set_image
hover_button::set_image() in button-defs.php
Sets button mouse-out image Sets the standard image for this button. This is the image which is shown with the mouse NOT over the top of it.
Method set_image
hover::set_image() in image-defs.php
Define normal image This is the image which is displayed when the mouse is 'out'.
Method set_image_over
Sets button mouse-over image Sets the mouse-over image for this button. This is the image which is shown with the mouse over the top of it.
Method set_image_over
hover::set_image_over() in image-defs.php
Define over image This is the image which is displayed when the mouse is 'over'.
Method set_itemfont
menu::set_itemfont() in menu-defs.php
Set the font of all menu items
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_labelfields
maintainer::set_labelfields() in maintainer-defs.php
Associates a list of fieldnames on a table to use as the label for a drop-down select reference. This is mainly so you can specify meaningful label strings for drop-down selects on foreign keyed fields, although it will work on any table, not just FKs.
Method set_language
Set the language of the content of this meta data element
Method set_lifetime
session::set_lifetime() in session-defs.php
Set session lifetime Set the session cookie lifetime in seconds.
Method set_limit
lucene_message::set_limit() in lucene-defs.php
Specify query limit field. This sets the maximum number of results that Lucene should return.
Method set_limit
searchengine_message::set_limit() in search-lucene-defs.php
Specify query limit field. This sets the maximum number of results that SearchEngine should return.
Method set_linkover_text
image::set_linkover_text() in image-defs.php
Set linkover text Defines the text to show when the mouse moves over the image.
Method set_linkover_text
Set linkover text Defines the text to show when the mouse moves over the image.
Method set_linkover_text
Defines the text to show when the mouse moves over the object.
Method set_linkover_text
Link::set_linkover_text() in button-defs.php
Set status text to show on mouseover Will do a mouseover status message, if onmouseover is not already defined, otherwise it will be ignored. This is useful to avoid long and ugly URL's appearing in the status bar.
Method set_maxresults
search::set_maxresults() in search-defs.php
Set maximum results Sets the maximum results to return from the search.
Method set_maxsize
fileupload::set_maxsize() in file-defs.php
Set the maximum filesize allowed
Method set_menu_images
Xmenu::set_menu_images() in xmenu-defs.php
Over-rides the standard icon images used to indicate submenus and spaces. The values passed should be image objects as instances of the 'img' class (@see img()).
Method set_menu_images
treemenu::set_menu_images() in treemenu-defs.php
Over-rides the standard '+' and '-' icon images used to indicate a sub-menu can be expanded or collapsed. The values passed should be image image objects as instances of the 'img' class (@see img()).
Method set_metadata_mode
response::set_metadata_mode() in response-defs.php
Set metadata mode
Method set_metatag
webpage::set_metatag() in webpage-defs.php
Add a meta tag to the webpage head section.
Method set_metatag
head::set_metatag() in webpage-defs.php
Add meta tag to the section
Method set_metrics
Set the HTMLArea sizing. The default is 'auto' for both width and height, which gives you an editing area filling the are that the original memofield widget would have filled.
Method set_microsites_mode
response::set_microsites_mode() in response-defs.php
Set microsites mode
Method set_moderator
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_nonblankfields
maintainer::set_nonblankfields() in maintainer-defs.php
Specify that the given field should be non-blank. This causes a check to be made on form submit and if any field is empty (nullstring) then a warning message is displayed and submit is prevented.
Method set_omittedfields
maintainer::set_omittedfields() in maintainer-defs.php
Specify that the given field should be omitted from the form
Method set_onblur
HTMLObject::set_onblur() in html-defs.php
Set the onblur script
Method set_onchange
Set the onchange script
Method set_onclick
HTMLObject::set_onclick() in html-defs.php
Set the on click script
Method set_onclick
button::set_onclick() in button-defs.php
Sets parameter string associated with the button.
Method set_ondblclick
Set the on doubleclick script
Method set_onfocus
HTMLObject::set_onfocus() in html-defs.php
Set the onfocus script
Method set_onkeydown
Set the on keydown script
Method set_onkeypress
Set the on keypress script
Method set_onkeyup
HTMLObject::set_onkeyup() in html-defs.php
Set the on keyup script
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_onload
HTMLObject::set_onload() in html-defs.php
Set the onload script
Method set_onmousedown
Set the on mousedown script
Method set_onmousemove
Set the on mousemove script
Method set_onmouseout
Set the on mouseout script
Method set_onmouseover
Set the on mouseover script
Method set_onmouseup
Set the on mouseup script
Method set_onselect
Set the onselect script
Method set_onsubmit
form::set_onsubmit() in form-defs.php
Set onsubmit script Defines the onsubmit script to call when the user submits the form.
Method set_ontimer
Activate a timer Sets up the parameters for a timer.
Method set_orderfields
maintainer::set_orderfields() in maintainer-defs.php
Associates a list of fieldnames on a table to use as the ordering for a drop-down select reference. Note: The list of field names should be comma-delimited.
Method set_pagestyle
Set the HTMLArea page style. This is the overall style setting(s) which are applied to the HTMLArea widget and so here is where you determine such basic things as the font settings of the content which is displayed/edited etc.
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_passwd_encryption
Whether passwords are encrypted or not. If true then we just apply the standard MD5 algorithm to the content.
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_password_expiry
Set the password expiry timestamp afresh. We use the settings for how long passwords should last, and add this to the time now to get the expiry datetime.
Method set_paste_intercept
Set the HTMLArea Paste mode. If set to true, then the HTMLArea
Method set_persistent_hosts
Define persistent hosts list.
Method set_position
Set the position and the positioning directive for the clock.
Method set_preview_metrics
Set the width and height of the preview image. The default setting is 125 x 125 pixels.
Method set_query
lucene_querymsg::set_query() in lucene-defs.php
Set the query for this message. There can be only one query defined.
Method set_query
searchengine_querymsg::set_query() in search-lucene-defs.php
Set the query for this message. There can be only one query defined.
Method set_range
searchengine_message::set_range() in search-lucene-defs.php
Specify a range on a field for querying. We specify the name of a field
Method set_range
lucene_message::set_range() in lucene-defs.php
Specify a range on a field for querying. We specify the name of a field
Method set_remote_authentication
Set the user authentication method. This determines how we authenticate the user. Normally we just authenticate via the local database, but this method allows that to be varied for remotely maintained account details.
Method set_remove_regex
Set the regular expression to use for removing dis-allowed HTML tags from the editor content. This allows you to specify a regex matching those tags you don't want to ever appear in the content.
Method set_returnfields
Specify the fields you want returned from SearchEngine.
Method set_returnfields
Specify the fields you want returned from Lucene.
Method set_rows
Set the number of rows for this memo field.
Method set_scheme
metadata_element::set_scheme() in metadata-defs.php
Set the scheme used to define the content of this meta data element. If the tag of the scheme is not specified, then we go and find it by looking up the scheme record in the DB.
Method set_searchdir
Set search directory Set the root directory to go to and search from.
Method set_searchindex
Set search index filename Defines the index filename to use for searching. If no filename is specified in the constructor (@see swish_search()) or via this method, then the default is used: 'swish++.index'.
Method set_searchquery
db_search::set_searchquery() in dbsearch-defs.php
Define the search query object
Method set_security_profile
Set the user security profile. This is a bunch of parameters which will are applied to ALL users, including this one, when passwords are being set, created or otherwise checked.
Method set_separator
rowmenu::set_separator() in rowmenu-defs.php
Set the separator string.
Method set_sequencevalue
dbseq::set_sequencevalue() in query-defs.php
Set a sequence value.
Method set_sequencevalue
Set the sequence value, given a sequence name, the table and the field it applies to.
Method set_sequencevalue
database::set_sequencevalue() in database-defs.php
This method must be defined in the child class.
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_session_track_logins
Set session track logins flag If set True this causes the session logins for this site to be tracked for each user. This amounts to an extra DB update of a login count field.
Method set_size
Set select field size in lines.
Method set_skipresults
search::set_skipresults() in search-defs.php
Set skip results
Method set_sortorder
Specify the fields you want query results to be ordered by.
Method set_sortorder
searchengine_message::set_sortorder() in search-lucene-defs.php
Specify the fields you want query results to be ordered by.
Method set_sql
dbrows::set_sql() in query-defs.php
Set the SQL statement In this case we re-execute the SQL automatically.
Method set_sql
dbquery::set_sql() in query-defs.php
Set the SQL statement
Method set_src
image::set_src() in image-defs.php
Set image details Allow setting of src and metrics from outside.
Method set_statusbar
Set the HTMLArea statusbar display mode, true or false.
Method set_stopwords
searchengine_message::set_stopwords() in search-lucene-defs.php
Supply a stopword list to SearchEngine.
Method set_stopwords
Supply a stopword list to lucene.
Method set_stop_on_condition
Set the condition to stop checking monitor on. If this is set to something other than COND_NONE, then the first time a monitor is raised to this condition the checking process is stopped.
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_styles
form_wysiwygfield::set_styles() in htmlarea-defs.php
Set the styles to provide for this Wysiwyg editor. Styles are displayed
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_success_regex
Allows you to specify a regular expression which will be applied to the output of the executed script/program and if matched will be taken to mean the check was successful. If specified, this takes the place of the default behaviour of checking the return code.
Method set_success_value
Allows you to specify a string value which, if returned as output by the called script/program, will indicate success.
Method set_tabindex
Alias for settabindex(), deprecated, backward compat.
Method set_tag_value
Set the tag value of this meta data element. This is used when the content is NOT a URI/URL. If it is, then use set_uri() instead.
Method set_template
Set the template file Base webpage content on a template. We echo this to the buffer.
Method set_template
webpage::set_template() in webpage-defs.php
Define the template for the webpage.
Method set_theme
webpage::set_theme() in webpage-defs.php
Define the theme
Method set_timelimits
lockfile::set_timelimits() in lockfile-defs.php
Set the time limits. Some commonsense has to be applied here. You
Method set_timeout
Set the socket timeout. Deals with the special case of setting the socket to non-blocking mode (zero timeout)..
Method set_timeout
searchengine_connection::set_timeout() in search-lucene-defs.php
Set the socket timeout. Deals with the special case of setting the socket to non-blocking mode (zero timeout)..
Method set_timezone
Set the timezone to use for this clock. The argument should be an integer (or decimal) in the range +12 to -12, in hours offset from GMT.
Method set_title
maintainer::set_title() in maintainer-defs.php
Set the title of this maintainer. The default is derived from the name of the maintained table, with 'Maintenance' appended. Otherwise set your own title using this method.
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 set_titlefont
menu::set_titlefont() in menu-defs.php
Set the menu tite font
Method set_today
Calendar::set_today() in calendar-defs.php
Set the 'today' date for the calendar. This is the date that is reset to when the user clicks on the 'TODAY' button. Of course it defaults to the current date when the calendar object is created, but this method allows for customised 'today' settings.
Method set_toolbar
Set a new toolbar definition. Toolbars are arrays of arrays of lists
Method set_to_gmt
digital_clock::set_to_gmt() in clock-defs.php
Special set timezone case - setting to GMT (0 hours offset).
Method set_type
form::set_type() in form-defs.php
Set the form type This can be 'normal' or 'subform'. Use the subform variant when you already have <form> tags being provided by other means. Then when you render the subform only the fields will be returned.
Method set_undo_steps
Set the HTMLArea undo steps maximum. The default number is 20. Use this method to change that.
Method set_update_interval_secs
Set the number of seconds to wait before updating the clock each time.
Method set_uri
metadata_element::set_uri() in metadata-defs.php
Set the tag value to be a URI. Same as setting tag value but we also flick the uri flag as well.
Method set_value
configuration::set_value() in configuration-defs.php
Put a value in a field, in a set of the config.
Method set_variable
Define a variable This variable will be sent to the server when the user clicks the link.
Method set_viewonlyfields
maintainer::set_viewonlyfields() in maintainer-defs.php
Specify that the given field should be displayed on the form as text (view-only) but will not be submitted with the form.
Method set_visibility
Set the starting visibility for the clock. In case you want to reveal/hide it with some javascript.
Method set_width
Set select field width. Note that selects can only have width set using a style, since they normally auto-set the width to the max length of their options display strings.
Method set_width
Set the field width (usually in characters).
Method set_width_profile
Set a width profile across the row of cells. The profile is passed as either a string or an array. If a string, the widths should be separated by commas. The widths can be absolute pixel values or %'s, and applies these widths to the first row of the given group.
Method set_window_target
Specific function for use with the rugbyvu framework. This causes a button click to open another browser window as a popup.
Method set_wrapmode
Set the wrap mode for the textarea.
Method set_year_limits
Calendar::set_year_limits() in calendar-defs.php
Set the starting and finishing year for the calendar - the range of operation. This defaults to +/-10 years around the current year.
Method shade
hr::shade() in html-defs.php
Cause HR to be shaded
Method shellconfigfile
Class shellconfigfile
shellconfigfile in file-defs.php
A system configuration file in the form of a shell script. These are in the standard NAME=VALUE format, but implemented as 'sh' scripts so that other scripts can use them via '.'. This class is provided to allow Php scripts to easily access the config settings in these too.
Constant SHORT_DATETIME
SHORT_DATETIME in datetime-defs.php
Example: Mar 3 21:30
Method show_24hrs
digital_clock::show_24hrs() in clock-defs.php
Method show_date
digital_clock::show_date() in clock-defs.php
Method show_date_first
Method show_dayname
Method show_inline
Method show_seconds
Constant SINGLESELECT
SINGLESELECT in form-defs.php
Combo-field is single-select
Method sitemap
menumaintainer::sitemap() in menumaint-defs.php
Render the whole menu layout hierarchy as a sitemap, which simply gives links to each menu page.
Method sitemenu
sitemenu::sitemenu() in menu-defs.php
Constructor
Class sitemenu
sitemenu in menu-defs.php
Site Menu class - a database-enabled extension of the menu class.
Constant SOCK_FOREVER
SOCK_FOREVER in lucene-defs.php
Wait on socket forever (well, 24hrs is that, more or less)
Constant SOCK_NO_WAIT
SOCK_NO_WAIT in lucene-defs.php
Do not wait on socket receive, return immediately
Constant SOCK_RETRIES
SOCK_RETRIES in lucene-defs.php
Times to retry timed-out socket sends/receives
Method span
tablecell::span() in html-defs.php
Flag this cell as being spanned
Method split_cols
table::split_cols() in html-defs.php
Remove a colspan from an existing table. The row and column of the cell which has the colspan is given. As a result the relevant spanned cells will be removed from the table.
Method split_rows
table::split_rows() in html-defs.php
Split rows at a given cell column.
Method SQL
datasources::SQL() in database-defs.php
Given an Axyl SQL query object, build the SQL string from it in suitable format for the currently connected database server.
Method SQL
database::SQL() in database-defs.php
Given an Axyl SQL query object, build the SQL string from it in suitable format for the currently connected database server.
Class sqlquery
sqlquery in query-defs.php
SQLquery class An SQL Statement Text Container.
Method sqlquery
sqlquery::sqlquery() in query-defs.php
Constructor Create a new SQL Query object.
Constant SQL_FORMAT
SQL_FORMAT in datetime-defs.php
Example: 12/31/1999 23:59:59
Page ss-schema-defs.php
ss-schema-defs.php in ss-schema-defs.php
Method start
microtimer::start() in timer-defs.php
Start the timer. Starts the timer ticking. If it was already ticking then there is no change in status.
Function start_transaction
start_transaction() in query-defs.php
Start a DB transaction. Alias for begin_transaction()
Constant STD_DMY
STD_DMY in datetime-defs.php
Example: 23/5/2001
Constant STD_ONCLICK
STD_ONCLICK in button-defs.php
This value is used with buttons. If specified in place of
Constant STD_ONCLICK_NEWWIN
STD_ONCLICK_NEWWIN in button-defs.php
Same as above, execpt we are indicating that we want the action to be directed to a new window.
Constant STD_WIDTH
STD_WIDTH in form-defs.php
Standard width for a textual form element
Method stick_thread
Method stop
microtimer::stop() in timer-defs.php
Stop the timer This freezes the internal seconds value, and stops the timer from ticking.
Method store
fileupload::store() in file-defs.php
Store the current upload file. Optionally specify a destination dir, and a filename. This is useful if you want to process each file separately, and need to store the uploaded file in a particular place.
Method storeall
fileupload::storeall() in file-defs.php
Store all files away at destination dir. We use the original names by default.
Constant STORED
STORED in lucene-defs.php
Used to indicate that a field should be stored by Lucene
Class story
story in story-defs.php
A class which encapsulates a story or article item. Provides methods to get/save to database, edit the story in a popup window, and view it.
Method story
story::story() in story-defs.php
Constructor
Page story-defs.php
story-defs.php in story-defs.php
Class story_media
story_media in story-defs.php
A container class for media item associated with a story. Contains a single piece of media which is associated with this story.
Method story_media
story_media::story_media() in story-defs.php
Create a new piece of story media. This comprises a catalogitem object, and a set of methods to access it.
Function strip_http_prefix
strip_http_prefix() in utils.php
Strip off any xxxx:// protocol prefix from a URL. Usually in Axyl, this is "http://", hence the name of this function.
Method StylableObject
Constructor Create a stylableobject. Sets basic field attributes.
Class StylableObject
StylableObject in html-defs.php
StylableObject This is a virtual class representing something which can have its look changed by applying styles and/or classnames to it.
Method style
stylesheet::style() in file-defs.php
Return a style setting(s) for given class name in the list format: "attrib:def;attrib:def; ..." Also allow specification of a particular attribute within the class to return the style setting for.
Method stylesheet
stylesheet::stylesheet() in file-defs.php
Constructor Open the given stylesheet file for input.
Class stylesheet
stylesheet in file-defs.php
Open a file which contains a stylesheet and read in the style settings. This is a special case of inputfile.
Method subform
subform::subform() in form-defs.php
Create a subform object. Sets basic form attributes.
Class subform
subform in form-defs.php
SubForm class The sub-form is a special case of the form class. The difference is that it is expected to be part of an existing form, and therefore is rendered without the form tags.
Method Subject
email::Subject() in mail-defs.php
Set subject
Class submit_button
submit_button in button-defs.php
Submit button
Method submit_button
Constructor
Page swish-defs.php
swish-defs.php in swish-defs.php
Method swish_search
Constructor
Class swish_search
swish_search in swish-defs.php
The swish search class
Method synchronize
application::synchronize() in application-defs.php
Make this current application object the same structure as the
Method syncparms
menuoption::syncparms() in menu-defs.php
Synchronise sitepage parameters with manually edited values. This
t
top
Variable $tabindex
HTMLObject::$tabindex in html-defs.php
TAB index of the object
Variable $table
DB_dbconstraint::$table in pg-schema-defs.php
Table (object) to apply constraint to
Variable $table
maintainer::$table in maintainer-defs.php
Table requiring maintenance (object)
Variable $tablename
dbconstraint::$tablename in schema-defs.php
Name of table constraint is applied to
Variable $tablename
dbindex::$tablename in schema-defs.php
Name of table index is built on
Variable $tablename
table::$tablename in html-defs.php
Tablename. Required. An internal name for use in debugging etc.
Variable $tablename
dbtrigger::$tablename in schema-defs.php
Name of table to apply trigger to
Variable $tables
schema::$tables in schema-defs.php
Variable $tables
sqlquery::$tables in query-defs.php
List of tables in the query
Variable $Tablestyle
treemenu::$Tablestyle in treemenu-defs.php
Overall class for the menu table
Variable $table_autojustify
layout::$table_autojustify in layout-defs.php
Table autojustify flag
Variable $table_autojustify
True if we autojustify table
Variable $table_rowstripes
layout::$table_rowstripes in layout-defs.php
Table rowstriping mode flag
Variable $table_rowstripes
blocklet::$table_rowstripes in block-defs.php
True if we autojustify table
Variable $table_style
blocklet::$table_style in block-defs.php
Table style to apply to content
Variable $table_style
layout::$table_style in layout-defs.php
Table style to apply for plain cells table
Variable $table_width
layout::$table_width in layout-defs.php
Table width specification
Variable $tag
application::$tag in application-defs.php
Current/last tag opened
Variable $tagname
xmltag::$tagname in xml-defs.php
Name of the XML tag
Variable $tag_name
metadata_element::$tag_name in metadata-defs.php
The full tag name of this element
Variable $tag_name
tag::$tag_name in renderable.php
Variable $tag_name
metadata_scheme::$tag_name in metadata-defs.php
Scheme name to be used in meta tags
Variable $tag_value
metadata_element::$tag_value in metadata-defs.php
The content of this metadata tag. This is the actual metadata
Variable $tag_value
tag::$tag_value in renderable.php
Variable $tandemfield
The second field object in tandem with this one
Variable $tandemwidth
Overall width in pixels
Variable $target
image_button::$target in button-defs.php
Target URL for a window to open when button clicked
Variable $target
HTMLObject::$target in html-defs.php
Traget frame for this object
Variable $target
img::$target in html-defs.php
Target frame for URL
Variable $target
Link::$target in button-defs.php
Target frame for the URL
Variable $tempfname
outputfile::$tempfname in file-defs.php
Full pathname of destination (temporary) file
Variable $template
microsite_page::$template in microsite-defs.php
The microsite template object applied to this page
Variable $template
webpage::$template in webpage-defs.php
The name of the template which was applied, if any
Variable $template
WMLdeck::$template in wml-defs.php
Optional template
Variable $templatefile
webpage::$templatefile in webpage-defs.php
The file the template content is to be found in
Variable $templates
microsite::$templates in microsite-defs.php
Templates in this microsite (array)
Variable $template_content
Template content
Variable $template_contents
Content of template file when read in
Variable $template_fname
Full pathname of template file
Variable $template_fp
outputfile::$template_fp in file-defs.php
File pointer
Variable $template_name
Template name
Variable $template_type
Template type 'html' or 'wml'
Variable $text
term::$text in search-defs.php
The text of this search term
Variable $text
forum_thread::$text in forum-defs.php
Variable $text
WMLanchor::$text in wml-defs.php
Text to display for the anchor/link
Variable $theme
webpage::$theme in webpage-defs.php
Theme to apply to the page. This should be a single-word ID, and
Variable $threadlast_author
forum::$threadlast_author in forum-defs.php
Variable $thread_id
forum_thread::$thread_id in forum-defs.php
Variable $thread_id
thread_msg::$thread_id in forum-defs.php
Variable $thread_msgs
forum_thread::$thread_msgs in forum-defs.php
Variable $ticking
microtimer::$ticking in timer-defs.php
True if the timer is ticking
Variable $timeoutsecs
fileindexer::$timeoutsecs in search-fileindex-defs.php
Timeout for indexing commands in seconds (can usually leave
Variable $timeoutsecs
Timeout for send in seconds
Variable $timeoutsecs
searchengine_connection::$timeoutsecs in search-lucene-defs.php
Timeout for send in seconds
Variable $timer
lucene_connection::$timer in lucene-defs.php
An execution timer
Variable $timer
database::$timer in database-defs.php
Microtimer for query execute timing
Variable $timer
response::$timer in response-defs.php
Reponse timer
Variable $timer
searchengine_connection::$timer in search-lucene-defs.php
An execution timer
Variable $timer
fileindexer::$timer in search-fileindex-defs.php
Indexing execution timer
Variable $timerval
WMLcontainer::$timerval in wml-defs.php
Timer expiry interval (in 10ths of seconds)
Variable $timeslots
schedule::$timeslots in datetime-defs.php
Array of timeslots in a schedule.
Variable $tinow
monitor::$tinow in monitor-defs.php
The current Unix timestamp
Variable $title
image_button::$title in button-defs.php
Title/tooltip
Variable $title
search::$title in search-defs.php
Title for heading of output
Variable $title
WMLfieldset::$title in wml-defs.php
Title of the set of fields
Variable $title
WMLcard::$title in wml-defs.php
Card title/banner
Variable $title
head::$title in webpage-defs.php
Title of the webpage
Variable $title
menu::$title in menu-defs.php
Title/banner for this menu
Variable $title
maintainer::$title in maintainer-defs.php
Title of this maintenance page
Variable $title
HTMLObject::$title in html-defs.php
Title of the object
Variable $title
WMLanchor::$title in wml-defs.php
Title of the anchor
Variable $title_font
menu::$title_font in menu-defs.php
Font settings for the title/banner
Variable $to
email::$to in mail-defs.php
Address to send e-mail
Variable $toolbar
htmlarea_config::$toolbar in htmlarea-defs.php
The toolbar. This takes the form of an array of arrays of toolbar
Variable $toolbar_basic
htmlarea_config::$toolbar_basic in htmlarea-defs.php
A basic toolbar definition. Use for entering text in given
Variable $toolbar_full
htmlarea_config::$toolbar_full in htmlarea-defs.php
A fully-populated toolbar definition for power users
Variable $toolbar_medium
A medium toolbar definition, adds colour, links, raw HTML editing,
Variable $topy
digital_clock::$topy in clock-defs.php
Y-offset from top
Variable $top_item_spacing
treemenu::$top_item_spacing in treemenu-defs.php
Padding before (above) the top-level menu options
Variable $total_logins
user::$total_logins in user-defs.php
Total logins so far
Variable $tot_block
layout::$tot_block in layout-defs.php
Total cells containing a content block
Variable $tot_cols
layout::$tot_cols in layout-defs.php
Total columns in layout
Variable $tot_editable
layout::$tot_editable in layout-defs.php
Total editable plain content cells
Variable $tot_empty
layout::$tot_empty in layout-defs.php
Total empty/undefined cells
Variable $tot_plain
layout::$tot_plain in layout-defs.php
Total plain content cells
Variable $tot_rows
layout::$tot_rows in layout-defs.php
Total rows in layout
Variable $tot_viewable
layout::$tot_viewable in layout-defs.php
Total viewable plain content cells
Variable $tot_wysiwyg
layout::$tot_wysiwyg in layout-defs.php
Total wysiwyg content cells
Variable $trace
webdebugger::$trace in debugger.php
Array of traced locations
Variable $tracedepth
webdebugger::$tracedepth in debugger.php
Depth of tracing
Variable $triggers
schema::$triggers in schema-defs.php
Variable $ts_end
timeslot::$ts_end in datetime-defs.php
Variable $ts_start
timeslot::$ts_start in datetime-defs.php
Variable $type
WMLdo_element::$type in wml-defs.php
Type of DO element: 'accept', 'prev', 'help', 'reset', 'options', or 'delete'
Variable $type
dbfield::$type in schema-defs.php
Variable $type
dbconstraint::$type in schema-defs.php
Type of constraint 'c' - check, 'p' - pk, 'f' - fk
Variable $type
form::$type in form-defs.php
Type of form 'normal' or 'subform'
Variable $type
parameter::$type in application-defs.php
Parameter type
Variable $type
blocklet::$type in block-defs.php
The blocklet type: 'text', 'list', 'ordered', 'bullets', or 'table'
Variable $type
searchengine_msg::$type in search-lucene-defs.php
Type/name of this message
Variable $type
database::$type in database-defs.php
Type of database eg: "postgres", "mssql_server"..
Variable $type
configfield::$type in configuration-defs.php
Variable $type
image_button::$type in button-defs.php
Form element type ID
Variable $type
form_field::$type in form-defs.php
Type of field eg: text, hidden, checkbox etc.
Variable $type
sqlquery::$type in query-defs.php
Type of query 'SELECT', 'DELETE', 'INSERT' or 'UPDATE'
Variable $type
lucene_msg::$type in lucene-defs.php
Type/name of this message
Variable $tz
digital_clock::$tz in clock-defs.php
The timezone offset in +/- hours from GMT.
Method table
table::table() in html-defs.php
Table constructor Create a new table object.
Class table
table in html-defs.php
Table.
Method tablecell
tablecell::tablecell() in html-defs.php
Constructor. Create this new table cell object.
Class tablecell
tablecell in html-defs.php
tablecell
Method tables
sqlquery::tables() in query-defs.php
Define table list
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
tag::tag() in renderable.php
Constructor
Method taghtml
HTMLObject::taghtml() in html-defs.php
Render the full tag. This method renders the given tag including all the attributes, as HTML.
Method tag_close
xmlparser::tag_close() in xml-defs.php
Method invoked when a tag is closed
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 tag_open
xmlparser::tag_open() in xml-defs.php
Method invoked when a tag is opened
Method tbody
table::tbody() in html-defs.php
Define a new tbody table group.
Method td
table::td() in html-defs.php
Define a new standard cell for the current row.
Method td_alignment
table::td_alignment() in html-defs.php
Set the working cell alignment properties in one hit. Use this method AFTER you have defined the cell with the td() method.
Method td_colspan
table::td_colspan() in html-defs.php
Set the working cell colspan property. Use this method AFTER you have defined the cell with the td() method.
Method td_content
table::td_content() in html-defs.php
Append content to the working cell. Use this method AFTER you have defined the cell with the td() method.
Method td_contentcss
table::td_contentcss() in html-defs.php
Set the working cell content css properties in one hit. Use this method AFTER you have defined the cell with the td() method. This defines the style or classname to use for the cell content. This will be implemented using span tags.
Method td_css
table::td_css() in html-defs.php
Set the working cell css properties. Use this method AFTER you have defined the cell with the td() method. This defines the style or classname to use for the cell. Note this is for the cell, rather than the content inside the cell.
Method td_height
table::td_height() in html-defs.php
Set the working cell height property. Use this method AFTER you have defined the cell with the td() method.
Method td_metrics
table::td_metrics() in html-defs.php
Set the working cell width and height properties in one hit. Use this method AFTER you have defined the cell with the td() method.
Method td_rowspan
table::td_rowspan() in html-defs.php
Set the working cell rowspan property. Use this method AFTER you have defined the cell with the td() method.
Method td_width
table::td_width() in html-defs.php
Set the working cell width property. Use this method AFTER you have defined the cell with the td() method.
Method template
outputfile::template() in file-defs.php
This defines a template for the file content and flags the file as being of "templated" type. The template is expected to be at the $path specified. The template is opened and the entire file contents are put into $this->content.
Class templated_webpage
templated_webpage in webpage-defs.php
The templated webpage page class
Method templated_webpage
Constructor Create a new templated webpage object.
Method term
term::term() in search-defs.php
Constructor Create a new search term.
Class term
term in search-defs.php
The search term class Something to contain a search term. A search term is basically a string of one or more words to match, together with the operator to apply with the match.
Method termcount
search::termcount() in search-defs.php
Return count of searchterms present in this search.
Method tfoot
table::tfoot() in html-defs.php
Define a new tfoot table group.
Method th
table::th() in html-defs.php
Define a new heading cell for the current row.
Method thead
table::thead() in html-defs.php
Define a new thead table group.
Class thread_msg
thread_msg in forum-defs.php
The thread message class.
Method thread_msg
thread_msg::thread_msg() in forum-defs.php
Method th_alignment
table::th_alignment() in html-defs.php
Alias for td_alignment()
Method th_colspan
table::th_colspan() in html-defs.php
Alias for td_colspan()
Method th_content
table::th_content() in html-defs.php
Alias for td_content()
Method th_contentcss
table::th_contentcss() in html-defs.php
Alias for td_contentcss()
Method th_css
table::th_css() in html-defs.php
Alias for td_css()
Method th_height
table::th_height() in html-defs.php
Alias for td_height()
Method th_metrics
table::th_metrics() in html-defs.php
Alias for td_metrics()
Method th_rowspan
table::th_rowspan() in html-defs.php
Alias for td_rowspan()
Method th_width
table::th_width() in html-defs.php
Alias for td_width()
Method tidyup
dbquery::tidyup() in query-defs.php
Free resources.
Function timeNow
timeNow() in datetime-defs.php
Time now as array
Function timeNowAsStr
timeNowAsStr() in datetime-defs.php
Time now as string
Page timer-defs.php
timer-defs.php in timer-defs.php
Method timeslot
schedule::timeslot() in datetime-defs.php
Class timeslot
timeslot in datetime-defs.php
Classes to handle a 24-hr time schedule. Covers the setting of * any number of slots, and testing whether a given time is in one of * the slots. The timeslot class. Holds details of a single slot.
Method timeslot
timeslot::timeslot() in datetime-defs.php
Function timestamp_to_datetime
timestamp_to_datetime() in datetime-defs.php
Conversion: timestamp to datetime.
Function timestamp_to_displaydate
timestamp_to_displaydate() in datetime-defs.php
Conversion: timestamp to descriptive Convert a Unix timestamp into a descriptive date/time format for the user display, using the given displayformat string.
Method To
email::To() in mail-defs.php
Set to Set the e-mail To: e-mail addresses.
Function todaysDate_DMY
todaysDate_DMY() in datetime-defs.php
Today as DD/MM/YYYY Returns the given datetime as a date, and in EUROPEAN 'd/m/Y' format.
Function todaysDate_MDY
todaysDate_MDY() in datetime-defs.php
Today as MM/DD/YYYY Returns the given datetime as a date, and in SQL 'm/d/Y' format.
Method tr
table::tr() in html-defs.php
Define a new row for the current group.
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.
Function transaction_failed
transaction_failed() in query-defs.php
Return DB transaction failure status.
Function transaction_open
transaction_open() in query-defs.php
Return DB transaction open status.
Function transaction_succeeded
transaction_succeeded() in query-defs.php
Return DB transaction success status.
Class treemenu
treemenu in treemenu-defs.php
A hierarchical menu renderer which does not use Javascript to implement the menuoption display.
Method treemenu
treemenu::treemenu() in treemenu-defs.php
Constructor Create a new menumaintainer.
Page treemenu-defs.php
treemenu-defs.php in treemenu-defs.php
Method type
outputfile::type() in file-defs.php
Set the file type. Possible types include 'text' (default), 'html', and 'templated'.
u
top
Variable $undoSteps
htmlarea_config::$undoSteps in htmlarea-defs.php
maximum size of the undo queue (default 20)
Variable $unique
dbindex::$unique in schema-defs.php
True if index is unique
Variable $update_action
dbconstraint::$update_action in schema-defs.php
Action to take on update
Variable $update_interval_ms
Interval between clock updates in millisecs
Variable $uploaded
catalogitem::$uploaded in catalog-defs.php
Variable $uploaded
fileupload::$uploaded in file-defs.php
Array of info on uploaded files
Variable $uploaded_count
No. of files uploaded
Variable $uploaded_ts
catalogitem::$uploaded_ts in catalog-defs.php
Variable $url
clickable_image::$url in image-defs.php
URL to go to when image is clicked on
Variable $url
img::$url in html-defs.php
URL associated with the image
Variable $url
hover::$url in image-defs.php
URL to go to when image is clicked
Variable $urls
contactinfo::$urls in pim-defs.php
urls
Variable $user
database::$user in database-defs.php
Default user to connect as
Variable $user
postgres_monitor::$user in monitor-defs.php
Username to connect as
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_attributes
User-defined attributes
Variable $user_confirmation
user_self_registration::$user_confirmation in selfregistration-defs.php
Variable $user_groups
menuoption::$user_groups in menu-defs.php
Array of user groups allowed to access this menuoption
Variable $user_groups
menumaintainer::$user_groups in menumaint-defs.php
Array of groups allowed to access menu
Variable $user_groups_cnt
user::$user_groups_cnt in user-defs.php
Group membership count
Variable $user_id
user_self_registration::$user_id in selfregistration-defs.php
Variable $user_record
user::$user_record in user-defs.php
Complete user record as an associative array
Variable $user_type
menuoption::$user_type in menu-defs.php
User type restriction
Variable $user_type
user::$user_type in user-defs.php
User type: arbitrary textual type
Variable $use_lockfile
monitor::$use_lockfile in monitor-defs.php
Whether to use a lockfile
Class ul
ul in html-defs.php
[UL] - Unordered list
Method ul
ul::ul() in html-defs.php
Constructor
Constant UNBUFFERED
UNBUFFERED in webpage-defs.php
The webpage is not buffered
Method uncheck
Sets the checkbox to the unchecked state.
Method uncheck
form_checkbox::uncheck() in form-defs.php
Sets the checkbox to the unchecked state.
Function unescape_string
unescape_string() in query-defs.php
Unescape a string according to the requirements of the current DB.
Method unescape_string
database::unescape_string() in database-defs.php
This method may be over-ridden in the child class. The default action is to simply do nothing.
Method unescape_string
datasources::unescape_string() in database-defs.php
Used to unescape escaped characters (typically the single quote) so that they are as they were before having the escape_string() method applied.
Page unicode-defs.php
unicode-defs.php in unicode-defs.php
Method unindex
lucene_unindexmsg::unindex() in lucene-defs.php
Unindex the given document, as identified by the unique ID. If no errors arise, then the item will be removed from the Lucene index.
Method unindex
catalogitem::unindex() in catalog-defs.php
Remove this catalog item from the search engine index.
Method unindex
named_layout::unindex() in layout-defs.php
Un-Index the named layout. We only do this if the layout version is LIVE or there is only a single version in existence.
Method unindex
searchengine_unindexmsg::unindex() in search-lucene-defs.php
Unindex the given document, as identified by the unique ID. If no errors arise, then the item will be removed from the SearchEngine index.
Method unindex
story::unindex() in story-defs.php
Un-Index this story from the search engine, if enabled for this website.
Method unindex
layout::unindex() in layout-defs.php
Un-Index all blocks in this layout. After calling this method all the blocks in the layout will have been removed from the search engine index.
Method unindex
block::unindex() in block-defs.php
Un-index the block.
Function unique_filename
unique_filename() in file-defs.php
Return a random unique filename, with optional prefix and an optional extension. The filename is composed from an md5 of microtime(), plus the prefix and extension if given.
Method unlock_thread
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 unpermit
tablecell::unpermit() in html-defs.php
Unset permission for this cell for given agent
Method unpermit_cell
table::unpermit_cell() in html-defs.php
Unset permission on given table cell. Optionally specify the group which is being targetted (default table body). The specified cell will have its access permission unset from the given perms.
Method unpublish
named_layout::unpublish() in layout-defs.php
Un-Publish a live named layout. This simply deletes the current pending version of the layout. That makes the current LIVE version the new pending version.
Method unpublish
microsite::unpublish() in microsite-defs.php
Un-publish this microsite. This just removes the physical contents of the microsite which were created in the ./var area.
Method unspan
tablecell::unspan() in html-defs.php
Flag this cell as being unspanned
Method unstick_thread
Method update_trlm
thread_msg::update_trlm() in forum-defs.php
Method upload
catalogitem::upload() in catalog-defs.php
Process an uploaded media file, and define this catalog item to be
Constant UPLOAD_E_ACCESS
UPLOAD_E_ACCESS in file-defs.php
Destination directory access problem
Constant UPLOAD_E_BADTYP
UPLOAD_E_BADTYP in file-defs.php
Uploaded file was not of an allowed mime type
Constant UPLOAD_E_HACK
UPLOAD_E_HACK in file-defs.php
Attempt to move a non-uploaded file. Hacking.
Constant UPLOAD_E_MAXSIZ
UPLOAD_E_MAXSIZ in file-defs.php
Uploaded file exceeded the given maximum size
Constant UPLOAD_E_MOV
UPLOAD_E_MOV in file-defs.php
Failed to move file, filesys error (perms?)
Constant UPLOAD_E_OK
UPLOAD_E_OK in file-defs.php
Error code: All ok, no errors
Constant UPPER
UPPER in form-defs.php
Force text to uppercase
Method uri_meta_tag
uri_meta_tag::uri_meta_tag() in metadata-defs.php
Constructor
Class uri_meta_tag
uri_meta_tag in metadata-defs.php
A class which encapsulates a meta tag which represents a reference to an item using a URL/URI.
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.
Method user
user::user() in user-defs.php
Constructor Create a new user object.
Page user-defs.php
user-defs.php in user-defs.php
Method user_can_edit
layout::user_can_edit() in layout-defs.php
Return true if the current user is permitted to edit layout details.
Method user_can_edit
block::user_can_edit() in block-defs.php
Return true if the current user is permitted to edit block details.
Method user_can_edit
story::user_can_edit() in story-defs.php
Determine wwhether user can edit this story.
Class user_self_registration
user_self_registration in selfregistration-defs.php
Self-registration class.
Method user_self_registration
Method use_map
image::use_map() in image-defs.php
Set image map Defines the image map to use with this image.
Method use_map
img::use_map() in html-defs.php
Set image map Defines the image map to use with this image.
Function utf8encode
utf8encode() in unicode-defs.php
takes a string of unicode entities and converts it to a utf-8 encoded string each unicode entitiy has the form &#nnn(nn); n={0..9} and can be displayed by utf-8 supporting browsers. Ascii will not be modified.
Function utf8ord
utf8ord() in unicode-defs.php
Function utf8RawUrlDecode
utf8RawUrlDecode() in unicode-defs.php
RFC1738 compliant replacement to PHP's rawurldecode - which actually works with unicode (using utf-8 encoding).
Function utf8RawUrlEncode
utf8RawUrlEncode() in unicode-defs.php
Replacement for PHP's rawurlencode. This version skips any existing sequences of '%xx', which represent already-encoded chars. Also uses the multi=byte string functions to preseve unicode chars integrity.
Function utf8_ensure
utf8_ensure() in unicode-defs.php
Ensure a string is encoded as UTF-8..
Page utils.php
utils.php in utils.php
v
top
Variable $valid
application::$valid in application-defs.php
True if response was valid, ie. no errors
Variable $valid
dbquery::$valid in query-defs.php
True if query is valid, post execution
Variable $valid
configfile::$valid in file-defs.php
True if config is read in & valid
Variable $valid
metadata_scheme::$valid in metadata-defs.php
Whether object contains valid data
Variable $valid
metadata_element::$valid in metadata-defs.php
Whether object contains valid data
Variable $valid
maintainer::$valid in maintainer-defs.php
True if this maintainer is good to go
Variable $valid
enc_qualifier::$valid in metadata-defs.php
Whether object contains valid data
Variable $valid
catalogitem::$valid in catalog-defs.php
Variable $valid
term::$valid in search-defs.php
True if this term is deemed valid
Variable $valid
story::$valid in story-defs.php
Variable $valid
user::$valid in user-defs.php
True if user record is valid
Variable $valid_xml
xmlparser::$valid_xml in xml-defs.php
True if XML parsed correctly
Variable $valign
block::$valign in block-defs.php
Vertical alignment: 'top', 'middle', 'bottom'
Variable $valign
HTMLObject::$valign in html-defs.php
Vertical alignment: top, bottom, middle
Variable $value
parameter::$value in application-defs.php
Parameter value
Variable $value
form_field::$value in form-defs.php
Value of the field
Variable $value
xmltag::$value in xml-defs.php
Value of this XML tag
Variable $values
metadata_scheme::$values in metadata-defs.php
Array of scheme key/value pairs
Variable $varnames
globals::$varnames in globals-defs.php
Array containing vars to globalise, and their sources
Variable $version
named_layout::$version in layout-defs.php
The version of the layout we have
Variable $version_count
named_layout::$version_count in layout-defs.php
Total versions of this layout in database
Variable $viewable_cells
layout::$viewable_cells in layout-defs.php
Array of layout cells with view permission
Variable $views
forum_thread::$views in forum-defs.php
Variable $view_passwords
maintainer::$view_passwords in maintainer-defs.php
If true, password field content is displayed
Variable $view_pks
maintainer::$view_pks in maintainer-defs.php
If true, primary keys are displayed
Variable $visibility
digital_clock::$visibility in clock-defs.php
Visibility setting
Variable $visible
story::$visible in story-defs.php
Variable $visible
blocklet::$visible in block-defs.php
Whether blocklet is visible
Variable $volatile
DB_dbfunction::$volatile in pg-schema-defs.php
Variable $vspace
image::$vspace in image-defs.php
Padding at image top & bottom in pixels
Variable $vspace
HTMLObject::$vspace in html-defs.php
Vertical space around object (pixels)
Method validate
table::validate() in html-defs.php
Check the table cell balance. Ie. make sure we have the
Method valid_password
user::valid_password() in user-defs.php
Validate password against all the rules for it. Returns true if the password passed all the tests, else false. Also provides a resulting error message which is either a nullstring "", or an explanation of why the validation failed.
Method value
configuration::value() in configuration-defs.php
Get value from a field in a set of the config.
Constant VERSION_LIVE
VERSION_LIVE in block-defs.php
Block/layout version is live
Constant VERSION_PENDING
VERSION_PENDING in block-defs.php
Block/layout version is pending
Constant VERSION_PREVIOUS
VERSION_PREVIOUS in block-defs.php
Block/layout version is previous
Constant VERSION_UNDEFINED
VERSION_UNDEFINED in block-defs.php
Block/layout version undefined
Constant VERTICAL
VERTICAL in menu-defs.php
Menu orientation set to vertical
Method view
story::view() in story-defs.php
Render the story as a maintainer reader would view it. Note that this
Method view_passwords
maintainer::view_passwords() in maintainer-defs.php
Allows content of any password fields to be shown for reference. This is useful to reference screens where someone might need to be able to read passwords from the maintenance screen. Defaults to false.
Method view_primary_keys
maintainer::view_primary_keys() in maintainer-defs.php
Allows primary key values to be viewed along with other data. It is sometimes useful to see this info in view-only mode.
Method view_record_filter
maintainer::view_record_filter() in maintainer-defs.php
Causes the filtering widgets to be viewed or not viewed. The filter widgets allow users to input rudimentary filtering criteria on a single field which they can select, in order to filter the recordset.
Method visible_cellsincol
Return the number of visible cells in a specific column.
Method visible_cellsinrow
Return the number of visible cells in a specific row.
Class vl
vl in html-defs.php
[VL] - Vanilla list (suppressed markers)
Method vl
vl::vl() in html-defs.php
Constructor
Function vspace
vspace() in utils.php
Insert vertical space in table Insert some vertical whitespace into a table.
w
top
Variable $warnsecs
file_monitor::$warnsecs in monitor-defs.php
Seconds before warning message
Variable $warnspace
diskspace_monitor::$warnspace in monitor-defs.php
Threshold (bytes) before warning condition
Variable $weeks
Calendar::$weeks in calendar-defs.php
Variable $where
sqlquery::$where in query-defs.php
The query WHERE clause components
Variable $width
image::$width in image-defs.php
Width of image in pixels
Variable $width
menuoption::$width in menu-defs.php
Width of option in pixels
Variable $width
story_media::$width in story-defs.php
Local override width
Variable $width
htmlarea_config::$width in htmlarea-defs.php
Width of HTMLarea element (default 'auto')
Variable $width
HTMLObject::$width in html-defs.php
Width of the object
Variable $width
blocklet::$width in block-defs.php
The width % of the blocklet table
Variable $width
catalogitem::$width in catalog-defs.php
Variable $WMLtemplate
deck::$WMLtemplate in webpage-defs.php
Template object for WML deck
Variable $wml_len
WMLdeck::$wml_len in wml-defs.php
Length of content in bytes
Variable $wordcount
story::$wordcount in story-defs.php
Variable $wrapmode
form_memofield::$wrapmode in form-defs.php
Wrapping mode: 'virtual', 'physical', or 'off'
Variable $wrap_threshold
menu::$wrap_threshold in menu-defs.php
Max. number of menu items before wrapping the menu
Variable $wysiwyg_id
form_wysiwygfield::$wysiwyg_id in htmlarea-defs.php
Unique ID of this form element
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 where
sqlquery::where() in query-defs.php
Add WHERE clause component
Method where
db_search::where() in dbsearch-defs.php
Define search WHERE clause
Method wml
deck::wml() in webpage-defs.php
This renders the deck content.
Method wml
WMLdo_element::wml() in wml-defs.php
Produce main WML for DO element This is a common utility method to render the DO WML once the details (body) has been filled in by the child class of this one.
Method wml
WMLtemplate::wml() in wml-defs.php
Return WML content Use render() to render this element in your page.
Method wml
WMLgo::wml() in wml-defs.php
Return WML content Use render() to render this element in your page.
Method wml
WMLfieldset::wml() in wml-defs.php
Return WML content 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
WMLrefresh::wml() in wml-defs.php
Return WML content Use render() to render this element in your page.
Method wml
WMLanchor::wml() in wml-defs.php
Return WML content Use render() to render this element in your page.
Method wml
WMLprev::wml() in wml-defs.php
Return WML content Use render() to render this element in your page.
Method wml
WMLcard::wml() in wml-defs.php
Return WML content Use render() to render this element in your page.
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
head::wml() in webpage-defs.php
Use render() to render this element in your page.
Method wml
WMLdeck::wml() in wml-defs.php
Return WML content for this deck.
Method wml
body::wml() in webpage-defs.php
This renders the body as WML.
Method wml
menu::wml() in menu-defs.php
This renders the field as WML.
Method wml
form_jumpmenu::wml() in form-defs.php
This renders the field as WML.
Method wml
image::wml() in image-defs.php
This renders the field as WML.
Method wml
table::wml() in html-defs.php
Render as WML.
Method wml
img::wml() in html-defs.php
Render as WML.
Method wml
menuitem::wml() in menu-defs.php
This renders the field as WML.
Method wml
form_textfield::wml() in form-defs.php
This renders the field as WML.
Method wml
form_combofield::wml() in form-defs.php
This renders the field as WML.
Method wml
Link::wml() in button-defs.php
Renders the reset button as WML.
Method wml
webdebugger::wml() in debugger.php
Use render() to render the debugger output.
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
pages::wml() in paging-defs.php
Deliver WML format page
Method wml
page_section::wml() in plugin-defs.php
This renders the page section as WML.
Page wml-defs.php
wml-defs.php in wml-defs.php
Method WMLanchor
WMLanchor::WMLanchor() in wml-defs.php
Constructor
Class WMLanchor
WMLanchor in wml-defs.php
WMLanchor class Provides a standard link on a WML page. It is usually an underlined bit of text which the user can click on to go to the given URL.
Class WMLcard
WMLcard in wml-defs.php
WMLcard class Manage WML cards.
Method WMLcard
WMLcard::WMLcard() in wml-defs.php
Constructor Create a new WML card.
Class WMLcontainer
WMLcontainer in wml-defs.php
WMLcontainer class Container Class: Extends element class to make a virtual class for descendants which are container of basic elements. Examples of these would be a WMLtemplate, or a WMLcard.
Method WMLcontainer
Constructor Create a new container object.
Class WMLdeck
WMLdeck in wml-defs.php
WMLDeck class Manage WML Decks of cards.
Method WMLdeck
WMLdeck::WMLdeck() in wml-defs.php
Constructor Create a new WML deck.
Class WMLdo_element
WMLdo_element in wml-defs.php
WMLdo_element class Do Element Class: Extends element to make a virtual class which has descendants which are contained by a 'do' construct.
Method WMLdo_element
Constructor Create a new do element object.
Class WMLelement
WMLelement in wml-defs.php
WMLelement class Manage WML elements. This is a virtual class used for all WML elements.
Method WMLelement
WMLelement::WMLelement() in wml-defs.php
Constructor Create a new element object.
Method WMLfieldset
Constructor Create a new fieldset object.
Class WMLfieldset
WMLfieldset in wml-defs.php
WMLfieldset class Manage a set of fields.
Class WMLgo
WMLgo in wml-defs.php
WMLgo class Extends the Do Element Class. Provide the Do element of type = 'accept'.
Method WMLgo
WMLgo::WMLgo() in wml-defs.php
Constructor Create a new go DO element object.
Method WMLprev
WMLprev::WMLprev() in wml-defs.php
Constructor Create a new prev element object.
Class WMLprev
WMLprev in wml-defs.php
WMLprev class Extends the Do Element Class. Provide the Do element of type = 'prev'.
Class WMLrefresh
WMLrefresh in wml-defs.php
WMLrefresh class Extends the Do Element Class. Provide the Do element of type = 'refresh'.
Method WMLrefresh
WMLrefresh::WMLrefresh() in wml-defs.php
Constructor Create a new refresh DO element object.
Method WMLtemplate
Constructor Create a new template object.
Class WMLtemplate
WMLtemplate in wml-defs.php
WMLtemplate class Extends container class to make a template. These are useful when you have a bunch of cards which you want to all have a common set of options.
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 wmlup
menu::wmlup() in menu-defs.php
This renders the menu as WML (w/Phone.com extns) in a paged mode with a number of menuitems/page defined by $wrap_threshold.
Method wml_morelink
menu::wml_morelink() in menu-defs.php
Given a page number of the current page, this method returns the appropriate label and link HREF for the next page link.
Method wml_template
deck::wml_template() in webpage-defs.php
Defines the template section for the deck.
Constant WM_CLSID
WM_CLSID in html-defs.php
Windows Media Player CLASS ID
Constant WM_CODEBASE
WM_CODEBASE in html-defs.php
Windows Media Player Codebase - where to download the player
Constant WM_MIMETYPE
WM_MIMETYPE in html-defs.php
Windows Media Player - MimeType
Constant WM_PLUGINSPAGE
WM_PLUGINSPAGE in html-defs.php
Windows Media Player - General plugins page for other platforms
Method word_count
story::word_count() in story-defs.php
Do a re-count of the story words. Set our local variable and also return the value as a by-product..
Method write
outputfile::write() in file-defs.php
Write to file Write the given string to the output file.
Method writeln
outputfile::writeln() in file-defs.php
Write line to file Write the given string to the output file as a line.
Constant WYSIWYG_EDITOR
WYSIWYG_EDITOR in block-defs.php
Layout cell content: HTMLArea wysiwyg editor
x
top
Variable $xmenu_configfile_path
Path to menu variables file - theme aware
Variable $xmenu_configfile_url
WWW Xmenu config URL - theme aware
Variable $xmenu_img
Xmenu::$xmenu_img in xmenu-defs.php
Home dir for Xmenu images
Variable $xmenu_js
Xmenu::$xmenu_js in xmenu-defs.php
Home dir for Xmenu scripts
Variable $xmltags
searchengine_msg::$xmltags in search-lucene-defs.php
Array containing XML tags
Variable $xmltags
lucene_msg::$xmltags in lucene-defs.php
Array containing XML tags
Method Xmenu
Xmenu::Xmenu() in xmenu-defs.php
Constructor Create the Xmenu object.
Class Xmenu
Xmenu in xmenu-defs.php
XMenu class A Generic Javascript Menu. This class provides a multi-level menu implemented in cross-browser Javascript. It should be compatible with Netscape 4, Netscape 6, and IE 4+.
Page xmenu-defs.php
xmenu-defs.php in xmenu-defs.php
Method Xmenu_entry
Xmenu::Xmenu_entry() in xmenu-defs.php
Recursively produce menu definition entries. These array
Method xml
RenderableObject::xml() in renderable.php
Return output suitable for XML-capable devices or agents.
Page xml-defs.php
xml-defs.php in xml-defs.php
Function xmldata
xmldata() in xml-defs.php
Returns a value for XML compliant data transfer. If the value has any of the chars: "<", ">" or "&" in it, then we enclose it in a CDATA construct.
Function xmldump
xmldump() in xml-defs.php
Processes an assumed XML string to a format where it can be safely viewed as a debugging dump in a browser et al.
Function xmlheader
xmlheader() in xml-defs.php
Returns the XML header string.
Method xmlparser
xmlparser::xmlparser() in xml-defs.php
Construct a new parser.
Class xmlparser
xmlparser in xml-defs.php
Class comprising the functionality of an XML parser. You should build specific parsers by inheriting this class and building your custom handler methods to handle the XML content.
Method xmltag
xmltag::xmltag() in xml-defs.php
Constructor
Class xmltag
xmltag in xml-defs.php
The XML tag class. This class encapsulates the functionality of an XML tag. It can accept child classes, usually of the same class, which will be rendered as child XML elements. A whole XML hierarchy can thus be represented in a single xmltag object.
y
top
Variable $YY
Calendar::$YY in calendar-defs.php
Function yearNow
yearNow() in datetime-defs.php
Year now as integer Returns the year as it is now.
$ a b c d e f g h i j k l m n o p q r s t u v w x y