Full index

Package indexes

Phpfw

top

$ajax_element: Form::$ajax_element in phpfw.php
$application: Module::$application in phpfw.php
a: View::a() in phpfw.php

Generate a URL link
access: PelWrap::access() in PelWrap.php

Get or set the value of a tag
add_css_class: Form::add_css_class() in phpfw.php

Update CSS class names for the form to be generated by View::create_form()
add_element: View::add_element() in phpfw.php

Function to add an element to process to the View::$template member
add_exception: Controller::add_exception() in phpfw.php

Add a module:action exception
add_link: Form::add_link() in phpfw.php

Add a table link which will be populated when the form is processed
add_module: Controller::add_module() in phpfw.php

Add a module to the controller
add_table: Form::add_table() in phpfw.php

Add a table to be rendered in this form
ajaxify: Form::ajaxify() in phpfw.php

AJAXify the form - submit is performed using AJAX and returned data is added to the element specified
Application: Application in phpfw.php

The main application class
Application: Application::Application() in phpfw.php

Constructor for the Application class
array_combine: array_combine() in phpfw.php
auto_reset_properties: View::auto_reset_properties() in phpfw.php

Set the View::$reset_properties variable

top

b: View::b() in phpfw.php

Bold the View::$data
body: View::body() in phpfw.php

Generate a body tag
br: View::br() in phpfw.php

Add a line break

top

$columns: Table::$columns in phpfw.php
$config: Application::$config in phpfw.php
$config_file: Application::$config_file in phpfw.php
$connection: Sql::$connection in phpfw.php
$connection: MailServer::$connection in MailServer.php
$controller: Module::$controller in phpfw.php
$controller: Application::$controller in phpfw.php
$css_class: Form::$css_class in phpfw.php
$current_mailbox: MailServer::$current_mailbox in MailServer.php
$current_user: MailServer::$current_user in MailServer.php
C: C in phpfw.php

Align center for View::table()
center: View::center() in phpfw.php

Center the View::$data
change_password: Login::change_password() in Login.php
check_configuration_file: Application::check_configuration_file() in phpfw.php

Verify that the configuration file has all required elements declared.
check_configuration_section: Application::check_configuration_section() in phpfw.php

Helper function for check_configuration_file() to check a configuration section.
check_date: Form::check_date() in phpfw.php

Check if an mm-dd-yyyy formatted date is valid
check_duplicate_table: Form::check_duplicate_table() in phpfw.php

Check if added table is already present in $this->tables or $this->links
check_errors: Error::check_errors() in phpfw.php

Check that error file syntax is correct
check_login: Login::check_login() in Login.php

Check if a user is logged in
check_module_action: Controller::check_module_action() in phpfw.php

Checks the module:action syntax and if corresponding class and method exist
check_row_link: Table::check_row_link() in phpfw.php

Check that this table has the specified number of links with the specified tables
check_row_links: Table::check_row_links() in phpfw.php

Check that this table has the specified number of links with the specified tables
check_schema: Database::check_schema() in phpfw.php

Check the schema of the database and make relevant associations.
check_time: Form::check_time() in phpfw.php

Check that time entered is hh:mm value
clear_properties: View::clear_properties() in phpfw.php

Clear the View::$properties member
Column: Column in phpfw.php

The Column class contains information on a table column
Column: Column::Column() in phpfw.php

Constructor for the Column class
compile_template: View::compile_template() in phpfw.php

Compile the template using the commands in View::$template
Config: Config in Config.php

Load and save configuration files
connect: MailServer::connect() in MailServer.php

