## Full index

### Package indexes

- PhorumDBLayer

d
top

DB_CLOSE_CONN
  DB_CLOSE_CONN in mysql.php
  Function call parameter $return for phorum_db_interact().
DB_DUPFIELDNAMEOK
  DB_DUPFIELDNAMEOK in mysql.php
  Constant for the phorum_db_interact() function call $flags parameter.
DB_DUPKEYNAMEOK
  DB_DUPKEYNAMEOK in mysql.php
  Constant for the phorum_db_interact() function call $flags parameter.
DB_DUPKEYOK
  DB_DUPKEYOK in mysql.php
  Constant for the phorum_db_interact() function call $flags parameter.
DB_GLOBALQUERY
  DB_GLOBALQUERY in mysql.php
  Constant for the phorum_db_interact() function call $flags parameter.
DB_MASTERQUERY
  DB_MASTERQUERY in mysql.php
  Constant for the phorum_db_interact() function call $flags parameter.
DB_MISSINGTABLEOK
  DB_MISSINGTABLEOK in mysql.php
  Constant for the phorum_db_interact() function call $flags parameter.
DB_NOCONNECTOK
  DB_NOCONNECTOK in mysql.php
  Constant for the phorum_db_interact() function call $flags parameter.
DB_RETURN_ASSOC
  DB_RETURN_ASSOC in mysql.php
  Function call parameter $return for phorum_db_interact().
DB_RETURN_ASSOCS
  DB_RETURN_ASSOCS in mysql.php
  Function call parameter $return for phorum_db_interact().
DB_RETURN_CONN
  DB_RETURN_CONN in mysql.php
  Function call parameter $return for phorum_db_interact().
DB_RETURN_ERROR
  DB_RETURN_ERROR in mysql.php
  Function call parameter $return for phorum_db_interact().
DB_RETURN_NEWID
  DB_RETURN_NEWID in mysql.php
  Function call parameter $return for phorum_db_interact().
DB_RETURN_QUOTED
  DB_RETURN_QUOTED in mysql.php
  Function call parameter $return for phorum_db_interact().
DB_RETURN_RES
  DB_RETURN_RES in mysql.php
  Function call parameter $return for phorum_db_interact().
DB_RETURN_ROW
  DB_RETURN_ROW in mysql.php
  Function call parameter $return for phorum_db_interact().
DB_RETURN_ROWCOUNT
  DB_RETURN_ROWCOUNT in mysql.php
  Function call parameter $return for phorum_db_interact().
DB_RETURN_ROWS
  DB_RETURN_ROWS in mysql.php
  Function call parameter $return for phorum_db_interact().
DB_RETURN_VALUE
  DB_RETURN_VALUE in mysql.php
  Function call parameter $return for phorum_db_interact().
DB_TABLEEXISTSOK
  DB_TABLEEXISTSOK in mysql.php
  Constant for the phorum_db_interact() function call $flags parameter.

l
top

LIST_RECENT_MESSAGES
  LIST_RECENT_MESSAGES in mysql.php
  Constant for the phorum_db_get_recent_messages() function call $list_type parameter.
LIST_RECENT_THREADS
  LIST_RECENT_THREADS in mysql.php
  Constant for the phorum_db_get_recent_messages() function call $list_type parameter.
LIST_UPDATED_THREADS
  LIST_UPDATED_THREADS in mysql.php
  Constant for the phorum_db_get_recent_messages() function call $list_type parameter.

m
top

mysql.php
  mysql.php in mysql.php

p
top

phorum_db_add_forum
  phorum_db_add_forum() in mysql.php
  Create a forum.
phorum_db_add_group
  phorum_db_add_group() in mysql.php
  Add a group. This will merely create the group in the database. For changing settings for the group, the function phorum_db_update_group() has to be used.
phorum_db_add_message_edit
  phorum_db_add_message_edit() in mysql.php
  Add a message-edit item
phorum_db_check_connection
  phorum_db_check_connection() in mysql.php
phorum_db_close_connection
  phorum_db_close_connection() in mysql.php
  Close the database connection.
phorum_db_close_thread
  phorum_db_close_thread() in mysql.php
  Close a thread for posting.
phorum_db_create_tables
  phorum_db_create_tables() in mysql.php
  Create the tables that are needed in the database. This function will only be called at install time. After installation, changes in the database schema will be handled by the database upgrade system.
phorum_db_delete_group
  phorum_db_delete_group() in mysql.php
  Delete a group.
phorum_db_delete_message
  phorum_db_delete_message() in mysql.php
  Delete a message or a message tree from the database.
