Element index for package com.lokorin.dfcrafters.lib

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ q ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ] [ y ] [ _ ]

_

__construct: in file lib_forms.php, method TextField::__construct()
Constructor for TextField.
__construct: in file lib_forms.php, method TextArea::__construct()
Constructor for TextArea.
__construct: in file lib_forms.php, method TimeField::__construct()
Constructor for TimeField.
__construct: in file lib_menu.php, method MenuItem::__construct()
Creator for MenuItem.
__construct: in file lib_news.php, method News::__construct()
Constructor for News.
__construct: in file lib_news.php, method Comment::__construct()
Constructor for Comment.
__construct: in file lib_forms.php, method SubmitButton::__construct()
Constructor for SubmitButton.
__construct: in file lib_forms.php, method SizedField::__construct()
Constructor for SizedField.
__construct: in file lib_forms.php, method PasswordField::__construct()
Constructor for PasswordField.
__construct: in file lib_forms.php, method Hidden::__construct()
Constructor for Hidden.
__construct: in file lib_forms.php, method ReadOnly::__construct()
Constructor for ReadOnly.
__construct: in file lib_forms.php, method ResetButton::__construct()
Constructor for ResetButton.
__construct: in file lib_forms.php, method Select::__construct()
Constructor for Select.
__construct: in file lib_search.php, method CustomSearch::__construct()
Constructor for CustomSearch.
__construct: in file lib_search.php, method EqualSearch::__construct()
Constructor for EqualSearch.
__construct: in file lib_tables.php, method Header::__construct()
Constructor for Header.
__construct: in file lib_search.php, method TableSearcher::__construct()
Constructor for SearchGenerator.
__construct: in file lib_tables.php, method Table::__construct()
Constructor for Table.
__construct: in file lib_updates.php, method Update::__construct()
Constructor for UpdateType.
__construct: in file lib_updates.php, method UpdateType::__construct()
Constructor for UpdateType.
__construct: in file lib_search.php, method SearchField::__construct()
Constructor for SearchField.
__construct: in file lib_search.php, method LikeSearch::__construct()
Constructor for LikeSearch.
__construct: in file lib_search.php, method GreaterEqualSearch::__construct()
Constructor for GreaterEqualSearch.
__construct: in file lib_search.php, method FulltextSearch::__construct()
Constructor for FulltextSearch.
__construct: in file lib_search.php, method GreaterSearch::__construct()
Constructor for GreaterSearch.
__construct: in file lib_search.php, method LesserEqualSearch::__construct()
Constructor for LesserSearch.
__construct: in file lib_search.php, method LesserSearch::__construct()
Constructor for LesserSearch.
__construct: in file lib_forms.php, method Form::__construct()
Constructor for Form.
__construct: in file lib_forms.php, method Field::__construct()
Constructor for Field.
__construct: in file lib_admin_panel.php, method DetailsModule::__construct()
Constructor for DetailsModule.
__construct: in file lib_admin_panel.php, method DeleteModule::__construct()
Constructor for DeleteModule.
__construct: in file lib_admin_panel.php, method EditModule::__construct()
Constructor for EditModule.
__construct: in file lib_admin_panel.php, method TableField::__construct()
Constructor for TableField.
__construct: in file lib_articles.php, method Article::__construct()
Constructor for Article.
__construct: in file lib_admin_panel.php, method UpdateModule::__construct()
Constructor for UpdateModule.
__construct: in file lib_admin_panel.php, method CallbackModule::__construct()
Constructor for CallbackModule.
__construct: in file lib_admin_panel.php, method AdminPanel::__construct()
Constructor for AdminPanel.
__construct: in file lib_abbreviations.php, method AbbreviationHandler::__construct()
Constructor for AbbreviationHandler.
__construct: in file common.php, method TableEntry::__construct()
Constructor for TableEntry.
__construct: in file lib_admin_panel.php, method AddModule::__construct()
Constructor for AddModule.
__construct: in file lib_admin_panel.php, method AdminAction::__construct()
Constructor for AdminAction.
__construct: in file lib_admin_panel.php, method AdminModule::__construct()
Constructor for AdminModule.
__construct: in file lib_authors.php, method Author::__construct()
Constructor for Author.
__construct: in file lib_calendar.php, method AliasCalendar::__construct()
Constructor for AliasCalendar.
__construct: in file lib_forms.php, method Browse::__construct()
Constructor for Browse.
__construct: in file lib_events.php, method TimedEvent::__construct()
Constructor for TimedEvent.
__construct: in file lib_forms.php, method Button::__construct()
Constructor for Button.
__construct: in file lib_forms.php, method Checkbox::__construct()
Constructor for Checkbox.
__construct: in file lib_forms.php, method DateField::__construct()
Constructor for DateField.
__construct: in file lib_displayer.php, method TableDisplayer::__construct()
Constructor for TableDisplayer.
__construct: in file lib_displayer.php, method CustomTableDisplayer::__construct()
Constructor for CustomTableDisplayer.
__construct: in file lib_counters.php, method Counter::__construct()
Constructor for Counter.
__construct: in file lib_calendar.php, method Calendar::__construct()
Constructor for Calendar.
__construct: in file lib_css.php, method CssHandler::__construct()
Constructor for CssConverter. Adds itself as additional head information to the page.
__construct: in file lib_db.php, method DB::__construct()
Constructor for DB.
__construct: in file lib_displayer.php, method AbstractTableDisplayer::__construct()
Constructor for AbstractTableDisplayer.
__construct: in file common.php, method Page::__construct()
Constructor for Page.

top

a

$abbrMap: in file lib_abbreviations.php, variable AbbreviationHandler::$abbrMap
An array where they keys are abbreviations and the corresponding values are the meanings of those keys.
$action: in file lib_forms.php, variable Form::$action
The action to be used by the form.
$actionIdentifier: in file lib_admin_panel.php, variable AdminAction::$actionIdentifier
The action value that triggers the action.
$actions: in file lib_admin_panel.php, variable AdminModule::$actions
Contains all actions that the module handles. The key is the action identifier and the value is the corresponding AdminAction instance.
$attributes: in file lib_forms.php, variable Field::$attributes
Any additional attributes where the key is the attribute name and the value is the the attribute value.
$author: in file lib_news.php, variable Comment::$author
The author of the comment.
$authorId: in file lib_articles.php, variable Article::$authorId
The unique identifier of the article's author.
$authorId: in file lib_news.php, variable News::$authorId
The unique identifier of the author.
AbbreviationHandler: in file lib_abbreviations.php, class AbbreviationHandler
A class for handling abbreviations that are entered into the site's abbrevation database. This class should be concidered singelton and should only be used using the one and only globally defined instance. Implements the singleton pattern.
AbstractTableDisplayer: in file lib_displayer.php, class AbstractTableDisplayer
Describes an abstract table displayer which displays and splits up table contents over several pages. It allows pages to display menu bars so the users can select the desired page which displays a specified number of table rows.
add: in file lib_tables.php, method Header::add()
Adds an new caption to the header.
addField: in file lib_search.php, method TableSearcher::addField()
Adds a search field to the table searcher. The field specifies the restrictions that should be put on the corresponding table field.
addField: in file lib_forms.php, method Form::addField()
Adds a new field to the form.
addFieldPair: in file lib_calendar.php, method Calendar::addFieldPair()
Adds a pair of fields to the calendar. If both fields are spceified then they should be connected, i.e. their request names should be identical.
addFields: in file lib_forms.php, method Form::addFields()
Adds multiple fields to the form.
AddModule: in file lib_admin_panel.php, class AddModule
Describes a module for adding new rows to a table.
addModule: in file lib_admin_panel.php, method AdminPanel::addModule()
Adds an additional module to the panel.
addMonthSelection: in file lib_calendar.php, method Calendar::addMonthSelection()
Adds a form selection field to the form. The selection field only contains months that include at least one day in the calendar's range.
addQueryParams: in file lib_util.php, function addQueryParams()
Adds specified parameters to the current query string. If a parameter is already specified then the existing value is overwritten by the new one.
addRow: in file lib_tables.php, method Table::addRow()
Adds a new row to the table.
addToHead: in file common.php, method Page::addToHead()
Adds something that is head addable (implements HeadAddable) to the head tag of the page.
addUpdate: in file lib_updates.php, function addUpdate()
Adds an update to the database.
addYearSelection: in file lib_calendar.php, method Calendar::addYearSelection()
Adds a form selection field to the form. The selection field only contains years that include at least one day in the calendar's range.
AdminAction: in file lib_admin_panel.php, class AdminAction
Describes an admin action, an identifier for something that can be done by the admin panel.
AdminModule: in file lib_admin_panel.php, class AdminModule
Describes an module with admin functionality. The module defines actions that it's able perform and performs the action when needed. This class should be concidered abstract.
AdminPanel: in file lib_admin_panel.php, class AdminPanel
Describes a panel itself. The panel itself is an module that shows an overview of a table and the available modules.
AliasCalendar: in file lib_calendar.php, class AliasCalendar
Describes a calendar that link to aliases in a ./year/month/day format.
Article: in file lib_articles.php, class Article
Describes an article.
Author: in file lib_authors.php, class Author
Describes an author.

