-
$accept
-
The browser accept string, as submitted by user-agent
-
$accept_charsets
-
Accept-charset attributes - comma-delimited list
-
$accept_encoding
-
The browser accept-encoding string
-
$accept_language
-
The browser accept-language string
-
$access
-
Optional access permissions for cell.
-
$accesskey
-
Access key of the object
-
$accesskey
-
Speed-key associated with button (ALT-<key>)
-
$access_method
-
Access method, eg. btree, hash etc.
-
$action
-
Internal field which combines the sitepage
-
$action
-
Action attribute
-
$activated
-
True if maintainer has been activated
-
$active
-
Menu active flag
-
$active
-
Whether the globals registration is active
-
$active
-
Whether menuoption is active (displayed)
-
$address
-
-
$addr_city
-
addr_city
-
$addr_code
-
addr_code
-
$addr_country
-
addr_country
-
$addr_other
-
addr_other
-
$addr_postal
-
addr_postal
-
$addr_street
-
addr_street
-
$addr_suburb
-
addr_suburb
-
$affectedrowcount
-
Number of rows affected by query
-
$agent
-
Agent which will action this setting
-
$Align
-
Alignment of the menu table
-
$align
-
Alignment of the object: left, right, center
-
$align
-
Image alignment with respect to the page:
-
$allowed_types
-
Array of allowed mimetypes (unset = any types)
-
$alt
-
ALT text for this object
-
$alt
-
Image ALT tag content
-
$application
-
Application we are indexing for
-
$args
-
Arguments to pass to the function
-
$arg_types
-
-
$aslink
-
If not empty, render as a link using $aslink as the text
-
$aslink_target
-
Target frame for the $aslink
-
$attr
-
Attributes array for current/last tag
-
$attributes
-
-
$attributes
-
Array of tag attributes
-
$author
-
-
$author
-
-
$author_groups
-
The group membership for Authoring privilege
-
$author_groups
-
The group membership for Authoring privilege
-
$auth_code
-
Whether to apply auth code
-
$auth_code
-
-
$auth_code
-
Optional authorisation hash code
-
$auth_fail_option
-
Option to take on auth failure
-
$auth_fail_redirect
-
URL to redirect to on auth failure
-
$auth_type
-
Type of authentication in effect
-
$autocomplete
-
If false, disable autocomplete on this field. Mainly used with
-
$autoconfigurate
-
Whether to show buttons on forms and auto-process POST or not
-
$autojustify
-
Auto-justify numerics to the right, text to the left
-
$autostart
-
If true the media start immediately it is loaded
-
ABANDON_FILE
-
Abandon file on close
-
ABBREVIATE_DAYNAME
-
Abbreviate day name or not
-
abbreviate_dayname
-
-
activate_editing
-
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.
-
activate_editing
-
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.
-
add
-
Add to the body content
-
add
-
Add new content to the page section.
-
add
-
Adds a form element object to the form. This is usually an object you have previously created eg. with new form_textfield(...) etc.
-
addcolumn
-
Return SQL which will create a column in this table. The $column passed in is actually a field object.
-
addcolumn
-
Return SQL which will create a column in this table. The $column passed in is actually a field object.
-
addconstraint
-
Add a constraint to the schema information.
-
addcontent
-
Add to the content for this cell
-
addfield
-
Add a field to the table.
-
addfunction
-
Add a function to the schema information.
-
additem
-
Add catalog item to the catalog. The catalog will add the new item by cat_id. If that ID already exists it is overwritten.
-
additem
-
Create new menu item Makes a new menuitem from a given label and URL and adds it to the menu.
-
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.
-
additem
-
Add a data item Adds a key=>value pair into the combo options collection.
-
additem
-
Adds a key=>value pair item into the collection.
-
addparameter
-
Add the given parameter to this setting.
-
addsequence
-
Add a sequence to the schema information.
-
addtable
-
Add a table to the schema information.
-
addto
-
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.
-
addtrigger
-
Add a trigger to the schema information.
-
add_annotation
-
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.
-
add_attribute
-
Adds an attribute to this tag.
-
add_attribute
-
Add non-standard attribute to be rendered.
-
add_blocklet
-
Add a new blocklet to the block.
-
add_button
-
Add a button Adds a button element to the form.
-
add_content
-
Add new content to the webstream..
-
add_content
-
Allows adding of any type of content to the plugin. This could be
-
add_content
-
Append new content to the body of the email.
-
add_database
-
Constructor Add a new base to our list of datasources. The dbtype and the name are the only mandatory parameters.
-
add_database
-
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.
-
add_defaults
-
Add an array of default values for each field.
-
add_embed
-
Add an embed object to provide fallback for browsers which do not support the object tag properly.
-
add_field
-
Add a field to the fieldset.
-
add_field
-
Add field Add a field object to the fields in this fieldset.
-
add_fileuploadfields
-
Add file upload fields Special function to add repeated fileupload fields to the form.
-
add_header
-
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.
-
add_http_prefix
-
Make sure there is an http:// on a URL. If already present then string is returned untouched.
-
add_language
-
Adds another language for the current head. Webpages might contain content in multiple languages, hence the need for a list.
-
add_language
-
Adds another language for the current webpage. Webpages might contain content in multiple languages, hence the need for a list.
-
add_member
-
-
add_menuitem
-
Add menu item Adds a ready-made menuitem to the menu.
-
add_menuoption
-
This adds a new menuoption to the list, but does not add any records to the database.
-
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.
-
add_monitor
-
Add a new monitor. Eg. file_monitor, postgres_monitor etc. This just stuffs the object in an array ready to be checked.
-
add_named_script
-
Add named script This adds a specific lump of script to the body under a unique name.
-
add_named_script
-
This adds a specific lump of script to the webpage under a unique name.
-
add_plugin
-
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.
-
add_popup_script
-
Add popup window scripting.
-
add_querydata
-
Add query data
-
add_querydata
-
Add ready-made data. Populates the combo field data from a pre-run query.
-
add_record
-
Add a record of data to the maintainer.
-
add_script
-
Add named script to the body
-
add_script
-
Add more scripting to this page section.
-
add_scriptsrc
-
Add script reference link Add more scripting to this section in the form of a link to a script source file.
-
add_scriptsrc
-
Add script URL to the body
-
add_separator
-
Add form separator row
-
add_style
-
Add the given content to the current style. Appends style statements to the style string, which is rendered when the page gets rendered.
-
add_text
-
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.
-
add_timeslot
-
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'.
-
add_timeslot
-
Add timeslot. The start and end parameters can either be Unix timestamps, or string datetime specifiers.
-
add_xmltag
-
Add a new XML tag object to this Lucene message
-
affectedrows
-
Return the number of rows affected by a query.
-
affectedrows
-
This method must be defined in the child class.
-
ALL
-
Run getchema() in recusrive mode - follow foreign keys
-
allowed_groups
-
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.
-
ALL_MIMES
-
-
ALTERNATIVE
-
Alternative formats of same content
-
anchor
-
[A] - The anchor tag, otheriwse know as a clickable link.
-
anchor
-
Constructor
-
antihack.php
-
-
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.
-
append_cols
-
Append columns onto all rows in the table.
-
append_row
-
Append a row onto the table.
-
application
-
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.
-
application
-
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.
-
application-defs.php
-
-
AsIcon
-
Return the catalog item as a clickable icon.
-
AsIcon
-
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.
-
AsIcon
-
Render the image object as an image 'icon' which can be clicked to display the object in a popup window.
-
AsIcon
-
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.
-
AsIcon
-
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.
-
AsLink
-
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.
-
AsLink
-
Return the catalog item as a clickable hyperlink.
-
assign_DTD
-
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.
-
as_displayonly
-
Returns current element as text, with associated hidden field.
-
as_hiddenfield
-
Returns current element as a hidden field.
-
attach
-
Wrapper for general binary attachments. We assume a MIME content type of multipart/mixed for these..
-
attach_file
-
Attaches a 'file' to the e-mail message. Pass a file pathname to attach.
-
attach_html
-
Just a convenient wrapper for adding HTML attachments. Note that with
-
AUDIO_MIMES
-
-
authenticate
-
Authenticate a user Tries all types of authentication we know about using the parameters passed to it.
-
authenticate_authid
-
Authenticate a user by authorisation ID
-
authenticate_ipaddress
-
Authenticate a user by IP address
-
authenticate_userid
-
Authenticate a user by userid/password.
-
AUTHFAIL_DIE_MSG
-
Failed authentication: Die, with 'not authorised' message.
-
AUTHFAIL_DIE_SILENT
-
Failed authentication: Die silently.
-
AUTHFAIL_GUEST
-
Failed authentication: Welcome the user as a guest instead.
-
AUTHFAIL_REDIRECT
-
Failed authentication: Re-direct to specified URL.
-
authorised_user
-
The Authorised User class This derived class just allows us a different way of defining a new user, when we know their authorisation code.
-
authorised_user
-
Constructor Create a new authorised user object.
-
autojustify
-
Automatically set the alignment of this cell according to content.
-
autojustify
-
Set table auto-justify mode on or off.
-
autosequence
-
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}.
-
AUTOSTART
-
Used to indicate sound should start playing on load
-
avoid_lockfile
-
Define a lockfile which we must avoid during indexing. If defined then no indexing will take place while the lockfile exists. The second parameter allows you to specify a limit to the patience of this process, in seconds. Zero means wait forever.
-
$cache
-
Sequence cache size
-
$cachecontrol
-
Cache control directive, usually passed on URL
-
$cached
-
Page is cached or dynamic
-
$cache_expiry
-
Seconds expiry for cached webpages
-
$cache_path
-
Path to use to save cached version of webpage
-
$cache_regen
-
If true, force regeneration of cached webpage
-
$cache_seconds
-
How many seconds to cache this page
-
$caption
-
The caption for this item
-
$cards
-
Array of card objects
-
$card_id
-
Unique card identifier string
-
$catalogitem
-
The catalogitem object
-
$catalogitems
-
The array of catalogitem objects in this catalog
-
$catalogitems
-
Media items in this microsite (array)
-
$categories
-
The array of categories (optional)
-
$category
-
Mimetype category, eg: 'movie', 'audio' etc.
-
$category
-
-
$cat_desc
-
-
$cat_id
-
-
$cat_name
-
-
$cc
-
Cc: (copies to) header
-
$cellid
-
Optional unique ID for this cell. Used for form field naming.
-
$cellpadding
-
Padding of cells in pixels
-
$cellspacing
-
Spacing between cells in pixels
-
$charset
-
Charset for content of the page
-
$charset
-
character set to use for the e-mail
-
$charset
-
Charset for this page
-
$checked
-
True if checkbox is ticked/checked
-
$checked
-
True if this element should be selected
-
$childtags
-
Array of child tags of this tag
-
$child_element_ids
-
Child element_ids of this element
-
$cksrc
-
Check constraint source
-
$class
-
The stylesheet class to apply to this object
-
$class
-
Classes of debugging to accumulate
-
$classid
-
URL for the object's implementation
-
$clockid
-
Unique ID for this clock widget
-
$clustered
-
True if index is clustered
-
$code
-
Name of Java file, if java applet
-
$codebase
-
Base URL for plug-in or potenial java applet (IE)
-
$codebase
-
URL for relative base for accessing object
-
$codetype
-
Object MIME type
-
$collapseimage
-
Image to use for expanded sub-menu
-
$color
-
Foreground/text colour of the object
-
$colour
-
Colour of the element
-
$cols
-
Columns in table
-
$cols
-
The number of columns in this block
-
$colspan
-
Column span that this cell is anchor of
-
$colspanned
-
Whether this cell is colspanned (invisible)
-
$comments
-
Blurb regarding this qualifier
-
$compression_minsize
-
Minimum size in bytes before invoking compression
-
$compression_type
-
Compression type to use for response content
-
$condition
-
Monitor worst case condition
-
$config
-
The configuration override settings to use. This is
-
$configpath
-
Path to application configuration file
-
$config_id
-
Identity if the current configuration
-
$config_name
-
The name of the current configuration
-
$confirmation
-
Confirmation text for onclick
-
$confirmsubject
-
-
$confirm_text
-
Popup confirmation text to display on button click
-
$confirm_text
-
Popup confirmation text to display on button click
-
$connected
-
Flag true if database was connected ok
-
$connected
-
True if we are connected to socket
-
$constraints
-
Array of constraints on this table
-
$constraints
-
-
$constraints
-
-
$contactinfo
-
Contact info object
-
$contactinfoid
-
contactinfo ID
-
$content
-
The content to send to browser
-
$content
-
Pages content
-
$content
-
Accumulated debugging output content
-
$content
-
E-mail body + headers minus From: and Subject:
-
$content
-
The cell content object
-
$content
-
Blocklet textual content
-
$content
-
Content of file after readall()
-
$content
-
Page section content
-
$content_colour
-
Content colour
-
$content_size
-
Content size adjustment -2 thru +2
-
$cookiename
-
The session cookie name
-
$cookiename
-
The name of the cookie to use
-
$corepage
-
Whether this page is an Axyl core page
-
$count
-
The total data items in our array
-
$created
-
True if quickfile was created successfully
-
$css
-
The main stylesheet of the microsite
-
$css_date
-
Style or class for date display
-
$css_ie
-
The IE stylesheet of the microsite
-
$css_ns
-
The Netscape stylesheet of the microsite
-
$css_styles
-
CSS Styles we want to display for this field
-
$css_time
-
Style or class for time digits
-
$currently_installed
-
Whether microsite is currently installed (built)
-
$current_row
-
Current record/row
-
$current_row
-
An array containing the current DB row
-
cache
-
Cache this webpage Causes the current webpage to be regarded as a cached page.
-
CACHED
-
The webpage is cached
-
calculate_length
-
Calculate the length (size) of deck Calculates the WML length from scratch.
-
Calendar
-
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.
-
Calendar
-
Calendar
-
calendar-defs.php
-
-
capable_of
-
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.
-
capable_of
-
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.
-
card
-
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.
-
catalog
-
Constructor
-
catalog
-
This class encapsulates a media catalog, which is a collection of catalogitem objects.
-
catalog-defs.php
-
-
catalogitem
-
A class which encpasulates an item which can be in the catalog.
-
catalogitem
-
Constructor
-
Cc
-
Set copies-to Set the e-mail Cc: e-mail addresses for copies to.
-
cdata
-
Method invoked when character data is available
-
cdata
-
Method invoked when character data is available
-
cellcount
-
Return the number of cells in a specific row.
-
cell_exists
-
Check if given cell exists, return True is it does.
-
charset
-
Set the character set encoding for the email.
-
check
-
Sets the checkbox to the checked state.
-
check
-
Make the check on Lucene by firing the query off and checking for the expected number of hits coming back.
-
check
-
Make the check, as to whether we can connect to the Postgres DB.
-
check
-
Check all monitors. Just iterate through them and raise the conditions
-
check
-
Check the space on the filesystem of the directory specified.
-
check
-
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.
-
check
-
Sets the checkbox to the checked state.
-
check
-
Make the check by executing the script/program which has been
-
check_all_monitors
-
Iterate through all our monitors, checking in each case. Each monitor will implement its own kind of checking and set its condition afterward.
-
check_authcode
-
-
check_group_membership
-
Check group membership
-
childtag
-
Add a child tag.
-
clear
-
Clear all the monitors.
-
clear
-
Clear all data/fields, leaving type definition alone.
-
clear
-
Clear all plugins from the set
-
clear
-
Clear all content from the page section.
-
clear
-
Clear query - Wipe all of the current query definitions.
-
clearcontent
-
Clear the content from all rows in table. This sets the content of every cell in every row in every group to nullstring.
-
clearcontent
-
Clear the content from this cell.
-
clearitems
-
Clears all key=>value pair items from the collection.
-
clearitems
-
Clears any existing items
-
clearstyle
-
Clear all existing style settings. This leaves any class settings alone.
-
clear_daterange
-
Clear the date range for the search. Makes sure that the search will not be filtered by a date restriction.
-
clear_search
-
Clear the search terms only.
-
clickable_image
-
Clickable Image class A class for managing a clickable image. A clickable image is one which redirects to a given URL when clicked on.
-
clickable_image
-
Constructor Creates the basic clickable image object.
-
clock-defs.php
-
-
CLOCK_ATTRS
-
Clock overall clock table attributes (eg. style, width etc.)
-
CLOCK_DATE_CSS
-
Clock date string style and/or class
-
CLOCK_DATE_FORMAT
-
Clock date format M=month no, m=month name, D=day no,
-
CLOCK_TIME_CSS
-
Clock time string style and/or class
-
closefile
-
Close the file. We move the temporary file that has been built to
-
closefile
-
Close the file
-
close_webstream
-
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.
-
colcount
-
Return the number of cols in this table.
-
commit
-
Commit the currently open database transaction.
-
commit
-
Commit a DB transaction
-
commit
-
Commit open database transaction
-
COND_ALL
-
Aggregate: all conditions
-
COND_ERROR
-
Error condition
-
COND_FATAL
-
Fatal error condition
-
COND_NONE
-
Aggregate: no conditions
-
COND_OK
-
Condition for a passed test
-
COND_UNKNOWN
-
Condition is undefined
-
COND_WARNING
-
Warning condition
-
configfield
-
* A Configuration field.
-
configfield
-
Constructor.
-
configuration
-
Constructor Create a new configuration object. Sets basic field attributes.
-
configuration
-
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.
-
configuration-defs.php
-
-
configurator
-
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.
-
configurator
-
Constructor
-
connect
-
This method must be defined in the child class.
-
connect
-
Connects to the database which has been selected in the mode specified, or non-peristent otherwise.
-
connected
-
Returns connected status of named database, or the currently selected one if no name given.
-
constants.php
-
-
constraints_match
-
Return true if field constraints match those passed in.
-
constraint_exists
-
Returns true if named constraint exists.
-
contactinfo
-
Constructor Create a new contactinfo object.
-
contactinfo
-
The contactinfo class manages a single set of contact information which might be associated with a person or thing.
-
contact_details
-
Return a standard contact details set.
-
contains_fileuploadfield
-
Check if form contains file upload field Check all elements for presence of file upload field. This is mainly for internal use.
-
CONTENT_AIFF
-
AIFF sound files
-
CONTENT_ASF
-
Media player ASF, ASX Movies
-
CONTENT_AUDIO
-
AU/SND basic audio files
-
CONTENT_AVI
-
AVI Movies
-
CONTENT_BMP
-
BMP attachment
-
content_css
-
Content style.
-
CONTENT_CSV
-
CSV attachments
-
CONTENT_FLASH
-
Shockwave Flash movies
-
CONTENT_GIF
-
GIF attachment
-
CONTENT_HTML
-
HTML attachments
-
CONTENT_JPEG
-
Jpeg image attachment
-
CONTENT_LATEX
-
Latex format
-
CONTENT_MP3
-
MP3 audio files
-
CONTENT_MPEG
-
MPEG Movies
-
CONTENT_MSACCESS
-
M$ Word docs
-
CONTENT_MSDOS
-
EXE files, binaries of poor parentage
-
CONTENT_MSEXCEL
-
M$ Excel spreadsheets
-
CONTENT_MSPROJECT
-
M$ Project files
-
CONTENT_MSWORD
-
M$ Word docs
-
CONTENT_OCTET
-
Binaries of questionable parentage
-
CONTENT_OGG
-
OGG sound files
-
CONTENT_PDF
-
Adobe PDF's
-
CONTENT_PHOTO
-
Photo Jpeg image attachment
-
CONTENT_PNG
-
PNG attachment
-
CONTENT_PSCRIPT
-
Postscript format
-
CONTENT_QUICKTIME
-
Quicktime movies
-
CONTENT_RA
-
REALAUDIO sound files
-
CONTENT_RTF
-
Rich text format
-
content_style
-
Content style.
-
CONTENT_TEX
-
Tex format
-
CONTENT_TEXT
-
TEXT
-
CONTENT_TIFF
-
TIFF attachment
-
CONTENT_WAV
-
WAV sound files
-
CONTENT_WINMEDIA
-
Windows Media Player
-
CONTENT_XML
-
XML attachments
-
CONTENT_ZIP
-
ZIP archive
-
control-panel.php
-
-
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'.
-
crash
-
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.
-
create
-
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.
-
create
-
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.
-
create
-
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.
-
create
-
Return Postgres SQL required to create this sequence.
-
create
-
Return SQL required to create this trigger.
-
create
-
Return SQL required to create this function.
-
create
-
Return SQL required to create this trigger.
-
create
-
Return the SQL which will create this Postgres table.
-
create
-
Return SQL required to create this index.
-
create
-
Return SQL required to create this constraint outside the table
-
create
-
-
create
-
Return the SQL which will create this table.
-
create
-
-
create
-
Return SQL required to create this index.
-
create_constraints
-
Return the SQL which will create the constraints on this table.
-
create_constraints
-
Return SQL to create all constraints for this field..
-
create_indexes
-
Return the SQL which will create the indexes on this table.
-
create_inline
-
Return SQL required to create this as an inline table constraint
-
csv
-
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.
-
csv
-
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.
-
csv
-
Return the CSV content for this cell.
-
csv
-
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.
-
csv_inputfile
-
CSV Inputfile class Manage CSV-formatted files for input.
-
csv_inputfile
-
Constructor Open the given CSV formatted file for input.
-
current_sequencevalue
-
Get the current sequence value.
-
current_sequencevalue
-
Return the current sequence value, given a sequence name, the table and the field it applies to.
-
current_sequencevalue
-
Return the current sequence value, given a sequence name, the table and the field it applies to.
-
CUSTOM_COMPRESSION
-
Webpage compression: Use custom Phplib compression. For Php < v4.04
-
$data
-
URL of data object might require
-
$data
-
The array containing data in key=>value pairs
-
$database
-
An array of database objects. All databases we can use as datasources
-
$database
-
The name of the database containing the table
-
$database_version
-
-
$datafname
-
The full path to the file
-
$datafname
-
The full path to the file
-
$datasource
-
Datasources associated with this response
-
$datasrc_uri
-
URI of scheme data
-
$date_end
-
End date range for search (false means undefined). This
-
$date_fieldname
-
Name of the field to which daterange should be applied
-
$date_format
-
Date format eg. 'M d, ccyy' for 'April 4, 2005'
-
$date_last_author
-
-
$date_posted
-
-
$date_posted
-
-
$date_start
-
Start date range for search (false means undefined). This
-
$dayname
-
-
$days
-
-
$daysinmonth
-
-
$days_clickable
-
-
$dbid
-
Unique identifier for database access
-
$dbid
-
Database connection resource ID
-
$dbname
-
Name of the database to connect to
-
$db_backed
-
The type of this session
-
$db_configuration_exists
-
Whether the configuration exists in database or not
-
$db_config_exists
-
Whether config definition exists in database or not
-
$db_name_default
-
Default database name
-
$db_name_selected
-
Name of currently selected database
-
$DD
-
-
$debugger
-
The debugger for this response
-
$default
-
-
$defaults
-
Field defaults for new records
-
$defaultval
-
-
$default_value
-
The default value for this element
-
$default_value
-
Default value of this qualifier
-
$deferrable
-
True if constraint is deferrable
-
$deferred
-
True if constraint is initially deferred
-
$definitions
-
-
$deleted
-
-
$delete_action
-
Action to take on delete
-
$desc
-
The description of the current blocklet
-
$description
-
Description
-
$description
-
Menu option descriptive text
-
$description
-
A description of the scheme
-
$description
-
Element description, usage details
-
$destination_dir
-
Destination dir to put files
-
$detail_tables
-
Array of detail tables. Master-detail relationship.
-
$dir
-
The directory prefix (if any) of the file
-
$dir
-
The directory prefix (if any) of the file
-
$disabled
-
True if field is disabled
-
$displaypw
-
-
$display_order
-
Display order
-
$display_order
-
Order of display
-
$display_order
-
Order (for displaying menu lables)
-
$display_order
-
Order of display
-
$display_order
-
Display order of this blocklet
-
$display_properties
-
Clock display settings. An array of booleans.
-
$docurl
-
-
$do_autosequence
-
If true we auto-detect sequences for integer fields,
-
$DTD
-
The Document Type Definition for this head section
-
$DTD
-
Array of DTD specifiers for this response. @see set_dtd()
-
data-defs.php
-
-
database
-
Define a database. This is a parent class to all of the supported
-
database
-
Constructor
-
database-defs.php
-
-
datasources
-
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.
-
datasources
-
Constructor
-
data_meta_tag
-
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.
-
data_meta_tag
-
Constructor
-
datetime-defs.php
-
-
datetime_to_displaydate
-
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.
-
datetime_to_timestamp
-
Conversion: datetime to descriptive Returns a timestamp from a database-formatted datetime string.
-
dat_keyvalues
-
Dat_keyvalues
-
dat_keyvalues
-
Constructor
-
dayNameNow
-
Day of Week now as string Returns the day name (eg. "Monday") as it is now.
-
dayNow
-
Day of Month now as integer Returns the day of the month (1-31) as it is now.
-
daysinmonth
-
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.
-
DAY_AND_DATE
-
Example: Friday, 20th July 2001
-
db-mssql-server.php
-
-
db-mysql.php
-
-
db-odbc.php
-
-
db-oracle.php
-
-
db-postgres.php
-
-
dbcommand
-
Execute a DB command
-
dbconstraint
-
Defines a database constraint.
-
dbconstraint
-
-
dbdelete
-
Constructor Create a new DB Delete object.
-
dbdelete
-
DB Delete class A special case of the dbquery class. This is for deleting rows from the database.
-
dbfield
-
-
dbfield
-
Class describing a database field of a table.
-
dbfunction
-
-
dbfunction
-
Defines a database function (procedure).
-
DBG_ALL
-
Everything. Warning, this can be VERBOSE!
-
DBG_DEBUG
-
Ad-hoc debugging output
-
DBG_DEFAULT
-
DEBUG and DIAGNOSTICS as default setting
-
DBG_DIAGNOSTIC
-
Diagnostic output
-
DBG_DUMP
-
Dump HTTP and PHP page vars
-
DBG_NONE
-
No debugging (redundant)
-
DBG_O_ALL
-
Ubiquitous output mode
-
DBG_O_CLI
-
Output for CLI: echoed raw ASCII, LF end-of-line
-
DBG_O_DEFAULT
-
Default output mode (stored)
-
DBG_O_ECHO
-
Output via direct echo
-
DBG_O_LOG
-
Output to system log
-
DBG_O_LOGFILE
-
To logfile (not implemented yet)
-
DBG_O_NONE
-
No output
-
DBG_O_STORED
-
Output stored in $content
-
DBG_PROFILE
-
Show debugging profiler output
-
DBG_SQL
-
SQL queries to database
-
DBG_SQLDATA
-
SQL SELECT data from database
-
DBG_TABLES
-
Show table borders and validation checks
-
DBG_TRACE
-
Provide debug traceback info
-
DBG_UNDEFINED
-
Dummy value
-
dbid
-
Returns the database resource ID of the given database name.
-
dbindex
-
Defines a database index.
-
dbindex
-
-
dbinsert
-
Constructor Create a new DB Insert object. This is for inserting a record into the database.
-
dbinsert
-
DB Insert class A special case of the dbtablemod class.
-
dbquery
-
DB Query class This class is the one which executes queries against the connected database.
-
dbquery
-
Constructor Create a new DB Query object.
-
dbrecords
-
Constructor Create a new DB Records object.
-
dbrecords
-
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.
-
dbrecordset
-
A wrapper which caters for queries which will return a record set identifier for returning data.
-
dbrows
-
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.
-
dbrows
-
Constructor Create a new DB Rows object.
-
dbsearch-defs.php
-
-
dbselect
-
Constructor Create a new DB Select object. This is for selecting rows from the database, and returning fields from those rows.
-
dbselect
-
DB Select class A special case of the dbrecords class.
-
dbseq
-
Create a new object to manage a sequence, optionally specifying the sequence name..
-
dbseq
-
DB seq class A class which allows the management and use of sequences.
-
dbsequence
-
Defines a database sequence.
-
dbsequence
-
-
dbtable
-
Construct a table of given name and array of primary key fields.
-
dbtable
-
Class describing a database table.
-
dbtablemod
-
Constructor Create a new DB Insert object. This is for inserting a record into the database.
-
dbtablemod
-
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.
-
dbtrigger
-
Defines a database trigger.
-
dbtrigger
-
-
dbtype
-
Returns the database type of the given database name.
-
dbupdate
-
Constructor Create a new DB Select object.
-
dbupdate
-
DB Update class A special case of the dbquery class. This is for updating data in particular rows in the database.
-
DB_dbconstraint
-
-
DB_dbconstraint
-
Defines a database constraint.
-
DB_dbfield
-
-
DB_dbfield
-
Class describing a database field of a Postgres table.
-
DB_dbfunction
-
Defines a database function (procedure).
-
DB_dbfunction
-
-
DB_dbindex
-
-
DB_dbindex
-
Defines a database index.
-
DB_dbsequence
-
Defines a database sequence.
-
DB_dbsequence
-
-
DB_dbtable
-
Construct a table of given name and array of primary key fields.
-
DB_dbtable
-
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.
-
DB_dbtrigger
-
-
DB_dbtrigger
-
Defines a database trigger.
-
DB_schema
-
Class describing a Postgres database schema.
-
DB_schema
-
Create a schema (database) of given name. The name should be a valid existing database name that is currently connected.
-
db_search
-
Constructor
-
db_search
-
DB Search class This class inherits the functionality of the generic 'search' class. It extends it to implement a database search.
-
db_value_from_bool
-
Return a suitable database field value to contain the value for the given boolean.
-
db_value_from_bool
-
Return a suitable database field value to contain the value for the given boolean.
-
debug
-
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.
-
debugbr
-
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.
-
debugger.php
-
-
debugging
-
Return debugger status Function for external routines to determine whether debugging is enabled or not..
-
debug_class
-
Set debugging class(es) Sets the class or classes (OR'ed together) of debug output which will be accepted/rendered on ouput.
-
debug_class
-
Set debug class(es) to accept
-
debug_dump
-
Sets flag for debugger to include global vars in output.
-
debug_hascontent
-
Return whether we have any content, true or false.
-
debug_hex
-
Add string to debug content as hexdump
-
debug_mode
-
Set debug mode
-
debug_off
-
Set debugging off
-
debug_on
-
Set debugging on Sets the debugging on. Sets class(es) to accept.
-
debug_output
-
Set debug output mode
-
debug_output
-
Set debugger output mode This function allows setting of the debugger output mode which determines where output goes.
-
debug_phpinfo
-
Calls Php phpinfo() function
-
debug_profile
-
Insert an entry into the profiler. This label will have a line in the profile output against the time elapsed since the last line.
-
debug_profiling
-
Returns true if the RESPONSE is in profiling mode
-
debug_render
-
Render the debug output as a string.
-
debug_trace
-
DEBUG TRACEBACK Usage: In your function you bracket the statements you want to label for tracing as in the following example..
-
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).
-
deck
-
Constructor Create a new deck object.
-
deck
-
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).
-
defaulted
-
Return a value which may be defaulted Returns the value of the variable, if it is valid, otherwise returns the specified default value.
-
defaultvalue
-
Return the default field value
-
DEFAULT_AGENT
-
The default agent ID
-
DEFAULT_AUTHOR_GROUPS
-
Default Author group membership
-
DEFAULT_DATASOURCE
-
Default datasource for queries @see add_database()
-
DEFAULT_EDITOR_GROUPS
-
Default Editor group membership
-
DEFAULT_ENTRY_GROUPS
-
Default Entry group membership
-
DEFAULT_FIELD
-
The name of the field Lucene should assume if none specified
-
DEFAULT_FIELDTYPE
-
Default type of field: 'Text', 'Date', 'Id'
-
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.
-
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.
-
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.
-
definition_form
-
Render this scheme as HTML. This produces a table containing the
-
delete
-
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.
-
delete
-
Delete this menu from the database.
-
delete
-
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.
-
delete
-
Delete this page from the database. We also delete all other records associated with this page, and do not rely on RI.
-
delete
-
Delete the menuoption.
-
delete
-
Delete the organisation.
-
delete
-
Delete the whole config.
-
delete
-
Delete registered variables.
-
delete
-
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.
-
delete
-
Delete the current microsite template, from the database.
-
delete
-
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.
-
delete
-
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.
-
delete
-
Delete the contactinfo.
-
delete
-
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.
-
delete
-
Delete the blocklet.
-
delete_cols
-
Remove a column from all rows in the table
-
delete_cookie
-
Delete session cookie Deletes the session cookie from the user's browser.
-
delete_forum
-
-
delete_row
-
Remove a row from the table. If the template cell is not provided then a 'vanilla' cell is used.
-
delete_story
-
Remove the story from the system. We actually just flag it as deleted on the database, and keep the record.
-
detail_table
-
Associates a detail table with the maintained table. This defines
-
diff
-
Produce the SQL required to morph the schema described in the passed dbschema object $db, into the schema we have in this current object.
-
DIGEST
-
A digest of multiple attachments
-
digital_clock
-
Constructor for the clock
-
digital_clock
-
The digital_clock class. This is implemented as a 'layer' or 'div'
-
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.
-
disable_autosequence
-
Specify that the maintainer should not auto-detect sequences which
-
disable_forum
-
disable the forum from showing
-
discard
-
Discard all webpage content For discarding the content so far with immediate effect.
-
disconnect
-
This method must be defined in the child class.
-
disconnect
-
Disconnect the currently selected database.
-
diskspace_monitor
-
-
diskspace_monitor
-
Class which checks for a disk free space condition.
-
displaydate_to_date
-
Conversion: descriptive to datetime without the time element.
-
displaydate_to_datetime
-
Conversion: descriptive to datetime.
-
displaydate_to_timestamp
-
Conversion: descriptive to timestamp.
-
displayvar
-
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.
-
DISPLAY_24_HOURS
-
Clock display hours (am/pm)
-
DISPLAY_DATE
-
Show date or not
-
DISPLAY_DATE_FIRST
-
Show the date first
-
DISPLAY_DATE_FORMAT
-
Example: 31/12/1999 23:59
-
DISPLAY_DATE_ONLY
-
Example: 31/12/1999
-
DISPLAY_DAYNAME
-
Show day name or not
-
display_disabled
-
Cause the maintainer to be displayed initially diabled. All form fields which are part of the maintainer will be readonly/disabled.
-
DISPLAY_INLINE
-
Show date and time on one line
-
display_in_webpage
-
Display in webpage Inserts the javascript necessary to embed the menu into a given webpage.
-
display_in_webpage
-
Display in webpage Inserts the javascript necessary to embed the menu into a given webpage.
-
display_msg
-
-
DISPLAY_ONLY
-
Form field is readonly/display only
-
DISPLAY_SECONDS
-
Display to seconds or mins
-
DISPLAY_TIMESTAMP_FORMAT
-
Example: 31/12/1999 23:59:59
-
DISPLAY_TIME_ONLY
-
Example: 23:59
-
DocumentObject
-
Constructor
-
DocumentObject
-
Document Object
-
DOCUMENT_MIMES
-
-
does_not_match
-
Define a search term which the search must not match to succeed.
-
does_not_matchfield
-
Add search term: must not match a field value.
-
DOW_HHMM
-
Example: Sun 23:59
-
drop
-
Return the SQL to drop this field.
-
drop
-
-
drop
-
-
drop
-
-
drop
-
Return the SQL to drop this table.
-
drop
-
Return SQL to drop this function.
-
drop
-
-
drop
-
-
drop
-
-
dropcolumn
-
Return SQL to drop a column from the table. The $column passed is actually a field object.
-
dump
-
Dump field description to stdout.
-
dump
-
A diagnostic dump of the class variables for debugging purposes.
-
dump
-
Dump field description to stdout.
-
dump
-
Dump ascii description of this index to stdout.
-
dump
-
Dump the table description to stdout.
-
dump
-
Dump ascii description of this trigger to stdout.
-
dump
-
Dump ascii description of this function to stdout.
-
dump
-
-
dump
-
Dump this entire schema description to stdout.
-
dump
-
Dump ascii description of this constraint to stdout.
-
$fieldname
-
Upload field name
-
$fieldnames
-
Fieldnames in the index
-
$fieldnames
-
Array of table field names in constraint
-
$fieldnums
-
Field positions for fields constraint applies to
-
$fieldnums
-
Field numbers of fields in index
-
$fields
-
Array of field objects
-
$fields
-
Internal array of field names being maintained
-
$fields
-
List of fields in the query
-
$fields
-
Array of fields
-
$fields
-
Array of fieldname/value pairs - info returned by the search
-
$fields
-
Array of configfield objects for the config
-
$fieldschanged
-
Whether field definitions have changed or not
-
$fieldset
-
Object containing lucene fields
-
$fields_total
-
Total number of fields
-
$field_definitions
-
Index fields definitions array. Contains definitions
-
$fileexists
-
-
$filename
-
Original filename
-
$filepath
-
Path to the file to monitor
-
$filepath
-
-
$filepath
-
Upload path to the file on the server
-
$filesize
-
Physical size of the file (bytes)
-
$filesize
-
Size of opened file in bytes
-
$filesize
-
-
$filetype
-
Type of file 'text' or 'templated'
-
$fk_fieldnames
-
Array of referenced foreign key fieldnames
-
$fk_fieldnums
-
Field positions for fields FK constraint refers to
-
$fk_table
-
Table (object) constraint refers to
-
$fk_tablename
-
Foreign key table name constraint refers to
-
$font
-
Font settings for link text
-
$fontnames
-
The list of font families to allow user to choose from
-
$fontsizes
-
The list of font sizes to allow user to choose from
-
$foot
-
Webpage foot object
-
$force_readonly
-
Whether to force forma elements to be read-only
-
$force_rebuild
-
Whether to force rebuild or not
-
$format
-
Format specifier (WML)
-
$format_last_modified
-
The format string for last modified datetime
-
$formname
-
The name of our form
-
$formname
-
-
$formname
-
Standard form name to use
-
$formname
-
The name of our form
-
$formname
-
Name of form we will be using
-
$formname
-
Name of the form containing maintained fields
-
$formname
-
The form this widget is to be displayed in
-
$formname
-
-
$form_mode
-
Mode to display the configuration in a form
-
$forumemail
-
-
$forumfor
-
-
$forum_desc
-
-
$forum_id
-
-
$forum_id
-
-
$forum_id
-
-
$forum_members
-
-
$forum_moderator
-
-
$forum_name
-
-
$forum_threads
-
-
$forum_title
-
-
$fp
-
File pointer
-
$fp
-
The file pointer
-
$freezefilename
-
Name of freeze lockfile to create (internal)
-
$freezesecs
-
Lockfile age at which we should stop trying to kill hung process
-
$from
-
e-mail From address
-
$frozen
-
True if the freeze lockfile exists
-
$fsdir
-
Directory to check
-
$fullPage
-
if true then HTMLArea will retrieve the full HTML, starting
-
$full_name
-
-
$funcname
-
Name of function to call when triggered
-
$functions
-
-
fetch_array
-
This method must be defined in the child class.
-
fetch_array
-
Return the specified row, as an associative array of fields in a fieldname => value format.
-
fetch_row
-
Return the specified row, as a standard (enumerated) array of field values.
-
fetch_row
-
This method must be defined in the child class.
-
field
-
Get field content Return the field content from the current database array (row).
-
fieldlist
-
Define field list
-
fieldlist
-
Define search fields list
-
fields
-
-
FIELDS_ONLY
-
Run getschema() to get only current table fields (no recursion)
-
field_count
-
Return fields present count.
-
field_create
-
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.
-
FIELD_DELIM
-
Field delimiter used in record structures
-
field_exists
-
Check if field exists
-
field_remove
-
Remove a field from all sets of this config.
-
file-defs.php
-
-
fileupload
-
Fileupload class.
-
fileupload
-
Constructor. On instantiation this class checks the global variable space for uploaded file info and pre-processes it.
-
file_monitor
-
Define a new file check object.
-
file_monitor
-
A monitor class to check when files/directories were last modified.
-
fk_fields
-
-
FlashObject
-
Macromedia Shockwave/Flash Object
-
FlashObject
-
Constructor
-
FLASH_CLSID
-
Macromedia Flash Windows CLASS ID
-
FLASH_CODEBASE
-
Macromedia Flash Codebase - where to download the player
-
FLASH_MIMES
-
-
FLASH_MIMETYPE
-
Macromedia Flash MimeType
-
FLASH_PLUGINSPAGE
-
Macromedia Flash Plugins plage - support for other platforms
-
flushbuffer
-
Flush any buffered content to the stream.
-
foot
-
The foot class
-
foot
-
Constructor Create a new foot object.
-
force_readonly
-
Force all of the contained fields to be rendered read-only
-
forget
-
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.
-
forget
-
Forget variable names Un-register the given comma-delimited list of varnames in the current session..
-
forgetall
-
Unset all registered variables.
-
form
-
Constructor Create a form object. Sets basic form attributes.
-
form
-
Form class
-
form-defs.php
-
-
formatted_microsecs
-
Return the micro-seconds on the clock to 2 decimal places.
-
formatted_millisecs
-
Return the milli-seconds on the clock to 2 decimal places.
-
formatted_secs
-
Return the seconds on the clock to 2 decimal places.
-
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'.
-
format_content
-
Format Content.
-
format_DMY
-
Format date as DD/MM/YYYY
-
format_name
-
Returns the name in the form SURNAME, Firstname.
-
format_tag_name
-
Function to format a tag name which might have multiple parents.
-
FORM_AUTHENTICATION
-
Authentication option: Username/password from custom form fields
-
form_buttonfield
-
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.
-
form_buttonfield
-
Constructor Create a field object. Sets basic field attributes.
-
form_checkbox
-
Checkbox Field class A field which renders a checkbox form element.
-
form_checkbox
-
Constructor Create a field object. Sets basic field attributes.
-
form_combofield
-
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.
-
form_combofield
-
Constructor Create a field object. Sets basic field attributes.
-
form_displayonlyfield
-
Constructor Create a disply-only field object. Sets basic field attributes.
-
form_displayonlyfield
-
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..
-
form_field
-
Constructor Create a field object. Sets basic field attributes.
-
form_field
-
Form Field class Abstract field class, for deriving various form field types.
-
form_fileuploadfield
-
Constructor Create a field object. Sets basic field attributes.
-
form_fileuploadfield
-
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.
-
form_hiddenfield
-
Hidden Field class This class generates a hidden field.
-
form_hiddenfield
-
Constructor Create a hidden field object. Sets basic field attributes.
-
form_imagebutton
-
Constructor Create a field object. Sets basic field attributes.
-
form_imagebutton
-
Image Button class This class generates a standard form image button field.
-
form_imagecombo
-
Constructor Create a field object. Sets basic field attributes.
-
form_imagecombo
-
Image Combo class
-
form_imagefield
-
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.
-
form_imagefield
-
Constructor Create a field object. Sets basic field attributes.
-
form_jumpmenu
-
Constructor Create a field object. Sets basic field attributes.
-
form_jumpmenu
-
Jumpmenu Field class A special case of combofield where we define key/value data made up of display-value and URL pairs.
-
form_labelfield
-
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..
-
form_labelfield
-
Constructor Create a label field object. Sets basic field attributes.
-
form_memofield
-
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.
-
form_memofield
-
Constructor Create a field object. Sets basic field attributes.
-
form_passwordfield
-
Constructor Create a field object. Sets basic field attributes.
-
form_passwordfield
-
Password Field class Password field element. Same as textfield, but masks user input.
-
form_radiobutton
-
Constructor Create a field object. Sets basic field attributes.
-
form_radiobutton
-
Radio Button Field class A field which renders a radio form element.
-
form_radiogroup
-
Radio Group Field class A field which groups a set of radio form elements together.
-
form_radiogroup
-
Constructor Create a field object. Sets basic field attributes.
-
form_resetbutton
-
Reset Button class This class generates a standard form reset button field.
-
form_resetbutton
-
Constructor Create a field object. Sets basic field attributes.
-
form_submitbutton
-
Constructor Create a field object. Sets basic field attributes.
-
form_submitbutton
-
Submit Button class This class generates a standard form submit button field.
-
form_tandemfield
-
Tandem Field class
-
form_tandemfield
-
Constructor Create a field object. Sets basic field attributes.
-
form_textfield
-
Text Field class. This class generates a text field.
-
form_textfield
-
Constructor Create a field object. Sets basic field attributes.
-
form_wysiwygfield
-
Wysiwyg Field class A field which renders a textarea form element as a Wysiwyg editor.
-
form_wysiwygfield
-
Constructor - create a wysiwyg form element..
-
forum
-
-
forum
-
The forum class.
-
forum-defs.php
-
-
forum_thread
-
The forum thread class.
-
forum_thread
-
-
freeresult
-
Free the result of a query
-
freeresult
-
This method must be defined in the child class.
-
friendlyName
-
Make a 'friendly' name from a full one. Good for "Dear... ,"
-
friendlyName
-
Get friendly name
-
from
-
Define search table FROM list
-
from
-
Define table FROM list
-
From
-
Set from Set the e-mail From: e-mail addresses.
-
F_CHECKBOX
-
Tickbox or checkbox
-
F_COMBO
-
Dropdown menu or listbox field
-
F_DATETIME
-
Date/time field
-
F_IMAGE
-
Text field containing image URL
-
F_MEMO
-
Textarea memo field
-
F_RADIO
-
Radio button
-
F_TEXT
-
General text field
-
$generated
-
True if page has been generated
-
$globals
-
-
$globals
-
Globals object. Manages the global vars in this response
-
$go
-
Go object associated with this link
-
$gotinfo
-
Whether info has been already got
-
$gotschemes
-
Whether schemes have been already got
-
$groupby
-
The GROUP BY clause
-
$groups
-
Array containing table groups
-
$group_info
-
Group membership details in full, as associative array
-
$group_names
-
Array of group membership names (strings)
-
$guest_browser_lifetime
-
True if we should limit 'guest' to browser lifetime
-
$gutter_colour
-
Colour of inter-column gutter
-
$gutter_width
-
Width of inter-column gutter in pixels
-
generate
-
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.
-
generic_type
-
Return the generic type of the field. The generic types are as
-
generic_type
-
Return the generic type of the field. The generic types are as
-
get
-
Get the current microsite template, as identified by the ID, from the database.
-
get
-
Get the layout.
-
get
-
Get the organisation.
-
get
-
Get the menuoption.
-
get
-
Get the data for this scheme.
-
get
-
Retrieves the specified contactinfo from database.
-
get
-
Get all of the metadata elements associated with this layout. We can
-
get
-
Get the blocklet.
-
get
-
Get the block.
-
get
-
Get all the relevant data for this metadata element.
-
get
-
Get the microsite Retrieves the specified microsite from database. If it doesn't exist then we create a new one.
-
get
-
Get current or nominated catalog item definition from the database.
-
get
-
Get the microsite page details from the databse.
-
get
-
Get the data for this qualifier.
-
get
-
Get the configuration set.
-
get
-
Get the menu Retrieves the specified menu from database. If it doesn't exist then we create a new one.
-
getconstraint
-
Returns constraint object of given name
-
getfield
-
Returns field object of given name
-
getfieldbynum
-
Returns field object of given attnum (order number)
-
getfieldnum
-
Returns field number of given field name
-
getfunction
-
Returns function object of given name
-
getfunctions
-
Populates our array of functions with all user functions in this schema.
-
getindex
-
Returns index object of given name
-
getitem
-
Return item value
-
getitemindex
-
Find ordinal array index Finds the ordinal array index of the element with key $key.
-
getkeyfieldnames
-
Returns list of names of keyfields as array
-
getlabelfield
-
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.
-
getmenu
-
Get the menu Read the menuitems in from database and apply security..
-
getnonkeyfieldnames
-
Returns list of names of non-keyfields as array
-
getparameter
-
Get the value of a named parameter.
-
getparameter
-
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.
-
getschema
-
Acquires the schema from database metadata.
-
getschema
-
Acquire all of the schema details.
-
getschema
-
Obtain constraint schema information.
-
getschema
-
Acquires the schema from database metadata.
-
getschema
-
Acquires the schema from database metadata.
-
getschema
-
Acquires the schema from database metadata.
-
getschema
-
Obtain trigger schema information.
-
getschema
-
Acquires the table fields and constraints which apply to it.
-
getschema
-
Acquires the schema from database metadata.
-
getschema
-
Obtain function schema information.
-
getschema
-
Get schema info for sequence
-
getschema
-
Acquires the schema from database metadata.
-
getschema
-
Obtain index schema information.
-
getschema_table
-
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.
-
getschema_table
-
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.
-
getsequence
-
Returns seqeuence object of given name
-
getsequences
-
Populates our array of sequences with all user sequences in this schema.
-
getsequences
-
Populates schema sequences.
-
gettable
-
Returns table object of given name
-
gettables
-
Populates schema tables.
-
gettables
-
Populates our array of tables with all tables in this schema.
-
gettrigger
-
Returns trigger object of given name
-
gettriggers
-
Populates schema triggers.
-
gettriggers
-
Populates our array of triggers with all user triggers in this schema.
-
getvalue
-
Get the parameter value. If the element name is given (for an array type parameter) then we return the value of that element.
-
getversion
-
Acquire the Postgres database version. We make some gross assumptions here with regard to standard local Postgres setup. Change as necessary.
-
getversion
-
Acquire the database version.
-
get_auth_code
-
Get user Authorisation Code Return this user's unique authorisation code; generate one if it isn't there yet, from userid and current time.
-
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.
-
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.
-
get_cell
-
Return the given cell from this group
-
get_current
-
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.
-
get_current
-
Acquire the details on the current upload file. This includes the
-
get_DB_datetime
-
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).
-
get_DDstr
-
Return the currently stored day-date as a two-digit string
-
get_decodedvalue
-
Return decoded value (or array of values) so that applications can use the data unencumbered with URL encoding etc.
-
get_dirlist
-
Returns an array containing full paths to the files in the directory
-
get_displaydate
-
Return the currently stored calendar date as a string in a given date format (see Axyl datetime-defs.php for pre-defined formats).
-
get_DMY
-
Get date components of datetime string Returns the date components of a formatted date string.
-
get_file_extn
-
Return the file extension from a filepath.
-
get_file_stem
-
Return the file stem (name without extn) from a filepath.
-
get_first
-
Acquire the details on the first upload file.
-
get_first
-
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.
-
get_forum
-
-
get_full_tag_name
-
Function to acquire the full tag name including descendants, given the tag name, and the parent element ID of that tag.
-
get_groups
-
Get user groups info
-
get_HMS
-
Get time components of datetime string Extract the HH:MM[:SS] from datetime string Returns the time components of a formatted date string.
-
get_info
-
Get all the info which are associated with this metadata element.
-
get_info
-
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.
-
get_last
-
Get details on the last file which was uploaded. If there are no more, then this function returns false.
-
get_last
-
Get last row If current query is invalid, try to execute it first, then get the last row from the resultset.
-
get_last_sql
-
Returns SQL statement most recently executed on the current DB.
-
get_metadata_element
-
Return a metadata element, given its element_id.
-
get_MMstr
-
Return the currently stored month as a two-digit string
-
get_msg
-
-
get_next
-
Get next row If current query is invalid, try to execute it first, then get the next row from the resultset.
-
get_next
-
Get details on the next file which was uploaded. If there are no more, then this function returns false.
-
get_next_sequencevalue
-
A wrapper to get the next sequence value from a named sequence..
-
get_previous
-
Get details on the previous file which was uploaded. If there are no more, then this function returns false.
-
get_previous
-
Get previous row If current query is invalid, try to execute it first, then get the previous row from the resultset.
-
get_recmaintfield
-
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.
-
get_row
-
Return a given row from the table.
-
get_row
-
Get row Return the given database row from the resultset. Uses the get_row_raw() method applicable to this class.
-
get_schemes
-
Get all the schemes which are associated with this metadata element.
-
get_setting
-
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.
-
get_settingindex
-
Return the index of the given named setting, or -1 if not found.
-
get_story
-
Get a story in total. We always access stories by their ID.
-
get_styles
-
Obtain the non-standard styles from the stylesheet
-
get_stylesheets
-
Get the filenames for the main stylesheet and (optionally) the
-
get_template
-
Read in the template for this page section.
-
get_thread
-
-
get_threads
-
-
get_thread_header
-
-
get_timestamp
-
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.
-
get_translation
-
Returns the story_id of a translation of the current story in the
-
get_trimcontent
-
Return content, if not null or newline.
-
get_user
-
-
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.
-
get_user_by_id
-
Get user by ID Internal function to return the user record from id.
-
get_user_by_ip
-
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.
-
get_width_profile
-
Get the width profile from the table.
-
get_YYstr
-
Return the currently stored year as a two-digit string
-
GIGABYTE
-
Gigabytes
-
globalise
-
Globalise the variables which have already been registered. Also
-
globalise
-
Globalise specific vars
-
globalise_all
-
Set globalise all
-
globalise_all
-
Globalises all variables from all possible sources. This duplicates the effect of Php register_globals = On in the Php configuration .ini file.
-
globals
-
A class to handle globalisation of specific variables. This class
-
globals
-
Creates the object which contains the vars to globalise and the methods to globalise them. Takes optional parameters which are vars to globalise.
-
globals-defs.php
-
-
groupby
-
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.
-
group_ids_list
-
Get group IDs list
-
group_names_list
-
Get group names list
-
$hascontent
-
Flag indicating whether plugins exist
-
$hasdata
-
True if data was returned, after execute
-
$hasfiles
-
True if some files were uploaded
-
$hasgroups
-
True if user has a group membership
-
$hasIPlist
-
Flag, true if user has auto-login IP addresses
-
$has_expiry
-
-
$has_media
-
-
$has_multilang
-
-
$has_multimedia
-
-
$has_precis
-
-
$head
-
Webpage head object
-
$heading
-
Whether this is a heading cell
-
$heading
-
Heading or subject of the error
-
$heading
-
blocklet heading
-
$heading_colour
-
Heading colour
-
$heading_item_spacing
-
Padding before (above) menu options which are
-
$heading_level
-
blocklet heading level (1-6)
-
$height
-
Height of HTMLarea element (default 'auto')
-
$height
-
-
$height
-
Height of image in pixels
-
$height
-
Local override height
-
$height
-
Height of option in pixels
-
$height
-
Height of the object
-
$hidden
-
If true the object is hidden
-
$hidden
-
If true the media object is hidden
-
$hidden_buttons
-
Array of disallowed button names eg:
-
$HighBgColor
-
Colour of highlighted top menu item background
-
$HighColor
-
Colour of highlighted top menu item text
-
$highlightclass
-
Stylesheet class to use for highlighting
-
$highlightclass
-
Stylesheet class name for highlighted link
-
$highlightclass
-
Stylesheet class name for highlighted link
-
$highlighted
-
True if menu item is highlighted
-
$hit
-
Array of hits returned. Each element of this array is
-
$host
-
For TCP connections: hostname to connect to
-
$host
-
HOST running the Lucene query server
-
$host
-
Host server of this database
-
$host
-
Host to connect to
-
$hostname
-
Local hostname we are running monitor on
-
$hover
-
The hover image associated with the button
-
$href
-
URL to GO to
-
$href
-
The URL to go to when link is clicked
-
$href
-
URL that clicking the link goes to
-
$hspace
-
Padding at image sides in pixels
-
$hspace
-
Horizontal space around object (pixels)
-
$htmlareaPaste
-
intercept ^V and use the HTMLArea paste command
-
$htmlRemoveTags
-
HTML tags to disallow (these have to be a regexp, or null
-
$http_host
-
The host of this website ie. 'foo.thingy.co.nz'
-
hasdata
-
Returns status of data.
-
hasSQL
-
Filters out potential hacking
-
has_daterange
-
Return true if at least one of our dates is set.
-
head
-
Constructor Create a new head object.
-
head
-
The head class.
-
HIDDEN
-
Used to hide the object control
-
hide_statusbar
-
Specify whether the maintainer should show its status bar or not.
-
highlight
-
Defines special highlight class name
-
highlight
-
Defines special highlight class name
-
hit
-
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.
-
hit
-
Constructor Create a new search hit.
-
hitcount
-
Return count of hits present in this search.
-
HORIZONTAL
-
Menu orientation set to horizontal
-
hover
-
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.
-
hover
-
Constructor Creates the hover object.
-
hover_button
-
Hover button.
-
hover_button
-
Constructor
-
hr
-
[HR] - Horizontal Rule
-
hr
-
Constructor
-
href_addparm
-
Add a parameter keyvalue pair to a URL. We check that it isn't already there, and use the right delimiter.
-
href_delparm
-
Remove a parameter keyvalue pair from a URL.
-
href_rewrite
-
Re-writes the given HREF, appending session ID if found. Appends the
-
html
-
Render the block content according to the mode of operation we are in. Possible modes: 'viewing', 'editing', 'saving'.
-
html
-
Return HTML for this named layout.
-
html
-
Render the maintainer as HTML. Use the render() method rather than directly calling this method.
-
html
-
This renders the field as HTML.
-
html
-
This renders the foot as HTML.
-
html
-
Render the menu as HTML.
-
html
-
This renders the head as HTML. After the title and the meta tags
-
html
-
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.
-
html
-
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.
-
html
-
-
html
-
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...
-
html
-
This renders the body as HTML.
-
html
-
This renders the body as HTML.
-
html
-
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.
-
html
-
This renders the error page section as HTML. We do this simply as a heading at level 3 (h3), and the message content.
-
html
-
This renders the page section as HTML.
-
html
-
Render all of the elements as HTML
-
html
-
Render the block content according to the mode of operation we are in. Possible modes: 'viewing', 'editing', 'saving'.
-
html
-
This renders the field as HTML.
-
html
-
Render this metadata element as HTML.
-
html
-
Render the block content according to the mode of operation we are in. Possible modes: 'viewing', 'editing', 'saving'.
-
html
-
Display organisation subform via the render() method.
-
html
-
Display Contactinfo subform via the render() method.
-
html
-
Deliver HTML format page
-
html
-
This renders the field as HTML.
-
html
-
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.
-
html
-
This renders the field as HTML.
-
html
-
This renders the field as HTML.
-
html
-
Renders the form button as HTML.
-
html
-
This renders the form as HTML, including the form tags and every form element in the form.
-
html
-
Render this configuration.
-
html
-
Use render() to render the debugger output.
-
html
-
Use render() to render this element in your page.
-
html
-
This renders the field as HTML.
-
html
-
This renders the field as HTML.
-
html
-
This renders the field as HTML.
-
html
-
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.
-
html
-
This renders the image button as HTML. If we have onclick then we render
-
html
-
This renders the field as HTML.
-
html
-
Render the clock.
-
html
-
Render the catalog item. We render it as either and icon or a link, both being clickable to view the content.
-
html
-
Render the blocklet.
-
html
-
Use render() to render this element in your page.
-
html
-
Render the block content according to the mode of operation we are in. Possible modes: 'viewing', 'editing', 'saving'.
-
html
-
Return HTML content Use render() to render this element in your page.
-
html
-
This renders the field as HTML.
-
html
-
Return HTML content Use render() to render this element in your page.
-
html
-
Use render() to render this element in your page.
-
html
-
Use render() to render this element in your page.
-
html
-
Return the calendar HTML
-
html
-
Return the HTML for this catalog. Returns the list of catalog items as an HTML table.
-
html
-
Use render() to render this element in your page.
-
html
-
Use render() to render this element in your page.
-
html
-
Use render() to render this element in your page.
-
html
-
This renders the field as HTML.
-
html
-
This renders the field as HTML.
-
html
-
Render the HTML
-
html
-
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.
-
html
-
Render as HTML
-
html
-
-
html
-
Return HTML content Use render() to render this element in your page.
-
html
-
Return HTML content Use render() to render this element in your page.
-
html
-
Produce main HTML for DO element
-
html
-
This renders the field as HTML.
-
html
-
This renders the field as HTML.
-
html
-
This renders the field as HTML.
-
html
-
Return HTML content Use render() to render this element in your page.
-
html
-
Return HTML content Use render() to render this element in your page.
-
html
-
Return HTML content Use render() to render this element in your page.
-
html
-
This renders the field as HTML.
-
html
-
Return HTML content Use render() to render this element in your page.
-
html
-
-
html
-
-
html
-
This renders the field as HTML.
-
html
-
Use render() to render this element in your page.
-
html
-
This renders the field as HTML.
-
html
-
This renders the field as HTML.
-
html
-
Render the object as HTML
-
html
-
Render the HTML
-
html
-
Render the HTML
-
html
-
-
html
-
Render the HTML
-
html
-
Render the object as HTML
-
html-defs.php
-
-
htmlarea-defs.php
-
-
htmlarea_config
-
Constructor for new HTMLArea configuration object
-
htmlarea_config
-
A container class for configuration settings for the HTMLArea
-
htmlarea_plugins
-
Function to set plugins to be loaded. When you are using one of
-
htmldump
-
Dump setting
-
htmldump
-
Dump this parameter
-
htmldump
-
Return dump of the application content as a string. Useful for diagnostics mainly.
-
HTMLObject
-
Constructor Create a HTMLObject. Sets basic field attributes.
-
HTMLObject
-
An HTMLObject is any object which will be rendered in HTML according to the basic syntax defined for HTML.
-
HTMLtag
-
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.
-
HTMLtag
-
-
HTTPError
-
Return an HTTP error message
-
HTTP_AUTHENTICATION
-
Authentication option: Browser popup form
-
HVmenu
-
Constructor Create the HV menu object.
-
HVmenu
-
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.
-
hvmenu-defs.php
-
-
HVmenu_entry
-
Recursively produce HVmenu definition entries. These array
-
$icon
-
Image which acts as a play icon
-
$icon
-
Image which acts as a clickable icon
-
$id
-
The ID tag to apply to this object
-
$id
-
ID field provided for optional application use
-
$idoffset
-
ID generation offset
-
$idprefix
-
ID generation prefix
-
$idsource
-
ID generation source
-
$images_defined
-
Flag, true if images have been defined
-
$image_keys
-
Array of image IDs we have in our combo
-
$image_type
-
The image type: "GIF", "JPG", "PNG", "TIFF", "BMP"..
-
$image_urls
-
Array of image URLS, one per ID above
-
$img
-
Image object
-
$img
-
The image object
-
$img
-
Image object for this button
-
$imgs_changed
-
Whether images were changed or not
-
$img_horiz_arrow
-
Menu image object: horizontal arrow
-
$img_over
-
Image over object
-
$img_spacer
-
Menu image object: spacer
-
$img_vert_arrow
-
Menu image object: vertical arrow
-
$include_maxsize
-
Whether to include the max size in the form
-
$increment
-
Sequence increment
-
$indexed
-
Indication that the indexing was successful
-
$indexed
-
Whether this element should be indexed
-
$indexes
-
-
$indexes
-
Array of indexes on this table
-
$indexfields
-
Fields for indexing. This is an array of fieldname/value
-
$index_category
-
The index category of the current layout - used with Lucene indexing
-
$info_msg
-
-
$initDD
-
-
$initial_record_value
-
Value, if defined, of the record to focus to on initialisation
-
$initial_ts
-
Initial time to set the clock to
-
$initMM
-
-
$initYY
-
-
$instantiated
-
Whether this element is instantiated as layout metadata
-
$internal_name
-
Internal name sans spaces
-
$IP
-
List of IP addresses this user will be auto-logged-in from.
-
$isarray
-
Whether this field is an array of values
-
$ispkey
-
-
$is_parent
-
True if this menu option is the parent of sub-menu options
-
$itemlist
-
Items to display, assoc. array
-
$items
-
Array of items in this menu
-
$item_count
-
Number of items in the menu
-
$item_height
-
Height of menu items in pixels
-
$item_spacing
-
Padding before (above) 'normal' menu options
-
$item_width
-
Width of all menu items in pixels
-
$ixid
-
The index ID
-
identify_user
-
Identify the user/client
-
ID_FROM_FILENAME
-
Mode of index ID generation is by full filename (incl. extension)
-
ID_FROM_INC
-
Mode of index ID generation is by incrementing integer
-
ID_FROM_NAME
-
Mode of index ID generation is by filename stripped of path and extension
-
ID_FROM_PATH
-
Mode of index ID generation is by full path to file
-
id_generate
-
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.
-
image
-
Constructor Creates the basic image object.
-
image
-
Image class A class for managing a standard image.
-
image-defs.php
-
-
image_button
-
Image button.
-
image_button
-
Constructor
-
IMAGE_MIMES
-
-
img
-
[IMG] - The img class. This is an object which renders the img tag.
-
img
-
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.
-
inc_thread_views
-
-
index
-
Index this story to Lucene, if enabled for this website.
-
index
-
Index this catalog item to Lucene.
-
index
-
Index the named layout. We only do this if the layout version is LIVE or there is only a single version in existence.
-
index
-
Index all blocks in this layout.
-
index
-
Index the block.
-
INDEXED
-
Used to indicate that a field should be indexed by Lucene
-
index_content
-
Index the given content against the given ID. This automatically
-
index_exists
-
Returns true if named index exists.
-
index_field
-
Supply field content for indexing. This causes Lucene to take the given fieldname and index the given value against it.
-
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.
-
index_file
-
Index a file located at the given path, using given ID.
-
index_tree
-
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.
-
infoField
-
-
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.
-
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.
-
initialise
-
Clear the object variables to default values.
-
initialise
-
Initialise this object to default values. Eg. this is done after a delete, so we don't see the deleted object data.
-
initialise
-
Initialise everything about the search.
-
initialise
-
Initialise local vars..
-
initial_record
-
Tell the record maintainer to focus the keycombo to the record with the given value, when it first initialises.
-
inline_end
-
End inline buffering Usually used as in: <?php $s = $page->inline_end(); Then $s will contain all the HTML between inline_start/inline_end.
-
inline_script
-
-
inline_start
-
Begin inline buffering
-
InPersistentHostsList
-
Is host in peristent list
-
inputfile
-
Constructor Open the given file for input.
-
inputfile
-
The inputfile class manages files for input. It opens, reads and closes files in input-only mode.
-
insert
-
Insert content into the anchor
-
insert
-
Insert content Append more WML content to the body. This just concatenates the given string onto the existing content.
-
insert_card
-
Add card Inserts a ready-made card object into the deck.
-
insert_cols
-
Insert a column into all rows in the table. If the template cell is not provided, then a 'vanilla' cell is used instead.
-
insert_go
-
Insert GO element into container
-
insert_metatag
-
Insert a ready-made meta tag object into the metatags array.
-
insert_metatag
-
Insert a ready-made meta tag object into the webpage head section.
-
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.
-
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.
-
insert_paragraph
-
Insert paragraph Append content to the body inside a paragraph.
-
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.
-
insert_prev
-
Insert PREV element into container
-
insert_refresh
-
Insert REFRESH element into container
-
insert_row
-
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.
-
insert_template
-
Define template defines the template for the deck.
-
Insitu
-
Return the catalog item as image, a clickable icon, or otherwise a link.
-
inslot
-
-
integerField
-
-
into
-
Define table INSERT INTO list
-
ip_format
-
Format a string (dotted) form of an IP address. We make sure we have
-
isLeapYear
-
Check if year is a leap year.
-
ismemberof_group
-
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.
-
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.
-
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.
-
ISO_8601
-
ISO 8601 Example: YYYYMMDDTHHMMSS-HHMM
-
ISO_DATABASE_FORMAT
-
Example: 1999-07-17 23:59:59
-
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.
-
istrue
-
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.
-
isvalid
-
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.
-
is_integer_class
-
Return true if the field is of an integer class.
-
is_integer_class
-
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.
-
is_ipaddress
-
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'.
-
is_pendingver
-
Return PENDING version status.
-
is_serial_class
-
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.
-
is_serial_class
-
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.
-
is_utf8
-
-
is_valid
-
Check that currently stored Month, Day and Year make a correct date. Returns true if so.
-
itemcount
-
Return the count of items in the catalog currently.
-
$label
-
Label for the Do element
-
$label
-
Label for scheme
-
$label
-
Link label text
-
$label
-
Label against the element value field
-
$label
-
Menuoption displayed label
-
$label
-
The label to display for the link
-
$label
-
Label to put against the field. NB: this is not displayed unless you make it so.
-
$label
-
Label for this menu item
-
$labelcolon
-
Whether to append colon ":" to labels
-
$labelcss
-
Optional class/style for labels
-
$labeljustify
-
Justification mode for labels "right" or "left"
-
$labelside
-
Side to place label: 'right' or 'left'
-
$label_padding_left
-
Padding between menuoption image, and menu item text
-
$lang
-
Language code for text content in this object
-
$langdir
-
Direction for text - 'LTR' (left-to-right) or 'RTL' (right-to-left)
-
$language
-
The language of the block (0 = default)
-
$language
-
Menu language
-
$language
-
The language of the layout (0 = default)
-
$language
-
The language of the content or resource referenced by URI
-
$language
-
Menu language
-
$language
-
The language of the menu (0 = default)
-
$language
-
-
$language
-
-
$language
-
Menu language, or default if zero
-
$language
-
Language variant of this menu eg: 'fr'
-
$languages
-
Languages used in content of the page
-
$languages
-
IDs of all languages contained in this page
-
$lang_desc
-
The name of the language of the menu
-
$lang_direction
-
The language text direction
-
$lang_direction
-
The language text direction
-
$lang_encoding
-
The language encoding code
-
$lang_encoding
-
The language encoding code
-
$lastmodified
-
-
$lastmodified_ts
-
-
$last_author
-
-
$last_errormsg
-
Record last error/info message
-
$last_installed_ts
-
When microsite was last installed (timestamp)
-
$last_logintime
-
Time of last login (Unix timestamp)
-
$last_modified
-
Last modified date/time string.
-
$last_modified
-
When menu option was last modified (datetime)
-
$last_modified_ts
-
When microsite was last modified (timestamp)
-
$layout
-
The layout we are providing
-
$layouteditor
-
Local layouteditor object, only instantiated if the
-
$layoutfm
-
The name of the layout form
-
$layoutid
-
The layout this block belongs to
-
$layoutid
-
The unique ID of this layout
-
$layout_blocks
-
The layout blocks, keyed on 'row|col'
-
$layout_id
-
The layout these elements are for
-
$layout_lang_direction
-
The language direction for the containing layout
-
$layout_lang_encoding
-
The language encoding for the containing layout
-
$layout_name
-
The name of the current layout
-
$layout_style
-
Supplemental layout table style
-
$layout_table
-
The layout table itself
-
$layout_version
-
Version of layout this block belongs to (optional). If present
-
$layout_version_count
-
Count of layout versions in existence.
-
$leftx
-
X-offset from left
-
$lifetime
-
The session lifetime, in seconds
-
$limit
-
The LIMIT value
-
$limit_logins
-
Limit of logins allowed (0=unlimited)
-
$link
-
Link object to associate with menu item
-
$linked_tables
-
Array of linked tables. Tables forming many-to-many link.
-
$linked_uri
-
Whether the tag value is actually a URL/URI
-
$linkover_text
-
Status bar text when link moused over
-
$linkover_text
-
Text to display in status area when mouse over image
-
$linkover_text
-
Text to display in statusbar when mouse over object
-
$list
-
-
$list_of_values
-
Allowed list of values for this qualifier
-
$list_of_values
-
A list of permitted element values
-
$locked
-
True if we are locked via lockfile
-
$locked
-
-
$locked
-
-
$lockfile
-
Path to a lockfile we should give way to. If this value
-
$lockfile
-
Monitor lockfile object
-
$lockfilename
-
Name of the lockfile to create
-
$lockfilepath
-
Monitor lockfile path
-
$lockfile_wait_secs
-
Number of seconds to wait on a lockfile. If zero, wait forever.
-
$lock_mins
-
Minutes process has been locked for
-
$logins_exceeded_msg
-
Custom message to deliver when blocking
-
$logins_exceeded_option
-
Option to take on logins exceeded for user
-
$logins_exceeded_redirect
-
URL to redirect to on logins exceeded
-
$login_type
-
Login type for this session
-
$lookahead
-
Number of chars to look ahead
-
$lookback
-
Number of chars to look back
-
$loop
-
If true the media replays endlessly
-
$LowBgColor
-
Colour of normal top menu item background
-
$LowColor
-
Colour of normal top menu item text
-
$lucene_indexer
-
The index object which does the work
-
$luhits
-
Expected no. of hits
-
$luhost
-
Lucene host
-
$luhost_abbrev
-
Lucene host abbreviation
-
$luport
-
Lucene port
-
$lusearch
-
The lucene search object
-
layout
-
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.
-
layout
-
Constructor Create a new layout object. To create a new layout then just leave leave the argument list empty.
-
layout-defs.php
-
-
layout-editor-defs.php
-
-
layouteditor
-
Constructor Create a new layouteditor object.
-
layouteditor
-
Layouteditor
-
layout_metadata_elements
-
Constructor
-
layout_metadata_elements
-
A class which holds multiple metadata elements, for a given layout.
-
LCK_E_CREFAIL
-
Lockfile
-
LCK_E_FROZEN
-
Lockfile was frozen
-
LCK_E_IMMORTAL
-
Lockfile process could not be killed
-
LCK_E_KILLED
-
Lockfile process was killed
-
LCK_E_KILLED9
-
Lockfile process was killed with -9
-
LCK_E_OK
-
Lockfile created ok
-
LCK_E_ORPHAN
-
Lockfile is orphaned (no associated process)
-
LCK_E_READFAIL
-
Lockfile could not be read
-
length
-
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.
-
length
-
Length of output buffer
-
limit
-
Define search LIMIT clause
-
limit
-
Define query LIMIT
-
Link
-
Constructor
-
Link
-
Clickable link
-
linked_table
-
Associates a table with the maintained table via a link-table.
-
load_template
-
Load given template content.
-
lock
-
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.
-
lock
-
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.
-
lock
-
This method must be defined in the child class.
-
lockfile
-
Make a new lockfile handler object.
-
lockfile
-
A class to handle a lockfile for a running process. The idea is you
-
lockfile-defs.php
-
-
lockrows_exclusive
-
Lock table in ROW EXCLUSIVE MODE
-
lockrows_share
-
Lock table in ROW SHARE MODE
-
locktable_exclusive
-
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.
-
locktable_share
-
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.
-
lock_thread
-
-
LOGIN_BY_AUTHCODE
-
Login by using authorisation code (MD5 string usually)
-
LOGIN_BY_GUEST
-
Login by using guest account
-
LOGIN_BY_IP
-
Login by remote IP address match
-
LOGIN_BY_PASSWD
-
Login by standard username/password
-
LOGIN_UNKNOWN
-
No known login has been achieved
-
log_sys
-
Send a message to the system logfile Send message to the syslog, prefixed with APP_NAME nicely. Saves having to prefix it each time.
-
LOOP
-
Used to indicate sound should loop indefinitely
-
LOWER
-
Force text to lowercase
-
lucene-defs.php
-
-
lucene_backup
-
Function to make a backup of the Lucene index. This would commonly
-
lucene_connection
-
The lucene connection class
-
lucene_connection
-
Constructor - Lucene connection
-
lucene_fileindexer
-
Constructor
-
lucene_fileindexer
-
The lucene file indexer class.
-
lucene_indexmsg
-
Constructor Make a new Lucene index message.
-
lucene_indexmsg
-
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.
-
lucene_message
-
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.
-
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.
-
lucene_monitor
-
Define a new Lucene monitor object. We register the Lucene query to use and the number of hits we expect. You can also specify the hostname and port of the Lucene server here, although Axyl users can leave these out (blank) if they have configured them with setup-system.php.
-
lucene_monitor
-
A monitor class to check if Lucene is up and about
-
lucene_msg
-
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.
-
lucene_msg
-
Constructor
-
lucene_optimize
-
Function to optimize the Lucene index. This would commonly be used after a batch of items have been indexed.
-
lucene_purge
-
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!?".
-
lucene_purgemsg
-
Constructor Make a new Lucene purge message. This message is provided to allow you to delete all items from the Lucene index.
-
lucene_purgemsg
-
The lucene purge message class. This class allows you to remove all
-
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.
-
lucene_querymsg
-
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.
-
lucene_search
-
Constructor
-
lucene_search
-
The lucene search class
-
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.
-
lucene_unindexmsg
-
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.
-
lucene_utilitymsg
-
Constructor
-
lucene_utilitymsg
-
The lucene utility message class. Used for special Lucene operations.
-
$map
-
Image map to use
-
$map
-
Name of an image map
-
$match_type
-
Match type for keys
-
$maxlength
-
Maximum user-enterable chars for field
-
$maxvalue
-
Sequence max value
-
$max_file_size
-
Maximum file suze in bytes
-
$max_results
-
Maximum results to return in query
-
$max_size
-
Max filesize, else delete (0 = any size)
-
$mbstring_avail
-
Whether we have multi-byte string fns available
-
$media
-
-
$menu
-
The menu instance
-
$menu
-
The menu instance
-
$menuhref
-
WWW menu URL - theme aware
-
$menuopimage
-
Image to use to indicate a menu option
-
$menuoptionid
-
menuoption ID
-
$menuoptions
-
The array of menu options
-
$menuoption_id
-
Initial menuoption ID
-
$menuoption_id
-
Menuoption ID - FK to ax_menuoption record
-
$menuoption_label
-
Label for menu option of this page
-
$menuvarsfile
-
Path to menu variables file - theme aware
-
$menu_desc
-
The description of the menu
-
$menu_id
-
Unique database menu ID
-
$menu_id
-
The ID of the menu
-
$menu_id
-
Unique database menu ID
-
$menu_id
-
menu ID the option belongs to
-
$menu_id
-
Unique database menu ID
-
$menu_id
-
The ID of the microsite menu
-
$menu_level
-
The level of the menu-options
-
$menu_level
-
Menu level of this item
-
$menu_level
-
Menu option level
-
$menu_level
-
Level of menu to render
-
$menu_level
-
Level of menuitems to return
-
$menu_name
-
Menu name eg: 'main'
-
$menu_name
-
Menu name eg: 'main'
-
$menu_name
-
The name of the menu
-
$menu_name
-
Name of this menu eg: 'main'
-
$menu_name
-
Menu name eg: 'main'
-
$menu_structure_changed
-
Whether menu structure was rebuilt or not
-
$menu_type
-
Menu type from stylesheet: vertical, horizontal
-
$menu_width
-
Fixed menu width, or zero if not fixed
-
$message
-
The message waiting to be sent
-
$message
-
Message to display (optional)
-
$messages
-
Latest error message
-
$meta
-
Meta tags array
-
$metadata_elements
-
The metadata elements themselves
-
$metadata_mode
-
Metadata edit/generation mode we are in
-
$metascan
-
Scan for meta tags as fields in file content. Recommended.
-
$meta_fields
-
Meta fields definitions array. Contains definitions
-
$method
-
Method, eg. "post"
-
$method
-
Method attribute
-
$microsites_mode
-
Microsites edit/generation mode we are in
-
$microsite_desc
-
The description of the microsite
-
$microsite_detected
-
Name of the microsite detected, or undefined
-
$microsite_domain
-
The domain of the microsite
-
$microsite_homepage
-
Whether this page is the microsite home page
-
$microsite_name
-
The name of the microsite this template is for
-
$microsite_name
-
-
$microsite_name
-
The name of the microsite
-
$microsite_name
-
Name of microsite this page is for
-
$microsite_page_id
-
Unique microsite page ID
-
$microsite_template_id
-
Unique microsite template ID
-
$microsite_template_id
-
Microsite template ID (Fk)
-
$mimeboundary
-
MIME boundary marker to use
-
$mimecontenttype
-
MIME content type for the e-mail
-
$mimeparts
-
Assembled mime attachments
-
$mimetype
-
Mime type of the the file
-
$mimetype
-
MIME type of data required by the object
-
$mimetype
-
The MIME type of the object
-
$mime_category
-
-
$mime_type
-
-
$minspace
-
Threshold (bytes) before error condition
-
$minvalue
-
Sequence minimum value
-
$MM
-
-
$mobile
-
-
$mode
-
mode of operation
-
$mode
-
Mode of operation, 'viewing', 'editing', 'saving' @access private
-
$moderator
-
-
$monitors
-
Array of monitors which do the work
-
$months
-
-
$movie
-
-
$msg
-
Actual error message in detail
-
$msg_id
-
-
$msg_subject
-
-
$msg_text
-
-
$multilang
-
Whether we are in multi-language mode or not, If this is true then
-
$multiselect
-
Boolean, multiple item select
-
mail-defs.php
-
-
maintainer
-
Create a new maintainer.
-
maintainer
-
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.
-
maintainer-defs.php
-
-
make_precis
-
Generate a precis from the story content.
-
match
-
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.
-
match
-
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.
-
matches
-
-
matchfield
-
Add search term to match a field value.
-
matchrange
-
Add search term to match a field value range.
-
matrix
-
Construct a new matrix.
-
matrix
-
A matrix is a table with no colspans or rowspans. It is an N x M
-
may_match
-
Define a search term which the search may or may not match.
-
may_matchfield
-
Add search term: may match a field value.
-
MediaObject
-
Generic Multimedia Object
-
MediaObject
-
Constructor
-
MEGABYTE
-
Megabytes
-
menu
-
Constructor Creates the menu object.
-
menu
-
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.
-
menu-defs.php
-
-
menuitem
-
Constructor Creates the menu item object.
-
menuitem
-
Standard menu item. Takes a link object as the item in the menu.
-
menumaint-defs.php
-
-
menumaintainer
-
Menu Maintainer
-
menumaintainer
-
Constructor Create a new menumaintainer.
-
menuoption
-
The menuoption is a class which contains the properties of a single option on a menu.
-
menuoption
-
Constructor Create a new menuoption object.
-
MENU_ITEM_SEPARATOR
-
The menu item is a separator line
-
MENU_ITEM_SPACER
-
The menu item is a spacer
-
MENU_ITEM_SUBMENU
-
The menu item is a sub-menu heading
-
MENU_ITEM_URL
-
The menu item is an ad-hoc URL
-
MENU_LEVEL0
-
Main menu level (0)
-
MENU_LEVEL1
-
Menu level 1
-
MENU_LEVEL2
-
Menu level 2
-
MENU_LEVEL3
-
Menu level 3
-
MENU_LEVEL4
-
Menu level 4
-
MENU_LEVEL_ALL
-
All menu levels
-
merge_cols
-
Apply a colspan in an existing table. The row and column of the
-
merge_rows
-
Merge rows at a given cell column.
-
metadata-defs.php
-
-
METADATA_DISABLED
-
Disable metadata editing and generation enhancements
-
metadata_element
-
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.
-
metadata_element
-
Constructor
-
METADATA_ENABLED
-
Enable metadata editing and generation enhancements
-
metadata_scheme
-
A class which encapsulates a metadata scheme. This is a set of
-
metadata_scheme
-
Constructor
-
metadata_tree
-
Returns a string containing a table which contains all of the meta data in a nice tree view.
-
metatag
-
Render this metadata element as a metatag object. This method creates the metatag object and returns it.
-
meta_element_count
-
Returns the number of meta elements in this layout.
-
meta_field
-
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.
-
meta_tag
-
A class which is derived from the generic tag class, and which is specifically for the HTML META tag.
-
meta_tag
-
Constructor. Creates an empty HTML meta tag object.
-
META_TAG_FIELDS
-
Indicates index fields come from meta tag extraction
-
microsecs
-
Returns the micro-seconds on the clock.
-
microsite
-
The Microsite Class
-
microsite
-
Constructor Create a new microsite instance.
-
microsite-defs.php
-
-
MICROSITES_DISABLED
-
Disable microsites editing and generation enhancements
-
MICROSITES_ENABLED
-
Enable microsites editing and generation enhancements
-
microsite_page
-
Constructor
-
microsite_page
-
Microsite Page - a container class.
-
microsite_template
-
Microsite Template - a container class.
-
microsite_template
-
Constructor
-
microtimer
-
Constructor Create a new microtimer.
-
microtimer
-
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.
-
millisecs
-
Returns the milli-seconds on the clock.
-
mime-types.php
-
-
mimetype_category
-
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.
-
mimetype_from_filename
-
Returns the mimetype associated with the given filepath or false of no match was found..
-
mins_diff
-
Tell minutes difference between too datetimes Returns the minutes difference between the two given datetimes.
-
MIN_PLUGIN_SLOTS
-
-
MIXED
-
Mixture of content: text/html/etc.
-
mkpath
-
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.
-
modify_replies
-
-
monitor
-
Create a new monitor object.
-
monitor
-
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.
-
monitor-defs.php
-
-
monthNameNow
-
Month now as string Returns the month name (eg. "January") as it is now..
-
monthno
-
Return month number Return the number of the named month, default to Jan if problems arise.
-
monthNow
-
Month now as integer Returns the month (1-12) as it is now.
-
MOVIE_MIMES
-
-
MULTILANG_DISABLED
-
Disable multi-language extensions
-
MULTILANG_ENABLED
-
Enable multi-language extensions
-
multipart_form
-
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.
-
multipart_form
-
Create an multipart_form object. Sets basic form attributes.
-
MULTISELECT
-
Combo-field is multiple-select
-
must_match
-
Define a search term which the search must match to succeed.
-
must_matchfield
-
Add search term: must match a field value.
-
$padimage
-
Image to use for padding/indenting menu options
-
$padsize
-
Size of level indent padding in px
-
$pageno
-
Current page number
-
$pager_condition_threshold
-
Threshold condition for paging
-
$pages
-
Pages in this microsite (array)
-
$pagesize
-
Size of each page in characters
-
$pageStyle
-
style included in the iframe document (default nullstring)
-
$pagetext
-
Text for current page
-
$page_expiry_secs
-
Dynamic page expiry in seconds. Time to allow a dynamic page to
-
$page_id
-
Page ID - key to ax_sitepage record
-
$page_id
-
Axyl sitepage ID (Fk)
-
$page_path
-
Axyl sitepage page filepath
-
$page_title
-
Title of this page
-
$paginghref
-
URL for getting next page
-
$parameters
-
-
$params
-
Array of parameter key-values
-
$ParentMsg
-
-
$parent_element_id
-
The element ID of the parent element of this item
-
$parent_id
-
ID of parent menuitem of this menuitem
-
$parent_id
-
Parent ID of this menu option
-
$parms
-
Miscellaneous content for the body tag
-
$parser
-
Parser object
-
$passwd
-
Default password to connect as
-
$password
-
-
$password
-
Text password (encrypted or plain)
-
$password
-
Password of username to connect as
-
$perms
-
Array of permisssions. This is an associative array with the
-
$persistent
-
True if we want a persistent connection
-
$persistent_hosts
-
Array of hosts we wish to connect persistently to
-
$phone
-
phone
-
$phone
-
-
$phone_fax
-
phone_fax
-
$phone_mobile
-
phone_mobile
-
$phone_work
-
phone_work
-
$physicalpath
-
-
$pid
-
Process ID of process lockfile is for
-
$pkey
-
Array of field attnum's which are primary keys in table
-
$pluginid
-
ID or name of this plugin
-
$plugins
-
Plugins we want to register for this field
-
$plugins
-
Array of plugins in this set
-
$pluginset
-
Set of plugins with content
-
$pluginspage
-
URL of page to acquire the relevant object plugin
-
$pluginspage
-
URL of page to acquire the relevant embed plugin
-
$plugin_contents
-
Array of plugin content objects
-
$plugin_slots
-
Number of plugin slots we provide to edit page plugins
-
$port
-
For TCP connections: port to connect to
-
$port
-
Port to connect to
-
$port
-
PORT that the server is listening on
-
$port
-
Port to access it via TCP
-
$position
-
Positioning mode
-
$posted_publish
-
Flag to indicate POST told us to publish
-
$posted_revert
-
Flag to indicate POST told us to revert
-
$postfields
-
Array of fields to post
-
$posts
-
-
$posturl
-
-
$preferred
-
Whether this is the 'preferred' scheme, of many
-
$preferred_scheme_id
-
ID of preferred scheme for this metadata element
-
$prefix
-
Prefix to differentiate one set of records from anther
-
$prefix_last_modified
-
The prefix string for last modified datetime
-
$preview_img_height
-
Height of preview in px
-
$preview_img_width
-
Width of preview in px
-
$primary
-
True if index is for a primary key
-
$private
-
-
$privileges
-
The group privilege settings for this layout, as
-
$privilege_groups
-
The groups which have privilege settings for this layout, as
-
$profile
-
Profiler data array
-
$profile_timer
-
Microtimer object for profiling
-
$progname
-
The current program name
-
$pseudo_item_spacing
-
Padding before (above) 'pseudo' menu options
-
$publish_output
-
-
page
-
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.
-
page
-
Deliver page N Delivers the text content for the specified page.
-
pages
-
Pages class
-
pages
-
Constructor Creates the basic text paging object.
-
page_section
-
The page section class
-
page_section
-
Constructor Create a new page section object.
-
paging-defs.php
-
-
PARALLEL
-
Parts intended to be viewed all at once
-
parameter
-
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.
-
parameter
-
Make a new parameter.
-
parameters
-
Return the types parameter list, including brackets.
-
parse
-
Parse the given XML document.
-
parse
-
Parse the application XML which is provided.
-
paste_layout
-
Paste the given layout into this layout, replacing the complete
-
peek_cell
-
Peek content from the given row,col cell..
-
perform_hierarchy_scan
-
Assembles all metadata elements for this layout.
-
permission
-
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).
-
permissions
-
The permissions class. This class encpasulates a set of permissions which can be managed and tested by the associated methods.
-
permissions
-
Constructor Create a new permissions object with an optional permissions set.
-
permit
-
Set permission for this cell for given agent
-
permit
-
Set cell permissions across entire table
-
permit
-
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.
-
permit_cell
-
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.
-
PERM_ALL
-
All permitted
-
PERM_ALLOWED
-
Permission is given
-
PERM_CREATE
-
Permission to create items
-
PERM_DELETE
-
Permission to delete items
-
PERM_DISALLOWED
-
Permission is refused
-
PERM_NONE
-
Nothing permitted
-
PERM_READ
-
Permission to read/view items
-
PERM_UNDEFINED
-
Permission is undefined
-
PERM_UPDATE
-
Permission to update/modify items
-
PERSISTENT
-
Connect persistent to DB
-
pg-schema-defs.php
-
-
pim-defs.php
-
-
plaintext_content
-
Return the content of this story formatted for plaintext display
-
PLAIN_CELL
-
Layout cell content: plain cell
-
plugin
-
Add content to a plugin Plugins are regions of a webpage which you want to plug content into.
-
plugin
-
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.
-
plugin
-
Constructor Create a new plugin object.
-
plugin-defs.php
-
-
pluginset
-
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.
-
pluginset
-
Constructor Create a new plugin set. This is just a container for plugins.
-
plugin_inline
-
Start/stop inline plugin content definition
-
plugin_replace
-
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.
-
poke_cell
-
Poke some content into the given row,col cell..
-
poke_cellcss
-
Poke a css class/style onto the given row,col cell..
-
postfield
-
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.
-
POSTGRES_DATE_FORMAT
-
Example: 12-31-1999 23:59:59
-
postgres_monitor
-
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.
-
postgres_monitor
-
Define a new Postgres monitor object.
-
POSTGRES_STD_FORMAT
-
Example: 1999-07-17 23:59:59
-
POSTprocess
-
-
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.
-
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.
-
POSTprocess
-
Process a block edit form POST.
-
POSTprocess
-
Process GET/POST from form.
-
POSTprocess
-
Process the POST of the form of this metadata element. We are just looking for the few fields containing the relevant data.
-
POSTprocess
-
-
POSTprocess
-
Process the POST from form. This method deals with POSTed content from the edit form.
-
post_to
-
Set the URL of script to POST the calendar form to.
-
PRIMARY_KEY_ONLY
-
Run getschema() to get primary key(s) only
-
printable
-
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.
-
process_navigation
-
Process any menu navigation.
-
profile
-
Profile breakpoint.
-
profiling
-
Returns true if this debugger is in profiling mode.
-
prose_diff
-
Tell nice difference between too datetimes
-
prose_diff_ts
-
Tell nice difference between too Unix timestamps
-
protocol_prefixed
-
Detect a URL with the "xxx://" protocol prefix. Returns true if it does, else false.
-
publish
-
Publish this microsite. We build the dir structures which actually
-
publish
-
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.
-
publishto
-
Publish the template(s) into the given directory. The filename will be as per the Axyl standard, depending on template name and type.
-
publishto
-
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.
-
publish_request
-
Request publishing for this microsite. We just set a database flag so that the cron script will do the work.
-
put
-
Save the block.
-
put
-
Save the blocklet.
-
put
-
Save the config.
-
put
-
Save this menu to the database. Create a new one if it doesn't already exist.
-
put
-
Save the menuoption.
-
put
-
Save the layout.
-
$records
-
Record data to maintain
-
$recvalid
-
True if record is valid
-
$reference
-
Reference time to base elapsed interval on
-
$reference_url
-
Reference URL for this scheme
-
$regmode
-
-
$relative_positioned
-
Positioned relatively, or not
-
$remote_address
-
The remote IP address
-
$render_form
-
-
$render_subform
-
-
$replacement
-
Replacements to make in template
-
$replies
-
-
$replyto
-
e-mail ReplyTo address
-
$reportmsg
-
Report staging for email
-
$requested
-
Path to the requested script/page
-
$requested_query
-
Query string (if any) supplied to requested page
-
$req_microsite_publish
-
Whether microsite publish is being requested
-
$req_microsite_remove
-
Whether microsite removal is being requested
-
$response
-
Response object which will parse XML content
-
$responsebuf
-
Raw response content we receive back from the Lucene server
-
$return_type
-
-
$rid
-
The result ID last returned by a query on this DB. Also
-
$rid
-
Current row resource ID
-
$root_translation_id
-
-
$root_translation_lang
-
-
$rowcount
-
Number of rows returned after execute
-
$rowcount
-
Row count - total records in table
-
$rowno
-
Current row in the query
-
$rows
-
Rows in table
-
$rows
-
Number of rows in the text box
-
$rowspan
-
Row span that this cell is anchor of
-
$rowspanned
-
Whether this cell is rowspanned (invisible)
-
$ruler
-
blocklet ruler: 'none', 'top', 'bottom'
-
$ruler_colour
-
Ruler colour
-
$ruler_size
-
Ruler pixel size
-
$ruler_width
-
Ruler width percent: 0-100
-
raise_condition
-
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.
-
rawfield
-
Get field content Return the field content from the current database array (row).
-
readall
-
Reads all of the file contents into class variable $content.
-
readln
-
Reads the next line of the file, up to max chars specified.
-
readln
-
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.
-
rebuild
-
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.
-
recmaint-defs.php
-
-
recmaintainer
-
The record maintainer class.
-
recmaintainer
-
Define a record maintainer object.
-
RECORD_DELIM
-
Record delimiter used in record lists
-
recover
-
Recover session Recover an existing session. This will obliterate any pre-existing session information in this object, since we expect it to succeed..
-
refresh
-
Refresh the query Re-run the current SQL query. If successful the row will be stored in $this->current_row.
-
register
-
Register the given comma-delimited list of varnames, These are the names of global variables which can come from 'outside sources'.
-
register
-
Register vars Register given variables for globalisation.
-
register_button
-
Register a button.
-
register_field
-
Register a form field in the maintainer.
-
register_plugins
-
Set the plugins to register for this Wysiwyg editor. This is a subset
-
remember
-
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.
-
remember
-
Remember variable names Register the given comma-delimited list of varnames in the current session..
-
remove
-
Remove the lockfile. Can't do this if the lock is frozen, which is deemed to require manual intervention.
-
remove_blocklet
-
Remove blocklet from the block.
-
remove_menuoption
-
Remove menuoption from the menu. Just removes the given menuoption from the list in this object - no database changes are made.
-
remove_metadata_element
-
Removes the layout metadata for a given element. This deletes the relevant record from the ax_layout_metadata table.
-
remove_request
-
Remove publishing for this microsite. We just set a database flag
-
render
-
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.
-
render
-
Generate the content into the buffer, then return the content.
-
render
-
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.
-
render
-
Return content to caller
-
render
-
Render the tag as XML.
-
render
-
Render output
-
render
-
Returns the string which represents all of the content
-
RenderableObject
-
RenderableObject class This object should be inherited by all classes which are intended to output content for the client browser.
-
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.
-
renderable.php
-
-
render_as_subform
-
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.
-
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.
-
render_in_form
-
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.
-
render_layouts
-
Find content layout tags in a string.
-
render_story_icon
-
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.
-
replace
-
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.
-
replace
-
Replace pattern in webpage content
-
replace
-
Replaces multiple occurrences of the given tag (pattern) in the body content with the specified new stuff.
-
replace_content
-
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.
-
replicate
-
Replicate this block into a new block with a new set of blocklets as a complete content copy of this original block.
-
replicate
-
Replicate the hosted layout as a new layout. Creates a brand new
-
replicate
-
Replicate the hosted layout as a new layout. Creates a brand new
-
replicate
-
Replicate this block into a new block with a new set of blocklets as a complete content copy of this original block.
-
ReplyTo
-
Set replyto Set the e-mail ReplyTo: e-mail address.
-
report_classes
-
List classes debugger is accepting
-
reset
-
Reset the data Resets the internal array to the start. This is used when you need to repeatedly traverse the data.
-
reset
-
Reset the timer. This zeroes the timer. If it was ticking it goes on ticking, but starting from zero.
-
reset_button
-
Constructor
-
reset_button
-
Reset button A standard form reset button appearing as the standard grey widget.
-
reset_search
-
Reset search results Reset the search results, hit-count, and query executed status.
-
reset_webstream
-
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.
-
resolveFK
-
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 "#".
-
response
-
Return complete WML response content including DOCTYPE, <wml> tags, and the content-length header.
-
response
-
THE RESPONSE CLASS
-
response
-
Constructor Create a new response.
-
response-defs.php
-
-
restart
-
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.
-
rollback
-
Rollback a DB transaction
-
rollback
-
Rollback the currently open database transaction.
-
rollback
-
Roll back the current database transaction. All queries executed as part of the open transaction will be rolled back.
-
ROLLBACK_ON_FAIL
-
Transaction response to failure - rollback
-
rowcount
-
Return the number of rows in this table.
-
rowexists
-
Returns true if the row number exists in the returned resultset.
-
rowmenu
-
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.
-
rowmenu
-
Constructor
-
rowmenu-defs.php
-
-
rowstripes
-
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.
-
$savehow
-
How to save: default "overwrite", or "append" to append.
-
$savepw
-
-
$schedule
-
Schedule of named timeslots for this monitor
-
$schema
-
Reference to the schema object this belongs to
-
$schema
-
Database schema
-
$schema_name
-
The meta schema that this item was sourced from
-
$schema_namespace
-
The namespace code for the schema
-
$schema_namespace_uri
-
The refence URi for the schema
-
$schemes
-
Schemes associated with this metadata element. This
-
$scheme_id
-
Unique encoding scheme ID
-
$scheme_id
-
Unique encoding scheme ID
-
$script
-
Script content for this page section
-
$scriptsrc
-
Scripts which are sourced via a URL
-
$searchable
-
Whether this element can be searched for
-
$searchdir
-
Directory to do the search from
-
$searchindex
-
Name of index file to use (defaults to 'swish++.index')
-
$searchquery
-
The query which runs the search
-
$searchterm
-
Array of search terms to match
-
$seconds
-
Current number of seconds on the timer
-
$separator
-
Separator string between menu options
-
$separator
-
Separator character between items
-
$sequencename
-
The name of the sequence
-
$sequences
-
-
$serialno
-
A unique handle to identify the index
-
$session_id
-
The ID of this session
-
$session_id
-
The current user session ID
-
$session_record
-
The session record complete
-
$set
-
Set of configuration fields/values in this configuration set
-
$setchanged
-
Whether configuration data has changed or not
-
$settings
-
-
$shade
-
Whether HR is shaded or not
-
$showcontrols
-
If true the mediaplayer controls are shown
-
$showlabels
-
Whether to render labels for fields
-
$show_last_modified
-
True if we should display last modified date
-
$show_recfilter
-
If true we include a built-in record filter
-
$show_statusbar
-
If true, status bar is displayed
-
$sitepage
-
Target site webpage when clicked
-
$sitepage_parms
-
Paramter string to pass on webpage URL
-
$site_docroot
-
Path to the site document root
-
$site_url
-
The URL of this website
-
$size
-
Size of the object
-
$sizeIncludesToolbar
-
the next parameter specifies whether the toolbar should
-
$skip_results
-
No. of results to skip in query (for paging)
-
$smstxtmsg
-
Report staging for SMS txt
-
$sockfp
-
Socket file pointer
-
$sort_limit_exceeded
-
Set to true if sort limit was exceeded in query
-
$sort_memory_exceeded
-
Set to true if Lucene blew its memory trying to sort
-
$sql
-
The formatted SQL query itself @see build()
-
$src
-
Source URL for this object
-
$src
-
Image file source URL/path
-
$src
-
-
$standby
-
Standby message text
-
$start
-
Sequence start
-
$startyear
-
-
$start_disabled
-
If true, maintainer will be displayed with fields disabled
-
$state
-
State of processing
-
$statusBar
-
enable creation of a status bar? (default true)
-
$sticky
-
-
$sticky
-
-
$storymode
-
-
$story_author
-
-
$story_author_name
-
-
$story_category
-
-
$story_category_desc
-
-
$story_content
-
-
$story_date
-
-
$story_date_ts
-
-
$story_headline
-
-
$story_icon
-
-
$story_icon_url
-
-
$story_id
-
ID of story this media belongs to
-
$story_id
-
-
$story_locs
-
-
$story_media
-
-
$story_precis
-
-
$story_translations
-
-
$story_type
-
-
$strict
-
-
$style
-
The style to apply to this object
-
$style
-
Style to apply to the link text
-
$style
-
Style settings for the webpage
-
$stylesheet
-
Name of stylesheet file to get menu styles from
-
$stylesheet
-
Path to the stylesheet for menu
-
$stylesheet
-
Name of stylesheet file to get menu styles from
-
$stylesheet
-
Name of the stylesheet associated with the webpage
-
$stylesheet_ie
-
Name of the IE stylesheet
-
$stylesheet_ns
-
Name of the Netscape stylesheet
-
$SubBorderColor
-
Colour of sub-menu border
-
$SubBorderWidth
-
Width of sub-menu border in px
-
$SubHighBgColor
-
Colour of sub-menu highlighted item background
-
$SubHighColor
-
Colour of sub-menu highlighted item text
-
$subject
-
-
$subject
-
Subject of the e-mail
-
$SubLowBgColor
-
Colour of sub-menu item background
-
$SubLowColor
-
Colour of sub-menu item normal text
-
$success_regex
-
-
$success_value
-
-
$summaryfield
-
True if main field should be suppressed
-
save
-
Save current catalog item definition to the database. Inserts if brand new, else performs an update.
-
save
-
Save this microsite to the database. Create a new one if it doesn't already exist.
-
save
-
Update or create the microsite template to the database.
-
save
-
-
save
-
Save the organisation.
-
save
-
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.
-
save
-
Save the contactinfo.
-
save
-
Update or create the microsite page. Also saves the template data associated with it.
-
SAVE_FILE
-
Save the file on close
-
save_forum
-
-
save_metadata_element
-
Saves the layout metadata for a given element. This saves data to the ax_layout_metadata table.
-
save_msg
-
-
save_story
-
Routine to save the story to the database.
-
save_thread
-
-
scantags
-
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.
-
schedule
-
-
schedule
-
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.
-
schema
-
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.
-
schema
-
Class describing a database schema. This object hold ALL the information
-
schema-defs.php
-
-
SchemaObject
-
Defines a virtual object which is used to denote something which is a part of an existing database schema.
-
SchemaObject
-
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.
-
script
-
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.
-
SCRIPT_APPEND
-
Add script by keeping current content and appending to the end
-
SCRIPT_PREFIX
-
Add script by keeping current content and prefixing to the beginning
-
SCRIPT_REPLACE
-
Add script by replacing current content (default)
-
scrub
-
Scrubs the given string to make it acceptable to touchy WML parsers in cellphones.
-
search
-
Perform a search for catalog items. This method will use Lucene
-
search
-
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.
-
search
-
Constructor Create a new search.
-
search-defs.php
-
-
secs
-
Returns the seconds on the clock as a floating point number.
-
SECS_1_DAY
-
One day
-
SECS_1_HOUR
-
1 hour
-
SECS_1_MONTH
-
One month
-
SECS_1_WEEK
-
One week
-
SECS_1_YEAR
-
One year
-
SECS_4_HOURS
-
4 hours
-
SECS_8_HOURS
-
8 hours
-
SECS_10_YEARS
-
Ten years - used as 'forever'
-
SECS_12_HOURS
-
12 hours
-
SECS_20_MINS
-
20 minutes
-
select
-
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.
-
select_database
-
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.
-
selfregistration-defs.php
-
-
send
-
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.
-
send
-
Sends the current message to Lucene, and checks for protocol errors in the received response.
-
send
-
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.
-
send
-
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.
-
send
-
Generate the content and then send it to the user browser.
-
send
-
Send the message to Lucene, and then post-process the response for
-
send
-
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.
-
send
-
Send content to user browser
-
send_confirmation_email
-
-
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.
-
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.
-
send_to_browser
-
Send content to user browser
-
send_to_file
-
Send debug output to a file.
-
send_to_file
-
Send content to file Deliver the content to a given file.
-
SEP_BAR
-
Menu item separator: "|" (pipe)
-
SEP_DBLSPACE
-
Menu item separator: " " (double-space)
-
SEP_SPACE
-
Menu item separator: " " (space)
-
session
-
Constructor Create a new session.
-
session
-
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.
-
session-defs.php
-
-
session_clear
-
Clear session vars Common method for clearing out the current session info from the object variables.
-
session_create
-
Create new session Make a brand new session for the user.
-
session_delete
-
Delete the session Delete the current session from the system.
-
session_valid
-
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.
-
SESS_1_DAY
-
Session lasts for 24 hours
-
SESS_1_HOUR
-
Session lasts for 1 hour
-
SESS_1_MONTH
-
Session lasts for 1 month
-
SESS_1_WEEK
-
Session lasts for 1 week
-
SESS_1_YEAR
-
Session lasts for 1 year
-
SESS_4_HOURS
-
Session lasts for 4 hours
-
SESS_8_HOURS
-
Session lasts for 8 hours
-
SESS_12_HOURS
-
Session lasts for 12 hours
-
SESS_20_MINS
-
Session lasts for 20 minutes
-
SESS_ALLOW
-
Login limit exceeded: Allow, assume app. takes action
-
SESS_ALLOW_CULL
-
Login limit exceeded: Allow session, cull oldest
-
SESS_BLOCK_GUEST
-
Login limit exceeded: Block session, login as guest instead
-
SESS_BLOCK_MSG
-
Login limit exceeded: Block session, nice message
-
SESS_BLOCK_REDIRECT
-
Login limit exceeded: Block session, redirect to URL
-
SESS_BLOCK_SILENT
-
Login limit exceeded: Block session, no message
-
SESS_BROWSER_LIFETIME
-
Session lasts as long as user browser is open
-
SESS_DATABASE_BACKED
-
Session is backed by a database connection
-
SESS_FOREVER
-
Session lasts forever.. well, 10 years is near enough.
-
SESS_STANDALONE
-
Session is standalone, no database
-
SESS_ZERO_LIFETIME
-
Session has no lifetime, immediate expiry
-
set
-
Set constraint variables.
-
set
-
Set the vars for this function
-
set
-
Define field assignments Defines the field assignment clauses for UPDATE and INSERT queries.
-
set
-
Set the vars for this trigger
-
set
-
Set index variables.
-
setaccesskey
-
Set the access key of the object
-
setalign
-
Set the horizontal alignment eg: left, center, right
-
setalignment
-
Set the alignment of this cell
-
setalt
-
Set the ALT text
-
setattribute
-
Set a tag attribute key=value pair.
-
setbackground
-
Set the background image (url)
-
setbgcolor
-
Set the background colour
-
setborder
-
Border thickness (pixels)
-
setcellid
-
Set the cell ID
-
setclass
-
Set the class (from stylesheet) for the object
-
setcolor
-
Set the foreground colour
-
setcolspan
-
Set the number of columns this cell spans
-
setcontent
-
Set the content for this cell
-
setcontentcss
-
Set the style or class for the content of this cell
-
setcss
-
Set class or style for the object. A style is detected by the presence of the colon (:) character in the string.
-
setdefault
-
Assign the default permission. This is the permission which is applied if the supplied agent is not recognised.
-
setdefault
-
Return SQL to set the default for given field on this table.
-
setheight
-
Set the height specifier of the element
-
sethspace
-
Horizontal spacing (pixels)
-
setid
-
Set the ID tag of the object
-
setimage
-
Sets the image to display for this button.
-
setlabel
-
Set the label associated with the field
-
setlang
-
Set the language for text content
-
setlangdir
-
Set the text direction for text content: 'rtl' or 'ltr'
-
setmetrics
-
Set the width and height of this cell
-
setname
-
Set the name of the object
-
setnbsp
-
Set nbsp setting for cells in this table
-
setnullconstraint
-
Return SQL to set the NULL/NOT NULL constraint..
-
setnullconstraint
-
Return SQL to set the NULL/NOT NULL constraint..
-
setpadding
-
Set the table padding and spacing amounts. This sets the table 'cellpadding' and 'cellspacing' attributes, in that order.
-
setparam
-
Set up a new object parameter name/value pair. This will be rendered as a param name="foo" value="bar" tag.
-
setparameter
-
Set the value of a named parameter for a named setting. Optionally provide the element name for arrayed parameters.
-
setparameter
-
Set the value of a parameter which already exists in this setting.
-
setrowspan
-
Set the number of rows this cell spans
-
setsize
-
Set the size specifier of the element
-
setsrc
-
Set the src URL/relative path
-
setstyle
-
Append a style to ant exitsing style the object has.
-
setstyle
-
Sets the style Sets the style for the href tag.
-
settabindex
-
Set the TAB index of the object (with alias)
-
settarget
-
Set the frame target.
-
setting
-
Make a new setting
-
setting
-
Application settings class. This class contains one or more parameters.
-
settitle
-
Set the title of this element
-
seturl
-
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.
-
setvalign
-
Set the vertical-alignment eg: top, middle, bottom
-
setvalue
-
Set the parameter to given value. If the parameter has an array of values, the name is also given.
-
setvalue
-
Set the value of the field
-
setvspace
-
Vertical spacing (pixels)
-
setwidth
-
Set the width specifier of the element
-
set_allowed_groups
-
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.
-
set_allowed_types
-
Set the allowed list of filetypes. This is specified as a comma-delimited list, and replaces any already defined.
-
set_application
-
Specify the application. The application is the name of a configuration
-
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.
-
set_authentication_type
-
Set website authentication
-
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.
-
set_blocked_ips
-
define a blocked IP list.
-
set_blockformats
-
Set a new list of selectable block formats. The array should be an
-
set_buffering_mode
-
Set buffering option
-
set_categories
-
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).
-
set_cell
-
Replace the given cell with new table cell. Returns true if ok.
-
set_charset
-
Set the charset for this head section
-
set_char_encoding
-
This method must be defined in the child class.
-
set_char_encoding
-
Set the database character encoding. This affects the encoding of characters in the database.
-
set_compression_minsize
-
Set compression threshold Set the threshold size of content before we use compression.
-
set_compression_type
-
Set compression type
-
set_condition_thresholds
-
Sets the threshold at which we will send messages to email & pager.
-
set_confirmation
-
Sets parameter string associated with the button.
-
set_confirm_text
-
Set the confirmation text to popup on click.
-
set_confirm_text
-
Set the confirmation text to popup on click using Javascript.
-
set_cookie
-
Set the session cookie.
-
set_cookiename
-
Set session cookie name
-
set_css_date
-
Set the style of class for the date display
-
set_css_time
-
Set the style of class for the time display
-
set_daterange
-
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.
-
set_datestyle
-
Set the database date style. This affect the format that dates will be displayed in, and the format they are submitted in.
-
set_datestyle
-
This method must be defined in the child class.
-
set_datetimeformat
-
Sets a datetime format string for a specified field. This influences the formatting of displayed dates and/or times in that field.
-
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'.
-
set_dbversion
-
Set the database version
-
set_default
-
Internal function to set the name of the default database.
-
set_default_images
-
Set the standard images up. This method just re-asserts that the Xmenu should use the standard Xmenu images for arrows, spacer etc.
-
set_disabledfields
-
Specify that the given fields should be disabled, not editable. Field is seen on screen, but is not modifiable.
-
set_displayonly
-
Set the field to be display-only (non-editable)
-
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.
-
set_domain
-
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.
-
set_dtd
-
Set the DTDs array for all possible content types for this webpage.
-
set_dtd
-
Set the DTD specifier string for this head section.
-
set_encoding
-
Sets the content-type header characterset encoding, and (optionally)
-
set_encrypted_passwords
-
Whether passwords are encrypted or not. If true then we just apply the standard MD5 algorithm to the content.
-
set_encrypted_passwords
-
Set the password encryption flag. If passed in true, then we will be assuming that new passwords should be encrypted, and password checks will try encryption first, then fall back to basic.
-
set_fieldblurb
-
Associates a string of text 'blurb' with the field. This will be presented just sitting below the field as explanatory text.
-
set_fieldcss
-
Sets the CSS style/class for a field.
-
set_fielddisplayproc
-
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.
-
set_fieldlabel
-
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.
-
set_fieldpostproc
-
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.
-
set_fieldsequence
-
Associates a named sequence with a field. This is so we can create new records using that sequence to populate the record field.
-
set_fieldsize
-
Sets the size of the field in pixels, width x height
-
set_fieldtexttype
-
Sets the type of a text field. This is a generic type and the
-
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%'.
-
set_first
-
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.
-
set_font
-
Set the menu item font
-
set_font
-
Sets the font Deprecated. Sets the font to use with the link text. Better to use a stylesheet these days.
-
set_fontnames
-
Set a new list of selectable font families. This array should be an
-
set_fontsizes
-
Set a new list of selectable font sizes. The sizes array should be
-
set_format
-
Set field format (WML)
-
set_formenctype
-
Specify the maintainers form encoding type. This will enable us to use file upload fields within the maintainer.
-
set_formfieldwidget
-
Use given user interface element for maintaining specified table field.
-
set_formname
-
Set the name of the form this will be displayed in.
-
set_formname
-
Set the name of the form we should use. Sometimes this is useful when other entities are using the same form.
-
set_forum_greeting
-
-
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'.
-
set_hiddenbuttons
-
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'.
-
set_hiddenfields
-
Specify that the given fields should be hidden, not editable. Value will be submitted on POST (save) via hidden field in form.
-
set_href
-
Sets the URL Sets the URL to go to when the link is clicked. usually this is specified on instantiation.
-
set_image
-
Sets the image to display for this button.
-
set_image
-
Define normal image This is the image which is displayed when the mouse is 'out'.
-
set_image
-
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.
-
set_image
-
Set the image src and details for this image object.
-
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.
-
set_image_over
-
Define over image This is the image which is displayed when the mouse is 'over'.
-
set_itemfont
-
Set the font of all menu items
-
set_keep
-
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.
-
set_labelfields
-
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.
-
set_language
-
Set the language of the content of this meta data element
-
set_lifetime
-
Set session lifetime Set the session cookie lifetime in seconds.
-
set_limit
-
Specify query limit field. This sets the maximum number of results that Lucene should return.
-
set_linkover_text
-
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.
-
set_linkover_text
-
Defines the text to show when the mouse moves over the object.
-
set_linkover_text
-
Set linkover text Defines the text to show when the mouse moves over the image.
-
set_linkover_text
-
Set linkover text Defines the text to show when the mouse moves over the image.
-
set_maxresults
-
Set maximum results Sets the maximum results to return from the search.
-
set_maxsize
-
Set the maximum filesize allowed
-
set_menu_images
-
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()).
-
set_menu_images
-
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()).
-
set_metadata_mode
-
Set metadata mode
-
set_metatag
-
Add meta tag to the section
-
set_metatag
-
Add a meta tag to the webpage head section.
-
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.
-
set_microsites_mode
-
Set microsites mode
-
set_moderator
-
-
set_multilang
-
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.
-
set_nonblankfields
-
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.
-
set_omittedfields
-
Specify that the given field should be omitted from the form
-
set_onblur
-
Set the onblur script
-
set_onchange
-
Set the onchange script
-
set_onclick
-
Set the on click script
-
set_onclick
-
Sets parameter string associated with the button.
-
set_ondblclick
-
Set the on doubleclick script
-
set_onfocus
-
Set the onfocus script
-
set_onkeydown
-
Set the on keydown script
-
set_onkeypress
-
Set the on keypress script
-
set_onkeyup
-
Set the on keyup script
-
set_onload
-
Set the onload script
-
set_onload
-
Define the script to execute after page has loaded
-
set_onload
-
Define the script to execute after page has loaded
-
set_onmousedown
-
Set the on mousedown script
-
set_onmousemove
-
Set the on mousemove script
-
set_onmouseout
-
Set the on mouseout script
-
set_onmouseover
-
Set the on mouseover script
-
set_onmouseup
-
Set the on mouseup script
-
set_onselect
-
Set the onselect script
-
set_onsubmit
-
Set onsubmit script Defines the onsubmit script to call when the user submits the form.
-
set_ontimer
-
Activate a timer Sets up the parameters for a timer.
-
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.
-
set_page_expirysecs
-
Set page expiry in seconds. This affects all of the pages returned by Axyl.
-
set_parms
-
Define other miscellaneous content to be put into the body tag.
-
set_password
-
Set the user login password. Store it according to the encryption mode. We assume a plain text password is being supplied.
-
set_paste_intercept
-
Set the HTMLArea Paste mode. If set to true, then the HTMLArea
-
set_persistent_hosts
-
Define persistent hosts list.
-
set_position
-
Set the position and the positioning directive for the clock.
-
set_preview_metrics
-
Set the width and height of the preview image. The default setting is 125 x 125 pixels.
-
set_query
-
Set the query for this message. There can be only one query defined.
-
set_range
-
Specify a range on a field for querying. We specify the name of a field
-
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.
-
set_returnfields
-
Specify the fields you want returned from Lucene.
-
set_rows
-
Set the number of rows for this memo field.
-
set_scheme
-
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.
-
set_searchdir
-
Set search directory Set the root directory to go to and search from.
-
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'.
-
set_searchquery
-
Define the search query object
-
set_separator
-
Set the separator string.
-
set_sequencevalue
-
This method must be defined in the child class.
-
set_sequencevalue
-
Set the sequence value, given a sequence name, the table and the field it applies to.
-
set_sequencevalue
-
Set a sequence value.
-
set_sessiontype
-
Set session database backing type The database backing 'type' can be either SESS_DATABASE_BACKED, or SESS_STANDALONE.
-
set_size
-
Set select field size in lines.
-
set_skipresults
-
Set skip results
-
set_sortorder
-
Specify the fields you want query results to be ordered by.
-
set_sql
-
Set the SQL statement In this case we re-execute the SQL automatically.
-
set_sql
-
Set the SQL statement
-
set_src
-
Set image details Allow setting of src and metrics from outside.
-
set_statusbar
-
Set the HTMLArea statusbar display mode, true or false.
-
set_stopwords
-
Supply a stopword list to lucene.
-
set_style
-
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.
-
set_style
-
Define the style NB: The way this is currently done, you are expected to supply your style WITHOUT style tags here.
-
set_styles
-
Set the styles to provide for this Wysiwyg editor. Styles are displayed
-
set_stylesheet
-
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.
-
set_stylesheet
-
Set the filenames for the main stylesheet and (optionally) the stylesheet for Internet Explorer compatible browsers.
-
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.
-
set_success_value
-
Allows you to specify a string value which, if returned as output by the called script/program, will indicate success.
-
set_tabindex
-
Alias for settabindex(), deprecated, backward compat.
-
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.
-
set_template
-
Set the template file Base webpage content on a template. We echo this to the buffer.
-
set_template
-
Define the template for the webpage.
-
set_theme
-
Define the theme
-
set_timelimits
-
Set the time limits. Some commonsense has to be applied here. You
-
set_timeout
-
Set the socket timeout. Deals with the special case of setting the socket to non-blocking mode (zero timeout)..
-
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.
-
set_title
-
Define the webpage title
-
set_title
-
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.
-
set_title
-
Define the title
-
set_titlefont
-
Set the menu tite font
-
set_today
-
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.
-
set_toolbar
-
Set a new toolbar definition. Toolbars are arrays of arrays of lists
-
set_to_gmt
-
Special set timezone case - setting to GMT (0 hours offset).
-
set_type
-
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.
-
set_undo_steps
-
Set the HTMLArea undo steps maximum. The default number is 20. Use this method to change that.
-
set_update_interval_secs
-
Set the number of seconds to wait before updating the clock each time.
-
set_uri
-
Set the tag value to be a URI. Same as setting tag value but we also flick the uri flag as well.
-
set_value
-
Put a value in a field, in a set of the config.
-
set_variable
-
Define a variable This variable will be sent to the server when the user clicks the link.
-
set_viewonlyfields
-
Specify that the given field should be displayed on the form as text (view-only) but will not be submitted with the form.
-
set_visibility
-
Set the starting visibility for the clock. In case you want to reveal/hide it with some javascript.
-
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.
-
set_width
-
Set the field width (usually in characters).
-
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.
-
set_window_target
-
Specific function for use with the rugbyvu framework. This causes a button click to open another browser window as a popup.
-
set_wrapmode
-
Set the wrap mode for the textarea.
-
set_year_limits
-
Set the starting and finishing year for the calendar - the range of operation. This defaults to +/-10 years around the current year.
-
shade
-
Cause HR to be shaded
-
SHORT_DATETIME
-
Example: Mar 3 21:30
-
show_24hrs
-
-
show_date
-
-
show_date_first
-
-
show_dayname
-
-
show_inline
-
-
show_seconds
-
-
SINGLESELECT
-
Combo-field is single-select
-
sitemap
-
Render the whole menu layout hierarchy as a sitemap, which simply gives links to each menu page.
-
sitemenu
-
Constructor
-
sitemenu
-
Site Menu class - a database-enabled extension of the menu class.
-
SOCK_FOREVER
-
Wait on socket forever (well, 24hrs is that, more or less)
-
SOCK_NO_WAIT
-
Do not wait on socket receive, return immediately
-
SOCK_RETRIES
-
Times to retry timed-out socket sends/receives
-
span
-
Flag this cell as being spanned
-
split_cols
-
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.
-
split_rows
-
Split rows at a given cell column.
-
SQL
-
Given an Axyl SQL query object, build the SQL string from it in suitable format for the currently connected database server.
-
SQL
-
Given an Axyl SQL query object, build the SQL string from it in suitable format for the currently connected database server.
-
sqlquery
-
Constructor Create a new SQL Query object.
-
sqlquery
-
SQLquery class An SQL Statement Text Container.
-
SQL_FORMAT
-
Example: 12/31/1999 23:59:59
-
start
-
Start the timer. Starts the timer ticking. If it was already ticking then there is no change in status.
-
start_transaction
-
Start a DB transaction. Alias for begin_transaction()
-
STD_DMY
-
Example: 23/5/2001
-
STD_ONCLICK
-
This value is used with buttons. If specified in place of
-
STD_ONCLICK_NEWWIN
-
Same as above, execpt we are indicating that we want the action to be directed to a new window.
-
STD_WIDTH
-
Standard width for a textual form element
-
stick_thread
-
-
stop
-
Stop the timer This freezes the internal seconds value, and stops the timer from ticking.
-
store
-
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.
-
storeall
-
Store all files away at destination dir. We use the original names by default.
-
STORED
-
Used to indicate that a field should be stored by Lucene
-
story
-
Constructor
-
story
-
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.
-
story-defs.php
-
-
story_media
-
Create a new piece of story media. This comprises a catalogitem object, and a set of methods to access it.
-
story_media
-
A container class for media item associated with a story. Contains a single piece of media which is associated with this story.
-
strip_http_prefix
-
Strip off any xxxx:// protocol prefix from a URL. Usually in Axyl, this is "http://", hence the name of this function.
-
StylableObject
-
StylableObject This is a virtual class representing something which can have its look changed by applying styles and/or classnames to it.
-
StylableObject
-
Constructor Create a stylableobject. Sets basic field attributes.
-
style
-
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.
-
stylesheet
-
Constructor Open the given stylesheet file for input.
-
stylesheet
-
Open a file which contains a stylesheet and read in the style settings. This is a special case of inputfile.
-
subform
-
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.
-
subform
-
Create a subform object. Sets basic form attributes.
-
Subject
-
Set subject
-
submit_button
-
Submit button
-
submit_button
-
Constructor
-
swish-defs.php
-
-
swish_search
-
The swish search class
-
swish_search
-
Constructor
-
synchronize
-
Make this current application object the same structure as the
-
syncparms
-
Synchronise sitepage parameters with manually edited values. This
-
$tabindex
-
TAB index of the object
-
$table
-
Table (object) to apply constraint to
-
$table
-
Table requiring maintenance (object)
-
$tablename
-
Name of table constraint is applied to
-
$tablename
-
Name of table to apply trigger to
-
$tablename
-
Name of table index is built on
-
$tablename
-
Tablename. Required. An internal name for use in debugging etc.
-
$tables
-
-
$tables
-
List of tables in the query
-
$Tablestyle
-
Overall class for the menu table
-
$table_autojustify
-
True if we autojustify table
-
$table_autojustify
-
Table autojustify flag
-
$table_rowstripes
-
Table rowstriping mode flag
-
$table_rowstripes
-
True if we autojustify table
-
$table_style
-
Table style to apply to content
-
$table_style
-
Table style to apply for plain cells table
-
$table_width
-
Table width specification
-
$tag
-
Current/last tag opened
-
$tagname
-
Name of the XML tag
-
$tag_name
-
Scheme name to be used in meta tags
-
$tag_name
-
-
$tag_name
-
The full tag name of this element
-
$tag_value
-
-
$tag_value
-
The content of this metadata tag. This is the actual metadata
-
$tandemfield
-
The second field object in tandem with this one
-
$tandemwidth
-
Overall width in pixels
-
$target
-
Target frame for URL
-
$target
-
Target URL for a window to open when button clicked
-
$target
-
Traget frame for this object
-
$target
-
Target frame for the URL
-
$tempfname
-
Full pathname of destination (temporary) file
-
$template
-
Optional template
-
$template
-
The microsite template object applied to this page
-
$template
-
The name of the template which was applied, if any
-
$templatefile
-
The file the template content is to be found in
-
$templates
-
Templates in this microsite (array)
-
$template_content
-
Template content
-
$template_contents
-
Content of template file when read in
-
$template_fname
-
Full pathname of template file
-
$template_fp
-
File pointer
-
$template_name
-
Template name
-
$template_type
-
Template type 'html' or 'wml'
-
$text
-
The text of this search term
-
$text
-
Text to display for the anchor/link
-
$text
-
-
$theme
-
Theme to apply to the page. This should be a single-word ID, and
-
$threadlast_author
-
-
$thread_id
-
-
$thread_id
-
-
$thread_msgs
-
-
$ticking
-
True if the timer is ticking
-
$timeoutsecs
-
Timeout for send in seconds
-
$timeoutsecs
-
Timeout for indexing commands in seconds (can usually leave
-
$timer
-
Indexing execution timer
-
$timer
-
An execution timer
-
$timer
-
Microtimer for query execute timing
-
$timerval
-
Timer expiry interval (in 10ths of seconds)
-
$timeslots
-
Array of timeslots in a schedule.
-
$tinow
-
The current Unix timestamp
-
$title
-
Card title/banner
-
$title
-
Title/tooltip
-
$title
-
Title of the set of fields
-
$title
-
Title for heading of output
-
$title
-
Title of the object
-
$title
-
Title/banner for this menu
-
$title
-
Title of this maintenance page
-
$title
-
Title of the anchor
-
$title
-
Title of the webpage
-
$title_font
-
Font settings for the title/banner
-
$to
-
Address to send e-mail
-
$toolbar
-
The toolbar. This takes the form of an array of arrays of toolbar
-
$toolbar_basic
-
A basic toolbar definition. Use for entering text in given
-
$toolbar_full
-
A fully-populated toolbar definition for power users
-
$toolbar_medium
-
A medium toolbar definition, adds colour, links, raw HTML editing,
-
$topy
-
Y-offset from top
-
$top_item_spacing
-
Padding before (above) the top-level menu options
-
$total_logins
-
Total logins so far
-
$tot_block
-
Total cells containing a content block
-
$tot_cols
-
Total columns in layout
-
$tot_editable
-
Total editable plain content cells
-
$tot_empty
-
Total empty/undefined cells
-
$tot_plain
-
Total plain content cells
-
$tot_rows
-
Total rows in layout
-
$tot_viewable
-
Total viewable plain content cells
-
$tot_wysiwyg
-
Total wysiwyg content cells
-
$trace
-
Array of traced locations
-
$tracedepth
-
Depth of tracing
-
$triggers
-
-
$ts_end
-
-
$ts_start
-
-
$type
-
Type of field eg: text, hidden, checkbox etc.
-
$type
-
Type of constraint 'c' - check, 'p' - pk, 'f' - fk
-
$type
-
-
$type
-
Type/name of this message
-
$type
-
Type of form 'normal' or 'subform'
-
$type
-
Type of DO element: 'accept', 'prev', 'help', 'reset', 'options', or 'delete'
-
$type
-
Type of database eg: "postgres", "mssql_server"..
-
$type
-
-
$type
-
Type of query 'SELECT', 'DELETE', 'INSERT' or 'UPDATE'
-
$type
-
Form element type ID
-
$type
-
Parameter type
-
$type
-
The blocklet type: 'text', 'list', 'ordered', 'bullets', or 'table'
-
$tz
-
The timezone offset in +/- hours from GMT.
-
table
-
Table constructor Create a new table object.
-
table
-
Table.
-
tablecell
-
Constructor. Create this new table cell object.
-
tablecell
-
tablecell
-
tables
-
Define table list
-
tag
-
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.
-
tag
-
Constructor
-
taghtml
-
Render the full tag. This method renders the given tag including all the attributes, as HTML.
-
tag_close
-
Method invoked when a tag is closed
-
tag_close
-
Method invoked when a tag is closed
-
tag_open
-
Method invoked when a tag is opened
-
tag_open
-
Method invoked when a tag is opened
-
tbody
-
Define a new tbody table group.
-
td
-
Define a new standard cell for the current row.
-
td_alignment
-
Set the working cell alignment properties in one hit. Use this method AFTER you have defined the cell with the td() method.
-
td_colspan
-
Set the working cell colspan property. Use this method AFTER you have defined the cell with the td() method.
-
td_content
-
Append content to the working cell. Use this method AFTER you have defined the cell with the td() method.
-
td_contentcss
-
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.
-
td_css
-
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.
-
td_height
-
Set the working cell height property. Use this method AFTER you have defined the cell with the td() method.
-
td_metrics
-
Set the working cell width and height properties in one hit. Use this method AFTER you have defined the cell with the td() method.
-
td_rowspan
-
Set the working cell rowspan property. Use this method AFTER you have defined the cell with the td() method.
-
td_width
-
Set the working cell width property. Use this method AFTER you have defined the cell with the td() method.
-
template
-
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.
-
templated_webpage
-
The templated webpage page class
-
templated_webpage
-
Constructor Create a new templated webpage object.
-
term
-
Constructor Create a new search term.
-
term
-
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.
-
termcount
-
Return count of searchterms present in this search.
-
tfoot
-
Define a new tfoot table group.
-
th
-
Define a new heading cell for the current row.
-
thead
-
Define a new thead table group.
-
thread_msg
-
-
thread_msg
-
The thread message class.
-
th_alignment
-
Alias for td_alignment()
-
th_colspan
-
Alias for td_colspan()
-
th_content
-
Alias for td_content()
-
th_contentcss
-
Alias for td_contentcss()
-
th_css
-
Alias for td_css()
-
th_height
-
Alias for td_height()
-
th_metrics
-
Alias for td_metrics()
-
th_rowspan
-
Alias for td_rowspan()
-
th_width
-
Alias for td_width()
-
tidyup
-
Free resources.
-
timeNow
-
Time now as array
-
timeNowAsStr
-
Time now as string
-
timer-defs.php
-
-
timeslot
-
-
timeslot
-
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.
-
timeslot
-
-
timestamp_to_datetime
-
Conversion: timestamp to datetime.
-
timestamp_to_displaydate
-
Conversion: timestamp to descriptive Convert a Unix timestamp into a descriptive date/time format for the user display, using the given displayformat string.
-
To
-
Set to Set the e-mail To: e-mail addresses.
-
todaysDate_DMY
-
Today as DD/MM/YYYY Returns the given datetime as a date, and in EUROPEAN 'd/m/Y' format.
-
todaysDate_MDY
-
Today as MM/DD/YYYY Returns the given datetime as a date, and in SQL 'm/d/Y' format.
-
tr
-
Define a new row for the current group.
-
traceback
-
Traceback list Return a string of the form "label->label->label" forming the traceback level labels in order.
-
transaction_failed
-
Return DB transaction failure status.
-
transaction_open
-
Return DB transaction open status.
-
transaction_succeeded
-
Return DB transaction success status.
-
treemenu
-
A hierarchical menu renderer which does not use Javascript to implement the menuoption display.
-
treemenu
-
Constructor Create a new menumaintainer.
-
treemenu-defs.php
-
-
type
-
Set the file type. Possible types include 'text' (default), 'html', and 'templated'.