phorum_db_del_banitem
  phorum_db_del_banitem() in mysql.php
  Delete a single ban item from the ban lists.
phorum_db_drop_folder
  phorum_db_drop_folder() in mysql.php
  Drop a forum folder. If the folder contains child forums or folders, then the parent_id for those will be updated to point to the parent of the folder that is being dropped.
phorum_db_drop_forum
  phorum_db_drop_forum() in mysql.php
  Drop a forum and all of its messages.
phorum_db_file_delete
  phorum_db_file_delete() in mysql.php
  Delete a file.
phorum_db_file_get
  phorum_db_file_get() in mysql.php
  Retrieve a file.
phorum_db_file_link
  phorum_db_file_link() in mysql.php
  Update the message to which a file is linked and/or the link type.
phorum_db_file_save
  phorum_db_file_save() in mysql.php
  Add or updates a file.
phorum_db_get_banitem
  phorum_db_get_banitem() in mysql.php
  Retrieve a single ban item from the ban lists.
phorum_db_get_banlists
  phorum_db_get_banlists() in mysql.php
  Retrieve the ban lists for the active forum.
phorum_db_get_file_list
  phorum_db_get_file_list() in mysql.php
  Retrieve a list of files from the database.
phorum_db_get_forums
  phorum_db_get_forums() in mysql.php
  Retrieve a list of forums. The forums which are returned can be filtered through the function parameters. Note that only one parameter is effective at a time.
phorum_db_get_groups
  phorum_db_get_groups() in mysql.php
  Retrieve all groups or one specific group.
phorum_db_get_group_members
  phorum_db_get_group_members() in mysql.php
  Retrieve a list of members for a group or for a list of groups.
phorum_db_get_max_messageid
  phorum_db_get_max_messageid() in mysql.php
  Retrieve the maximum message_id in the database.
phorum_db_get_message
  phorum_db_get_message() in mysql.php
  Retrieve message(s) from the messages table by comparing value(s) for a specified field in that table.
phorum_db_get_messages
  phorum_db_get_messages() in mysql.php
  Retrieve messages from a specific thread.
phorum_db_get_messagetree
  phorum_db_get_messagetree() in mysql.php
  Build a tree of all child (reply) messages below a message_id.
phorum_db_get_message_edits
  phorum_db_get_message_edits() in mysql.php
  Retrieve a list of message-edits for a message
phorum_db_get_message_file_list
  phorum_db_get_message_file_list() in mysql.php
  Retrieve a list of files for a message (a.k.a. attachments).
phorum_db_get_message_index
  phorum_db_get_message_index() in mysql.php
  Retrieve the index of a message (the offset from the thread starter message) within a thread.
phorum_db_get_neighbour_thread
  phorum_db_get_neighbour_thread() in mysql.php
  Retrieve the closest neighbour thread. What "neighbour" is, depends on the
phorum_db_get_recent_messages
  phorum_db_get_recent_messages() in mysql.php
  Retrieve a list of recent messages for all forums for which the user has read permission, for a particular forum, for a list of forums or for a particular thread. Optionally, only top level thread messages can be retrieved.
phorum_db_get_thread_list
  phorum_db_get_thread_list() in mysql.php
  Retrieve a list of visible messages for a given page offset.
phorum_db_get_unapproved_list
  phorum_db_get_unapproved_list() in mysql.php
  Retrieve a list of messages which have not yet been approved by a moderator.
phorum_db_get_user_filesize_total
  phorum_db_get_user_filesize_total() in mysql.php
  Retrieve the total size for all personal files for a user.
phorum_db_get_user_file_list
  phorum_db_get_user_file_list() in mysql.php
  Retrieve a list of personal files for a user.
phorum_db_increment_viewcount
  phorum_db_increment_viewcount() in mysql.php
  Increment the viewcount field for a post.
phorum_db_list_stale_files
  phorum_db_list_stale_files() in mysql.php
  Retrieve a list of stale files from the database.
phorum_db_load_settings
  phorum_db_load_settings() in mysql.php
  Load the Phorum settings in the $PHORUM array.
phorum_db_maxpacketsize
  phorum_db_maxpacketsize() in mysql.php
  This function is used by the sanity checking system in the admin interface to determine how much data can be transferred in one query.
phorum_db_metaquery_compile
  phorum_db_metaquery_compile() in mysql.php
  Translates a message searching meta query into a real SQL WHERE statement for this database backend. The meta query can be used to define extended SQL queries, based on a meta description of the search that has to be performed on the database.
phorum_db_metaquery_messagesearch
  phorum_db_metaquery_messagesearch() in mysql.php
  Run a search on the messages, using a metaquery. See the documentation for the phorum_db_metaquery_compile() function for more info on the metaquery syntax.