top

b

Browse: in file lib_forms.php, class Browse
Describes a file field.
buildDeleteQuery: in file lib_db.php, method DB::buildDeleteQuery()
Builds and executes a delete query for the specified table using the specified values.
buildInsertQuery: in file lib_db.php, method DB::buildInsertQuery()
Builds an insert query based on the specified table and values.
buildSqlSelector: in file lib_db.php, method DB::buildSqlSelector()
Builds a sql selector from specified field values.
buildUpdateQuery: in file lib_db.php, method DB::buildUpdateQuery()
Builds an update query for the specified table using the specified values.
buildUrlAliases: in file lib_redirects.php, function buildUrlAliases()
Rebuilds the url aliases master table. It composes all necessary aliases and resets the aliases master table with that info.
buildUrlRedirects: in file lib_redirects.php, function buildUrlRedirects()
Rebuilds the url redirects master table. It composes all necessary redirects and resets the redirects master table with that info.
Button: in file lib_forms.php, class Button
Describes a button.

top

c

$callback: in file lib_forms.php, variable ReadOnly::$callback
A callback that the value should be processed through before being displayed. An empty string means that there is no callback.
$callback: in file lib_events.php, variable TimedEvent::$callback
The callback that should be called when the event is to be performed.
$callbacks: in file lib_admin_panel.php, variable DetailsModule::$callbacks
Contains all format callbacks with the corresponding table field as key and the callback as value.
$callbacks: in file lib_admin_panel.php, variable CallbackModule::$callbacks
Contains all the callbacks, action value as key, the callback as value.
$caption: in file lib_news.php, variable News::$caption
The caption of the news item.
$captions: in file lib_tables.php, variable Header::$captions
Contains the captions for the header.
$connection: in file lib_db.php, variable DB::$connection
The database connection to use.
$contents: in file lib_news.php, variable Comment::$contents
The contents of the comment.
$counterId: in file lib_articles.php, variable Article::$counterId
The unique identifier for the counter that is associated with the article.
$countQuery: in file lib_displayer.php, variable CustomTableDisplayer::$countQuery
The SQL query that should be used for counting all the rows that should be displayed.
$cssClass: in file lib_forms.php, variable Form::$cssClass
The css class to be used by the form element.
$cssClass: in file lib_tables.php, variable Table::$cssClass
The CSS class to use for the header when displaying.
$cssNames: in file lib_css.php, variable CssHandler::$cssNames
The names of all CSS files that should be included when displaying the page.
$cssValues: in file lib_css.php, variable CssHandler::$cssValues
The CSS values as a tree structure. The array may contain arrays, in which case the key is the name of the node. The array may also contain textual values, which are leaves.
$currentPage: in file lib_displayer.php, variable AbstractTableDisplayer::$currentPage
The page index that the displayer is currently displaying, the first page has index 0. As a special case -1 means that everything should be displayed.
$customPattern: in file lib_search.php, variable CustomSearch::$customPattern
The custom pattern that should be used when constructing the where conditions.
Calendar: in file lib_calendar.php, class Calendar
Describes a calendar that displays a database table as a calendar with
CallbackModule: in file lib_admin_panel.php, class CallbackModule
Describes a module that uses callbacks to process events.
Checkbox: in file lib_forms.php, class Checkbox
Describes a checkbox.
checkErrors: in file lib_event_digest.php, function checkErrors()
Checks if there are any unresolved errors that should be sent to the webmaster.
clear: in file lib_forms.php, method Form::clear()
Removes all recorded field values from the form.
clearCssCache: in file lib_css.php, function clearCssCache()
Unlinks all cached CSS files.
clearQueue: in file lib_db.php, method DB::clearQueue()
Clears the queue, removing all currently queued queries wihtout executing them.
Comment: in file lib_news.php, class Comment
Describes a news comment.
connectToDb: in file lib_db.php, method DB::connectToDb()
Connects to mysql and selects the correct databse.
convertBoolToYn: in file lib_admin_panel.php, function convertBoolToYn()
Converts a boolean value to either 'Yes' or 'No'. 'Yes' is used if the value is a boolean true, 'No' is used in all other cases.
convertDayToFirstSecond: in file lib_calendar.php, function convertDayToFirstSecond()
Internal function to convert days to timestamps equal to the first second of the specified day.
convertDayToLastSecond: in file lib_calendar.php, function convertDayToLastSecond()
Internal function to convert days to timestamps equal to the last second of the specified day.
convertTemplate: in file lib_css.php, method CssHandler::convertTemplate()
Converts a string containing a CSS template to a string representing a real CSS file.
convertToDays: in file lib_updates.php, function convertToDays()
Converts unixtime in seconds to the corresponding number of days.
convertToNumerical: in file lib_tables.php, method Header::convertToNumerical()
Converts the value to the corresponding numerical one. The conversion will only be reliable if the value return true with isConvertableToNumerical().
convertWildcardToLike: in file lib_search.php, function convertWildcardToLike()
Converts a wildcard search where '*' means '0 or more characters' to the corresponding search in a LIKE search (using '%' instead of '*').
Counter: in file lib_counters.php, class Counter
Describes a counter which maintains a value that can be incremented by one.
CssHandler: in file lib_css.php, class CssHandler
A class that handles everything that has to do with CSS, all CSS files that are to be included are recorded by this class. The appropriate actions are then taken to make sure that each of the files are then handled correctly when the page should be displayed. Implements the singleton pattern.
CustomSearch: in file lib_search.php, class CustomSearch
Describes a search field that uses a custom pattern to construct the sql conditions.
CustomTableDisplayer: in file lib_displayer.php, class CustomTableDisplayer
A displayer that takes a custom query and executes it. It can be used to perform more advanced queries than the notmal displayer can.

top

d

$day: in file lib_calendar.php, variable Calendar::$day
The currently selected unix timestamp as days. I.e. this is not day of the week, this is timestamp/(3600*24).
$day: in file lib_forms.php, variable DateField::$day
The date selection field.
$dayMax: in file lib_calendar.php, variable Calendar::$dayMax
The last day, as an unix timestamp converted into days, that the calendar should display.
$dayMin: in file lib_calendar.php, variable Calendar::$dayMin
The first day, as an unix timestamp converted into days, that the calendar should display.
$decsription: in file lib_events.php, variable TimedEvent::$decsription
A description of the event.
$defaultAction: in file lib_admin_panel.php, variable AdminPanel::$defaultAction
The action that should be used if no other action is declared (in $_REQUEST).
$depth: in file lib_menu.php, variable MenuItem::$depth
The level of depth that the menu item is located at in the menu tree. A level of 0 means that the item is the root, 1 means that it is a child of the root, and so on.
$description: in file lib_updates.php, variable UpdateType::$description
A short description of what updates are grouped in the type. For example 'News added'.
$description: in file lib_counters.php, variable Counter::$description
The description of what the counter records.
$displayer: in file lib_admin_panel.php, variable AdminPanel::$displayer
The table displayer that should be used to view the the contents of the viewe database.
$displayErrors: in file lib_forms.php, variable Form::$displayErrors
If errors should be displayed or not (true by default).
$displayField: in file lib_updates.php, variable UpdateType::$displayField
The field in $tableToListenTo that contains the value to use as display text for resulting updates.
$displayFormat: in file lib_updates.php, variable UpdateType::$displayFormat
The format that should be used with printf when describing an individual update of this type. For example '%s' if one wants the update's text to be displayed along, or 'Added: %s' if one instead wants to display 'Added: ' in front.
$displayName: in file lib_admin_panel.php, variable TableField::$displayName
The name that should be displayed to the user.
$displayName: in file lib_admin_panel.php, variable AdminAction::$displayName
The name that describes the action to the user.
$displayText: in file lib_updates.php, variable Update::$displayText
The text describing the specific update. This value will generally differ from each update instance.
$doConfirmation: in file lib_admin_panel.php, variable DeleteModule::$doConfirmation
If a confirmation should be asked for or not. True if a confirmation should be asked for, false otherwise.
DateField: in file lib_forms.php, class DateField
Describes a field (or rather group of fields) that allows the user to select a specific date by selecting year, month and day.
DATE_CALENDAR_NAV: in file lib_calendar.php, constant DATE_CALENDAR_NAV
DB: in file lib_db.php, class DB
Describes a database abstraction. The abstraction maintains a connection which is instance specific. Hence it is recommended that only one global instance is used.
DeleteModule: in file lib_admin_panel.php, class DeleteModule
Describes a module that deletes rows from a table.
DetailsModule: in file lib_admin_panel.php, class DetailsModule
Describes a module that shows read only contents of a specified row.
display: in file common.php, method Page::display()
Displays the page.
displayContents: in file common.php, method Page::displayContents()
Displays the page with the specified contents.
doDaysHaveRows: in file lib_calendar.php, method Calendar::doDaysHaveRows()
Check if an specified interval of days have updates. Optionally constraints can be placed on the public function so that it only checks for updates of a specific type. This public function should be concidered private.
doDelayedRedirect: in file lib_redirects.php, function doDelayedRedirect()
Performs a delayed redirection to the specified url with the speicified delay. The page will be redirected after the specified number of seconds have elapsed.
doEventDigest: in file lib_event_digest.php, function doEventDigest()
Performs all the event digest work available.
doPermanentRedirect: in file lib_redirects.php, function doPermanentRedirect()
Redirects the request to a specified page with a permanent redirect, i.e.
doRedirect: in file lib_redirects.php, function doRedirect()
Redirects the url to the specified page with a temporary redirect, i.e.

