phpBB API Documentation

Classes

acm ACM for Memcached
acm_memory ACM Abstract Memory Class
acp_attachments
acp_attachments_info
acp_ban
acp_ban_info
acp_bbcodes
acp_bbcodes_info
acp_board
acp_board_info
acp_bots
acp_bots_info
acp_captcha
acp_captcha_info
acp_disallow
acp_disallow_info
acp_email
acp_email_info
acp_forums
acp_forums_info
acp_groups
acp_groups_info
acp_icons
acp_icons_info
acp_inactive
acp_inactive_info
acp_jabber
acp_jabber_info
acp_language
acp_language_info
acp_logs
acp_logs_info
acp_main
acp_main_info
acp_modules
acp_modules_info
acp_permission_roles
acp_permission_roles_info
acp_permissions
acp_permissions_info
acp_php_info
acp_php_info_info
acp_profile
acp_profile_info
acp_prune
acp_prune_info
acp_ranks
acp_ranks_info
acp_reasons
acp_reasons_info
acp_search
acp_search_info
acp_send_statistics
acp_send_statistics_info
acp_styles
acp_styles_info
acp_update
acp_update_info
acp_users
acp_users_info
acp_words
acp_words_info
auth Permission/Auth class
auth_admin ACP Permission/Auth class
bbcode BBCode class
bbcode_firstpass BBCODE FIRSTPASS BBCODE first pass class (functions for parsing messages for db storage)
bitfield
cache Class for grabbing/handling cached entries, extends acmfile or acmdb depending on the setup
captcha Main non-gd captcha class
char_cube3d
colour_manager
compress Class for handling archives (compression/decompression)
compress_tar Tar/tar.gz compression routine Header/checksum creation derived from tarfile.pl, (c) Tom Horsley, 1994
compress_zip Zip creation class from phpMyAdmin 2.3.0 (c) Tobias Ratschiller, Olivier Müller, Loïc Chapeaux, Marc Delisle, http://www.phpmyadmin.net/
convert Class holding all convertor-specific details.
custom_profile Custom Profile Fields
custom_profile_admin Custom Profile Fields ACP
dbal Database Abstraction Layer
dbal_firebird Firebird/Interbase Database Abstraction Layer Minimum Requirement is Firebird 2.1
dbal_mssql MSSQL Database Abstraction Layer Minimum Requirement is MSSQL 2000+
dbal_mssql_odbc Unified ODBC functions Unified ODBC functions support any database having ODBC driver, for example Adabas D, IBM DB2, iODBC, Solid, Sybase SQL Anywhere...
dbal_mssqlnative
dbal_mysql MySQL4 Database Abstraction Layer Compatible with: MySQL 3.23+ MySQL 4.0+ MySQL 4.1+ MySQL 5.0+
dbal_mysqli MySQLi Database Abstraction Layer mysqli-extension has to be compiled with: MySQL 4.1+ or MySQL 5.0+
dbal_oracle Oracle Database Abstraction Layer
dbal_postgres PostgreSQL Database Abstraction Layer Minimum Requirement is Version 7.3+
dbal_sqlite Sqlite Database Abstraction Layer Minimum Requirement: 2.8.2+
diff Code from pear.php.net, TextDiff-1.1.0 package http://pear.php.net/package/TextDiff/
diff3 A class for computing three way diffs.
diff3_block_builder
diff3_op
diff3_op_copy
diff_engine Code from pear.php.net, TextDiff-1.1.0 package http://pear.php.net/package/TextDiff/ (native engine)
diff_op
diff_op_add
diff_op_change
diff_op_copy
diff_op_delete
diff_renderer Code from pear.php.net, TextDiff-1.1.0 package http://pear.php.net/package/TextDiff/
diff_renderer_inline "Inline" diff renderer.
diff_renderer_raw "raw" diff renderer.
diff_renderer_side_by_side "chora (Horde)" diff renderer - similar style.
diff_renderer_unified Renders a unified diff
fileerror Class for assigning error messages before a real filespec class can be assigned
filespec Responsible for holding all file relevant information, as well as doing file-specific operations.
fileupload File upload class Init class (all parameters optional and able to be set/overwritten separately) - scope is global and valid for all uploads
ftp FTP transfer class
ftp_fsock FTP fsock transfer class
fulltext_mysql fulltext_mysql Fulltext search for MySQL
fulltext_native fulltext_native phpBB's own db driven fulltext search, version 2
install_convert Convert class for conversions
install_install Installation
install_main Main Tab - Installation
install_update Update Installation
jabber Jabber class from Flyspray project
mapped_diff
mcp_ban
mcp_ban_info
mcp_logs mcp_logs Handling warning the users
mcp_logs_info
mcp_main mcp_main Handling mcp actions
mcp_main_info
mcp_notes mcp_notes Displays notes about a user
mcp_notes_info
mcp_pm_reports mcp_reports Handling the reports queue
mcp_pm_reports_info
mcp_queue mcp_queue Handling the moderation queue
mcp_queue_info
mcp_reports mcp_reports Handling the reports queue
mcp_reports_info
mcp_warn mcp_warn Handling warning the users
mcp_warn_info
messenger Messenger
module
p_master Class handling all types of 'plugins' (a future term)
parse_message Main message parser for posting, pm, etc.
phpbb_captcha_factory A small class for 3.0.x (no autoloader in 3.0.x)
phpbb_captcha_gd
phpbb_captcha_gd_wave
phpbb_captcha_nogd
phpbb_captcha_qa And now to something completely different.
phpbb_db_tools Database Tools for handling cross-db actions such as altering columns, etc.
phpbb_default_captcha This class holds the code shared by the two default 3.0.x CAPTCHAs.
phpbb_error_collector
phpbb_feed_base Base class with some generic functions and settings.
phpbb_feed_factory Factory class to return correct object
phpbb_feed_forum Forum feed
phpbb_feed_forums 'All Forums' feed
phpbb_feed_news News feed
phpbb_feed_overall Board wide feed (aka overall feed)
phpbb_feed_post_base Abstract class for post based feeds
phpbb_feed_topic Topic feed for a specific topic
phpbb_feed_topic_base Abstract class for topic based feeds
phpbb_feed_topics New Topics feed
phpbb_feed_topics_active Active Topics feed
phpbb_hook phpBB Hook Class
phpbb_questionnaire_data_collector This class collects data which is used to create some usage statistics.
phpbb_questionnaire_php_data_provider Questionnaire PHP data provider
phpbb_questionnaire_phpbb_data_provider Questionnaire phpBB data provider
phpbb_questionnaire_system_data_provider Questionnaire System data provider
phpbb_recaptcha
queue handling email and jabber queue
result_mssqlnative Prior to version 1.1 the SQL Server Native PHP driver didn't support sqlsrvnumrows, or cursor based seeking so we recall all rows into an array and maintain our own cursor index into that array.
search_backend searchbackend optional base class for search plugins providing simple caching based on ACM and functions to retrieve ignorewords and synonyms
session Session class
smtp_class SMTP Class Auth Mechanisms originally taken from the AUTH Modules found within the PHP Extension and Application Repository (PEAR) See docs/AUTHORS for more details
template Base Template class.
template_compile Extension of template class - Functions needed for compiling templates only.
transfer Transfer class, wrapper for ftp/sftp/ssh
ucp_activate ucp_activate User activation
ucp_attachments ucp_attachments User attachments
ucp_attachments_info
ucp_confirm ucp_confirm Visual confirmation
ucp_groups ucp_groups
ucp_groups_info
ucp_main ucp_main UCP Front Panel
ucp_main_info
ucp_pm Private Message Class
ucp_pm_info
ucp_prefs ucp_prefs Changing user preferences
ucp_prefs_info
ucp_profile ucp_profile Changing profile settings
ucp_profile_info
ucp_register ucp_register Board registration
ucp_remind ucp_remind Sending password reminders
ucp_resend ucp_resend Resending activation emails
ucp_zebra ucp_zebra
ucp_zebra_info
user Base user class
utf_normalizer Unicode normalization routines