phorum_db_mod_banlists
  phorum_db_mod_banlists() in mysql.php
  Add or modify a single ban list item.
phorum_db_move_thread
  phorum_db_move_thread() in mysql.php
  Move a thread to another forum.
phorum_db_mysql_connect
  phorum_db_mysql_connect() in mysql.php
  A wrapper function for connecting to the database.
phorum_db_newflag_add_read
  phorum_db_newflag_add_read() in mysql.php
  Mark a message as read for the active Phorum user.
phorum_db_newflag_allread
  phorum_db_newflag_allread() in mysql.php
  Mark all messages for a forum read for the active Phorum user.
phorum_db_newflag_check
  phorum_db_newflag_check() in mysql.php
  Checks if there are new messages in the forums given in forum_ids
phorum_db_newflag_count
  phorum_db_newflag_count() in mysql.php
  Gets a count of new messages and threads for the forum ids given
phorum_db_newflag_delete
  phorum_db_newflag_delete() in mysql.php
  Remove newflags for a forum for the active Phorum user.
phorum_db_newflag_get_count
  phorum_db_newflag_get_count() in mysql.php
  Retrieve the total number of newflags for a forum for the active Phorum user.
phorum_db_newflag_get_flags
  phorum_db_newflag_get_flags() in mysql.php
  Retrieve the read messages for a forum for the active Phorum user.
phorum_db_newflag_get_unread_count
  phorum_db_newflag_get_unread_count() in mysql.php
  Retrieve the number of new threads and messages for a forum for the active Phorum user.
phorum_db_newflag_update_forum
  phorum_db_newflag_update_forum() in mysql.php
  Update the forum_id for the newflags. The newsflags are updated by setting their forum_ids to the forum_ids of the referenced message table records.
phorum_db_pm_buddy_add
  phorum_db_pm_buddy_add() in mysql.php
  Add a buddy for a user.
phorum_db_pm_buddy_delete
  phorum_db_pm_buddy_delete() in mysql.php
  Delete a buddy for a user.
phorum_db_pm_buddy_list
  phorum_db_pm_buddy_list() in mysql.php
  Retrieve a list of buddies for a user.
phorum_db_pm_checknew
  phorum_db_pm_checknew() in mysql.php
  Check if the user has any new private messages. This is useful in case you only want to know whether the user has new messages or not and when you are not interested in the exact amount of new messages.
phorum_db_pm_create_folder
  phorum_db_pm_create_folder() in mysql.php
  Create a new private messages folder for a user.
phorum_db_pm_delete
  phorum_db_pm_delete() in mysql.php
  Delete a private message from a folder.
phorum_db_pm_delete_folder
  phorum_db_pm_delete_folder() in mysql.php
  Delete a private message folder for a user. Along with the folder, all contained messages are deleted as well.
phorum_db_pm_get
  phorum_db_pm_get() in mysql.php
  Retrieve a private message from the database.
phorum_db_pm_getfolders
  phorum_db_pm_getfolders() in mysql.php
  Retrieve a list of private message folders for a user.
phorum_db_pm_is_buddy
  phorum_db_pm_is_buddy() in mysql.php
  Check if a user is buddy of another user.
phorum_db_pm_list
  phorum_db_pm_list() in mysql.php
  Retrieve all private messages for a user in a folder.
phorum_db_pm_messagecount
  phorum_db_pm_messagecount() in mysql.php
  Compute the total number of private messages a user has and return both the total number of messages and the number of unread messages.
phorum_db_pm_move
  phorum_db_pm_move() in mysql.php
  Move a private message to a different folder.
phorum_db_pm_rename_folder
  phorum_db_pm_rename_folder() in mysql.php
  Rename a private message folder for a user.
phorum_db_pm_send
  phorum_db_pm_send() in mysql.php
  Send a private message.
phorum_db_pm_setflag
  phorum_db_pm_setflag() in mysql.php
  Update a flag for a private message.
phorum_db_pm_update_message_info
  phorum_db_pm_update_message_info() in mysql.php
  Update the meta information for a message.
phorum_db_post_message
  phorum_db_post_message() in mysql.php
  Store a new message in the database.
phorum_db_rebuild_search_data
  phorum_db_rebuild_search_data() in mysql.php
  Rebuild the search table data from scratch.
phorum_db_rebuild_user_posts
  phorum_db_rebuild_user_posts() in mysql.php
  Rebuild the user post counts from scratch.
phorum_db_reopen_thread
  phorum_db_reopen_thread() in mysql.php
  (Re)open a thread for posting.