top

e

$email: in file lib_authors.php, variable Author::$email
The email connected to the author.
$encType: in file lib_forms.php, variable Form::$encType
The encoding type to use for the form.
$entry: in file lib_news.php, variable News::$entry
The actual processed XHTML entry of the news item.
$entryLink: in file lib_admin_panel.php, variable CallbackModule::$entryLink
The entry link pattern to be returned by the module.
$entryMap: in file lib_tables.php, variable Table::$entryMap
Contains an array which maps ints onto other ints. The mapping can rearange the order in which the row entries are displayed.
EditModule: in file lib_admin_panel.php, class EditModule
Describes a module that edits a specified row in a table.
ensureConnected: in file lib_db.php, method DB::ensureConnected()
Ensures that there is a active valid connection the the database. Id there is an active and valid connection then nothing is done, otherwise a connection is created.
ensureCssIncluded: in file lib_util.php, function ensureCssIncluded()
Ensures that a css file with the specified name is included in the page output. If it is already included then nothing is done, if it is not included then it is added.
EqualSearch: in file lib_search.php, class EqualSearch
Describes a search field that searches for things that are equal to the parameter.
escape: in file lib_db.php, method DB::escape()
Escapes any special characters in the specified value. The result is also quoted if it is not numeric. All field values should be run through this function to ensure security.

top

f

$fields: in file lib_admin_panel.php, variable DeleteModule::$fields
Contains the TableField instances that should be used to identify which row that should be deleted.
$fields: in file lib_admin_panel.php, variable AddModule::$fields
Contains the fields (represented by TableFiled instances) that should be set when adding a new module.
$fields: in file lib_admin_panel.php, variable EditModule::$fields
Contains the fields, represented by TableField instances, that should be edited.
$fields: in file lib_forms.php, variable Form::$fields
Contains arrays describing contained fields with two keys each: (Field)field: The actual field.
$fields: in file lib_search.php, variable TableSearcher::$fields
An array of SearchField instances.
$fields: in file lib_admin_panel.php, variable AdminPanel::$fields
Contains the fields (represented by TableField instances) that should be displayed.
$fieldsToSet: in file lib_admin_panel.php, variable UpdateModule::$fieldsToSet
Contains the fields (represented by TableField instances) and the values that they should be set to.
$fieldsToView: in file lib_admin_panel.php, variable DetailsModule::$fieldsToView
Contains TableField instances representing the fields that should be viewed in the detailed overview.
$fileName: in file lib_articles.php, variable Article::$fileName
The filename of the file in the article folder that contains the contents of the article.
$form: in file lib_calendar.php, variable Calendar::$form
The form that should be displayed to the user along with the calendar grid.
$formatCallbacks: in file lib_admin_panel.php, variable AdminPanel::$formatCallbacks
Contains callbacks that should be used to properly format fields. Key is the tables fieldname, value is the callback. If no callback for a field is found then the field is directly outputted without any preprocessing.
$formatMultiple: in file lib_updates.php, variable UpdateType::$formatMultiple
The format that should be used with printf when describing a grouping which contains more than one update.
$formatSingle: in file lib_updates.php, variable UpdateType::$formatSingle
The format that should be used with printf when describing a grouping which contains less than two updates.
$formFields: in file lib_admin_panel.php, variable AddModule::$formFields
Contains the form fields, represented by Field instances, that should be used to override the request name contained in the key.
$formFields: in file lib_admin_panel.php, variable EditModule::$formFields
Contains the form fields, represented by Field instances, that should be used to override the request name contained in the key.
Field: in file lib_forms.php, class Field
Describes a field in a form.
FileNotFoundException: in file lib_errors.php, class FileNotFoundException
An exception used when an error occurs while performing an IO operation because of that a file was not found.
flush: in file common.php, method Page::flush()
Flushes the page, totally unprocessed, to the output stream.
flushQueue: in file lib_db.php, method DB::flushQueue()
Flushes the queue, executing all queries in it in the order that they were inserted and then clearing it.
Form: in file lib_forms.php, class Form
Describes an form.
formatAbbreviation: in file lib_abbreviations.php, method AbbreviationHandler::formatAbbreviation()
Formats an abbreviation into XHTML compliant code.
formatAddition: in file lib_forms.php, method DateField::formatAddition()
No additions are allowed.
formatAddition: in file lib_forms.php, method Field::formatAddition()
Formats any additional data that should be appended to the field. Any '%id' entities in the formatted string are replaced with the field's id. Any '%name' entities in the formatted string are replaced with the field's name.
formatTimestampDate: in file lib_admin_panel.php, function formatTimestampDate()
Formats a timestamp into a date representation. As a special case timestamp equal to 0 get the representation 'Never'.
formatTimestampDays: in file lib_admin_panel.php, function formatTimestampDays()
Formats a timestamp to the number of elapsed days since the point in time which the timestamp represents. This includes special cases like 'Never', 'Today' and 'Yesterday'.
formatTimestampTime: in file lib_admin_panel.php, function formatTimestampTime()
Formats a timestamp into a date representation complete with hours and minutes. As a special case timestamp equal to 0 get the representation 'Never'.
FulltextSearch: in file lib_search.php, class FulltextSearch
Describes a search field that implements fulltext searches.

top

g

