-
$Action
-
-
$Align
-
-
$attributes
-
-
$attributes
-
An array of key value pairs
-
$Attributes
-
-
Active
-
Mark it as active, with a fancy style to distinguish that
-
Add
-
-
AddAttribute
-
-
AddAttribute
-
-
AddBcc
-
Add another Bcc recipient to the email
-
AddCc
-
Add another Cc recipient to the email
-
AddColumn
-
Add a column to the Browser.
-
AddComponent
-
Adds a new subcomponent
-
AddComponent
-
-
AddErrorsTo
-
Add another Error recipient to the email
-
AddField
-
-
AddGrouping
-
-
AddHidden
-
Add a hidden column - one that is present in the SQL result, but for which there is no column displayed.
-
AddOption
-
Add an option, which is a link.
-
AddOrder
-
Add an ordering to the browser widget.
-
AddProperty
-
Adds a new property
-
AddReplyTo
-
Add another Reply-to address to the email
-
AddRow
-
Add an extra arbitrary row onto the end of the browser.
-
AddRule
-
Adds a validation rule for a specific field upon submission of the form.
-
AddSubmenu
-
This menu option is now promoted to the head of a tree
-
AddSubMenu
-
Add an option, which is a submenu
-
AddSubTag
-
Add a sub-element
-
AddTable
-
This will join an additional table to the maintained set
-
AddTo
-
Add another recipient to the email
-
AddTotal
-
Mark a column as something to be totalled. You can also specify the name of a function which may modify the value before the actual totalling.
-
AllowedTo
-
Can the user do this?
-
AllowedTo
-
Checks whether a user is allowed to do something.
-
AndWhere
-
-
AndWhere
-
Add an OR ... to the SQL Where clause
-
ApplyFilter
-
-
Assign
-
-
AssignSessionDetails
-
Internal function used to assign the session details to a user's new session.
-
Authenticate
-
Authenticate. Do whatever we need to authenticate a username / password.
-
AuthPlugin
-
A class for authenticating and retrieving user information
-
AuthPlugin
-
Create a new AuthPlugin object. This is as lightweight as possible.
-
AuthPlugin.php
-
-
AuthPlugins.php
-
-
auth_external
-
Authentication has already happened. We know the username, we just need to do the authorisation / access control. The password is ignored.
-
auth_other_awl
-
Authenticate against a different PostgreSQL database which contains a usr table in the AWL format.
-
Available
-
-
AwlDatabase
-
Typically there will only be a single instance of the database level class in an application.
-
AwlDatabase.php
-
-
AwlDBDialect
-
The AwlDBDialect class handles support for different SQL dialects
-
AwlDBDialect.php
-
-
AwlQuery
-
The AwlQuery Class.
-
AwlQuery.php
-
-
AwlUpgrader
-
The AwlUpgrader Class.
-
AwlUpgrader.php
-
-
AWLUtilities.php
-
-
awl_replace_sql_args
-
Replaces PostgreSQL query with escaped parameters in preparation for execution.
-
awl_set_locale
-
Set the translation to the user's locale. At this stage all we do is call the gettext function.
-
$BaseTable
-
-
$BeginRow
-
-
$BeginRowArgs
-
-
$bound_parameters
-
The current array of bound parameters
-
$bound_querystring
-
The actual query string, after we've replaced parameters in it
-
Begin
-
Wrap the parent DB class Begin() so we can $qry->Begin() sometime before we $qry->Exec()
-
Begin
-
Begin a transaction.
-
Bind
-
Bind some parameters. This can be called in three ways:
-
BreakLine
-
A utility function for a heading line within a data entry table
-
Browser
-
The Browser class constructor
-
Browser
-
Start a new Browser, add columns, set a join and Render it to create a basic list of records in a table.
-
BrowserColumn
-
BrowserColumns are the basic building blocks. You can specify just the field name, and the column header or you can get fancy and specify an alignment, format string, SQL formula and cell CSS class.
-
BrowserColumn
-
BrowserColumn constructor. Only the first parameter is mandatory.
-
BuildConfirmationHash
-
Build a hash which we can use for confirmation that we didn't get e-mailed a bogus link by someone, and that we actually got here by traversing the website.
-
BuildFromText
-
Build the vEvent object from a text string which is a single VEVENT
-
BuildFromText
-
Build the iCalendar object from a text string which is a single iCalendar resource
-
BuildOptionList
-
Build an option list from the query.
-
BuildXMLTree
-
Rebuild an XML tree in our own style from the parsed XML tags using a tail-recursive approach.
-
$Class
-
-
$CloseRow
-
-
$Columns
-
-
$connection
-
Our database connection, normally copied from a global one
-
$content
-
-
$current
-
The current value
-
$current_row
-
-
CheckConfirmationHash
-
Check a hash which we created through BuildConfirmationHash
-
check_temporary_passwords
-
Checks what a user entered against any currently valid temporary passwords on their account.
-
classBrowser.php
-
-
classEditor.php
-
-
clean_by_regex
-
Clean a value by applying a regex to it. If it is an array apply it to each element in the array recursively. If it is an object we don't mess with it.
-
clean_string
-
Clean a string of many suspicious characters
-
ClearComponents
-
-
ClearComponents
-
Clear all components, or the components matching a particular type
-
ClearProperties
-
Clear all properties, or the properties matching a particular type
-
CloneConfidential
-
Clone this component (and subcomponents) into a confidential version of it. A confidential event will be scrubbed of any identifying characteristics other than time/date, repeat, uid and a summary which is just a translated 'Busy'.
-
CollectParameterValues
-
Collect an array of all parameters of our properties which are the specified type
-
Commit
-
Wrap the parent DB class Commit() so we can $qry->Commit() sometime after we $qry->Exec()
-
Commit
-
Complete a transaction.
-
connect_configured_database
-
Connect to the database defined in the $c->dbconn[] array
-
CountElements
-
Count the number of elements
-
$db
-
Holds the PDO database connection
-
$dbconn
The database connection.
-
-
$dialect
-
Holds the name of the database dialect
-
$Distinct
-
-
$DivClose
-
-
$DivOpen
-
-
DataEntry.php
-
-
DataEntryField
-
A utility function for a data entry line within a table
-
DataEntryLine
-
A utility function for a data entry line within a table
-
DataUpdate.php
-
-
Dbg
-
DEPRECATED Utility function to log debug stuff with printf expansion, and the ability to enable it selectively.
-
dbg_error_log
-
Writes a debug message into the error log using printf syntax. If the first parameter is "ERROR" then the message will _always_ be logged.
-
dbg_log_array
-
Function to dump an array to the error log, possibly recursively
-
DBRecord
-
Really numbingly simple construction.
-
DBRecord
-
A Base class to use for records which will be read/written from the database.
-
DealWithTimeZones
-
Do what must be done with time zones from on file. Attempt to turn them into something that PostgreSQL can understand...
-
DealWithTimeZones
-
Do what must be done with time zones from on file. Attempt to turn them into something that PostgreSQL can understand...
-
DefaultPropertyList
-
An array of property names that we should always want when rendering an iCalendar
-
define_byte_mappings
-
-
deprecated
-
*********************************************************************************** Everything below here is deprecated and should be avoided in favour of using, improving and enhancing the more sensible structures above.
-
DoQuery
-
This method is used to build and execute the database query.
-
duration
-
A duration (in decimal seconds) between two times which are the result of calls to microtime()
-
$EditMode
-
The mode we are in for any form
-
$email
-
The user's email address from their usr record.
-
$errorstring
-
The PostgreSQL error message, if the query fails.
-
$error_info
-
The Database error information, if the query fails.
-
$execution_time
-
Stores the query execution time - used to deal with long queries.
-
$execution_time
-
Stores the query execution time - used to deal with long queries.
-
$ExtraRows
-
-
Editor
-
The class for the Editor form in full
-
EditorField
-
A class for the fields in the editor
-
EMail
-
Create the e-mail, optionally assigning the subject and primary recipient.
-
EMail
-
Lightweight class for sending an e-mail.
-
EMail.php
-
-
EmailTemporaryPassword
-
E-mails a temporary password in response to a request from a user.
-
EndForm
-
Return the HTML fragment to end the form.
-
EntryField
-
Individual fields used for data entry / viewing.
-
EntryField
-
Initialise an EntryField, used for data entry.
-
EntryForm
-
Initialise a new data-entry form.
-
EntryForm
-
A class to handle displaying a form on the page (for editing) or a structured layout of non-editable content (for viewing), with a simple switch to flip from view mode to edit mode.
-
ErrorInfo
-
-
Exec
-
Execute the query, logging any debugging.
-
Exec
-
Execute the query, logging any debugging.
-
Execute
-
Tell the database to execute the query
-
ExtractProperty
-
-
ExtractSubComponent
-
-
E_USER_ERROR
-
-
$Grouping
-
-
Get
-
Get the value of a property
-
Get
-
Get the value of a property in the first non-VTIMEZONE
-
Get
-
Returns a single field from the record
-
GetAttribute
-
Accessor for a single attribute
-
GetAttributes
-
Accessor for the attributes
-
GetComponents
-
Get all sub-components, or at least get those matching a type, or failling to match, should the second parameter be set to false.
-
GetComponents
-
-
GetContent
-
Accessor for the content
-
GetElements
-
Return an array of elements matching the specified tag, or all elements if no tag is supplied.
-
GetFields
-
Returns the SQL for the current database dialect which will return a two-column resultset containing a list of fields and their associated data types.
-
GetNSTag
-
Accessor for the full-namespaced tag name
-
GetParameterValue
-
Get the value of a parameter
-
GetPath
-
Return an array of elements matching the specified path
-
GetPParamValue
-
Get the value of the specified parameter for the first property matching the name. Obviously this isn't so useful for properties which may occur multiply, but most don't.
-
GetProperties
-
Get all properties, or the properties matching a particular type
-
GetPropertiesByPath
-
Return an array of properties matching the specified path
-
GetPValue
-
Get the value of the first property matching the name. Obviously this isn't so useful for properties which may occur multiply, but most don't.
-
GetRecord
-
-
GetRoles
-
Internal function used to get the user's roles from the database.
-
GetRoles
-
Get the group memberships for the user
-
GetTag
-
Accessor for the tag name
-
GetTarget
-
GetTarget
-
GetTarget
-
-
GetTotal
-
Retrieve the total from a totalled column
-
GetType
-
Return the type of component which this is
-
GetVersion
-
Sets the current search path for the database.
-
get_fields
-
Get the names of the fields for a particular table
-
$Id
-
-
i18n
-
Mark a string as being internationalized. This is a semaphore method; it does nothing but it allows us to easily identify strings that require translation. Generally this is used to mark strings that will be stored in the database (like descriptions of permissions).
-
iCalComponent
-
A basic constructor
-
iCalComponent
-
A Class for representing components within an iCalendar
-
iCalendar
-
A Class for handling Events on a calendar (DEPRECATED)
-
iCalendar
-
-
iCalendar.php
-
-
iCalFooter
-
-
iCalHeader
-
-
iCalProp
-
A Class for representing properties within an iCalendar
-
iCalProp
-
The constructor parses the incoming string, which is formatted as per RFC2445 as a propname[;param1=pval1[; ... ]]:propvalue however we allow ourselves to assume that the RFC2445 content unescaping has already happened when iCalComponent::ParseFrom() called iCalComponent::UnwrapComponent().
-
Id
-
-
Initialise
-
Set some particular values to the ones from the array.
-
Initialise
-
This will read the record from the database if it's available, and the $keys parameter is a non-empty array.
-
init_gettext
-
Initialise our use of Gettext
-
IsActive
-
Whether this option is currently active.
-
IsAttendee
-
Return true if the person identified by the email address is down as an attendee or organizer for this meeting.
-
IsCreate
-
-
IsOrganizer
-
Return true if the person identified by the email address is down as an organizer for this meeting.
-
IsSubmit
-
-
IsUpdate
-
-
Parameters
-
Get/Set parameters in their entirety
-
Parameters
-
Return the parameters we are planning to substitute into the query string
-
param_to_global
-
Convert a parameter to a global. We first look in _POST and then in _GET, and if they passed in a bunch of valid characters, we will make sure the incoming is cleaned to only match that set.
-
ParseFrom
-
The constructor parses the incoming string, which is formatted as per RFC2445 as a propname[;param1=pval1[; ... ]]:propvalue however we allow ourselves to assume that the RFC2445 content unescaping has already happened when iCalComponent::ParseFrom() called iCalComponent::UnwrapComponent().
-
ParseFrom
-
Parse the text $content into sets of iCalProp & iCalComponent within this iCalComponent
-
ParseSomeLines
-
Function to parse lines from BEGIN:SOMETHING to END:SOMETHING into a nested array structure
-
PgQuery
-
The PgQuery Class.
-
PgQuery.php
-
-
Plain
-
Convert a string which has already been quoted and escaped for PostgreSQL into a magic array so that it will be inserted unmodified into the SQL string. Use with care!
-
PopulateForm
-
Initialise some more of the forms fields, possibly with a prefix
-
positive_dollars
-
Check that the given string is a positive dollar amount.
-
positive_integer
-
Check that the given string is a positive integer.
-
PostToValues
-
This will assign $_POST values to the internal Values object for each field that exists in the Fields array.
-
PostToValues
-
This will assign $_POST values to the internal Values object for each field that exists in the Fields array.
-
Prepare
-
Tell the database to prepare the query that we will execute
-
prepare
-
Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.
-
PrepareTranslated
-
Operates identically to AwlDatabase::Prepare, except that $this->Translate() will be called on the query before any processing.
-
Put
-
Put the value of a property
-
$Query
-
-
$Query
-
-
$querystring
-
The original query string
-
$query_time_warning
-
How long the query should take before a warning is issued.
-
$query_time_warning
-
How long the query should take before a warning is issued.
-
QDo
-
Simple QDo() class which will re-use this query for whatever was passed in, and execute it returning the result of the Exec() call. We can't call it Do() since that's a reserved word...
-
qpg
-
Quote the given string (depending on its type) so that it can be used safely in a PostgreSQL query without fear of SQL injection errors.
-
query
-
Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.
-
QueryString
-
Return the query string we are planning to execute
-
quote
-
Quote the given string so it can be safely used within string delimiters in a query.
-
quote
-
Quote the given string so it can be safely used within string delimiters in a query. To be avoided, in general.
-
Quote
-
Returns $value escaped in an appropriate way for this database dialect.
-
quoted_printable_encode
-
Process a string to fit the requirements of RFC2045 section 6.7. Note that this works, but replaces more characters than the minimum set. For readability the spaces aren't encoded as =20 though.
-
$Record
-
-
$RecordAvailable
-
-
$rendered
-
The rendered HTML fragment (once it has been).
-
$rendered
-
Once it actually is...
-
$result
-
Result of the last execution
-
$rownum
-
number of current row - use accessor to get/set
-
$rows
-
number of rows from pg_numrows - use accessor to get value
-
$rows
-
number of rows from pg_numrows - for fetching result
-
Read
-
To read the record from the database.
-
Render
-
Render an EntryField into HTML
-
Render
-
Render the menu tree to an HTML fragment.
-
Render
-
Renders the component, possibly restricted to only the listed properties
-
Render
-
-
Render
-
Convert the menu option into an HTML string
-
Render
-
Render a suitably escaped RFC2445 content string.
-
Render
-
Render the form / viewer as HTML to show the user
-
Render
-
Render the templated component. The heavy lifting is done by the callback...
-
Render
-
Render the vEvent object as a text string which is a single VEVENT
-
Render
-
This method is used to render the browser as HTML. If the query has not yet been executed then this will call DoQuery to do so.
-
Render
-
Render the document tree into (nicely formatted) XML
-
RenderAsCSS
-
Render the menu tree to an HTML fragment.
-
RenderAttributes
-
-
RenderContent
-
Render just the internal content
-
RenderFields
-
Render the core details to show to the user
-
RenderHeader
-
RenderHeader
-
RenderJavascript
-
Returns the javascript for form validation using the rules.
-
RenderLoginPanel
-
Renders some HTML for a basic login panel
-
RenderParameters
-
Render the set of parameters as key1=value1[;key2=value2[; ...]] with any colons or semicolons escaped.
-
RenderRoles
-
Render the user's administrative roles
-
RenderValue
-
-
ReplaceEditorPart
-
Replace parts into the form template.
-
ReplaceNamedParameters
-
Replaces named query parameters of the form :name with appropriately escaped substitutions.
-
ReplaceParameters
-
Replaces query parameters with appropriately escaped substitutions.
-
replace_uri_params
-
Given a URL (presumably the current one) and a parameter, replace the value of parameter, extending the URL as necessary if the parameter is not already there.
-
RevertLineFormat
-
Revert the line format to what was in place before the last TempLineFormat call.
-
RFC2445ContentEscape
-
Returns a suitably escaped RFC2445 content string.
-
RFC2445ContentEscape
-
-
RFC2445ContentUnescape
-
Returns a content string with the RFC2445 escaping removed
-
Rollback
-
Cancel a transaction in progress.
-
Rollback
-
Wrap the parent DB class Rollback() so we can $qry->Rollback() sometime after we $qry->Exec()
-
RowFormat
-
Set the format for an output row.
-
rows
-
Return the count of rows retrieved/affected
-
rows
-
Provide a rows() method for forward compatibility with AwlQuery.
-
$self
-
A reference to this menu option itself
-
$session
The session object is global.
-
-
$session_id
-
A unique id for this user's logged-in session.
-
$Sql
-
-
$Sql
-
-
$sth
-
The PDO statement handle, or null if we don't have one yet.
-
$SubmitName
-
-
$SubTitle
-
-
SaveTimeZones
-
-
selected
-
Checks that a string is not empty or zero
-
Send
-
Actually send the email
-
SendTemporaryPassword
-
Sends a temporary password in response to a request from a user.
-
Session
-
Create a new Session object.
-
Session
-
A class for creating and holding session information.
-
Session.php
-
-
session_salted_md5
-
Make a salted MD5 string, given a string and (possibly) a salt.
-
session_salted_sha1
-
Make a salted SHA1 string, given a string and (possibly) a salt. PHP5 only (although it could be made to work on PHP4 (@see http://www.openldap.org/faq/data/cache/347.html). The algorithm used here is compatible with OpenLDAP so passwords generated through this function should be able to be migrated to OpenLDAP by using the part following the second '*', i.e.
-
session_simple_md5
-
Make a plain MD5 hash of a string, identifying the type of hash it is
-
session_validate_password
-
Checks what a user entered against the actual password on their account.
-
Set
-
-
Set
-
Sets a single field in the record
-
Set
-
Set the value of a property
-
Set
-
Set arbitrary attributes of the menu option
-
SetAttribute
-
Set an element attribute to a value
-
SetBaseTable
-
-
SetBody
-
Set the body of the e-mail.
-
SetComponents
-
-
SetComponents
-
Sets some or all sub-components of the component to the supplied new components
-
SetConnection
-
Use a different database connection for this query
-
SetConnection
-
Use a different database connection for this query
-
SetContent
-
Set the whole content to a value
-
SetDistinct
-
Set the SQL DISTINCT clause to a specific value.
-
SetDiv
-
Set a div for wrapping the browse.
-
SetFrom
-
Set the visible From address for the e-mail.
-
SetJoins
-
-
SetJoins
-
Set the tables and joins for the SQL.
-
SetLimit
-
Set the SQL LIMIT clause to a specific value.
-
SetLookup
-
-
SetLookup
-
-
SetOffset
-
Set the SQL OFFSET clause to a specific value.
-
SetOptionList
-
-
SetOptionList
-
-
SetOrdering
-
Set up the ordering for the browser. Generally you should call this with the first parameter set as a field to order by default. Call with the second parameter set to 'D' or 'DESCEND' if you want to reverse the default order.
-
SetParameterValue
-
Set the value of a parameter
-
SetProperties
-
Set all properties, or the ones matching a particular type
-
SetRecord
-
-
SetSearchPath
-
Sets the current search path for the database.
-
SetSender
-
Set the envelope sender address for the e-mail.
-
SetSql
-
-
SetSql
-
-
SetSql
-
Simple SetSql() class which will reset the object with the querystring from the first argument.
-
SetSubject
-
Set the subject line for the email
-
SetSubmitName
-
-
SetSubTitle
-
Set a Sub Title for the browse.
-
SetTemplate
-
-
SetTitle
-
Set the Title for the browse.
-
SetTranslatable
-
Set the named columns to be translatable
-
SetTranslatable
-
-
SetType
-
Set the type of component which this is
-
SetUnion
-
Set a Union SQL statement.
-
SetWhere
-
Set the SQL Where clause to a specific value.
-
SetWhere
-
-
SimpleForm
-
Set the line format to an extremely simple CSS based prompt / field layout.
-
Size
-
Find out how many options the menu has.
-
SqlDateFormat
-
Returns a PostgreSQL Date Format string suitable for returning iCal dates
-
SqlDateFormat
-
-
SqlDurationFormat
-
Returns a PostgreSQL Date Format string suitable for returning iCal durations
-
SqlDurationFormat
-
-
SqlUTCFormat
-
Returns a PostgreSQL Date Format string suitable for returning dates which
-
SqlUTCFormat
-
-
sql_from_object
-
Build SQL INSERT/UPDATE statement from an associative array of fieldnames => values.
-
sql_from_post
-
Build SQL INSERT/UPDATE statement from the $_POST associative array
-
StartForm
-
Start the actual HTML form. Return the fragment to do this.
-
SubmitButton
-
A utility function for a submit button within a data entry table
-
$tagname
-
-
$Template
-
-
$Title
-
-
$Title
-
-
$TotalFuncs
-
-
$Totals
-
-
$Translatable
-
-
$translate_all
-
Holds whether we are translating all statements.
-
$txnstate
-
Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit
-
$Type
-
-
TempLineFormat
-
Set the line format to a temporary one that we can revert from.
-
TestFilter
-
-
TextMatch
-
Test if our value contains a string
-
Title
-
Accessor for the Title for the browse, which could set the title also.
-
Title
-
Accessor for the Title for the browse, which could set the title also.
-
TransactionState
-
Returns the current state of a transaction, indicating if we have begun a transaction, whether the transaction has failed, or if we are not in a transaction.
-
translate
-
Convert a string in English to whatever this user's locale is
-
TranslateAll
-
Switches on or off the processing flag controlling whether subsequent calls to AwlDatabase::Prepare are translated as if PrepareTranslated() had been called.
-
TranslateSQL
-
Translates the given SQL string into a form that will hopefully work for this database dialect. This hook is intended to be used by developers to provide support for differences in database operation by translating the query string in an arbitrary way, such as through a file or database lookup.
-
Translation.php
-
-
$_parent
-
-
_AppendDelimited
-
Append something with a comma delimter onto the existing referenced string
-
_awl_connect_configured_database
-
Connect to the database defined in the $c->db_connect[] (or $c->pg_connect) arrays
-
_BuildFieldList
-
Builds a field target list
-
_BuildJoinClause
-
Builds a table join clause
-
_BuildWhereClause
-
Builds a where clause to match the supplied keys
-
_CheckLogin
-
-
_CheckLogout
-
-
_CompareMenuSequence
-
_CompareMenuSequence is used in sorting the menu options into the sequence order
-
_CompareSequence
-
_CompareSequence is used in sorting the menu options into the sequence order
-
_HasActive
-
Does the menu have any options that are active.
-
_log_error
-
Log error, optionally with file and line location of the caller.
-
_log_query
-
Log query, optionally with file and line location of the caller.
-
_OptionExists
-
See if a menu already has this option
-
_ParseAttributes
-
Internal function for parsing the type extra on a field.
-
__construct
-
-
__construct
-
Constructor - nothing fancy as yet.
-
__construct
-
Constructor
-
__construct
-
-
__construct
-
Constructor
-
__construct
-
Parses the connection string to ascertain the database dialect. Returns true if the dialect is supported and fails if the dialect is not supported. All code to support any given database should be within in an external include.
-
__construct
-
Constructor
-
__tostring
-