phorum_db_run_queries
  phorum_db_run_queries() in mysql.php
  Execute an array of queries.
phorum_db_sanitize_mixed
  phorum_db_sanitize_mixed() in mysql.php
  This function will sanitize a mixed variable based on a given type for safe use in SQL queries.
phorum_db_sanitychecks
  phorum_db_sanitychecks() in mysql.php
  This function is used by the sanity checking system to let the database layer do sanity checks of its own. This function can be used by every database layer to implement specific checks.
phorum_db_search
  phorum_db_search() in mysql.php
  Search the database using the provided search criteria and return an array containing the total count of matches and the visible messages based on the page $offset and $length.
phorum_db_sort_groups
  phorum_db_sort_groups() in mysql.php
phorum_db_split_thread
  phorum_db_split_thread() in mysql.php
  Split a thread.
phorum_db_update_forum
  phorum_db_update_forum() in mysql.php
  Update the settings for one or more forums.
phorum_db_update_forum_stats
  phorum_db_update_forum_stats() in mysql.php
  Update the forums stats. This function will update the thread count, message count, sticky message count and last post timestamp for a forum.
phorum_db_update_group
  phorum_db_update_group() in mysql.php
  Update the settings for a group.
phorum_db_update_message
  phorum_db_update_message() in mysql.php
  Update a message in the database.
phorum_db_update_settings
  phorum_db_update_settings() in mysql.php
  Store or update Phorum settings.
phorum_db_user_add
  phorum_db_user_add() in mysql.php
  Add a user.
phorum_db_user_check_login
  phorum_db_user_check_login() in mysql.php
  Check if a user's authentication credentials are correct.
phorum_db_user_count
  phorum_db_user_count() in mysql.php
  Count the total number of users in the Phorum system.
phorum_db_user_delete
  phorum_db_user_delete() in mysql.php
  Delete a user completely. Messages that were posted by the user in the
phorum_db_user_display_name_updates
  phorum_db_user_display_name_updates() in mysql.php
  Run the updates that are needed after changing the display_name for a user.
phorum_db_user_get
  phorum_db_user_get() in mysql.php
  Retrieve one or more users.
phorum_db_user_get_all
  phorum_db_user_get_all() in mysql.php
  Retrieve all users from the database.
phorum_db_user_get_fields
  phorum_db_user_get_fields() in mysql.php
  Retrieve the data for a couple of user table fields for one or more users.
phorum_db_user_get_groups
  phorum_db_user_get_groups() in mysql.php
  Retrieve a list of group memberships and their statuses for a user.
phorum_db_user_get_list
  phorum_db_user_get_list() in mysql.php
  Retrieve a list of all users for a given type.
phorum_db_user_get_moderators
  phorum_db_user_get_moderators() in mysql.php
  Retrieve a list of moderators for a particular forum.
phorum_db_user_get_subscription
  phorum_db_user_get_subscription() in mysql.php
  Retrieve the subscription of a user for a thread.
phorum_db_user_get_unapproved
  phorum_db_user_get_unapproved() in mysql.php
  Retrieve the users that await signup approval.
phorum_db_user_increment_posts
  phorum_db_user_increment_posts() in mysql.php
  Increment the posts counter for a user.
phorum_db_user_list_subscribers
  phorum_db_user_list_subscribers() in mysql.php
  Retrieve the email addresses of the active users that are subscribed to a forum/thread, grouped by the preferred language for these users.
phorum_db_user_list_subscriptions
  phorum_db_user_list_subscriptions() in mysql.php
  Retrieve a list of threads to which a user is subscribed. The list can be limited to those threads which did receive contributions recently.
phorum_db_user_save
  phorum_db_user_save() in mysql.php
  Update a user.
phorum_db_user_save_groups
  phorum_db_user_save_groups() in mysql.php
  Save the group memberships for a user.
phorum_db_user_search
  phorum_db_user_search() in mysql.php
  Search for users, based on a simple search condition, which can be used to search on any field in the user table.
phorum_db_user_search_custom_profile_field
  phorum_db_user_search_custom_profile_field() in mysql.php
  Search for users, based on a simple search condition, which can be used to search on custom profile fields.
phorum_db_user_subscribe
  phorum_db_user_subscribe() in mysql.php
  Subscribe a user to a forum or thread.
phorum_db_user_unsubscribe
  phorum_db_user_unsubscribe() in mysql.php
  Unsubscribe a user from a forum/thread.
phorum_db_validate_field
  phorum_db_validate_field() in mysql.php
  Check if a value that will be used as a field name in a SQL query contains only characters that would appear in a field name.