$globalLink: in file lib_admin_panel.php, variable CallbackModule::$globalLink
The global link pattern to be used by the module.
getAction: in file lib_admin_panel.php, method AdminAction::getAction()
Gets the action value identifing the action.
getAddDialog: in file lib_admin_panel.php, method AddModule::getAddDialog()
Gets the corresponding add dialog.
getAdminActions: in file lib_admin_panel.php, method AdminModule::getAdminActions()
Gets all admin actions handled by the module.
getAdminMenu: in file lib_admin.php, function getAdminMenu()
Gets an menu listing all available admin panels.
getAllArticles: in file lib_articles.php, function getAllArticles()
Gets all available articles.
getAllAuthorNames: in file lib_authors.php, function getAllAuthorNames()
Gets all authors' names.
getAllCounterDescriptions: in file lib_counters.php, function getAllCounterDescriptions()
Gets the descriptions of all available counters.
getAllMenuNames: in file lib_menu.php, function getAllMenuNames()
Gets the names of all menu items available.
getAllMonthNames: in file lib_calendar.php, function getAllMonthNames()
Gets the names of all the years months.
getAllNewsCaptions: in file lib_news.php, function getAllNewsCaptions()
Gets the captions of all available news entries.
getAllUpdateTypeDescriptions: in file lib_updates.php, function getAllUpdateTypeDescriptions()
Gets the descriptions of all available update types.
getAllUpdateTypes: in file lib_updates.php, function getAllUpdateTypes()
Gets a list of all available update types.
getArticle: in file lib_articles.php, method Article::getArticle()
Gets the article in a XHTML form.
getAsHtml: in file lib_forms.php, method ResetButton::getAsHtml()
getAsHtml: in file lib_tables.php, method Header::getAsHtml()
Gets the header as HTML, including the row tags.
getAsHtml: in file lib_forms.php, method Checkbox::getAsHtml()
getAsHTML: in file lib_forms.php, method DateField::getAsHTML()
getAsHtml: in file lib_forms.php, method Field::getAsHtml()
Returns the (X)HTML representation of the field. This function should be concidered as an abstract function, any subclasses should override this.
getAsHtml: in file lib_forms.php, method Hidden::getAsHtml()
getAsHtml: in file lib_forms.php, method Select::getAsHtml()
getAsHtml: in file lib_forms.php, method SubmitButton::getAsHtml()
getAsHtml: in file lib_forms.php, method Button::getAsHtml()
getAsHtml: in file lib_forms.php, method TextArea::getAsHtml()
getAsHtml: in file lib_forms.php, method TextField::getAsHtml()
getAsHTML: in file lib_forms.php, method TimeField::getAsHTML()
getAsHTML: in file lib_news.php, method Comment::getAsHTML()
Gets the comment as (X)HTML.
getAsHtml: in file lib_forms.php, method ReadOnly::getAsHtml()
getAsHtml: in file lib_forms.php, method PasswordField::getAsHtml()
getAsHtml: in file lib_menu.php, method MenuItem::getAsHtml()
Gets the menu item as XHTML compliant code. This function also includes the children of the menu item (if there are any).
getAsHtml: in file lib_forms.php, method Browse::getAsHtml()
getAsHTMLComment: in file lib_news.php, method News::getAsHTMLComment()
Gets the (X)HTML representing the news entry as it should be displayed in a comment enviorment (it doesn't include project references or comment links).
getAsHTMLGeneric: in file lib_news.php, method News::getAsHTMLGeneric()
Gets the (X)HTML representing the news entry as it should be displayed in a generic enviorment.
getAsHTMLIndex: in file lib_news.php, method News::getAsHTMLIndex()
Gets the (X)HTML representating the news entry in a search engine friendly form.
getAsHTMLPreview: in file lib_news.php, method News::getAsHTMLPreview()
Gets the (X)HTML representating the news entry as it should be displayed when displayed as a preview.
getAsRSS: in file lib_news.php, method News::getAsRSS()
Gets the news entry as it should displayed in an RSS feed.
getAssociatedComments: in file lib_news.php, method News::getAssociatedComments()
Gets all comment instance that are related to the news entry.
getAttributes: in file lib_forms.php, method SizedField::getAttributes()
getAttributes: in file lib_forms.php, method Field::getAttributes()
Gets the (X)HTML information containing all base information.
getAuthor: in file lib_articles.php, method Article::getAuthor()
Gets the author of the article.
getAuthor: in file lib_news.php, method News::getAuthor()
Gets the author of the new item.
getAuthorByName: in file lib_authors.php, function getAuthorByName()
Finds an author with a specified name.
getCalendar: in file lib_calendar.php, method Calendar::getCalendar()
Gets the XHTML code that represent the calendar.
getCaption: in file lib_news.php, method News::getCaption()
Gets the caption of the news entry.
getChildren: in file lib_menu.php, method MenuItem::getChildren()
Gets all children of the menu item in alphabetical order based on their names.
getCommentLink: in file lib_news.php, method News::getCommentLink()
Gets a link to the news iterm's comment page.
getCommentUrl: in file lib_news.php, method News::getCommentUrl()
Gets the url to the news' comments page.
getCounter: in file lib_articles.php, method Article::getCounter()
Gets the counter that is connected to the article.
getCssLink: in file lib_css.php, method CssHandler::getCssLink()
Gets the XHTML link that represents the specified CSS name.
getCurrentDirectory: in file lib_util.php, function getCurrentDirectory()
Gets the relative path to the current requested directory from the root path.
getCurrentEncodedUrl: in file lib_util.php, function getCurrentEncodedUrl()
Gets the current encoded url, complete with the query string.
getCurrentPath: in file lib_menu.php, function getCurrentPath()
Gets the current path relative to the root path. This is used as a callback in the menu.
getCurrentUrl: in file lib_util.php, function getCurrentUrl()
Gets the current url, complete with the query string.
getDaysInMonth: in file lib_calendar.php, function getDaysInMonth()
Gets the number of days in a specified month.
getDayUrl: in file lib_calendar.php, method Calendar::getDayUrl()
Gets the url to a specified day in the calendar.
getDayUrl: in file lib_calendar.php, method AliasCalendar::getDayUrl()
getDesciption: in file lib_events.php, method TimedEvent::getDesciption()
Gets a brief description of the event.
getDescription: in file lib_counters.php, method Counter::getDescription()
Gets the counter's description. The description describes what the counter is recording.
getDescription: in file lib_updates.php, method UpdateType::getDescription()
Gets a description of what updates are grouped in the type. For example 'News added'.
getDisplayName: in file lib_admin_panel.php, method TableField::getDisplayName()
Gets the display name of the field.
getDisplayName: in file lib_admin_panel.php, method AdminAction::getDisplayName()
Gets the name that describes the action.
getDueEvents: in file lib_events.php, function getDueEvents()
Gets all events that are due to be performed.
getEditDialog: in file lib_admin_panel.php, method EditModule::getEditDialog()
Gets the corresponding edit dialog.
getEmail: in file lib_authors.php, method Author::getEmail()
Gets the email to the author.
getEntryAsHTML: in file lib_news.php, method News::getEntryAsHTML()
Gets the news' entry with markup code in it (e.g. [img]...[/img]) to the XHTML equivelant.
getEntryLinkPattern: in file lib_admin_panel.php, method DeleteModule::getEntryLinkPattern()
getEntryLinkPattern: in file lib_admin_panel.php, method CallbackModule::getEntryLinkPattern()
getEntryLinkPattern: in file lib_admin_panel.php, method DetailsModule::getEntryLinkPattern()
getEntryLinkPattern: in file lib_admin_panel.php, method AdminModule::getEntryLinkPattern()
Override this function if the module should be linked to once for every entry displayed in the panel's overview. The pattern can use fieldnames as $row['foo'] (where foo is the fieldname).
getEntryLinkPattern: in file lib_admin_panel.php, method EditModule::getEntryLinkPattern()
getEntryLinkPattern: in file lib_admin_panel.php, method UpdateModule::getEntryLinkPattern()
getError: in file lib_forms.php, method Form::getError()
getError: in file lib_forms.php, method Validatable::getError()
Returns the reason for an object is not in a valid state. This assumes that the isValid() function returns false (so check that first).
getError: in file lib_forms.php, method Field::getError()
getField: in file lib_forms.php, method Form::getField()
Gets the field instance corresponding to the given (field) name.
getForm: in file lib_forms.php, method Form::getForm()
Gets the (X)HTML representation of the form.
getGlobalLinkPattern: in file lib_admin_panel.php, method AdminModule::getGlobalLinkPattern()
Override this function if the module should be linked to once in the panel.
getGlobalLinkPattern: in file lib_admin_panel.php, method AddModule::getGlobalLinkPattern()
getGlobalLinkPattern: in file lib_admin_panel.php, method CallbackModule::getGlobalLinkPattern()
getGroupedUpdates: in file lib_updates.php, function getGroupedUpdates()
Retrives all updates that match the specified criterias. The updates are
getHeadAddition: in file lib_css.php, method CssHandler::getHeadAddition()
Gets all the CSS links that should be added.
getHeadAddition: in file common.php, method HeadAddable::getHeadAddition()
Gets the things that should be added to the page's head element.
getHeadAddition: in file common.php, method Page::getHeadAddition()
Gets all additional head data that is specified by the page.
getHeader: in file lib_tables.php, method Table::getHeader()
Gets the header of the table.
getHeight: in file lib_forms.php, method SizedField::getHeight()
Gets the height of the field.
getId: in file lib_forms.php, method Field::getId()
Gets the field's id.
getId: in file common.php, method TableEntry::getId()
Gets the unique identifier for the table entry.
getImage: in file lib_images.php, function getImage()
Gets the XHTML code for an image within the defined paramaters. If the default source of the specified image does not meet the define parameters then the function created an resized version of the image so that does.
getImageCode: in file lib_images.php, function getImageCode()
Gets the XHTML code for a specified image.
getImageResource: in file lib_images.php, function getImageResource()
Gets the image resource of the specified image file.
getInstance: in file lib_css.php, method CssHandler::getInstance()
Gets the one and only instance of the class.
getInstance: in file lib_db.php, method DB::getInstance()
Gets the one and only instance of the class.
getInstance: in file lib_abbreviations.php, method AbbreviationHandler::getInstance()
Gets the one and only instance of the class.
getInstance: in file common.php, method Page::getInstance()
Gets the one and only instance of the class.
getLastInsertId: in file lib_db.php, method DB::getLastInsertId()
Gets the last generated identifier on a per-connection basis.
getLink: in file lib_updates.php, method Update::getLink()
Gets the XHTML link representing the update.
getLink: in file lib_updates.php, method UpdateType::getLink()
Formats specified information into a XHTML link in accordance with the update type's specifications.
getMatchedRows: in file lib_search.php, method TableSearcher::getMatchedRows()
Gets all rows that matched the search parameters (if any).
getMonth: in file lib_calendar.php, function getMonth()
Gets the month of the year that a specified day is included in.
getMonthNavigation: in file lib_calendar.php, method Calendar::getMonthNavigation()
Gets an XHTML compliant month navigation. The navigation allows users the move one month forward or backwards or to move to the first or last month.
getName: in file lib_authors.php, method Author::getName()
Gets the name of the author.
getName: in file lib_menu.php, method MenuItem::getName()
Gets the name of the menu item.
getName: in file lib_forms.php, method Field::getName()
Gets the name of the field.
getNews: in file lib_news.php, function getNews()
Gets all news items that matches the specified selector.
getNewsEntry: in file lib_news.php, method Comment::getNewsEntry()
Gets the news entry that the comment is attached to.
getOutput: in file lib_admin_panel.php, method AdminModule::getOutput()
Gets the output that the module wants to diaply.
getOutput: in file lib_admin_panel.php, method AdminPanel::getOutput()
getOutput: in file lib_admin_panel.php, method UpdateModule::getOutput()
getOutput: in file lib_admin_panel.php, method DeleteModule::getOutput()
getOutput: in file lib_admin_panel.php, method EditModule::getOutput()
getOutput: in file lib_admin_panel.php, method CallbackModule::getOutput()
getOutput: in file lib_admin_panel.php, method AddModule::getOutput()
getOutput: in file lib_admin_panel.php, method DetailsModule::getOutput()
getPageMenuBar: in file lib_displayer.php, method AbstractTableDisplayer::getPageMenuBar()
Gets a page menu associated with the table displayer. The menu contains links ordered in a bar which can be used to change the current page.
getPageRows: in file lib_displayer.php, method TableDisplayer::getPageRows()
getPageRows: in file lib_displayer.php, method AbstractTableDisplayer::getPageRows()
Gets the rows that should be displayed on the current page.
getPageRows: in file lib_displayer.php, method CustomTableDisplayer::getPageRows()
getPanel: in file lib_admin_panel.php, method AdminPanel::getPanel()
Gets the panel in its HTML form.
getPermanentUrl: in file lib_news.php, method News::getPermanentUrl()
Gets the premanent url to the news item.
getQueueSize: in file lib_db.php, method DB::getQueueSize()
Gets the number of queries in the queue.
getRealUrl: in file lib_redirects.php, function getRealUrl()
Gets the url that a specified url really leads to. For instance a user might request one url while the request is actually transferred to an centralised module behind the scenes.
getRedirect: in file lib_redirects.php, function getRedirect()
Gets any redirects that apply to a specified url.
getRequestName: in file lib_admin_panel.php, method TableField::getRequestName()
Gets the request name of the field.
getRequestName: in file lib_search.php, method SearchField::getRequestName()
Gets the name of the table field that the search field is connected to.
getRowCount: in file lib_displayer.php, method TableDisplayer::getRowCount()
getRowCount: in file lib_displayer.php, method CustomTableDisplayer::getRowCount()
getRowCount: in file lib_displayer.php, method AbstractTableDisplayer::getRowCount()
Gets the number of rows that the viewer can display in total. This is an abstract implementation and should be overridden by all subclasses.
getSelectedTimestamp: in file lib_calendar.php, method Calendar::getSelectedTimestamp()
Gets the calendar's selected timestamp. The timestamp has a resolution of 3600*24 seconds, i.e. days.
getSimilarUrls: in file lib_redirects.php, function getSimilarUrls()
Gets all urls that are similar to a specified url. I.e. all urls that exist and are subsets of the specified url.
getSqlSelector: in file lib_search.php, method TableSearcher::getSqlSelector()
Gets the sql selector that represents the current configuration of the table searcher. The selector describes what the search will match.
getSqlSelector: in file lib_displayer.php, method TableDisplayer::getSqlSelector()
Gets the sql selector that represents what the displayer will display on the current page.
getSqlSelector: in file lib_calendar.php, method Calendar::getSqlSelector()
Gets the sql selector that represents the current configuration of the calendar. The selector describes what rows match the calendar selections.
getSqlWhereCondition: in file lib_search.php, method GreaterSearch::getSqlWhereCondition()
getSqlWhereCondition: in file lib_search.php, method LesserEqualSearch::getSqlWhereCondition()
getSqlWhereCondition: in file lib_search.php, method LikeSearch::getSqlWhereCondition()
getSqlWhereCondition: in file lib_search.php, method SearchField::getSqlWhereCondition()
Gets the where condition of the search field. This should be a sql statement that can be placed after "WHERE" in the sql query. A couple of examples: "id > 5", "(solved = 1) AND (tested = 0)".
getSqlWhereCondition: in file lib_search.php, method LesserSearch::getSqlWhereCondition()
getSqlWhereCondition: in file lib_search.php, method GreaterEqualSearch::getSqlWhereCondition()
getSqlWhereCondition: in file lib_search.php, method FulltextSearch::getSqlWhereCondition()
getSqlWhereCondition: in file lib_search.php, method CustomSearch::getSqlWhereCondition()
getSqlWhereCondition: in file lib_search.php, method EqualSearch::getSqlWhereCondition()
getTable: in file lib_tables.php, method Table::getTable()
Gets the table in HTML format.
getTableField: in file lib_admin_panel.php, method TableField::getTableField()
Gets the name of the table field connected to this instance.
getTextSearchField: in file lib_search.php, function getTextSearchField()
Gets the appriopriate instance of a text search field (FulltextSearch or LikeSearch) to use with the specified constructor parameters. Fulltext is used if possible, otherwise LIKE is used.
getTimeAdded: in file lib_news.php, method News::getTimeAdded()
Gets the timestamp that represents when the news entry was added.
getTimestamp: in file lib_updates.php, method Update::getTimestamp()
Gets the unix timestamp of when the update was generated.
getTitle: in file lib_articles.php, method Article::getTitle()
Gets the title describing the article.
getTitle: in file common.php, method Page::getTitle()
Gets the title of the page.
getToken: in file lib_css.php, method CssHandler::getToken()
Gets the token that represents the steps take. It's the token that should be replaced in any text by the corresponding value.
getType: in file lib_updates.php, method Update::getType()
Gets the update type connected with the update.
getUpdateBoxes: in file lib_updates.php, function getUpdateBoxes()
Gets boxes in XHTML format containing all recent updates that have been done to the site.
getUpdateGroupsDescription: in file lib_updates.php, method UpdateType::getUpdateGroupsDescription()
Gets an description for the specified group of updates as defined by the update type. This can for instance be '4 items added'.
getUpdates: in file lib_updates.php, function getUpdates()
Gets all updates that matches the specified selector.
getUrl: in file lib_articles.php, method Article::getUrl()
Gets the url to the article. The url is easy to read and is the one that the user should always be seeing.
getUrlPath: in file lib_redirects.php, function getUrlPath()
Attempts to get a url path to an existing file by starting from a specified url and then translating the related redirects.
getValue: in file lib_admin_panel.php, method TableField::getValue()
Gets the value of the field.
getValue: in file lib_forms.php, method DateField::getValue()
getValue: in file lib_forms.php, method TimeField::getValue()
getValue: in file lib_css.php, method CssHandler::getValue()
Gets the CSS value that correspond to the specified steps.
getValue: in file lib_forms.php, method Field::getValue()
Gets the value of the field.
getValue: in file lib_forms.php, method Form::getValue()
Gets the value of one of the form's fields.
getWidth: in file lib_forms.php, method SizedField::getWidth()
Gets the width of the field.
getYear: in file lib_calendar.php, function getYear()
Gets the year that a specified day is included in.
GreaterEqualSearch: in file lib_search.php, class GreaterEqualSearch
Describes a search field that searches for things that are greater than or equal to the parameter.
GreaterSearch: in file lib_search.php, class GreaterSearch
Describes a search field that searches for things that are greater than the parameter.
groupUpdatesByType: in file lib_updates.php, function groupUpdatesByType()
Groups update instance by their update types.

top

h

$hasUserValue: in file lib_forms.php, variable Field::$hasUserValue
True if the current value was entered by a user, false otherwise.
$headAdditions: in file common.php, variable Page::$headAdditions
All instances of HeadAddable that should be added to the head contents.
$height: in file lib_forms.php, variable SizedField::$height
The height of the field, 0 means that no height has been set.
$hits: in file lib_counters.php, variable Counter::$hits
The number of hits that the counter has recorded.
$hour: in file lib_forms.php, variable TimeField::$hour
The hour selection field.
handleAbbreviations: in file lib_abbreviations.php, method AbbreviationHandler::handleAbbreviations()
Handles all abbreviations in a text by appending XHTML compliant explainations to each recognised abbreviation.
handlesAction: in file lib_admin_panel.php, method AdminModule::handlesAction()
Checks if an action can be handled by the module.
hasAnyUserValue: in file lib_forms.php, method Form::hasAnyUserValue()
Checks if any of the form's fields has any user set values.
hasUserValue: in file lib_forms.php, method Hidden::hasUserValue()
hasUserValue: in file lib_forms.php, method SubmitButton::hasUserValue()
hasUserValue: in file lib_forms.php, method TimeField::hasUserValue()
hasUserValue: in file lib_forms.php, method Field::hasUserValue()
Checks if the field has a non empty value that has been supplied by a user.
hasUserValue: in file lib_forms.php, method DateField::hasUserValue()
hasUserValue: in file lib_calendar.php, method Calendar::hasUserValue()
Checks if the user has selected a day or not in the calendar. If the user has not then getting results from the calendar should not be attempted.
hasValue: in file lib_admin_panel.php, method TableField::hasValue()
Checks if the field has a value set or not.
hasValue: in file lib_forms.php, method Field::hasValue()
Checks if the field has a non empty value.
hasValue: in file lib_forms.php, method DateField::hasValue()
hasValue: in file lib_forms.php, method Form::hasValue()
Checks if the form has a field with the specified name and if that field has a non empty value.
HeadAddable: in file common.php, class HeadAddable
Describes something that can add contents to the <head></head> elements of pages that are displayed.
Header: in file lib_tables.php, class Header
Descibes an Header.
Hidden: in file lib_forms.php, class Hidden
Describes a hidden field.
highlightWords: in file lib_search.php, function highlightWords()
Highlight specific words in a specified text.

top

i

$id: in file lib_forms.php, variable Field::$id
The unique identifier for the field.
$id: in file common.php, variable TableEntry::$id
The unique identifier for the entry.
$idFields: in file lib_admin_panel.php, variable EditModule::$idFields
Contains the fields that identify the rows that should be edited. The key is the name of the table field and the corresponding value is the corresponding form field that should be used for the table field.
$idFields: in file lib_admin_panel.php, variable DetailsModule::$idFields
Contains the fields (as TableField instances) that identify which row that should be viewed.
$idFields: in file lib_admin_panel.php, variable UpdateModule::$idFields
Contains the fields (represented by TableFiled instances) that identify which row that should be set.
$initialValue: in file lib_forms.php, variable DateField::$initialValue
The initial value (unix timestamp) that should be used for the field.
$instance: in file common.php, variable Page::$instance
The one and only instance of the class.
$instance: in file lib_db.php, variable DB::$instance
The one and only instance of the class.
$instance: in file lib_abbreviations.php, variable AbbreviationHandler::$instance
The one and only instance of the class.
$instance: in file lib_css.php, variable CssHandler::$instance
The one and only instance of the class.
$interval: in file lib_events.php, variable TimedEvent::$interval
The number of seconds that should pass between each time the event is run.
$itemsPerPage: in file lib_admin_panel.php, variable AdminPanel::$itemsPerPage
The number of items that should be displayed in each page when viewing the table overview.
IllegalArgumentException: in file lib_errors.php, class IllegalArgumentException
An exception used when an error occurs as a result of invalid input arguments to a function.
includeCss: in file lib_css.php, method CssHandler::includeCss()
Ensures that a css file with the specified name is included in the page output.
insertError: in file lib_errors.php, function insertError()
Inserts and error into the error table in the database.
insertMenu: in file lib_menu.php, function insertMenu()
Inserts the menu from the cache.
insertUpdateBox: in file lib_updates.php, function insertUpdateBox()
Inserts the update box from the cache.
IOException: in file lib_errors.php, class IOException
An exception used when an error occurs while performing an IO operation.
isConvertableToNumerical: in file lib_tables.php, method Header::isConvertableToNumerical()
Checks if a value could be converted to a numerical value. I.e. if it is a numerical value or possible a formatted numerical value. E.g.
isFulltextSearchable: in file lib_search.php, function isFulltextSearchable()
Checks if a wildcard search can be done with fulltext or if LIKE has to be used (fulltext is faster).
isValid: in file lib_forms.php, method Field::isValid()
isValid: in file lib_search.php, method TableSearcher::isValid()
Checks if the table searcher has valid results. I.e. if any search paramters have been caught by it.
isValid: in file lib_search.php, method SearchField::isValid()
Checks if the search field is valid, meaning if it has has caugth a non empty parameter.
isValid: in file lib_forms.php, method Form::isValid()
isValid: in file lib_forms.php, method Validatable::isValid()
Checks if the object's state is valid or not.

top

l

$lastPerformed: in file lib_events.php, variable TimedEvent::$lastPerformed
The unix timestamp describing the point in time at which the event was last performed.
$lastTimestamp: in file lib_counters.php, variable Counter::$lastTimestamp
The unix timestamp of the last hit that the counter recorded.
$legend: in file lib_forms.php, variable Form::$legend
The legend value that should be used for the form.
$legend: in file lib_forms.php, variable DateField::$legend
The value that should be displayed as legend for the fieldset.
$libraryName: in file lib_events.php, variable TimedEvent::$libraryName
The name of the library that should be included before the event is run and before the callback is called. If it's empty then no library is included.
$linkFormat: in file lib_updates.php, variable UpdateType::$linkFormat
The format that should be used with printf when creating a link to an update that is grouped in this type. The link should assume that it starts in the root path.
$linkId: in file lib_updates.php, variable Update::$linkId
This is an identifier that is used when constructing links to the updated item. It is used in cojunction with the updater type's link format.
$linkIdField: in file lib_updates.php, variable UpdateType::$linkIdField
The field in $tableToListenTo that contains the value to use as link id for resulting updates.
$linkName: in file lib_admin_panel.php, variable UpdateModule::$linkName
The name for the link that should represent the module.
LesserEqualSearch: in file lib_search.php, class LesserEqualSearch
Describes a search field that searches for things that are lesser than or equal to the parameter.
LesserSearch: in file lib_search.php, class LesserSearch
Describes a search field that searches for things that are lesser than the parameter.
LikeSearch: in file lib_search.php, class LikeSearch
Describes a search field that implements LIKE searches.
loadCssValueTree: in file lib_css.php, method CssHandler::loadCssValueTree()
Loads all CSS values into a tree structure. The resulting tree structure reflects the XML resource file, but does not contain the root node.
logActivity: in file lib_admin_panel.php, method AdminModule::logActivity()
Notifies everything that should be notified of admin activity. This function should be called whenever a module alters a table.
logAdminAction: in file lib_admin_panel.php, function logAdminAction()
Adds an entry to the admin log, storing the action for later examination.
logAdminActivity: in file lib_admin_panel.php, function logAdminActivity()
This function is notified whenever a module performs a table altering action. Everything that should be notified of admin activity should hook in here.
logException: in file lib_errors.php, function logException()
Logs an exception, providing information about the current state. The script then continues on.
logFatalException: in file lib_errors.php, function logFatalException()
Logs a fatal exception, providing information about the current state.
lib_abbreviations.php: procedural page lib_abbreviations.php
lib_admin_panel.php: procedural page lib_admin_panel.php
lib_admin.php: procedural page lib_admin.php
lib_articles.php: procedural page lib_articles.php
lib_authors.php: procedural page lib_authors.php
lib_calendar.php: procedural page lib_calendar.php
lib_counters.php: procedural page lib_counters.php
lib_css.php: procedural page lib_css.php
lib_db.php: procedural page lib_db.php
lib_displayer.php: procedural page lib_displayer.php
lib_errors.php: procedural page lib_errors.php
lib_events.php: procedural page lib_events.php
lib_event_digest.php: procedural page lib_event_digest.php
lib_forms.php: procedural page lib_forms.php
lib_images.php: procedural page lib_images.php
lib_menu.php: procedural page lib_menu.php
lib_news.php: procedural page lib_news.php
lib_redirects.php: procedural page lib_redirects.php
lib_search.php: procedural page lib_search.php
lib_tables.php: procedural page lib_tables.php
lib_updates.php: procedural page lib_updates.php
lib_util.php: procedural page lib_util.php

top

m

$method: in file lib_forms.php, variable Form::$method
The method to be used by the form.
$minute: in file lib_forms.php, variable TimeField::$minute
The minute selection field.
$modules: in file lib_admin_panel.php, variable AdminPanel::$modules
Contains all the modules (AdminModule instances) that belong to the panel.
$moduleToListenTo: in file lib_updates.php, variable UpdateType::$moduleToListenTo
The name of the admin module class that the type is listening to. The type triggers on changes made by this module in conjunction with $tableToListenTo.
$month: in file lib_forms.php, variable DateField::$month
The month selection field.
markAsPerformed: in file lib_events.php, method TimedEvent::markAsPerformed()
Marks the event as performed, updating the next time that it should be performed.
MAX_FILE_SIZE: in file lib_images.php, constant MAX_FILE_SIZE
The default maximum file size in kB to allow image to have.
MAX_WIDTH: in file lib_images.php, constant MAX_WIDTH
The default maximum width to allow image to have.
MenuItem: in file lib_menu.php, class MenuItem
Describes an item in a menu. An menu item has a name and are ordered in a tree where all nodes except the root are menu items. An menu item may have any number of children.
MENU_CACHE_PATH: in file lib_menu.php, constant MENU_CACHE_PATH
The path relative to the site's root where the menu cache is located.

top

n

$name: in file lib_authors.php, variable Author::$name
The name of the author.
$name: in file lib_forms.php, variable Field::$name
The name of the field.
$name: in file lib_menu.php, variable MenuItem::$name
The name that describes and is displayed for the menu item.
$newsId: in file lib_news.php, variable Comment::$newsId
The unique identifier of the news item that the comment is attached to.
News: in file lib_news.php, class News
Describes a news item.
NoSuchElementException: in file lib_errors.php, class NoSuchElementException
An exception used when an element that was searched for could not be found.
notifyOfAdminActivity: in file lib_updates.php, method UpdateType::notifyOfAdminActivity()
Notifies the update types that there has been administrative activity.
notifyOfAdminActivity: in file lib_updates.php, function notifyOfAdminActivity()
Notifies all update types that there has been administrative activity. This allows the update types to catch table/module combinations that they are listening to and take the appropriate action.

top

o

$options: in file lib_forms.php, variable Select::$options
The options that should be displayed in the select element. The value as key and the name of the option as value.

top

p

$parameter: in file lib_search.php, variable SearchField::$parameter
The parameter (if any) that has been caught by the search field.
$path: in file lib_menu.php, variable MenuItem::$path
An optional path that the menu item leads to. It's either an aboslute url or one relative to the root path.
$processCallback: in file lib_search.php, variable SearchField::$processCallback
An optional callback that all parameters should be passed through.
Page: in file common.php, class Page
Describes a page that can be displayed. It's the end result of the whole script.
parseCssValueNode: in file lib_css.php, method CssHandler::parseCssValueNode()
Recursivly parses a css value node and turns it into an array structure.
PasswordField: in file lib_forms.php, class PasswordField
Describes a password field.
performEvent: in file lib_events.php, method TimedEvent::performEvent()
Performs the event, correctly processing it and marking it as performed.
performSort: in file lib_tables.php, method Header::performSort()
Performs a sort, if the user has requested one, on the specified rows.
processAdd: in file lib_admin_panel.php, method AddModule::processAdd()
Processes an add request and returns the result or an error message.
processConfirm: in file lib_admin_panel.php, method DeleteModule::processConfirm()
Creates a confirmation dialog.
processEdit: in file lib_admin_panel.php, method EditModule::processEdit()
Processes an edit request and returns the result or an error message.
processRemove: in file lib_admin_panel.php, method DeleteModule::processRemove()
Removes an entry and creates a confirmation message.

top

q

$queryAppandage: in file lib_displayer.php, variable TableDisplayer::$queryAppandage
The appandage to the queries, the appandage specifies what should be displayed. The appandage is placed after 'FROM table'. I.e. to get the query "SELECT * FROM foo WHERE MATCH (title, body) AGAINST ('bar')" one should use "WHERE MATCH (title, body) AGAINST ('foo')".
$queryAppendage: in file lib_admin_panel.php, variable AdminPanel::$queryAppendage
The appendage to the view query. This could for instance be a match statement or a order apppendage.
$queryAppendage: in file lib_search.php, variable TableSearcher::$queryAppendage
An optional query appendage to use when searching. This can be used to specify a specific subset or ordering and is appended on the end of the query.
$queue: in file lib_db.php, variable DB::$queue
Contains any queued queries.
query: in file lib_db.php, method DB::query()
Performs a specified query on the database.
queryCount: in file lib_db.php, method DB::queryCount()
Gets the number of rows that matches specified conditions.
queryDelete: in file lib_db.php, method DB::queryDelete()
Builds and executes a delete query on the specified table using the specified values.
queryInsert: in file lib_db.php, method DB::queryInsert()
Builds and executes an insert query based on the specified table and values.
querySelect: in file lib_db.php, method DB::querySelect()
Selects specific table fields from a specific table. The select operation can also specify an optional sql selector.
querySelectAll: in file lib_db.php, method DB::querySelectAll()
Selects all table fields from a specific table. The select operation can also specify an optional sql selector.
querySelectFirst: in file lib_db.php, method DB::querySelectFirst()
Selects the first value found in a specified field in a specified table that satisfies an sql selector.
queryUpdate: in file lib_db.php, method DB::queryUpdate()
Builds and executes an update query on the specified table using the specified values and selector.
queueQuery: in file lib_db.php, method DB::queueQuery()
Puts a specified query at the end of the queue.

top

r

$requestName: in file lib_search.php, variable SearchField::$requestName
The request index that is connected to this request field. I.e. the index in $_REQUEST that the search field should attempt to catch parameters from.
$requestName: in file lib_admin_panel.php, variable TableField::$requestName
The name used to identify field in $_REQUEST.
$required: in file lib_forms.php, variable Field::$required
If the field has to be entered to be valid.
$rows: in file lib_tables.php, variable Table::$rows
Contains an array which contains an array for each row. The key of the rows should be numeric, the value should be the value that should be displayed.
$rowsPerPage: in file lib_displayer.php, variable AbstractTableDisplayer::$rowsPerPage
The maximum number of rows from the table that each page may display.
ReadOnly: in file lib_forms.php, class ReadOnly
Describes a field that is read only. I.e. just prints the contents of it, not really a field, but it's useful at times.
readRow: in file lib_news.php, method News::readRow()
readRow: in file lib_news.php, method Comment::readRow()
readRow: in file lib_counters.php, method Counter::readRow()
readRow: in file lib_authors.php, method Author::readRow()
readRow: in file common.php, method TableEntry::readRow()
Processes the contents of a retrieved row that describes the entry.
readRow: in file lib_menu.php, method MenuItem::readRow()
readRow: in file lib_updates.php, method UpdateType::readRow()
readRow: in file lib_updates.php, method Update::readRow()
readRow: in file lib_events.php, method TimedEvent::readRow()
readRow: in file lib_articles.php, method Article::readRow()
recordHit: in file lib_counters.php, method Counter::recordHit()
Records that a hit has occured. Increments the counter.
remove: in file lib_tables.php, method Header::remove()
Removes a caption from the header, assuming that the caption exists.
removeField: in file lib_forms.php, method Form::removeField()
Removes the first field encountered with the specified field name.
renameQueryParams: in file lib_util.php, function renameQueryParams()
Renames parameters in a url query string, the values remain unchanged. It can for instance turn "foo=0&bar=hi" into "a=0&b=hi".
replaceCssValues: in file lib_css.php, method CssHandler::replaceCssValues()
Replaces all css values defined by the specified array in the specified text. The values are represented in the css text as $namespace:subcat:value, the subcat may or may not be used, any number of subctegories can be used after the namespace but before the value.
ResetButton: in file lib_forms.php, class ResetButton
Describes a reset button.

top

s

$searcher: in file lib_calendar.php, variable Calendar::$searcher
The table searcher that should be used by the calendar.
$second: in file lib_forms.php, variable TimeField::$second
The second selection field.
$selectQuery: in file lib_displayer.php, variable CustomTableDisplayer::$selectQuery
The SQL query that should be used for selecting all the rows that should be displayed.
$style: in file lib_calendar.php, variable Calendar::$style
The text that should be included in the calendar's style attribute.
CSS_VALUE_FILE_NAME: in file lib_css.php, class constant CssHandler::CSS_VALUE_FILE_NAME
The name of the XML resource file that contains all CSS values.
save: in file lib_counters.php, method Counter::save()
Saves the current information held by the counter. This public function should be concidered private.
SearchField: in file lib_search.php, class SearchField
Describes a field that should be used in a search.
Select: in file lib_forms.php, class Select
Describes a select field.
sendEmail: in file lib_util.php, function sendEmail()
Sends an email with specified contents. Optionally the receiver of the email can be specififed along with the sender.
setAttribute: in file lib_forms.php, method Field::setAttribute()
Sets one of the firleds attributes. If the attribute does not exist then it is created. The attributes 'id', 'name' and 'value' can not be modified throught this function.
setCssClass: in file lib_forms.php, method Form::setCssClass()
Sets the css class to be used by the form element.
setCssClass: in file lib_tables.php, method Table::setCssClass()
Sets the CSS class that the table should use.
setDescription: in file lib_counters.php, method Counter::setDescription()
Sets the counters description to a new value.
setDisplayErrors: in file lib_forms.php, method Form::setDisplayErrors()
Sets if the form should display errors or not (the default is true).
setHeader: in file lib_tables.php, method Table::setHeader()
Sets a specified header as the new header that should be used by the table.
setHeight: in file lib_forms.php, method SizedField::setHeight()
Sets the height of the field.
setId: in file lib_forms.php, method Field::setId()
Sets the field's id.
setItemsPerPage: in file lib_admin_panel.php, method AdminPanel::setItemsPerPage()
Sets the number of items that should be displayed in each page when viewing the table overview.
setParameter: in file lib_search.php, method SearchField::setParameter()
Sets the parameter for the search done by the field to a new value.
setRowMapping: in file lib_tables.php, method Table::setRowMapping()
Sets a row mapping for the table to use. The row map rearranges the values of a row into a different order.
setRowsPerPage: in file lib_displayer.php, method AbstractTableDisplayer::setRowsPerPage()
Sets the number of rows that should be displayed on each page by the displayer.
setSearchParameter: in file lib_search.php, method TableSearcher::setSearchParameter()
Sets the search parameter of all search fields connected to the request name to the specified value.
setTableDisplayer: in file lib_admin_panel.php, method AdminPanel::setTableDisplayer()
Sets a new table displayer that should be used by the panel to view databses with.
setTitle: in file common.php, method Page::setTitle()
Sets the title of the page to a new title.
setValue: in file lib_forms.php, method Field::setValue()
Sets the value of the field.
setValue: in file lib_admin_panel.php, method TableField::setValue()
Sets a new value for the field.
setValue: in file lib_forms.php, method TimeField::setValue()
setValue: in file lib_forms.php, method Form::setValue()
Sets a specified field's value to a new specified value.
setValue: in file lib_forms.php, method DateField::setValue()
setWidth: in file lib_forms.php, method SizedField::setWidth()
Sets the width of the field.
SizedField: in file lib_forms.php, class SizedField
Describes a field that can be sized.
stripCssExtension: in file lib_css.php, method CssHandler::stripCssExtension()
Strips any .css extensions that occur last in a specified text.
stripQueryString: in file lib_redirects.php, function stripQueryString()
Strips an url of any query string (if one exists).
stripRootPath: in file lib_redirects.php, function stripRootPath()
Strips the root path from a specified url.
SubmitButton: in file lib_forms.php, class SubmitButton
Describes a submit button.

top

t

$tabel: in file lib_admin_panel.php, variable AdminPanel::$tabel
The name of the table that the panel should view.
$table: in file lib_calendar.php, variable Calendar::$table
The name of the table that the calendar should display.
$table: in file lib_displayer.php, variable TableDisplayer::$table
The name of the table that the displayer should display from.
$table: in file lib_search.php, variable TableSearcher::$table
The name of the table that the search should be performed on.
$table: in file lib_admin_panel.php, variable EditModule::$table
The name of table that contains the row that should be edited.
$table: in file lib_admin_panel.php, variable UpdateModule::$table
The name of the table which rows should be updated.
$table: in file lib_admin_panel.php, variable AddModule::$table
The name of the table that the module should add rows to.
$table: in file lib_admin_panel.php, variable DetailsModule::$table
The table that should be read from.
$table: in file lib_admin_panel.php, variable DeleteModule::$table
The name of the table that the module should delete rows from.
$tableField: in file lib_search.php, variable SearchField::$tableField
The name of the field in the table.
$tableField: in file lib_admin_panel.php, variable TableField::$tableField
The name of the corresponding field in the table.
$tableHeader: in file lib_tables.php, variable Table::$tableHeader
Contains the header (if any) for the Table.
$tableToListenTo: in file lib_updates.php, variable UpdateType::$tableToListenTo
The name of the table that the type is listening to. The type triggers on changes to this table in conjunction with $moduleToListenTo.
$timeMax: in file lib_forms.php, variable DateField::$timeMax
The highest unix timestamp that the user should allow to select.
$timeMin: in file lib_forms.php, variable DateField::$timeMin
The lowest unix timestamp that the user should allow to select.
$timestamp: in file lib_news.php, variable News::$timestamp
The UNIX timestamp of when the news was submitted.
$timestamp: in file lib_articles.php, variable Article::$timestamp
The unix timestamp for when the article was added.
$timestamp: in file lib_news.php, variable Comment::$timestamp
The time when the comment was made.
$timestamp: in file lib_updates.php, variable Update::$timestamp
The unix timestamp of when the update was generated.
$timestampField: in file lib_calendar.php, variable Calendar::$timestampField
The name of the table field that contains the unix timestamp values.
$title: in file lib_articles.php, variable Article::$title
The title of the article.
$title: in file common.php, variable Page::$title
The title of the page.
Table: in file lib_tables.php, class Table
Describes a Table.
TableDisplayer: in file lib_displayer.php, class TableDisplayer
Describes a table displayer which displays and splits up table contents over several pages. It allows pages to display menu bars so the users can select the desired page which displays a specified number of table rows.
TableEntry: in file common.php, class TableEntry
Describes a table entry in a table where each entry has an unique identifier with a key named 'id'.
TableField: in file lib_admin_panel.php, class TableField
Describes a table field with a connected value in $_REQUEST. The table field tries to capture it's connected value if possible.
TableSearcher: in file lib_search.php, class TableSearcher
Describes a utility that searches tables for rows that satisfy specified conditions. The result of a search can be retrieved directly as rows or as a sql statement describing the conditions.
TABLE_ABBR: in file lib_db.php, constant TABLE_ABBR
Site specific database name constants.
TABLE_ADMIN_LOGS: in file lib_db.php, constant TABLE_ADMIN_LOGS
Site specific database name constants.
TABLE_ALIASES: in file lib_db.php, constant TABLE_ALIASES
Site specific database name constants.
TABLE_ARTICLES: in file lib_db.php, constant TABLE_ARTICLES
Site specific database name constants.
TABLE_AUTHORS: in file lib_db.php, constant TABLE_AUTHORS
Site specific database name constants.
TABLE_COMMENTS: in file lib_db.php, constant TABLE_COMMENTS
Site specific database name constants.
TABLE_COUNTERS: in file lib_db.php, constant TABLE_COUNTERS
Site specific database name constants.
TABLE_CUSTOM_ALIASES: in file lib_db.php, constant TABLE_CUSTOM_ALIASES
Site specific database name constants.
TABLE_CUSTOM_REDIRECTS: in file lib_db.php, constant TABLE_CUSTOM_REDIRECTS
Site specific database name constants.
TABLE_ERRORS: in file lib_db.php, constant TABLE_ERRORS
Site specific database name constants.
TABLE_EVENTS: in file lib_db.php, constant TABLE_EVENTS
Site specific database name constants.
TABLE_ITEMS: in file lib_db.php, constant TABLE_ITEMS
Site specific database name constants.
TABLE_ITEM_STATS: in file lib_db.php, constant TABLE_ITEM_STATS
Site specific database name constants.
TABLE_LOCATIONS: in file lib_db.php, constant TABLE_LOCATIONS
Site specific database name constants.
TABLE_LOCATION_TYPES: in file lib_db.php, constant TABLE_LOCATION_TYPES
Site specific database name constants.
TABLE_MENU: in file lib_db.php, constant TABLE_MENU
Site specific database name constants.
TABLE_NEWS: in file lib_db.php, constant TABLE_NEWS
Site specific database name constants.
TABLE_REDIRECTS: in file lib_db.php, constant TABLE_REDIRECTS
Site specific database name constants.
TABLE_RESOURCES: in file lib_db.php, constant TABLE_RESOURCES
Site specific database name constants.
TABLE_SKILLS: in file lib_db.php, constant TABLE_SKILLS
Site specific database name constants.
TABLE_SKILL_LEVELS: in file lib_db.php, constant TABLE_SKILL_LEVELS
Site specific database name constants.
TABLE_SLOTS: in file lib_db.php, constant TABLE_SLOTS
Site specific database name constants.
TABLE_UPDATES: in file lib_db.php, constant TABLE_UPDATES
Site specific database name constants.
TABLE_UPDATE_TYPES: in file lib_db.php, constant TABLE_UPDATE_TYPES
Site specific database name constants.
TextArea: in file lib_forms.php, class TextArea
Describes a textarea.
TextField: in file lib_forms.php, class TextField
Describes a textfield.
THUMB_SIZE: in file lib_images.php, constant THUMB_SIZE
The default file size in kB that a produced thumbnail image should aim at.
THUMB_WIDTH: in file lib_images.php, constant THUMB_WIDTH
The default width a produced thumbnail image should have.
TimedEvent: in file lib_events.php, class TimedEvent
Describes an event that is schedudled to be run every so often.
TimeField: in file lib_forms.php, class TimeField
Describes a field (or rather a group of fields) that allows the user to select a certain timestamp (year, month, day, hour, minute and second).

top

u

$updateType: in file lib_updates.php, variable Update::$updateType
The unique identifier for the update type that the update belongs to.
$urlRoot: in file lib_calendar.php, variable Calendar::$urlRoot
The root that should be used for all link urls.
Update: in file lib_updates.php, class Update
Describes an update. An update is a manifestation of a change to the site that viewers of the site should be aware of. An update belongs to an UpdateType.
updateMenuCache: in file lib_menu.php, function updateMenuCache()
Updates the cache of the menu. Rebuilds the menu with the currently saved configuration and then rewrites the cache.
UpdateModule: in file lib_admin_panel.php, class UpdateModule
Describes a module that sets specified fields to specified values when requested.
updateProcessedEntry: in file lib_news.php, method News::updateProcessedEntry()
Processes the raw form the the news entry and updates the processed form with the new version. This should be done whenever the entry changes.
UPDATES_CACHE_PATH: in file lib_updates.php, constant UPDATES_CACHE_PATH
The path (from the page root) where the cache of the updates should be kept.
UpdateType: in file lib_updates.php, class UpdateType
Describes an update type. An update type is a group that updates are grouped into. The type decides how updates of its type should be displayed.
updateUpdatesCache: in file lib_updates.php, function updateUpdatesCache()
Rebuilds the update boxes based on the latest information and then writes the result into the chache.
UrlNotFoundException: in file lib_errors.php, class UrlNotFoundException
An exception used when an error occurs as a result of an invalid url being requested.

top

v

$value: in file lib_admin_panel.php, variable TableField::$value
The value of the field (used for different things, e.g. identification).
$value: in file lib_forms.php, variable Field::$value
The value of the field.
Validatable: in file lib_forms.php, class Validatable
Meant as an interface for validatable objects.

top

w

$width: in file lib_forms.php, variable SizedField::$width
The width of the field, 0 means that no width has been set.

top

y

$year: in file lib_forms.php, variable DateField::$year
The year selection field.

top

Documentation generated on Tue, 10 Jan 2006 17:06:15 +0100 by phpDocumentor 1.3.0RC4