Connect to the server in a half-open mode (don't select any mailbox)
Controller: Controller in phpfw.php

The Controller class loads all modules and executes requested action
Controller: Controller::Controller() in phpfw.php

Constructor for the Controller class
convert_date: Form::convert_date() in phpfw.php

This function converts a date of format yyyy-mm-dd to mm-dd-yyyy and vice versa
copy_messages: MailServer::copy_messages() in MailServer.php

Copy the specified messages to the specified mailbox
create_form: Form::create_form() in phpfw.php

Create the form based on the specified tables and table_ids.
create_mailbox: MailServer::create_mailbox() in MailServer.php

Create the specified mailbox
Config.php: Config.php in Config.php

top

$data: View::$data in phpfw.php
$data: Form::$data in phpfw.php
$database: Application::$database in phpfw.php
$database: Module::$database in phpfw.php
$default: Controller::$default in phpfw.php
$dictionary: Sql::$dictionary in phpfw.php
DATA: DATA in phpfw.php

Type for Table: DATA
Database: Database in phpfw.php

The Database class contains information about the specified database
Database: Database::Database() in phpfw.php

Constructor for the Database class
DATE_ADDED: DATE_ADDED in phpfw.php

Name of date_added field
DATE_FORMAT: DATE_FORMAT in phpfw.php

Format for the date() command
DATE_UPDATED: DATE_UPDATED in phpfw.php

Name of date_updated field
decode_url: Controller::decode_url() in phpfw.php

Decode a query string sent by the browser.
delete_link_table_row: Table::delete_link_table_row() in phpfw.php

Delete a specific row from this table - for link tables
delete_mailbox: MailServer::delete_mailbox() in MailServer.php

Delete the specified mailbox
delete_messages: MailServer::delete_messages() in MailServer.php

Delete specified messages
delete_table_row: Table::delete_table_row() in phpfw.php

Delete a specific row from this table - for data tables
delete_table_row_and_links: Table::delete_table_row_and_links() in phpfw.php

Delete a specific row and all links to other tables
delete_table_row_and_link_rows: Table::delete_table_row_and_link_rows() in phpfw.php

Delete a specific row and all linked rows for this table
delete_table_row_links: Table::delete_table_row_links() in phpfw.php

Delete all link table entries for the table id mentioned
delete_table_row_link_rows: Table::delete_table_row_link_rows() in phpfw.php

Delete all links for a table - for data tables
disable_render: Module::disable_render() in phpfw.php

Prevent the Module::render() function from running.
disable_template_library: Module::disable_template_library() in phpfw.php

Disable usage of the template library to render the output of the module.
disable_view: Module::disable_view() in phpfw.php

Disable the View object usage in Module::render().
disconnect: MailServer::disconnect() in MailServer.php

Disconnect from the current server if connected
display_error: Error::display_error() in phpfw.php

Display the specified error message
display_error: Application::display_error() in phpfw.php

Display an error message - this is used by the Application before the Error class is loaded
div: View::div() in phpfw.php

Generate a div

top

$error: Application::$error in phpfw.php
$error: Module::$error in phpfw.php
$error_strings: Module::$error_strings in phpfw.php
$error_strings: Error::$error_strings in phpfw.php
$exceptions: Module::$exceptions in phpfw.php
$exceptions: Controller::$exceptions in phpfw.php
$external_name: Table::$external_name in phpfw.php
$external_name: Column::$external_name in phpfw.php
Email: Email in Email.php

Send an HTML and/or text email
enable_render: Module::enable_render() in phpfw.php

Enable the Module::render() function.
enable_template_library: Module::enable_template_library() in phpfw.php

Enable usage of the template library to render the output of the module.
enable_view: Module::enable_view() in phpfw.php

Enable the View object usage in Module::render().
encode_ajax_url: Controller::encode_ajax_url() in phpfw.php

Encode an ajax query string to be sent to the browser
encode_url: Controller::encode_url() in phpfw.php

Encode a query string to be sent to the browser.
Error: Error::Error() in phpfw.php

Constructor for the Error class
Error: Error in phpfw.php

The Error class stores error strings and displays them as needed.
execute: Controller::execute() in phpfw.php

Execute the module:action specified, or select default action
execute_query: Sql::execute_query() in phpfw.php

Execute a query on this Sql connection.
exec_module_action: Module::exec_module_action() in phpfw.php

Execute another loaded module's action
expunge: MailServer::expunge() in MailServer.php

Expunge currently selected mailbox
Email.php: Email.php in Email.php

top

$file: Login::$file in Login.php
font: View::font() in phpfw.php

Enclosure View::$data in a font tag
form: View::form() in phpfw.php

Generate a form element
Form: Form::Form() in phpfw.php

Constructor for the Form class
Form: Form in phpfw.php

The Form class creates and processes HTML forms.

top

generate_tag: View::generate_tag() in phpfw.php

Format the View::$data - called by b(), u(), etc. Can be called directly with the tag name. A wrapper for the tag() function.
get_all_messages: MailServer::get_all_messages() in MailServer.php

Get all the message headers for the current mailbox
get_column_by_name: Table::get_column_by_name() in phpfw.php

Get a column object by name
get_configuration: MailServer::get_configuration() in MailServer.php

Get the configuration from config file
get_configuration: Login::get_configuration() in Login.php

Get the configuration from the config file
get_configuration: PelWrap::get_configuration() in PelWrap.php

Get the configuration from the config file
get_data: View::get_data() in phpfw.php

Return the value of $data
get_data: Form::get_data() in phpfw.php

Get the form data
get_error_strings: Module::get_error_strings() in phpfw.php

Get the error strings registered by the Module
get_exceptions: Module::get_exceptions() in phpfw.php

Get the exceptions registered by the Module
get_external_name: Table::get_external_name() in phpfw.php

Get the external table name
get_external_name: Column::get_external_name() in phpfw.php

Get the external column name
get_is_autoincrement: Column::get_is_autoincrement() in phpfw.php

Get is_autoincrement
get_is_key: Column::get_is_key() in phpfw.php

Get is_key
get_is_required: Column::get_is_required() in phpfw.php

Get is_required
get_last_inserted_id: Sql::get_last_inserted_id() in phpfw.php

Get the ID of the last inserted value
get_linked_to: Table::get_linked_to() in phpfw.php

Get the $links array
get_mailboxes: MailServer::get_mailboxes() in MailServer.php

Get all mailboxes for current connection
get_mailbox_status: MailServer::get_mailbox_status() in MailServer.php

Get the status information for the specified mailbox
get_message_parts: MailServer::get_message_parts() in MailServer.php
get_mobile_browser: Controller::get_mobile_browser() in phpfw.php

Set the remote browser type.
get_name: Column::get_name() in phpfw.php

Get the column name
get_name: Table::get_name() in phpfw.php

Get the table name
get_queries: Module::get_queries() in phpfw.php

Get the queries registered by the Module
get_raw_headers: MailServer::get_raw_headers() in MailServer.php

Get the raw headers for the specified message uid
get_schema: Database::get_schema() in phpfw.php

Get the schema for this database
get_size: Column::get_size() in phpfw.php

Get the column size
get_subscribed_mailboxes: MailServer::get_subscribed_mailboxes() in MailServer.php

Get only subscribed mailboxes for current connection
get_table_by_name: Database::get_table_by_name() in phpfw.php

Returns a Table object by its name
get_table_row: Table::get_table_row() in phpfw.php

Get a specific row from this table
get_table_rows: Table::get_table_rows() in phpfw.php

Get all the rows in this table
get_table_rows_with_actions: Table::get_table_rows_with_actions() in phpfw.php

Get all the rows in this table with the action field
get_table_row_and_link_rows_for_view: Table::get_table_row_and_link_rows_for_view() in phpfw.php

Get specific row and all linked rows from this table - formatted for View::table_two_column_associative()
get_table_row_for_view: Table::get_table_row_for_view() in phpfw.php

Get a specific row from this table - formatted for View::table_two_column_associative()
get_table_row_links: Table::get_table_row_links() in phpfw.php

Get links to a table row.
get_table_row_links_with_actions: Table::get_table_row_links_with_actions() in phpfw.php

Get all the link rows with the action field for the specified ID in this table
get_table_row_link_rows_for_view: Table::get_table_row_link_rows_for_view() in phpfw.php

Get all linked rows for a specific row from this table - formatted for View::table_two_column_associative()
get_templating_library_paths: Module::get_templating_library_paths() in phpfw.php

Get templating library paths
get_type: Column::get_type() in phpfw.php

Get the column type
get_type: Table::get_type() in phpfw.php

Get the table type
get_unique_blank_key: View::get_unique_blank_key() in phpfw.php

Generate a unique blank string key for the $data array
get_values: Column::get_values() in phpfw.php

Get the column values (for enumeration)
generate.php: generate.php in generate.php

top

h1: View::h1() in phpfw.php

Enclose View::$data in a header 1
h2: View::h2() in phpfw.php

Enclose View::$data in a header 2
h3: View::h3() in phpfw.php

Enclose View::$data in a header 3
head: View::head() in phpfw.php

Generate a head tag
header: View::header() in phpfw.php

Generate the header HTML around the main code
hr: View::hr() in phpfw.php

Add a horizontal line
html: View::html() in phpfw.php

Generate a html tag

top

$is_autoincrement: Column::$is_autoincrement in phpfw.php
$is_key: Column::$is_key in phpfw.php
$is_mobile_browser: Controller::$is_mobile_browser in phpfw.php
$is_required: Column::$is_required in phpfw.php
i: View::i() in phpfw.php

Italicize the View::$data
img: View::img() in phpfw.php

Generate an image tag
index.php: index.php in index.php
initialize: Module::initialize() in phpfw.php

Reset the Module::$output
input: View::input() in phpfw.php

Generic input element function - called internally
input_button: View::input_button() in phpfw.php

Generate a generic button
input_cancel: View::input_cancel() in phpfw.php

Generate a cancel button which goes back to the previous page using history.back()
input_file: View::input_file() in phpfw.php

Generate a file input element
input_hidden: View::input_hidden() in phpfw.php

Create a hidden input element
input_password: View::input_password() in phpfw.php

Generate a password input text box
input_submit: View::input_submit() in phpfw.php

Generate a submit button
input_text: View::input_text() in phpfw.php

Generate an input text box
isset_and_non_empty: isset_and_non_empty() in phpfw.php

top

$key_field: Login::$key_field in Login.php

top

$links: Table::$links in phpfw.php
$links: Form::$links in phpfw.php
$link_ids: Form::$link_ids in phpfw.php
L: L in phpfw.php

Align left for View::table()
label: View::label() in phpfw.php

Create a label for an input element
link: View::link() in phpfw.php

Generate a link to stylesheet
LINK: LINK in phpfw.php

Type for Table: LINK
load_include_files: Application::load_include_files() in phpfw.php

Load all include files - scripts and stylesheets
load_schema_from_file: Database::load_schema_from_file() in phpfw.php

Load the schema into the database
Login: Login::Login() in Login.php

Constructor for Login module
Login: Login in Login.php

The Login Module
login_user: Login::login_user() in Login.php

Login the user
login_user_form: Login::login_user_form() in Login.php

Display login form
logout_user: Login::logout_user() in Login.php

Log out the current user. This is done by deleting the session
Login.php: Login.php in Login.php

top

$mode: Login::$mode in Login.php
$modules: Controller::$modules in phpfw.php
MailServer: MailServer::MailServer() in MailServer.php

Constructor for the email server module
MailServer: MailServer in MailServer.php

The MailServer Module
mark_messages_as_read: MailServer::mark_messages_as_read() in MailServer.php

Mark specified messages as read
mark_messages_as_unread: MailServer::mark_messages_as_unread() in MailServer.php

Mark specified messages as unread
merge_properties: View::merge_properties() in phpfw.php

Merge specified array with View::$properties array
Module: Module in phpfw.php

The Module class - all modules are to extend this class
MailServer.php: MailServer.php in MailServer.php
move_messages: MailServer::move_messages() in MailServer.php

Move the specified messages to the specified mailbox

top

$name: Table::$name in phpfw.php
$name: Database::$name in phpfw.php
$name: Column::$name in phpfw.php
nl: View::nl() in phpfw.php

Add a new line
to View::$data

top

$output: Module::$output in phpfw.php
open: PelWrap::open() in PelWrap.php

Open an image using PEL
open_mailbox: MailServer::open_mailbox() in MailServer.php

Open the specified mailbox
options: View::options() in phpfw.php

Generate an options list for <select>

top

$pass_field: Login::$pass_field in Login.php
$path: PelWrap::$path in PelWrap.php
$primary_key: Table::$primary_key in phpfw.php
$properties: View::$properties in phpfw.php
PelWrap.php: PelWrap.php in PelWrap.php
p: View::p() in phpfw.php

Enclosure View::$data in a paragraph
PelWrap: PelWrap::PelWrap() in PelWrap.php

Constructor for the Pel module
PelWrap: PelWrap in PelWrap.php

Wrapper for the PEL library
phpfw.php: phpfw.php in phpfw.php
PHPTAL_render: Module::PHPTAL_render() in phpfw.php

Render the module output using PHPTAL
pop: View::pop() in phpfw.php

Pop the last pushed data in View::$saved to View::$data
pop_append: View::pop_append() in phpfw.php

Pop the last pushed data in View::$saved and append to View::$data
pop_prepend: View::pop_prepend() in phpfw.php

Pop the last pushed data in View::$saved and prepend to View::$data
process_form: Form::process_form() in phpfw.php

Process a submitted form.
process_sql_options: Table::process_sql_options() in phpfw.php

Helper function to concatenate options to the SQL syntax, internal function, do not use
push: View::push() in phpfw.php

Push the contents of View::$data to View::$saved

top

$queries: Sql::$queries in phpfw.php
$queries: Module::$queries in phpfw.php

top

$reset_properties: View::$reset_properties in phpfw.php
R: R in phpfw.php

Align right for View::table()
read_ini_file: Config::read_ini_file() in Config.php

This method reads configuration values in the specified filename.
register: MailServer::register() in MailServer.php

Register all error messages
register_error: Module::register_error() in phpfw.php

Register a module error string
register_exception: Module::register_exception() in phpfw.php

Register a module exception
register_query: Module::register_query() in phpfw.php

Register a module SQL query
rename_mailbox: MailServer::rename_mailbox() in MailServer.php

Rename the specified mailbox as requested
render: View::render() in phpfw.php

Print the $data HTML result
render: Module::render() in phpfw.php

Render the module HTML output
reset_data: View::reset_data() in phpfw.php

Reset the value of $data to 0.

top

$saved: View::$saved in phpfw.php
$scripts: Application::$scripts in phpfw.php
$server_config: MailServer::$server_config in MailServer.php
$size: Column::$size in phpfw.php
$special_tags: View::$special_tags in phpfw.php
$sql: Module::$sql in phpfw.php
$sql: Database::$sql in phpfw.php
$stylesheets: Application::$stylesheets in phpfw.php
script: View::script() in phpfw.php

Generate a script file header
select: View::select() in phpfw.php

Generate a select element
select_query: Sql::select_query() in phpfw.php

Perform a select query
send_HTML_email: Email::send_HTML_email() in Email.php

Construct the email headers and send email using mail()
setup: PelWrap::setup() in PelWrap.php

Setup the Pel module
set_data: View::set_data() in phpfw.php

Set the value of $data to a new value
set_default: Controller::set_default() in phpfw.php

Set a default module:action to execute when none is specified
set_is_autoincrement: Column::set_is_autoincrement() in phpfw.php

Set is_autoincrement
set_is_key: Column::set_is_key() in phpfw.php

Set is_key
set_is_required: Column::set_is_required() in phpfw.php

Set is_required
set_properties: View::set_properties() in phpfw.php

Set the value of $properties to a new value
set_references: Module::set_references() in phpfw.php

Set the references to the application objects
set_size: Column::set_size() in phpfw.php

Set the column size
set_template_file: Module::set_template_file() in phpfw.php

Set a custom template file if using a templating library
set_type: Column::set_type() in phpfw.php

Set the column type
set_type: Table::set_type() in phpfw.php

Set the table type
set_values: Column::set_values() in phpfw.php

Set the column values (for enumeration)
Smarty_render: Module::Smarty_render() in phpfw.php

Render the module output using Smarty
sp: View::sp() in phpfw.php

Add a space to View::$data
Sql: Sql in phpfw.php

The Sql class is a wrapper for the ADOdb or ADOdb Lite library.
Sql: Sql::Sql() in phpfw.php

Constructor for the Sql class
subscribe_mailbox: MailServer::subscribe_mailbox() in MailServer.php

Subscribe to the specified mailbox

top

$table: Login::$table in Login.php
$tables: Form::$tables in phpfw.php
$tables: Database::$tables in phpfw.php
$table_ids: Form::$table_ids in phpfw.php
$template: View::$template in phpfw.php
$template_file: Module::$template_file in phpfw.php
$type: Login::$type in Login.php
$type: Table::$type in phpfw.php
$type: Column::$type in phpfw.php
table: View::table() in phpfw.php

Display a table with multiple rows and columns
Table: Table::Table() in phpfw.php

Constructor for the Table class
Table: Table in phpfw.php

The Table class contains information about a table
table_two_column_associative: View::table_two_column_associative() in phpfw.php

Displays table of following format:
tag: View::tag() in phpfw.php

Print an HTML tag with the supplied properties and inner HTML
test_update: Sql::test_update() in phpfw.php

Check if an insert, update or delete succeeded
text_area: View::text_area() in phpfw.php

Generate a text area element

top

$user_field: Login::$user_field in Login.php
$use_render: Module::$use_render in phpfw.php
$use_template_library: Module::$use_template_library in phpfw.php
$use_view: Module::$use_view in phpfw.php
u: View::u() in phpfw.php

Underline the View::$data
undelete_messages: MailServer::undelete_messages() in MailServer.php

Undelete specified messages
unsubscribe_mailbox: MailServer::unsubscribe_mailbox() in MailServer.php

Unsubscribe from the specified mailbox
update: PelWrap::update() in PelWrap.php

Update an image file
update_form: Form::update_form() in phpfw.php

Create a form to update a table row and all its linked rows
update_login: Login::update_login() in Login.php
update_query: Sql::update_query() in phpfw.php

Perform an insert, update or delete query

top

$values: Column::$values in phpfw.php
View: View::View() in phpfw.php

Constructor for the View class
View: View in phpfw.php

The View class generates HTML output

top

write_ini_file: Config::write_ini_file() in Config.php

This method writes the configuration values specified to the filename.