Full index

Package indexes


a b c d e f g h i j l m n o p q r s t u v w x _
a
top
Variable $Action
Editor::$Action in classEditor.php
Variable $Align
BrowserColumn::$Align in classBrowser.php
Variable $attributes
XMLElement::$attributes in XMLElement.php
Variable $attributes
EntryField::$attributes in DataEntry.php
An array of key value pairs
Variable $Attributes
EditorField::$Attributes in classEditor.php
Method Active
MenuOption::Active() in MenuSet.php
Mark it as active, with a fancy style to distinguish that
Method Add
iCalendar::Add() in iCalendar.php
Method AddAttribute
Editor::AddAttribute() in classEditor.php
Method AddAttribute
EditorField::AddAttribute() in classEditor.php
Method AddBcc
EMail::AddBcc() in EMail.php
Add another Bcc recipient to the email
Method AddCc
EMail::AddCc() in EMail.php
Add another Cc recipient to the email
Method AddColumn
Browser::AddColumn() in classBrowser.php
Add a column to the Browser.
Method AddComponent
Adds a new subcomponent
Method AddComponent
iCalendar::AddComponent() in iCalendar.php
Method AddErrorsTo
Add another Error recipient to the email
Method AddField
Editor::AddField() in classEditor.php
Method AddGrouping
Browser::AddGrouping() in classBrowser.php
Method AddHidden
Browser::AddHidden() in classBrowser.php
Add a hidden column - one that is present in the SQL result, but for which there is no column displayed.
Method AddOption
MenuSet::AddOption() in MenuSet.php
Add an option, which is a link.
Method AddOrder
Browser::AddOrder() in classBrowser.php
Add an ordering to the browser widget.
Method AddProperty
Adds a new property
Method AddReplyTo
EMail::AddReplyTo() in EMail.php
Add another Reply-to address to the email
Method AddRow
Browser::AddRow() in classBrowser.php
Add an extra arbitrary row onto the end of the browser.
Method AddRule
Validation::AddRule() in Validation.php
Adds a validation rule for a specific field upon submission of the form.
Method AddSubmenu
This menu option is now promoted to the head of a tree
Method AddSubMenu
MenuSet::AddSubMenu() in MenuSet.php
Add an option, which is a submenu
Method AddSubTag
XMLElement::AddSubTag() in XMLElement.php
Add a sub-element
Method AddTable
DBRecord::AddTable() in DataUpdate.php
This will join an additional table to the maintained set
Method AddTo
EMail::AddTo() in EMail.php
Add another recipient to the email
Method AddTotal
Browser::AddTotal() in classBrowser.php
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.
Method AllowedTo
User::AllowedTo() in User.php
Can the user do this?
Method AllowedTo
Session::AllowedTo() in Session.php
Checks whether a user is allowed to do something.
Method AndWhere
Editor::AndWhere() in classEditor.php
Method AndWhere
Browser::AndWhere() in classBrowser.php
Add an OR ... to the SQL Where clause
Method ApplyFilter
iCalendar::ApplyFilter() in iCalendar.php
Method Assign
Editor::Assign() in classEditor.php
Method AssignSessionDetails
Internal function used to assign the session details to a user's new session.
Method Authenticate
AuthPlugin::Authenticate() in AuthPlugin.php
Authenticate. Do whatever we need to authenticate a username / password.
Class AuthPlugin
AuthPlugin in AuthPlugin.php
A class for authenticating and retrieving user information
Method AuthPlugin
AuthPlugin::AuthPlugin() in AuthPlugin.php
Create a new AuthPlugin object. This is as lightweight as possible.
Page AuthPlugin.php
AuthPlugin.php in AuthPlugin.php
Page AuthPlugins.php
AuthPlugins.php in AuthPlugins.php
Function auth_external
auth_external() in AuthPlugins.php
Authentication has already happened. We know the username, we just need to do the authorisation / access control. The password is ignored.
Function auth_other_awl
auth_other_awl() in AuthPlugins.php
Authenticate against a different PostgreSQL database which contains a usr table in the AWL format.
Method Available
Editor::Available() in classEditor.php
Class AwlDatabase
AwlDatabase in AwlDatabase.php
Typically there will only be a single instance of the database level class in an application.
Page AwlDatabase.php
AwlDatabase.php in AwlDatabase.php
Class AwlDBDialect
AwlDBDialect in AwlDBDialect.php
The AwlDBDialect class handles support for different SQL dialects
Page AwlDBDialect.php
AwlDBDialect.php in AwlDBDialect.php
Class AwlQuery
AwlQuery in AwlQuery.php
The AwlQuery Class.
Page AwlQuery.php
AwlQuery.php in AwlQuery.php
Class AwlUpgrader
AwlUpgrader in AwlUpgrader.php
The AwlUpgrader Class.
Page AwlUpgrader.php
AwlUpgrader.php in AwlUpgrader.php
Page AWLUtilities.php
AWLUtilities.php in AWLUtilities.php
Function awl_replace_sql_args
awl_replace_sql_args() in PgQuery.php
Replaces PostgreSQL query with escaped parameters in preparation for execution.
Function awl_set_locale
awl_set_locale() in Translation.php
Set the translation to the user's locale. At this stage all we do is call the gettext function.
b
top
Variable $BaseTable
Editor::$BaseTable in classEditor.php
Variable $BeginRow
Browser::$BeginRow in classBrowser.php
Variable $BeginRowArgs
Browser::$BeginRowArgs in classBrowser.php
Variable $bound_parameters
The current array of bound parameters
Variable $bound_querystring
The actual query string, after we've replaced parameters in it
Method Begin
AwlQuery::Begin() in AwlQuery.php
Wrap the parent DB class Begin() so we can $qry->Begin() sometime before we $qry->Exec()
Method Begin
AwlDatabase::Begin() in AwlDatabase.php
Begin a transaction.
Method Bind
AwlQuery::Bind() in AwlQuery.php
Bind some parameters. This can be called in three ways:
Method BreakLine
EntryForm::BreakLine() in DataEntry.php
A utility function for a heading line within a data entry table
Method Browser
Browser::Browser() in classBrowser.php
The Browser class constructor
Class Browser
Browser in classBrowser.php
Start a new Browser, add columns, set a join and Render it to create a basic list of records in a table.
Class BrowserColumn
BrowserColumn in classBrowser.php
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.
Method BrowserColumn
BrowserColumn::BrowserColumn() in classBrowser.php
BrowserColumn constructor. Only the first parameter is mandatory.
Method 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.
Method BuildFromText
Build the vEvent object from a text string which is a single VEVENT
Method BuildFromText
Build the iCalendar object from a text string which is a single iCalendar resource
Method BuildOptionList
Build an option list from the query.
Function BuildXMLTree
BuildXMLTree() in XMLElement.php
Rebuild an XML tree in our own style from the parsed XML tags using a tail-recursive approach.
c
top
Variable $Class
BrowserColumn::$Class in classBrowser.php
Variable $CloseRow
Browser::$CloseRow in classBrowser.php
Variable $Columns
Browser::$Columns in classBrowser.php
Variable $connection
AwlQuery::$connection in AwlQuery.php
Our database connection, normally copied from a global one
Variable $content
XMLElement::$content in XMLElement.php
Variable $current
EntryField::$current in DataEntry.php
The current value
Variable $current_row
BrowserColumn::$current_row in classBrowser.php
Method CheckConfirmationHash
Check a hash which we created through BuildConfirmationHash
Function check_temporary_passwords
Checks what a user entered against any currently valid temporary passwords on their account.
Page classBrowser.php
classBrowser.php in classBrowser.php
Page classEditor.php
classEditor.php in classEditor.php
Function clean_by_regex
clean_by_regex() in AWLUtilities.php
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.
Function clean_string
clean_string() in PgQuery.php
Clean a string of many suspicious characters
Method ClearComponents
Method ClearComponents
Clear all components, or the components matching a particular type
Method ClearProperties
Clear all properties, or the properties matching a particular type
Method 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'.
Method CollectParameterValues
Collect an array of all parameters of our properties which are the specified type
Method Commit
AwlQuery::Commit() in AwlQuery.php
Wrap the parent DB class Commit() so we can $qry->Commit() sometime after we $qry->Exec()
Method Commit
AwlDatabase::Commit() in AwlDatabase.php
Complete a transaction.
Function connect_configured_database
Connect to the database defined in the $c->dbconn[] array
Method CountElements
XMLElement::CountElements() in XMLElement.php
Count the number of elements
d
top
Variable $db
AwlDBDialect::$db in AwlDBDialect.php
Holds the PDO database connection
Global $dbconn The database connection.
Variable $dialect
AwlDBDialect::$dialect in AwlDBDialect.php
Holds the name of the database dialect
Variable $Distinct
Browser::$Distinct in classBrowser.php
Variable $DivClose
Browser::$DivClose in classBrowser.php
Variable $DivOpen
Browser::$DivOpen in classBrowser.php
Page DataEntry.php
DataEntry.php in DataEntry.php
Method DataEntryField
A utility function for a data entry line within a table
Method DataEntryLine
A utility function for a data entry line within a table
Page DataUpdate.php
DataUpdate.php in DataUpdate.php
Method Dbg
Session::Dbg() in Session.php
DEPRECATED Utility function to log debug stuff with printf expansion, and the ability to enable it selectively.
Function dbg_error_log
dbg_error_log() in AWLUtilities.php
Writes a debug message into the error log using printf syntax. If the first parameter is "ERROR" then the message will _always_ be logged.
Function dbg_log_array
dbg_log_array() in AWLUtilities.php
Function to dump an array to the error log, possibly recursively
Method DBRecord
DBRecord::DBRecord() in DataUpdate.php
Really numbingly simple construction.
Class DBRecord
DBRecord in DataUpdate.php
A Base class to use for records which will be read/written from the database.
Method DealWithTimeZones
Do what must be done with time zones from on file. Attempt to turn them into something that PostgreSQL can understand...
Method DealWithTimeZones
Do what must be done with time zones from on file. Attempt to turn them into something that PostgreSQL can understand...
Method DefaultPropertyList
An array of property names that we should always want when rendering an iCalendar
Function define_byte_mappings
define_byte_mappings() in AWLUtilities.php
Function deprecated
deprecated() in iCalendar.php
*********************************************************************************** Everything below here is deprecated and should be avoided in favour of using, improving and enhancing the more sensible structures above.
Method DoQuery
Browser::DoQuery() in classBrowser.php
This method is used to build and execute the database query.
Function duration
duration() in PgQuery.php
A duration (in decimal seconds) between two times which are the result of calls to microtime()
e
top
Variable $EditMode
DBRecord::$EditMode in DataUpdate.php
The mode we are in for any form
Variable $email
Session::$email in Session.php
The user's email address from their usr record.
Variable $errorstring
PgQuery::$errorstring in PgQuery.php
The PostgreSQL error message, if the query fails.
Variable $error_info
AwlQuery::$error_info in AwlQuery.php
The Database error information, if the query fails.
Variable $execution_time
Stores the query execution time - used to deal with long queries.
Variable $execution_time
Stores the query execution time - used to deal with long queries.
Variable $ExtraRows
Browser::$ExtraRows in classBrowser.php
Class Editor
Editor in classEditor.php
The class for the Editor form in full
Class EditorField
EditorField in classEditor.php
A class for the fields in the editor
Method EMail
EMail::EMail() in EMail.php
Create the e-mail, optionally assigning the subject and primary recipient.
Class EMail
EMail in EMail.php
Lightweight class for sending an e-mail.
Page EMail.php
EMail.php in EMail.php
Method EmailTemporaryPassword
E-mails a temporary password in response to a request from a user.
Method EndForm
EntryForm::EndForm() in DataEntry.php
Return the HTML fragment to end the form.
Class EntryField
EntryField in DataEntry.php
Individual fields used for data entry / viewing.
Method EntryField
EntryField::EntryField() in DataEntry.php
Initialise an EntryField, used for data entry.
Method EntryForm
EntryForm::EntryForm() in DataEntry.php
Initialise a new data-entry form.
Class EntryForm
EntryForm in DataEntry.php
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.
Method ErrorInfo
AwlDatabase::ErrorInfo() in AwlDatabase.php
Method Exec
AwlQuery::Exec() in AwlQuery.php
Execute the query, logging any debugging.
Method Exec
PgQuery::Exec() in PgQuery.php
Execute the query, logging any debugging.
Method Execute
AwlQuery::Execute() in AwlQuery.php
Tell the database to execute the query
Method ExtractProperty
Method ExtractSubComponent
Constant E_USER_ERROR
E_USER_ERROR in AwlDBDialect.php
f
top
Variable $Field
EditorField::$Field in classEditor.php
Variable $Field
BrowserColumn::$Field in classBrowser.php
Variable $FieldNames
Browser::$FieldNames in classBrowser.php
Variable $Fields
Editor::$Fields in classEditor.php
Variable $ForcedOrder
Browser::$ForcedOrder in classBrowser.php
Variable $Format
BrowserColumn::$Format in classBrowser.php
Variable $fullname
Session::$fullname in Session.php
The user's full name from their usr record.
Method Fetch
PgQuery::Fetch() in PgQuery.php
Fetch the next row from the query results
Method Fetch
AwlQuery::Fetch() in AwlQuery.php
Fetch the next row from the query results
Method FetchBackwards
Fetch backwards from the result resource
Method FirstNonTimezone
Get all sub-components, or at least get those matching a type
Method ForceOrder
Browser::ForceOrder() in classBrowser.php
Force a particular ordering onto the browser widget.
Function force_utf8
force_utf8() in AWLUtilities.php
Method FormattedDate
Function to reformat an ISO date to something nicer and possibly more localised
g
top
Variable $Grouping
Browser::$Grouping in classBrowser.php
Method Get
vEvent::Get() in vEvent.php
Get the value of a property
Method Get
iCalendar::Get() in iCalendar.php
Get the value of a property in the first non-VTIMEZONE
Method Get
DBRecord::Get() in DataUpdate.php
Returns a single field from the record
Method GetAttribute
XMLElement::GetAttribute() in XMLElement.php
Accessor for a single attribute
Method GetAttributes
XMLElement::GetAttributes() in XMLElement.php
Accessor for the attributes
Method 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.
Method GetComponents
Method GetContent
XMLElement::GetContent() in XMLElement.php
Accessor for the content
Method GetElements
XMLElement::GetElements() in XMLElement.php
Return an array of elements matching the specified tag, or all elements if no tag is supplied.
Method GetFields
AwlDBDialect::GetFields() in AwlDBDialect.php
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.
Method GetNSTag
XMLElement::GetNSTag() in XMLElement.php
Accessor for the full-namespaced tag name
Method GetParameterValue
Get the value of a parameter
Method GetPath
XMLElement::GetPath() in XMLElement.php
Return an array of elements matching the specified path
Method 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.
Method GetProperties
Get all properties, or the properties matching a particular type
Method GetPropertiesByPath
Return an array of properties matching the specified path
Method 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.
Method GetRecord
Editor::GetRecord() in classEditor.php
Method GetRoles
Session::GetRoles() in Session.php
Internal function used to get the user's roles from the database.
Method GetRoles
User::GetRoles() in User.php
Get the group memberships for the user
Method GetTag
XMLElement::GetTag() in XMLElement.php
Accessor for the tag name
Method GetTarget
BrowserColumn::GetTarget() in classBrowser.php
GetTarget
Method GetTarget
EditorField::GetTarget() in classEditor.php
Method GetTotal
Browser::GetTotal() in classBrowser.php
Retrieve the total from a totalled column
Method GetType
iCalComponent::GetType() in iCalendar.php
Return the type of component which this is
Method GetVersion
AwlDBDialect::GetVersion() in AwlDBDialect.php
Sets the current search path for the database.
Function get_fields
get_fields() in AWLUtilities.php
Get the names of the fields for a particular table
h
top
Variable $Header
BrowserColumn::$Header in classBrowser.php
Variable $HiddenColumns
Browser::$HiddenColumns in classBrowser.php
Variable $Hook
BrowserColumn::$Hook in classBrowser.php
Method HelpInCell
EntryForm::HelpInCell() in DataEntry.php
Set the line format to have help displayed in it's own separate cell
Method HelpInLine
EntryForm::HelpInLine() in DataEntry.php
Set the line format to have help displayed in the same cell as the entry field.
Method HiddenField
EntryForm::HiddenField() in DataEntry.php
A utility function for a hidden field within a data entry table
Method HttpDateFormat
i
top
Variable $Id
Editor::$Id in classEditor.php
Function i18n
i18n() in Translation.php
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).
Method iCalComponent
A basic constructor
Class iCalComponent
iCalComponent in iCalendar.php
A Class for representing components within an iCalendar
Class iCalendar
iCalendar in iCalendar.php
A Class for handling Events on a calendar (DEPRECATED)
Method iCalendar
iCalendar::iCalendar() in iCalendar.php
Page iCalendar.php
iCalendar.php in iCalendar.php
Method iCalFooter
iCalendar::iCalFooter() in iCalendar.php
Method iCalHeader
iCalendar::iCalHeader() in iCalendar.php
Class iCalProp
iCalProp in iCalendar.php
A Class for representing properties within an iCalendar
Method iCalProp
iCalProp::iCalProp() in iCalendar.php
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().
Method Id
Editor::Id() in classEditor.php
Method Initialise
Editor::Initialise() in classEditor.php
Set some particular values to the ones from the array.
Method Initialise
DBRecord::Initialise() in DataUpdate.php
This will read the record from the database if it's available, and the $keys parameter is a non-empty array.
Function init_gettext
init_gettext() in Translation.php
Initialise our use of Gettext
Method IsActive
MenuOption::IsActive() in MenuSet.php
Whether this option is currently active.
Method IsAttendee
Return true if the person identified by the email address is down as an attendee or organizer for this meeting.
Method IsCreate
Editor::IsCreate() in classEditor.php
Method IsOrganizer
Return true if the person identified by the email address is down as an organizer for this meeting.
Method IsSubmit
Editor::IsSubmit() in classEditor.php
Method IsUpdate
Editor::IsUpdate() in classEditor.php
j
top
Variable $Joins
Browser::$Joins in classBrowser.php
Variable $Joins
Editor::$Joins in classEditor.php
Variable $just_logged_in
Whether the user logged in to view the current page. Perhaps some details on the login form might pollute an editable form and result in an unplanned submit. This can be used to program around such a problem.
Method JustThisBitPlease
A function to extract the contents of a BEGIN:SOMETHING to END:SOMETHING (perhaps multiply) and return just that bit (or, of course, those bits :-)
l
top
Variable $last_session_end
The date and time that the user requested their last page during their last session.
Variable $last_session_start
The date and time that the user logged on during their last session.
Variable $Limit
Editor::$Limit in classEditor.php
Variable $Limit
Browser::$Limit in classBrowser.php
Variable $location
AwlQuery::$location in AwlQuery.php
Where we called this query from so we can find it in our code! Debugging may also be selectively enabled for a $location.
Variable $logged_in
Session::$logged_in in Session.php
Whether this user has actually logged in.
Variable $LookupSql
EditorField::$LookupSql in classEditor.php
Method Layout
Editor::Layout() in classEditor.php
Method LinkActiveSubMenus
Mark each MenuOption as active that has an active sub-menu entry.
Method Log
Session::Log() in Session.php
DEPRECATED Utility function to log stuff with printf expansion.
Method Login
Session::Login() in Session.php
Attempt to perform a login action.
Method LoginRequired
Checks that this user is logged in, and presents a login screen if they aren't.
Method LSIDLogin
Session::LSIDLogin() in Session.php
Attempts to logs in using a long-term session ID
m
top
Variable $match_column
Browser::$match_column in classBrowser.php
Variable $match_function
Browser::$match_function in classBrowser.php
Variable $match_value
Browser::$match_value in classBrowser.php
Method MakeSomethingActive
Mark each MenuOption as active that has an active sub-menu entry.
Method MaskComponents
Mask components, removing any that are not of the types in the list
Method MaskComponents
Method MaskProperties
Mask properties, removing any that are not in the list
Method MatchedRow
Browser::MatchedRow() in classBrowser.php
Replace a row where $column = $value with an extra arbitrary row, returned from calling $function
Method MaybeActive
Whether this option is currently active.
Method MenuOption
The thing we click
Class MenuOption
MenuOption in MenuSet.php
Each menu option is an object.
Method MenuSet
MenuSet::MenuSet() in MenuSet.php
Start a new MenuSet with no options.
Class MenuSet
MenuSet in MenuSet.php
A MenuSet is a hierarchy of MenuOptions, some of which might be MenuSet objects themselves.
Page MenuSet.php
MenuSet.php in MenuSet.php
Method MoreWhere
Editor::MoreWhere() in classEditor.php
Method MoreWhere
Browser::MoreWhere() in classBrowser.php
Add an [operator] ... to the SQL Where clause
Method MultiEntryLine
A utility function for a data entry line, where the prompt is a drop-down.
n
top
Variable $NewWhere
Editor::$NewWhere in classEditor.php
Method Name
iCalProp::Name() in iCalendar.php
Get/Set name property
Method NewElement
XMLElement::NewElement() in XMLElement.php
Add a new sub-element
Method new_lookup
EntryField::new_lookup() in DataEntry.php
Function called indirectly when a new EntryField of type 'lookup' is created.
Method NoHelp
EntryForm::NoHelp() in DataEntry.php
Set the line format to have no help display
Method not_empty
Validation::not_empty() in Validation.php
Checks if a string is empty
o
top
Variable $Offset
Browser::$Offset in classBrowser.php
Variable $OptionList
EditorField::$OptionList in classEditor.php
Variable $Order
Editor::$Order in classEditor.php
Variable $Order
Browser::$Order in classBrowser.php
Variable $OrderBrowserKey
Browser::$OrderBrowserKey in classBrowser.php
Variable $OrderDirection
Browser::$OrderDirection in classBrowser.php
Variable $OrderedFields
Editor::$OrderedFields in classEditor.php
Variable $OrderField
Browser::$OrderField in classBrowser.php
Function olson_from_tzstring
olson_from_tzstring() in AWLUtilities.php
Try and extract something like "Pacific/Auckland" or "America/Indiana/Indianapolis" if possible.
Method OrWhere
Editor::OrWhere() in classEditor.php
Method OrWhere
Browser::OrWhere() in classBrowser.php
Add an OR ... to the SQL Where clause
p
top
Method Parameters
iCalProp::Parameters() in iCalendar.php
Get/Set parameters in their entirety
Method Parameters
AwlQuery::Parameters() in AwlQuery.php
Return the parameters we are planning to substitute into the query string
Function param_to_global
param_to_global() in AWLUtilities.php
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.
Method ParseFrom
iCalProp::ParseFrom() in iCalendar.php
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().
Method ParseFrom
Parse the text $content into sets of iCalProp & iCalComponent within this iCalComponent
Method ParseSomeLines
Function to parse lines from BEGIN:SOMETHING to END:SOMETHING into a nested array structure
Class PgQuery
PgQuery in PgQuery.php
The PgQuery Class.
Page PgQuery.php
PgQuery.php in PgQuery.php
Method Plain
PgQuery::Plain() in PgQuery.php
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!
Method PopulateForm
EntryForm::PopulateForm() in DataEntry.php
Initialise some more of the forms fields, possibly with a prefix
Method positive_dollars
Check that the given string is a positive dollar amount.
Method positive_integer
Check that the given string is a positive integer.
Method PostToValues
DBRecord::PostToValues() in DataUpdate.php
This will assign $_POST values to the internal Values object for each field that exists in the Fields array.
Method PostToValues
Editor::PostToValues() in classEditor.php
This will assign $_POST values to the internal Values object for each field that exists in the Fields array.
Method Prepare
AwlQuery::Prepare() in AwlQuery.php
Tell the database to prepare the query that we will execute
Method prepare
AwlDatabase::prepare() in AwlDatabase.php
Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.
Method PrepareTranslated
Operates identically to AwlDatabase::Prepare, except that $this->Translate() will be called on the query before any processing.
Method Put
vEvent::Put() in vEvent.php
Put the value of a property
q
top
Variable $Query
Editor::$Query in classEditor.php
Variable $Query
Browser::$Query in classBrowser.php
Variable $querystring
AwlQuery::$querystring in AwlQuery.php
The original query string
Variable $query_time_warning
How long the query should take before a warning is issued.
Variable $query_time_warning
How long the query should take before a warning is issued.
Method QDo
AwlQuery::QDo() in AwlQuery.php
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...
Function qpg
qpg() in PgQuery.php
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.
Method query
AwlDatabase::query() in AwlDatabase.php
Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.
Method QueryString
AwlQuery::QueryString() in AwlQuery.php
Return the query string we are planning to execute
Method quote
PgQuery::quote() in PgQuery.php
Quote the given string so it can be safely used within string delimiters in a query.
Method quote
AwlQuery::quote() in AwlQuery.php
Quote the given string so it can be safely used within string delimiters in a query. To be avoided, in general.
Method Quote
AwlDBDialect::Quote() in AwlDBDialect.php
Returns $value escaped in an appropriate way for this database dialect.
Function quoted_printable_encode
quoted_printable_encode() in AWLUtilities.php
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.
r
top
Variable $Record
Editor::$Record in classEditor.php
Variable $RecordAvailable
Editor::$RecordAvailable in classEditor.php
Variable $rendered
MenuOption::$rendered in MenuSet.php
The rendered HTML fragment (once it has been).
Variable $rendered
EntryField::$rendered in DataEntry.php
Once it actually is...
Variable $result
AwlQuery::$result in AwlQuery.php
Result of the last execution
Variable $rownum
AwlQuery::$rownum in AwlQuery.php
number of current row - use accessor to get/set
Variable $rows
AwlQuery::$rows in AwlQuery.php
number of rows from pg_numrows - use accessor to get value
Variable $rows
PgQuery::$rows in PgQuery.php
number of rows from pg_numrows - for fetching result
Method Read
DBRecord::Read() in DataUpdate.php
To read the record from the database.
Method Render
EntryField::Render() in DataEntry.php
Render an EntryField into HTML
Method Render
MenuSet::Render() in MenuSet.php
Render the menu tree to an HTML fragment.
Method Render
iCalComponent::Render() in iCalendar.php
Renders the component, possibly restricted to only the listed properties
Method Render
iCalendar::Render() in iCalendar.php
Method Render
MenuOption::Render() in MenuSet.php
Convert the menu option into an HTML string
Method Render
iCalProp::Render() in iCalendar.php
Render a suitably escaped RFC2445 content string.
Method Render
User::Render() in User.php
Render the form / viewer as HTML to show the user
Method Render
Editor::Render() in classEditor.php
Render the templated component. The heavy lifting is done by the callback...
Method Render
vEvent::Render() in vEvent.php
Render the vEvent object as a text string which is a single VEVENT
Method Render
Browser::Render() in classBrowser.php
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.
Method Render
XMLElement::Render() in XMLElement.php
Render the document tree into (nicely formatted) XML
Method RenderAsCSS
MenuSet::RenderAsCSS() in MenuSet.php
Render the menu tree to an HTML fragment.
Method RenderAttributes
Method RenderContent
XMLElement::RenderContent() in XMLElement.php
Render just the internal content
Method RenderFields
Render the core details to show to the user
Method RenderHeader
BrowserColumn::RenderHeader() in classBrowser.php
RenderHeader
Method RenderJavascript
Returns the javascript for form validation using the rules.
Method RenderLoginPanel
Renders some HTML for a basic login panel
Method RenderParameters
Render the set of parameters as key1=value1[;key2=value2[; ...]] with any colons or semicolons escaped.
Method RenderRoles
Render the user's administrative roles
Method RenderValue
BrowserColumn::RenderValue() in classBrowser.php
Method ReplaceEditorPart
Editor::ReplaceEditorPart() in classEditor.php
Replace parts into the form template.
Method ReplaceNamedParameters
Replaces named query parameters of the form :name with appropriately escaped substitutions.
Method ReplaceParameters
Replaces query parameters with appropriately escaped substitutions.
Function replace_uri_params
replace_uri_params() in AWLUtilities.php
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.
Method RevertLineFormat
Revert the line format to what was in place before the last TempLineFormat call.
Method RFC2445ContentEscape
Returns a suitably escaped RFC2445 content string.
Method RFC2445ContentEscape
Method RFC2445ContentUnescape
Returns a content string with the RFC2445 escaping removed
Method Rollback
AwlDatabase::Rollback() in AwlDatabase.php
Cancel a transaction in progress.
Method Rollback
AwlQuery::Rollback() in AwlQuery.php
Wrap the parent DB class Rollback() so we can $qry->Rollback() sometime after we $qry->Exec()
Method RowFormat
Browser::RowFormat() in classBrowser.php
Set the format for an output row.
Method rows
AwlQuery::rows() in AwlQuery.php
Return the count of rows retrieved/affected
Method rows
PgQuery::rows() in PgQuery.php
Provide a rows() method for forward compatibility with AwlQuery.
s
top
Variable $self
MenuOption::$self in MenuSet.php
A reference to this menu option itself
Global $session The session object is global.
Variable $session_id
Session::$session_id in Session.php
A unique id for this user's logged-in session.
Variable $Sql
BrowserColumn::$Sql in classBrowser.php
Variable $Sql
EditorField::$Sql in classEditor.php
Variable $sth
AwlQuery::$sth in AwlQuery.php
The PDO statement handle, or null if we don't have one yet.
Variable $SubmitName
Editor::$SubmitName in classEditor.php
Variable $SubTitle
Browser::$SubTitle in classBrowser.php
Method SaveTimeZones
Method selected
Validation::selected() in Validation.php
Checks that a string is not empty or zero
Method Send
EMail::Send() in EMail.php
Actually send the email
Method SendTemporaryPassword
Sends a temporary password in response to a request from a user.
Method Session
Session::Session() in Session.php
Create a new Session object.
Class Session
Session in Session.php
A class for creating and holding session information.
Page Session.php
Session.php in Session.php
Function session_salted_md5
session_salted_md5() in AWLUtilities.php
Make a salted MD5 string, given a string and (possibly) a salt.
Function session_salted_sha1
session_salted_sha1() in AWLUtilities.php
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.
Function session_simple_md5
session_simple_md5() in AWLUtilities.php
Make a plain MD5 hash of a string, identifying the type of hash it is
Function session_validate_password
session_validate_password() in AWLUtilities.php
Checks what a user entered against the actual password on their account.
Method Set
EditorField::Set() in classEditor.php
Method Set
DBRecord::Set() in DataUpdate.php
Sets a single field in the record
Method Set
iCalendar::Set() in iCalendar.php
Set the value of a property
Method Set
MenuOption::Set() in MenuSet.php
Set arbitrary attributes of the menu option
Method SetAttribute
XMLElement::SetAttribute() in XMLElement.php
Set an element attribute to a value
Method SetBaseTable
Editor::SetBaseTable() in classEditor.php
Method SetBody
EMail::SetBody() in EMail.php
Set the body of the e-mail.
Method SetComponents
Method SetComponents
Sets some or all sub-components of the component to the supplied new components
Method SetConnection
Use a different database connection for this query
Method SetConnection
Use a different database connection for this query
Method SetContent
XMLElement::SetContent() in XMLElement.php
Set the whole content to a value
Method SetDistinct
Browser::SetDistinct() in classBrowser.php
Set the SQL DISTINCT clause to a specific value.
Method SetDiv
Browser::SetDiv() in classBrowser.php
Set a div for wrapping the browse.
Method SetFrom
EMail::SetFrom() in EMail.php
Set the visible From address for the e-mail.
Method SetJoins
Editor::SetJoins() in classEditor.php
Method SetJoins
Browser::SetJoins() in classBrowser.php
Set the tables and joins for the SQL.
Method SetLimit
Browser::SetLimit() in classBrowser.php
Set the SQL LIMIT clause to a specific value.
Method SetLookup
EditorField::SetLookup() in classEditor.php
Method SetLookup
Editor::SetLookup() in classEditor.php
Method SetOffset
Browser::SetOffset() in classBrowser.php
Set the SQL OFFSET clause to a specific value.
Method SetOptionList
EditorField::SetOptionList() in classEditor.php
Method SetOptionList
Editor::SetOptionList() in classEditor.php
Method SetOrdering
Browser::SetOrdering() in classBrowser.php
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.
Method SetParameterValue
Set the value of a parameter
Method SetProperties
Set all properties, or the ones matching a particular type
Method SetRecord
Editor::SetRecord() in classEditor.php
Method SetSearchPath
AwlDBDialect::SetSearchPath() in AwlDBDialect.php
Sets the current search path for the database.
Method SetSender
EMail::SetSender() in EMail.php
Set the envelope sender address for the e-mail.
Method SetSql
EditorField::SetSql() in classEditor.php
Method SetSql
Editor::SetSql() in classEditor.php
Method SetSql
AwlQuery::SetSql() in AwlQuery.php
Simple SetSql() class which will reset the object with the querystring from the first argument.
Method SetSubject
EMail::SetSubject() in EMail.php
Set the subject line for the email
Method SetSubmitName
Editor::SetSubmitName() in classEditor.php
Method SetSubTitle
Browser::SetSubTitle() in classBrowser.php
Set a Sub Title for the browse.
Method SetTemplate
Editor::SetTemplate() in classEditor.php
Method SetTitle
Browser::SetTitle() in classBrowser.php
Set the Title for the browse.
Method SetTranslatable
Browser::SetTranslatable() in classBrowser.php
Set the named columns to be translatable
Method SetTranslatable
Method SetType
iCalComponent::SetType() in iCalendar.php
Set the type of component which this is
Method SetUnion
Browser::SetUnion() in classBrowser.php
Set a Union SQL statement.
Method SetWhere
Browser::SetWhere() in classBrowser.php
Set the SQL Where clause to a specific value.
Method SetWhere
Editor::SetWhere() in classEditor.php
Method SimpleForm
EntryForm::SimpleForm() in DataEntry.php
Set the line format to an extremely simple CSS based prompt / field layout.
Method Size
MenuSet::Size() in MenuSet.php
Find out how many options the menu has.
Method SqlDateFormat
Returns a PostgreSQL Date Format string suitable for returning iCal dates
Method SqlDateFormat
Method SqlDurationFormat
Returns a PostgreSQL Date Format string suitable for returning iCal durations
Method SqlDurationFormat
Method SqlUTCFormat
Returns a PostgreSQL Date Format string suitable for returning dates which
Method SqlUTCFormat
iCalendar::SqlUTCFormat() in iCalendar.php
Function sql_from_object
sql_from_object() in DataUpdate.php
Build SQL INSERT/UPDATE statement from an associative array of fieldnames => values.
Function sql_from_post
sql_from_post() in DataUpdate.php
Build SQL INSERT/UPDATE statement from the $_POST associative array
Method StartForm
EntryForm::StartForm() in DataEntry.php
Start the actual HTML form. Return the fragment to do this.
Method SubmitButton
EntryForm::SubmitButton() in DataEntry.php
A utility function for a submit button within a data entry table
t
top
Variable $tagname
XMLElement::$tagname in XMLElement.php
Variable $Template
Editor::$Template in classEditor.php
Variable $Title
Browser::$Title in classBrowser.php
Variable $Title
Editor::$Title in classEditor.php
Variable $TotalFuncs
Browser::$TotalFuncs in classBrowser.php
Variable $Totals
Browser::$Totals in classBrowser.php
Variable $Translatable
BrowserColumn::$Translatable in classBrowser.php
Variable $translate_all
AwlDatabase::$translate_all in AwlDatabase.php
Holds whether we are translating all statements.
Variable $txnstate
AwlDatabase::$txnstate in AwlDatabase.php
Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit
Variable $Type
BrowserColumn::$Type in classBrowser.php
Method TempLineFormat
Set the line format to a temporary one that we can revert from.
Method TestFilter
iCalendar::TestFilter() in iCalendar.php
Method TextMatch
iCalProp::TextMatch() in iCalendar.php
Test if our value contains a string
Method Title
Editor::Title() in classEditor.php
Accessor for the Title for the browse, which could set the title also.
Method Title
Browser::Title() in classBrowser.php
Accessor for the Title for the browse, which could set the title also.
Method 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.
Function translate
translate() in Translation.php
Convert a string in English to whatever this user's locale is
Method TranslateAll
AwlDatabase::TranslateAll() in AwlDatabase.php
Switches on or off the processing flag controlling whether subsequent calls to AwlDatabase::Prepare are translated as if PrepareTranslated() had been called.
Method TranslateSQL
AwlDBDialect::TranslateSQL() in AwlDBDialect.php
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.
Page Translation.php
Translation.php in Translation.php
u
top
Variable $Union
Browser::$Union in classBrowser.php
Variable $username
Session::$username in Session.php
The user's username used to log in.
Variable $user_no
Session::$user_no in Session.php
The user_no of the logged in user.
Method Undefine
DBRecord::Undefine() in DataUpdate.php
Unsets a single field from the record
Method UnFetch
PgQuery::UnFetch() in PgQuery.php
Set row counter back one
Method UnwrapComponent
This unescapes the (CRLF + linear space) wrapping specified in RFC2445. According to RFC2445 we should always end with CRLF but the CalDAV spec says that normalising XML parsers often muck with it and may remove the CR. We accept either case.
Method User
User::User() in User.php
The constructor initialises a new record, potentially reading it from the database.
Class User
User in User.php
A class to handle reading, writing, viewing, editing and validating usr records.
Page User.php
User.php in User.php
Function uuid
uuid() in AWLUtilities.php
Generates a Universally Unique IDentifier, version 4.
v
top
Variable $Value
EditorField::$Value in classEditor.php
Method Validate
Validation::Validate() in Validation.php
Validates the form according to it's rules.
Method Validate
User::Validate() in User.php
Validate the information the user submitted
Method Validation
Validation::Validation() in Validation.php
Initialise a new validation.
Class Validation
Validation in Validation.php
Rules used for validation of form fields.
Page Validation.php
Validation.php in Validation.php
Method valid_date_format
Check that the given string matches the user's date format.
Method valid_email_format
Check that the given string is a valid email address.
Method Value
iCalProp::Value() in iCalendar.php
Get/Set the content of the property
Method Value
Editor::Value() in classEditor.php
Method ValueReplacement
Browser::ValueReplacement() in classBrowser.php
Return values from the current row for replacing into a template.
Method VCalendar
Apply standard properties for a VCalendar
Class vEvent
vEvent in vEvent.php
A Class for handling Events on a calendar
Method vEvent
vEvent::vEvent() in vEvent.php
The constructor takes an array of args. If there is an element called 'vevent' then that will be parsed into the vEvent object. Otherwise the array elements are converted into properties of the vEvent object directly.
Page vEvent.php
vEvent.php in vEvent.php
w
top
Variable $Where
Editor::$Where in classEditor.php
Variable $Where
Browser::$Where in classBrowser.php
Method WhereNewRecord
Editor::WhereNewRecord() in classEditor.php
Method WrapComponent
This imposes the (CRLF + linear space) wrapping specified in RFC2445. According to RFC2445 we should always end with CRLF but the CalDAV spec says that normalising XML parsers often muck with it and may remove the CR. We output RFC2445 compliance.
Method Write
User::Write() in User.php
Write the User record.
Method Write
Editor::Write() in classEditor.php
Write the record
Method Write
DBRecord::Write() in DataUpdate.php
To write the record to the database
Method WriteRoles
User::WriteRoles() in User.php
Write the roles associated with the user
x
top
Variable $xmlns
XMLElement::$xmlns in XMLElement.php
Class XMLDocument
XMLDocument in XMLDocument.php
A class for XML Documents which will contain namespaced XML elements
Page XMLDocument.php
XMLDocument.php in XMLDocument.php
Class XMLElement
XMLElement in XMLElement.php
A class for XML elements which may have attributes, or contain other XML sub-elements
Page XMLElement.php
XMLElement.php in XMLElement.php
_
top
Variable $_parent
XMLElement::$_parent in XMLElement.php
Method _AppendDelimited
Append something with a comma delimter onto the existing referenced string
Function _awl_connect_configured_database
Connect to the database defined in the $c->db_connect[] (or $c->pg_connect) arrays
Method _BuildFieldList
DBRecord::_BuildFieldList() in DataUpdate.php
Builds a field target list
Method _BuildJoinClause
Builds a table join clause
Method _BuildWhereClause
Builds a where clause to match the supplied keys
Method _CheckLogin
Session::_CheckLogin() in Session.php
Method _CheckLogout
Function _CompareMenuSequence
_CompareMenuSequence() in MenuSet.php
_CompareMenuSequence is used in sorting the menu options into the sequence order
Method _CompareSequence
_CompareSequence is used in sorting the menu options into the sequence order
Method _HasActive
MenuSet::_HasActive() in MenuSet.php
Does the menu have any options that are active.
Method _log_error
PgQuery::_log_error() in PgQuery.php
Log error, optionally with file and line location of the caller.
Method _log_query
AwlQuery::_log_query() in AwlQuery.php
Log query, optionally with file and line location of the caller.
Method _OptionExists
See if a menu already has this option
Method _ParseAttributes
Internal function for parsing the type extra on a field.
Method __construct
EditorField::__construct() in classEditor.php
Method __construct
XMLElement::__construct() in XMLElement.php
Constructor - nothing fancy as yet.
Method __construct
AwlUpgrader::__construct() in AwlUpgrader.php
Constructor
Method __construct
Editor::__construct() in classEditor.php
Method __construct
PgQuery::__construct() in PgQuery.php
Constructor
Method __construct
AwlDBDialect::__construct() in AwlDBDialect.php
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.
Method __construct
AwlQuery::__construct() in AwlQuery.php
Constructor
Method __tostring
XMLElement::__tostring() in XMLElement.php
a b c d e f g h i j l m n o p q r s t u v w x _