A

SphinxClient::AddQuery() — Method in class SphinxClient
acp_attachmentsClass in namespace [Global Namespace]
$ acp_attachments#attachment_managerProperty in class acp_attachments
acp_attachments_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_banClass in namespace [Global Namespace]
acp_ban_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_bbcodesClass in namespace [Global Namespace]
acp_bbcodes_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_boardClass in namespace [Global Namespace]
acp_board_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_botsClass in namespace [Global Namespace]
acp_bots_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_captchaClass in namespace [Global Namespace]
acp_captcha_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_contactClass in namespace [Global Namespace]
acp_contact_infoClass in namespace [Global Namespace]
acp_disallowClass in namespace [Global Namespace]
acp_disallow_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_emailClass in namespace [Global Namespace]
acp_email_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_extensionsClass in namespace [Global Namespace]
acp_extensions_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_forumsClass in namespace [Global Namespace]
acp_forums_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_groupsClass in namespace [Global Namespace]
acp_groups_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_help_phpbbClass in namespace [Global Namespace]
acp_help_phpbb_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_iconsClass in namespace [Global Namespace]
acp_icons_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_inactiveClass in namespace [Global Namespace]
acp_inactive_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_jabberClass in namespace [Global Namespace]
acp_jabber_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_languageClass in namespace [Global Namespace]
acp_language_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_logsClass in namespace [Global Namespace]
acp_logs_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_mainClass in namespace [Global Namespace]
acp_main_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_modulesClass in namespace [Global Namespace]
  • Able to check for new module versions (modes changed/adjusted/added/removed) Icons for:
  • module enabled and displayed (common)
  • module enabled and not displayed
  • module deactivated
  • category (enabled)
  • category disabled
acp_modules_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_permission_rolesClass in namespace [Global Namespace]
$ acp_permission_roles#auth_adminProperty in class acp_permission_roles
acp_permission_roles_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_permissionsClass in namespace [Global Namespace]
acp_permissions_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_php_infoClass in namespace [Global Namespace]
acp_php_info_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_profileClass in namespace [Global Namespace]
acp_profile_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_pruneClass in namespace [Global Namespace]
acp_prune_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_ranksClass in namespace [Global Namespace]
acp_ranks_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_reasonsClass in namespace [Global Namespace]
acp_reasons_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_searchClass in namespace [Global Namespace]
acp_search_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_stylesClass in namespace [Global Namespace]
$ acp_styles#authProperty in class acp_styles
acp_styles::action_install() — Method in class acp_styles

Install style(s)

acp_styles::action_uninstall() — Method in class acp_styles

Confirm styles removal

acp_styles::action_uninstall_confirmed() — Method in class acp_styles

Uninstall styles(s)

acp_styles::action_activate() — Method in class acp_styles

Activate styles

acp_styles::action_deactivate() — Method in class acp_styles

Deactivate styles

acp_styles::action_details() — Method in class acp_styles

Show style details

acp_styles_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_updateClass in namespace [Global Namespace]
acp_update_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_usersClass in namespace [Global Namespace]
acp_users_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

acp_wordsClass in namespace [Global Namespace]
acp_words_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

auth_adminClass in namespace [Global Namespace]

ACP Permission/Auth class

auth_admin::acl_add_option() — Method in class auth_admin

NOTE: this function is not in use atm Add a new option to the list ... $options is a hash of form -> $options = array( 'local' => array('option1', 'option2', ...), 'global' => array('optionA', 'optionB', ...) );

auth_admin::acl_set() — Method in class auth_admin

Set a user or group ACL record

auth_admin::acl_set_role() — Method in class auth_admin

Set a role-specific ACL record

auth_admin::acl_delete() — Method in class auth_admin

Remove local permission

auth_admin::assign_cat_array() — Method in class auth_admin

Assign category to template used by display_mask()

compress::add_file() — Method in class compress

Add file to archive

compress::add_custom_file() — Method in class compress

Add custom file (the filepath will not be adjusted)

compress::add_data() — Method in class compress

Add file data

$ jabber#allow_self_signedProperty in class jabber
jabber::add_to_log() — Method in class jabber

Add information to log

mcp_queue::approve_posts() — Method in class mcp_queue

Approve/Restore posts

mcp_queue::approve_topics() — Method in class mcp_queue

Approve/Restore topics

$ messenger#addressesProperty in class messenger
messenger::anti_abuse_headers() — Method in class messenger

Adds X-AntiAbuse headers

messenger::assign_vars() — Method in class messenger

assign variables to email template

messenger::assign_block_vars() — Method in class messenger
$ p_master#active_moduleProperty in class p_master
$ p_master#active_module_row_idProperty in class p_master
$ p_master#acl_forum_idProperty in class p_master
p_master::adjust_url() — Method in class p_master

Appending url parameter to the currently active module.

p_master::assign_tpl_vars() — Method in class p_master

Build navigation structure

p_master::add_mod_info() — Method in class p_master

Add custom MOD info language file

$ parse_message#attachment_dataProperty in class parse_message
$ parse_message#allow_img_bbcodeProperty in class parse_message
$ parse_message#allow_flash_bbcodeProperty in class parse_message
$ parse_message#allow_quote_bbcodeProperty in class parse_message
$ parse_message#allow_url_bbcodeProperty in class parse_message
$ upload#authProperty in class upload
authClass in namespace phpbb\auth

Permission/Auth class

$ auth#aclProperty in class auth
$ auth#acl_optionsProperty in class auth
$ auth#acl_forum_idsProperty in class auth
auth::acl() — Method in class auth

Init permissions

auth::acl_get() — Method in class auth

Look up an option if the option is prefixed with !, then the result becomes negated

auth::acl_getf() — Method in class auth

Get forums with the specified permission setting

auth::acl_getf_global() — Method in class auth

Get local permission state for any forum.

auth::acl_gets() — Method in class auth

Get permission settings (more than one)

auth::acl_get_list() — Method in class auth

Get permission listing based on user_id/options/forum_ids

auth::acl_cache() — Method in class auth

Cache data to user_permissions row

auth::acl_clear_prefetch() — Method in class auth

Clear one or all users cached permission settings

auth::acl_role_data() — Method in class auth

Get assigned roles

auth::acl_raw_data() — Method in class auth

Get raw acl data based on user/option/forum

auth::acl_user_raw_data() — Method in class auth

Get raw user based permission settings

auth::acl_group_raw_data() — Method in class auth

Get raw group based permission settings

auth::acl_raw_data_single_user() — Method in class auth

Get raw acl data based on user for caching user_permissions This function returns the same data as acl_raw_data(), but without the user id as the first key within the array.

apacheClass in namespace phpbb\auth\provider

Apache authentication provider for phpBB3

apache::autologin() — Method in class apache

Autologin function

base::autologin() — Method in class base

Autologin function

base::acp() — Method in class base

This function is used to output any required fields in the authentication admin panel. It also defines any required configuration table fields.

ldap::acp() — Method in class ldap

This function is used to output any required fields in the authentication admin panel. It also defines any required configuration table fields.

oauth::acp() — Method in class oauth

This function is used to output any required fields in the authentication admin panel. It also defines any required configuration table fields.

provider_interface::autologin() — Method in class provider_interface

Autologin function

provider_interface::acp() — Method in class provider_interface

This function is used to output any required fields in the authentication admin panel. It also defines any required configuration table fields.

$ driver#allowed_extensionsProperty in class driver

Array of allowed avatar image extensions Array is used for setting the allowed extensions in the fileupload class and as a base for a regex of allowed extensions, which will be formed by imploding the array with a "|".

$ manager#avatar_driversProperty in class manager

Array that contains all available avatar drivers which are passed via the service container

apcuClass in namespace phpbb\cache\driver

ACM for APCU

$ char_cube3d#abs_xProperty in class char_cube3d
$ char_cube3d#abs_yProperty in class char_cube3d
colour_manager::allocate_named() — Method in class colour_manager

names and allocates a colour resource

colour_manager::allocate() — Method in class colour_manager

allocates a specified colour into the image

colour_manager::ah2h() — Method in class colour_manager

Alternate hue to hue

$ captcha_abstract#attemptsProperty in class captcha_abstract
gd::acp_page() — Method in class gd
gd_wave::acp_page() — Method in class gd_wave
nogd::acp_page() — Method in class nogd
$ qa#answerProperty in class qa
$ qa#attemptsProperty in class qa
qa::acp_page() — Method in class qa

API function - The ACP backend, this marks the end of the easy methods

qa::acp_question_list() — Method in class qa

This handles the list overview

qa::acp_get_question_data() — Method in class qa

Grab a question and bring it into a format the editor understands

qa::acp_get_question_input() — Method in class qa

Grab a question from input and bring it into a format the editor understands

qa::acp_update_question() — Method in class qa

Update a question.

qa::acp_add_question() — Method in class qa

Insert a question.

qa::acp_insert_answers() — Method in class qa

Insert the answers.

qa::acp_delete_question() — Method in class qa

Delete a question.

qa::acp_is_last() — Method in class qa

See if there is a question other than the one we have

recaptcha::acp_page() — Method in class recaptcha
$ recaptcha_v3#actionsProperty in class recaptcha_v3
recaptcha_v3::acp_page() — Method in class recaptcha_v3

Create the ACP page for configuring this CAPTCHA plugin.

applicationClass in namespace phpbb\console
$ purge#authProperty in class purge
activateClass in namespace phpbb\console\command\user
addClass in namespace phpbb\console\command\user
add::ask_user() — Method in class add

Helper to translate questions to the user

$ content_visibility#authProperty in class content_visibility

Auth object

content_visibility::add_post_to_statistic() — Method in class content_visibility

Add post to topic and forum statistics

$ helper#authProperty in class helper
$ helper#admin_pathProperty in class helper
helper::assign_meta_refresh_var() — Method in class helper

Assigns automatic refresh time meta tag in template

prune_shadow_topics::auto_prune_shadow_topics() — Method in class prune_shadow_topics

Automatically prune shadow topics Based on fuunction auto_prune()

$ tidy_search#authProperty in class tidy_search

Auth object

$ driver#any_charProperty in class driver

Wildcards for matching any (%) or exactly one (_) character within LIKE expressions

config::add() — Method in class config

Add a config setting.

config_text::add() — Method in class config_text

Add a config_text setting.

module::add() — Method in class module

Module Add

$ permission#authProperty in class permission
$ permission#auth_adminProperty in class permission
permission::add() — Method in class permission

Permission Add

ordered_service_collection::add() — Method in class ordered_service_collection

Adds a service ID to the collection

service_collection::add() — Method in class service_collection

Add a service to the collection

service_collection::add_service_class() — Method in class service_collection

Add a service's class to the collection

recursive_event_filter_iterator::accept() — Method in class recursive_event_filter_iterator
{@inheritDoc}
rst_exporter::add_section_header() — Method in class rst_exporter

Add header to rst page

manager::all_available() — Method in class manager

Retrieves a list of all available extensions on the filesystem

manager::all_configured() — Method in class manager

Retrieves all configured extensions.

manager::all_enabled() — Method in class manager

Retrieves all enabled extensions.

manager::all_disabled() — Method in class manager

Retrieves all disabled extensions.

attachments_baseClass in namespace phpbb\feed

Abstract class for feeds displaying attachments

$ attachments_base#attachmentsProperty in class attachments_base

Attachments that may be displayed

$ base#authProperty in class base
$ feed#authProperty in class feed
feed_interface::adjust_item() — Method in class feed_interface

Adjust a feed entry

forum::adjust_item() — Method in class forum

Adjust a feed entry

forums::adjust_item() — Method in class forums

Adjust a feed entry

$ helper#authProperty in class helper
helper::append_sid() — Method in class helper

Run links through append_sid(), prepend generate_board_url() and remove session id

overall::adjust_item() — Method in class overall

Adjust a feed entry

post_base::adjust_item() — Method in class post_base

Adjust a feed entry

topic::adjust_item() — Method in class topic

Adjust a feed entry

topic_base::adjust_item() — Method in class topic_base

Adjust a feed entry

topics::adjust_item() — Method in class topics

Adjust a feed entry

topics_active::adjust_item() — Method in class topics_active

Adjust a feed entry

filespec::additional_checks() — Method in class filespec

Performing additional checks

$ upload#allowed_extensionsProperty in class upload
upload::assign_internal_error() — Method in class upload

Assign internal error

$ helper#authProperty in class helper
groupposition_interface::add_group() — Method in class groupposition_interface

Addes a group by group_id

legend::add_group() — Method in class legend

Addes a group by group_id

teampage::add_group() — Method in class teampage

Addes a group by group_id

teampage::add_group_teampage() — Method in class teampage

Adds a group by group_id

teampage::add_category_teampage() — Method in class teampage

Adds a new category

help::assign_to_template() — Method in class help

Assigns the help data to the template blocks

manager::add_block() — Method in class manager

Add a new faq block

manager::add_question() — Method in class manager

Add a new faq question

archive_downloadClass in namespace phpbb\install\controller
ajax_iohandlerClass in namespace phpbb\install\helper\iohandler

Input-Output handler for the AJAX frontend

ajax_iohandler::add_user_form_group() — Method in class ajax_iohandler

Adds a requested data group to the rendering queue

ajax_iohandler::add_download_link() — Method in class ajax_iohandler

Adds a download link

ajax_iohandler::acquire_lock() — Method in class ajax_iohandler

Acquires a file lock

cli_iohandler::add_user_form_group() — Method in class cli_iohandler

Adds a requested data group to the rendering queue

cli_iohandler::add_error_message() — Method in class cli_iohandler
{@inheritdoc
cli_iohandler::add_warning_message() — Method in class cli_iohandler
{@inheritdoc
cli_iohandler::add_log_message() — Method in class cli_iohandler
{@inheritdoc
cli_iohandler::add_success_message() — Method in class cli_iohandler
{@inheritdoc
cli_iohandler::add_download_link() — Method in class cli_iohandler

Adds a download link

iohandler_base::add_error_message() — Method in class iohandler_base

Adds an error message to the rendering queue

iohandler_base::add_warning_message() — Method in class iohandler_base

Adds a warning message to the rendering queue

iohandler_base::add_log_message() — Method in class iohandler_base

Adds a log message to the rendering queue

iohandler_base::add_success_message() — Method in class iohandler_base

Adds a success message to the rendering queue

iohandler_interface::add_error_message() — Method in class iohandler_interface

Adds an error message to the rendering queue

iohandler_interface::add_warning_message() — Method in class iohandler_interface

Adds a warning message to the rendering queue

iohandler_interface::add_log_message() — Method in class iohandler_interface

Adds a log message to the rendering queue

iohandler_interface::add_success_message() — Method in class iohandler_interface

Adds a success message to the rendering queue

iohandler_interface::add_user_form_group() — Method in class iohandler_interface

Adds a requested data group to the rendering queue

iohandler_interface::add_download_link() — Method in class iohandler_interface

Adds a download link

$ notify_user#authProperty in class notify_user
abstract_requirements_moduleClass in namespace phpbb\install\module\requirements

Base class for requirements installer module

$ module_base#allow_progress_barProperty in class module_base
language::add_lang() — Method in class language

Add Language Items

db::acquire() — Method in class db

Tries to acquire the lock by updating the configuration variable in the database.

flock::acquire() — Method in class flock

Tries to acquire the lock.

dummy::add() — Method in class dummy

Adds a log entry to the database

$ log#authProperty in class log

Auth object

log::add() — Method in class log

Adds a log entry to the database

log_interface::add() — Method in class log_interface

Adds a log entry to the database

admin_formClass in namespace phpbb\message

Class admin_form Displays a message to the user and allows him to send an email

$ form#authProperty in class form
message::add_recipient_from_user_row() — Method in class message

Add a recipient from \phpbb\user

message::add_recipient() — Method in class message

Add a recipient

manager::add_notifications() — Method in class manager

Add a notification

manager::add_notifications_for_users() — Method in class manager

Add a notification for specific users

manager::add_subscription() — Method in class manager

Add a subscription

base::add_to_queue() — Method in class base

Add a notification to the queue

board::add_to_queue() — Method in class board

Add a notification to the queue

method_interface::add_to_queue() — Method in class method_interface

Add a notification to the queue

admin_activate_userClass in namespace phpbb\notification\type

Admin activation notifications class This class handles notifications for users requiring admin activation

approve_postClass in namespace phpbb\notification\type

Post approved notifications class This class handles notifications for posts when they are approved (to their authors)

approve_topicClass in namespace phpbb\notification\type

Topic approved notifications class This class handles notifications for topics when they are approved (for authors)

$ base#authProperty in class base
post::add_responders() — Method in class post

Add responders to the notification

argon2iClass in namespace phpbb\passwords\driver
argon2idClass in namespace phpbb\passwords\driver
$ manager#algorithmsProperty in class manager

Service collection of hashing algorithms Needs to be public for passwords helper

$ path_helper#adm_relative_pathProperty in class path_helper
path_helper::append_url_params() — Method in class path_helper

Append parameters to an already built URL.

$ manager#authProperty in class manager
recursive_dot_prefix_filter_iterator::accept() — Method in class recursive_dot_prefix_filter_iterator
report::assign_template_data() — Method in class report

Assigns template variables

already_reported_exceptionClass in namespace phpbb\report\exception
$ report_handler#authProperty in class report_handler
report_handler_interface::add_report() — Method in class report_handler_interface

Reports a message

report_handler_pm::add_report() — Method in class report_handler_pm

Reports a message

report_handler_post::add_report() — Method in class report_handler_post

Reports a message

default_resources_locator::append_ext_resources() — Method in class default_resources_locator

Append extension resources to an array of resouces

fulltext_mysql::author_search() — Method in class fulltext_mysql

Performs a search on an author's posts without caring about message contents. Depends on display specific params

fulltext_mysql::acp() — Method in class fulltext_mysql

Display a note, that UTF-8 support is not available with certain versions of PHP

fulltext_native::author_search() — Method in class fulltext_native

Performs a search on an author's posts without caring about message contents. Depends on display specific params

fulltext_native::acp() — Method in class fulltext_native

Returns a list of options for the ACP to display

fulltext_postgres::author_search() — Method in class fulltext_postgres

Performs a search on an author's posts without caring about message contents. Depends on display specific params

fulltext_postgres::acp() — Method in class fulltext_postgres

Display various options that can be configured for the backend from the acp

$ fulltext_sphinx#authProperty in class fulltext_sphinx

Auth object

fulltext_sphinx::author_search() — Method in class fulltext_sphinx

Performs a search on an author's posts without caring about message contents. Depends on display specific params

fulltext_sphinx::acp() — Method in class fulltext_sphinx

Returns a list of options for the ACP to display

config::add_section() — Method in class config

Appends a new empty section to the end of the config

config_section::add_variable() — Method in class config_section

Add a variable object to the list of variables in this section

assetClass in namespace phpbb\template
asset::add_assets_version() — Method in class asset

Add assets_version parameter to URL.

assets_bagClass in namespace phpbb\template
assets_bag::add_stylesheet() — Method in class assets_bag

Add a css asset to the bag

assets_bag::add_script() — Method in class assets_bag

Add a js script asset to the bag

base::assign_vars() — Method in class base

Assign key variable pairs from an array

base::assign_var() — Method in class base

Assign a single scalar value to a single key.

base::append_var() — Method in class base

Append text to the string value stored in a key.

base::assign_block_vars() — Method in class base

Assign key variable pairs from an array to a specified block

base::assign_block_vars_array() — Method in class base

Assign key variable pairs from an array to a whole specified block loop

base::alter_block_array() — Method in class base

Change already assigned key variable pair (one-dimensional - single loop entry)

context::assign_var() — Method in class context

Assign a single scalar value to a single key.

context::append_var() — Method in class context

Append text to the string value stored in a key.

context::assign_block_vars() — Method in class context

Assign key variable pairs from an array to a specified block

context::assign_block_vars_array() — Method in class context

Assign key variable pairs from an array to a whole specified block loop

context::alter_block_array() — Method in class context

Change already assigned key variable pair (one-dimensional - single loop entry)

template::assign_display() — Method in class template

Display the handle and assign the output to a template variable or return the compiled result.

template::assign_vars() — Method in class template

Assign key variable pairs from an array

template::assign_var() — Method in class template

Assign a single scalar value to a single key.

template::append_var() — Method in class template

Append text to the string value stored in a key.

template::assign_block_vars() — Method in class template

Assign key variable pairs from an array to a specified block

template::assign_block_vars_array() — Method in class template

Assign key variable pairs from an array to a whole specified block loop

template::alter_block_array() — Method in class template

Change already assigned key variable pair (one-dimensional - single loop entry)

definition::append() — Method in class definition

Append to a variable

$ environment#assets_bagProperty in class environment
avatarClass in namespace phpbb\template\twig\extension
lexer::add_surrounding_quotes() — Method in class lexer

Add surrounding quotes

loader::addSafeDirectory() — Method in class loader

Add safe directory

loader::addPath() — Method in class loader

Adds a realpath call to fix a BC break in Twig 1.26 (https://github.com/twigphp/Twig/issues/2145)

twig::assign_display() — Method in class twig

Display the handle and assign the output to a template variable or return the compiled result.

acp_utils_interfaceClass in namespace phpbb\textformatter
acp_utils_interface::analyse_bbcode() — Method in class acp_utils_interface

Analyse given BBCode definition for issues and safeness

acp_utilsClass in namespace phpbb\textformatter\s9e
acp_utils::analyse_bbcode() — Method in class acp_utils

Analyse given BBCode definition for issues and safeness

factory::add_bbcode() — Method in class factory

Add a BBCode to given configurator

base::add_missing_fields() — Method in class base

Add fields to given record, if applicable

user_signature::add_missing_fields() — Method in class user_signature

Add fields to given record, if applicable

nestedset::acquire_lock() — Method in class nestedset

Acquires a lock on the item table

nestedset::add_item_to_nestedset() — Method in class nestedset

Add an item which already has a database row at the end of the tree

user::add_lang() — Method in class user

Add Language Items - use_db and use_help are assigned where needed (only use them to force inclusion)

user::add_lang_ext() — Method in class user

Add Language Items from an extension - use_db and use_help are assigned where needed (only use them to force inclusion)

phpbb_hook::add_hook() — Method in class phpbb_hook

Add new function to the allowed hooks.

phpbb_questionnaire_data_collector::add_data_provider() — Method in class phpbb_questionnaire_data_collector
smtp_class::add_backtrace() — Method in class smtp_class

Add backtrace message for debugging

ucp_main::assign_topiclist() — Method in class ucp_main

Build and assign topiclist for bookmarks/subscribed topics

B

SphinxClient::BuildExcerpts() — Method in class SphinxClient
SphinxClient::BuildKeywords() — Method in class SphinxClient
acp_bbcodes::build_regexp() — Method in class acp_bbcodes
acp_board::bump_interval() — Method in class acp_board

Select bump interval

acp_board::board_disable() — Method in class acp_board

Board disable option and message

acp_permissions::build_subforum_options() — Method in class acp_permissions

Build +subforum options

acp_permissions::build_permission_dropdown() — Method in class acp_permissions

Build dropdown field for changing permission types

acp_profile::build_language_options() — Method in class acp_profile

Build all Language specific options

$ acp_search#batch_sizeProperty in class acp_search
auth_admin::build_permission_array() — Method in class auth_admin

Building content array from permission rows with explicit key ordering used by display_mask()

bbcodeClass in namespace [Global Namespace]

BBCode class

$ bbcode#bbcode_uidProperty in class bbcode
$ bbcode#bbcode_bitfieldProperty in class bbcode
$ bbcode#bbcode_cacheProperty in class bbcode
$ bbcode#bbcode_templateProperty in class bbcode
$ bbcode#bbcodesProperty in class bbcode
bbcode::bbcode_set_bitfield() — Method in class bbcode

Init bbcode cache entries if bitfield is specified

bbcode::bbcode_second_pass() — Method in class bbcode

Second pass bbcodes

bbcode::bbcode_cache_init() — Method in class bbcode

Init bbcode cache

bbcode::bbcode_tpl() — Method in class bbcode

Return bbcode template

bbcode::bbcode_tpl_replace() — Method in class bbcode

Return bbcode template replacement

bbcode::bbcode_list() — Method in class bbcode

Second parse list bbcode

bbcode::bbcode_second_pass_quote() — Method in class bbcode

Second parse quote tag

bbcode::bbcode_second_pass_code() — Method in class bbcode

Second parse code tag

bbcode::bbcode_second_pass_by_extension() — Method in class bbcode

Function to perform custom bbcode second pass by extensions can be used to assign bbcode pattern replacement Example: '#[list=([^[]+):$uid]#e' => "\$this->bbcode_second_pass_by_extension('\$1')"

bbcode_firstpassClass in namespace [Global Namespace]

BBCODE FIRSTPASS BBCODE first pass class (functions for parsing messages for db storage)

bbcode_firstpass::bbcode_init() — Method in class bbcode_firstpass

Init bbcode data for later parsing

bbcode_firstpass::bbcode_specialchars() — Method in class bbcode_firstpass

Transform some characters in valid bbcodes

bbcode_firstpass::bbcode_size() — Method in class bbcode_firstpass

Parse size tag

bbcode_firstpass::bbcode_color() — Method in class bbcode_firstpass

Parse color tag

bbcode_firstpass::bbcode_underline() — Method in class bbcode_firstpass

Parse u tag

bbcode_firstpass::bbcode_strong() — Method in class bbcode_firstpass

Parse b tag

bbcode_firstpass::bbcode_italic() — Method in class bbcode_firstpass

Parse i tag

bbcode_firstpass::bbcode_img() — Method in class bbcode_firstpass

Parse img tag

bbcode_firstpass::bbcode_flash() — Method in class bbcode_firstpass

Parse flash tag

bbcode_firstpass::bbcode_attachment() — Method in class bbcode_firstpass

Parse inline attachments [ia]

bbcode_firstpass::bbcode_code() — Method in class bbcode_firstpass

Parse code tag Expects the argument to start right after the opening [code] tag and to end with [/code]

bbcode_firstpass::bbcode_parse_list() — Method in class bbcode_firstpass

Parse list bbcode Expects the argument to start with a tag

bbcode_firstpass::bbcode_quote() — Method in class bbcode_firstpass

Parse quote bbcode Expects the argument to start with a tag

bitfieldClass in namespace [Global Namespace]
messenger::bcc() — Method in class messenger

Sets an bcc address to send to

messenger::build_header() — Method in class messenger

Return email header

p_master::build_tree() — Method in class p_master

Build true binary tree from given array Not in use

auth::build_bitstring() — Method in class auth

Build bitstring from permission set

auth::build_auth_option_statement() — Method in class auth

Fill auth_option statement for later querying based on the supplied options

baseClass in namespace phpbb\auth\provider

Base authentication provider class that all other providers should implement

baseClass in namespace phpbb\auth\provider\oauth\service

Base OAuth abstract class that all OAuth services should implement

bitlyClass in namespace phpbb\auth\provider\oauth\service

Bitly OAuth service

baseClass in namespace phpbb\cache\driver
$ char_cube3d#bitmapProperty in class char_cube3d
$ char_cube3d#bitmap_widthProperty in class char_cube3d
$ char_cube3d#bitmap_heightProperty in class char_cube3d
$ char_cube3d#basis_matrixProperty in class char_cube3d
$ convert#batch_sizeProperty in class convert
convertor::build_insert_query() — Method in class convertor
baseClass in namespace phpbb\cron\task

Cron task base class. Provides sensible defaults for cron tasks and partially implements cron task interface, making writing cron tasks easier.

base_extractorClass in namespace phpbb\db\extractor

Abstract base class for database extraction

$ sql_insert_buffer#bufferProperty in class sql_insert_buffer
baseClass in namespace phpbb\extension

A base class for extensions without custom enable/disable/purge code.

baseClass in namespace phpbb\feed

Base class with some generic functions and settings.

baseClass in namespace phpbb\files\types
bbcodeClass in namespace phpbb\help\controller

BBCode help page

container_factory::build_container() — Method in class container_factory

Build dependency injection container

admin_form::bind() — Method in class admin_form
{inheritDoc}
$ form#bodyProperty in class form
form::bind() — Method in class form

Bind the values of the request to the form

$ message#bodyProperty in class message
topic_form::bind() — Method in class topic_form
{inheritDoc}
user_form::bind() — Method in class user_form
{inheritDoc}
baseClass in namespace phpbb\notification\method

Base notifications method class

boardClass in namespace phpbb\notification\method

In Board notification method class This class handles in board notifications. This method is enabled by default.

baseClass in namespace phpbb\notification\type

Base notifications class

bookmarkClass in namespace phpbb\notification\type

Bookmark updating notifications class This class handles notifications for replies to a bookmarked topic

baseClass in namespace phpbb\passwords\driver
base_nativeClass in namespace phpbb\passwords\driver
bcryptClass in namespace phpbb\passwords\driver
bcrypt_2yClass in namespace phpbb\passwords\driver
bcrypt_wcf2Class in namespace phpbb\passwords\driver
$ bcrypt_wcf2#bcryptProperty in class bcrypt_wcf2
manager::build_cache() — Method in class manager

Build profile cache, used for display.

manager::build_insert_sql_array() — Method in class manager

Build array for the custom profile fields table.

baseClass in namespace phpbb\search

optional base class for search plugins providing simple caching based on ACM and functions to retrieve ignore_words and synonyms

$ session#browserProperty in class session
baseClass in namespace phpbb\template
bbcode_mergerClass in namespace phpbb\textformatter\s9e
baseClass in namespace phpbb\textreparser
$ smtp_class#backtraceProperty in class smtp_class
$ smtp_class#backtrace_logProperty in class smtp_class

C

SphinxClient::Close() — Method in class SphinxClient
$ acp_attachments#configProperty in class acp_attachments
acp_attachments::check_stats_accuracy() — Method in class acp_attachments

Check accuracy of attachment statistics.

acp_attachments::category_select() — Method in class acp_attachments

Build Select for category items

acp_extensions::check_is_enableable() — Method in class acp_extensions

Checks whether the extension can be enabled. Triggers error if not.

acp_forums::copy_permission_page() — Method in class acp_forums

Display copy permission page Not used at the moment - we will have a look at it for 3.0.7

acp_language::compare_language_files() — Method in class acp_language

Compare two language files

acp_permissions::check_existence() — Method in class acp_permissions

Check if selected items exist. Remove not found ids and if empty return error.

acp_permissions::check_assigned_role() — Method in class acp_permissions

Compare auth settings with auth settings from role returns false if they differ, true if they are equal

acp_permissions::copy_forum_permissions() — Method in class acp_permissions

Handles copying permissions from one forum to others

$ acp_styles#configProperty in class acp_styles
$ acp_styles#cacheProperty in class acp_styles
bbcode_firstpass::check_bbcode() — Method in class bbcode_firstpass

Making some pre-checks for bbcodes as well as increasing the number of parsed items

bitfield::clear() — Method in class bitfield
compressClass in namespace [Global Namespace]

Class for handling archives (compression/decompression)

compress_tarClass in namespace [Global Namespace]

Tar/tar.gz compression routine Header/checksum creation derived from tarfile.pl, (c) Tom Horsley, 1994

compress_tar::close() — Method in class compress_tar

Close archive

compress_zipClass in namespace [Global Namespace]

Zip creation class from phpMyAdmin 2.3.0 (c) Tobias Ratschiller, Olivier Müller, Loïc Chapeaux, Marc Delisle, http://www.phpmyadmin.net/

$ compress_zip#ctrl_dirProperty in class compress_zip
compress_zip::close() — Method in class compress_zip

Close archive

diff::count_added_lines() — Method in class diff

returns the number of new (added) lines in a given diff.

diff::count_deleted_lines() — Method in class diff

Returns the number of deleted (removed) lines in a given diff.

$ diff_renderer_side_by_side#colsProperty in class diff_renderer_side_by_side
$ jabber#connectionProperty in class jabber
$ jabber#connect_serverProperty in class jabber
jabber::can_use_ssl() — Method in class jabber

Able to use the SSL functionality?

jabber::can_use_tls() — Method in class jabber

Able to use TLS?

jabber::connect() — Method in class jabber
Connect
jabber::connected() — Method in class jabber
Connected?
messenger::cc() — Method in class messenger

Sets an cc address to send to

parse_message::check_attachment_form_token() — Method in class parse_message

Check attachment form token depending on submit type

$ delete#configProperty in class delete
delete::collect_attachment_info() — Method in class delete

Collect info about attachment IDs

$ upload#cacheProperty in class upload
$ upload#configProperty in class upload
upload::create_thumbnail() — Method in class upload

Create thumbnail for file if necessary

upload::check_image() — Method in class upload

Check if uploaded file is really an image

upload::check_attach_quota() — Method in class upload

Check if attachment quota was reached

upload::check_disk_space() — Method in class upload

Check if there is enough free space available on disk

$ auth#cacheProperty in class auth
$ apache#configProperty in class apache
$ db#captcha_factoryProperty in class db
$ db#configProperty in class db
$ ldap#configProperty in class ldap
$ oauth#configProperty in class oauth
$ bitly#configProperty in class bitly
$ facebook#configProperty in class facebook
$ google#configProperty in class google
$ twitter#configProperty in class twitter
$ token_storage#cachedTokenProperty in class token_storage
$ token_storage#cachedStateProperty in class token_storage
token_storage::clearToken() — Method in class token_storage
{@inheritdoc}
token_storage::clearAllTokens() — Method in class token_storage
{@inheritdoc}
token_storage::clearAuthorizationState() — Method in class token_storage
{@inheritdoc}
token_storage::clearAllAuthorizationStates() — Method in class token_storage
{@inheritdoc}
$ provider_collection#configProperty in class provider_collection
$ driver#configProperty in class driver

Current board configuration

$ driver#cacheProperty in class driver

Cache driver

upload::can_upload() — Method in class upload

Check if user is able to upload an avatar

$ manager#configProperty in class manager

phpBB configuration

manager::clean_row() — Method in class manager

Strip out user, group, or other prefixes from array keys

manager::clean_driver_name() — Method in class manager

Clean driver names that are returned from template files Underscores are replaced with dots

$ base#cache_dirProperty in class base
base::clean_query_id() — Method in class base

Ensure query ID can be used by cache

driver_interface::clean_query_id() — Method in class driver_interface

Ensure query ID can be used by cache

file::clean_varname() — Method in class file

Replace slashes in the file name

$ service#configProperty in class service

The config.

char_cube3dClass in namespace phpbb\captcha
char_cube3d::cross_product() — Method in class char_cube3d
colour_managerClass in namespace phpbb\captcha
$ colour_manager#coloursProperty in class colour_manager
colour_manager::colour_scheme() — Method in class colour_manager
gd::captcha_noise_bg_bitmaps() — Method in class gd
gd::captcha_bitmaps() — Method in class gd

Return bitmaps

gd_wave::captcha_bitmaps() — Method in class gd_wave
non_gd::create_png() — Method in class non_gd

Creates greyscale 8bit png - The PNG spec can be found at http://www.libpng.org/pub/png/spec/PNG-Contents.html we use png because it's a fully recognised open standard and supported by practically all modern browsers and OSs

captcha_abstractClass in namespace phpbb\captcha\plugins

This class holds the code shared by the two default 3.0.x CAPTCHAs.

$ captcha_abstract#confirm_idProperty in class captcha_abstract
$ captcha_abstract#confirm_codeProperty in class captcha_abstract
$ captcha_abstract#codeProperty in class captcha_abstract
$ captcha_abstract#captcha_varsProperty in class captcha_abstract
captcha_abstract::check_code() — Method in class captcha_abstract
$ gd#captcha_varsProperty in class gd
$ qa#confirm_idProperty in class qa
qa::check_answer() — Method in class qa

The actual validation

class_loaderClass in namespace phpbb

The class loader resolves class names to file system paths and loads them if necessary.

configClass in namespace phpbb\config

Configuration container class

$ config#configProperty in class config

The configuration data

config::count() — Method in class config

Retrieves the number of configuration options currently set.

$ db#cacheProperty in class db

Cache instance

config_php_fileClass in namespace phpbb
$ config_php_file#config_loadedProperty in class config_php_file

Indicates whether the php config file has been loaded.

$ config_php_file#config_dataProperty in class config_php_file

The content of the php config file

$ config_php_file#config_fileProperty in class config_php_file

The path to the config file. (Default: $phpbb_root_path . 'config.' . $php_ext)

config_php_file::convert_30_dbms_to_31() — Method in class config_php_file

Convert either 3.0 dbms or 3.1 db driver class name to 3.1 db driver class name.

$ application#configProperty in class application
$ purge#cacheProperty in class purge
$ purge#configProperty in class purge
purge::configure() — Method in class purge
{@inheritdoc}
commandClass in namespace phpbb\console\command
command::create_progress_bar() — Method in class command

Create a styled progress bar

commandClass in namespace phpbb\console\command\config
$ command#configProperty in class command
delete::configure() — Method in class delete
{@inheritdoc}
get::configure() — Method in class get
{@inheritdoc}
increment::configure() — Method in class increment
{@inheritdoc}
set::configure() — Method in class set
{@inheritdoc}
set_atomic::configure() — Method in class set_atomic
{@inheritdoc}
cron_listClass in namespace phpbb\console\command\cron
$ cron_list#cron_managerProperty in class cron_list
cron_list::configure() — Method in class cron_list
{@inheritdoc}
$ run#cron_managerProperty in class run
run::configure() — Method in class run

Sets the command name and description

console_migrator_output_handlerClass in namespace phpbb\console\command\db
list_command::configure() — Method in class list_command
migrate::configure() — Method in class migrate
$ migration_command#configProperty in class migration_command
$ migration_command#cacheProperty in class migration_command
revert::configure() — Method in class revert
migration_tips::configure() — Method in class migration_tips
commandClass in namespace phpbb\console\command\extension
$ command#cache_driver_classProperty in class command
command::check_apcu_cache() — Method in class command

Check if APCu cache driver is used and enabled for CLI, otherwise display a notice.

disable::configure() — Method in class disable
enable::configure() — Method in class enable
purge::configure() — Method in class purge
show::configure() — Method in class show
$ fix_left_right_ids#cacheProperty in class fix_left_right_ids
fix_left_right_ids::configure() — Method in class fix_left_right_ids
{@inheritdoc}
$ update_hashes#configProperty in class update_hashes
update_hashes::configure() — Method in class update_hashes
{@inheritdoc}
list_all::configure() — Method in class list_all

Sets the command name and description

reparse::configure() — Method in class reparse

Sets the command name and description

$ delete#configProperty in class delete
delete::configure() — Method in class delete

Sets the command name and description

delete::commit_changes() — Method in class delete

Commits the changes to the database

$ generate#configProperty in class generate
$ generate#cacheProperty in class generate
generate::configure() — Method in class generate

Sets the command name and description

generate::commit_changes() — Method in class generate

Commits the changes to the database

recreate::configure() — Method in class recreate

Sets the command name and description

checkClass in namespace phpbb\console\command\update
$ check#configProperty in class check
check::configure() — Method in class check

Configures the service.

check::check_ext() — Method in class check

Check if a given extension is up to date

check::check_core() — Method in class check

Check if the core is up to date

check::check_all_ext() — Method in class check

Check if all the available extensions are up to date

$ activate#configProperty in class activate
activate::configure() — Method in class activate

Sets the command name and description

$ add#configProperty in class add
add::configure() — Method in class add

Sets the command name and description

delete::configure() — Method in class delete

Sets the command name and description

reclean::configure() — Method in class reclean

Sets the command name and description

content_visibilityClass in namespace phpbb

phpbb_visibility Handle fetching and setting the visibility for topics and posts

$ content_visibility#configProperty in class content_visibility

config object

content_visibility::can_soft_delete() — Method in class content_visibility

Can the current logged-in user soft-delete posts?

$ helper#cacheProperty in class helper
$ helper#configProperty in class helper
$ helper#cron_managerProperty in class helper
$ resolver#containerProperty in class resolver

ContainerInterface object

convertorClass in namespace phpbb\convert\controller

Controller for forum convertors

$ convertor#cacheProperty in class convertor
$ convertor#configProperty in class convertor
$ convertor#config_php_fileProperty in class convertor
$ convertor#config_tableProperty in class convertor
$ convertor#controller_helperProperty in class convertor
convertor::convert() — Method in class convertor

Run conversion

convertClass in namespace phpbb\convert

Class holding all convertor-specific details.

$ convert#convertor_tagProperty in class convert
$ convert#convertor_dataProperty in class convert
$ convert#config_schemaProperty in class convert
$ convert#convertorProperty in class convert
convertorClass in namespace phpbb\convert

Convertor backend class

$ convertor#controller_helperProperty in class convertor
convertor::convert_data() — Method in class convertor

The function which does the actual work (or dispatches it to the relevant places)

cronClass in namespace phpbb\cron\controller

Controller for running cron jobs

cron_runner_listenerClass in namespace phpbb\cron\event

Event listener that executes cron tasks, after the response was served

$ prune_all_forums#configProperty in class prune_all_forums
$ prune_forum#configProperty in class prune_forum
$ prune_notifications#configProperty in class prune_notifications
$ prune_shadow_topics#configProperty in class prune_shadow_topics
$ queue#cache_dirProperty in class queue
$ queue#configProperty in class queue
$ tidy_cache#configProperty in class tidy_cache
$ tidy_cache#cacheProperty in class tidy_cache
$ tidy_plupload#cron_frequencyProperty in class tidy_plupload

How often we run the cron (in seconds).

$ tidy_plupload#configProperty in class tidy_plupload

Config object

$ tidy_search#configProperty in class tidy_search

Config object

$ tidy_sessions#configProperty in class tidy_sessions
$ tidy_warnings#configProperty in class tidy_warnings
$ update_hashes#configProperty in class update_hashes
$ reparser#configProperty in class reparser
$ reparser#config_textProperty in class reparser
$ driver#curtimeProperty in class driver
driver::cast_expr_to_bigint() — Method in class driver

Returns SQL string to cast a string expression to an int.

driver::cast_expr_to_string() — Method in class driver

Returns SQL string to cast an integer expression to a string.

driver::clean_query_id() — Method in class driver

Ensure query ID can be used by cache

driver_interface::cast_expr_to_bigint() — Method in class driver_interface

Returns SQL string to cast a string expression to an int.

driver_interface::cast_expr_to_string() — Method in class driver_interface

Returns SQL string to cast an integer expression to a string.

driver_interface::clean_query_id() — Method in class driver_interface

Ensure query ID can be used by cache

$ factory#containerProperty in class factory
factory::cast_expr_to_bigint() — Method in class factory

Returns SQL string to cast a string expression to an int.

factory::cast_expr_to_string() — Method in class factory

Returns SQL string to cast an integer expression to a string.

factory::clean_query_id() — Method in class factory

Ensure query ID can be used by cache

mssql_base::cast_expr_to_bigint() — Method in class mssql_base

Returns SQL string to cast a string expression to an int.

$ mssql_odbc#connect_errorProperty in class mssql_odbc
$ mssqlnative#connect_errorProperty in class mssqlnative
$ mysqli#connect_errorProperty in class mysqli
$ oracle#connect_errorProperty in class oracle
$ postgres#connect_errorProperty in class postgres
postgres::cast_expr_to_bigint() — Method in class postgres

Returns SQL string to cast a string expression to an int.

postgres::cast_expr_to_string() — Method in class postgres

Returns SQL string to cast an integer expression to a string.

$ sqlite3#connect_errorProperty in class sqlite3
$ base_extractor#closeProperty in class base_extractor
$ factory#containerProperty in class factory
container_aware_migrationClass in namespace phpbb\db\migration

Abstract base class for container aware database migrations.

$ container_aware_migration#containerProperty in class container_aware_migration
$ migration#configProperty in class migration
profilefield_base_migration::create_custom_field() — Method in class profilefield_base_migration
profilefield_base_migration::create_language_entries() — Method in class profilefield_base_migration

Create Custom profile fields languguage entries

profilefield_base_migration::convert_user_field_to_custom_field() — Method in class profilefield_base_migration
$ schema_generator#configProperty in class schema_generator
$ schema_generator#class_namesProperty in class schema_generator
schema_generator::check_dependencies() — Method in class schema_generator

Check if one of the migrations files' dependencies can't be resolved by the supplied list of migrations

configClass in namespace phpbb\db\migration\tool

Migration config tool

$ config#configProperty in class config
config_textClass in namespace phpbb\db\migration\tool

Migration config_text tool

$ config_text#config_textProperty in class config_text
$ module#cacheProperty in class module
$ permission#cacheProperty in class permission
$ migrator#containerProperty in class migrator
$ migrator#configProperty in class migrator
migrator::create_migrations_table() — Method in class migrator

Creates the migrations table if it does not exist.

tools::check_index_name_length() — Method in class tools

Check whether the index name is too long

container_builderClass in namespace phpbb\di
$ container_builder#containerProperty in class container_builder

The container under construction

$ container_builder#config_pathProperty in class container_builder

Defines a custom path to find the configuration of the container (default to $this->phpbb_root_path . 'config')

$ container_builder#compile_containerProperty in class container_builder

Indicates if the container should be compiled automatically (default to true).

$ container_builder#custom_parametersProperty in class container_builder

Custom parameters to inject into the container.

$ container_builder#config_php_fileProperty in class container_builder
$ container_builder#cache_dirProperty in class container_builder
container_builder::create_container() — Method in class container_builder

Create the ContainerBuilder object

configClass in namespace phpbb\di\extension

Container config extension

$ config#config_phpProperty in class config
config::convert_30_acm_type() — Method in class config

Convert 3.0 ACM type to 3.1 cache driver class name

container_configurationClass in namespace phpbb\di\extension
coreClass in namespace phpbb\di\extension

Container core extension

$ core#config_pathProperty in class core

Config path

collection_passClass in namespace phpbb\di\pass

Appends an add method call to the definition of each collection service for the services tagged with the appropriate name defined in the collection's service_collection tag.

$ service_collection#containerProperty in class service_collection
$ service_collection_iterator#collectionProperty in class service_collection_iterator
service_collection_iterator::current() — Method in class service_collection_iterator
{@inheritdoc}
$ md_exporter#current_eventProperty in class md_exporter
md_exporter::crawl_phpbb_directory_adm() — Method in class md_exporter
md_exporter::crawl_phpbb_directory_styles() — Method in class md_exporter
md_exporter::crawl_eventsmd() — Method in class md_exporter
md_exporter::crawl_file_for_events() — Method in class md_exporter

Get all template events in a template file

$ php_exporter#current_fileProperty in class php_exporter
$ php_exporter#current_eventProperty in class php_exporter
$ php_exporter#current_event_lineProperty in class php_exporter
php_exporter::crawl_phpbb_directory_php() — Method in class php_exporter

Crawl the phpBB/ directory for php events

php_exporter::crawl_php_file() — Method in class php_exporter
$ base#containerProperty in class base
$ manager#containerProperty in class manager
$ manager#configProperty in class manager
$ manager#cacheProperty in class manager
$ manager#cache_nameProperty in class manager
manager::create_extension_metadata_manager() — Method in class manager

Instantiates the metadata manager for the extension with the given name

$ base#configProperty in class base
$ base#cacheProperty in class base
$ base#content_visibilityProperty in class base
base::close() — Method in class base

Close feed

$ feed#controller_helperProperty in class feed
$ feed#configProperty in class feed
$ feed#containerProperty in class feed
feed_interface::close() — Method in class feed_interface

Close feed

$ helper#configProperty in class helper
$ helper#containerProperty in class helper
$ filespec#class_initializedProperty in class filespec
filespec::clean_filename() — Method in class filespec

Cleans destination filename

filespec::check_content() — Method in class filespec

Check the first 256 bytes for forbidden content

base::check_upload_size() — Method in class base

Check if upload exceeds maximum file size

$ remote#configProperty in class remote
upload::common_checks() — Method in class upload

Perform common file checks

$ filesystem#chmod_infoProperty in class filesystem

Store some information about file ownership for phpBB's chmod function

filesystem::chgrp() — Method in class filesystem

Change owner group of files/directories

filesystem::chmod() — Method in class filesystem

Global function for chmodding directories and files for internal use

filesystem::chown() — Method in class filesystem

Change owner group of files/directories

filesystem::clean_path() — Method in class filesystem

Eliminates useless . and .. components from specified path.

filesystem::copy() — Method in class filesystem

Copies a file.

filesystem_interface::chgrp() — Method in class filesystem_interface

Change owner group of files/directories

filesystem_interface::chmod() — Method in class filesystem_interface

Global function for chmodding directories and files for internal use

filesystem_interface::chown() — Method in class filesystem_interface

Change owner group of files/directories

filesystem_interface::clean_path() — Method in class filesystem_interface

Eliminates useless . and .. components from specified path.

filesystem_interface::copy() — Method in class filesystem_interface

Copies a file.

$ finder#cacheProperty in class finder
$ finder#cache_nameProperty in class finder

The cache variable name used to store $this->cached_queries in $this->cache.

$ finder#cached_queriesProperty in class finder

A map from md5 hashes of serialized queries to their previously retrieved results.

finder::core_path() — Method in class finder

Sets a core path to be searched in addition to extensions

finder::core_suffix() — Method in class finder

Sets a suffix all files found in the core path must match

finder::core_prefix() — Method in class finder

Sets a prefix all files found in the core path must match

finder::core_directory() — Method in class finder

Sets a directory all files found in the core path must be contained in

$ helper#cacheProperty in class helper
$ helper#configProperty in class helper
$ teampage#cacheProperty in class teampage

Cache object

controllerClass in namespace phpbb\help\controller

BBCode help page

$ finder#cacheProperty in class finder
show::configure() — Method in class show
{@inheritdoc}
validate::configure() — Method in class validate
{@inheritdoc}
install::configure() — Method in class install
{@inheritdoc}
show::configure() — Method in class show
{@inheritdoc}
validate::configure() — Method in class validate
{@inheritdoc}
update::configure() — Method in class update
{@inheritdoc}
archive_download::conflict_archive() — Method in class archive_download

Sends response with the merge conflict archive

$ install#controller_helperProperty in class install
$ update#controller_helperProperty in class update
$ kernel_exception_subscriber#controller_helperProperty in class kernel_exception_subscriber
cannot_build_container_exceptionClass in namespace phpbb\install\exception

Thrown when the container cannot be built

configClass in namespace phpbb\install\helper

Stores common settings and installation status

config::create_progress_restart_point() — Method in class config

Creates a progress restart point

config::clean_up_config_file() — Method in class config

Removes install config file

container_factoryClass in namespace phpbb\install\helper
$ container_factory#containerProperty in class container_factory

The full phpBB container

compression_file_updaterClass in namespace phpbb\install\helper\file_updater

File updater for generating archive with updated files

$ compression_file_updater#compressProperty in class compression_file_updater
compression_file_updater::close() — Method in class compression_file_updater

Close archive writing process

compression_file_updater::create_new_file() — Method in class compression_file_updater

Creates a new file

file_updater::create_new_file() — Method in class file_updater

Creates a new file

file_updater_interface::create_new_file() — Method in class file_updater_interface

Creates a new file

ftp_file_updater::close() — Method in class ftp_file_updater

Close FTP session

ftp_file_updater::create_new_file() — Method in class ftp_file_updater

Creates a new file

$ ajax_iohandler#cookiesProperty in class ajax_iohandler
cli_iohandlerClass in namespace phpbb\install\helper\iohandler

Input-Output handler for the CLI frontend

$ factory#containerProperty in class factory
$ iohandler_base#current_task_progressProperty in class iohandler_base
$ iohandler_base#current_task_nameProperty in class iohandler_base
convertor_navigationClass in namespace phpbb\install\helper\navigation
$ installer#cacheProperty in class installer
$ installer#container_factoryProperty in class installer
create_config_fileClass in namespace phpbb\install\module\install_filesystem\task

Dumps config file

$ install_extensions#configProperty in class install_extensions
$ notify_user#configProperty in class notify_user
$ populate_migrations#configProperty in class populate_migrations
check_filesystemClass in namespace phpbb\install\module\requirements\task

Checks filesystem requirements

check_filesystem::check_file() — Method in class check_filesystem

Check if a file is readable and writable

check_filesystem::check_dir() — Method in class check_filesystem

Check if a directory is readable and writable

check_server_environmentClass in namespace phpbb\install\module\requirements\task

Installer task that checks if the server meets phpBB requirements

check_server_environment::check_php_version() — Method in class check_server_environment

Check if the requirements for PHP version is met

check_server_environment::check_image_size() — Method in class check_server_environment

Checks if the installed PHP has getimagesize() available

check_server_environment::check_pcre() — Method in class check_server_environment

Checks if the installed PHP supports PCRE

check_server_environment::check_json() — Method in class check_server_environment

Checks whether PHP's JSON extension is available or not

check_server_environment::check_mbstring() — Method in class check_server_environment

Checks whether PHP's mbstring extension is available or not

check_server_environment::check_xml() — Method in class check_server_environment

Checks whether or not the XML PHP extension is available (Required by the text formatter)

check_server_environment::check_available_dbms() — Method in class check_server_environment

Check if any supported DBMS is available

check_updateClass in namespace phpbb\install\module\requirements\task

Check the availability of updater files and update version

$ check_update#configProperty in class check_update
$ diff_files#cacheProperty in class diff_files
diff_files::check_requirements() — Method in class diff_files

Checks requirements for the tasks

download_updated_files::check_requirements() — Method in class download_updated_files

Checks requirements for the tasks

file_check::check_requirements() — Method in class file_check

Checks requirements for the tasks

$ show_file_status#cacheProperty in class show_file_status
show_file_status::check_requirements() — Method in class show_file_status

Checks requirements for the tasks

$ update_files#cacheProperty in class update_files
update_files::check_requirements() — Method in class update_files

Checks requirements for the tasks

module_base::check_requirements() — Method in class module_base

Checks requirements for the tasks

module_interface::check_requirements() — Method in class module_interface

Checks requirements for the tasks

task_base::check_requirements() — Method in class task_base

Checks requirements for the tasks

task_interface::check_requirements() — Method in class task_interface

Checks requirements for the tasks

$ language#common_language_filesProperty in class language
$ language#common_language_files_loadedProperty in class language
$ admin_form#config_textProperty in class admin_form
admin_form::check_allow() — Method in class admin_form
{inheritDoc}
$ form#configProperty in class form
$ form#cc_senderProperty in class form
form::check_allow() — Method in class form

Checks whether the user is allowed to use the form

message::cc_sender() — Method in class message

Ok, now the same email if CC specified, but without exposing the user's email address

topic_form::check_allow() — Method in class topic_form
{inheritDoc}
user_form::check_allow() — Method in class user_form
{inheritDoc}
content_guesserClass in namespace phpbb\mimetype
guesser::choose_mime_type() — Method in class guesser

Choose the best mime type based on the current mime type and the guess If a guesser returns nulls or application/octet-stream, we will keep the current guess. Guesses with a slash inside them will be favored over already existing ones. However, any guess that will pass the first check will always overwrite the default application/octet-stream.

$ module_manager#cacheProperty in class module_manager
$ manager#cacheProperty in class manager
$ board#cacheProperty in class board
$ board#configProperty in class board
$ email#configProperty in class email
email::clean_data() — Method in class email

Clean data to contain only what we need for email notifications table

$ jabber#configProperty in class jabber
$ admin_activate_user#configProperty in class admin_activate_user
admin_activate_user::create_insert_array() — Method in class admin_activate_user

Function for preparing the data for insertion in an SQL query

approve_post::create_insert_array() — Method in class approve_post

Function for preparing the data for insertion in an SQL query

approve_topic::create_insert_array() — Method in class approve_topic

Function for preparing the data for insertion in an SQL query

base::create_insert_array() — Method in class base

Function for preparing the data for insertion in an SQL query

base::create_update_array() — Method in class base

Function for preparing the data for update in an SQL query (The service handles insertion)

base::check_user_notification_options() — Method in class base

Find the users who want to receive notifications (helper)

disapprove_post::create_insert_array() — Method in class disapprove_post

Function for preparing the data for insertion in an SQL query

disapprove_topic::create_insert_array() — Method in class disapprove_topic

Function for preparing the data for insertion in an SQL query

group_request::create_insert_array() — Method in class group_request

Function for preparing the data for insertion in an SQL query

group_request_approved::create_insert_array() — Method in class group_request_approved

Function for preparing the data for insertion in an SQL query

$ pm#configProperty in class pm
pm::create_insert_array() — Method in class pm

Function for preparing the data for insertion in an SQL query

$ post#configProperty in class post
post::create_insert_array() — Method in class post

Function for preparing the data for insertion in an SQL query

post_in_queue::create_insert_array() — Method in class post_in_queue

Function for preparing the data for insertion in an SQL query

report_pm::create_insert_array() — Method in class report_pm

Function for preparing the data for insertion in an SQL query

report_pm_closed::create_insert_array() — Method in class report_pm_closed

Function for preparing the data for insertion in an SQL query

report_post::create_insert_array() — Method in class report_post

Function for preparing the data for insertion in an SQL query

report_post_closed::create_insert_array() — Method in class report_post_closed

Function for preparing the data for insertion in an SQL query

$ topic#configProperty in class topic
topic::create_insert_array() — Method in class topic

Function for preparing the data for insertion in an SQL query

topic_in_queue::create_insert_array() — Method in class topic_in_queue

Function for preparing the data for insertion in an SQL query

type_interface::create_insert_array() — Method in class type_interface

Function for preparing the data for insertion in an SQL query

type_interface::create_update_array() — Method in class type_interface

Function for preparing the data for update in an SQL query (The service handles insertion)

$ base#configProperty in class base
base_native::check() — Method in class base_native

Check the password against the supplied hash

$ bcrypt#cost_factorProperty in class bcrypt
bcrypt::check() — Method in class bcrypt

Check the password against the supplied hash

bcrypt_wcf2::check() — Method in class bcrypt_wcf2

Check the password against the supplied hash

convert_passwordClass in namespace phpbb\passwords\driver
convert_password::check() — Method in class convert_password

Check the password against the supplied hash

driver_interface::check() — Method in class driver_interface

Check the password against the supplied hash

$ helper#configProperty in class helper
md5_mybb::check() — Method in class md5_mybb

Check the password against the supplied hash

md5_phpbb2::check() — Method in class md5_phpbb2

Check the password against the supplied hash

md5_vb::check() — Method in class md5_vb

Check the password against the supplied hash

salted_md5::check() — Method in class salted_md5

Check the password against the supplied hash

sha1::check() — Method in class sha1

Check the password against the supplied hash

sha1_smf::check() — Method in class sha1_smf

Check the password against the supplied hash

sha1_wcf1::check() — Method in class sha1_wcf1

Check the password against the supplied hash

sha_xf1::check() — Method in class sha_xf1

Check the password against the supplied hash

helper::combine_hash_output() — Method in class helper

Combine hash prefixes, settings, and actual hash

$ manager#convert_flagProperty in class manager

Password convert flag. Signals that password should be converted

$ manager#configProperty in class manager

phpBB configuration

manager::check() — Method in class manager

Check supplied password against hash and set convert_flag if password needs to be converted to different format (preferably newer one)

manager::combined_hash_password() — Method in class manager

Create combined hash from already hashed password

manager::check_combined_hash() — Method in class manager

Check combined password hash against the supplied password

path_helper::clean_url() — Method in class path_helper

Eliminates useless . and .. components from specified URL

$ permissions#categoriesProperty in class permissions
permissions::category_defined() — Method in class permissions

Checks if a category has been defined

$ plupload#configProperty in class plupload
plupload::configure() — Method in class plupload

Fill in the plupload configuration options in the template

$ manager#config_textProperty in class manager
$ report#configProperty in class report
$ report#captcha_factoryProperty in class report
report::check_captcha() — Method in class report

Check CAPTCHA

$ handler_factory#containerProperty in class handler_factory
$ report_handler#configProperty in class report_handler
report_handler::create_report() — Method in class report_handler

Creates a report entity in the database

deactivated_super_global::count() — Method in class deactivated_super_global

Part of the \Countable implementation, will always result in a FATAL error

$ helper#configProperty in class helper

config object

chained_resources_locatorClass in namespace phpbb\routing\resources_locator
$ router#containerProperty in class router
$ router#contextProperty in class router
$ router#cache_dirProperty in class router
router::create_dumped_url_matcher() — Method in class router

Creates a new dumped URL Matcher (dump it if necessary)

router::create_new_url_matcher() — Method in class router

Creates a new URL Matcher

router::create_dumped_url_generator() — Method in class router

Creates a new dumped URL Generator (dump it if necessary)

router::create_new_url_generator() — Method in class router

Creates a new URL Generator

$ fulltext_mysql#configProperty in class fulltext_mysql

Config object

$ fulltext_mysql#common_wordsProperty in class fulltext_mysql

Contains common words.

fulltext_mysql::create_index() — Method in class fulltext_mysql

Create fulltext index

$ fulltext_native#common_wordsProperty in class fulltext_native

Contains common words.

$ fulltext_native#configProperty in class fulltext_native

Config object

fulltext_native::cleanup() — Method in class fulltext_native

Clean up a text to remove non-alphanumeric characters

$ fulltext_postgres#configProperty in class fulltext_postgres

Config object

$ fulltext_postgres#common_wordsProperty in class fulltext_postgres

Contains common words.

fulltext_postgres::create_index() — Method in class fulltext_postgres

Create fulltext index

$ fulltext_sphinx#configProperty in class fulltext_sphinx

Config object

$ fulltext_sphinx#config_file_dataProperty in class fulltext_sphinx

Stores the generated content of the sphinx config file

fulltext_sphinx::config_generate() — Method in class fulltext_sphinx

Generates content of sphinx.conf

fulltext_sphinx::create_index() — Method in class fulltext_sphinx

Create sphinx table

configClass in namespace phpbb\search\sphinx

An object representing the sphinx configuration Can read it from file and write it back out after modification

config_commentClass in namespace phpbb\search\sphinx

\phpbb\search\sphinx\config_comment Represents a comment inside the sphinx configuration

config_sectionClass in namespace phpbb\search\sphinx

\phpbb\search\sphinx\config_section Represents a single section inside the sphinx configuration

config_section::create_variable() — Method in class config_section

Create a new variable object and append it to the variable list of this section

config_variableClass in namespace phpbb\search\sphinx

\phpbb\search\sphinx\config_variable Represents a single variable inside the sphinx configuration

$ session#cookie_dataProperty in class session
session::check_ban() — Method in class session

Check for banned user

session::check_ban_for_current_session() — Method in class session

Check the current session for bans

session::check_dnsbl_spamhaus() — Method in class session

Check if ip is blacklisted by Spamhaus SBL

session::check_dnsbl_ipv4_generic() — Method in class session

Checks if an IPv4 address is in a specified DNS blacklist

session::check_dnsbl() — Method in class session

Check if ip is blacklisted This should be called only where absolutely necessary

$ asset#componentsProperty in class asset
$ base#contextProperty in class base

Template context.

base::call_hook() — Method in class base

Calls hook if any is defined.

contextClass in namespace phpbb\template

Stores variables assigned to template.

context::clear() — Method in class context

Clears template data set.

template::clear_cache() — Method in class template

Clear the cache

$ environment#containerProperty in class environment
$ extension#contextProperty in class extension
configClass in namespace phpbb\template\twig\extension
$ config#configProperty in class config
definenode::compile() — Method in class definenode

Compiles the node to PHP.

event::compile() — Method in class event

Compiles the node to PHP.

includeasset::compile() — Method in class includeasset

Compiles the node to PHP.

includenode::compile() — Method in class includenode

Compiles the node to PHP.

includephp::compile() — Method in class includephp

Compiles the node to PHP.

php::compile() — Method in class php

Compiles the node to PHP.

$ twig#configProperty in class twig

phpBB config instance

twig::clear_cache() — Method in class twig

Clear the cache

cache_interfaceClass in namespace phpbb\textformatter

Currently only used to signal that something that could effect the rendering has changed.

$ bbcode_merger#configuratorProperty in class bbcode_merger
bbcode_merger::create_bbcode() — Method in class bbcode_merger

Create a custom BBCode for inspection

$ factory#cacheProperty in class factory
$ factory#cache_dirProperty in class factory
$ factory#cache_key_parserProperty in class factory
$ factory#cache_key_rendererProperty in class factory
$ factory#configProperty in class factory
$ factory#custom_tokensProperty in class factory
factory::configure_autolink() — Method in class factory

Configure the Autolink / Autoemail plugins used to linkify text

link_helper::cleanup_tag() — Method in class link_helper

Clean up and invalidate a LINK_TEXT tag if applicable

$ renderer#censorProperty in class renderer
renderer::configure_quote_helper() — Method in class renderer

Configure the quote_helper object used to display extended information in quotes

renderer::configure_smilies_path() — Method in class renderer

Automatically set the smilies path based on config

renderer::configure_user() — Method in class renderer

Configure this renderer as per the user's settings

utils::clean_formatting() — Method in class utils

Replace BBCodes and other formatting elements with whitespace

utils_interface::clean_formatting() — Method in class utils_interface

Replace BBCodes and other formatting elements with whitespace

$ manager#configProperty in class manager
$ manager#config_textProperty in class manager
contact_admin_infoClass in namespace phpbb\textreparser\plugins
$ contact_admin_info#config_textProperty in class contact_admin_info
$ nestedset#column_item_idProperty in class nestedset

Column names in the table

$ nestedset#column_left_idProperty in class nestedset
$ nestedset#column_right_idProperty in class nestedset
$ nestedset#column_parent_idProperty in class nestedset
$ nestedset#column_item_parentsProperty in class nestedset
nestedset::change_parent() — Method in class nestedset

Change parent item

tree_interface::change_parent() — Method in class tree_interface

Change parent item

$ reset_password#configProperty in class reset_password
user::create_timezone() — Method in class user

Create a DateTimeZone object in the context of the current user

user::create_datetime() — Method in class user

Create a \phpbb\datetime object in the context of the current user

$ version_helper#current_versionProperty in class version_helper
$ version_helper#cacheProperty in class version_helper
$ version_helper#configProperty in class version_helper
version_helper::compare() — Method in class version_helper

Wrapper for version_compare() that allows using uppercase A and B for alpha and beta releases.

$ phpbb_hook#current_hookProperty in class phpbb_hook

internal pointer

phpbb_hook::call_hook() — Method in class phpbb_hook

Calling all functions/methods attached to a specified hook.

phpbb_questionnaire_data_collector::collect() — Method in class phpbb_questionnaire_data_collector

Collect info into the data property.

$ phpbb_questionnaire_phpbb_data_provider#configProperty in class phpbb_questionnaire_phpbb_data_provider
$ queue#cache_fileProperty in class queue
$ smtp_class#commandsProperty in class smtp_class
smtp_class::close_session() — Method in class smtp_class

Close session

smtp_class::cram_md5() — Method in class smtp_class

cram_md5 authentication method

$ transfer#connectionProperty in class transfer
transfer::copy_file() — Method in class transfer

Copy file from source location to destination location

transfer::close_session() — Method in class transfer

Close current session

D

$ acp_attachments#dbProperty in class acp_attachments
acp_attachments::display_order() — Method in class acp_attachments

Write display_order config field

acp_board::dateformat_select() — Method in class acp_board

Select default dateformat

acp_captcha::deliver_demo() — Method in class acp_captcha

Entry point for delivering image CAPTCHAs in the ACP.

acp_forums::delete_forum() — Method in class acp_forums

Remove complete forum

acp_forums::delete_forum_content() — Method in class acp_forums

Delete forum content

acp_forums::display_progress_bar() — Method in class acp_forums

Display progress bar for syncinc forums

acp_permission_roles::display_auth_options() — Method in class acp_permission_roles

Display permission settings able to be set

$ acp_styles#default_styleProperty in class acp_styles
$ acp_styles#dbProperty in class acp_styles
$ acp_styles#dispatcherProperty in class acp_styles
acp_styles::delete_style_files() — Method in class acp_styles

Delete all files in style directory

acp_styles::default_bitfield() — Method in class acp_styles

Generates default bitfield

auth_admin::display_mask() — Method in class auth_admin

Display permission mask (assign to template)

auth_admin::display_role_mask() — Method in class auth_admin

Display permission mask for roles

$ bitfield#dataProperty in class bitfield
compress_tar::data() — Method in class compress_tar

Create the structures

compress_tar::download() — Method in class compress_tar

Download archive

$ compress_zip#datasecProperty in class compress_zip
$ compress_zip#datasec_lenProperty in class compress_zip
compress_zip::data() — Method in class compress_zip

Create the structures ... note we assume version made by is MSDOS

compress_zip::download() — Method in class compress_zip

Download archive

diffClass in namespace [Global Namespace]

Code from pear.php.net, Text_Diff-1.1.0 package http://pear.php.net/package/Text_Diff/

diff3Class in namespace [Global Namespace]

A class for computing three way diffs.

diff3_block_builderClass in namespace [Global Namespace]
diff3_opClass in namespace [Global Namespace]
diff3_op_copyClass in namespace [Global Namespace]
diff_engineClass in namespace [Global Namespace]

Code from pear.php.net, Text_Diff-1.1.0 package http://pear.php.net/package/Text_Diff/ (native engine)

diff_engine::diff() — Method in class diff_engine
diff_opClass in namespace [Global Namespace]
diff_op_addClass in namespace [Global Namespace]
diff_op_changeClass in namespace [Global Namespace]
diff_op_copyClass in namespace [Global Namespace]
diff_op_deleteClass in namespace [Global Namespace]
diff_rendererClass in namespace [Global Namespace]

Code from pear.php.net, Text_Diff-1.1.0 package http://pear.php.net/package/Text_Diff/

diff_renderer_inlineClass in namespace [Global Namespace]

"Inline" diff renderer.

diff_renderer_rawClass in namespace [Global Namespace]

"raw" diff renderer.

diff_renderer_side_by_sideClass in namespace [Global Namespace]

"chora (Horde)" diff renderer - similar style.

$ diff_renderer_side_by_side#dataProperty in class diff_renderer_side_by_side
diff_renderer_unifiedClass in namespace [Global Namespace]

Renders a unified diff

ftp::data() — Method in class ftp

Requests data

$ ftp_fsock#data_connectionProperty in class ftp_fsock
ftp_fsock::data() — Method in class ftp_fsock

Requests data

jabber::disconnect() — Method in class jabber
Disconnect
mcp_queue::disapprove_posts() — Method in class mcp_queue

Disapprove Post

p_master::display() — Method in class p_master

Display module

parse_message::decode_message() — Method in class parse_message

Decode message to be placed back into form box

deleteClass in namespace phpbb\attachment

Attachment delete class

$ delete#dbProperty in class delete
$ delete#dispatcherProperty in class delete
delete::delete() — Method in class delete

Delete Attachments

delete::delete_attachments_from_db() — Method in class delete

Delete attachments from database table

$ manager#deleteProperty in class manager
manager::delete() — Method in class manager

Wrapper method for deleting attachments

$ resync#dbProperty in class resync
$ apache#dbProperty in class apache
dbClass in namespace phpbb\auth\provider

Database authentication provider for phpBB3 This is for authentication via the integrated user table

$ db#dbProperty in class db
$ ldap#dbProperty in class ldap
$ oauth#dbProperty in class oauth
$ oauth#db_authProperty in class oauth
$ oauth#dispatcherProperty in class oauth
$ token_storage#dbProperty in class token_storage
driverClass in namespace phpbb\avatar\driver

Base class for avatar drivers

driver::delete() — Method in class driver

Delete avatar

driver_interfaceClass in namespace phpbb\avatar\driver

Interface for avatar drivers

driver_interface::delete() — Method in class driver_interface

Delete avatar

$ upload#dispatcherProperty in class upload
upload::delete() — Method in class upload

Delete avatar

$ manager#default_rowProperty in class manager

Default avatar data row

driver_interfaceClass in namespace phpbb\cache\driver

An interface that all cache drivers must implement

driver_interface::destroy() — Method in class driver_interface

Destroy cache data

dummyClass in namespace phpbb\cache\driver

ACM dummy Caching

dummy::destroy() — Method in class dummy

Destroy cache data

file::destroy() — Method in class file

Destroy cache data

memory::destroy() — Method in class memory

Destroy cache data

$ service#driverProperty in class service

Cache driver.

$ service#dbProperty in class service

Database connection.

$ service#dispatcherProperty in class service
service::deferred_purge() — Method in class service

Deferred purge of the cache.

char_cube3d::drawchar() — Method in class char_cube3d

Draw a character

char_cube3d::dimensions() — Method in class char_cube3d
dimensions
non_gd::define_filtered_pngs() — Method in class non_gd

png image data Each 'data' element is base64_encoded uncompressed IDAT

config::delete() — Method in class config

Removes a configuration option

dbClass in namespace phpbb\config

Configuration container class

$ db#dbProperty in class db

Database connection

db::delete() — Method in class db

Removes a configuration option

db_textClass in namespace phpbb\config

Manages configuration options with an arbitrary length value stored in a TEXT column. In constrast to class \phpbb\config\db, values are never cached and prefetched, but every get operation sends a query to the database.

$ db_text#dbProperty in class db_text

Database connection

db_text::delete() — Method in class db_text

Removes the configuration option with the name $key.

db_text::delete_array() — Method in class db_text

Mass delete configuration options.

application::doRun() — Method in class application
{@inheritdoc}
$ purge#dbProperty in class purge
deleteClass in namespace phpbb\console\command\config
disableClass in namespace phpbb\console\command\extension
$ fix_left_right_ids#dbProperty in class fix_left_right_ids
$ update_hashes#dbProperty in class update_hashes
$ update_hashes#default_typeProperty in class update_hashes
deleteClass in namespace phpbb\console\command\thumbnail
$ delete#dbProperty in class delete
$ generate#dbProperty in class generate
check::display_versions() — Method in class check

Display the details of the available updates

$ activate#dbProperty in class activate
$ add#dataProperty in class add
$ add#dbProperty in class add
deleteClass in namespace phpbb\console\command\user
$ delete#dbProperty in class delete
$ reclean#dbProperty in class reclean
$ content_visibility#dbProperty in class content_visibility

Database object

$ helper#dbProperty in class helper
$ helper#dispatcherProperty in class helper
helper::display_footer() — Method in class helper

Handle display actions for footer, e.g. SQL report and credit line

helper::display_sql_report() — Method in class helper

Display SQL report

$ convertor#db_helperProperty in class convertor
$ convertor#dbProperty in class convertor
convertor::db_error() — Method in class convertor

Database error handler function

$ prune_all_forums#dbProperty in class prune_all_forums
$ prune_forum#dbProperty in class prune_forum
$ prune_shadow_topics#dbProperty in class prune_shadow_topics
$ tidy_search#dbProperty in class tidy_search

Database object

$ update_hashes#dbProperty in class update_hashes
$ update_hashes#default_typeProperty in class update_hashes
datetimeClass in namespace phpbb

phpBB custom extensions to the PHP DateTime class This handles the relative formats phpBB employs

driverClass in namespace phpbb\db\driver

Database Abstraction Layer

$ driver#db_connect_idProperty in class driver
$ driver#dbnameProperty in class driver
$ driver#debug_load_timeProperty in class driver
$ driver#debug_sql_explainProperty in class driver
driver_interfaceClass in namespace phpbb\db\driver
$ factory#driverProperty in class factory
$ sqlite3#dboProperty in class sqlite3
$ base_extractor#dbProperty in class base_extractor
$ base_extractor#downloadProperty in class base_extractor
$ factory#dbProperty in class factory
$ migration#dbProperty in class migration
$ migration#db_toolsProperty in class migration
migration::depends_on() — Method in class migration

Defines other migrations to be applied first

migration_interface::depends_on() — Method in class migration_interface

Defines other migrations to be applied first

profilefield_base_migration::delete_custom_profile_field_data() — Method in class profilefield_base_migration

Clean database when reverting the migration

$ schema_generator#dbProperty in class schema_generator
$ schema_generator#db_toolsProperty in class schema_generator
$ schema_generator#dependenciesProperty in class schema_generator
$ module#dbProperty in class module
$ permission#dbProperty in class permission
$ migrator#dbProperty in class migrator
$ migrator#db_toolsProperty in class migrator
$ sql_insert_buffer#dbProperty in class sql_insert_buffer
$ tools#dbProperty in class tools
$ tools#dbms_type_mapProperty in class tools

The Column types for every database we support

debugClass in namespace phpbb\debug

Registers all the debug tools.

$ container_builder#dbal_connectionProperty in class container_builder
container_builder::dump_container() — Method in class container_builder

Dump the container to the disk.

dispatcherClass in namespace phpbb\event

Extension of the Symfony EventDispatcher

$ dispatcher#disabledProperty in class dispatcher
dispatcher::dispatch() — Method in class dispatcher
{@inheritdoc}
dispatcher::disable() — Method in class dispatcher

Disable the event dispatcher.

dispatcher_interfaceClass in namespace phpbb\event

Extension of the Symfony2 EventDispatcher

dispatcher_interface::disable() — Method in class dispatcher_interface

Disable the event dispatcher.

$ kernel_exception_subscriber#debugProperty in class kernel_exception_subscriber

Set to true to show full exception messages

base::disable_step() — Method in class base

Single disable step that does nothing

extension_interface::disable_step() — Method in class extension_interface

Disables the extension.

$ manager#dbProperty in class manager
manager::disable_step() — Method in class manager

Disables an extension

manager::disable() — Method in class manager

Disables an extension

$ base#dbProperty in class base
$ feed#dbProperty in class feed
$ filespec#destination_fileProperty in class filespec
$ filespec#destination_pathProperty in class filespec
$ upload#disallowed_contentProperty in class upload
filesystem::dump_file() — Method in class filesystem

Atomically dumps content into a file.

filesystem_interface::dump_file() — Method in class filesystem_interface

Atomically dumps content into a file.

finder::directory() — Method in class finder

Sets a directory all files found in extensions and core must be contained in

$ helper#dispatcherProperty in class helper
groupposition_interface::delete_group() — Method in class groupposition_interface

Deletes a group by group_id

$ legend#dbProperty in class legend

Database object

legend::delete_group() — Method in class legend

Deletes a group by setting the field to self::GROUP_DISABLED and closing the gap in the list.

$ teampage#dbProperty in class teampage

Database object

teampage::delete_group() — Method in class teampage

Deletes a group from the list and closes the gap in the position list.

teampage::delete_teampage() — Method in class teampage

Deletes an item from the list and closes the gap in the position list.

bbcode::display() — Method in class bbcode
controller::display() — Method in class controller
faq::display() — Method in class faq
$ help#dispatcherProperty in class help
$ manager#dispatcherProperty in class manager
$ config#do_clean_upProperty in class config

Flag indicating that config file should be cleaned up

compression_file_updater::delete_file() — Method in class compression_file_updater

Deletes a file

file_updater::delete_file() — Method in class file_updater

Deletes a file

file_updater_interface::delete_file() — Method in class file_updater_interface

Deletes a file

ftp_file_updater::delete_file() — Method in class ftp_file_updater

Deletes a file

$ ajax_iohandler#downloadProperty in class ajax_iohandler
$ create_config_file#db_helperProperty in class create_config_file
$ install_extensions#dbProperty in class install_extensions
$ check_server_environment#database_helperProperty in class check_server_environment
diff_filesClass in namespace phpbb\install\module\update_filesystem\task

Merges user made changes into the files

download_updated_filesClass in namespace phpbb\install\module\update_filesystem\task
$ language#default_languageProperty in class language
dbClass in namespace phpbb\lock

Database locking class

dummyClass in namespace phpbb\log

Dummy logger

dummy::disable() — Method in class dummy

Disable log

dummy::delete() — Method in class dummy

Delete entries in the logs

$ log#disabled_typesProperty in class log

An array with the disabled log types. Logs of such types will not be added when add() is called.

$ log#dbProperty in class log

Database object

$ log#dispatcherProperty in class log

Event dispatcher object

log::disable() — Method in class log

Disable log

log::delete() — Method in class log

Delete entries in the logs

log_interface::disable() — Method in class log_interface

Disable log

log_interface::delete() — Method in class log_interface

Delete entries in the logs

$ admin_form#dispatcherProperty in class admin_form
$ form#dbProperty in class form
$ module_manager#dbProperty in class module_manager
module_manager::delete_module() — Method in class module_manager

Remove module from tree

$ manager#dbProperty in class manager
manager::delete_notifications() — Method in class manager

Delete a notification

manager::delete_subscription() — Method in class manager

Delete a subscription

manager::disable_notifications() — Method in class manager

Disable all notifications of a certain type

base::delete_notifications() — Method in class base

Delete a notification

$ board#dbProperty in class board
board::delete_notifications() — Method in class board

Delete a notification

$ email#dbProperty in class email
method_interface::delete_notifications() — Method in class method_interface

Delete a notification

$ base#dbProperty in class base
disapprove_postClass in namespace phpbb\notification\type

Post disapproved notifications class This class handles notifications for posts when they are disapproved (for authors)

disapprove_topicClass in namespace phpbb\notification\type

Topic disapproved notifications class This class handles notifications for topics when they are disapproved (for authors)

driver_interfaceClass in namespace phpbb\passwords\driver
manager::detect_algorithm() — Method in class manager

Detect the hash type of the supplied hash

$ permissions#dispatcherProperty in class permissions

Event dispatcher object

$ lang_helper#dbProperty in class lang_helper

Database object

$ manager#dbProperty in class manager
$ manager#db_toolsProperty in class manager
$ manager#dispatcherProperty in class manager
manager::disable_profilefields() — Method in class manager

Disable all profile fields of a certain type.

type_base::display_options() — Method in class type_base

Allows assigning of additional template variables

type_bool::display_options() — Method in class type_bool

Allows assigning of additional template variables

type_dropdown::display_options() — Method in class type_dropdown

Allows assigning of additional template variables

type_interface::display_options() — Method in class type_interface

Allows assigning of additional template variables

type_string::display_options() — Method in class type_string

Allows assigning of additional template variables

type_text::display_options() — Method in class type_text

Allows assigning of additional template variables

$ report_handler#dbProperty in class report_handler
$ report_handler#dispatcherProperty in class report_handler
$ report_reason_list_provider#dbProperty in class report_reason_list_provider
report_reason_list_provider::display_reasons() — Method in class report_reason_list_provider

Sets template variables to render report reasons select HTML input

deactivated_super_globalClass in namespace phpbb\request

Replacement for a superglobal (like $_GET or $_POST) which calls trigger_error on all operations but isset, overloads the [] operator with SPL.

request::disable_super_globals() — Method in class request

Disables access of super globals specified in $super_globals.

default_resources_locatorClass in namespace phpbb\routing\resources_locator

Locates the yaml routing resources located in the default locations

base::destroy_cache() — Method in class base

Removes old entries from the search results table and removes searches with keywords that contain a word in $words.

$ fulltext_mysql#dbProperty in class fulltext_mysql

Database connection

fulltext_mysql::delete_index() — Method in class fulltext_mysql

Drop fulltext index

$ fulltext_native#dbProperty in class fulltext_native

Database connection

fulltext_native::delete_index() — Method in class fulltext_native

Deletes all words from the index

$ fulltext_postgres#dbProperty in class fulltext_postgres

Database connection

fulltext_postgres::delete_index() — Method in class fulltext_postgres

Drop fulltext index

$ fulltext_sphinx#dbProperty in class fulltext_sphinx

Database connection

$ fulltext_sphinx#db_toolsProperty in class fulltext_sphinx

Database Tools object

$ fulltext_sphinx#dbtypeProperty in class fulltext_sphinx

Stores the database type if supported by sphinx

fulltext_sphinx::delete_index() — Method in class fulltext_sphinx

Drop sphinx table

config_section::delete_variables_by_name() — Method in class config_section

Deletes all variables with the given name

$ session#dataProperty in class session
base::destroy() — Method in class base

Clears all variables and blocks assigned to this template.

base::destroy_block_vars() — Method in class base

Reset/empty complete block

context::destroy_block_vars() — Method in class context

Reset/empty complete block

template::destroy() — Method in class template

Clears all variables and blocks assigned to this template.

template::destroy_block_vars() — Method in class template

Reset/empty complete block

template::display() — Method in class template

Display a template for provided handle.

definitionClass in namespace phpbb\template\twig

This class holds all DEFINE variables from the current page load

$ definition#definitionsProperty in class definition
environment::display() — Method in class environment
{@inheritdoc}
definenodeClass in namespace phpbb\template\twig\node
defineparserClass in namespace phpbb\template\twig\tokenparser
defineparser::decideBlockEnd() — Method in class defineparser
php::decideEnd() — Method in class php
twig::display() — Method in class twig

Display a template for provided handle.

parser_interface::disable_bbcode() — Method in class parser_interface

Disable a specific BBCode

parser_interface::disable_bbcodes() — Method in class parser_interface

Disable BBCodes in general

parser_interface::disable_censor() — Method in class parser_interface

Disable the censor

parser_interface::disable_magic_url() — Method in class parser_interface

Disable magic URLs

parser_interface::disable_smilies() — Method in class parser_interface

Disable smilies

$ factory#data_accessProperty in class factory
$ factory#default_definitionsProperty in class factory
$ factory#default_templatesProperty in class factory
$ factory#dispatcherProperty in class factory
$ parser#dispatcherProperty in class parser
parser::disable_bbcode() — Method in class parser

Disable a specific BBCode

parser::disable_bbcodes() — Method in class parser

Disable BBCodes in general

parser::disable_censor() — Method in class parser

Disable the censor

parser::disable_magic_url() — Method in class parser

Disable magic URLs

parser::disable_smilies() — Method in class parser

Disable smilies

$ renderer#dispatcherProperty in class renderer
base::disable_save() — Method in class base

Disable saving changes to the database

$ row_based_plugin#dbProperty in class row_based_plugin
$ nestedset#dbProperty in class nestedset
nestedset::delete() — Method in class nestedset

Delete an item from the tree and from the database table

tree_interface::delete() — Method in class tree_interface

Delete an item from the tree and from the database table

$ reset_password#dbProperty in class reset_password
$ reset_password#dispatcherProperty in class reset_password
$ user#date_formatProperty in class user
$ user#datetimeProperty in class user
$ user_loader#dbProperty in class user_loader
$ viewonline_helper#dbProperty in class viewonline_helper
$ phpbb_questionnaire_data_collector#dataProperty in class phpbb_questionnaire_data_collector
$ queue#dataProperty in class queue
smtp_class::digest_md5() — Method in class smtp_class

digest_md5 authentication method A real pain in the ***

$ transfer#dir_permsProperty in class transfer
transfer::delete_file() — Method in class transfer

Remove file

E

SphinxClient::EscapeString() — Method in class SphinxClient
acp_board::enable_mod_rewrite() — Method in class acp_board

Option to enable/disable removal of 'app.php' from URLs

$ acp_profile#edit_lang_idProperty in class acp_profile
compress_tar::extract() — Method in class compress_tar

Extract archive

$ compress_zip#eof_cdhProperty in class compress_zip
compress_zip::extract() — Method in class compress_zip

Extract archive

$ jabber#enable_loggingProperty in class jabber
jabber::encrypt_password() — Method in class jabber

Encrypts a password as in RFC 2831

$ messenger#extra_headersProperty in class messenger
messenger::error() — Method in class messenger

Add error message to log

exceptionClass in namespace phpbb\auth\provider\oauth\service

OAuth service exception class

$ manager#enabled_driversProperty in class manager

Array that contains a list of enabled drivers

$ apcu#extensionProperty in class apcu
$ memcached#extensionProperty in class memcached
$ redis#extensionProperty in class redis
$ wincache#extensionProperty in class wincache
gd::execute() — Method in class gd

Create the image containing $code with a seed of $seed

gd_wave::execute() — Method in class gd_wave
non_gd::execute() — Method in class non_gd

Create the image containing $code with a seed of $seed

captcha_abstract::execute_demo() — Method in class captcha_abstract
captcha_abstract::execute() — Method in class captcha_abstract
gd::execute_demo() — Method in class gd
qa::execute_demo() — Method in class qa

API function - not needed as we don't display an image

qa::execute() — Method in class qa

API function - not needed as we don't display an image

recaptcha::execute_demo() — Method in class recaptcha
recaptcha::execute() — Method in class recaptcha
recaptcha_v3::execute() — Method in class recaptcha_v3
Execute.
recaptcha_v3::execute_demo() — Method in class recaptcha_v3

Execute demo.

config::ensure_lock() — Method in class config

Checks configuration option's value only if the new_value matches the current configuration value and the configuration value does exist.Called only after set_atomic has been called.

purge::execute() — Method in class purge

Executes the command cache:purge.

delete::execute() — Method in class delete

Executes the command config:delete.

get::execute() — Method in class get

Executes the command config:get.

increment::execute() — Method in class increment

Executes the command config:increment.

set::execute() — Method in class set

Executes the command config:set.

set_atomic::execute() — Method in class set_atomic

Executes the command config:set-atomic.

cron_list::execute() — Method in class cron_list

Executes the command cron:list.

run::execute() — Method in class run

Executes the command cron:run.

list_command::execute() — Method in class list_command
migrate::execute() — Method in class migrate
$ migration_command#extension_managerProperty in class migration_command
revert::execute() — Method in class revert
$ migration_tips#extension_managerProperty in class migration_tips
migration_tips::execute() — Method in class migration_tips
disable::execute() — Method in class disable
enableClass in namespace phpbb\console\command\extension
enable::execute() — Method in class enable
purge::execute() — Method in class purge
show::execute() — Method in class show
fix_left_right_ids::execute() — Method in class fix_left_right_ids

Executes the command fixup:fix-left-right-ids.

update_hashes::execute() — Method in class update_hashes
{@inheritdoc}
list_all::execute() — Method in class list_all

Executes the command reparser:list

reparse::execute() — Method in class reparse

Executes the command reparser:reparse

delete::execute() — Method in class delete

Executes the command thumbnail:delete.

generate::execute() — Method in class generate

Executes the command thumbnail:generate.

recreate::execute() — Method in class recreate

Executes the command thumbnail:recreate.

check::execute() — Method in class check

Executes the command.

activate::execute() — Method in class activate

Executes the command user:activate

add::execute() — Method in class add

Executes the command user:add

delete::execute() — Method in class delete

Executes the command user:delete

reclean::execute() — Method in class reclean

Executes the command user:reclean

exception_subscriberClass in namespace phpbb\console
exceptionClass in namespace phpbb\controller

Controller exception class

helper::error() — Method in class helper

Output an error, effectively the same thing as trigger_error

convertor::error() — Method in class convertor

Error handler function

extractor_not_initialized_exceptionClass in namespace phpbb\db\extractor\exception

This exception is thrown when invalid format is given to the extractor

extractor_interfaceClass in namespace phpbb\db\extractor

Database extractor interface

exceptionClass in namespace phpbb\db\migration

The migrator is responsible for applying new migrations in the correct order.

$ migration#errorsProperty in class migration
migration::effectively_installed() — Method in class migration

Allows you to check if the migration is effectively installed (entirely optional)

migration_interface::effectively_installed() — Method in class migration_interface

Allows you to check if the migration is effectively installed (entirely optional)

profilefield_base_migration::effectively_installed() — Method in class profilefield_base_migration

Allows you to check if the migration is effectively installed (entirely optional)

module::exists() — Method in class module

Module Exists

permission::exists() — Method in class permission

Permission Exists

debug::enable() — Method in class debug

Enables the debug tools.

error_handlerClass in namespace phpbb\debug
$ container_builder#environmentProperty in class container_builder
error_collectorClass in namespace phpbb
$ error_collector#errorsProperty in class error_collector
$ error_collector#error_typesProperty in class error_collector
error_collector::error_handler() — Method in class error_collector
dispatcher::enable() — Method in class dispatcher

Enable the event dispatcher.

dispatcher_interface::enable() — Method in class dispatcher_interface

Enable the event dispatcher.

$ md_exporter#eventsProperty in class md_exporter
md_exporter::export_events_for_wiki() — Method in class md_exporter

Format the md events as a wiki table

md_exporter::export_events_for_rst() — Method in class md_exporter

Format the md events as a rst table

md_exporter::export_events_for_bbcode() — Method in class md_exporter

Format the md events as BBCode list

$ php_exporter#eventsProperty in class php_exporter
php_exporter::export_events_for_wiki() — Method in class php_exporter

Format the php events as a wiki table

php_exporter::export_events_for_rst() — Method in class php_exporter

Format the PHP events as a rst table

php_exporter::export_events_for_bbcode() — Method in class php_exporter

Format the PHP events as a BBCode list

exception_interfaceClass in namespace phpbb\exception

Interface exception_interface

$ base#extension_finderProperty in class base
$ base#extension_nameProperty in class base
$ base#extension_pathProperty in class base
base::enable_step() — Method in class base

Single enable step that installs any included migrations

extension_baseClass in namespace phpbb\extension\di

Container core extension

$ extension_base#extension_nameProperty in class extension_base

Name of the extension (vendor/name)

$ extension_base#ext_pathProperty in class extension_base

Path to the extension.

exceptionClass in namespace phpbb\extension

Exception class for metadata

extension_interfaceClass in namespace phpbb\extension

The interface extension meta classes have to implement to run custom code on enable/disable/purge.

extension_interface::enable_step() — Method in class extension_interface

enable_step is executed on enabling an extension until it returns false.

$ manager#extensionsProperty in class manager
$ manager#extension_tableProperty in class manager
manager::enable_step() — Method in class manager

Runs a step of the extension enabling process.

manager::enable() — Method in class manager

Enables an extension

$ provider#extension_managerProperty in class provider

An extension manager to search for items in extensions

$ file_downloader#error_stringProperty in class file_downloader
$ file_downloader#error_numberProperty in class file_downloader
$ filespec#extensionProperty in class filespec
$ filespec#errorProperty in class filespec
$ upload#error_prefixProperty in class upload
filesystem::exists() — Method in class filesystem

Checks the existence of files or directories.

filesystem_interface::exists() — Method in class filesystem_interface

Checks the existence of files or directories.

$ finder#extensionsProperty in class finder
finder::extension_suffix() — Method in class finder

Sets a suffix all files found in extensions must match

finder::extension_prefix() — Method in class finder

Sets a prefix all files found in extensions must match

finder::extension_directory() — Method in class finder

Sets a directory all files found in extensions must be contained in

exceptionClass in namespace phpbb\groupposition
show::execute() — Method in class show

Show the validated configuration

validate::execute() — Method in class validate

Validate the configuration file

install::execute() — Method in class install

Executes the command install.

show::execute() — Method in class show

Show the validated configuration

validate::execute() — Method in class validate

Validate the configuration file

update::execute() — Method in class update

Executes the command update.

$ factory#environmentProperty in class factory
$ iohandler_base#errorsProperty in class iohandler_base

Array of errors

$ install_extensions#extension_managerProperty in class install_extensions
$ install_extensions#extension_tableProperty in class install_extensions
$ populate_migrations#extension_managerProperty in class populate_migrations
$ language_file_loader#extension_managerProperty in class language_file_loader
dummy::enable() — Method in class dummy

Enable log

$ log#entry_countProperty in class log

Keeps the total log count of the last call to get_logs()

log::enable() — Method in class log

Enable log

log_interface::enable() — Method in class log_interface

Enable log

$ form#errorsProperty in class form
extension_guesserClass in namespace phpbb\mimetype
$ extension_guesser#extension_mapProperty in class extension_guesser
$ module_manager#extension_managerProperty in class module_manager
exceptionClass in namespace phpbb\notification

Notifications exception

manager::enable_notifications() — Method in class manager

Enable all notifications of a certain type

base::empty_queue() — Method in class base

Empty the queue

emailClass in namespace phpbb\notification\method

Email notification method class This class handles sending emails for notifications

$ report_pm_closed#email_templateProperty in class report_pm_closed

Email template to use to send notifications

$ report_post_closed#email_templateProperty in class report_post_closed

Email template to use to send notifications

plupload::emit_error() — Method in class plupload

Sends an error message back to the client via JSON response

manager::enable_profilefields() — Method in class manager

Enable the profile fields of a certain type.

empty_report_exceptionClass in namespace phpbb\report\exception
entity_not_found_exceptionClass in namespace phpbb\report\exception
request::enable_super_globals() — Method in class request

Enables access of super globals specified in $super_globals if they were disabled by disable_super_globals disable_super_globals.

request::escape() — Method in class request

Escape a string variable.

request_interface::escape() — Method in class request_interface

Escape a string variable.

$ default_resources_locator#environmentProperty in class default_resources_locator

Name of the current environment

$ default_resources_locator#extension_managerProperty in class default_resources_locator

Extension manager

$ installer_resources_locator#environmentProperty in class installer_resources_locator

Name of the current environment

session::extract_current_page() — Method in class session

Extract current session page

session::extract_current_hostname() — Method in class session

Get valid hostname/port. HTTP_HOST is used, SERVER_NAME if HTTP_HOST not present.

environmentClass in namespace phpbb\template\twig
$ environment#extension_managerProperty in class environment
extensionClass in namespace phpbb\template\twig
$ extension#environmentProperty in class extension
eventClass in namespace phpbb\template\twig\node
$ event#environmentProperty in class event
equalequalClass in namespace phpbb\template\twig\node\expression\binary
$ includephp#environmentProperty in class includephp
$ php#environmentProperty in class php
eventClass in namespace phpbb\template\twig\tokenparser
$ event#environmentProperty in class event
$ includephp#environmentProperty in class includephp
$ php#environmentProperty in class php
$ twig#extension_managerProperty in class twig

Extension manager.

parser_interface::enable_bbcode() — Method in class parser_interface

Enable a specific BBCode

parser_interface::enable_bbcodes() — Method in class parser_interface

Enable BBCodes in general

parser_interface::enable_censor() — Method in class parser_interface

Enable the censor

parser_interface::enable_magic_url() — Method in class parser_interface

Enable magic URLs

parser_interface::enable_smilies() — Method in class parser_interface

Enable smilies

factory::escape_html_attribute() — Method in class factory

Escape a literal to be used in an HTML attribute in an XSL template

factory::extract_templates() — Method in class factory

Extract and recompose individual BBCode templates from a style's template file

parser::enable_bbcode() — Method in class parser

Enable a specific BBCode

parser::enable_bbcodes() — Method in class parser

Enable BBCodes in general

parser::enable_censor() — Method in class parser

Enable the censor

parser::enable_magic_url() — Method in class parser

Enable magic URLs

parser::enable_smilies() — Method in class parser

Enable smilies

base::enable_save() — Method in class base

Enable saving changes to the database

$ queue#eolProperty in class queue

F

SphinxClient::FlushAttributes() — Method in class SphinxClient
$ acp_attachments#filesystemProperty in class acp_attachments
acp_board::full_folder_select() — Method in class acp_board

Select full folder action

acp_styles::frontend() — Method in class acp_styles

Main page

acp_styles::find_available() — Method in class acp_styles

Find styles available for installation

acp_styles::find_possible_parents() — Method in class acp_styles

Find all possible parent styles for style

acp_styles::find_style_dirs() — Method in class acp_styles

Find all directories that have styles

$ compress#fpProperty in class compress
$ compress#filelistProperty in class compress
$ compress_tar#filenameProperty in class compress_tar
$ compress_tar#filesystemProperty in class compress_tar
$ compress_zip#filesystemProperty in class compress_zip
compress_zip::file() — Method in class compress_zip
file
diff3_block_builder::finish() — Method in class diff3_block_builder
$ diff_op#finalProperty in class diff_op
ftpClass in namespace [Global Namespace]

FTP transfer class

ftp_fsockClass in namespace [Global Namespace]

FTP fsock transfer class

$ jabber#featuresProperty in class jabber
$ messenger#fromProperty in class messenger
messenger::from() — Method in class messenger

Set the from address

$ parse_message#filename_dataProperty in class parse_message
parse_message::format_display() — Method in class parse_message

Formatting text for display

$ delete#filesystemProperty in class delete
$ upload#files_uploadProperty in class upload
upload::fill_file_data() — Method in class upload

Fills file data with file information and current time as filetime

facebookClass in namespace phpbb\auth\provider\oauth\service

Facebook OAuth service

$ upload#filesystemProperty in class upload
$ upload#files_factoryProperty in class upload
fileClass in namespace phpbb\cache\driver

ACM File Based Caching

$ file#filesystemProperty in class file
$ memcached#flagsProperty in class memcached
factoryClass in namespace phpbb\captcha
$ non_gd#filtered_pngsProperty in class non_gd
$ migrate#filesystemProperty in class migrate
migration_command::finalise_update() — Method in class migration_command
fix_left_right_idsClass in namespace phpbb\console\command\fixup
fix_left_right_ids::fix_ids_tree() — Method in class fix_left_right_ids

Item's tree structure rebuild helper The item is either forum or ACP/MCP/UCP module

convertor::finish() — Method in class convertor

Render the final page of the convertor

$ convert#fulltext_searchProperty in class convert
$ convertor#filesystemProperty in class convertor
convertor::finish_conversion() — Method in class convertor

Finish conversion, the last function to be called.

convertor::final_jump() — Method in class convertor

This function marks the steps after syncing

manager::find_one_ready_task() — Method in class manager

Finds a task that is ready to run.

manager::find_all_ready_tasks() — Method in class manager

Finds all tasks that are ready to run.

manager::find_task() — Method in class manager

Finds a task by name.

$ prune_forum#forum_dataProperty in class prune_forum

If $forum_data is given, it is assumed to contain necessary information about a single forum that is to be pruned.

$ prune_shadow_topics#forum_dataProperty in class prune_shadow_topics

If $forum_data is given, it is assumed to contain necessary information about a single forum that is to be pruned.

$ datetime#format_cacheProperty in class datetime
datetime::format() — Method in class datetime

Formats the current date time into the specified format

datetime::format_cache() — Method in class datetime

Pre-processes the specified date format

factoryClass in namespace phpbb\db\driver

Database Abstraction Layer

$ base_extractor#formatProperty in class base_extractor
$ base_extractor#fpProperty in class base_extractor
base_extractor::flush() — Method in class base_extractor

Writes data to file/download content

extractor_interface::flush() — Method in class extractor_interface

Writes data to file/download content

factoryClass in namespace phpbb\db\extractor

A factory which serves the suitable extractor instance for the given dbal

$ migrator#fulfillable_migrationsProperty in class migrator

Array of migrations that have been determined to be fulfillable

migrator::finished() — Method in class migrator

Checks whether all available, fulfillable migrations have been applied.

$ log_wrapper_migrator_output_handler#file_handleProperty in class log_wrapper_migrator_output_handler

Log file handle

$ log_wrapper_migrator_output_handler#filesystemProperty in class log_wrapper_migrator_output_handler
log_wrapper_migrator_output_handler::file_open() — Method in class log_wrapper_migrator_output_handler

Open file for logging

sql_insert_buffer::flush() — Method in class sql_insert_buffer

Flushes the buffer content to the DB and clears the buffer.

factoryClass in namespace phpbb\db\tools

A factory which serves the suitable tools instance for the given dbal

error_collector::format_errors() — Method in class error_collector
$ md_exporter#filterProperty in class md_exporter
$ php_exporter#file_linesProperty in class php_exporter
php_exporter::find_since() — Method in class php_exporter

Find the "@since" Information line

php_exporter::find_changed() — Method in class php_exporter

Find the "@changed" Information lines

php_exporter::find_event() — Method in class php_exporter

Find the "@event" Information line

php_exporter::find_tag() — Method in class php_exporter

Find a "@*" Information line

php_exporter::find_description() — Method in class php_exporter

Find a "@*" Information line

provider::find() — Method in class provider

Finds items using the extension manager.

attachments_base::fetch_attachments() — Method in class attachments_base

Retrieve the list of attachments that may be displayed

feedClass in namespace phpbb\feed\controller
$ feed#feed_helperProperty in class feed
feed::forums() — Method in class feed

Controller for /feed/forums route

feed::forum() — Method in class feed

Controller for /feed/forum/{forum_id} route

feed_exceptionClass in namespace phpbb\feed\exception
feed_unavailable_exceptionClass in namespace phpbb\feed\exception
feed_interfaceClass in namespace phpbb\feed

Interface implemented by all feeds types

forumClass in namespace phpbb\feed

Forum feed

$ forum#forum_idProperty in class forum
$ forum#forum_dataProperty in class forum
forumsClass in namespace phpbb\feed

'All Forums' feed

helper::format_date() — Method in class helper

Generate ISO 8601 date string (RFC 3339)

$ topic#forum_idProperty in class topic
file_downloaderClass in namespace phpbb
factoryClass in namespace phpbb\files
filespecClass in namespace phpbb\files

Responsible for holding all file relevant information, as well as doing file-specific operations.

$ filespec#filenameProperty in class filespec
$ filespec#filesizeProperty in class filespec
$ filespec#file_movedProperty in class filespec
$ filespec#filesystemProperty in class filespec
formClass in namespace phpbb\files\types
$ form#factoryProperty in class form
form::form_upload() — Method in class form

Form upload method Upload file from users harddisk

$ local#factoryProperty in class local
$ remote#factoryProperty in class remote
$ upload#filesystemProperty in class upload
$ upload#factoryProperty in class upload
filesystemClass in namespace phpbb
filesystem_exceptionClass in namespace phpbb\filesystem\exception
filesystemClass in namespace phpbb\filesystem

A class with various functions that are related to paths, files and the filesystem

filesystem_interfaceClass in namespace phpbb\filesystem

Interface for phpBB's filesystem service

finderClass in namespace phpbb

The finder provides a simple way to locate files in the core and a set of extensions

$ finder#filesystemProperty in class finder
finder::find_with_root_path() — Method in class finder

A wrapper around the general find which prepends a root path to results

finder::find() — Method in class finder

Finds all file system entries matching the configured options

finder::find_from_extension() — Method in class finder

Finds all file system entries matching the configured options for one specific extension

finder::find_from_paths() — Method in class finder

Finds all file system entries matching the configured options from an array of paths

faqClass in namespace phpbb\help\controller

FAQ help page

finderClass in namespace phpbb\hook

The hook finder locates installed hooks.

finder::find() — Method in class finder

Finds all hook files.

file_updater_failure_exceptionClass in namespace phpbb\install\exception

Thrown when the file updater fails

$ config#filesystemProperty in class config
factoryClass in namespace phpbb\install\helper\file_updater

File updater factory

$ factory#file_updatersProperty in class factory
file_updaterClass in namespace phpbb\install\helper\file_updater

File updater for direct filesystem access

$ file_updater#filesystemProperty in class file_updater
file_updater_interfaceClass in namespace phpbb\install\helper\file_updater
ftp_file_updaterClass in namespace phpbb\install\helper\file_updater

File updater for FTP updates

$ ajax_iohandler#file_statusProperty in class ajax_iohandler
$ ajax_iohandler#formProperty in class ajax_iohandler
$ ajax_iohandler#file_lock_pointerProperty in class ajax_iohandler
cli_iohandler::finish_progress() — Method in class cli_iohandler

Finish the progress bar

factoryClass in namespace phpbb\install\helper\iohandler

Input-output handler factory

iohandler_base::finish_progress() — Method in class iohandler_base

Finish the progress bar

iohandler_interface::finish_progress() — Method in class iohandler_interface

Finish the progress bar

$ create_config_file#filesystemProperty in class create_config_file
$ install_extensions#finderProperty in class install_extensions
$ check_filesystem#filesystemProperty in class check_filesystem
$ check_filesystem#files_to_checkProperty in class check_filesystem
$ check_update#filesystemProperty in class check_update
$ download_updated_files#filesystemProperty in class download_updated_files
file_checkClass in namespace phpbb\install\module\update_filesystem\task

Updater task performing file checking

$ file_check#filesystemProperty in class file_check
$ show_file_status#filesystemProperty in class show_file_status
$ show_file_status#file_updaterProperty in class show_file_status
$ update_files#factoryProperty in class update_files
$ update_files#file_updaterProperty in class update_files
flockClass in namespace phpbb\lock

File locking class

formClass in namespace phpbb\message

Abstract class form

admin_activate_user::find_users_for_notification() — Method in class admin_activate_user

Find the users who want to receive notifications

approve_post::find_users_for_notification() — Method in class approve_post

Find the users who want to receive notifications

approve_topic::find_users_for_notification() — Method in class approve_topic

Find the users who want to receive notifications

bookmark::find_users_for_notification() — Method in class bookmark

Find the users who want to receive notifications

forumClass in namespace phpbb\notification\type

Forum notifications class This class handles notifications for replies to a topic in a forum user subscribed to

forum::find_users_for_notification() — Method in class forum

Find the users who want to receive notifications

group_request::find_users_for_notification() — Method in class group_request

Find the users who want to receive notifications

group_request_approved::find_users_for_notification() — Method in class group_request_approved

Find the users who want to receive notifications

pm::find_users_for_notification() — Method in class pm

Find the users who want to receive notifications

post::find_users_for_notification() — Method in class post

Find the users who want to receive notifications

post_in_queue::find_users_for_notification() — Method in class post_in_queue

Find the users who want to receive notifications

quote::find_users_for_notification() — Method in class quote

Find the users who want to receive notifications

report_pm::find_users_for_notification() — Method in class report_pm

Find the users who want to receive notifications (copied from post_in_queue)

report_pm_closed::find_users_for_notification() — Method in class report_pm_closed

Find the users who want to receive notifications

report_post::find_users_for_notification() — Method in class report_post

Find the users who want to receive notifications

report_post_closed::find_users_for_notification() — Method in class report_post_closed

Find the users who want to receive notifications

topic::find_users_for_notification() — Method in class topic

Find the users who want to receive notifications

topic_in_queue::find_users_for_notification() — Method in class topic_in_queue

Find the users who want to receive notifications

type_interface::find_users_for_notification() — Method in class type_interface

Find the users who want to receive notifications

manager::fill_type_map() — Method in class manager

Fill algorithm type map

$ path_helper#filesystemProperty in class path_helper
$ manager#fields_tableProperty in class manager
$ manager#fields_data_tableProperty in class manager
$ manager#fields_data_lang_tableProperty in class manager
$ manager#fields_lang_tableProperty in class manager
factory_invalid_argument_exceptionClass in namespace phpbb\report\exception
$ report_handler_post#forum_dataProperty in class report_handler_post
request::file() — Method in class request

Shortcut method to retrieve $_FILES variables

file_locatorClass in namespace phpbb\routing
$ helper#filesystemProperty in class helper
$ installer_resources_locator#filesystemProperty in class installer_resources_locator

phpBB's filesystem handler

fulltext_mysqlClass in namespace phpbb\search

Fulltext search for MySQL

fulltext_nativeClass in namespace phpbb\search

phpBB's own db driven fulltext search, version 2

fulltext_postgresClass in namespace phpbb\search

Fulltext search for PostgreSQL

fulltext_sphinxClass in namespace phpbb\search

Fulltext search based on the sphinx search daemon

$ session#forwarded_forProperty in class session
$ asset#filesystemProperty in class asset
$ base#filenamesProperty in class base

Array of filenames assigned to set_filenames

base::find_key_index() — Method in class base

Find the index for a specified key in the innermost specified block

context::find_key_index() — Method in class context

Find the index for a specified key in the innermost specified block

template::find_key_index() — Method in class template

Find the index for a specified key in the innermost specified block

$ environment#filesystemProperty in class environment
environment::findTemplate() — Method in class environment

Finds a template by name.

lexer::fix_inline_variable_tokens() — Method in class lexer

Fix tokens that may have inline variables

lexer::fix_begin_tokens() — Method in class lexer

Fix begin tokens (convert our BEGIN to Twig for)

lexer::fix_if_tokens() — Method in class lexer

Fix IF statements

lexer::fix_define_tokens() — Method in class lexer

Fix DEFINE statements and {$VARNAME} variables

$ loader#filesystemProperty in class loader
loader::findTemplate() — Method in class loader

Find the template

$ acp_utils#factoryProperty in class acp_utils
factoryClass in namespace phpbb\textformatter\s9e

Creates s9e\TextFormatter objects

parser::filter_flash_height() — Method in class parser

Filter a flash object's height

parser::filter_flash_width() — Method in class parser

Filter a flash object's width

parser::filter_font_size() — Method in class parser

Filter the value used in a [size] BBCode

parser::filter_img_url() — Method in class parser

Filter an image's URL to enforce restrictions on its dimensions

utils::format_attribute_value() — Method in class utils

Format given string to be used as an attribute value

manager::find_reparser() — Method in class manager

Finds a reparser by name.

forum_descriptionClass in namespace phpbb\textreparser\plugins
forum_rulesClass in namespace phpbb\textreparser\plugins
user::format_date() — Method in class user

Format user date

$ version_helper#fileProperty in class version_helper
$ version_helper#force_stabilityProperty in class version_helper
$ version_helper#file_downloaderProperty in class version_helper
version_helper::force_stability() — Method in class version_helper

Over-ride the stability to force check to include unstable versions

$ viewonline_helper#filesystemProperty in class viewonline_helper
$ queue#filesystemProperty in class queue
$ transfer#file_permsProperty in class transfer
transfer::file_exists() — Method in class transfer

Check if a specified file exist.

G

SphinxClient::GetLastError() — Method in class SphinxClient
SphinxClient::GetLastWarning() — Method in class SphinxClient
acp_attachments::get_attachment_stats() — Method in class acp_attachments

Get attachment file count and size of upload directory

acp_attachments::group_select() — Method in class acp_attachments

Extension group select

acp_board::guest_style_get() — Method in class acp_board

Get guest style

acp_board::guest_style_set() — Method in class acp_board

Set guest style

acp_forums::get_forum_info() — Method in class acp_forums

Get forum details

acp_prune::get_prune_users() — Method in class acp_prune

Get user_ids/usernames from those being pruned

acp_search::get_search_types() — Method in class acp_search
acp_search::get_max_post_id() — Method in class acp_search
acp_search::get_post_index_progress() — Method in class acp_search

Get progress stats of search index with HTML progress bar.

acp_styles::get_styles() — Method in class acp_styles

Lists all styles

acp_styles::get_users() — Method in class acp_styles

Count users for each style

auth_admin::get_mask() — Method in class auth_admin

Get permission mask This function only supports getting permissions of one type (for example a_)

auth_admin::get_role_mask() — Method in class auth_admin

Get permission mask for roles This function only supports getting masks for one role

auth_admin::ghost_permissions() — Method in class auth_admin

Use permissions from another user. This transferes a permission set from one user to another.

bitfield::get() — Method in class bitfield
bitfield::get_blob() — Method in class bitfield
bitfield::get_base64() — Method in class bitfield
bitfield::get_bin() — Method in class bitfield
bitfield::get_all_set() — Method in class bitfield
diff::get_diff() — Method in class diff

Returns the array of differences.

diff::get_original() — Method in class diff

Gets the original set of lines.

diff::get_final() — Method in class diff

Gets the final set of lines.

diff3::get_num_conflicts() — Method in class diff3

Return number of conflicts

diff3::get_conflicts_content() — Method in class diff3

Get conflicts content for download. This is generally a merged file, but preserving conflicts and adding explanations to it.

diff3::get_conflicts() — Method in class diff3

Get conflicting block(s)

diff_renderer::get_params() — Method in class diff_renderer

Get any renderer parameters.

diff_renderer::get_diff_content() — Method in class diff_renderer

Our function to get the diff

diff_renderer_inline::get_diff_content() — Method in class diff_renderer_inline

Our function to get the diff

diff_renderer_raw::get_diff_content() — Method in class diff_renderer_raw

Our function to get the diff

diff_renderer_side_by_side::get_diff_content() — Method in class diff_renderer_side_by_side

Our function to get the diff

diff_renderer_unified::get_diff_content() — Method in class diff_renderer_unified

Our function to get the diff

jabber::get_log() — Method in class jabber

Return log

messenger::generate_message_id() — Method in class messenger

Generates a valid message id to be used in emails

p_master::get_parents() — Method in class p_master

Get parents

p_master::get_branch() — Method in class p_master

Get tree branch

p_master::get_tpl_name() — Method in class p_master

Returns desired template name

p_master::get_page_title() — Method in class p_master

Returns the desired page title

p_master::get_short_name() — Method in class p_master

Retrieve shortened module basename for legacy basenames (with xcp_ prefix)

p_master::get_module_identifier() — Method in class p_master

If the basename contains a \ we don't use that for the URL.

parse_message::get_submitted_attachment_data() — Method in class parse_message

Get Attachment Data

base::get_acp_template() — Method in class base

This function updates the template with variables related to the acp options with whatever configuration values are passed to it as an array.

base::get_login_data() — Method in class base

Returns an array of data necessary to build custom elements on the login form.

base::get_auth_link_data() — Method in class base

Returns an array of data necessary to build the ucp_auth_link page

ldap::get_acp_template() — Method in class ldap

This function updates the template with variables related to the acp options with whatever configuration values are passed to it as an array.

oauth::get_login_data() — Method in class oauth

Returns an array of data necessary to build custom elements on the login form.

oauth::get_acp_template() — Method in class oauth

This function updates the template with variables related to the acp options with whatever configuration values are passed to it as an array.

oauth::get_auth_link_data() — Method in class oauth

Returns an array of data necessary to build the ucp_auth_link page

oauth::get_service() — Method in class oauth

Returns a new service object.

oauth::get_service_name() — Method in class oauth

Returns the service name for an OAuth provider name.

oauth::get_provider() — Method in class oauth

Returns the OAuth provider name from a service name.

oauth::get_provider_title() — Method in class oauth

Returns the localized title for the OAuth provider.

base::get_auth_scope() — Method in class base

Returns an array of the scopes necessary for auth

base::get_external_service_class() — Method in class base

Returns the class of external library service provider that has to be used.

base::get_external_service_provider() — Method in class base

Returns the external library service provider once it has been set

bitly::get_service_credentials() — Method in class bitly

Returns an array containing the service credentials belonging to requested service.

facebook::get_service_credentials() — Method in class facebook

Returns an array containing the service credentials belonging to requested service.

googleClass in namespace phpbb\auth\provider\oauth\service

Google OAuth service

google::get_auth_scope() — Method in class google

Returns an array of the scopes necessary for auth

google::get_service_credentials() — Method in class google

Returns an array containing the service credentials belonging to requested service.

service_interface::get_auth_scope() — Method in class service_interface

Returns an array of the scopes necessary for auth

service_interface::get_service_credentials() — Method in class service_interface

Returns an array containing the service credentials belonging to requested service.

service_interface::get_external_service_class() — Method in class service_interface

Returns the class of external library service provider that has to be used.

service_interface::get_external_service_provider() — Method in class service_interface

Returns the external library service provider once it has been set

twitter::get_service_credentials() — Method in class twitter

Returns an array containing the service credentials belonging to requested service.

token_storage::get_access_token_row() — Method in class token_storage

A helper function that performs the query for retrieving an access token.

token_storage::get_state_row() — Method in class token_storage

A helper function that performs the query for retrieving a state.

token_storage::get_service_name_for_db() — Method in class token_storage

Returns the service name as it must be stored in the database.

provider_interface::get_acp_template() — Method in class provider_interface

This function updates the template with variables related to the acp options with whatever configuration values are passed to it as an array.

provider_interface::get_login_data() — Method in class provider_interface

Returns an array of data necessary to build custom elements on the login form.

provider_interface::get_auth_link_data() — Method in class provider_interface

Returns an array of data necessary to build the ucp_auth_link page

provider_collection::get_provider() — Method in class provider_collection

Get an auth provider.

driver::get_custom_html() — Method in class driver

Returns custom html if it is needed for displaying this avatar

driver::get_name() — Method in class driver

Returns the name of the driver.

driver::get_config_name() — Method in class driver

Returns the config name of the driver. To be used in accessing the CONFIG variables.

driver::get_acp_template_name() — Method in class driver

Get the avatar driver's template name (ACP)

driver_interface::get_name() — Method in class driver_interface

Returns the name of the driver.

driver_interface::get_config_name() — Method in class driver_interface

Returns the config name of the driver. To be used in accessing the CONFIG variables.

driver_interface::get_data() — Method in class driver_interface

Get the avatar url and dimensions

driver_interface::get_custom_html() — Method in class driver_interface

Returns custom html if it is needed for displaying this avatar

driver_interface::get_template_name() — Method in class driver_interface

Get the avatar driver's template name

driver_interface::get_acp_template_name() — Method in class driver_interface

Get the avatar driver's template name (ACP)

gravatarClass in namespace phpbb\avatar\driver

Handles avatars hosted at gravatar.com

gravatar::get_data() — Method in class gravatar

Get the avatar url and dimensions

gravatar::get_custom_html() — Method in class gravatar

Returns custom html if it is needed for displaying this avatar

gravatar::get_template_name() — Method in class gravatar

Get the avatar driver's template name

gravatar::get_gravatar_url() — Method in class gravatar

Build gravatar URL for output on page

local::get_data() — Method in class local

Get the avatar url and dimensions

local::get_template_name() — Method in class local

Get the avatar driver's template name

local::get_avatar_list() — Method in class local

Get a list of avatars that are locally available Results get cached for 24 hours (86400 seconds)

remote::get_data() — Method in class remote

Get the avatar url and dimensions

remote::get_template_name() — Method in class remote

Get the avatar driver's template name

upload::get_data() — Method in class upload

Get the avatar url and dimensions

upload::get_template_name() — Method in class upload

Get the avatar driver's template name

manager::get_driver() — Method in class manager

Get the driver object specified by the avatar type

manager::get_all_drivers() — Method in class manager

Get a list of all avatar drivers

manager::get_enabled_drivers() — Method in class manager

Get a list of enabled avatar drivers

manager::get_avatar_settings() — Method in class manager

Get the settings array for enabling/disabling an avatar driver

driver_interface::get() — Method in class driver_interface

Get saved cache object

dummy::get() — Method in class dummy

Get saved cache object

file::get() — Method in class file

Get saved cache object

memory::get() — Method in class memory

Get saved cache object

service::get_driver() — Method in class service

Returns the cache driver used by this cache service.

char_cube3d::gen_poly() — Method in class char_cube3d
colour_manager::get_resource() — Method in class colour_manager

Lookup a named colour resource

factory::get_instance() — Method in class factory

Return a new instance of a given plugin

factory::garbage_collect() — Method in class factory

Call the garbage collector

factory::get_captcha_types() — Method in class factory

Return a list of all registered CAPTCHA plugins

gdClass in namespace phpbb\captcha
gd_waveClass in namespace phpbb\captcha

Wave3D CAPTCHA

gd_wave::grid_height() — Method in class gd_wave
captcha_abstract::get_template() — Method in class captcha_abstract
captcha_abstract::get_demo_template() — Method in class captcha_abstract
captcha_abstract::get_hidden_fields() — Method in class captcha_abstract
captcha_abstract::garbage_collect() — Method in class captcha_abstract
captcha_abstract::generate_code() — Method in class captcha_abstract

The old way to generate code, suitable for GD and non-GD. Resets the internal state.

captcha_abstract::get_attempt_count() — Method in class captcha_abstract
captcha_abstract::get_service_name() — Method in class captcha_abstract
captcha_abstract::get_generator_class() — Method in class captcha_abstract
captcha_abstract::get_login_error_attempts() — Method in class captcha_abstract

Get language variable for error message when CAPTCHA is being shown due to exceeding the maximum number of login attempts

gdClass in namespace phpbb\captcha\plugins
gd::get_generator_class() — Method in class gd
gd::get_name() — Method in class gd
gd_waveClass in namespace phpbb\captcha\plugins
gd_wave::get_name() — Method in class gd_wave
gd_wave::get_generator_class() — Method in class gd_wave
nogd::get_name() — Method in class nogd
nogd::get_generator_class() — Method in class nogd
qa::get_name() — Method in class qa

API function

qa::get_service_name() — Method in class qa
qa::get_template() — Method in class qa

API function - send the question to the template

qa::get_demo_template() — Method in class qa

API function - we just display a mockup so that the captcha doesn't need to be installed

qa::get_hidden_fields() — Method in class qa

API function

qa::garbage_collect() — Method in class qa

API function

qa::get_attempt_count() — Method in class qa

API function

qa::get_languages() — Method in class qa

List the installed language packs

recaptcha::get_name() — Method in class recaptcha
recaptcha::get_generator_class() — Method in class recaptcha

This function is implemented because required by the upper class, but is never used for reCaptcha.

recaptcha::get_template() — Method in class recaptcha
recaptcha::get_demo_template() — Method in class recaptcha
recaptcha::get_hidden_fields() — Method in class recaptcha
recaptcha_v3::get_actions() — Method in class recaptcha_v3

Get CAPTCHA types mapped to their action.

recaptcha_v3::get_generator_class() — Method in class recaptcha_v3

Get generator class.

recaptcha_v3::get_name() — Method in class recaptcha_v3

Get CAPTCHA plugin name.

recaptcha_v3::get_demo_template() — Method in class recaptcha_v3

Create the ACP page for previewing this CAPTCHA plugin.

recaptcha_v3::get_template() — Method in class recaptcha_v3

Get the template for this CAPTCHA plugin.

recaptcha_v3::get_login_error_attempts() — Method in class recaptcha_v3

Get language variable for error message when CAPTCHA is being shown due to exceeding the maximum number of login attempts

config::getIterator() — Method in class config

Retrieves an ArrayIterator over the configuration values.

db_text::get() — Method in class db_text

Gets the configuration value for the name $key.

db_text::get_array() — Method in class db_text

Mass get configuration options: Receives a set of configuration option names and returns the result as a key => value map where array keys are configuration option names and array values are associated config option values.

config_php_file::get_all() — Method in class config_php_file

Returns an associative array containing the variables defined by the config file.

config_php_file::get() — Method in class config_php_file

Return the value of a variable defined into the config.php file or null if the variable does not exist.

application::getDefaultInputDefinition() — Method in class application
{@inheritdoc}
application::getHelp() — Method in class application

Gets the help message.

getClass in namespace phpbb\console\command\config
reparse::get_option() — Method in class reparse

Get an option value, adjusted for given reparser

generateClass in namespace phpbb\console\command\thumbnail
add::get_group_id() — Method in class add

Get the group id

reclean::get_count() — Method in class reclean

Get the count of users in the database

exception_subscriber::getSubscribedEvents() — Method in class exception_subscriber
content_visibility::get_count() — Method in class content_visibility

Get the topics post count or the forums post/topic count based on permissions

content_visibility::get_visibility_sql() — Method in class content_visibility

Create topic/post visibility SQL for a given forum ID

content_visibility::get_forums_visibility_sql() — Method in class content_visibility

Create topic/post visibility SQL for a set of forums

content_visibility::get_global_visibility_sql() — Method in class content_visibility

Create topic/post visibility SQL for all forums on the board

helper::get_current_url() — Method in class helper

Return the current url

resolver::getController() — Method in class resolver

Load a controller callable

resolver::getArguments() — Method in class resolver

Dependencies should be specified in the service definition and can be then accessed in __construct(). Arguments are sent through the URL path and should match the parameters of the method you are using as your controller.

cron_runner_listener::getSubscribedEvents() — Method in class cron_runner_listener
{@inheritdoc}
manager::get_tasks() — Method in class manager

Find all tasks and return them.

base::get_name() — Method in class base

Returns the name of the task.

prune_forum::get_parameters() — Method in class prune_forum

Returns parameters of this cron task as an array.

prune_shadow_topics::get_parameters() — Method in class prune_shadow_topics

Returns parameters of this cron task as an array.

parametrized::get_parameters() — Method in class parametrized

Returns parameters of this cron task as an array.

task::get_name() — Method in class task

Returns the name of the task.

wrapper::get_url() — Method in class wrapper

Returns a url through which this task may be invoked via web.

wrapper::get_html_tag() — Method in class wrapper

Returns HTML for an invisible img tag that can be displayed on page load to trigger a request to the relevant cron task endpoint.

driver::get_sql_layer() — Method in class driver

Gets the name of the sql layer.

driver::get_db_name() — Method in class driver

Gets the name of the database.

driver::get_any_char() — Method in class driver

Wildcards for matching any (%) character within LIKE expressions

driver::get_one_char() — Method in class driver

Wildcards for matching exactly one (_) character within LIKE expressions

driver::get_db_connect_id() — Method in class driver

Gets the connect ID.

driver::get_sql_error_triggered() — Method in class driver

Indicates if an error was triggered.

driver::get_sql_error_sql() — Method in class driver

Gets the last faulty query

driver::get_transaction() — Method in class driver

Indicates if we are in a transaction.

driver::get_sql_time() — Method in class driver

Gets the time spent into the queries

driver::get_sql_error_returned() — Method in class driver

Gets the returned error.

driver::get_multi_insert() — Method in class driver

Indicates if multiple insertion can be used

driver::get_estimated_row_count() — Method in class driver

Gets the estimated number of rows in a specified table.

driver::get_row_count() — Method in class driver

Gets the exact number of rows in a specified table.

driver_interface::get_sql_layer() — Method in class driver_interface

Gets the name of the sql layer.

driver_interface::get_db_name() — Method in class driver_interface

Gets the name of the database.

driver_interface::get_any_char() — Method in class driver_interface

Wildcards for matching any (%) character within LIKE expressions

driver_interface::get_one_char() — Method in class driver_interface

Wildcards for matching exactly one (_) character within LIKE expressions

driver_interface::get_sql_time() — Method in class driver_interface

Gets the time spent into the queries

driver_interface::get_db_connect_id() — Method in class driver_interface

Gets the connect ID.

driver_interface::get_sql_error_triggered() — Method in class driver_interface

Indicates if an error was triggered.

driver_interface::get_sql_error_sql() — Method in class driver_interface

Gets the last faulty query

driver_interface::get_transaction() — Method in class driver_interface

Indicates if we are in a transaction.

driver_interface::get_sql_error_returned() — Method in class driver_interface

Gets the returned error.

driver_interface::get_multi_insert() — Method in class driver_interface

Indicates if multiple insertion can be used

driver_interface::get_row_count() — Method in class driver_interface

Gets the exact number of rows in a specified table.

driver_interface::get_estimated_row_count() — Method in class driver_interface

Gets the estimated number of rows in a specified table.

factory::get_driver() — Method in class factory

Return the current driver (and retrieved it from the container if necessary)

factory::get_sql_layer() — Method in class factory

Gets the name of the sql layer.

factory::get_db_name() — Method in class factory

Gets the name of the database.

factory::get_any_char() — Method in class factory

Wildcards for matching any (%) character within LIKE expressions

factory::get_one_char() — Method in class factory

Wildcards for matching exactly one (_) character within LIKE expressions

factory::get_db_connect_id() — Method in class factory

Gets the connect ID.

factory::get_sql_error_triggered() — Method in class factory

Indicates if an error was triggered.

factory::get_sql_error_sql() — Method in class factory

Gets the last faulty query

factory::get_transaction() — Method in class factory

Indicates if we are in a transaction.

factory::get_sql_time() — Method in class factory

Gets the time spent into the queries

factory::get_sql_error_returned() — Method in class factory

Gets the returned error.

factory::get_multi_insert() — Method in class factory

Indicates if multiple insertion can be used

factory::get_row_count() — Method in class factory

Gets the exact number of rows in a specified table.

factory::get_estimated_row_count() — Method in class factory

Gets the estimated number of rows in a specified table.

mysql_base::get_estimated_row_count() — Method in class mysql_base

Gets the estimated number of rows in a specified table.

mysql_base::get_row_count() — Method in class mysql_base

Gets the exact number of rows in a specified table.

mysql_base::get_table_status() — Method in class mysql_base

Gets some information about the specified table.

factory::get() — Method in class factory

DB extractor factory getter

exception::getParameters() — Method in class exception

Get the parameters

exception::getLocalisedMessage() — Method in class exception

Get localised message (with $user->lang())

helper::get_schema_steps() — Method in class helper

Get the schema steps from an array of schema changes

migration::get_queries() — Method in class migration

Get the list of queries run

profilefield_base_migration::get_custom_profile_field_id() — Method in class profilefield_base_migration

Get custom profile field id

profilefield_base_migration::get_insert_sql_array() — Method in class profilefield_base_migration
schema_generator::get_schema() — Method in class schema_generator

Loads all migrations and their application state from the database.

config::get_name() — Method in class config

Retrieve a short name used for commands in migrations.

config_text::get_name() — Method in class config_text

Retrieve a short name used for commands in migrations.

module::get_name() — Method in class module

Retrieve a short name used for commands in migrations.

module::get_module_info() — Method in class module

Wrapper for \acp_modules::get_module_infos()

module::get_categories_list() — Method in class module

Get the list of installed module categories key - module_id value - module_langname

module::get_parent_module_id() — Method in class module

Get parent module id

permission::get_name() — Method in class permission

Retrieve a short name used for commands in migrations.

tool_interface::get_name() — Method in class tool_interface

Retrieve a short name used for commands in migrations.

migrator::get_last_run_migration() — Method in class migrator

Get an array with information about the last migration run.

migrator::get_migrations() — Method in class migrator

Get the list of available migration class names

migrator::get_installable_migrations() — Method in class migrator

Get the list of available and not installed migration class names

migrator::get_valid_name() — Method in class migrator

Get a valid migration name from the migration state array in case the supplied name is not in the migration state list.

migrator::get_callable_from_step() — Method in class migrator

Get a callable statement from a data step

migrator::get_migration() — Method in class migrator

Helper to get a migration

factory::get() — Method in class factory
mssql::get_dbms_type_map() — Method in class mssql

Get the column types for mssql based databases

mssql::get_max_index_name_length() — Method in class mssql

Get maximum index name length. Might vary depending on db type

mssql::get_existing_indexes() — Method in class mssql

Get a list with existing indexes for the column

postgres::get_dbms_type_map() — Method in class postgres

Get the column types for postgres only

postgres::get_existing_indexes() — Method in class postgres

Get a list with existing indexes for the column

tools::get_dbms_type_map() — Method in class tools

Get the column types for every database we support

tools::get_column_type() — Method in class tools

Get the column's database type from the type map

tools::get_max_index_name_length() — Method in class tools

Get maximum index name length. Might vary depending on db type

tools::get_existing_indexes() — Method in class tools

Get a list with existing indexes for the column

container_builder::get_container() — Method in class container_builder

Build and return a new Container respecting the current configuration

container_builder::get_config_path() — Method in class container_builder

Returns the path to the container configuration (default: root_path/config)

container_builder::get_cache_dir() — Method in class container_builder

Returns the path to the cache directory (default: root_path/cache/environment).

container_builder::get_core_parameters() — Method in class container_builder

Returns the core parameters.

container_builder::get_env_parameters() — Method in class container_builder

Gets the environment parameters.

container_builder::get_container_filename() — Method in class container_builder

Get the filename under which the dumped container will be stored.

container_builder::get_autoload_filename() — Method in class container_builder

Get the filename under which the dumped extensions autoloader will be stored.

container_builder::get_environment() — Method in class container_builder

Return the name of the current environment.

config::getAlias() — Method in class config

Returns the recommended alias to use in XML.

container_configuration::getConfigTreeBuilder() — Method in class container_configuration

Generates the configuration tree builder.

core::getConfiguration() — Method in class core
{@inheritdoc}
core::getAlias() — Method in class core

Returns the recommended alias to use in XML.

tables::getAlias() — Method in class tables

Returns the recommended alias to use in XML.

ordered_service_collection::getIterator() — Method in class ordered_service_collection
{@inheritdoc}
service_collection::getIterator() — Method in class service_collection
{@inheritdoc}
service_collection::get_service_classes() — Method in class service_collection

Get services' classes

service_collection::get_by_class() — Method in class service_collection

Returns the service associated to a class

kernel_exception_subscriber::getSubscribedEvents() — Method in class kernel_exception_subscriber
kernel_terminate_subscriber::getSubscribedEvents() — Method in class kernel_terminate_subscriber
md_exporter::get_events() — Method in class md_exporter

Get the list of all events

md_exporter::get_recursive_file_list() — Method in class md_exporter

Returns a list of files in $dir

php_exporter::get_events() — Method in class php_exporter

Get the list of all events

php_exporter::get_recursive_file_list() — Method in class php_exporter

Returns a list of files in $dir

php_exporter::get_event_name() — Method in class php_exporter

Find the name of the event inside the dispatch() line

php_exporter::get_vars_from_array() — Method in class php_exporter

Find the $vars array

php_exporter::get_vars_from_single_line_array() — Method in class php_exporter

Find the variables in single line array

php_exporter::get_vars_from_multi_line_array() — Method in class php_exporter

Find the variables in single line array

php_exporter::get_vars_from_docblock() — Method in class php_exporter

Find the $vars array

recursive_event_filter_iterator::getChildren() — Method in class recursive_event_filter_iterator

Return the inner iterator's children contained in a recursive_event_filter_iterator

rst_exporter::generate_events_table() — Method in class rst_exporter

Fill table with event data

rst_exporter::get_rst_output() — Method in class rst_exporter

Get rst output

exception_interface::get_parameters() — Method in class exception_interface

Return the arguments associated with the message if it's a language var.

http_exception::getStatusCode() — Method in class http_exception
{@inheritdoc}
http_exception::getHeaders() — Method in class http_exception
{@inheritdoc}
runtime_exception::get_parameters() — Method in class runtime_exception

Return the arguments associated with the message if it's a language var.

base::get_migration_file_list() — Method in class base

Get the list of migration files from this extension

extension_base::getConfiguration() — Method in class extension_base
{@inheritdoc}
extension_base::getAlias() — Method in class extension_base

Returns the recommended alias to use in XML.

manager::get_extension_path() — Method in class manager

Generates the path to an extension

manager::get_extension() — Method in class manager

Instantiates the extension meta class for the extension with the given name

manager::get_finder() — Method in class manager

Instantiates a \phpbb\finder.

provider::getIterator() — Method in class provider

Retrieve an iterator over all items

attachments_base::get_attachments() — Method in class attachments_base

Get attachments related to a given post

base::get() — Method in class base

Get key

base::get_item() — Method in class base

Get the next post in the feed

base::get_readable_forums() — Method in class base

Returns the ids of the forums readable by the current user.

base::get_moderator_approve_forums() — Method in class base

Returns the ids of the forum for which the current user can approve the post in the moderation queue.

base::get_excluded_forums() — Method in class base

Returns the ids of the forum excluded from the feeds

base::get_passworded_forums() — Method in class base

Returns all password protected forum ids the current user is currently NOT authenticated for.

base::get_sql() — Method in class base

Returns the SQL query used to retrieve the posts of the feed.

feed_interface::get() — Method in class feed_interface

Get key

feed_interface::get_item() — Method in class feed_interface

Get the next post in the feed

forum::get_sql() — Method in class forum

Returns the SQL query used to retrieve the posts of the feed.

forum::get_item() — Method in class forum

Get the next post in the feed

forums::get_sql() — Method in class forums

Returns the SQL query used to retrieve the posts of the feed.

helper::get_board_url() — Method in class helper

Returns the board url (and caches it in the function)

helper::generate_content() — Method in class helper

Generate text content

news::get_sql() — Method in class news

Returns the SQL query used to retrieve the posts of the feed.

overall::get_sql() — Method in class overall

Returns the SQL query used to retrieve the posts of the feed.

topic::get_sql() — Method in class topic

Returns the SQL query used to retrieve the posts of the feed.

topic::get_item() — Method in class topic

Get the next post in the feed

topics::get_sql() — Method in class topics

Returns the SQL query used to retrieve the posts of the feed.

topics_active::get_sql() — Method in class topics_active

Returns the SQL query used to retrieve the posts of the feed.

file_downloader::get() — Method in class file_downloader

Retrieve contents from remotely stored file

file_downloader::get_error_string() — Method in class file_downloader

Get error string

file_downloader::get_error_number() — Method in class file_downloader

Get error number

factory::get() — Method in class factory

Get files service

filespec::get() — Method in class filespec

Get property from file object

filespec::get_extension() — Method in class filespec

Get file extension

filespec::get_mimetype() — Method in class filespec

Get mime type

filespec::get_filesize() — Method in class filespec

Get file size

local::get_upload_ary() — Method in class local

Retrieve upload array

remote::get_max_file_size() — Method in class remote

Get maximum file size for remote uploads

filesystem_exception::get_filename() — Method in class filesystem_exception

Returns the filename that triggered the error

finder::get_classes() — Method in class finder

Finds classes matching the configured options if they follow phpBB naming rules.

finder::get_classes_from_files() — Method in class finder

Get class names from a list of files

finder::get_directories() — Method in class finder

Finds all directories matching the configured options

finder::get_files() — Method in class finder

Finds all files matching the configured options.

helper::get_name() — Method in class helper
helper::get_name_string() — Method in class helper

Get group name details for placing into templates.

helper::get_rank() — Method in class helper

Get group rank title and image

helper::get_avatar() — Method in class helper

Get group avatar.

groupposition_interfaceClass in namespace phpbb\groupposition

Interface to manage group positions in various places of phpbb

groupposition_interface::get_group_value() — Method in class groupposition_interface

Returns the value for a given group, if the group exists.

groupposition_interface::get_group_count() — Method in class groupposition_interface

Get number of groups displayed

legend::get_group_value() — Method in class legend

Returns the group_legend for a given group, if the group exists.

legend::get_group_count() — Method in class legend

Get number of groups, displayed on the legend

legend::group_type_language() — Method in class legend

Get group type language var

teampage::get_group_value() — Method in class teampage

Returns the teampage position for a given group, if the group exists.

teampage::get_group_values() — Method in class teampage

Returns the row for a given group, if the group exists.

teampage::get_teampage_value() — Method in class teampage

Returns the teampage position for a given teampage item, if the item exists.

teampage::get_teampage_values() — Method in class teampage

Returns the teampage row for a given teampage item, if the item exists.

teampage::get_group_count() — Method in class teampage

Get number of groups displayed

teampage::group_type_language() — Method in class teampage

Get group type language var

helper::get_active_main_menu() — Method in class helper

Returns the name of the active main menu item

kernel_exception_subscriber::getSubscribedEvents() — Method in class kernel_exception_subscriber

Returns an array of events the object is subscribed to

jump_to_restart_point_exception::get_restart_point_name() — Method in class jump_to_restart_point_exception

Returns the restart point's name

config::get() — Method in class config

Returns data for a specified parameter

config::get_time_remaining() — Method in class config

Returns remaining time until the run time limit

config::get_memory_remaining() — Method in class config

Returns remaining memory available for PHP

config::get_progress_data() — Method in class config

Getter for progress data

config::get_current_task_progress() — Method in class config

Returns the number of the current task being executed

config::get_task_progress_count() — Method in class config

Returns the number of tasks belonging to the installer in the current mode.

config::get_navigation_data() — Method in class config

Returns navigation data

container_factory::get() — Method in class container_factory

Container getter

container_factory::get_parameter() — Method in class container_factory

Returns the specified parameter from the container

compression_file_updater::get_method_name() — Method in class compression_file_updater

Returns the name of the file updater method

factory::get() — Method in class factory

Returns file updater object

file_updater::get_method_name() — Method in class file_updater

Returns the name of the file updater method

file_updater_interface::get_method_name() — Method in class file_updater_interface

Returns the name of the file updater method

ftp_file_updater::get_method_name() — Method in class ftp_file_updater

Returns the name of the file updater method

ajax_iohandler::get_input() — Method in class ajax_iohandler

Returns input variable

ajax_iohandler::get_raw_input() — Method in class ajax_iohandler

Returns raw input variable

ajax_iohandler::get_server_variable() — Method in class ajax_iohandler

Returns server variable

ajax_iohandler::get_header_variable() — Method in class ajax_iohandler

Wrapper function for request_interface::header()

ajax_iohandler::generate_form_render_data() — Method in class ajax_iohandler

Returns the rendering information for the form

cli_iohandler::get_input() — Method in class cli_iohandler

Returns input variable

cli_iohandler::get_raw_input() — Method in class cli_iohandler

Returns raw input variable

cli_iohandler::get_server_variable() — Method in class cli_iohandler

Returns server variable

cli_iohandler::get_header_variable() — Method in class cli_iohandler

Wrapper function for request_interface::header()

factory::get() — Method in class factory

Factory getter for iohandler

iohandler_base::generate_form_render_data() — Method in class iohandler_base

Returns the rendering information for the form

iohandler_interface::get_input() — Method in class iohandler_interface

Returns input variable

iohandler_interface::get_raw_input() — Method in class iohandler_interface

Returns raw input variable

iohandler_interface::get_server_variable() — Method in class iohandler_interface

Returns server variable

iohandler_interface::get_header_variable() — Method in class iohandler_interface

Wrapper function for request_interface::header()

iohandler_interface::generate_form_render_data() — Method in class iohandler_interface

Returns the rendering information for the form

convertor_navigation::get() — Method in class convertor_navigation

Returns an array with the navigation items

install_navigation::get() — Method in class install_navigation

Returns an array with the navigation items

main_navigation::get() — Method in class main_navigation

Returns an array with the navigation items

navigation_interface::get() — Method in class navigation_interface

Returns an array with the navigation items

navigation_provider::get() — Method in class navigation_provider

Returns navigation array

update_navigation::get() — Method in class update_navigation

Returns an array with the navigation items

update_helper::get_path_to_new_update_files() — Method in class update_helper

Returns path to new update files

update_helper::get_path_to_old_update_files() — Method in class update_helper

Returns path to new update files

installer_configuration::getConfigTreeBuilder() — Method in class installer_configuration

Generates the configuration tree builder.

module::get_navigation_stage_path() — Method in class module

Returns an array to the correct navigation stage

create_config_file::get_config_data() — Method in class create_config_file

Returns the content which should be dumped to config.php

create_config_file::get_step_count() — Method in class create_config_file

Returns the number of steps the task contains

create_config_file::get_task_lang_name() — Method in class create_config_file

Returns the language key of the name of the task

module::get_navigation_stage_path() — Method in class module

Returns an array to the correct navigation stage

install_extensions::get_step_count() — Method in class install_extensions

Returns the number of steps the task contains

install_extensions::get_task_lang_name() — Method in class install_extensions

Returns the language key of the name of the task

notify_user::get_step_count() — Method in class notify_user

Returns the number of steps the task contains

notify_user::get_task_lang_name() — Method in class notify_user

Returns the language key of the name of the task

populate_migrations::get_step_count() — Method in class populate_migrations

Returns the number of steps the task contains

populate_migrations::get_task_lang_name() — Method in class populate_migrations

Returns the language key of the name of the task

abstract_requirements_module::get_step_count() — Method in class abstract_requirements_module

Returns the number of tasks in the module

install_module::get_navigation_stage_path() — Method in class install_module

Returns an array to the correct navigation stage

check_filesystem::get_step_count() — Method in class check_filesystem

Returns the number of steps the task contains

check_filesystem::get_task_lang_name() — Method in class check_filesystem

Returns the language key of the name of the task

check_server_environment::get_step_count() — Method in class check_server_environment

Returns the number of steps the task contains

check_server_environment::get_task_lang_name() — Method in class check_server_environment

Returns the language key of the name of the task

check_update::get_step_count() — Method in class check_update

Returns the number of steps the task contains

check_update::get_task_lang_name() — Method in class check_update

Returns the language key of the name of the task

update_module::get_navigation_stage_path() — Method in class update_module

Returns an array to the correct navigation stage

module::get_navigation_stage_path() — Method in class module

Returns an array to the correct navigation stage

module::get_step_count() — Method in class module

Returns the number of tasks in the module

diff_files::get_step_count() — Method in class diff_files

Returns the number of steps the task contains

diff_files::get_task_lang_name() — Method in class diff_files

Returns the language key of the name of the task

download_updated_files::get_step_count() — Method in class download_updated_files

Returns the number of steps the task contains

download_updated_files::get_task_lang_name() — Method in class download_updated_files

Returns the language key of the name of the task

file_check::get_step_count() — Method in class file_check

Returns the number of steps the task contains

file_check::get_task_lang_name() — Method in class file_check

Returns the language key of the name of the task

show_file_status::get_step_count() — Method in class show_file_status

Returns the number of steps the task contains

show_file_status::get_task_lang_name() — Method in class show_file_status

Returns the language key of the name of the task

update_files::get_file_updater() — Method in class update_files

Get file updater

update_files::get_step_count() — Method in class update_files

Returns the number of steps the task contains

update_files::get_task_lang_name() — Method in class update_files

Returns the language key of the name of the task

module_base::get_step_count() — Method in class module_base

Returns the number of tasks in the module

module_interface::get_step_count() — Method in class module_interface

Returns the number of tasks in the module

module_interface::get_navigation_stage_path() — Method in class module_interface

Returns an array to the correct navigation stage

task_interface::get_step_count() — Method in class task_interface

Returns the number of steps the task contains

task_interface::get_task_lang_name() — Method in class task_interface

Returns the language key of the name of the task

updater_configuration::getConfigTreeBuilder() — Method in class updater_configuration

Generates the configuration tree builder.

language::get_lang_array() — Method in class language

Returns language array

language::get_plural_form() — Method in class language

Determine which plural form we should use.

language::get_used_language() — Method in class language

Returns the ISO code of the used language

language_file_helper::get_available_languages() — Method in class language_file_helper

Returns available languages

language_file_loader::get_language_file_path() — Method in class language_file_loader

This function implements language fallback logic

dummy::get_logs() — Method in class dummy

Grab the logs from the database

dummy::get_log_count() — Method in class dummy

Get total log count

dummy::get_valid_offset() — Method in class dummy

Get offset of the last valid page

log::get_is_admin() — Method in class log

Returns the is_in_admin option

log::get_logs() — Method in class log

Grab the logs from the database

log::generate_sql_keyword() — Method in class log

Generates a sql condition for the specified keywords

log::get_topic_auth() — Method in class log

Determine whether the user is allowed to read and/or moderate the forum of the topic

log::get_reportee_data() — Method in class log

Get the data for all reportee from the database

log::get_log_count() — Method in class log

Get total log count

log::get_valid_offset() — Method in class log

Get offset of the last valid page

log_interface::get_logs() — Method in class log_interface

Grab the logs from the database

log_interface::get_log_count() — Method in class log_interface

Get total log count

log_interface::get_valid_offset() — Method in class log_interface

Get offset of the last valid page

form::get_page_title() — Method in class form

Returns the title for the email form page

form::get_template_file() — Method in class form

Returns the file name of the form template

form::get_return_message() — Method in class form

Get the return link after the message has been sent

topic_form::get_topic_row() — Method in class topic_form

Get the data of the topic

topic_form::get_return_message() — Method in class topic_form
{inheritDoc}
user_form::get_user_row() — Method in class user_form

Get the data of the recipient

content_guesser::guess() — Method in class content_guesser

Guess mimetype of supplied file

extension_guesser::guess() — Method in class extension_guesser

Guess mimetype of supplied file

guesserClass in namespace phpbb\mimetype
$ guesser#guessersProperty in class guesser
guesser::guess() — Method in class guesser

Guess mimetype of supplied file

guesser_baseClass in namespace phpbb\mimetype
guesser_base::get_priority() — Method in class guesser_base

Get the guesser priority

guesser_interfaceClass in namespace phpbb\mimetype
guesser_interface::guess() — Method in class guesser_interface

Guess mimetype of supplied file

guesser_interface::get_priority() — Method in class guesser_interface

Get the guesser priority

module_manager::get_module_row() — Method in class module_manager

Get row for specified module

module_manager::get_module_infos() — Method in class module_manager

Get available module information from module files

module_manager::get_module_branch() — Method in class module_manager

Get module branch

manager::get_subscription_types() — Method in class manager

Get all of the subscription types

manager::get_subscription_methods() — Method in class manager

Get all of the subscription methods

manager::get_user_notifications() — Method in class manager

Get user's notification data

manager::get_global_subscriptions() — Method in class manager

Get global subscriptions (item_id = 0)

manager::get_default_methods() — Method in class manager

Helper to get the list of methods enabled by default

manager::get_item_type_class() — Method in class manager

Helper to get the notifications item type class and set it up

manager::get_method_class() — Method in class manager

Helper to get the notifications method class and set it up

manager::get_notification_type_id() — Method in class manager

Get the notification type id from the name

manager::get_notification_type_ids() — Method in class manager

Get notification type ids (as an array)

manager::get_notified_users() — Method in class manager

Find the users which are already notified

base::get_notified_users() — Method in class base

Return the list of the users already notified

board::get_type() — Method in class board

Get notification method name

board::get_notified_users() — Method in class board

Return the list of the users already notified

email::get_type() — Method in class email

Get notification method name

email::get_notified_users() — Method in class email

Return the list of the users already notified

jabber::get_type() — Method in class jabber

Get notification method name

jabber::global_available() — Method in class jabber

Is this method available at all? This is checked before notifications are sent

method_interface::get_type() — Method in class method_interface

Get notification method name

method_interface::get_notified_users() — Method in class method_interface

Return the list of the users already notified

admin_activate_user::get_type() — Method in class admin_activate_user

Get notification type name

admin_activate_user::get_item_id() — Method in class admin_activate_user

Get the id of the item

admin_activate_user::get_item_parent_id() — Method in class admin_activate_user

Get the id of the parent

admin_activate_user::get_avatar() — Method in class admin_activate_user

Get the user's avatar (fall back)

admin_activate_user::get_title() — Method in class admin_activate_user

Get the HTML formatted title of this notification

admin_activate_user::get_email_template() — Method in class admin_activate_user

Get email template

admin_activate_user::get_email_template_variables() — Method in class admin_activate_user

Get email template variables

admin_activate_user::get_url() — Method in class admin_activate_user

Get the url to this item

approve_post::get_type() — Method in class approve_post

Get notification type name

approve_post::get_insert_array() — Method in class approve_post

Function for getting the data for insertion in an SQL query

approve_post::get_email_template() — Method in class approve_post

Get email template

approve_post::get_redirect_url() — Method in class approve_post
{inheritDoc}
approve_topic::get_type() — Method in class approve_topic

Get notification type name

approve_topic::get_insert_array() — Method in class approve_topic

Function for getting the data for insertion in an SQL query

approve_topic::get_email_template() — Method in class approve_topic

Get email template

base::get_data() — Method in class base

Get special data (only important for the classes that extend this)

base::get_insert_array() — Method in class base

Function for getting the data for insertion in an SQL query

base::get_redirect_url() — Method in class base
{inheritDoc}
base::get_unsubscribe_url() — Method in class base

URL to unsubscribe to this notification (fall back)

base::get_style_class() — Method in class base

Get the CSS style class of the notification (fall back)

base::get_avatar() — Method in class base

Get the user's avatar (fall back)

base::get_reference() — Method in class base

Get the reference of the notification (fall back)

base::get_forum() — Method in class base

Get the forum of the notification reference (fall back)

base::get_reason() — Method in class base

Get the reason for the notification (fall back)

base::get_load_special() — Method in class base

Get the special items to load (fall back)

base::get_authorised_recipients() — Method in class base

Get a list of users that are authorised to receive notifications

bookmark::get_type() — Method in class bookmark

Get notification type name

bookmark::get_email_template() — Method in class bookmark

Get email template

disapprove_post::get_type() — Method in class disapprove_post

Get notification type name

disapprove_post::get_style_class() — Method in class disapprove_post

Get the CSS style class of the notification

disapprove_post::get_title() — Method in class disapprove_post

Get the HTML formatted title of this notification

disapprove_post::get_reference() — Method in class disapprove_post

Get the HTML formatted reference of the notification

disapprove_post::get_reason() — Method in class disapprove_post

Get the reason for the disapproval notification

disapprove_post::get_url() — Method in class disapprove_post

Get the url to this item

disapprove_post::get_email_template_variables() — Method in class disapprove_post

Get email template variables

disapprove_post::get_insert_array() — Method in class disapprove_post

Function for getting the data for insertion in an SQL query

disapprove_post::get_email_template() — Method in class disapprove_post

Get email template

disapprove_topic::get_type() — Method in class disapprove_topic

Get notification type name

disapprove_topic::get_style_class() — Method in class disapprove_topic

Get the CSS style class of the notification

disapprove_topic::get_title() — Method in class disapprove_topic

Get the HTML formatted title of this notification

disapprove_topic::get_reference() — Method in class disapprove_topic

Get the HTML formatted reference of the notification

disapprove_topic::get_reason() — Method in class disapprove_topic

Get the reason for the disapproval notification

disapprove_topic::get_url() — Method in class disapprove_topic

Get the url to this item

disapprove_topic::get_email_template_variables() — Method in class disapprove_topic

Get email template variables

disapprove_topic::get_insert_array() — Method in class disapprove_topic

Function for getting the data for insertion in an SQL query

disapprove_topic::get_email_template() — Method in class disapprove_topic

Get email template

forum::get_type() — Method in class forum

Get notification type name

forum::get_email_template() — Method in class forum

Get email template

forum::get_email_template_variables() — Method in class forum

Get email template variables

group_requestClass in namespace phpbb\notification\type
group_request::get_type() — Method in class group_request

Get notification type name

group_request::get_item_id() — Method in class group_request

Get the id of the item

group_request::get_item_parent_id() — Method in class group_request

Get the id of the parent

group_request::get_avatar() — Method in class group_request

Get the user's avatar (fall back)

group_request::get_title() — Method in class group_request

Get the HTML formatted title of this notification

group_request::get_email_template() — Method in class group_request

Get email template

group_request::get_email_template_variables() — Method in class group_request

Get email template variables

group_request::get_url() — Method in class group_request

Get the url to this item

group_request_approvedClass in namespace phpbb\notification\type
group_request_approved::get_type() — Method in class group_request_approved

Get notification type name

group_request_approved::get_item_id() — Method in class group_request_approved

Get the id of the item

group_request_approved::get_item_parent_id() — Method in class group_request_approved

Get the id of the parent

group_request_approved::get_title() — Method in class group_request_approved

Get the HTML formatted title of this notification

group_request_approved::get_url() — Method in class group_request_approved

Get the url to this item

group_request_approved::get_email_template() — Method in class group_request_approved

Get email template

group_request_approved::get_email_template_variables() — Method in class group_request_approved

Get email template variables

pm::get_type() — Method in class pm

Get notification type name

pm::get_item_id() — Method in class pm

Get the id of the

pm::get_item_parent_id() — Method in class pm

Get the id of the parent

pm::get_avatar() — Method in class pm

Get the user's avatar

pm::get_title() — Method in class pm

Get the HTML formatted title of this notification

pm::get_reference() — Method in class pm

Get the HTML formatted reference of the notification

pm::get_email_template() — Method in class pm

Get email template

pm::get_email_template_variables() — Method in class pm

Get email template variables

pm::get_url() — Method in class pm

Get the url to this item

post::get_type() — Method in class post

Get notification type name

post::get_item_id() — Method in class post

Get the id of the item

post::get_item_parent_id() — Method in class post

Get the id of the parent

post::get_avatar() — Method in class post

Get the user's avatar

post::get_title() — Method in class post

Get the HTML formatted title of this notification

post::get_reference() — Method in class post

Get the HTML formatted reference of the notification

post::get_email_template() — Method in class post

Get email template

post::get_email_template_variables() — Method in class post

Get email template variables

post::get_url() — Method in class post

Get the url to this item

post::get_redirect_url() — Method in class post
{inheritDoc}
post_in_queue::get_type() — Method in class post_in_queue

Get notification type name

post_in_queue::get_url() — Method in class post_in_queue

Get the url to this item

post_in_queue::get_redirect_url() — Method in class post_in_queue
{inheritDoc}
post_in_queue::get_insert_array() — Method in class post_in_queue

Function for getting the data for insertion in an SQL query

post_in_queue::get_email_template() — Method in class post_in_queue

Get email template

quote::get_type() — Method in class quote

Get notification type name

quote::get_redirect_url() — Method in class quote
{inheritDoc}
quote::get_email_template() — Method in class quote

Get email template

quote::get_email_template_variables() — Method in class quote

Get email template variables

report_pm::get_type() — Method in class report_pm

Get notification type name

report_pm::get_style_class() — Method in class report_pm

Get the CSS style class of the notification

report_pm::get_item_parent_id() — Method in class report_pm

Get the id of the parent

report_pm::get_email_template() — Method in class report_pm

Get email template

report_pm::get_email_template_variables() — Method in class report_pm

Get email template variables

report_pm::get_url() — Method in class report_pm

Get the url to this item

report_pm::get_title() — Method in class report_pm

Get the HTML formatted title of this notification

report_pm::get_reference() — Method in class report_pm

Get the HTML formatted reference of the notification

report_pm::get_reason() — Method in class report_pm

Get the reason for the notification

report_pm::get_avatar() — Method in class report_pm

Get the user's avatar

report_pm_closed::get_type() — Method in class report_pm_closed

Get notification type name

report_pm_closed::get_email_template() — Method in class report_pm_closed

Get email template

report_pm_closed::get_email_template_variables() — Method in class report_pm_closed

Get email template variables

report_pm_closed::get_title() — Method in class report_pm_closed

Get the HTML formatted title of this notification

report_pm_closed::get_reference() — Method in class report_pm_closed

Get the HTML formatted reference of the notification

report_pm_closed::get_avatar() — Method in class report_pm_closed

Get the user's avatar

report_pm_closed::get_insert_array() — Method in class report_pm_closed

Function for getting the data for insertion in an SQL query

report_post::get_type() — Method in class report_post

Get notification type name

report_post::get_style_class() — Method in class report_post

Get the CSS style class of the notification

report_post::get_email_template() — Method in class report_post

Get email template

report_post::get_email_template_variables() — Method in class report_post

Get email template variables

report_post::get_url() — Method in class report_post

Get the url to this item

report_post::get_title() — Method in class report_post

Get the HTML formatted title of this notification

report_post::get_reference() — Method in class report_post

Get the HTML formatted reference of the notification

report_post::get_reason() — Method in class report_post

Get the reason for the notification

report_post::get_avatar() — Method in class report_post

Get the user's avatar

report_post_closed::get_type() — Method in class report_post_closed

Get notification type name

report_post_closed::get_email_template() — Method in class report_post_closed

Get email template

report_post_closed::get_email_template_variables() — Method in class report_post_closed

Get email template variables

report_post_closed::get_url() — Method in class report_post_closed

Get the url to this item

report_post_closed::get_redirect_url() — Method in class report_post_closed
{inheritDoc}
report_post_closed::get_title() — Method in class report_post_closed

Get the HTML formatted title of this notification

report_post_closed::get_reference() — Method in class report_post_closed

Get the HTML formatted reference of the notification

report_post_closed::get_avatar() — Method in class report_post_closed

Get the user's avatar

report_post_closed::get_insert_array() — Method in class report_post_closed

Function for getting the data for insertion in an SQL query

topic::get_type() — Method in class topic

Get notification type name

topic::get_item_id() — Method in class topic

Get the id of the item

topic::get_item_parent_id() — Method in class topic

Get the id of the parent

topic::get_avatar() — Method in class topic

Get the user's avatar

topic::get_title() — Method in class topic

Get the HTML formatted title of this notification

topic::get_reference() — Method in class topic

Get the HTML formatted reference of the notification

topic::get_forum() — Method in class topic

Get the forum of the notification reference

topic::get_email_template() — Method in class topic

Get email template

topic::get_email_template_variables() — Method in class topic

Get email template variables

topic::get_url() — Method in class topic

Get the url to this item

topic_in_queue::get_type() — Method in class topic_in_queue

Get notification type name

topic_in_queue::get_url() — Method in class topic_in_queue

Get the url to this item

topic_in_queue::get_insert_array() — Method in class topic_in_queue

Function for getting the data for insertion in an SQL query

topic_in_queue::get_email_template() — Method in class topic_in_queue

Get email template

type_interface::get_type() — Method in class type_interface

Get notification type name

type_interface::get_item_id() — Method in class type_interface

Get the id of the item

type_interface::get_item_parent_id() — Method in class type_interface

Get the id of the parent

type_interface::get_load_special() — Method in class type_interface

Get the special items to load

type_interface::get_style_class() — Method in class type_interface

Get the CSS style class of the notification

type_interface::get_title() — Method in class type_interface

Get the HTML formatted title of this notification

type_interface::get_reference() — Method in class type_interface

Get the HTML formatted reference of the notification

type_interface::get_forum() — Method in class type_interface

Get the forum of the notification reference

type_interface::get_url() — Method in class type_interface

Get the url to this item

type_interface::get_redirect_url() — Method in class type_interface

Get the url to redirect after the item has been marked as read

type_interface::get_unsubscribe_url() — Method in class type_interface

URL to unsubscribe to this notification

type_interface::get_avatar() — Method in class type_interface

Get the user's avatar (the user who caused the notification typically)

type_interface::get_email_template() — Method in class type_interface

Get email template

type_interface::get_email_template_variables() — Method in class type_interface

Get email template variables

type_interface::get_insert_array() — Method in class type_interface

Function for getting the data for insertion in an SQL query

pagination::generate_page_link() — Method in class pagination

Generate a pagination link based on the url and the page information

pagination::generate_template_pagination() — Method in class pagination

Generate template rendered pagination Allows full control of rendering of pagination with the template

pagination::get_on_page() — Method in class pagination

Get current page number

argon2i::get_algo_name() — Method in class argon2i

Return the constant name for this driver's algorithm

argon2i::get_options() — Method in class argon2i

Return the options set for this driver instance

argon2i::get_prefix() — Method in class argon2i

Returns the hash prefix

argon2id::get_algo_name() — Method in class argon2id

Return the constant name for this driver's algorithm

argon2id::get_prefix() — Method in class argon2id

Returns the hash prefix

base::get_settings_only() — Method in class base

Get only the settings of the specified hash

base_native::get_algo_name() — Method in class base_native

Return the constant name for this driver's algorithm

base_native::get_options() — Method in class base_native

Return the options set for this driver instance

base_native::get_algo_value() — Method in class base_native

Return the value for this driver's algorithm

bcrypt::get_prefix() — Method in class bcrypt

Returns the hash prefix

bcrypt::get_random_salt() — Method in class bcrypt

Get a random salt value with a length of 22 characters

bcrypt::get_settings_only() — Method in class bcrypt

Get only the settings of the specified hash

bcrypt_2y::get_prefix() — Method in class bcrypt_2y

Returns the hash prefix

bcrypt_wcf2::get_prefix() — Method in class bcrypt_wcf2

Returns the hash prefix

convert_password::get_prefix() — Method in class convert_password

Returns the hash prefix

driver_interface::get_prefix() — Method in class driver_interface

Returns the hash prefix

driver_interface::get_settings_only() — Method in class driver_interface

Get only the settings of the specified hash

helper::get_random_salt() — Method in class helper

Get random salt with specified length

md5_mybb::get_prefix() — Method in class md5_mybb

Returns the hash prefix

md5_phpbb2::get_prefix() — Method in class md5_phpbb2

Returns the hash prefix

md5_vb::get_prefix() — Method in class md5_vb

Returns the hash prefix

phpass::get_prefix() — Method in class phpass

Returns the hash prefix

salted_md5::get_prefix() — Method in class salted_md5

Returns the hash prefix

salted_md5::generate_salt() — Method in class salted_md5

Generate salt for hashing method

salted_md5::get_hash_settings() — Method in class salted_md5

Get hash settings

salted_md5::get_settings_only() — Method in class salted_md5

Get only the settings of the specified hash

sha1::get_prefix() — Method in class sha1

Returns the hash prefix

sha1_smf::get_prefix() — Method in class sha1_smf

Returns the hash prefix

sha1_wcf1::get_prefix() — Method in class sha1_wcf1

Returns the hash prefix

sha_xf1::get_prefix() — Method in class sha_xf1

Returns the hash prefix

helper::get_combined_hash_settings() — Method in class helper

Get hash settings from combined hash

manager::get_algorithm() — Method in class manager

Get the algorithm specified by a specific prefix

path_helper::get_phpbb_root_path() — Method in class path_helper

Get the phpBB root path

path_helper::get_adm_relative_path() — Method in class path_helper

Get the adm root path

path_helper::get_php_ext() — Method in class path_helper

Get the php extension

path_helper::get_web_root_path() — Method in class path_helper

Get a relative root path from the current URL

path_helper::get_web_root_path_from_ajax_referer() — Method in class path_helper

Get the web root path of the referer form an ajax request

path_helper::glue_url_params() — Method in class path_helper

Glue URL parameters together

path_helper::get_url_parts() — Method in class path_helper

Get the base and parameters of a URL

path_helper::get_valid_page() — Method in class path_helper

Get a valid page

permissions::get_categories() — Method in class permissions

Returns an array with all the permission categories (pm, post, settings, misc, etc.)

permissions::get_category_lang() — Method in class permissions

Returns the language string of a permission category

permissions::get_types() — Method in class permissions

Returns an array with all the permission types (a, u, m_, etc.)

permissions::get_type_lang() — Method in class permissions

Returns the language string of a permission type

permissions::get_permissions() — Method in class permissions

Returns an array with all the permissions.

permissions::get_permission_category() — Method in class permissions

Returns the category of a permission

permissions::get_permission_lang() — Method in class permissions

Returns the language string of a permission

ini::get() — Method in class ini

Simple wrapper for ini_get() See http://php.net/manual/en/function.ini-get.php

ini::get_string() — Method in class ini

Gets the configuration option value as a trimmed string.

ini::get_bool() — Method in class ini

Gets configuration option value as a boolean.

ini::get_int() — Method in class ini

Gets configuration option value as an integer.

ini::get_float() — Method in class ini

Gets configuration option value as a float.

ini::get_bytes() — Method in class ini

Gets configuration option value in bytes.

plupload::generate_filter_string() — Method in class plupload

Looks at the list of allowed extensions and generates a string appropriate for use in configuring plupload with

plupload::generate_resize_string() — Method in class plupload

Generates a string that is used to tell plupload to automatically resize files before uploading them.

plupload::get_chunk_size() — Method in class plupload

Checks various php.ini values to determine the maximum chunk size a file should be split into for upload.

lang_helper::get() — Method in class lang_helper

Get the selected language string

manager::generate_profile_fields() — Method in class manager

Assign editable fields to template.

manager::generate_profile_fields_template_headlines() — Method in class manager

Generate the template arrays in order to display the column names.

manager::grab_profile_fields_data() — Method in class manager

Grab the user specific profile fields data.

manager::generate_profile_fields_template_data() — Method in class manager

Generate the user's profile fields data for the template.

type_base::get_name() — Method in class type_base

Get the translated name of the type

type_base::get_service_name() — Method in class type_base

Get the name of service representing the type

type_base::get_template_filename() — Method in class type_base

Get the name of template file for this type

type_base::get_field_ident() — Method in class type_base

Get the ident of the field

type_base::get_field_name() — Method in class type_base

Get the localized name of the field

type_base::get_profile_contact_value() — Method in class type_base

Get Profile Value for display

type_base::get_language_options_input() — Method in class type_base

Get the input for the supplied language options

type_base::get_excluded_options() — Method in class type_base

Allows manipulating the intended variables if needed

type_bool::get_name_short() — Method in class type_bool

Get the short name of the type, used for error messages and template loops

type_bool::get_options() — Method in class type_bool

Get dropdown options for second step in ACP

type_bool::get_default_option_values() — Method in class type_bool

Get default values for the options of this type

type_bool::get_default_field_value() — Method in class type_bool

Get default value for this type

type_bool::get_profile_field() — Method in class type_bool

Get profile field value on submit

type_bool::get_profile_value() — Method in class type_bool

Get Profile Value for display

type_bool::get_profile_value_raw() — Method in class type_bool

Get Profile Value ID for display (the raw, unprocessed user data)

type_bool::generate_field() — Method in class type_bool

Generate the input field for display

type_bool::get_field_ident() — Method in class type_bool

Get the ident of the field

type_bool::get_database_column_type() — Method in class type_bool

Get the column type for the database

type_bool::get_language_options() — Method in class type_bool

Get the options we need to display for the language input fields in the ACP

type_bool::get_language_options_input() — Method in class type_bool

Get the input for the supplied language options

type_bool::get_excluded_options() — Method in class type_bool

Allows manipulating the intended variables if needed

type_date::get_name_short() — Method in class type_date

Get the short name of the type, used for error messages and template loops

type_date::get_options() — Method in class type_date

Get dropdown options for second step in ACP

type_date::get_default_option_values() — Method in class type_date

Get default values for the options of this type

type_date::get_default_field_value() — Method in class type_date

Get default value for this type

type_date::get_profile_field() — Method in class type_date

Get profile field value on submit

type_date::get_profile_value() — Method in class type_date

Get Profile Value for display

type_date::get_profile_value_raw() — Method in class type_date

Get Profile Value ID for display (the raw, unprocessed user data)

type_date::generate_field() — Method in class type_date

Generate the input field for display

type_date::get_field_ident() — Method in class type_date

Get the ident of the field

type_date::get_database_column_type() — Method in class type_date

Get the column type for the database

type_date::get_language_options() — Method in class type_date

Get the options we need to display for the language input fields in the ACP

type_date::get_excluded_options() — Method in class type_date

Allows manipulating the intended variables if needed

type_dropdown::get_name_short() — Method in class type_dropdown

Get the short name of the type, used for error messages and template loops

type_dropdown::get_options() — Method in class type_dropdown

Get dropdown options for second step in ACP

type_dropdown::get_default_option_values() — Method in class type_dropdown

Get default values for the options of this type

type_dropdown::get_default_field_value() — Method in class type_dropdown

Get default value for this type

type_dropdown::get_profile_field() — Method in class type_dropdown

Get profile field value on submit

type_dropdown::get_profile_value() — Method in class type_dropdown

Get Profile Value for display

type_dropdown::get_profile_value_raw() — Method in class type_dropdown

Get Profile Value ID for display (the raw, unprocessed user data)

type_dropdown::generate_field() — Method in class type_dropdown

Generate the input field for display

type_dropdown::get_database_column_type() — Method in class type_dropdown

Get the column type for the database

type_dropdown::get_language_options() — Method in class type_dropdown

Get the options we need to display for the language input fields in the ACP

type_dropdown::get_excluded_options() — Method in class type_dropdown

Allows manipulating the intended variables if needed

type_int::get_name_short() — Method in class type_int

Get the short name of the type, used for error messages and template loops

type_int::get_options() — Method in class type_int

Get dropdown options for second step in ACP

type_int::get_default_option_values() — Method in class type_int

Get default values for the options of this type

type_int::get_default_field_value() — Method in class type_int

Get default value for this type

type_int::get_profile_field() — Method in class type_int

Get profile field value on submit

type_int::get_profile_value() — Method in class type_int

Get Profile Value for display

type_int::get_profile_value_raw() — Method in class type_int

Get Profile Value ID for display (the raw, unprocessed user data)

type_int::generate_field() — Method in class type_int

Generate the input field for display

type_int::get_field_ident() — Method in class type_int

Get the ident of the field

type_int::get_database_column_type() — Method in class type_int

Get the column type for the database

type_int::get_language_options() — Method in class type_int

Get the options we need to display for the language input fields in the ACP

type_int::get_excluded_options() — Method in class type_int

Allows manipulating the intended variables if needed

type_interface::get_name() — Method in class type_interface

Get the translated name of the type

type_interface::get_name_short() — Method in class type_interface

Get the short name of the type, used for error messages and template loops

type_interface::get_service_name() — Method in class type_interface

Get the name of service representing the type

type_interface::get_template_filename() — Method in class type_interface

Get the name of template file for this type

type_interface::get_options() — Method in class type_interface

Get dropdown options for second step in ACP

type_interface::get_default_option_values() — Method in class type_interface

Get default values for the options of this type

type_interface::get_default_field_value() — Method in class type_interface

Get default value for this type

type_interface::get_profile_field() — Method in class type_interface

Get profile field value on submit

type_interface::get_profile_value() — Method in class type_interface

Get Profile Value for display

type_interface::get_profile_value_raw() — Method in class type_interface

Get Profile Value ID for display (the raw, unprocessed user data)

type_interface::get_profile_contact_value() — Method in class type_interface

Get Profile Value for display

type_interface::generate_field() — Method in class type_interface

Generate the input field for display

type_interface::get_field_ident() — Method in class type_interface

Get the ident of the field

type_interface::get_field_name() — Method in class type_interface

Get the localized name of the field

type_interface::get_database_column_type() — Method in class type_interface

Get the column type for the database

type_interface::get_language_options() — Method in class type_interface

Get the options we need to display for the language input fields in the ACP

type_interface::get_language_options_input() — Method in class type_interface

Get the input for the supplied language options

type_interface::get_excluded_options() — Method in class type_interface

Allows manipulating the intended variables if needed

type_string::get_name_short() — Method in class type_string

Get the short name of the type, used for error messages and template loops

type_string::get_options() — Method in class type_string

Get dropdown options for second step in ACP

type_string::get_default_option_values() — Method in class type_string

Get default values for the options of this type

type_string::get_profile_field() — Method in class type_string

Get profile field value on submit

type_string::generate_field() — Method in class type_string

Generate the input field for display

type_string::get_database_column_type() — Method in class type_string

Get the column type for the database

type_string::get_language_options() — Method in class type_string

Get the options we need to display for the language input fields in the ACP

type_string_common::get_default_field_value() — Method in class type_string_common

Get default value for this type

type_string_common::get_profile_value() — Method in class type_string_common

Get Profile Value for display

type_string_common::get_profile_value_raw() — Method in class type_string_common

Get Profile Value ID for display (the raw, unprocessed user data)

type_string_common::get_profile_contact_value() — Method in class type_string_common

Get Profile Value for display

type_text::get_name_short() — Method in class type_text

Get the short name of the type, used for error messages and template loops

type_text::get_options() — Method in class type_text

Get dropdown options for second step in ACP

type_text::get_default_option_values() — Method in class type_text

Get default values for the options of this type

type_text::get_profile_field() — Method in class type_text

Get profile field value on submit

type_text::generate_field() — Method in class type_text

Generate the input field for display

type_text::get_database_column_type() — Method in class type_text

Get the column type for the database

type_text::get_language_options() — Method in class type_text

Get the options we need to display for the language input fields in the ACP

type_text::get_excluded_options() — Method in class type_text

Allows manipulating the intended variables if needed

type_url::get_name_short() — Method in class type_url

Get the short name of the type, used for error messages and template loops

type_url::get_options() — Method in class type_url

Get dropdown options for second step in ACP

type_url::get_default_option_values() — Method in class type_url

Get default values for the options of this type

type_url::get_profile_value() — Method in class type_url

Get Profile Value for display

handler_factory::get_instance() — Method in class handler_factory

Return a new instance of an appropriate report handler

deactivated_super_global::getIterator() — Method in class deactivated_super_global

Part of the Traversable/IteratorAggregate implementation, will always result in a FATAL error

request::get_super_global() — Method in class request

Returns the original array of the requested super global

request_interface::get_super_global() — Method in class request_interface

Returns the original array of the requested super global

$ router#generatorProperty in class router
router::get_routes() — Method in class router

Get the list of routes

router::getRouteCollection() — Method in class router
{@inheritdoc}
router::getContext() — Method in class router
{@inheritdoc}
router::generate() — Method in class router
{@inheritdoc}
router::get_matcher() — Method in class router

Gets the UrlMatcher instance associated with this Router.

router::get_generator() — Method in class router

Gets the UrlGenerator instance associated with this Router.

fulltext_mysql::get_name() — Method in class fulltext_mysql

Returns the name of this search backend to be displayed to administrators

fulltext_mysql::get_search_query() — Method in class fulltext_mysql

Returns the search_query

fulltext_mysql::get_common_words() — Method in class fulltext_mysql

Returns the common_words array

fulltext_mysql::get_word_length() — Method in class fulltext_mysql

Returns the word_length array

fulltext_mysql::get_stats() — Method in class fulltext_mysql

Computes the stats and store them in the $this->stats associative array

fulltext_native::get_name() — Method in class fulltext_native

Returns the name of this search backend to be displayed to administrators

fulltext_native::get_search_query() — Method in class fulltext_native

Returns the search_query

fulltext_native::get_common_words() — Method in class fulltext_native

Returns the common_words array

fulltext_native::get_word_length() — Method in class fulltext_native

Returns the word_length array

fulltext_native::get_stats() — Method in class fulltext_native
fulltext_postgres::get_name() — Method in class fulltext_postgres

Returns the name of this search backend to be displayed to administrators

fulltext_postgres::get_search_query() — Method in class fulltext_postgres

Returns the search_query

fulltext_postgres::get_common_words() — Method in class fulltext_postgres

Returns the common_words array

fulltext_postgres::get_word_length() — Method in class fulltext_postgres

Returns the word_length array

fulltext_postgres::get_stats() — Method in class fulltext_postgres

Computes the stats and store them in the $this->stats associative array

fulltext_sphinx::get_name() — Method in class fulltext_sphinx

Returns the name of this search backend to be displayed to administrators

fulltext_sphinx::get_search_query() — Method in class fulltext_sphinx

Returns the search_query

fulltext_sphinx::get_word_length() — Method in class fulltext_sphinx

Returns false as there is no word_len array

fulltext_sphinx::get_common_words() — Method in class fulltext_sphinx

Returns an empty array as there are no common_words

fulltext_sphinx::get_stats() — Method in class fulltext_sphinx

Collects stats that can be displayed on the index maintenance page

config::get_section_by_name() — Method in class config

Get a section object by its name

config::get_data() — Method in class config

Returns the config data

config_section::get_name() — Method in class config_section

Getter for the name of this section

config_section::get_variable_by_name() — Method in class config_section

Get a variable object by its name

config_variable::get_name() — Method in class config_variable

Getter for the variable's name

asset::get_url() — Method in class asset

Get URL

asset::get_path() — Method in class asset

Get path component of current URL

assets_bag::get_stylesheets() — Method in class assets_bag

Returns all css assets

assets_bag::get_scripts() — Method in class assets_bag

Returns all js assets

assets_bag::get_stylesheets_content() — Method in class assets_bag

Returns the HTML code to include all css assets

assets_bag::get_scripts_content() — Method in class assets_bag

Returns the HTML code to include all js assets

base::get_filename_from_handle() — Method in class base

Get a filename from the handle

context::get_data_ref() — Method in class context

Returns a reference to template data array.

context::get_root_ref() — Method in class context

Returns a reference to template root scope.

template::get_user_style() — Method in class template

Get the style tree of the style preferred by the current user

template::get_source_file_for_handle() — Method in class template

Get path to template for handle (required for BBCode parser)

environment::get_phpbb_extensions() — Method in class environment

Get the list of enabled phpBB extensions

environment::get_phpbb_config() — Method in class environment

Get phpBB config

environment::get_phpbb_root_path() — Method in class environment

Get the phpBB root path

environment::get_filesystem() — Method in class environment

Get the filesystem object

environment::get_web_root_path() — Method in class environment

Get the web root path

environment::get_path_helper() — Method in class environment

Get the phpbb path helper object

environment::get_assets_bag() — Method in class environment

Gets the assets bag

environment::getNamespaceLookUpOrder() — Method in class environment

Get the namespace look up order

extension::getName() — Method in class extension

Get the name of this extension

extension::getTokenParsers() — Method in class extension

Returns the token parser instance to add to the existing list.

extension::getFilters() — Method in class extension

Returns a list of filters to add to the existing list.

extension::getFunctions() — Method in class extension

Returns a list of global functions to add to the existing list.

extension::getOperators() — Method in class extension

Returns a list of operators to add to the existing list.

avatar::getName() — Method in class avatar

Get the name of this extension

avatar::getFunctions() — Method in class avatar

Returns a list of global functions to add to the existing list.

avatar::get_avatar() — Method in class avatar

Get avatar for placing into templates.

config::getName() — Method in class config

Get the name of this extension

config::getFunctions() — Method in class config

Returns a list of global functions to add to the existing list.

config::get_config() — Method in class config

Retrieves a configuration value for use in templates.

routing::getPath() — Method in class routing
routing::getUrl() — Method in class routing
username::getName() — Method in class username

Get the name of this extension

username::getFunctions() — Method in class username

Returns a list of global functions to add to the existing list.

username::get_username() — Method in class username

Get username details for placing into templates.

loader::getSafeDirectories() — Method in class loader

Get current safe directories

includeasset::get_setters_name() — Method in class includeasset

Get the name of the assets bag setter

includecss::get_setters_name() — Method in class includecss

Get the name of the assets bag setter

includejs::get_setters_name() — Method in class includejs

Get the name of the assets bag setter

defineparser::getTag() — Method in class defineparser

Gets the tag name associated with this token parser.

event::getTag() — Method in class event

Gets the tag name associated with this token parser.

includecss::getTag() — Method in class includecss

Gets the tag name associated with this token parser.

includejs::getTag() — Method in class includejs

Gets the tag name associated with this token parser.

includeparser::getTag() — Method in class includeparser

Gets the tag name associated with this token parser.

includephp::getTag() — Method in class includephp

Gets the tag name associated with this token parser.

php::getTag() — Method in class php

Gets the tag name associated with this token parser.

twig::get_user_style() — Method in class twig

Get the style tree of the style preferred by the current user

twig::get_template_vars() — Method in class twig

Get template vars in a format Twig will use (from the context)

twig::get_source_file_for_handle() — Method in class twig

Get path to template for handle (required for BBCode parser)

parser_interface::get_errors() — Method in class parser_interface

Get the list of errors that were generated during last parsing

renderer_interface::get_viewcensors() — Method in class renderer_interface

Return the value of the "viewcensors" option

renderer_interface::get_viewflash() — Method in class renderer_interface

Return the value of the "viewflash" option

renderer_interface::get_viewimg() — Method in class renderer_interface

Return the value of the "viewimg" option

renderer_interface::get_viewsmilies() — Method in class renderer_interface

Return the value of the "viewsmilies" option

factory::get_configurator() — Method in class factory

Generate and return a new configured instance of s9e\TextFormatter\Configurator

factory::get_default_bbcodes() — Method in class factory

Return the default BBCodes configuration

link_helper::generate_link_text_tag() — Method in class link_helper

Create a LINK_TEXT tag inside of a link

parser::get_errors() — Method in class parser

Get the list of errors that were generated during last parsing

parser::get_parser() — Method in class parser

Return the instance of s9e\TextFormatter\Parser used by this object

renderer::get_renderer() — Method in class renderer

Return the instance of s9e\TextFormatter\Renderer used by this object

renderer::get_viewcensors() — Method in class renderer

Return the value of the "viewcensors" option

renderer::get_viewflash() — Method in class renderer

Return the value of the "viewflash" option

renderer::get_viewimg() — Method in class renderer

Return the value of the "viewimg" option

renderer::get_viewsmilies() — Method in class renderer

Return the value of the "viewsmilies" option

utils::generate_quote() — Method in class utils

Create a quote block for given text

utils::get_outermost_quote_authors() — Method in class utils

Get a list of quote authors, limited to the outermost quotes

utils_interface::generate_quote() — Method in class utils_interface

Create a quote block for given text

utils_interface::get_outermost_quote_authors() — Method in class utils_interface

Get a list of quote authors, limited to the outermost quotes

base::get_max_id() — Method in class base

Return the highest ID for all existing records

base::get_records_by_range() — Method in class base

Return all records in given range

base::get_name() — Method in class base

Returns the name of the reparser

base::guess_bbcode() — Method in class base

Guess whether given BBCode is in use in given record

base::guess_bbcodes() — Method in class base

Guess whether any BBCode is in use in given record

base::guess_magic_url() — Method in class base

Guess whether magic URLs are in use in given record

base::guess_smilies() — Method in class base

Guess whether smilies are in use in given record

manager::get_resume_data() — Method in class manager

Loads resume data from the database

contact_admin_info::get_max_id() — Method in class contact_admin_info

Return the highest ID for all existing records

contact_admin_info::get_records_by_range() — Method in class contact_admin_info

Return all records in given range

forum_description::get_columns() — Method in class forum_description

Return the name of the column that correspond to each field

forum_rules::get_columns() — Method in class forum_rules

Return the name of the column that correspond to each field

group_descriptionClass in namespace phpbb\textreparser\plugins
group_description::get_columns() — Method in class group_description

Return the name of the column that correspond to each field

pm_text::get_columns() — Method in class pm_text

Return the name of the column that correspond to each field

poll_option::get_columns() — Method in class poll_option

Return the name of the column that correspond to each field

poll_option::get_records_by_range_query() — Method in class poll_option

Generate the query that retrieves all records for given range

poll_title::get_columns() — Method in class poll_title

Return the name of the column that correspond to each field

poll_title::get_records_by_range_query() — Method in class poll_title

Generate the query that retrieves all records for given range

post_text::get_columns() — Method in class post_text

Return the name of the column that correspond to each field

user_signature::get_columns() — Method in class user_signature

Return the name of the column that correspond to each field

reparser_interface::get_max_id() — Method in class reparser_interface

Return the highest ID for all existing records

reparser_interface::get_name() — Method in class reparser_interface

Returns the name of the reparser

row_based_plugin::get_columns() — Method in class row_based_plugin

Return the name of the column that correspond to each field

row_based_plugin::get_max_id() — Method in class row_based_plugin

Return the highest ID for all existing records

row_based_plugin::get_records_by_range() — Method in class row_based_plugin

Return all records in given range

row_based_plugin::get_records_by_range_query() — Method in class row_based_plugin

Generate the query that retrieves all records for given range

nestedset::get_sql_where() — Method in class nestedset

Returns additional sql where restrictions

nestedset::get_path_and_subtree_data() — Method in class nestedset

Get all items that are either ancestors or descendants of the item

nestedset::get_path_data() — Method in class nestedset

Get all of the item's ancestors

nestedset::get_subtree_data() — Method in class nestedset

Get all of the item's descendants

nestedset::get_set_of_nodes_data() — Method in class nestedset

Get items that are related to the given item by the condition

nestedset::get_path_basic_data() — Method in class nestedset

Get basic data of all parent items

nestedset::get_all_tree_data() — Method in class nestedset

Get all items from the tree

tree_interface::get_path_and_subtree_data() — Method in class tree_interface

Get all items that are either ancestors or descendants of the item

tree_interface::get_path_data() — Method in class tree_interface

Get all of the item's ancestors

tree_interface::get_subtree_data() — Method in class tree_interface

Get all of the item's descendants

user::get_plural_form() — Method in class user

Determine which plural form we should use.

user::get_timestamp_from_format() — Method in class user

Get the UNIX timestamp for a datetime in the users timezone, so we can store it in the database.

user::get_iso_lang_id() — Method in class user

Get language id currently used by the user

user::get_profile_fields() — Method in class user

Get users profile fields

user::get_passworded_forums() — Method in class user

Returns all password protected forum ids the user is currently NOT authenticated for.

user_loader::get_user() — Method in class user_loader

Get a user row from our users cache

user_loader::get_username() — Method in class user_loader

Get username

user_loader::get_avatar() — Method in class user_loader

Get avatar

user_loader::get_rank() — Method in class user_loader

Get rank

version_helper::get_latest_on_current_branch() — Method in class version_helper

Gets the latest version for the current branch the user is on

version_helper::get_update_on_branch() — Method in class version_helper

Gets the latest update for the current branch the user is on Will suggest versions from newer branches when EoL has been reached and/or version from newer branch is needed for having all known security issues fixed.

version_helper::get_ext_update_on_branch() — Method in class version_helper

Gets the latest extension update for the current phpBB branch the user is on Will suggest versions from newer branches when EoL has been reached and/or version from newer branch is needed for having all known security issues fixed.

version_helper::get_suggested_updates() — Method in class version_helper

Obtains the latest version information

version_helper::get_versions_matching_stability() — Method in class version_helper

Obtains the latest version information matching the stability of the current install

version_helper::get_versions() — Method in class version_helper

Obtains the latest version information

viewonline_helper::get_forum_ids() — Method in class viewonline_helper

Get forum IDs for topics

viewonline_helper::get_user_page() — Method in class viewonline_helper

Get user page

phpbb_questionnaire_data_collector::get_data_raw() — Method in class phpbb_questionnaire_data_collector

Get data as an array.

phpbb_questionnaire_data_collector::get_data_for_form() — Method in class phpbb_questionnaire_data_collector
phpbb_questionnaire_php_data_provider::get_identifier() — Method in class phpbb_questionnaire_php_data_provider
phpbb_questionnaire_php_data_provider::get_data() — Method in class phpbb_questionnaire_php_data_provider

Get data about the PHP runtime setup.

phpbb_questionnaire_phpbb_data_provider::get_identifier() — Method in class phpbb_questionnaire_phpbb_data_provider

Returns a string identifier for this data provider

phpbb_questionnaire_phpbb_data_provider::get_data() — Method in class phpbb_questionnaire_phpbb_data_provider

Get data about this phpBB installation.

phpbb_questionnaire_system_data_provider::get_identifier() — Method in class phpbb_questionnaire_system_data_provider
phpbb_questionnaire_system_data_provider::get_data() — Method in class phpbb_questionnaire_system_data_provider

Get data about the general system information, like OS or IP (shortened).

ucp_login_link::get_hidden_fields() — Method in class ucp_login_link

Builds the hidden fields string from the data array.

ucp_login_link::get_login_link_data_array() — Method in class ucp_login_link

Builds the login_link data array

ucp_register::get_login_link_data_array() — Method in class ucp_register

Creates the login_link data array

ucp_register::get_login_link_data_for_hidden_fields() — Method in class ucp_register

Prepends they key names of an associative array with 'loginlink' for inclusion on the page as hidden fields.

H

acp_attachments::handle_stats_resync() — Method in class acp_attachments

Handle stats resync.

messenger::headers() — Method in class messenger

set up extra mail headers

token_storage::hasAccessToken() — Method in class token_storage
{@inheritdoc}
token_storage::hasAuthorizationState() — Method in class token_storage
{@inheritdoc}
token_storage::has_access_token_by_session() — Method in class token_storage

Checks to see if an access token exists solely by the session_id of the user.

token_storage::has_state_by_session() — Method in class token_storage

Checks to see if a state exists solely by the session_id of the user.

token_storage::has_access_token() — Method in class token_storage

A helper function that performs the query for has access token functions.

manager::handle_avatar_delete() — Method in class manager

Handle deleting avatars

colour_manager::hsv2rgb() — Method in class colour_manager

Slightly altered from wikipedia's algorithm

colour_manager::h2ah() — Method in class colour_manager

hue to Alternate hue

$ gd#heightProperty in class gd
$ gd_wave#heightProperty in class gd_wave
$ non_gd#heightProperty in class non_gd
captcha_abstract::has_config() — Method in class captcha_abstract

API function

gd::has_config() — Method in class gd

API function

qa::has_config() — Method in class qa

API function

recaptcha::has_config() — Method in class recaptcha

API function

recaptcha_v3::has_config() — Method in class recaptcha_v3

Indicator that this CAPTCHA plugin requires configuration.

helperClass in namespace phpbb\controller

Controller helper class, contains methods that do things for controllers

cron::handle() — Method in class cron

Handles CRON requests

$ driver#html_holdProperty in class driver
helperClass in namespace phpbb\db\migration

The migrator is responsible for applying new migrations in the correct order.

$ migrator#helperProperty in class migrator
html_migrator_output_handlerClass in namespace phpbb\db\output_handler
error_handler::handleError() — Method in class error_handler
http_exceptionClass in namespace phpbb\exception

Class http_exception

$ base#helperProperty in class base

Feed helper object

helperClass in namespace phpbb\feed

Class with some helpful functions used in feeds

$ filespec#heightProperty in class filespec
upload::handle_upload() — Method in class upload

Handle upload based on type

helperClass in namespace phpbb\group
$ controller#helperProperty in class controller
controller::handle() — Method in class controller
helpClass in namespace phpbb\help\controller
$ help#helperProperty in class help
help::handle() — Method in class help

Controller for /help/{mode} routes

helperClass in namespace phpbb\install\controller

A duplicate of \phpbb\controller\helper

helper::handle_language_select() — Method in class helper

Handles language selector form

helper::handle_navigation() — Method in class helper

Process navigation data to reflect active/completed stages

install::handle() — Method in class install

Controller logic

$ installer_index#helperProperty in class installer_index
installer_index::handle() — Method in class installer_index
$ timeout_check#helperProperty in class timeout_check
update::handle() — Method in class update

Controller entry point

config::has_restart_point() — Method in class config

Returns whether a restart point with a given name exists or not

$ pagination#helperProperty in class pagination
$ base#helperProperty in class base
base_native::hash() — Method in class base_native

Hash the password

bcrypt::hash() — Method in class bcrypt

Hash the password

$ bcrypt_wcf2#helperProperty in class bcrypt_wcf2
bcrypt_wcf2::hash() — Method in class bcrypt_wcf2

Hash the password

convert_password::hash() — Method in class convert_password

Hash the password

driver_interface::hash() — Method in class driver_interface

Hash the password

helperClass in namespace phpbb\passwords\driver
helper::hash_encode64() — Method in class helper

Base64 encode hash

md5_mybb::hash() — Method in class md5_mybb

Hash the password

$ md5_phpbb2#helperProperty in class md5_phpbb2
md5_phpbb2::hash() — Method in class md5_phpbb2

Hash the password

md5_vb::hash() — Method in class md5_vb

Hash the password

salted_md5::hash() — Method in class salted_md5

Hash the password

sha1::hash() — Method in class sha1

Hash the password

sha1_smf::hash() — Method in class sha1_smf

Hash the password

sha1_wcf1::hash() — Method in class sha1_wcf1

Hash the password

sha_xf1::hash() — Method in class sha_xf1

Hash the password

helperClass in namespace phpbb\passwords
$ manager#helperProperty in class manager

Passwords helper

manager::hash() — Method in class manager

Hash supplied password

plupload::handle_upload() — Method in class plupload

Plupload allows for chunking so we must check for that and assemble the whole file first before performing any checks on it.

$ report#helperProperty in class report
report::handle() — Method in class report

Controller for /path_to_entities/{id}/report routes

handler_factoryClass in namespace phpbb\report
request::header() — Method in class request

Shortcut method to retrieve the value of client HTTP headers.

request_interface::header() — Method in class request_interface

Shortcut method to retrieve the value of client HTTP headers.

helperClass in namespace phpbb\routing

Controller helper class, contains methods that do things for controllers

$ session#hostProperty in class session
$ routing#helperProperty in class routing
$ reset_password#helperProperty in class reset_password
$ version_helper#hostProperty in class version_helper
$ phpbb_hook#hooksProperty in class phpbb_hook

Registered hooks

$ phpbb_hook#hook_resultProperty in class phpbb_hook

Results returned by functions called

phpbb_hook::hook_return() — Method in class phpbb_hook

Check if the called functions/methods returned something.

phpbb_hook::hook_return_result() — Method in class phpbb_hook

Give actual result from called functions/methods back.

smtp_class::hello() — Method in class smtp_class

SMTP EHLO/HELO

$ transfer#hostProperty in class transfer

I

SphinxClient::IsConnectError() — Method in class SphinxClient
$ acp_attachments#idProperty in class acp_attachments
acp_attachments_info::install() — Method in class acp_attachments_info
acp_ban_info::install() — Method in class acp_ban_info
acp_bbcodes_info::install() — Method in class acp_bbcodes_info
acp_board_info::install() — Method in class acp_board_info
acp_bots_info::install() — Method in class acp_bots_info
acp_captcha_info::install() — Method in class acp_captcha_info
acp_disallow_info::install() — Method in class acp_disallow_info
acp_email_info::install() — Method in class acp_email_info
acp_extensions_info::install() — Method in class acp_extensions_info
acp_forums_info::install() — Method in class acp_forums_info
acp_groups_info::install() — Method in class acp_groups_info
acp_help_phpbb_info::install() — Method in class acp_help_phpbb_info
acp_icons::item_count() — Method in class acp_icons

Returns the count of smilies or icons in the database

acp_icons_info::install() — Method in class acp_icons_info
acp_inactive_info::install() — Method in class acp_inactive_info
acp_jabber_info::install() — Method in class acp_jabber_info
acp_language_info::install() — Method in class acp_language_info
acp_logs_info::install() — Method in class acp_logs_info
acp_main_info::install() — Method in class acp_main_info
acp_modules_info::install() — Method in class acp_modules_info
acp_permission_roles_info::install() — Method in class acp_permission_roles_info
acp_permissions_info::install() — Method in class acp_permissions_info
acp_php_info_info::install() — Method in class acp_php_info_info
acp_profile_info::install() — Method in class acp_profile_info
acp_prune_info::install() — Method in class acp_prune_info
acp_ranks_info::install() — Method in class acp_ranks_info
acp_reasons_info::install() — Method in class acp_reasons_info
acp_search::index() — Method in class acp_search
acp_search::init_search() — Method in class acp_search

Initialises a search backend object

acp_search_info::install() — Method in class acp_search_info
acp_styles::install_style() — Method in class acp_styles

Install style

acp_styles_info::install() — Method in class acp_styles_info
acp_update_info::install() — Method in class acp_update_info
acp_users_info::install() — Method in class acp_users_info
acp_words_info::install() — Method in class acp_words_info
$ compress_tar#isgzProperty in class compress_tar
$ compress_tar#isbzProperty in class compress_tar
diff::is_empty() — Method in class diff

Checks for an empty diff.

diff3_block_builder::input() — Method in class diff3_block_builder
diff3_block_builder::is_empty() — Method in class diff3_block_builder
diff3_op::is_conflict() — Method in class diff3_op
diff3_op_copy::is_conflict() — Method in class diff3_op_copy
jabber::implode_data() — Method in class jabber

opposite of jabber::parse_data()

mcp_ban_info::install() — Method in class mcp_ban_info
mcp_logs_info::install() — Method in class mcp_logs_info
mcp_main_info::install() — Method in class mcp_main_info
mcp_notes_info::install() — Method in class mcp_notes_info
mcp_pm_reports_info::install() — Method in class mcp_pm_reports_info
mcp_queue_info::install() — Method in class mcp_queue_info
mcp_reports_info::install() — Method in class mcp_reports_info
mcp_warn_info::install() — Method in class mcp_warn_info
messenger::im() — Method in class messenger

Sets a im contact to send to

$ p_master#include_pathProperty in class p_master
p_master::is_active() — Method in class p_master

Check if a module is active

p_master::is_full_class() — Method in class p_master

Checks whether the given module basename is a correct class name

$ delete#idsProperty in class delete
upload::init_files_upload() — Method in class upload

Init files upload class

apache::init() — Method in class apache

Checks whether the user is currently identified to the authentication provider.

base::init() — Method in class base

Checks whether the user is currently identified to the authentication provider.

ldap::init() — Method in class ldap

Checks whether the user is currently identified to the authentication provider.

oauth::init() — Method in class oauth

Checks whether the user is currently identified to the authentication provider.

oauth::is_set_code() — Method in class oauth

Returns whether or not the authorization code is set.

provider_interface::init() — Method in class provider_interface

Checks whether the user is currently identified to the authentication provider.

$ driver#imagesizeProperty in class driver
manager::is_enabled() — Method in class manager

Check if avatar is enabled

$ base#is_modifiedProperty in class base
$ colour_manager#imgProperty in class colour_manager
captcha_abstract::init() — Method in class captcha_abstract
captcha_abstract::install() — Method in class captcha_abstract
captcha_abstract::is_solved() — Method in class captcha_abstract
gd::is_available() — Method in class gd
gd_wave::is_available() — Method in class gd_wave
nogd::is_available() — Method in class nogd
qa::init() — Method in class qa
qa::is_installed() — Method in class qa

See if the captcha has created its tables.

qa::is_available() — Method in class qa

API function - for the captcha to be available, it must have installed itself and there has to be at least one question in the board's default lang

qa::install() — Method in class qa

API function - set up shop

qa::is_solved() — Method in class qa

API function

recaptcha::init() — Method in class recaptcha
recaptcha::is_available() — Method in class recaptcha
recaptcha::install() — Method in class recaptcha
recaptcha_v3::init() — Method in class recaptcha_v3

Initialize this CAPTCHA plugin.

recaptcha_v3::is_available() — Method in class recaptcha_v3

Whether or not this CAPTCHA plugin is available and setup.

config::increment() — Method in class config

Increments an integer configuration value.

db::initialise() — Method in class db

Initialise config with database and/or cached entries

db::increment() — Method in class db

Increments an integer config value directly in the database.

$ application#in_shellProperty in class application
incrementClass in namespace phpbb\console\command\config
$ reparse#inputProperty in class reparse
$ reparse#ioProperty in class reparse
add::interact() — Method in class add

Interacts with the user.

delete::interact() — Method in class delete

Interacts with the user.

content_visibility::is_visible() — Method in class content_visibility

Check topic/post visibility for a given forum ID

$ convertor#installer_cacheProperty in class convertor
$ convertor#install_helperProperty in class convertor
$ convertor#iohandlerProperty in class convertor
convertor::intro() — Method in class convertor

Render the intro page

$ manager#is_initialised_from_containerProperty in class manager

Flag indicating if $this->tasks contains tasks registered in the container

base::is_runnable() — Method in class base

Returns whether this cron task can run, given current board configuration.

prune_all_forums::is_runnable() — Method in class prune_all_forums

Returns whether this cron task can run, given current board configuration.

prune_forum::is_runnable() — Method in class prune_forum

Returns whether this cron task can run, given current board configuration.

prune_notifications::is_runnable() — Method in class prune_notifications

Returns whether this cron task can run, given current board configuration.

prune_shadow_topics::is_runnable() — Method in class prune_shadow_topics

Returns whether this cron task can run, given current board configuration.

queue::is_runnable() — Method in class queue

Returns whether this cron task can run, given current board configuration.

tidy_cache::is_runnable() — Method in class tidy_cache

Returns whether this cron task can run, given current board configuration.

tidy_plupload::is_runnable() — Method in class tidy_plupload

Returns whether this cron task can run, given current board configuration.

tidy_search::is_runnable() — Method in class tidy_search

Returns whether this cron task can run, given current board configuration.

tidy_warnings::is_runnable() — Method in class tidy_warnings

Returns whether this cron task can run, given current board configuration.

update_hashes::is_runnable() — Method in class update_hashes

Returns whether this cron task can run, given current board configuration.

task::is_runnable() — Method in class task

Returns whether this cron task can run, given current board configuration.

reparser::is_runnable() — Method in class reparser

Returns whether this cron task can run, given current board configuration.

wrapper::is_parametrized() — Method in class wrapper

Returns whether the wrapped task is parametrised.

wrapper::is_ready() — Method in class wrapper

Returns whether the wrapped task is ready to run.

$ base_extractor#is_initializedProperty in class base_extractor
base_extractor::init_extractor() — Method in class base_extractor

Start the extraction of the database

invalid_format_exceptionClass in namespace phpbb\db\extractor\exception

This exception is thrown when invalid format is given to the extractor

extractor_interface::init_extractor() — Method in class extractor_interface

Start the extraction of the database

migrator::is_migration() — Method in class migrator

Check if a class is a migration.

installer_migrator_output_handlerClass in namespace phpbb\db\output_handler
$ installer_migrator_output_handler#iohandlerProperty in class installer_migrator_output_handler
sql_insert_buffer::insert() — Method in class sql_insert_buffer

Inserts a single row into the buffer if multi insert is supported by the database (otherwise an insert query is sent immediately). Then flushes the buffer if the number of rows in the buffer is now greater than or equal to $max_buffered_rows.

sql_insert_buffer::insert_all() — Method in class sql_insert_buffer

Inserts a row set, i.e. an array of rows, by calling insert().

$ mssql#is_sql_server_2000Property in class mssql

Is the used MS SQL Server a SQL Server 2000?

container_builder::inject_custom_parameters() — Method in class container_builder

Inject the customs parameters into the container

container_builder::inject_dbal_driver() — Method in class container_builder

Inject the dbal connection driver into container

$ ordered_service_collection#is_orderedProperty in class ordered_service_collection
proxy_instantiator::instantiateProxy() — Method in class proxy_instantiator
{@inheritdoc}
error_collector::install() — Method in class error_collector
base::is_enableable() — Method in class base

Indicate whether or not the extension can be enabled.

extension_interface::is_enableable() — Method in class extension_interface

Indicate whether or not the extension can be enabled.

manager::is_available() — Method in class manager

Check to see if a given extension is available on the filesystem

manager::is_enabled() — Method in class manager

Check to see if a given extension is enabled

manager::is_disabled() — Method in class manager

Check to see if a given extension is disabled

manager::is_configured() — Method in class manager

Check to see if a given extension is configured

manager::is_purged() — Method in class manager

Check to see if a given extension is purged

$ provider#itemsProperty in class provider

Array holding all found items

base::is_moderator_approve_forum() — Method in class base

Returns true if the current user can approve the post of the given forum

base::is_excluded_forum() — Method in class base

Returns true if the given id is in the excluded forums list.

quote_helper::inject_metadata() — Method in class quote_helper

Inject dynamic metadata into QUOTE tags in given XML

$ filespec#image_infoProperty in class filespec
$ filespec#imagesizeProperty in class filespec
filespec::init_error() — Method in class filespec

Check if class members were not properly initialised yet

filespec::is_image() — Method in class filespec

Check if file is an image (mime type)

filespec::is_uploaded() — Method in class filespec

Check if the file got correctly uploaded

upload::is_valid() — Method in class upload

Check if form upload is valid

upload::image_types() — Method in class upload

Get image type/extension mapping

filesystem::is_absolute_path() — Method in class filesystem

Checks if a path is absolute or not

filesystem::is_readable() — Method in class filesystem

Checks if files/directories are readable

filesystem::is_writable() — Method in class filesystem

Test if a file/directory is writable

filesystem_interface::is_absolute_path() — Method in class filesystem_interface

Checks if a path is absolute or not

filesystem_interface::is_readable() — Method in class filesystem_interface

Checks if files/directories are readable

filesystem_interface::is_writable() — Method in class filesystem_interface

Test if a file/directory is writable

$ show#iohandler_factoryProperty in class show
$ validate#iohandler_factoryProperty in class validate
installClass in namespace phpbb\install\console\command\install
$ install#iohandler_factoryProperty in class install
$ install#installerProperty in class install
$ install#install_helperProperty in class install
$ show#iohandler_factoryProperty in class show
$ validate#iohandler_factoryProperty in class validate
$ update#iohandler_factoryProperty in class update
$ update#installerProperty in class update
$ update#install_helperProperty in class update
$ archive_download#installer_configProperty in class archive_download
$ helper#installer_configProperty in class helper
installClass in namespace phpbb\install\controller

Controller for installing phpBB

$ install#iohandler_factoryProperty in class install
$ install#installerProperty in class install
$ install#install_helperProperty in class install
installer_indexClass in namespace phpbb\install\controller
$ update#installerProperty in class update
$ update#install_helperProperty in class update
$ update#iohandler_factoryProperty in class update
installer_config_not_writable_exceptionClass in namespace phpbb\install\exception

Thrown when installer config is not writable to disk

installer_exceptionClass in namespace phpbb\install\exception

Installer's base exception

invalid_dbms_exceptionClass in namespace phpbb\install\exception

Thrown when an unavailable DBMS has been selected

$ config#installer_configProperty in class config

Array which contains config settings for the installer

$ config#install_config_fileProperty in class config
config::increment_current_task_progress() — Method in class config

Increments the task progress

compression_file_updater::init() — Method in class compression_file_updater

Set the compression method

ftp_file_updater::init() — Method in class ftp_file_updater

Initialize FTP connection

install_helperClass in namespace phpbb\install\helper

General helper functionality for the installer

install_helper::is_phpbb_installed() — Method in class install_helper

Check whether phpBB is installed.

ajax_iohandler::is_secure() — Method in class ajax_iohandler

Returns true if the connection is encrypted

$ cli_iohandler#ioProperty in class cli_iohandler
$ cli_iohandler#input_valuesProperty in class cli_iohandler
cli_iohandler::is_secure() — Method in class cli_iohandler

Returns true if the connection is encrypted

iohandler_not_implemented_exceptionClass in namespace phpbb\install\helper\iohandler\exception
iohandler_baseClass in namespace phpbb\install\helper\iohandler

Base class for installer input-output handlers

iohandler_interfaceClass in namespace phpbb\install\helper\iohandler

Input-Output handler interface for the installer

iohandler_interface::is_secure() — Method in class iohandler_interface

Returns true if the connection is encrypted

install_navigationClass in namespace phpbb\install\helper\navigation
update_helper::include_file() — Method in class update_helper

Includes the updated file if available

installerClass in namespace phpbb\install
$ installer#install_configProperty in class installer
$ installer#installer_modulesProperty in class installer
$ installer#iohandlerProperty in class installer
installer_configurationClass in namespace phpbb\install
$ create_config_file#install_configProperty in class create_config_file
$ create_config_file#iohandlerProperty in class create_config_file
install_extensionsClass in namespace phpbb\install\module\install_finish\task

Installs extensions that exist in ext folder upon install

$ install_extensions#install_configProperty in class install_extensions
$ install_extensions#iohandlerProperty in class install_extensions
$ notify_user#install_configProperty in class notify_user
$ notify_user#iohandlerProperty in class notify_user
install_moduleClass in namespace phpbb\install\module\requirements
$ check_update#installer_configProperty in class check_update
$ check_update#iohandlerProperty in class check_update
$ diff_files#installer_configProperty in class diff_files
$ diff_files#iohandlerProperty in class diff_files
$ download_updated_files#installer_configProperty in class download_updated_files
$ download_updated_files#iohandlerProperty in class download_updated_files
$ file_check#installer_configProperty in class file_check
$ file_check#iohandlerProperty in class file_check
$ show_file_status#installer_configProperty in class show_file_status
$ show_file_status#iohandlerProperty in class show_file_status
$ update_files#installer_configProperty in class update_files
$ update_files#iohandlerProperty in class update_files
$ module_base#install_configProperty in class module_base
$ module_base#iohandlerProperty in class module_base
$ module_base#is_essentialProperty in class module_base
module_base::is_essential() — Method in class module_base

Checks if the execution of the module is essential to install phpBB or it can be skipped

module_interface::is_essential() — Method in class module_interface

Checks if the execution of the module is essential to install phpBB or it can be skipped

$ task_base#is_essentialProperty in class task_base
task_base::is_essential() — Method in class task_base

Checks if the task is essential to install phpBB or it can be skipped

task_interface::is_essential() — Method in class task_interface

Checks if the task is essential to install phpBB or it can be skipped

invalid_plural_rule_exceptionClass in namespace phpbb\language\exception

Thrown when nonexistent plural rule is specified

language::is_set() — Method in class language
dummy::is_enabled() — Method in class dummy

This function returns the state of the log system.

$ log#is_in_adminProperty in class log

If set, administrative user profile links will be returned and messages will not be censored.

log::is_enabled() — Method in class log

This function returns the state of the log system.

log_interface::is_enabled() — Method in class log_interface

This function returns the state of the log system.

content_guesser::is_supported() — Method in class content_guesser

Returns whether this guesser is supported on the current OS

extension_guesser::is_supported() — Method in class extension_guesser

Returns whether this guesser is supported on the current OS

guesser_interface::is_supported() — Method in class guesser_interface

Returns whether this guesser is supported on the current OS

base::is_enabled_by_default() — Method in class base

Is the method enable by default?

board::is_available() — Method in class board

Is this method available for the user? This is checked on the notifications options

board::is_enabled_by_default() — Method in class board

Is the method enable by default?

email::is_available() — Method in class email

Is this method available for the user? This is checked on the notifications options

jabber::is_available() — Method in class jabber

Is this method available for the user? This is checked on the notifications options

messenger_base::is_available() — Method in class messenger_base

Is this method available for the user? This is checked on the notifications options

method_interface::is_enabled_by_default() — Method in class method_interface

Is the method enable by default?

method_interface::is_available() — Method in class method_interface

Is this method available for the user? This is checked on the notifications options

admin_activate_user::is_available() — Method in class admin_activate_user

Is available (fall back)

$ approve_post#inherit_read_statusProperty in class approve_post

Inherit notification read status from post.

approve_post::is_available() — Method in class approve_post

Is available

$ approve_topic#inherit_read_statusProperty in class approve_topic

Inherit notification read status from topic.

approve_topic::is_available() — Method in class approve_topic

Is available

base::is_available() — Method in class base

Is available (fall back)

bookmark::is_available() — Method in class bookmark

Is available

$ disapprove_post#inherit_read_statusProperty in class disapprove_post

Inherit notification read status from post.

$ disapprove_topic#inherit_read_statusProperty in class disapprove_topic

Inherit notification read status from topic.

group_request::is_available() — Method in class group_request

Is available (fall back)

group_request_approved::is_available() — Method in class group_request_approved

Is available (fall back)

pm::is_available() — Method in class pm

Is available

$ post#inherit_read_statusProperty in class post

Inherit notification read status from post.

post::is_available() — Method in class post

Is available

post_in_queue::is_available() — Method in class post_in_queue

Is available

quote::is_available() — Method in class quote

Is available

report_pm::is_available() — Method in class report_pm

Is this type available to the current user (defines whether or not it will be shown in the UCP Edit notification options)

report_pm_closed::is_available() — Method in class report_pm_closed

Is available

$ report_post#inherit_read_statusProperty in class report_post

Inherit notification read status from post.

$ report_post_closed#inherit_read_statusProperty in class report_post_closed

Inherit notification read status from post.

report_post_closed::is_available() — Method in class report_post_closed

Is available

$ topic#inherit_read_statusProperty in class topic

Inherit notification read status from topic.

topic::is_available() — Method in class topic

Is available

topic_in_queue::is_available() — Method in class topic_in_queue

Is available

type_interface::is_available() — Method in class type_interface

Is this type available to the current user (defines whether or not it will be shown in the UCP Edit notification options)

base::is_supported() — Method in class base

Check if hash type is supported

base::is_legacy() — Method in class base

Check if hash type is a legacy hash type

base_native::is_supported() — Method in class base_native

Check if hash type is supported

bcrypt_2y::is_supported() — Method in class bcrypt_2y

Check if hash type is supported

bcrypt_wcf2::is_legacy() — Method in class bcrypt_wcf2

Check if hash type is a legacy hash type

driver_interface::is_supported() — Method in class driver_interface

Check if hash type is supported

driver_interface::is_legacy() — Method in class driver_interface

Check if hash type is a legacy hash type

$ helper#itoa64Property in class helper

base64 alphabet

md5_mybb::is_legacy() — Method in class md5_mybb

Check if hash type is a legacy hash type

md5_phpbb2::is_legacy() — Method in class md5_phpbb2

Check if hash type is a legacy hash type

md5_vb::is_legacy() — Method in class md5_vb

Check if hash type is a legacy hash type

salted_md5::is_legacy() — Method in class salted_md5

Check if hash type is a legacy hash type

sha1::is_legacy() — Method in class sha1

Check if hash type is a legacy hash type

sha1_smf::is_legacy() — Method in class sha1_smf

Check if hash type is a legacy hash type

sha1_wcf1::is_legacy() — Method in class sha1_wcf1

Check if hash type is a legacy hash type

sha_xf1::is_legacy() — Method in class sha_xf1

Check if hash type is a legacy hash type

manager::initialize() — Method in class manager

Initialize the internal state

path_helper::is_router_used() — Method in class path_helper

Tells if the router is currently in use (if the current page is a route or not)

iniClass in namespace phpbb\php

Wrapper class for ini_get function.

plupload::is_active() — Method in class plupload

Checks whether the page request was sent by plupload or not

plupload::is_multipart() — Method in class plupload

Returns whether the current HTTP request is a multipart request.

plupload::integrate_uploaded_file() — Method in class plupload

Checks whether the chunk we are about to deal with was actually uploaded by PHP and actually exists, if not, it generates an error

lang_helper::is_set() — Method in class lang_helper

Are language options set for this field?

invalid_report_exceptionClass in namespace phpbb\report\exception
$ request#inputProperty in class request
request::is_set_post() — Method in class request

Checks whether a certain variable was sent via POST.

request::is_set() — Method in class request

Checks whether a certain variable is set in one of the super global arrays.

request::is_ajax() — Method in class request

Checks whether the current request is an AJAX request (XMLHttpRequest)

request::is_secure() — Method in class request

Checks if the current request is happening over HTTPS.

request_interface::is_set_post() — Method in class request_interface

Checks whether a certain variable was sent via POST.

request_interface::is_set() — Method in class request_interface

Checks whether a certain variable is set in one of the super global arrays.

request_interface::is_ajax() — Method in class request_interface

Checks whether the current request is an AJAX request (XMLHttpRequest)

request_interface::is_secure() — Method in class request_interface

Checks if the current request is happening over HTTPS.

installer_resources_locatorClass in namespace phpbb\routing\resources_locator

Locates the yaml routing resources taking update directories into consideration

$ base#ignore_wordsProperty in class base
fulltext_mysql::init() — Method in class fulltext_mysql

Checks for correct MySQL version and stores min/max word length in the config

fulltext_mysql::index() — Method in class fulltext_mysql

Destroys cached search results, that contained one of the new words in a post so the results won't be outdated

fulltext_mysql::index_remove() — Method in class fulltext_mysql

Destroy cached results, that might be outdated after deleting a post

fulltext_mysql::index_created() — Method in class fulltext_mysql

Returns true if both FULLTEXT indexes exist

fulltext_mysql::index_stats() — Method in class fulltext_mysql

Returns an associative array containing information about the indexes

fulltext_native::index() — Method in class fulltext_native

Updates wordlist and wordmatch tables when a message is posted or changed

fulltext_native::index_remove() — Method in class fulltext_native

Removes entries from the wordmatch table for the specified post_ids

fulltext_native::index_created() — Method in class fulltext_native

Returns true if both FULLTEXT indexes exist

fulltext_native::index_stats() — Method in class fulltext_native

Returns an associative array containing information about the indexes

fulltext_postgres::init() — Method in class fulltext_postgres

Checks for correct PostgreSQL version and stores min/max word length in the config

fulltext_postgres::index() — Method in class fulltext_postgres

Destroys cached search results, that contained one of the new words in a post so the results won't be outdated

fulltext_postgres::index_remove() — Method in class fulltext_postgres

Destroy cached results, that might be outdated after deleting a post

fulltext_postgres::index_created() — Method in class fulltext_postgres

Returns true if both FULLTEXT indexes exist

fulltext_postgres::index_stats() — Method in class fulltext_postgres

Returns an associative array containing information about the indexes

$ fulltext_sphinx#idProperty in class fulltext_sphinx

Holds unique sphinx id

$ fulltext_sphinx#indexesProperty in class fulltext_sphinx

Stores the names of both main and delta sphinx indexes separated by a semicolon

fulltext_sphinx::init() — Method in class fulltext_sphinx

Checks permissions and paths, if everything is correct it generates the config file

fulltext_sphinx::index() — Method in class fulltext_sphinx

Updates wordlist and wordmatch tables when a message is posted or changed

fulltext_sphinx::index_remove() — Method in class fulltext_sphinx

Delete a post from the index after it was deleted

fulltext_sphinx::index_created() — Method in class fulltext_sphinx

Returns true if the sphinx table was created

fulltext_sphinx::index_stats() — Method in class fulltext_sphinx

Returns an associative array containing information about the indexes

$ session#ipProperty in class session
session::id() — Method in class session

Get user ID

asset::is_relative() — Method in class asset

Checks if URL is local and relative

includeassetClass in namespace phpbb\template\twig\node
includecssClass in namespace phpbb\template\twig\node
includejsClass in namespace phpbb\template\twig\node
includenodeClass in namespace phpbb\template\twig\node
includephpClass in namespace phpbb\template\twig\node
includecssClass in namespace phpbb\template\twig\tokenparser
includejsClass in namespace phpbb\template\twig\tokenparser
includeparserClass in namespace phpbb\template\twig\tokenparser
includephpClass in namespace phpbb\template\twig\tokenparser
cache_interface::invalidate() — Method in class cache_interface

Invalidate and/or regenerate this text formatter's cache(s)

bbcode_merger::indent_template() — Method in class bbcode_merger

Indent given template for readability

bbcode_merger::is_content_bbcode() — Method in class bbcode_merger

Test whether the two definitions form a "content"-style BBCode

bbcode_merger::is_optional_bbcode() — Method in class bbcode_merger

Test whether the two definitions form BBCode with an optional attribute

factory::invalidate() — Method in class factory

Invalidate and/or regenerate this text formatter's cache(s)

parser::is_a_bbcode() — Method in class parser

Test whether given tag consumes text that looks like BBCode-styled markup

quote_helper::inject_metadata() — Method in class quote_helper

Inject dynamic metadata into QUOTE tags in given XML

utils::is_empty() — Method in class utils

Return whether or not a parsed text represent an empty text.

utils_interface::is_empty() — Method in class utils_interface

Return whether or not a parsed text represent an empty text.

$ nestedset#item_basic_dataProperty in class nestedset

List of item properties to be cached in the item_parents column

nestedset::insert() — Method in class nestedset

Inserts an item into the database table and into the tree.

tree_interface::insert() — Method in class tree_interface

Inserts an item into the database table and into the tree.

reset_password::init_controller() — Method in class reset_password

Init controller

$ user#img_langProperty in class user
$ user#img_arrayProperty in class user
$ user#is_setup_flagProperty in class user
user::is_setup() — Method in class user

Returns whether user::setup was called

user::img() — Method in class user

Specify/Get image

version_helper::is_stable() — Method in class version_helper

Check whether or not a version is "stable"

$ phpbb_questionnaire_data_collector#install_idProperty in class phpbb_questionnaire_data_collector
phpbb_questionnaire_system_data_provider::is_private_ip() — Method in class phpbb_questionnaire_system_data_provider

Checks whether the given IP is in a private network.

queue::init() — Method in class queue

Init a queue object

ucp_attachments_info::install() — Method in class ucp_attachments_info
ucp_auth_link_info::install() — Method in class ucp_auth_link_info
ucp_groups_info::install() — Method in class ucp_groups_info
ucp_main_info::install() — Method in class ucp_main_info
ucp_notifications_info::install() — Method in class ucp_notifications_info
ucp_pm_info::install() — Method in class ucp_pm_info
ucp_prefs_info::install() — Method in class ucp_prefs_info
ucp_profile_info::install() — Method in class ucp_profile_info
ucp_zebra_info::install() — Method in class ucp_zebra_info

J

jabberClass in namespace [Global Namespace]

Jabber class from Flyspray project

token_storage::json_encode_token() — Method in class token_storage

A helper function that JSON encodes a TokenInterface's data.

token_storage::json_decode_token() — Method in class token_storage

A helper function that JSON decodes a data string and creates a TokenInterface.

convertor::jump() — Method in class convertor

This function marks the steps before syncing (jump=1)

jump_to_restart_point_exceptionClass in namespace phpbb\install\exception
config::jump_to_restart_point() — Method in class config

Set restart point to continue from

json_responseClass in namespace phpbb

JSON class

jabberClass in namespace phpbb\notification\method

Jabber notification method class This class handles sending Jabber messages for notifications

asset::join_url() — Method in class asset

Convert URL components into string

K

$ memory#key_prefixProperty in class memory
kernel_exception_subscriberClass in namespace phpbb\event
kernel_terminate_subscriberClass in namespace phpbb\event
$ base#keysProperty in class base

Keys specified for retrieval of title, content, etc.

kernel_exception_subscriberClass in namespace phpbb\install\event

Exception handler for the installer

fulltext_mysql::keyword_search() — Method in class fulltext_mysql

Performs a search on keywords depending on display specific params. You have to run split_keywords() first

fulltext_native::keyword_search() — Method in class fulltext_native

Performs a search on keywords depending on display specific params. You have to run split_keywords() first

fulltext_postgres::keyword_search() — Method in class fulltext_postgres

Performs a search on keywords depending on display specific params. You have to run split_keywords() first

fulltext_sphinx::keyword_search() — Method in class fulltext_sphinx

Performs a search on keywords depending on display specific params. You have to run split_keywords() first

$ user_signature#keyoptionsProperty in class user_signature
$ user#keyoptionsProperty in class user

L

$ acp_attachments#languageProperty in class acp_attachments
acp_extensions::list_enabled_exts() — Method in class acp_extensions

Lists all the enabled extensions and dumps to the template

acp_extensions::list_disabled_exts() — Method in class acp_extensions

Lists all the disabled extensions and dumps to the template

acp_extensions::list_available_exts() — Method in class acp_extensions

Lists all the available extensions and dumps to the template

$ acp_language#language_headerProperty in class acp_language
$ acp_language#lang_headerProperty in class acp_language
$ acp_language#language_fileProperty in class acp_language
$ acp_language#language_directoryProperty in class acp_language
acp_permissions::log_action() — Method in class acp_permissions

Log permission changes

$ acp_profile#lang_defsProperty in class acp_profile
acp_styles::list_style() — Method in class acp_styles

Show item in styles list

diff::lcs() — Method in class diff

Computes the length of the Longest Common Subsequence (LCS).

$ diff_renderer_side_by_side#linesProperty in class diff_renderer_side_by_side
$ jabber#log_arrayProperty in class jabber
jabber::login() — Method in class jabber

Initiates login (using data from contructor, after calling connect())

jabber::listen() — Method in class jabber

Listens to the connection until it gets data or the timeout is reached.

p_master::list_modules() — Method in class p_master

List modules

p_master::loaded() — Method in class p_master

Check if a certain main module is accessible/loaded By giving the module mode you are able to additionally check for only one mode within the main module

p_master::load_active() — Method in class p_master

Loads currently active module

p_master::load() — Method in class p_master

Load module as the current active one without the need for registering it

$ upload#languageProperty in class upload
auth::login() — Method in class auth

Authentication plug-ins is largely down to Sergey Kanareykin, our thanks to him.

$ apache#languageProperty in class apache
apache::login() — Method in class apache

Performs login.

base::logout() — Method in class base

Performs additional actions during logout.

base::login_link_has_necessary_data() — Method in class base

Checks to see if $login_link_data contains all information except for the user_id of an account needed to successfully link an external account to a forum account.

base::link_account() — Method in class base

Links an external account to a phpBB account.

db::login() — Method in class db

Performs login.

ldapClass in namespace phpbb\auth\provider

Database authentication provider for phpBB3 This is for authentication via the integrated user table

$ ldap#languageProperty in class ldap
ldap::login() — Method in class ldap

Performs login.

$ oauth#languageProperty in class oauth
oauth::login() — Method in class oauth

Performs login.

oauth::login_link_has_necessary_data() — Method in class oauth

Checks to see if $login_link_data contains all information except for the user_id of an account needed to successfully link an external account to a forum account.

oauth::link_account() — Method in class oauth

Links an external account to a phpBB account.

oauth::logout() — Method in class oauth

Performs additional actions during logout.

oauth::link_account_login_link() — Method in class oauth

Performs the account linking for login_link.

oauth::link_account_auth_link() — Method in class oauth

Performs the account linking for auth_link.

oauth::link_account_perform_link() — Method in class oauth

Performs the query that inserts an account link

provider_interface::login() — Method in class provider_interface

Performs login.

provider_interface::logout() — Method in class provider_interface

Performs additional actions during logout.

provider_interface::login_link_has_necessary_data() — Method in class provider_interface

Checks to see if $login_link_data contains all information except for the user_id of an account needed to successfully link an external account to a forum account.

provider_interface::link_account() — Method in class provider_interface

Links an external account to a phpBB account.

localClass in namespace phpbb\avatar\driver

Handles avatars selected from the board gallery

manager::load_enabled_drivers() — Method in class manager

Load the list of enabled drivers This is executed once and fills self::$enabled_drivers

manager::localize_errors() — Method in class manager

Replace "error" strings with their real, localized form

driver_interface::load() — Method in class driver_interface

Load global cache

dummy::load() — Method in class dummy

Load global cache

file::load() — Method in class file

Load global cache

memory::load() — Method in class memory

Load global cache

$ char_cube3d#letterProperty in class char_cube3d
captcha_abstract::load_code() — Method in class captcha_abstract

Look up everything we need for painting&checking.

qa::load_confirm_id() — Method in class qa

See if there is already an entry for the current session.

qa::load_answer() — Method in class qa

Look up everything we need and populate the instance variables.

class_loader::load_class() — Method in class class_loader

Resolves a class name to a path and then includes it.

config_php_file::load_config_file() — Method in class config_php_file

Load the config file and store the information.

$ application#languageProperty in class application
$ purge#logProperty in class purge
$ run#lock_dbProperty in class run
list_commandClass in namespace phpbb\console\command\db
$ migrate#logProperty in class migrate
$ migrate#languageProperty in class migrate
migration_command::load_migrations() — Method in class migration_command
$ command#logProperty in class command
list_allClass in namespace phpbb\console\command\reparser
$ activate#languageProperty in class activate
$ activate#logProperty in class activate
$ add#languageProperty in class add
$ delete#languageProperty in class delete
$ delete#logProperty in class delete
$ reclean#languageProperty in class reclean
$ exception_subscriber#languageProperty in class exception_subscriber
$ helper#languageProperty in class helper
$ convertor#languageProperty in class convertor
manager::load_tasks() — Method in class manager

Loads tasks given by name, wraps them and puts them into $this->tasks.

manager::load_tasks_from_container() — Method in class manager

Loads registered tasks from the container, wraps them and puts them into $this->tasks.

$ prune_shadow_topics#logProperty in class prune_shadow_topics
$ tidy_plupload#logProperty in class tidy_plupload
$ mssql_odbc#last_query_textProperty in class mssql_odbc
$ mssqlnative#last_query_textProperty in class mssqlnative
$ oracle#last_query_textProperty in class oracle
$ postgres#last_query_textProperty in class postgres
$ migrator#last_run_migrationProperty in class migrator

'name,' 'class,' and 'state' of the last migration run

migrator::load_migration_state() — Method in class migrator

Loads all migrations and their application state from the database.

log_wrapper_migrator_output_handlerClass in namespace phpbb\db\output_handler
$ log_wrapper_migrator_output_handler#languageProperty in class log_wrapper_migrator_output_handler

Language object.

container_builder::load_extensions() — Method in class container_builder

Load the enabled extensions.

config::load() — Method in class config

Loads a specific configuration.

core::load() — Method in class core

Loads a specific configuration.

tables::load() — Method in class tables
{@inheritDoc}
$ kernel_exception_subscriber#languageProperty in class kernel_exception_subscriber

Language object

extension_base::load() — Method in class extension_base

Loads a specific configuration.

extension_base::load_services() — Method in class extension_base

Loads the services.yml file.

manager::load_extensions() — Method in class manager

Loads all extension information from the database

$ feed#languageProperty in class feed
$ filespec#localProperty in class filespec
$ filespec#languageProperty in class filespec
$ base#languageProperty in class base
$ form#languageProperty in class form
localClass in namespace phpbb\files\types
$ local#languageProperty in class local
local::local_upload() — Method in class local

Move file from another location to phpBB

$ remote#languageProperty in class remote
$ upload#languageProperty in class upload
$ helper#languageProperty in class helper
legendClass in namespace phpbb\groupposition

Legend group position class

$ controller#languageProperty in class controller
$ manager#languageProperty in class manager
$ show#languageProperty in class show
$ validate#languageProperty in class validate
$ install#languageProperty in class install
$ show#languageProperty in class show
$ validate#languageProperty in class validate
$ update#languageProperty in class update
$ helper#languageProperty in class helper
$ helper#language_cookieProperty in class helper
$ helper#lang_helperProperty in class helper
$ install#languageProperty in class install
$ installer_index#languageProperty in class installer_index
$ update#languageProperty in class update
$ kernel_exception_subscriber#languageProperty in class kernel_exception_subscriber
config::load_config() — Method in class config

Recovers install configuration from file

$ container_factory#languageProperty in class container_factory
ajax_iohandler::lang_replace_callback() — Method in class ajax_iohandler

Callback function for language replacing

$ iohandler_base#logsProperty in class iohandler_base

Array of logs

$ iohandler_base#languageProperty in class iohandler_base
$ install_extensions#logProperty in class install_extensions
$ notify_user#languageProperty in class notify_user
$ notify_user#logProperty in class notify_user
language_exceptionClass in namespace phpbb\language\exception

Base exception class for language exceptions

language_file_not_foundClass in namespace phpbb\language\exception

This exception is thrown when the language file is not found

languageClass in namespace phpbb\language

Wrapper class for loading translations

$ language#language_fallbackProperty in class language
$ language#langProperty in class language
$ language#loaded_language_setsProperty in class language
$ language#loaderProperty in class language
language::lang() — Method in class language

Advanced language substitution

language::lang_raw() — Method in class language

Returns the raw value associated to a language key or the language key no translation is available.

language::lang_array() — Method in class language

Act like lang() but takes a key and an array of parameters instead of using variadic

language::load_common_language_files() — Method in class language

Loads common language files

language::load_core_file() — Method in class language

Load core language file

language::load_extension() — Method in class language

Load extension language file

language_file_helperClass in namespace phpbb\language

Helper class for language file related functions

language_file_loaderClass in namespace phpbb\language

Language file loader

language_file_loader::load() — Method in class language_file_loader

Loads language array for the given component

language_file_loader::load_extension() — Method in class language_file_loader

Loads language array for the given extension component

language_file_loader::load_file() — Method in class language_file_loader

Prepares language file loading

language_file_loader::load_language_file() — Method in class language_file_loader

Loads language file

logClass in namespace phpbb\log

This class is used to add entries into the log table.

$ log#last_page_offsetProperty in class log

Keeps the offset of the last valid page of the last call to get_logs()

$ log#log_tableProperty in class log

The table we use to store our logs.

log_interfaceClass in namespace phpbb\log

The interface for the log-system.

$ manager#languageProperty in class manager
manager::load_notifications() — Method in class manager

Load the user's notifications for a given method

manager::load_object() — Method in class manager

Helper to load objects (notification types/methods)

base::load_notifications() — Method in class base

Load the user's notifications

board::load_notifications() — Method in class board

Load the user's notifications

method_interface::load_notifications() — Method in class method_interface

Load the user's notifications

$ admin_activate_user#language_keyProperty in class admin_activate_user
{@inheritdoc}
$ approve_post#language_keyProperty in class approve_post

Language key used to output the text

$ approve_topic#language_keyProperty in class approve_topic

Language key used to output the text

$ base#languageProperty in class base
base::load_special() — Method in class base

Load the special items (fall back)

$ bookmark#language_keyProperty in class bookmark

Language key used to output the text

$ disapprove_post#language_keyProperty in class disapprove_post

Language key used to output the text

$ disapprove_topic#language_keyProperty in class disapprove_topic

Language key used to output the text

$ post#language_keyProperty in class post

Language key used to output the text

$ post_in_queue#language_keyProperty in class post_in_queue

Language key used to output the text

$ quote#language_keyProperty in class quote

Language key used to output the text

$ report_pm#language_keyProperty in class report_pm

Language key used to output the text

$ report_pm_closed#language_keyProperty in class report_pm_closed

Language key used to output the text

$ report_post#language_keyProperty in class report_post

Language key used to output the text

$ report_post_closed#language_keyProperty in class report_post_closed

Language key used to output the text

$ topic#language_keyProperty in class topic

Language key used to output the text

$ topic_in_queue#language_keyProperty in class topic_in_queue

Language key used to output the text

type_interface::load_special() — Method in class type_interface

Load the special items

lang_helperClass in namespace phpbb\profilefields

Custom Profile Fields

$ lang_helper#language_tableProperty in class lang_helper

Table where the language strings are stored

lang_helper::load_preview_options() — Method in class lang_helper

Loads preview options into language entries for options

lang_helper::load_option_lang() — Method in class lang_helper

Fetches language entries for options from DB

$ manager#languageProperty in class manager
$ manager#logProperty in class manager
$ type_bool#lang_helperProperty in class type_bool

Profile fields language helper

$ type_dropdown#lang_helperProperty in class type_dropdown

Profile fields language helper

loader_resolverClass in namespace phpbb\routing
$ loader_resolver#loadersProperty in class loader_resolver
$ chained_resources_locator#locatorsProperty in class chained_resources_locator
chained_resources_locator::locate_resources() — Method in class chained_resources_locator

Locates a list of resources used to load the routes

default_resources_locator::locate_resources() — Method in class default_resources_locator

Locates a list of resources used to load the routes

installer_resources_locator::locate_resources() — Method in class installer_resources_locator

Locates a list of resources used to load the routes

resources_locator_interface::locate_resources() — Method in class resources_locator_interface

Locates a list of resources used to load the routes

$ router#loaderProperty in class router
$ session#loadProperty in class session
environment::loadTemplate() — Method in class environment

Loads a template by name.

$ extension#languageProperty in class extension
extension::loop_subset() — Method in class extension

Grabs a subset of a loop

extension::lang() — Method in class extension

Get output for a language variable (L_FOO, LA_FOO)

extension::lang_defined() — Method in class extension

Check if a language variable exists

extension::lang_js() — Method in class extension

Get output for language variable in JS code

lexerClass in namespace phpbb\template\twig
loaderClass in namespace phpbb\template\twig

Twig Template loader

$ event#listener_directoryProperty in class event

The subdirectory in which all template listener files must be placed

$ factory#link_helperProperty in class factory
$ factory#logProperty in class factory
link_helperClass in namespace phpbb\textformatter\s9e
$ nestedset#lockProperty in class nestedset
$ reset_password#languageProperty in class reset_password
$ reset_password#logProperty in class reset_password
$ user#languageProperty in class user
$ user#lang_nameProperty in class user
$ user#lang_idProperty in class user
$ user#lang_pathProperty in class user
user::lang() — Method in class user

More advanced language substitution Function to mimic sprintf() with the possibility of using phpBB's language system to substitute nullar/singular/plural forms.

user::leave_newly_registered() — Method in class user

Function to make the user leave the NEWLY_REGISTERED system group.

user_loader::load_users() — Method in class user_loader

Load user helper

user_loader::load_user_by_username() — Method in class user_loader

Load a user by username

smtp_class::log_into_server() — Method in class smtp_class

Log into server and get possible auth codes if neccessary

smtp_class::login() — Method in class smtp_class

Login authentication method

M

acp_attachments::main() — Method in class acp_attachments
acp_attachments::max_filesize() — Method in class acp_attachments

Adjust all three max_filesize config vars for display

acp_attachments_info::module() — Method in class acp_attachments_info
acp_ban::main() — Method in class acp_ban
acp_ban_info::module() — Method in class acp_ban_info
acp_bbcodes::main() — Method in class acp_bbcodes
acp_bbcodes_info::module() — Method in class acp_bbcodes_info
acp_board::main() — Method in class acp_board
acp_board::mail_auth_select() — Method in class acp_board

Select mail authentication method

acp_board_info::module() — Method in class acp_board_info
acp_bots::main() — Method in class acp_bots
acp_bots_info::module() — Method in class acp_bots_info
acp_captcha::main() — Method in class acp_captcha
acp_captcha_info::module() — Method in class acp_captcha_info
acp_contact::main() — Method in class acp_contact
acp_contact_info::module() — Method in class acp_contact_info
acp_disallow::main() — Method in class acp_disallow
acp_disallow_info::module() — Method in class acp_disallow_info
acp_email::main() — Method in class acp_email
acp_email_info::module() — Method in class acp_email_info
acp_extensions::main() — Method in class acp_extensions
acp_extensions_info::module() — Method in class acp_extensions_info
acp_forums::main() — Method in class acp_forums
acp_forums::move_forum() — Method in class acp_forums

Move forum

acp_forums::move_forum_content() — Method in class acp_forums

Move forum content from one to another forum

acp_forums::move_forum_by() — Method in class acp_forums

Move forum position by $steps up/down

acp_forums_info::module() — Method in class acp_forums_info
acp_groups::main() — Method in class acp_groups
acp_groups::manage_position() — Method in class acp_groups
acp_groups_info::module() — Method in class acp_groups_info
acp_help_phpbb::main() — Method in class acp_help_phpbb
acp_help_phpbb_info::module() — Method in class acp_help_phpbb_info
acp_icons::main() — Method in class acp_icons
acp_icons_info::module() — Method in class acp_icons_info
acp_inactive::main() — Method in class acp_inactive
acp_inactive_info::module() — Method in class acp_inactive_info
acp_jabber::main() — Method in class acp_jabber
acp_jabber_info::module() — Method in class acp_jabber_info
$ acp_language#main_filesProperty in class acp_language
acp_language::main() — Method in class acp_language
acp_language_info::module() — Method in class acp_language_info
acp_logs::main() — Method in class acp_logs
acp_logs_info::module() — Method in class acp_logs_info
acp_main::main() — Method in class acp_main
acp_main_info::module() — Method in class acp_main_info
$ acp_modules#module_classProperty in class acp_modules
acp_modules::main() — Method in class acp_modules
acp_modules::make_module_select() — Method in class acp_modules

Simple version of jumpbox, just lists modules

acp_modules_info::module() — Method in class acp_modules_info
acp_permission_roles::main() — Method in class acp_permission_roles
acp_permission_roles_info::module() — Method in class acp_permission_roles_info
acp_permissions::main() — Method in class acp_permissions
acp_permissions_info::module() — Method in class acp_permissions_info
acp_php_info::main() — Method in class acp_php_info
acp_php_info_info::module() — Method in class acp_php_info_info
acp_profile::main() — Method in class acp_profile
acp_profile_info::module() — Method in class acp_profile_info
acp_prune::main() — Method in class acp_prune
acp_prune_info::module() — Method in class acp_prune_info
acp_ranks::main() — Method in class acp_ranks
acp_ranks_info::module() — Method in class acp_ranks_info
acp_reasons::main() — Method in class acp_reasons
acp_reasons_info::module() — Method in class acp_reasons_info
$ acp_search#max_post_idProperty in class acp_search
acp_search::main() — Method in class acp_search
acp_search_info::module() — Method in class acp_search_info
$ acp_styles#modeProperty in class acp_styles
acp_styles::main() — Method in class acp_styles
acp_styles_info::module() — Method in class acp_styles_info
acp_update::main() — Method in class acp_update
acp_update_info::module() — Method in class acp_update_info
acp_users::main() — Method in class acp_users
acp_users_info::module() — Method in class acp_users_info
acp_words::main() — Method in class acp_words
acp_words_info::module() — Method in class acp_words_info
$ bbcode_firstpass#messageProperty in class bbcode_firstpass
$ bbcode_firstpass#modeProperty in class bbcode_firstpass
bitfield::merge() — Method in class bitfield
compress::methods() — Method in class compress

Return available methods

$ compress_tar#modeProperty in class compress_tar
diff3::merged_output() — Method in class diff3

Return merged output (used by the renderer)

diff3::merged_new_output() — Method in class diff3

Merge the output and use the new file code for conflicts

diff3::merged_orig_output() — Method in class diff3

Merge the output and use the original file code for conflicts

diff3_op::merged() — Method in class diff3_op
diff3_op_copy::merged() — Method in class diff3_op_copy
mapped_diffClass in namespace [Global Namespace]
mcp_banClass in namespace [Global Namespace]
mcp_ban::main() — Method in class mcp_ban
mcp_ban_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

mcp_ban_info::module() — Method in class mcp_ban_info
mcp_logsClass in namespace [Global Namespace]

mcp_logs Handling warning the users

mcp_logs::main() — Method in class mcp_logs
mcp_logs_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

mcp_logs_info::module() — Method in class mcp_logs_info
mcp_mainClass in namespace [Global Namespace]

mcp_main Handling mcp actions

mcp_main::main() — Method in class mcp_main
mcp_main_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

mcp_main_info::module() — Method in class mcp_main_info
mcp_notesClass in namespace [Global Namespace]

mcp_notes Displays notes about a user

mcp_notes::main() — Method in class mcp_notes
mcp_notes::mcp_notes_user_view() — Method in class mcp_notes

Display user notes

mcp_notes_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

mcp_notes_info::module() — Method in class mcp_notes_info
mcp_pm_reportsClass in namespace [Global Namespace]

mcp_reports Handling the reports queue

mcp_pm_reports::main() — Method in class mcp_pm_reports
mcp_pm_reports_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

mcp_pm_reports_info::module() — Method in class mcp_pm_reports_info
mcp_queueClass in namespace [Global Namespace]

mcp_queue Handling the moderation queue

mcp_queue::main() — Method in class mcp_queue
mcp_queue_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

mcp_queue_info::module() — Method in class mcp_queue_info
mcp_reportsClass in namespace [Global Namespace]

mcp_reports Handling the reports queue

mcp_reports::main() — Method in class mcp_reports
mcp_reports_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

mcp_reports_info::module() — Method in class mcp_reports_info
mcp_warnClass in namespace [Global Namespace]

mcp_warn Handling warning the users

mcp_warn::main() — Method in class mcp_warn
mcp_warn::mcp_warn_front_view() — Method in class mcp_warn

Generates the summary on the main page of the warning module

mcp_warn::mcp_warn_list_view() — Method in class mcp_warn

Lists all users with warnings

mcp_warn::mcp_warn_post_view() — Method in class mcp_warn

Handles warning the user when the warning is for a specific post

mcp_warn::mcp_warn_user_view() — Method in class mcp_warn

Handles warning the user

mcp_warn_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

mcp_warn_info::module() — Method in class mcp_warn_info
messengerClass in namespace [Global Namespace]
Messenger
$ messenger#msgProperty in class messenger
$ messenger#mail_priorityProperty in class messenger
messenger::msg_email() — Method in class messenger

Send out emails

messenger::msg_jabber() — Method in class messenger

Send jabber message out

$ p_master#module_aryProperty in class p_master
p_master::module_auth_self() — Method in class p_master

Check module authorisation.

p_master::module_auth() — Method in class p_master

Check module authorisation.

$ parse_message#message_statusProperty in class parse_message
parse_message::magic_url() — Method in class parse_message

Replace magic urls of form http://xxx.xxx., www.xxx. and xxx@xxx.xxx.

managerClass in namespace phpbb\attachment

Attachment manager

$ upload#mimetype_guesserProperty in class upload
managerClass in namespace phpbb\avatar
memcachedClass in namespace phpbb\cache\driver

ACM for Memcached

$ memcached#memcachedProperty in class memcached
memoryClass in namespace phpbb\cache\driver

ACM Abstract Memory Class

$ colour_manager#modeProperty in class colour_manager
colour_manager::mono_range() — Method in class colour_manager
colour_manager::model_convert() — Method in class colour_manager

Convert from one colour model to another

migrateClass in namespace phpbb\console\command\db
migration_commandClass in namespace phpbb\console\command\db
$ migration_command#migratorProperty in class migration_command
migration_tipsClass in namespace phpbb\console\command\dev
$ command#managerProperty in class command
helper::message() — Method in class helper

Output a message

$ convert#mysql_convertProperty in class convert
convertor::meta_refresh() — Method in class convertor

Own meta refresh function to be able to change the global time used

managerClass in namespace phpbb\cron

Cron manager class.

$ tidy_plupload#max_file_ageProperty in class tidy_plupload

How old a file must be (in seconds) before it is deleted.

$ driver#multi_insertProperty in class driver
mssql_baseClass in namespace phpbb\db\driver

MSSQL Database Base Abstraction Layer

mssql_odbcClass in namespace phpbb\db\driver

Unified ODBC functions Unified ODBC functions support any database having ODBC driver, for example Adabas D, IBM DB2, iODBC, Solid, Sybase SQL Anywhere... Here we only support MSSQL Server 2000+ because of the provided schema

mssqlnativeClass in namespace phpbb\db\driver
$ mssqlnative#m_insert_idProperty in class mssqlnative
mssqlnative::mssqlnative_num_rows() — Method in class mssqlnative

Utility method used to retrieve number of rows Emulates mysql_num_rows Used in acp_database.php -> write_data_mssqlnative() Requires a static or keyset cursor to be definde via mssqlnative_set_query_options()

mssqlnative::mssqlnative_set_query_options() — Method in class mssqlnative

Allows setting mssqlnative specific query options passed to sqlsrv_query as 4th parameter.

mysql_baseClass in namespace phpbb\db\driver

Abstract MySQL Database Base Abstraction Layer

mysqliClass in namespace phpbb\db\driver

MySQLi Database Abstraction Layer mysqli-extension has to be compiled with: MySQL 4.1+ or MySQL 5.0+

$ mysqli#multi_insertProperty in class mysqli
$ postgres#multi_insertProperty in class postgres
mssql_extractorClass in namespace phpbb\db\extractor
mysql_extractorClass in namespace phpbb\db\extractor
migrationClass in namespace phpbb\db\migration

Abstract base class for database migrations

migration_interfaceClass in namespace phpbb\db\migration

Base class interface for database migrations

moduleClass in namespace phpbb\db\migration\tool

Migration module management tool

$ module#module_managerProperty in class module
$ module#modules_tableProperty in class module
$ module#module_categoriesProperty in class module
migratorClass in namespace phpbb\db

The migrator is responsible for applying new migrations in the correct order.

$ migrator#migrations_tableProperty in class migrator
$ migrator#migration_stateProperty in class migrator

State of all migrations

$ migrator#migrationsProperty in class migrator

Array of all migrations available to be run

migrator::migration_state() — Method in class migrator

Gets a migration state (whether it is installed and to what extent)

$ log_wrapper_migrator_output_handler#migratorProperty in class log_wrapper_migrator_output_handler

A migrator output handler

migrator_output_handler_interfaceClass in namespace phpbb\db\output_handler
$ sql_insert_buffer#max_buffered_rowsProperty in class sql_insert_buffer
mssqlClass in namespace phpbb\db\tools

Database Tools for handling cross-db actions such as altering columns, etc.

mssql::mssql_get_drop_default_constraints_queries() — Method in class mssql

Get queries to drop the default constraints of a column

mssql::mssql_get_drop_default_primary_key_queries() — Method in class mssql

Get queries to drop the primary keys depending on the specified column

mssql::mssql_is_column_identity() — Method in class mssql

Checks to see if column is an identity column

mssql::mssql_is_sql_server_2000() — Method in class mssql

Is the used MS SQL Server a SQL Server 2000?

md_exporterClass in namespace phpbb\event

Crawls through a markdown file and grabs all events

$ md_exporter#min_versionProperty in class md_exporter
$ md_exporter#max_versionProperty in class md_exporter
$ php_exporter#min_versionProperty in class php_exporter
$ php_exporter#max_versionProperty in class php_exporter
$ base#migratorProperty in class base
managerClass in namespace phpbb\extension

The extension manager provides means to activate/deactivate extensions.

$ filespec#mimetypeProperty in class filespec
$ filespec#mimetype_guesserProperty in class filespec
filespec::move_file() — Method in class filespec

Move file to destination folder The phpbb_root_path variable will be applied to the destination path

$ upload#max_filesizeProperty in class upload
$ upload#min_widthProperty in class upload
$ upload#min_heightProperty in class upload
$ upload#max_widthProperty in class upload
$ upload#max_heightProperty in class upload
filesystem::make_path_relative() — Method in class filesystem

Given an existing path, convert it to a path relative to a given starting path

filesystem::mirror() — Method in class filesystem

Mirrors a directory to another.

filesystem::mkdir() — Method in class filesystem

Creates a directory recursively.

filesystem_interface::make_path_relative() — Method in class filesystem_interface

Given an existing path, convert it to a path relative to a given starting path

filesystem_interface::mirror() — Method in class filesystem_interface

Mirrors a directory to another.

filesystem_interface::mkdir() — Method in class filesystem_interface

Creates a directory recursively.

groupposition_interface::move_up() — Method in class groupposition_interface

Moves a group up by group_id

groupposition_interface::move_down() — Method in class groupposition_interface

Moves a group down by group_id

groupposition_interface::move() — Method in class groupposition_interface

Moves a group up/down

legend::move_up() — Method in class legend

Moves a group up by group_id

legend::move_down() — Method in class legend

Moves a group down by group_id

legend::move() — Method in class legend

Moves a group up/down

teampage::move_up() — Method in class teampage

Moves a group up by group_id

teampage::move_up_teampage() — Method in class teampage

Moves an item up by teampage_id

teampage::move_down() — Method in class teampage

Moves a group down by group_id

teampage::move_down_teampage() — Method in class teampage

Moves an item down by teampage_id

teampage::move() — Method in class teampage

Moves a group up/down

teampage::move_teampage() — Method in class teampage

Moves an item up/down

$ controller#managerProperty in class controller
managerClass in namespace phpbb\help

Class help page manager

$ install#menu_providerProperty in class install
$ update#menu_providerProperty in class update
main_navigationClass in namespace phpbb\install\helper\navigation
$ installer#module_step_countProperty in class installer

Stores the number of steps that a given module has

moduleClass in namespace phpbb\install\module\install_filesystem

Installer module for filesystem installation

moduleClass in namespace phpbb\install\module\install_finish

Installer module for filesystem installation

$ populate_migrations#migratorProperty in class populate_migrations
moduleClass in namespace phpbb\install\module\update_filesystem
module_baseClass in namespace phpbb\install

Base class for installer module

module_interfaceClass in namespace phpbb\install

Interface for installer modules

$ form#messageProperty in class form
messageClass in namespace phpbb\message

Class message Holds all information for an email and sends it in the end

extension_guesser::map_extension_to_type() — Method in class extension_guesser

Map extension of supplied file_name to mime type

module_exceptionClass in namespace phpbb\module\exception
module_not_found_exceptionClass in namespace phpbb\module\exception
module_managerClass in namespace phpbb\module
$ module_manager#modules_tableProperty in class module_manager
module_manager::move_module() — Method in class module_manager

Move module around the tree

module_manager::move_module_by() — Method in class module_manager

Move module position by $steps up/down

managerClass in namespace phpbb\notification

Notifications service class

manager::mark_notifications_read() — Method in class manager

Mark notifications read or unread for all available methods

manager::mark_notifications() — Method in class manager

Mark notifications read or unread for all available methods

manager::mark_notifications_read_by_parent() — Method in class manager

Mark notifications read or unread from a parent identifier for all available methods

manager::mark_notifications_by_parent() — Method in class manager

Mark notifications read or unread from a parent identifier for all available methods

manager::mark_notifications_by_id() — Method in class manager

Mark notifications read or unread for a given method

base::mark_notifications() — Method in class base
{@inheritdoc
base::mark_notifications_by_parent() — Method in class base

Mark notifications read or unread from a parent identifier

base::mark_notifications_by_id() — Method in class base

Mark notifications read or unread

board::mark_notifications() — Method in class board
{@inheritdoc
board::mark_notifications_by_parent() — Method in class board

Mark notifications read or unread from a parent identifier

board::mark_notifications_by_id() — Method in class board

Mark notifications read or unread

email::mark_notifications() — Method in class email
{@inheritdoc
email::mark_notifications_by_parent() — Method in class email

Mark notifications read or unread from a parent identifier

messenger_baseClass in namespace phpbb\notification\method

Abstract notification method handling email and jabber notifications using the phpBB messenger.

method_interfaceClass in namespace phpbb\notification\method

Base notifications method interface

method_interface::mark_notifications() — Method in class method_interface

Mark notifications read or unread

method_interface::mark_notifications_by_parent() — Method in class method_interface

Mark notifications read or unread from a parent identifier

method_interface::mark_notifications_by_id() — Method in class method_interface

Mark notifications read or unread

base::mark_read() — Method in class base

Mark this item read

base::mark_unread() — Method in class base

Mark this item unread

base::mark() — Method in class base

Mark this item read/unread helper

type_interface::mark_read() — Method in class type_interface

Mark this item read

type_interface::mark_unread() — Method in class type_interface

Mark this item unread

$ argon2i#memory_costProperty in class argon2i
md5_mybbClass in namespace phpbb\passwords\driver
md5_phpbb2Class in namespace phpbb\passwords\driver
md5_vbClass in namespace phpbb\passwords\driver
managerClass in namespace phpbb\passwords
$ plupload#mimetype_guesserProperty in class plupload
managerClass in namespace phpbb\profilefields

Custom Profile Fields (CPF) manager.

$ router#matcherProperty in class router
router::match() — Method in class router
{@inheritdoc}
$ base#match_synonymProperty in class base
$ fulltext_native#must_contain_idsProperty in class fulltext_native

Post ids of posts containing words that are to be included

$ fulltext_native#must_not_contain_idsProperty in class fulltext_native

Post ids of posts containing words that should not be included

$ fulltext_native#must_exclude_one_idsProperty in class fulltext_native

Post ids of posts containing at least one word that needs to be excluded

bbcode_merger::merge_bbcodes() — Method in class bbcode_merger

Merge two BBCode definitions

bbcode_merger::merge_content_bbcode() — Method in class bbcode_merger

Merge the two BBCode definitions of a "content"-style BBCode

bbcode_merger::merge_optional_bbcode() — Method in class bbcode_merger

Merge the two BBCode definitions of a BBCode with an optional argument

factory::merge_templates() — Method in class factory

Merge the templates from any number of styles into one BBCode template

$ quote_helper#msg_urlProperty in class quote_helper
managerClass in namespace phpbb\textreparser
$ nestedset#message_prefixProperty in class nestedset

Prefix for the language keys returned by exceptions

nestedset::move() — Method in class nestedset

Move an item by a given delta

nestedset::move_down() — Method in class nestedset

Move an item down by 1

nestedset::move_up() — Method in class nestedset

Move an item up by 1

nestedset::move_children() — Method in class nestedset

Moves all children of one item to another item

tree_interface::move() — Method in class tree_interface

Move an item by a given delta

tree_interface::move_down() — Method in class tree_interface

Move an item down by 1

tree_interface::move_up() — Method in class tree_interface

Move an item up by 1

tree_interface::move_children() — Method in class tree_interface

Moves all children of one item to another item

transfer::make_dir() — Method in class transfer

Create directory structure

transfer::methods() — Method in class transfer

Determine methods able to be used

ucp_activate::main() — Method in class ucp_activate
ucp_attachments::main() — Method in class ucp_attachments
ucp_attachments_info::module() — Method in class ucp_attachments_info
ucp_auth_link::main() — Method in class ucp_auth_link

Generates the ucp_auth_link page and handles the auth link process

ucp_auth_link_info::module() — Method in class ucp_auth_link_info
ucp_confirm::main() — Method in class ucp_confirm
ucp_groups::main() — Method in class ucp_groups
ucp_groups_info::module() — Method in class ucp_groups_info
ucp_login_link::main() — Method in class ucp_login_link

Generates the ucp_login_link page and handles login link process

ucp_main::main() — Method in class ucp_main
ucp_main_info::module() — Method in class ucp_main_info
ucp_notifications::main() — Method in class ucp_notifications
ucp_notifications_info::module() — Method in class ucp_notifications_info
ucp_pm::main() — Method in class ucp_pm
ucp_pm_info::module() — Method in class ucp_pm_info
ucp_prefs::main() — Method in class ucp_prefs
ucp_prefs_info::module() — Method in class ucp_prefs_info
ucp_profile::main() — Method in class ucp_profile
ucp_profile_info::module() — Method in class ucp_profile_info
ucp_register::main() — Method in class ucp_register
ucp_resend::main() — Method in class ucp_resend
ucp_zebra::main() — Method in class ucp_zebra
ucp_zebra_info::module() — Method in class ucp_zebra_info

N

$ acp_attachments#new_configProperty in class acp_attachments
$ acp_board#new_configProperty in class acp_board
diff_op::norig() — Method in class diff_op
diff_op::nfinal() — Method in class diff_op
$ driver#nameProperty in class driver

Avatar driver name

char_cube3d::normalize() — Method in class char_cube3d
Normalize
$ colour_manager#named_coloursProperty in class colour_manager
colour_manager::name_colour() — Method in class colour_manager

Assign a name to a colour resource

colour_manager::normalize_hue() — Method in class colour_manager
gd::noise_line() — Method in class gd

Noise line

non_gdClass in namespace phpbb\captcha

Main non-gd captcha class

captcha_abstract::new_attempt() — Method in class captcha_abstract

New Question, if desired.

nogdClass in namespace phpbb\captcha\plugins
qa::new_attempt() — Method in class qa

Wrong answer, so we increase the attempts and use a different question.

$ activate#notificationsProperty in class activate
$ convertor#navigation_providerProperty in class convertor
$ convert#num_wait_rowsProperty in class convert
$ prune_notifications#notification_managerProperty in class prune_notifications
$ driver#num_queriesProperty in class driver
mysql_extractor::new_write_table() — Method in class mysql_extractor

Extracts database table structure (for MySQLi or MySQL 3.23.20+)

null_migrator_output_handlerClass in namespace phpbb\db\output_handler
$ base#num_itemsProperty in class base

Number of items to fetch. Usually overwritten by $config['feed_something']

feed::news() — Method in class feed

Controller for /feed/news route

no_feed_exceptionClass in namespace phpbb\feed\exception
no_forum_exceptionClass in namespace phpbb\feed\exception
no_topic_exceptionClass in namespace phpbb\feed\exception
$ forums#num_itemsProperty in class forums
newsClass in namespace phpbb\feed

News feed

$ post_base#num_itemsProperty in class post_base
$ topic_base#num_itemsProperty in class topic_base
$ helper#name_stringsProperty in class helper
$ helper#navigation_providerProperty in class helper
$ config#navigation_dataProperty in class config

Array containing navigation bar information

$ ajax_iohandler#nav_dataProperty in class ajax_iohandler
navigation_interfaceClass in namespace phpbb\install\helper\navigation

Interface for installer's navigation defining services

navigation_providerClass in namespace phpbb\install\helper\navigation

Installers navigation provider

notify_userClass in namespace phpbb\install\module\install_finish\task

Logs installation and sends an email to the admin

$ manager#notification_typesProperty in class manager
$ manager#notification_methodsProperty in class manager
$ manager#notification_types_tableProperty in class manager
$ base#notification_managerProperty in class base
$ board#notification_types_tableProperty in class board
$ board#notifications_tableProperty in class board
board::notify() — Method in class board

Parse the queue and notify the users

$ email#notification_emails_tableProperty in class email
email::notify() — Method in class email

Parse the queue and notify the users

jabber::notify() — Method in class jabber

Parse the queue and notify the users

messenger_base::notify_using_messenger() — Method in class messenger_base

Notify using phpBB messenger

method_interface::notify() — Method in class method_interface

Parse the queue and notify the users

$ admin_activate_user#notification_optionProperty in class admin_activate_user
{@inheritdoc}
$ approve_post#notification_optionProperty in class approve_post

Notification option data (for outputting to the user)

$ approve_topic#notification_optionProperty in class approve_topic

Notification option data (for outputting to the user)

$ base#notification_managerProperty in class base
$ base#notification_optionProperty in class base

Notification option data (for outputting to the user)

$ base#notification_type_idProperty in class base

The notification_type_id, set upon creation of the class This is the notification_type_id from the notification_types table

$ bookmark#notification_optionProperty in class bookmark

Notification option data (for outputting to the user)

$ disapprove_post#notification_optionProperty in class disapprove_post

Notification option data (for outputting to the user)

$ disapprove_topic#notification_optionProperty in class disapprove_topic

Notification option data (for outputting to the user)

$ forum#notification_optionProperty in class forum

Notification option data (for outputting to the user)

$ group_request#notification_optionProperty in class group_request
{@inheritdoc}
$ pm#notification_optionProperty in class pm

Notification option data (for outputting to the user)

$ post#notification_optionProperty in class post

Notification option data (for outputting to the user)

$ post_in_queue#notification_optionProperty in class post_in_queue

Notification option data (for outputting to the user)

$ quote#notification_optionProperty in class quote

Notification option data (for outputting to the user)

$ report_pm#notification_optionProperty in class report_pm

Notification option data (for outputting to the user)

$ report_pm_closed#notification_optionProperty in class report_pm_closed

Notification option data (for outputting to the user)

$ report_post#notification_optionProperty in class report_post

Notification option data (for outputting to the user)

$ report_post_closed#notification_optionProperty in class report_post_closed

Notification option data (for outputting to the user)

$ topic#notification_optionProperty in class topic

Notification option data (for outputting to the user)

$ topic_in_queue#notification_optionProperty in class topic_in_queue

Notification option data (for outputting to the user)

$ base#nameProperty in class base
base::needs_rehash() — Method in class base

Check if password needs to be rehashed

base_native::needs_rehash() — Method in class base_native

Check if password needs to be rehashed

bcrypt::needs_rehash() — Method in class bcrypt

Check if password needs to be rehashed

rehashable_driver_interface::needs_rehash() — Method in class rehashable_driver_interface

Check if password needs to be rehashed

$ report_handler#notificationsProperty in class report_handler
$ environment#namespace_look_up_orderProperty in class environment
notequalequalClass in namespace phpbb\template\twig\node\expression\binary
bbcode_merger::normalize_template() — Method in class bbcode_merger

Normalize a template

$ base#nameProperty in class base
nestedsetClass in namespace phpbb\tree
nestedset_forumClass in namespace phpbb\tree
$ smtp_class#numeric_response_codeProperty in class smtp_class

O

SphinxClient::Open() — Method in class SphinxClient
acp_extensions::output_metadata_to_template() — Method in class acp_extensions

Outputs extension metadata into the template

acp_users::optionset() — Method in class acp_users

Set option bit field for user options in a user row array.

acp_users::optionget() — Method in class acp_users

Get option bit field from user options in a user row array.

compress_tar::open() — Method in class compress_tar

Open archive

$ compress_zip#old_offsetProperty in class compress_zip
diff3_block_builder::out1() — Method in class diff3_block_builder
diff3_block_builder::out2() — Method in class diff3_block_builder
$ diff_op#origProperty in class diff_op
jabber::open_socket() — Method in class jabber
OpenSocket
auth::obtain_user_data() — Method in class auth

Retrieves data wanted by acl function from the database for the specified user.

oauthClass in namespace phpbb\auth\provider\oauth

OAuth authentication provider for phpBB3

$ oauth#oauth_token_tableProperty in class oauth
$ oauth#oauth_state_tableProperty in class oauth
$ oauth#oauth_account_tableProperty in class oauth
$ token_storage#oauth_token_tableProperty in class token_storage
$ token_storage#oauth_state_tableProperty in class token_storage
service::obtain_word_list() — Method in class service

Obtain list of naughty words and build preg style replacement arrays for use by the calling script

service::obtain_icons() — Method in class service

Obtain currently listed icons

service::obtain_ranks() — Method in class service

Obtain ranks

service::obtain_attach_extensions() — Method in class service

Obtain allowed extensions

service::obtain_bots() — Method in class service

Obtain active bots

service::obtain_cfg_items() — Method in class service

Obtain cfg file data

service::obtain_disallowed_usernames() — Method in class service

Obtain disallowed usernames

config::offsetExists() — Method in class config

Checks if the specified config value exists.

config::offsetGet() — Method in class config

Retrieves a configuration value.

config::offsetSet() — Method in class config

Temporarily overwrites the value of a configuration variable.

config::offsetUnset() — Method in class config

Called when deleting a configuration value directly, triggers an error.

$ reparse#outputProperty in class reparse
exception_subscriber::on_error() — Method in class exception_subscriber

This listener is run when the ConsoleEvents::ERROR event is triggered.

$ convert#optionsProperty in class convert
cron_runner_listener::on_kernel_terminate() — Method in class cron_runner_listener

Runs the cron job after the response was sent

$ driver#open_queriesProperty in class driver
$ driver#one_charProperty in class driver
oracleClass in namespace phpbb\db\driver

Oracle Database Abstraction Layer

mysql_extractor::old_write_table() — Method in class mysql_extractor

Extracts database table structure (for MySQL versions older than 3.23.20)

oracle_extractorClass in namespace phpbb\db\extractor
$ migrator#output_handlerProperty in class migrator

The output handler. A null handler is configured by default.

ordered_service_collectionClass in namespace phpbb\di

Collection of services in a specified order

ordered_service_collection::offsetExists() — Method in class ordered_service_collection
{@inheritdoc}
ordered_service_collection::offsetGet() — Method in class ordered_service_collection
{@inheritdoc}
service_collection::offsetGet() — Method in class service_collection
{@inheritdoc}
kernel_exception_subscriber::on_kernel_exception() — Method in class kernel_exception_subscriber

This listener is run when the KernelEvents::EXCEPTION event is triggered

kernel_terminate_subscriber::on_kernel_terminate() — Method in class kernel_terminate_subscriber

This listener is run when the KernelEvents::TERMINATE event is triggered This comes after a Response has been sent to the server; this is primarily cleanup stuff.

base::open() — Method in class base

Open feed

feed::overall() — Method in class feed

Controller for /feed/{mode] route

feed_interface::open() — Method in class feed_interface

Open feed

forum::open() — Method in class forum

Open feed

overallClass in namespace phpbb\feed

Board wide feed (aka overall feed)

topic::open() — Method in class topic

Open feed

kernel_exception_subscriber::on_kernel_exception() — Method in class kernel_exception_subscriber

This listener is run when the KernelEvents::EXCEPTION event is triggered

$ cli_iohandler#outputProperty in class cli_iohandler
$ create_config_file#optionsProperty in class create_config_file
db::owns_lock() — Method in class db

Does this process own the lock?

flock::owns_lock() — Method in class flock

Does this process own the lock?

pagination::on_page() — Method in class pagination

Return current page

helper::obtain_hash_only() — Method in class helper

Obtain only the actual hash after the prefixes

$ lang_helper#options_langProperty in class lang_helper

Array with the language option, grouped by field and language

deactivated_super_global::offsetExists() — Method in class deactivated_super_global

Redirects isset to the correct request class call.

deactivated_super_global::offsetGet() — Method in class deactivated_super_global
deactivated_super_global::offsetSet() — Method in class deactivated_super_global
deactivated_super_global::offsetUnset() — Method in class deactivated_super_global
$ request#original_requestProperty in class request
request::overwrite() — Method in class request

This function allows overwriting or setting a value in one of the super global arrays.

request_interface::overwrite() — Method in class request_interface

This function allows overwriting or setting a value in one of the super global arrays.

base::obtain_ids() — Method in class base

Retrieves cached search results

equalequal::operator() — Method in class equalequal
notequalequal::operator() — Method in class notequalequal
user::optionget() — Method in class user

Get option bit field from user options.

user::optionset() — Method in class user

Set option bit field for user options.

transfer::overwrite_file() — Method in class transfer

Moving file into location. If the destination file already exists it gets overwritten

transfer::open_session() — Method in class transfer

Open session

ucp_notifications::output_notification_types() — Method in class ucp_notifications

Output all the notification types to the template

ucp_notifications::output_notification_methods() — Method in class ucp_notifications

Output all the notification methods to the template

P

$ acp_attachments#phpbb_containerProperty in class acp_attachments
acp_attachments::perform_site_list() — Method in class acp_attachments

Perform operations on sites for external linking

acp_board::password_length() — Method in class acp_board

Minimum password length

$ acp_extensions#page_titleProperty in class acp_extensions
$ acp_forums#parent_idProperty in class acp_forums
$ acp_inactive#p_masterProperty in class acp_inactive
$ acp_modules#parent_idProperty in class acp_modules
$ acp_permissions#permission_dropdownProperty in class acp_permissions
$ acp_permissions#permissionsProperty in class acp_permissions
acp_permissions::permission_trace() — Method in class acp_permissions

Display a complete trace tree for the selected permission to determine where settings are set/unset

acp_prune::prune_forums() — Method in class acp_prune

Prune forums

acp_prune::prune_users() — Method in class acp_prune

Prune users

$ acp_styles#phpbb_root_pathProperty in class acp_styles
$ acp_styles#php_extProperty in class acp_styles
$ acp_users#p_masterProperty in class acp_users
$ bbcode_firstpass#parsed_itemsProperty in class bbcode_firstpass
bbcode_firstpass::parse_bbcode() — Method in class bbcode_firstpass

Parse BBCode

bbcode_firstpass::prepare_bbcodes() — Method in class bbcode_firstpass

Prepare some bbcodes for better parsing

$ jabber#portProperty in class jabber
$ jabber#passwordProperty in class jabber
jabber::parse_data() — Method in class jabber

parse_data like a="b",c="d",... or like a="a, b", c, d="e", f=g,.

$ mcp_logs#p_masterProperty in class mcp_logs
$ mcp_main#p_masterProperty in class mcp_main
$ mcp_notes#p_masterProperty in class mcp_notes
$ mcp_pm_reports#p_masterProperty in class mcp_pm_reports
$ mcp_queue#p_masterProperty in class mcp_queue
$ mcp_reports#p_masterProperty in class mcp_reports
$ mcp_warn#p_masterProperty in class mcp_warn
p_masterClass in namespace [Global Namespace]

Class handling all types of 'plugins' (a future term)

$ p_master#p_idProperty in class p_master
$ p_master#p_classProperty in class p_master
$ p_master#p_nameProperty in class p_master
$ p_master#p_modeProperty in class p_master
$ p_master#p_parentProperty in class p_master
parse_messageClass in namespace [Global Namespace]

Main message parser for posting, pm, etc. takes raw message and parses it for attachments, bbcode and smilies

$ parse_message#pluploadProperty in class parse_message

The plupload object used for dealing with attachments

parse_message::parse() — Method in class parse_message

Parse Message

parse_message::parse_attachments() — Method in class parse_message

Parse Attachments

parse_message::parse_poll() — Method in class parse_message

Parse Poll

$ delete#phpbb_root_pathProperty in class delete
$ upload#phpbb_dispatcherProperty in class upload
$ upload#phpbb_root_pathProperty in class upload
$ upload#pluploadProperty in class upload
$ apache#phpbb_root_pathProperty in class apache
$ apache#php_extProperty in class apache
$ db#phpbb_root_pathProperty in class db
$ db#php_extProperty in class db
$ db#passwords_managerProperty in class db

phpBB passwords manager

$ oauth#php_extProperty in class oauth
bitly::perform_auth_login() — Method in class bitly

Returns the results of the authentication in json format

bitly::perform_token_auth() — Method in class bitly

Returns the results of the authentication in json format Use this function when the user already has an access token

facebook::perform_auth_login() — Method in class facebook

Returns the results of the authentication in json format

facebook::perform_token_auth() — Method in class facebook

Returns the results of the authentication in json format Use this function when the user already has an access token

google::perform_auth_login() — Method in class google

Returns the results of the authentication in json format

google::perform_token_auth() — Method in class google

Returns the results of the authentication in json format Use this function when the user already has an access token

service_interface::perform_auth_login() — Method in class service_interface

Returns the results of the authentication in json format

service_interface::perform_token_auth() — Method in class service_interface

Returns the results of the authentication in json format Use this function when the user already has an access token

twitter::perform_auth_login() — Method in class twitter

Returns the results of the authentication in json format

twitter::perform_token_auth() — Method in class twitter

Returns the results of the authentication in json format Use this function when the user already has an access token

provider_interfaceClass in namespace phpbb\auth\provider

The interface authentication provider classes have to implement.

provider_collectionClass in namespace phpbb\auth

Collection of auth providers to be configured at container compile time.

$ driver#phpbb_root_pathProperty in class driver

Current $phpbb_root_path

$ driver#php_extProperty in class driver

Current $php_ext

$ driver#path_helperProperty in class driver

Path Helper

driver::prepare_form_acp() — Method in class driver

Prepare form for changing the acp settings of this avatar

driver_interface::prepare_form() — Method in class driver_interface

Prepare form for changing the settings of this avatar

driver_interface::prepare_form_acp() — Method in class driver_interface

Prepare form for changing the acp settings of this avatar

driver_interface::process_form() — Method in class driver_interface

Process form data

gravatar::prepare_form() — Method in class gravatar

Prepare form for changing the settings of this avatar

gravatar::process_form() — Method in class gravatar

Process form data

local::prepare_form() — Method in class local

Prepare form for changing the settings of this avatar

local::prepare_form_acp() — Method in class local

Prepare form for changing the acp settings of this avatar

local::process_form() — Method in class local

Process form data

remote::prepare_form() — Method in class remote

Prepare form for changing the settings of this avatar

remote::process_form() — Method in class remote

Process form data

upload::prepare_form() — Method in class upload

Prepare form for changing the settings of this avatar

upload::process_form() — Method in class upload

Process form data

upload::prepare_form_acp() — Method in class upload

Prepare form for changing the acp settings of this avatar

$ manager#phpbb_dispatcherProperty in class manager

phpBB event dispatcher

manager::prepare_driver_name() — Method in class manager

Prepare driver names for use in template files Dots are replaced with underscores

manager::prefix_avatar_columns() — Method in class manager

Prefix avatar columns

apcu::purge() — Method in class apcu

Purge cache data

base::purge() — Method in class base

Purge cache data

driver_interface::put() — Method in class driver_interface

Put data into cache

driver_interface::purge() — Method in class driver_interface

Purge cache data

dummy::put() — Method in class dummy

Put data into cache

dummy::purge() — Method in class dummy

Purge cache data

file::put() — Method in class file

Put data into cache

file::purge() — Method in class file

Purge cache data

memcached::purge() — Method in class memcached

Purge cache data

memory::put() — Method in class memory

Put data into cache

redis::purge() — Method in class redis

Purge cache data

wincache::purge() — Method in class wincache

Purge cache data

$ service#phpbb_root_pathProperty in class service

Root path.

$ service#php_extProperty in class service

PHP file extension.

non_gd::png_chunk() — Method in class non_gd

This creates a chunk of the given type, with the given data of the given length adding the relevant crc

$ config_php_file#phpbb_root_pathProperty in class config_php_file
$ config_php_file#php_extProperty in class config_php_file
purgeClass in namespace phpbb\console\command\cache
$ migrate#phpbb_root_pathProperty in class migrate
purgeClass in namespace phpbb\console\command\extension
$ update_hashes#passwords_managerProperty in class update_hashes
$ delete#phpbb_root_pathProperty in class delete

phpBB root path

$ generate#phpbb_root_pathProperty in class generate

phpBB root path

$ generate#php_extProperty in class generate

PHP extension.

$ check#phpbb_containerProperty in class check
$ activate#phpbb_root_pathProperty in class activate

phpBB root path

$ activate#php_extProperty in class activate

PHP extension.

$ add#password_managerProperty in class add
$ add#phpbb_root_pathProperty in class add

phpBB root path

$ add#php_extProperty in class add

PHP extension.

$ delete#phpbb_root_pathProperty in class delete

phpBB root path

$ delete#php_extProperty in class delete

PHP extension.

$ reclean#processedProperty in class reclean
$ reclean#progressProperty in class reclean
$ content_visibility#phpbb_dispatcherProperty in class content_visibility

Event dispatcher object

$ content_visibility#phpbb_root_pathProperty in class content_visibility

phpBB root path

$ content_visibility#php_extProperty in class content_visibility

PHP Extension

$ helper#php_extProperty in class helper
$ resolver#phpbb_root_pathProperty in class resolver

phpBB root path

$ convertor#phpbb_root_pathProperty in class convertor
$ convertor#php_extProperty in class convertor
convertor::proccess_settings_form() — Method in class convertor

Validates settings form

$ convert#p_masterProperty in class convert
convertor::process_row() — Method in class convertor

Function for processing the currently handled row

$ manager#phpbb_containerProperty in class manager
$ manager#phpbb_root_pathProperty in class manager
$ manager#php_extProperty in class manager
prune_all_forumsClass in namespace phpbb\cron\task\core

Prune all forums cron task.

$ prune_all_forums#phpbb_root_pathProperty in class prune_all_forums
$ prune_all_forums#php_extProperty in class prune_all_forums
prune_forumClass in namespace phpbb\cron\task\core

Prune one forum cron task.

$ prune_forum#phpbb_root_pathProperty in class prune_forum
$ prune_forum#php_extProperty in class prune_forum
prune_forum::parse_parameters() — Method in class prune_forum

Parses parameters found in $request, which is an instance of \phpbb\request\request_interface.

prune_notificationsClass in namespace phpbb\cron\task\core

Prune notifications cron task.

prune_shadow_topicsClass in namespace phpbb\cron\task\core

Prune one forum of its shadow topics cron task.

$ prune_shadow_topics#phpbb_root_pathProperty in class prune_shadow_topics
$ prune_shadow_topics#php_extProperty in class prune_shadow_topics
prune_shadow_topics::parse_parameters() — Method in class prune_shadow_topics

Parses parameters found in $request, which is an instance of \phpbb\request\request_interface.

$ queue#phpbb_root_pathProperty in class queue
$ queue#php_extProperty in class queue
$ tidy_plupload#phpbb_root_pathProperty in class tidy_plupload

phpBB root path

$ tidy_plupload#plupload_upload_pathProperty in class tidy_plupload

Directory where plupload stores temporary files.

$ tidy_search#phpbb_root_pathProperty in class tidy_search

phpBB root path

$ tidy_search#php_extProperty in class tidy_search

PHP file extension

$ tidy_search#phpbb_dispatcherProperty in class tidy_search

Event dispatcher object

$ tidy_warnings#phpbb_root_pathProperty in class tidy_warnings
$ tidy_warnings#php_extProperty in class tidy_warnings
$ update_hashes#passwords_managerProperty in class update_hashes
parametrizedClass in namespace phpbb\cron\task

Parametrized cron task interface.

parametrized::parse_parameters() — Method in class parametrized

Parses parameters found in $request, which is an instance of \phpbb\request\request_interface.

$ wrapper#phpbb_root_pathProperty in class wrapper
$ wrapper#php_extProperty in class wrapper
$ driver#persistencyProperty in class driver
postgresClass in namespace phpbb\db\driver

PostgreSQL Database Abstraction Layer Minimum Requirement is Version 8.3+

$ base_extractor#phpbb_root_pathProperty in class base_extractor
postgres_extractorClass in namespace phpbb\db\extractor
$ exception#parametersProperty in class exception

Extra parameters sent to exception to aid in debugging

$ migration#phpbb_root_pathProperty in class migration
$ migration#php_extProperty in class migration
profilefield_base_migrationClass in namespace phpbb\db\migration
$ profilefield_base_migration#profilefield_nameProperty in class profilefield_base_migration
$ profilefield_base_migration#profilefield_database_typeProperty in class profilefield_base_migration
$ profilefield_base_migration#profilefield_dataProperty in class profilefield_base_migration
$ profilefield_base_migration#profilefield_language_dataProperty in class profilefield_base_migration

Language data should be in array -> each language_data in separate key array( array( 'option_id' => value, 'field_type' => value, 'lang_value' => value, ), array( 'option_id' => value, 'field_type' => value, 'lang_value' => value, ), )

$ schema_generator#phpbb_root_pathProperty in class schema_generator
$ schema_generator#php_extProperty in class schema_generator
$ module#phpbb_root_pathProperty in class module
$ module#php_extProperty in class module
permissionClass in namespace phpbb\db\migration\tool

Migration permission management tool

$ permission#phpbb_root_pathProperty in class permission
$ permission#php_extProperty in class permission
permission::permission_set() — Method in class permission

Permission Set

permission::permission_unset() — Method in class permission

Permission Unset

$ migrator#phpbb_root_pathProperty in class migrator
$ migrator#php_extProperty in class migrator
migrator::process_data_step() — Method in class migrator

Process the data step of the migration

migrator::populate_migrations() — Method in class migrator

This function adds all migrations sent to it to the migrations table

postgresClass in namespace phpbb\db\tools

Database Tools for handling cross-db actions such as altering columns, etc.

tools::perform_schema_changes() — Method in class tools

Handle passed database update array.

tools_interface::perform_schema_changes() — Method in class tools_interface

Handle passed database update array.

$ container_builder#phpbb_root_pathProperty in class container_builder
$ container_builder#php_extProperty in class container_builder
collection_pass::process() — Method in class collection_pass

Modify the container before it is passed to the rest of the code

proxy_instantiatorClass in namespace phpbb\di

Runtime lazy loading proxy generator extended for allowing use while using open_basedir restrictions

$ md_exporter#pathProperty in class md_exporter
php_exporterClass in namespace phpbb\event

Class php_exporter Crawls through a list of files and grabs all php-events

$ php_exporter#pathProperty in class php_exporter
php_exporter::preg_match_event_name() — Method in class php_exporter

Returns a regex match for the event name

base::purge_step() — Method in class base

Single purge step that reverts any included and installed migrations

extension_interface::purge_step() — Method in class extension_interface

purge_step is executed on purging an extension until it returns false.

$ manager#php_extProperty in class manager
$ manager#phpbb_root_pathProperty in class manager
manager::purge_step() — Method in class manager

Purge an extension

manager::purge() — Method in class manager

Purge an extension

providerClass in namespace phpbb\extension

Provides a set of items found in extensions.

$ base#phpbb_dispatcherProperty in class base
$ base#phpExProperty in class base
$ feed#phpbb_dispatcherProperty in class feed
$ feed#php_extProperty in class feed
$ helper#path_helperProperty in class helper
post_baseClass in namespace phpbb\feed

Abstract class for post based feeds

$ filespec#php_iniProperty in class filespec
$ filespec#phpbb_root_pathProperty in class filespec
$ filespec#pluploadProperty in class filespec
$ base#php_iniProperty in class base
$ form#php_iniProperty in class form
$ form#pluploadProperty in class form
$ local#php_iniProperty in class local
$ remote#php_iniProperty in class remote
$ remote#phpbb_root_pathProperty in class remote
$ upload#php_iniProperty in class upload
filesystem::phpbb_chmod() — Method in class filesystem

Global function for chmodding directories and files for internal use

filesystem::phpbb_is_writable() — Method in class filesystem

phpBB's implementation of is_writable

filesystem::phpbb_own_realpath() — Method in class filesystem

Try to resolve real path when PHP's realpath fails to do so

filesystem_interface::phpbb_chmod() — Method in class filesystem_interface

Global function for chmodding directories and files for internal use

$ finder#phpbb_root_pathProperty in class finder
$ finder#php_extProperty in class finder
finder::prefix() — Method in class finder

Sets the prefix all files found in extensions and core must match

$ helper#path_helperProperty in class helper
$ helper#phpbb_root_pathProperty in class helper
$ controller#php_extProperty in class controller
$ help#php_extProperty in class help
$ finder#phpbb_root_pathProperty in class finder
$ finder#php_extProperty in class finder
$ helper#path_helperProperty in class helper
$ helper#phpbb_requestProperty in class helper
$ helper#phpbb_admin_pathProperty in class helper
$ helper#phpbb_root_pathProperty in class helper
helper::page_header() — Method in class helper

Set default template variables

$ installer_index#path_helperProperty in class installer_index
$ installer_index#phpbb_root_pathProperty in class installer_index
$ timeout_check#phpbb_root_pathProperty in class timeout_check
$ config#php_iniProperty in class config
$ config#phpbb_root_pathProperty in class config
$ config#progress_dataProperty in class config

Array containing progress information

$ container_factory#phpbb_root_pathProperty in class container_factory
$ container_factory#php_extProperty in class container_factory
$ compression_file_updater#phpbb_root_pathProperty in class compression_file_updater
$ compression_file_updater#php_extProperty in class compression_file_updater
$ file_updater#phpbb_root_pathProperty in class file_updater
$ ftp_file_updater#phpbb_root_pathProperty in class ftp_file_updater
$ ftp_file_updater#php_extProperty in class ftp_file_updater
$ install_helper#php_extProperty in class install_helper
$ install_helper#phpbb_root_pathProperty in class install_helper
$ ajax_iohandler#path_helperProperty in class ajax_iohandler
$ ajax_iohandler#phpbb_root_pathProperty in class ajax_iohandler
ajax_iohandler::prepare_json_array() — Method in class ajax_iohandler

Prepares iohandler's data to be sent out to the client.

$ cli_iohandler#progress_barProperty in class cli_iohandler
$ update_helper#path_to_new_filesProperty in class update_helper
$ update_helper#path_to_old_filesProperty in class update_helper
$ update_helper#phpbb_root_pathProperty in class update_helper
update_helper::phpbb_version_compare() — Method in class update_helper

Customized version_compare()

$ installer#purge_cache_beforeProperty in class installer
$ create_config_file#phpbb_root_pathProperty in class create_config_file
$ create_config_file#php_extProperty in class create_config_file
$ notify_user#phpbb_root_pathProperty in class notify_user
$ notify_user#php_extProperty in class notify_user
populate_migrationsClass in namespace phpbb\install\module\install_finish\task

Populates migrations

$ check_filesystem#phpbb_root_pathProperty in class check_filesystem
$ check_update#phpbb_root_pathProperty in class check_update
$ check_update#php_extProperty in class check_update
$ diff_files#phpbb_root_pathProperty in class diff_files
$ diff_files#php_extProperty in class diff_files
$ file_check#phpbb_root_pathProperty in class file_check
$ update_files#phpbb_root_pathProperty in class update_files
$ language_file_helper#phpbb_root_pathProperty in class language_file_helper
$ language_file_loader#phpbb_root_pathProperty in class language_file_loader
$ language_file_loader#php_extProperty in class language_file_loader
$ log#phpbb_root_pathProperty in class log

phpBB root path

$ log#phpbb_admin_pathProperty in class log

Admin root path

$ log#php_extProperty in class log

PHP Extension

$ form#phpbb_root_pathProperty in class form
$ form#phpExProperty in class form
$ guesser_base#priorityProperty in class guesser_base
$ module_manager#phpbb_root_pathProperty in class module_manager
$ module_manager#php_extProperty in class module_manager
$ manager#phpbb_containerProperty in class manager
$ manager#phpbb_dispatcherProperty in class manager
manager::purge_notifications() — Method in class manager

Purge all notifications of a certain type

manager::prune_notifications() — Method in class manager

Delete all notifications older than a certain time

base::prune_notifications() — Method in class base

Delete all notifications older than a certain time

base::purge_notifications() — Method in class base

Purge all notifications of a certain type

board::prune_notifications() — Method in class board

Delete all notifications older than a certain time

board::purge_notifications() — Method in class board

Purge all notifications of a certain type

$ messenger_base#phpbb_root_pathProperty in class messenger_base
$ messenger_base#php_extProperty in class messenger_base
method_interface::prune_notifications() — Method in class method_interface

Delete all notifications older than a certain time

method_interface::purge_notifications() — Method in class method_interface

Purge all notifications of a certain type

approve_post::pre_create_insert_array() — Method in class approve_post

Pre create insert array function This allows you to perform certain actions, like run a query and load data, before create_insert_array() is run. The data returned from this function will be sent to create_insert_array().

approve_topic::pre_create_insert_array() — Method in class approve_topic

Pre create insert array function This allows you to perform certain actions, like run a query and load data, before create_insert_array() is run. The data returned from this function will be sent to create_insert_array().

$ base#phpbb_root_pathProperty in class base
$ base#php_extProperty in class base
base::prepare_for_display() — Method in class base

Prepare to output the notification to the template

base::pre_create_insert_array() — Method in class base

Pre create insert array function (fall back)

pmClass in namespace phpbb\notification\type

Private message notifications class This class handles notifications for private messages

postClass in namespace phpbb\notification\type

Post notifications class This class handles notifications for replies to a topic

post::pre_create_insert_array() — Method in class post

Pre create insert array function This allows you to perform certain actions, like run a query and load data, before create_insert_array() is run. The data returned from this function will be sent to create_insert_array().

post_in_queueClass in namespace phpbb\notification\type

Post in queue notifications class This class handles notifications for posts that are put in the moderation queue (for moderators)

$ post_in_queue#permissionProperty in class post_in_queue

Permission to check for (in find_users_for_notification)

$ report_pm#permissionProperty in class report_pm

Permission to check for (in find_users_for_notification)

$ report_post#permissionProperty in class report_post

Permission to check for (in find_users_for_notification)

topic::pre_create_insert_array() — Method in class topic

Pre create insert array function This allows you to perform certain actions, like run a query and load data, before create_insert_array() is run. The data returned from this function will be sent to create_insert_array().

$ topic_in_queue#permissionProperty in class topic_in_queue

Permission to check for (in find_users_for_notification)

type_interface::prepare_for_display() — Method in class type_interface

Prepare to output the notification to the template

type_interface::pre_create_insert_array() — Method in class type_interface

Pre create insert array function This allows you to perform certain actions, like run a query and load data, before create_insert_array() is run. The data returned from this function will be sent to create_insert_array().

paginationClass in namespace phpbb
$ pagination#phpbb_dispatcherProperty in class pagination
$ md5_phpbb2#phpbb_root_pathProperty in class md5_phpbb2
$ md5_phpbb2#php_extProperty in class md5_phpbb2
phpassClass in namespace phpbb\passwords\driver
path_helperClass in namespace phpbb

A class with various functions that are related to paths, files and the filesystem

$ path_helper#phpbb_root_pathProperty in class path_helper
$ path_helper#php_extProperty in class path_helper
permissionsClass in namespace phpbb
$ permissions#permissionsProperty in class permissions
permissions::permission_defined() — Method in class permissions

Checks if a permission has been defined

pluploadClass in namespace phpbb\plupload

This class handles all server-side plupload functions

$ plupload#phpbb_root_pathProperty in class plupload
$ plupload#php_iniProperty in class plupload
plupload::prepare_temporary_directory() — Method in class plupload

Creates the temporary directory if it does not already exist.

$ manager#profile_cacheProperty in class manager
manager::purge_profilefields() — Method in class manager

Purge all profile fields of a certain type.

type_base::prepare_options_form() — Method in class type_base

Allows exclusion of options in single steps of the creation process

type_base::prepare_hidden_fields() — Method in class type_base

Allows manipulating the intended variables if needed

type_base::process_field_row() — Method in class type_base

Return templated value/field. Possible values for $mode are: change == user is able to set/enter profile values; preview == just show the value

type_bool::prepare_options_form() — Method in class type_bool

Allows exclusion of options in single steps of the creation process

type_bool::prepare_hidden_fields() — Method in class type_bool

Allows manipulating the intended variables if needed

type_date::prepare_hidden_fields() — Method in class type_date

Allows manipulating the intended variables if needed

type_dropdown::prepare_options_form() — Method in class type_dropdown

Allows exclusion of options in single steps of the creation process

type_interface::prepare_options_form() — Method in class type_interface

Allows exclusion of options in single steps of the creation process

type_interface::prepare_hidden_fields() — Method in class type_interface

Allows manipulating the intended variables if needed

type_interface::process_field_row() — Method in class type_interface

Return templated value/field. Possible values for $mode are: change == user is able to set/enter profile values; preview == just show the value

type_string_common::prepare_options_form() — Method in class type_string_common

Allows exclusion of options in single steps of the creation process

type_text::prepare_hidden_fields() — Method in class type_text

Allows manipulating the intended variables if needed

$ report#phpbb_root_pathProperty in class report
$ report#php_extProperty in class report
pm_reporting_disabled_exceptionClass in namespace phpbb\report\exception
$ helper#phpbb_root_pathProperty in class helper

phpBB root path

$ helper#php_extProperty in class helper

PHP file extension

$ default_resources_locator#phpbb_root_pathProperty in class default_resources_locator

phpBB root path

$ installer_resources_locator#phpbb_root_pathProperty in class installer_resources_locator

phpBB root path

$ router#php_extProperty in class router

PHP file extensions

$ fulltext_mysql#phpbb_dispatcherProperty in class fulltext_mysql

phpBB event dispatcher object

$ fulltext_native#phpbb_root_pathProperty in class fulltext_native

Relative path to board root

$ fulltext_native#php_extProperty in class fulltext_native

PHP Extension

$ fulltext_native#phpbb_dispatcherProperty in class fulltext_native

phpBB event dispatcher object

$ fulltext_postgres#phrase_searchProperty in class fulltext_postgres

True if phrase search is supported.

$ fulltext_postgres#phpbb_dispatcherProperty in class fulltext_postgres

phpBB event dispatcher object

$ fulltext_sphinx#phpbb_root_pathProperty in class fulltext_sphinx

Relative path to board root

$ fulltext_sphinx#php_extProperty in class fulltext_sphinx

PHP Extension

$ fulltext_sphinx#phpbb_dispatcherProperty in class fulltext_sphinx

phpBB event dispatcher object

$ session#pageProperty in class session
$ asset#path_helperProperty in class asset
$ environment#phpbb_configProperty in class environment
$ environment#phpbb_path_helperProperty in class environment
$ environment#phpbb_dispatcherProperty in class environment
$ environment#phpbb_root_pathProperty in class environment
phpClass in namespace phpbb\template\twig\node
defineparser::parse() — Method in class defineparser

Parses a token and returns a node.

event::parse() — Method in class event

Parses a token and returns a node.

includecss::parse() — Method in class includecss

Parses a token and returns a node.

includejs::parse() — Method in class includejs

Parses a token and returns a node.

includeparser::parse() — Method in class includeparser

Parses a token and returns a node.

includephp::parse() — Method in class includephp

Parses a token and returns a node.

phpClass in namespace phpbb\template\twig\tokenparser
php::parse() — Method in class php

Parses a token and returns a node.

$ twig#path_helperProperty in class twig

phpBB path helper

$ twig#phpbb_root_pathProperty in class twig

phpBB root path

$ twig#php_extProperty in class twig

PHP file extension

parser_interfaceClass in namespace phpbb\textformatter
parser_interface::parse() — Method in class parser_interface

Parse given text

parserClass in namespace phpbb\textformatter\s9e

s9e\TextFormatter\Parser adapter

$ parser#parserProperty in class parser
parser::parse() — Method in class parser

Parse given text

$ quote_helper#post_urlProperty in class quote_helper
$ quote_helper#profile_urlProperty in class quote_helper
pm_textClass in namespace phpbb\textreparser\plugins
poll_optionClass in namespace phpbb\textreparser\plugins
poll_titleClass in namespace phpbb\textreparser\plugins
post_textClass in namespace phpbb\textreparser\plugins
nestedset::prepare_adding_subset() — Method in class nestedset

Prepare adding a subset to the nested set

$ reset_password#passwords_managerProperty in class reset_password
$ reset_password#php_extProperty in class reset_password
$ user_loader#phpbb_root_pathProperty in class user_loader
$ user_loader#php_extProperty in class user_loader
$ version_helper#pathProperty in class version_helper
phpbb_hookClass in namespace [Global Namespace]

phpBB Hook Class

phpbb_hook::previous_hook_result() — Method in class phpbb_hook

Get result from previously called functions/methods for the same hook

phpbb_questionnaire_data_collectorClass in namespace [Global Namespace]

This class collects data which is used to create some usage statistics.

$ phpbb_questionnaire_data_collector#providersProperty in class phpbb_questionnaire_data_collector
phpbb_questionnaire_php_data_providerClass in namespace [Global Namespace]

Questionnaire PHP data provider

phpbb_questionnaire_phpbb_data_providerClass in namespace [Global Namespace]

Questionnaire phpBB data provider

phpbb_questionnaire_system_data_providerClass in namespace [Global Namespace]

Questionnaire System data provider

$ queue#package_sizeProperty in class queue
queue::put() — Method in class queue

Put object in queue

queue::process() — Method in class queue

Process queue Using lock file

smtp_class::pop_before_smtp() — Method in class smtp_class

Pop before smtp authentication

smtp_class::plain() — Method in class smtp_class

Plain authentication method

$ transfer#portProperty in class transfer
$ transfer#passwordProperty in class transfer
ucp_login_link::process_login_result() — Method in class ucp_login_link

Processes the result array from the login process

ucp_login_link::perform_redirect() — Method in class ucp_login_link

Performs a post login redirect

$ ucp_main#p_masterProperty in class ucp_main

Q

SphinxClient::Query() — Method in class SphinxClient
acp_board::quick_reply() — Method in class acp_board

Global quick reply enable/disable setting and button to enable in all forums

qaClass in namespace phpbb\captcha\plugins

And now to something completely different. Let's make a captcha without extending the abstract class.

$ qa#question_idsProperty in class qa
$ qa#question_textProperty in class qa
$ qa#question_langProperty in class qa
$ qa#question_strictProperty in class qa
queueClass in namespace phpbb\cron\task\core

Queue cron task. Sends email and jabber messages queued by other scripts.

$ driver#query_resultProperty in class driver
$ driver#query_holdProperty in class driver
$ mssqlnative#query_optionsProperty in class mssqlnative
$ migration#queriesProperty in class migration
quote_helperClass in namespace phpbb\feed

Modified quote_helper for feeds (basically just removing all attributes)

$ finder#queryProperty in class finder

An associative array, containing all search parameters set in methods.

$ base#queueProperty in class base

Queue of messages to be sent

quoteClass in namespace phpbb\notification\type

Post quoting notifications class This class handles notifying users when they have been quoted in a post

quote_helperClass in namespace phpbb\textformatter\s9e
$ renderer#quote_helperProperty in class renderer
queueClass in namespace [Global Namespace]

handling email and jabber queue

$ queue#queue_dataProperty in class queue

R

SphinxClient::ResetFilters() — Method in class SphinxClient
SphinxClient::ResetGroupBy() — Method in class SphinxClient
SphinxClient::ResetOverrides() — Method in class SphinxClient
SphinxClient::RunQueries() — Method in class SphinxClient
acp_permission_roles::remove_role() — Method in class acp_permission_roles

Remove role

acp_permissions::remove_permissions() — Method in class acp_permissions

Remove permissions

acp_permissions::retrieve_defined_user_groups() — Method in class acp_permissions

Get already assigned users/groups

acp_php_info::remove_spaces() — Method in class acp_php_info
$ acp_styles#reserved_style_namesProperty in class acp_styles
$ acp_styles#requestProperty in class acp_styles
acp_styles::read_style_cfg() — Method in class acp_styles

Read style configuration file

acp_styles::request_vars() — Method in class acp_styles

Get list of items from posted data

diff::reverse() — Method in class diff

Computes a reversed diff.

diff_op::reverse() — Method in class diff_op
diff_op_add::reverse() — Method in class diff_op_add
diff_op_change::reverse() — Method in class diff_op_change
diff_op_copy::reverse() — Method in class diff_op_copy
diff_op_delete::reverse() — Method in class diff_op_delete
diff_renderer::render() — Method in class diff_renderer

Renders a diff.

$ jabber#resourceProperty in class jabber
jabber::register() — Method in class jabber

Initiates account registration (based on data used for contructor)

jabber::response() — Method in class jabber

This handles all the different XML elements

$ messenger#replytoProperty in class messenger
messenger::reset() — Method in class messenger

Resets all the data (address, template file, etc etc) to default

messenger::replyto() — Method in class messenger

Set the reply to address

parse_message::remove_nested_quotes() — Method in class parse_message

Remove nested quotes at given depth in current parsed message

$ delete#resyncProperty in class delete
delete::remove_from_filesystem() — Method in class delete

Delete attachments from filesystem

$ manager#resyncProperty in class manager
manager::resync() — Method in class manager

Wrapper method for resyncing specified type

resyncClass in namespace phpbb\attachment

Attachment resync class

resync::resync() — Method in class resync

Resync specified type

$ apache#requestProperty in class apache
$ db#requestProperty in class db
$ oauth#requestProperty in class oauth
$ oauth#root_pathProperty in class oauth
$ bitly#requestProperty in class bitly
$ facebook#requestProperty in class facebook
$ google#requestProperty in class google
$ twitter#requestProperty in class twitter
token_storage::retrieveAccessToken() — Method in class token_storage
{@inheritdoc}
token_storage::retrieveAuthorizationState() — Method in class token_storage
{@inheritdoc}
token_storage::retrieve_access_token_by_session() — Method in class token_storage

A helper function that performs the query for retrieving access token functions by session.

token_storage::retrieve_state_by_session() — Method in class token_storage

A helper function that performs the query for retrieving state functions by session.

remoteClass in namespace phpbb\avatar\driver

Handles avatars hosted remotely

manager::register_avatar_drivers() — Method in class manager

Register avatar drivers

base::remove_file() — Method in class base

Removes/unlinks file

base::remove_dir() — Method in class base

Remove directory

redisClass in namespace phpbb\cache\driver

ACM for Redis

$ redis#redisProperty in class redis
char_cube3d::range() — Method in class char_cube3d
colour_manager::random_colour() — Method in class colour_manager

randomly generates a colour, with optional params

colour_manager::rgb2hsv() — Method in class colour_manager

(more than) Slightly altered from wikipedia's algorithm

non_gd::randomise() — Method in class non_gd

This is designed to randomise the pixels of the image data within certain limits so as to keep it readable. It also varies the image width a little

captcha_abstract::regenerate_code() — Method in class captcha_abstract

New Question, if desired.

captcha_abstract::reset() — Method in class captcha_abstract
qa::reselect_question() — Method in class qa

New Question, if desired.

qa::reset() — Method in class qa

API function

recaptchaClass in namespace phpbb\captcha\plugins
recaptcha::recaptcha_check_answer() — Method in class recaptcha

Calls an HTTP POST function to verify if the user's guess was correct

recaptcha_v3Class in namespace phpbb\captcha\plugins

Google reCAPTCHA v3 plugin.

recaptcha_v3::recaptcha_verify_token() — Method in class recaptcha_v3

Validate the token returned by Google reCAPTCHA v3.

class_loader::register() — Method in class class_loader

Registers the class loader as an autoloader using SPL.

class_loader::resolve_path() — Method in class class_loader

Resolves a phpBB class name to a relative path which can be included.

application::register_container_commands() — Method in class application

Register a set of commands from the container

application::register_global_options() — Method in class application

Register global options

runClass in namespace phpbb\console\command\cron
run::run_all() — Method in class run

Executes all ready cron tasks.

run::run_one() — Method in class run

Executes a given cron task, if it is ready.

revertClass in namespace phpbb\console\command\db
$ list_all#reparser_namesProperty in class list_all
reparseClass in namespace phpbb\console\command\reparser
$ reparse#reparse_lockProperty in class reparse
$ reparse#reparser_managerProperty in class reparse
$ reparse#reparsersProperty in class reparse
$ reparse#resume_dataProperty in class reparse
reparse::reparse() — Method in class reparse

Reparse all text handled by given reparser within given range

recreateClass in namespace phpbb\console\command\thumbnail
recleanClass in namespace phpbb\console\command\user
reclean::reclean_usernames() — Method in class reclean

Re-clean user names Only user names that are unclean will be re-cleaned

content_visibility::remove_post_from_statistic() — Method in class content_visibility

Remove post from topic and forum statistics

content_visibility::remove_topic_from_statistic() — Method in class content_visibility

Remove topic from forum statistics

$ helper#requestProperty in class helper
$ helper#routing_helperProperty in class helper
helper::render() — Method in class helper

Automate setting up the page and creating the response object.

helper::route() — Method in class helper

Generate a URL to a route

resolverClass in namespace phpbb\controller

Controller manager class

$ convertor#requestProperty in class convertor
convertor::render_settings_form() — Method in class convertor

Renders settings form

convertor::render_convert_list() — Method in class convertor

Render the list of available convertors

convertor::render_error() — Method in class convertor

Renders an error form

convertor::redirect_to_html() — Method in class convertor

Redirects an AJAX request to a non-JS version

$ manager#routing_helperProperty in class manager
prune_all_forums::run() — Method in class prune_all_forums

Runs this cron task.

prune_forum::run() — Method in class prune_forum

Runs this cron task.

prune_notifications::run() — Method in class prune_notifications

Runs this cron task.

prune_shadow_topics::run() — Method in class prune_shadow_topics

Runs this cron task.

queue::run() — Method in class queue

Runs this cron task.

tidy_cache::run() — Method in class tidy_cache

Runs this cron task.

tidy_plupload::run() — Method in class tidy_plupload

Runs this cron task.

tidy_search::run() — Method in class tidy_search

Runs this cron task.

tidy_sessions::run() — Method in class tidy_sessions

Runs this cron task.

tidy_warnings::run() — Method in class tidy_warnings

Runs this cron task.

update_hashes::run() — Method in class update_hashes

Runs this cron task.

task::run() — Method in class task

Runs this cron task.

reparserClass in namespace phpbb\cron\task\text_reparser

Reparse text cron task

$ reparser#reparse_lockProperty in class reparser
$ reparser#reparser_managerProperty in class reparser
$ reparser#reparser_nameProperty in class reparser
$ reparser#reparsersProperty in class reparser
$ reparser#resume_dataProperty in class reparser
reparser::run() — Method in class reparser

Runs this cron task.

$ wrapper#routing_helperProperty in class wrapper
$ driver#return_on_errorProperty in class driver
$ base_extractor#requestProperty in class base_extractor
$ base_extractor#run_compProperty in class base_extractor
helper::reverse_update_data() — Method in class helper

Reverse the update steps from an array of data changes

migration::revert_schema() — Method in class migration

Reverts the database schema by providing a set of change instructions

migration::revert_data() — Method in class migration

Reverts data by returning a list of instructions to be executed

migration_interface::revert_schema() — Method in class migration_interface

Reverts the database schema by providing a set of change instructions

migration_interface::revert_data() — Method in class migration_interface

Reverts data by returning a list of instructions to be executed

profilefield_base_migration::revert_schema() — Method in class profilefield_base_migration

Reverts the database schema by providing a set of change instructions

profilefield_base_migration::revert_data() — Method in class profilefield_base_migration

Reverts data by returning a list of instructions to be executed

config::remove() — Method in class config

Remove an existing config setting.

config::reverse() — Method in class config

Reverse an original install action

config_text::remove() — Method in class config_text

Remove an existing config_text setting.

config_text::reverse() — Method in class config_text

Reverse an original install action

module::remove() — Method in class module

Module Remove

module::reverse() — Method in class module

Reverse an original install action

permission::remove() — Method in class permission

Permission Remove

permission::role_exists() — Method in class permission

Check if a permission role exists

permission::role_add() — Method in class permission

Add a new permission role

permission::role_update() — Method in class permission

Update the name on a permission role

permission::role_remove() — Method in class permission

Remove a permission role

permission::reverse() — Method in class permission

Reverse an original install action

tool_interface::reverse() — Method in class tool_interface

Reverse an original install action

migrator::revert() — Method in class migrator

Runs a single revert step from the last migration installed

migrator::revert_do() — Method in class migrator

Effectively runs a single revert step from the last migration installed

migrator::run_step() — Method in class migrator

Run a single step

$ tools#return_statementsProperty in class tools

This is set to true if user only wants to return the 'to-be-executed' SQL statement(s) (as an array).

$ md_exporter#root_pathProperty in class md_exporter
$ php_exporter#root_pathProperty in class php_exporter
recursive_event_filter_iteratorClass in namespace phpbb\event

This filter ignores directories and files starting with a dot.

$ recursive_event_filter_iterator#root_pathProperty in class recursive_event_filter_iterator
rst_exporterClass in namespace phpbb\event
runtime_exceptionClass in namespace phpbb\exception

Class runtime_exception

$ base#resultProperty in class base
$ feed#requestProperty in class feed
$ helper#rendererProperty in class helper
$ filespec#realnameProperty in class filespec
filespec::remove() — Method in class filespec

Remove file

$ form#requestProperty in class form
$ local#requestProperty in class local
remoteClass in namespace phpbb\files\types
$ remote#requestProperty in class remote
remote::remote_upload() — Method in class remote

Remote upload method Uploads file from given url

$ upload#requestProperty in class upload
upload::reset_vars() — Method in class upload

Reset vars

filesystem::realpath() — Method in class filesystem

A wrapper for PHP's realpath

filesystem::remove() — Method in class filesystem

Removes files or directories.

filesystem::rename() — Method in class filesystem

Renames a file or a directory.

filesystem::resolve_path() — Method in class filesystem

Try to resolve symlinks in path

filesystem_interface::realpath() — Method in class filesystem_interface

A wrapper for PHP's realpath

filesystem_interface::remove() — Method in class filesystem_interface

Removes files or directories.

filesystem_interface::rename() — Method in class filesystem_interface

Renames a file or a directory.

$ controller#root_pathProperty in class controller
$ help#root_pathProperty in class help
$ helper#requestProperty in class helper
$ helper#routerProperty in class helper
helper::render() — Method in class helper

Automate setting up the page and creating the response object.

helper::route() — Method in class helper

Returns path from route name

helper::render_navigation() — Method in class helper

Render navigation

helper::render_language_select() — Method in class helper

Render language select form

$ install#requestProperty in class install
$ update#requestProperty in class update
$ jump_to_restart_point_exception#restart_point_nameProperty in class jump_to_restart_point_exception
resource_limit_reached_exceptionClass in namespace phpbb\install\exception

Thrown when the installer is out of memory or time

$ container_factory#requestProperty in class container_factory
factory::register() — Method in class factory

Register updater object

$ ajax_iohandler#requestProperty in class ajax_iohandler
$ ajax_iohandler#routerProperty in class ajax_iohandler
$ ajax_iohandler#request_client_refreshProperty in class ajax_iohandler
$ ajax_iohandler#redirect_urlProperty in class ajax_iohandler
ajax_iohandler::request_refresh() — Method in class ajax_iohandler

Sends refresh request to the client

ajax_iohandler::render_update_file_status() — Method in class ajax_iohandler

Renders the status of update files

ajax_iohandler::redirect() — Method in class ajax_iohandler

Redirects the user to a new page

ajax_iohandler::release_lock() — Method in class ajax_iohandler

Release file lock

cli_iohandler::request_refresh() — Method in class cli_iohandler

Sends refresh request to the client

cli_iohandler::render_update_file_status() — Method in class cli_iohandler

Renders the status of update files

cli_iohandler::redirect() — Method in class cli_iohandler

Redirects the user to a new page

$ iohandler_base#restart_progress_barProperty in class iohandler_base
iohandler_interface::request_refresh() — Method in class iohandler_interface

Sends refresh request to the client

iohandler_interface::redirect() — Method in class iohandler_interface

Redirects the user to a new page

iohandler_interface::render_update_file_status() — Method in class iohandler_interface

Renders the status of update files

navigation_provider::register() — Method in class navigation_provider

Registers a navigation provider's navigation items

installer::run() — Method in class installer

Run phpBB installer

installer::recover_progress() — Method in class installer

Recover install progress

create_config_file::run() — Method in class create_config_file

Executes the task

install_extensions::run() — Method in class install_extensions

Executes the task

notify_user::run() — Method in class notify_user

Executes the task

populate_migrations::run() — Method in class populate_migrations

Executes the task

abstract_requirements_module::run() — Method in class abstract_requirements_module

Executes the task

$ check_filesystem#responseProperty in class check_filesystem
check_filesystem::run() — Method in class check_filesystem

Executes the task

$ check_server_environment#response_helperProperty in class check_server_environment
check_server_environment::run() — Method in class check_server_environment

Executes the task

check_update::run() — Method in class check_update

Executes the task

diff_files::run() — Method in class diff_files

Executes the task

download_updated_files::run() — Method in class download_updated_files

Executes the task

file_check::run() — Method in class file_check

Executes the task

show_file_status::run() — Method in class show_file_status

Executes the task

update_files::run() — Method in class update_files

Executes the task

module_base::run() — Method in class module_base

Executes the task

module_base::recover_progress() — Method in class module_base

Returns the next task's name

module_interface::run() — Method in class module_interface

Executes the task

task_interface::run() — Method in class task_interface

Executes the task

language::reload_language_files() — Method in class language

Reload language files

db::release() — Method in class db

Releases the lock.

flock::release() — Method in class flock

Releases the lock.

admin_form::render() — Method in class admin_form
{inheritDoc}
form::render() — Method in class form

Render the template of the form

$ message#recipientsProperty in class message
$ topic_form#recipient_addressProperty in class topic_form
$ topic_form#recipient_nameProperty in class topic_form
$ topic_form#recipient_langProperty in class topic_form
topic_form::render() — Method in class topic_form
{inheritDoc}
$ user_form#recipient_idProperty in class user_form
$ user_form#recipient_rowProperty in class user_form
user_form::render() — Method in class user_form
{inheritDoc}
guesser::register_guessers() — Method in class guesser

Register MimeTypeGuessers and sort them by priority

module_manager::remove_cache_file() — Method in class module_manager

Remove modules cache file

report_pmClass in namespace phpbb\notification\type

Private message reported notifications class This class handles notifications for private messages when they are reported

report_pm_closedClass in namespace phpbb\notification\type

PM report closed notifications class This class handles notifications for when reports are closed on PMs (for the one who reported the PM)

report_postClass in namespace phpbb\notification\type

Reported post notifications class This class handles notifications for reported posts

report_post_closedClass in namespace phpbb\notification\type

Post report closed notifications class This class handles notifications for when reports are closed on posts (for the one who reported the post)

pagination::reverse_start() — Method in class pagination

Get new start when searching from the end

pagination::reverse_limit() — Method in class pagination

Get new item limit when searching from the end

$ md5_phpbb2#requestProperty in class md5_phpbb2
rehashable_driver_interfaceClass in namespace phpbb\passwords\driver
helper::rebuild_hash() — Method in class helper

Rebuild hash for hashing functions

manager::register_default_type() — Method in class manager

Register default type Will register the first supported type from the list of default types

$ path_helper#requestProperty in class path_helper
path_helper::remove_web_root_path() — Method in class path_helper

Strips away the web root path and prepends the normal root path

$ plupload#requestProperty in class plupload
$ manager#requestProperty in class manager
$ type_base#requestProperty in class type_base

Request object

$ type_bool#requestProperty in class type_bool

Request object

$ type_date#requestProperty in class type_date

Request object

$ type_dropdown#requestProperty in class type_dropdown

Request object

$ type_int#requestProperty in class type_int

Request object

$ type_string#requestProperty in class type_string

Request object

$ type_text#requestProperty in class type_text

Request object

recursive_dot_prefix_filter_iteratorClass in namespace phpbb

Class recursive_dot_prefix_filter_iterator

reportClass in namespace phpbb\report\controller
$ report#requestProperty in class report
$ report#report_handlerProperty in class report
$ report#report_reason_providerProperty in class report
report_permission_denied_exceptionClass in namespace phpbb\report\exception
report_handlerClass in namespace phpbb\report
$ report_handler#report_dataProperty in class report_handler
report_handler_interfaceClass in namespace phpbb\report
report_handler_pmClass in namespace phpbb\report
report_handler_postClass in namespace phpbb\report
report_reason_list_providerClass in namespace phpbb\report
requestClass in namespace phpbb\request

All application input is accessed through this class.

request::raw_variable() — Method in class request

Get a variable without trimming strings and without escaping.

request_interfaceClass in namespace phpbb\request

An interface through which all application input can be accessed.

request_interface::raw_variable() — Method in class request_interface

Get a variable without trimming strings and without escaping.

type_cast_helper::recursive_set_var() — Method in class type_cast_helper

Recursively sets a variable to a given type using set_var set_var

type_cast_helper_interface::recursive_set_var() — Method in class type_cast_helper_interface

Recursively sets a variable to a given type using set_var set_var.

$ helper#routerProperty in class helper

phpBB router

$ helper#requestProperty in class helper
helper::route() — Method in class helper

Generate a URL to a route

loader_resolver::resolve() — Method in class loader_resolver
{@inheritdoc}
resources_locator_interfaceClass in namespace phpbb\routing\resources_locator
routerClass in namespace phpbb\routing

Integration of all pieces of the routing system for easier use.

$ router#resources_locatorProperty in class router
$ router#route_collectionProperty in class router
router::resolveParameters() — Method in class router

Replaces placeholders with service container parameter values in:

  • the route defaults,
  • the route requirements,
  • the route path,
  • the route host,
  • the route schemes,
  • the route methods.
$ base#replace_synonymProperty in class base
session::reset_login_keys() — Method in class session

Reset all login keys for the specified user

base::retrieve_vars() — Method in class base

Retrieve multiple template values

base::retrieve_var() — Method in class base

Retrieve a single scalar value from a single key.

base::retrieve_block_vars() — Method in class base

Retrieve variable values from an specified block

context::retrieve_var() — Method in class context

Retrieve a single scalar value from a single key.

context::retrieve_block_vars() — Method in class context

Retrieve key variable pairs from the specified block

template::retrieve_vars() — Method in class template

Retrieve multiple template values

template::retrieve_var() — Method in class template

Retrieve a single scalar value from a single key.

template::retrieve_block_vars() — Method in class template

Retrieve variable values from an specified block

environment::render() — Method in class environment
{@inheritdoc}
routingClass in namespace phpbb\template\twig\extension
lexer::replace_twig_tag_masks() — Method in class lexer

Replace Twig tag masks with Twig tag calls

renderer_interfaceClass in namespace phpbb\textformatter
renderer_interface::render() — Method in class renderer_interface

Render given text

factory::regenerate() — Method in class factory

Regenerate and cache a new parser and renderer

rendererClass in namespace phpbb\textformatter\s9e

s9e\TextFormatter\Renderer adapter

$ renderer#rendererProperty in class renderer
renderer::render() — Method in class renderer

Render given text

utils::remove_bbcode() — Method in class utils

Remove given BBCode and its content, at given nesting depth

utils_interface::remove_bbcode() — Method in class utils_interface

Remove given BBCode and its content, at given nesting depth

base::reparse_range() — Method in class base

Reparse all records in given range

base::reparse_record() — Method in class base

Reparse given record

$ manager#reparsersProperty in class manager
$ manager#resume_dataProperty in class manager
reparser_interfaceClass in namespace phpbb\textreparser
reparser_interface::reparse_range() — Method in class reparser_interface

Reparse all records in given range

row_based_pluginClass in namespace phpbb\textreparser
nestedset::remove_item_from_nestedset() — Method in class nestedset

Remove an item from the tree without deleting it from the database

nestedset::remove_subset() — Method in class nestedset

Remove a subset from the nested set

nestedset::reset_nestedset_values() — Method in class nestedset

Resets values required for the nested set system

nestedset::regenerate_left_right_ids() — Method in class nestedset

Regenerate left/right ids from parent/child relationship

reset_passwordClass in namespace phpbb\ucp\controller

Handling forgotten passwords via reset password functionality

$ reset_password#requestProperty in class reset_password
$ reset_password#root_pathProperty in class reset_password
reset_password::remove_reset_token() — Method in class reset_password

Remove reset token for specified user

reset_password::request() — Method in class reset_password

Handle password reset request

reset_password::reset() — Method in class reset_password

Handle controller requests

phpbb_hook::register() — Method in class phpbb_hook

Register function/method to be called within hook This function is normally called by the modification/application to attach/register the functions.

phpbb_hook::remove_hook() — Method in class phpbb_hook

Remove function from the allowed hooks.

$ smtp_class#responsesProperty in class smtp_class
$ transfer#root_pathProperty in class transfer
transfer::remove_dir() — Method in class transfer

Remove directory

transfer::rename() — Method in class transfer

Rename a file or folder

S

SphinxClientClass in namespace [Global Namespace]
SphinxClient::SetServer() — Method in class SphinxClient
SphinxClient::SetConnectTimeout() — Method in class SphinxClient
SphinxClient::SetLimits() — Method in class SphinxClient
SphinxClient::SetMaxQueryTime() — Method in class SphinxClient
SphinxClient::SetMatchMode() — Method in class SphinxClient
SphinxClient::SetRankingMode() — Method in class SphinxClient
SphinxClient::SetSortMode() — Method in class SphinxClient
SphinxClient::SetWeights() — Method in class SphinxClient
SphinxClient::SetFieldWeights() — Method in class SphinxClient
SphinxClient::SetIndexWeights() — Method in class SphinxClient
SphinxClient::SetIDRange() — Method in class SphinxClient
SphinxClient::SetFilter() — Method in class SphinxClient
SphinxClient::SetFilterRange() — Method in class SphinxClient
SphinxClient::SetFilterFloatRange() — Method in class SphinxClient
SphinxClient::SetGeoAnchor() — Method in class SphinxClient
SphinxClient::SetGroupBy() — Method in class SphinxClient
SphinxClient::SetGroupDistinct() — Method in class SphinxClient
SphinxClient::SetRetries() — Method in class SphinxClient
SphinxClient::SetArrayResult() — Method in class SphinxClient
SphinxClient::SetOverride() — Method in class SphinxClient
SphinxClient::SetSelect() — Method in class SphinxClient
SphinxClient::Status() — Method in class SphinxClient
acp_attachments::set_attachment_stats() — Method in class acp_attachments

Set config attachment stat values

acp_attachments::select_allow_deny() — Method in class acp_attachments

Write secure_allow_deny config field

acp_board::select_auth_method() — Method in class acp_board

Select auth method

acp_board::select_ip_check() — Method in class acp_board

Select ip validation

acp_board::select_ref_check() — Method in class acp_board

Select referer validation

acp_board::select_acc_activation() — Method in class acp_board

Select account activation method

acp_board::select_username_chars() — Method in class acp_board

Allowed chars in usernames

acp_board::select_password_chars() — Method in class acp_board

Required chars in passwords

acp_board::select_news_forums() — Method in class acp_board

Select multiple forums

acp_board::select_exclude_forums() — Method in class acp_board
acp_board::store_feed_forums() — Method in class acp_board
acp_board::send_test_email() — Method in class acp_board
acp_extensions::sort_extension_meta_data_table() — Method in class acp_extensions

Sort helper for the table containing the metadata about the extensions.

acp_permissions::set_permissions() — Method in class acp_permissions

Apply permissions

acp_permissions::set_all_permissions() — Method in class acp_permissions

Apply all permissions

acp_profile::save_profile_field() — Method in class acp_profile

Save Profile Field

$ acp_search#stateProperty in class acp_search
$ acp_search#searchProperty in class acp_search
acp_search::settings() — Method in class acp_search
acp_search::save_state() — Method in class acp_search
$ acp_styles#s_hidden_fieldsProperty in class acp_styles
$ acp_styles#styles_pathProperty in class acp_styles
$ acp_styles#styles_path_absoluteProperty in class acp_styles
$ acp_styles#styles_list_colsProperty in class acp_styles
acp_styles::show_installed() — Method in class acp_styles

List installed styles

acp_styles::show_available() — Method in class acp_styles

Show list of styles that can be installed

acp_styles::show_styles_list() — Method in class acp_styles

Show styles list

acp_styles::show_available_child_styles() — Method in class acp_styles

Show available styles tree

acp_styles::sort_styles() — Method in class acp_styles

Sort styles

bitfield::set() — Method in class bitfield
diff3_op::solve_prepare() — Method in class diff3_op

Function to prepare the arrays for comparing - we want to skip over newline changes

diff3_op::solve_conflict() — Method in class diff3_op

Tries to solve conflicts aggressively based on typical "assumptions"

$ diff_engine#skip_whitespace_changesProperty in class diff_engine

If set to true we trim all lines before we compare them. This ensures that sole space/tab changes do not trigger diffs.

$ diff_renderer_side_by_side#stateProperty in class diff_renderer_side_by_side
$ jabber#sessionProperty in class jabber
$ jabber#serverProperty in class jabber
jabber::set_resource() — Method in class jabber

Sets the resource which is used. No validation is done here, only escaping.

jabber::send() — Method in class jabber

Send data to the Jabber server

jabber::send_presence() — Method in class jabber

Sets account presence. No additional info required (default is "online" status)

jabber::send_message() — Method in class jabber
$ messenger#subjectProperty in class messenger
messenger::set_addresses() — Method in class messenger

Set addresses for to/im as available

messenger::subject() — Method in class messenger

set up subject for mail

messenger::set_mail_priority() — Method in class messenger

Set the email priority

messenger::send() — Method in class messenger

Send the mail out to the recipients set previously in var $this->addresses

messenger::save_queue() — Method in class messenger

Save to queue

messenger::setup_template() — Method in class messenger

Setup template engine

messenger::set_template_paths() — Method in class messenger

Set template paths to load

p_master::set_custom_include_path() — Method in class p_master

Set custom include path for modules Schema for inclusion is include_path . modulebase

p_master::set_active() — Method in class p_master

Set active module

p_master::set_display() — Method in class p_master

Toggle whether this module will be displayed or not

parse_message::smilies() — Method in class parse_message

Parse Smilies

parse_message::set_plupload() — Method in class parse_message

Setter function for passing the plupload object

delete::set_attachment_ids() — Method in class delete

Set attachment IDs

resync::set_type_constraints() — Method in class resync

Set type constraints for attachment resync

$ oauth#service_providersProperty in class oauth
oauth::set_redirect() — Method in class oauth

Sets a redirect to the authorization uri.

$ base#service_providerProperty in class base

External OAuth service provider

base::set_external_service_provider() — Method in class base

Sets the external library service provider

service_interfaceClass in namespace phpbb\auth\provider\oauth\service

OAuth service interface

service_interface::set_external_service_provider() — Method in class service_interface

Sets the external library service provider

token_storage::storeAccessToken() — Method in class token_storage
{@inheritdoc}
token_storage::storeAuthorizationState() — Method in class token_storage
{@inheritdoc}
token_storage::set_user_id() — Method in class token_storage

Updates the user_id field in the database associated with the token.

driver::set_name() — Method in class driver

Sets the name of the driver.

$ base#sql_rowsetProperty in class base
$ base#sql_row_pointerProperty in class base
base::sql_load() — Method in class base

Load result of an SQL query from cache.

base::sql_exists() — Method in class base

Check if result for a given SQL query exists in cache.

base::sql_fetchrow() — Method in class base

Fetch row from cache (database)

base::sql_fetchfield() — Method in class base

Fetch a field from the current row of a cached database result (database)

base::sql_rowseek() — Method in class base

Seek a specific row in an a cached database result (database)

base::sql_freeresult() — Method in class base

Free memory used for a cached database result (database)

driver_interface::save() — Method in class driver_interface

Save modified objects

driver_interface::sql_load() — Method in class driver_interface

Load result of an SQL query from cache.

driver_interface::sql_save() — Method in class driver_interface

Save result of an SQL query in cache.

driver_interface::sql_exists() — Method in class driver_interface

Check if result for a given SQL query exists in cache.

driver_interface::sql_fetchrow() — Method in class driver_interface

Fetch row from cache (database)

driver_interface::sql_fetchfield() — Method in class driver_interface

Fetch a field from the current row of a cached database result (database)

driver_interface::sql_rowseek() — Method in class driver_interface

Seek a specific row in an a cached database result (database)

driver_interface::sql_freeresult() — Method in class driver_interface

Free memory used for a cached database result (database)

dummy::save() — Method in class dummy

Save modified objects

dummy::sql_load() — Method in class dummy

Load result of an SQL query from cache.

dummy::sql_save() — Method in class dummy

Save result of an SQL query in cache.

dummy::sql_exists() — Method in class dummy

Check if result for a given SQL query exists in cache.

dummy::sql_fetchrow() — Method in class dummy

Fetch row from cache (database)

dummy::sql_fetchfield() — Method in class dummy

Fetch a field from the current row of a cached database result (database)

dummy::sql_rowseek() — Method in class dummy

Seek a specific row in an a cached database result (database)

dummy::sql_freeresult() — Method in class dummy

Free memory used for a cached database result (database)

file::save() — Method in class file

Save modified objects

file::sql_save() — Method in class file

Save result of an SQL query in cache.

memory::save() — Method in class memory

Save modified objects

memory::sql_save() — Method in class memory

Save result of an SQL query in cache.

serviceClass in namespace phpbb\cache

Class for grabbing/handling cached entries

service::set_driver() — Method in class service

Replaces the cache driver used by this cache service.

char_cube3d::sum() — Method in class char_cube3d
char_cube3d::sum2() — Method in class char_cube3d
char_cube3d::scale() — Method in class char_cube3d
$ captcha_abstract#seedProperty in class captcha_abstract
$ captcha_abstract#solvedProperty in class captcha_abstract
$ captcha_abstract#service_nameProperty in class captcha_abstract
captcha_abstract::set_name() — Method in class captcha_abstract

Set the name of the plugin

$ qa#solvedProperty in class qa
$ qa#service_nameProperty in class qa
qa::set_name() — Method in class qa

Set the name of the plugin

qa::select_question() — Method in class qa

Select a question

$ recaptcha_v3#supported_domainsProperty in class recaptcha_v3
class_loader::set_cache() — Method in class class_loader

Provide the class loader with a cache to store paths. If set to null, the the class loader will resolve paths by checking for the existence of every directory in the class name every time.

config::set() — Method in class config

Sets a configuration option's value

config::set_atomic() — Method in class config

Sets a configuration option's value only if the old_value matches the current configuration value or the configuration value does not exist yet.

db::set() — Method in class db

Sets a configuration option's value

db::set_atomic() — Method in class db

Sets a configuration option's value only if the old_value matches the current configuration value or the configuration value does not exist yet.

db_text::set() — Method in class db_text

Sets the configuration option with the name $key to $value.

db_text::set_array() — Method in class db_text

Mass set configuration options: Receives an associative array, treats array keys as configuration option names and associated array values as their configuration option values.

config_php_file::set_config_file() — Method in class config_php_file

Set the path to the config file.

setClass in namespace phpbb\console\command\config
set_atomicClass in namespace phpbb\console\command\config
showClass in namespace phpbb\console\command\extension
activate::send_notification() — Method in class activate

Send account activation notification to user

add::send_activation_email() — Method in class add

Send account activation email

content_visibility::set_post_visibility() — Method in class content_visibility

Change visibility status of one post or all posts of a topic

content_visibility::set_topic_visibility() — Method in class content_visibility

Set topic visibility

$ helper#symfony_requestProperty in class helper
$ helper#sql_explainProperty in class helper
helper::set_cron_task() — Method in class helper

Set cron task for footer

$ convertor#session_keys_tableProperty in class convertor
$ convertor#session_tableProperty in class convertor
convertor::settings() — Method in class convertor

Obtain convertor settings

$ convert#src_dbmsProperty in class convert
$ convert#src_dbhostProperty in class convert
$ convert#src_dbportProperty in class convert
$ convert#src_dbuserProperty in class convert
$ convert#src_dbpasswdProperty in class convert
$ convert#src_dbnameProperty in class convert
$ convert#src_table_prefixProperty in class convert
$ convert#src_truncate_statementProperty in class convert
convertor::sync_forums() — Method in class convertor

Sync function being executed at the middle, some functions need to be executed after a successful sync.

convertor::save_convert_progress() — Method in class convertor

Save the convertor status

base::set_name() — Method in class base

Sets the name of the task.

base::should_run() — Method in class base

Returns whether this cron task should run now, because enough time has passed since it was last run.

prune_forum::set_forum_data() — Method in class prune_forum

Manually set forum data.

prune_forum::should_run() — Method in class prune_forum

Returns whether this cron task should run now, because enough time has passed since it was last run.

prune_notifications::should_run() — Method in class prune_notifications

Returns whether this cron task should run now, because enough time has passed since it was last run.

prune_shadow_topics::set_forum_data() — Method in class prune_shadow_topics

Manually set forum data.

prune_shadow_topics::should_run() — Method in class prune_shadow_topics

Returns whether this cron task should run now, because enough time has passed since it was last run.

queue::should_run() — Method in class queue

Returns whether this cron task should run now, because enough time has passed since it was last run.

tidy_cache::should_run() — Method in class tidy_cache

Returns whether this cron task should run now, because enough time has passed since it was last run.

tidy_plupload::should_run() — Method in class tidy_plupload

Returns whether this cron task should run now, because enough time has passed since it was last run.

tidy_search::should_run() — Method in class tidy_search

Returns whether this cron task should run now, because enough time has passed since it was last run.

tidy_sessions::should_run() — Method in class tidy_sessions

Returns whether this cron task should run now, because enough time has passed since it was last run.

tidy_warnings::should_run() — Method in class tidy_warnings

Returns whether this cron task should run now, because enough time has passed since it was last run.

update_hashes::should_run() — Method in class update_hashes

Returns whether this cron task should run now, because enough time has passed since it was last run.

task::should_run() — Method in class task

Returns whether this cron task should run now, because enough time has passed since it was last run.

reparser::set_reparser() — Method in class reparser

Sets the reparser for this cron task

reparser::should_run() — Method in class reparser

Returns whether this cron task should run now, because enough time has passed since it was last run.

$ driver#sql_timeProperty in class driver
$ driver#sql_reportProperty in class driver
$ driver#serverProperty in class driver
$ driver#sql_error_triggeredProperty in class driver
$ driver#sql_error_sqlProperty in class driver
$ driver#sql_error_returnedProperty in class driver
$ driver#sql_layerProperty in class driver

Current sql layer

$ driver#sql_server_versionProperty in class driver

Exact version of the DBAL, directly queried

driver::set_debug_load_time() — Method in class driver

Set value for load_time debug parameter

driver::set_debug_sql_explain() — Method in class driver

Set value for sql_explain debug parameter

driver::set_multi_insert() — Method in class driver

Set if multiple insertion can be used

driver::sql_return_on_error() — Method in class driver

Return on error or display error message

driver::sql_num_queries() — Method in class driver

Return number of sql queries and cached sql queries used

driver::sql_add_num_queries() — Method in class driver

Add to query count

driver::sql_close() — Method in class driver

DBAL garbage collection, close SQL connection

driver::sql_query_limit() — Method in class driver

Build LIMIT query

driver::sql_fetchrowset() — Method in class driver

Fetch all rows

driver::sql_rowseek() — Method in class driver

Seek to given row number

driver::sql_fetchfield() — Method in class driver

Fetch field if rownum is false, the current row is used, else it is pointing to the row (zero-based)

driver::sql_like_expression() — Method in class driver

Correctly adjust LIKE expression for special characters Some DBMS are handling them in a different way

driver::sql_not_like_expression() — Method in class driver

Correctly adjust NOT LIKE expression for special characters Some DBMS are handling them in a different way

driver::sql_case() — Method in class driver

Build a case expression

driver::sql_concatenate() — Method in class driver

Build a concatenated expression

driver::sql_buffer_nested_transactions() — Method in class driver

Returns whether results of a query need to be buffered to run a transaction while iterating over them.

driver::sql_transaction() — Method in class driver

SQL Transaction

driver::sql_build_array() — Method in class driver

Build sql statement from an array

driver::sql_in_set() — Method in class driver

Build IN or NOT IN sql comparison string, uses <> or = on single element arrays to improve comparison speed

driver::sql_bit_and() — Method in class driver

Run binary AND operator on DB column.

driver::sql_bit_or() — Method in class driver

Run binary OR operator on DB column.

driver::sql_nextid() — Method in class driver

Gets the ID of the last inserted row immediately after an INSERT statement.

driver::sql_lower_text() — Method in class driver

Run LOWER() on DB column of type text (i.e. neither varchar nor char).

driver::sql_multi_insert() — Method in class driver

Run more than one insert statement.

driver::sql_build_query() — Method in class driver

Build sql statement from array for select and select distinct statements

driver::sql_error() — Method in class driver

Display sql error page

driver::sql_report() — Method in class driver

Explain queries

driver_interface::set_debug_load_time() — Method in class driver_interface

Set value for load_time debug parameter

driver_interface::set_debug_sql_explain() — Method in class driver_interface

Set value for sql_explain debug parameter

driver_interface::set_multi_insert() — Method in class driver_interface

Set if multiple insertion can be used

driver_interface::sql_lower_text() — Method in class driver_interface

Run LOWER() on DB column of type text (i.e. neither varchar nor char).

driver_interface::sql_error() — Method in class driver_interface

Display sql error page

driver_interface::sql_buffer_nested_transactions() — Method in class driver_interface

Returns whether results of a query need to be buffered to run a transaction while iterating over them.

driver_interface::sql_bit_or() — Method in class driver_interface

Run binary OR operator on DB column.

driver_interface::sql_server_info() — Method in class driver_interface

Version information about used database

driver_interface::sql_return_on_error() — Method in class driver_interface

Return on error or display error message

driver_interface::sql_build_array() — Method in class driver_interface

Build sql statement from an array

driver_interface::sql_fetchrowset() — Method in class driver_interface

Fetch all rows

driver_interface::sql_transaction() — Method in class driver_interface

SQL Transaction

driver_interface::sql_concatenate() — Method in class driver_interface

Build a concatenated expression

driver_interface::sql_case() — Method in class driver_interface

Build a case expression

driver_interface::sql_build_query() — Method in class driver_interface

Build sql statement from array for select and select distinct statements

driver_interface::sql_fetchfield() — Method in class driver_interface

Fetch field if rownum is false, the current row is used, else it is pointing to the row (zero-based)

driver_interface::sql_fetchrow() — Method in class driver_interface

Fetch current row

driver_interface::sql_nextid() — Method in class driver_interface

Gets the ID of the last inserted row immediately after an INSERT statement.

driver_interface::sql_last_inserted_id() — Method in class driver_interface

Gets the ID of the last inserted row immediately after an INSERT statement. The returned value can be used for selecting the item that has just been inserted or for updating another table with an ID pointing to that item.

driver_interface::sql_add_num_queries() — Method in class driver_interface

Add to query count

driver_interface::sql_query_limit() — Method in class driver_interface

Build LIMIT query

driver_interface::sql_query() — Method in class driver_interface

Base query method

driver_interface::sql_connect() — Method in class driver_interface

Connect to server

driver_interface::sql_bit_and() — Method in class driver_interface

Run binary AND operator on DB column.

driver_interface::sql_freeresult() — Method in class driver_interface

Free sql result

driver_interface::sql_num_queries() — Method in class driver_interface

Return number of sql queries and cached sql queries used

driver_interface::sql_multi_insert() — Method in class driver_interface

Run more than one insert statement.

driver_interface::sql_affectedrows() — Method in class driver_interface

Return number of affected rows

driver_interface::sql_close() — Method in class driver_interface

DBAL garbage collection, close SQL connection

driver_interface::sql_rowseek() — Method in class driver_interface

Seek to given row number

driver_interface::sql_escape() — Method in class driver_interface

Escape string used in sql query

driver_interface::sql_like_expression() — Method in class driver_interface

Correctly adjust LIKE expression for special characters Some DBMS are handling them in a different way

driver_interface::sql_not_like_expression() — Method in class driver_interface

Correctly adjust NOT LIKE expression for special characters Some DBMS are handling them in a different way

driver_interface::sql_report() — Method in class driver_interface

Explain queries

driver_interface::sql_in_set() — Method in class driver_interface

Build IN or NOT IN sql comparison string, uses <> or = on single element arrays to improve comparison speed

driver_interface::sql_quote() — Method in class driver_interface

Quote identifiers used in sql query

factory::set_driver() — Method in class factory

Set the current driver

factory::set_debug_load_time() — Method in class factory

Set value for load_time debug parameter

factory::set_debug_sql_explain() — Method in class factory

Set value for sql_explain debug parameter

factory::set_multi_insert() — Method in class factory

Set if multiple insertion can be used

factory::sql_lower_text() — Method in class factory

Run LOWER() on DB column of type text (i.e. neither varchar nor char).

factory::sql_error() — Method in class factory

Display sql error page

factory::sql_buffer_nested_transactions() — Method in class factory

Returns whether results of a query need to be buffered to run a transaction while iterating over them.

factory::sql_bit_or() — Method in class factory

Run binary OR operator on DB column.

factory::sql_server_info() — Method in class factory

Version information about used database

factory::sql_return_on_error() — Method in class factory

Return on error or display error message

factory::sql_build_array() — Method in class factory

Build sql statement from an array

factory::sql_fetchrowset() — Method in class factory

Fetch all rows

factory::sql_transaction() — Method in class factory

SQL Transaction

factory::sql_concatenate() — Method in class factory

Build a concatenated expression

factory::sql_case() — Method in class factory

Build a case expression

factory::sql_build_query() — Method in class factory

Build sql statement from array for select and select distinct statements

factory::sql_fetchfield() — Method in class factory

Fetch field if rownum is false, the current row is used, else it is pointing to the row (zero-based)

factory::sql_fetchrow() — Method in class factory

Fetch current row

factory::sql_nextid() — Method in class factory

Gets the ID of the last inserted row immediately after an INSERT statement.

factory::sql_last_inserted_id() — Method in class factory

Gets the ID of the last inserted row immediately after an INSERT statement. The returned value can be used for selecting the item that has just been inserted or for updating another table with an ID pointing to that item.

factory::sql_add_num_queries() — Method in class factory

Add to query count

factory::sql_query_limit() — Method in class factory

Build LIMIT query

factory::sql_query() — Method in class factory

Base query method

factory::sql_connect() — Method in class factory

Connect to server

factory::sql_bit_and() — Method in class factory

Run binary AND operator on DB column.

factory::sql_freeresult() — Method in class factory

Free sql result

factory::sql_num_queries() — Method in class factory

Return number of sql queries and cached sql queries used

factory::sql_multi_insert() — Method in class factory

Run more than one insert statement.

factory::sql_affectedrows() — Method in class factory

Return number of affected rows

factory::sql_close() — Method in class factory

DBAL garbage collection, close SQL connection

factory::sql_rowseek() — Method in class factory

Seek to given row number

factory::sql_escape() — Method in class factory

Escape string used in sql query

factory::sql_like_expression() — Method in class factory

Correctly adjust LIKE expression for special characters Some DBMS are handling them in a different way

factory::sql_not_like_expression() — Method in class factory

Correctly adjust NOT LIKE expression for special characters Some DBMS are handling them in a different way

factory::sql_report() — Method in class factory

Explain queries

factory::sql_in_set() — Method in class factory

Build IN or NOT IN sql comparison string, uses <> or = on single element arrays to improve comparison speed

factory::sql_quote() — Method in class factory

Quote identifiers used in sql query

mssql_base::sql_concatenate() — Method in class mssql_base

Build a concatenated expression

mssql_base::sql_escape() — Method in class mssql_base

Escape string used in sql query

mssql_base::sql_lower_text() — Method in class mssql_base

Run LOWER() on DB column of type text (i.e. neither varchar nor char).

mssql_base::sql_quote() — Method in class mssql_base

Quote identifiers used in sql query

mssql_odbc::sql_connect() — Method in class mssql_odbc

Connect to server

mssql_odbc::sql_server_info() — Method in class mssql_odbc

Version information about used database

mssql_odbc::sql_query() — Method in class mssql_odbc

Base query method

mssql_odbc::sql_affectedrows() — Method in class mssql_odbc

Return number of affected rows

mssql_odbc::sql_fetchrow() — Method in class mssql_odbc

Fetch current row

mssql_odbc::sql_last_inserted_id() — Method in class mssql_odbc

Gets the ID of the last inserted row immediately after an INSERT statement. The returned value can be used for selecting the item that has just been inserted or for updating another table with an ID pointing to that item.

mssql_odbc::sql_freeresult() — Method in class mssql_odbc

Free sql result

mssqlnative::sql_connect() — Method in class mssqlnative

Connect to server

mssqlnative::sql_server_info() — Method in class mssqlnative

Version information about used database

mssqlnative::sql_buffer_nested_transactions() — Method in class mssqlnative

Returns whether results of a query need to be buffered to run a transaction while iterating over them.

mssqlnative::sql_query() — Method in class mssqlnative

Base query method

mssqlnative::sql_affectedrows() — Method in class mssqlnative

Return number of affected rows

mssqlnative::sql_fetchrow() — Method in class mssqlnative

Fetch current row

mssqlnative::sql_last_inserted_id() — Method in class mssqlnative

Gets the ID of the last inserted row immediately after an INSERT statement. The returned value can be used for selecting the item that has just been inserted or for updating another table with an ID pointing to that item.

mssqlnative::sql_freeresult() — Method in class mssqlnative

Free sql result

mysql_base::sql_concatenate() — Method in class mysql_base

Build a concatenated expression

mysqli::sql_connect() — Method in class mysqli

Connect to server

mysqli::sql_server_info() — Method in class mysqli

Version information about used database

mysqli::sql_query() — Method in class mysqli

Base query method

mysqli::sql_affectedrows() — Method in class mysqli

Return number of affected rows

mysqli::sql_fetchrow() — Method in class mysqli

Fetch current row

mysqli::sql_rowseek() — Method in class mysqli

Seek to given row number

mysqli::sql_last_inserted_id() — Method in class mysqli

Gets the ID of the last inserted row immediately after an INSERT statement. The returned value can be used for selecting the item that has just been inserted or for updating another table with an ID pointing to that item.

mysqli::sql_freeresult() — Method in class mysqli

Free sql result

mysqli::sql_escape() — Method in class mysqli

Escape string used in sql query

mysqli::sql_quote() — Method in class mysqli

Quote identifiers used in sql query

oracle::sql_connect() — Method in class oracle

Connect to server

oracle::sql_server_info() — Method in class oracle

Version information about used database

oracle::sql_query() — Method in class oracle

Base query method

oracle::sql_affectedrows() — Method in class oracle

Return number of affected rows

oracle::sql_fetchrow() — Method in class oracle

Fetch current row

oracle::sql_rowseek() — Method in class oracle

Seek to given row number

oracle::sql_last_inserted_id() — Method in class oracle

Gets the ID of the last inserted row immediately after an INSERT statement. The returned value can be used for selecting the item that has just been inserted or for updating another table with an ID pointing to that item.

oracle::sql_freeresult() — Method in class oracle

Free sql result

oracle::sql_escape() — Method in class oracle

Escape string used in sql query

oracle::sql_quote() — Method in class oracle

Quote identifiers used in sql query

postgres::sql_connect() — Method in class postgres

Connect to server

postgres::sql_server_info() — Method in class postgres

Version information about used database

postgres::sql_query() — Method in class postgres

Base query method

postgres::sql_affectedrows() — Method in class postgres

Return number of affected rows

postgres::sql_fetchrow() — Method in class postgres

Fetch current row

postgres::sql_rowseek() — Method in class postgres

Seek to given row number

postgres::sql_fetchfield() — Method in class postgres

Fetch field if rownum is false, the current row is used, else it is pointing to the row (zero-based)

postgres::sql_last_inserted_id() — Method in class postgres

Gets the ID of the last inserted row immediately after an INSERT statement. The returned value can be used for selecting the item that has just been inserted or for updating another table with an ID pointing to that item.

postgres::sql_freeresult() — Method in class postgres

Free sql result

postgres::sql_escape() — Method in class postgres

Escape string used in sql query

postgres::sql_quote() — Method in class postgres

Quote identifiers used in sql query

sqlite3Class in namespace phpbb\db\driver

SQLite3 Database Abstraction Layer Minimum Requirement: 3.6.15+

sqlite3::sql_connect() — Method in class sqlite3

Connect to server

sqlite3::sql_server_info() — Method in class sqlite3

Version information about used database

sqlite3::sql_query() — Method in class sqlite3

Base query method

sqlite3::sql_affectedrows() — Method in class sqlite3

Return number of affected rows

sqlite3::sql_fetchrow() — Method in class sqlite3

Fetch current row

sqlite3::sql_last_inserted_id() — Method in class sqlite3

Gets the ID of the last inserted row immediately after an INSERT statement. The returned value can be used for selecting the item that has just been inserted or for updating another table with an ID pointing to that item.

sqlite3::sql_freeresult() — Method in class sqlite3

Free sql result

sqlite3::sql_escape() — Method in class sqlite3

Escape string used in sql query

sqlite3::sql_like_expression() — Method in class sqlite3

Correctly adjust LIKE expression for special characters Some DBMS are handling them in a different way

sqlite3::sql_not_like_expression() — Method in class sqlite3

Correctly adjust NOT LIKE expression for special characters Some DBMS are handling them in a different way

sqlite3::sql_quote() — Method in class sqlite3

Quote identifiers used in sql query

$ base_extractor#storeProperty in class base_extractor
sqlite3_extractorClass in namespace phpbb\db\extractor
container_aware_migration::setContainer() — Method in class container_aware_migration
{@inheritdoc}
migration::sql_query() — Method in class migration

Wrapper for running queries to generate user feedback on updates

schema_generatorClass in namespace phpbb\db\migration

The schema generator generates the schema based on the existing migrations

migrator::set_output_handler() — Method in class migrator

Set the output handler.

migrator::set_migrations() — Method in class migrator

Sets the list of available migration class names to the given array.

migrator::set_migration_state() — Method in class migrator

Insert/Update migration row into the database

sql_insert_bufferClass in namespace phpbb\db

Collects rows for insert into a database until the buffer size is reached.

mssql::sql_list_tables() — Method in class mssql

Gets a list of tables in the database.

mssql::sql_create_table() — Method in class mssql

Create SQL Table

mssql::sql_list_columns() — Method in class mssql

Gets a list of columns of a table.

mssql::sql_index_exists() — Method in class mssql

Check if a specified index exists in table. Does not return PRIMARY KEY and UNIQUE indexes.

mssql::sql_unique_index_exists() — Method in class mssql

Check if a specified index exists in table.

mssql::sql_prepare_column_data() — Method in class mssql
{@inheritDoc}
mssql::sql_column_add() — Method in class mssql

Add new column

mssql::sql_column_remove() — Method in class mssql

Drop column

mssql::sql_index_drop() — Method in class mssql

Drop Index

mssql::sql_table_drop() — Method in class mssql

Drop Table

mssql::sql_create_primary_key() — Method in class mssql

Add primary key

mssql::sql_create_unique_index() — Method in class mssql

Add unique index

mssql::sql_create_index() — Method in class mssql

Add index

mssql::sql_list_index() — Method in class mssql

List all of the indices that belong to a table

mssql::sql_column_change() — Method in class mssql

Change column type (not name!)

postgres::sql_list_tables() — Method in class postgres

Gets a list of tables in the database.

postgres::sql_table_exists() — Method in class postgres

Check if table exists

postgres::sql_create_table() — Method in class postgres

Create SQL Table

postgres::sql_list_columns() — Method in class postgres

Gets a list of columns of a table.

postgres::sql_index_exists() — Method in class postgres

Check if a specified index exists in table. Does not return PRIMARY KEY and UNIQUE indexes.

postgres::sql_unique_index_exists() — Method in class postgres

Check if a specified index exists in table.

postgres::sql_column_add() — Method in class postgres

Add new column

postgres::sql_column_remove() — Method in class postgres

Drop column

postgres::sql_index_drop() — Method in class postgres

Drop Index

postgres::sql_table_drop() — Method in class postgres

Drop Table

postgres::sql_create_primary_key() — Method in class postgres

Add primary key

postgres::sql_create_unique_index() — Method in class postgres

Add unique index

postgres::sql_create_index() — Method in class postgres

Add index

postgres::sql_list_index() — Method in class postgres

List all of the indices that belong to a table

postgres::sql_column_change() — Method in class postgres

Change column type (not name!)

sqlite3Class in namespace phpbb\db\tools

Database Tools for handling cross-db actions such as altering columns, etc.

sqlite3::sql_table_exists() — Method in class sqlite3

Check if table exists

$ tools#sql_layerProperty in class tools

Current sql layer

tools::set_return_statements() — Method in class tools

Setter for $return_statements return_statements.

tools::sql_list_tables() — Method in class tools

Gets a list of tables in the database.

tools::sql_table_exists() — Method in class tools

Check if table exists

tools::sql_create_table() — Method in class tools

Create SQL Table

tools::sql_list_columns() — Method in class tools

Gets a list of columns of a table.

tools::sql_column_exists() — Method in class tools

Check whether a specified column exist in a table

tools::sql_index_exists() — Method in class tools

Check if a specified index exists in table. Does not return PRIMARY KEY and UNIQUE indexes.

tools::sql_unique_index_exists() — Method in class tools

Check if a specified index exists in table.

tools::sql_column_add() — Method in class tools

Add new column

tools::sql_column_remove() — Method in class tools

Drop column

tools::sql_index_drop() — Method in class tools

Drop Index

tools::sql_table_drop() — Method in class tools

Drop Table

tools::sql_create_primary_key() — Method in class tools

Add primary key

tools::sql_create_unique_index() — Method in class tools

Add unique index

tools::sql_create_index() — Method in class tools

Add index

tools::sql_list_index() — Method in class tools

List all of the indices that belong to a table

tools::strip_table_name_from_index_name() — Method in class tools

Removes table_name from the index_name if it is at the beginning

tools::sql_column_change() — Method in class tools

Change column type (not name!)

tools::sqlite_get_recreate_table_queries() — Method in class tools

Returns the Queries which are required to recreate a table including indexes

tools_interface::sql_list_tables() — Method in class tools_interface

Gets a list of tables in the database.

tools_interface::sql_table_exists() — Method in class tools_interface

Check if table exists

tools_interface::sql_create_table() — Method in class tools_interface

Create SQL Table

tools_interface::sql_table_drop() — Method in class tools_interface

Drop Table

tools_interface::sql_list_columns() — Method in class tools_interface

Gets a list of columns of a table.

tools_interface::sql_column_exists() — Method in class tools_interface

Check whether a specified column exist in a table

tools_interface::sql_column_add() — Method in class tools_interface

Add new column

tools_interface::sql_column_change() — Method in class tools_interface

Change column type (not name!)

tools_interface::sql_column_remove() — Method in class tools_interface

Drop column

tools_interface::sql_list_index() — Method in class tools_interface

List all of the indices that belong to a table

tools_interface::sql_index_exists() — Method in class tools_interface

Check if a specified index exists in table. Does not return PRIMARY KEY and UNIQUE indexes.

tools_interface::sql_create_index() — Method in class tools_interface

Add index

tools_interface::sql_index_drop() — Method in class tools_interface

Drop Index

tools_interface::sql_unique_index_exists() — Method in class tools_interface

Check if a specified index exists in table.

tools_interface::sql_create_unique_index() — Method in class tools_interface

Add unique index

tools_interface::sql_create_primary_key() — Method in class tools_interface

Add primary key

$ ordered_service_collection#service_idsProperty in class ordered_service_collection
ordered_service_collection::sort_services() — Method in class ordered_service_collection
service_collectionClass in namespace phpbb\di

Collection of services to be configured at container compile time.

$ service_collection#service_classesProperty in class service_collection
service_collection_iteratorClass in namespace phpbb\di

Iterator which loads the services when they are requested

php_exporter::set_current_event() — Method in class php_exporter

Set current event data

php_exporter::set_content() — Method in class php_exporter

Set the content of this file

rst_exporter::set_columns() — Method in class rst_exporter

Set columns with array where key is column name and value is title of column in table

$ base#sqlProperty in class base

SQL Query to be executed to get feed items

$ base#separatorProperty in class base

Separator for title elements to separate items (for example forum / topic)

$ base#separator_statsProperty in class base

Separator for the statistics row (Posted by, post date, replies, etc.)

base::set_keys() — Method in class base

Set keys.

base::set() — Method in class base

Set key

feed::send_feed() — Method in class feed

Display a given feed

feed::send_feed_do() — Method in class feed

Really send the feed

feed::send_unavailable() — Method in class feed

Throw and exception saying that the feed isn't available

feed_interface::set_keys() — Method in class feed_interface

Set keys.

feed_interface::set() — Method in class feed_interface

Set key

forum::set_forum_id() — Method in class forum

Set the Forum ID

forums::set_keys() — Method in class forums

Set keys.

post_base::set_keys() — Method in class post_base

Set keys.

topic::set_topic_id() — Method in class topic

Set the Topic ID

topic_base::set_keys() — Method in class topic_base

Set keys.

$ topics_active#sort_daysProperty in class topics_active
topics_active::set_keys() — Method in class topics_active

Set keys.

filespec::set_upload_ary() — Method in class filespec

Set upload ary

filespec::set_upload_namespace() — Method in class filespec

Set the upload namespace

filespec::set_error() — Method in class filespec

Set error in error array

base::set_upload() — Method in class base

Set upload instance Needs to be executed before every upload.

type_interface::set_upload() — Method in class type_interface

Set upload instance Needs to be executed before every upload.

upload::set_allowed_extensions() — Method in class upload

Set allowed extensions

upload::set_allowed_dimensions() — Method in class upload

Set allowed dimensions

upload::set_max_filesize() — Method in class upload

Set maximum allowed file size

upload::set_disallowed_content() — Method in class upload

Set disallowed strings

upload::set_error_prefix() — Method in class upload

Set error prefix

$ filesystem#symfony_filesystemProperty in class filesystem

Symfony's Filesystem component

filesystem::symlink() — Method in class filesystem

Creates a symbolic link or copy a directory.

filesystem_interface::symlink() — Method in class filesystem_interface

Creates a symbolic link or copy a directory.

finder::set_extensions() — Method in class finder

Set the array of extensions

finder::suffix() — Method in class finder

Sets the suffix all files found in extensions and core must match.

finder::sanitise_directory() — Method in class finder

Removes occurrences of /./ and makes sure path ends without trailing slash

$ manager#switched_columnProperty in class manager
manager::switched_column() — Method in class manager

Returns whether the block titles switched side

showClass in namespace phpbb\install\console\command\install\config
showClass in namespace phpbb\install\console\command\update\config
helper::sort_navigation_level() — Method in class helper

Sorts the top level of navigation array

timeout_check::status() — Method in class timeout_check

Controller for querying installer status

$ config#system_dataProperty in class config

Array containing system information

config::set() — Method in class config

Sets a parameter in installer_config

config::system_get() — Method in class config

Returns system parameter

config::set_finished_task() — Method in class config

Saves the latest executed task

config::set_active_module() — Method in class config

Set active module

config::save_config() — Method in class config

Dumps install configuration to disk

config::set_current_task_progress() — Method in class config

Sets the task progress to a specific number

config::set_task_progress_count() — Method in class config

Sets the number of tasks belonging to the installer in the current mode.

config::set_finished_navigation_stage() — Method in class config

Marks stage as completed in the navigation bar

config::set_active_navigation_stage() — Method in class config

Marks stage as active in the navigation bar

config::setup_system_data() — Method in class config

Filling up system_data array

ajax_iohandler::send_response() — Method in class ajax_iohandler

Renders or returns response message

ajax_iohandler::set_progress() — Method in class ajax_iohandler

Sets the progress information

ajax_iohandler::set_active_stage_menu() — Method in class ajax_iohandler

Marks stage as active in the navigation bar

ajax_iohandler::set_finished_stage_menu() — Method in class ajax_iohandler

Marks stage as completed in the navigation bar

ajax_iohandler::set_cookie() — Method in class ajax_iohandler

Sends and sets cookies

cli_iohandler::set_style() — Method in class cli_iohandler

Set the style and output used to display feedback;

cli_iohandler::set_input() — Method in class cli_iohandler

Set input variable

cli_iohandler::send_response() — Method in class cli_iohandler

Renders or returns response message

cli_iohandler::set_task_count() — Method in class cli_iohandler

Sets the number of tasks belonging to the installer in the current mode.

cli_iohandler::set_progress() — Method in class cli_iohandler

Sets the progress information

cli_iohandler::set_active_stage_menu() — Method in class cli_iohandler

Marks stage as active in the navigation bar

cli_iohandler::set_finished_stage_menu() — Method in class cli_iohandler

Marks stage as completed in the navigation bar

cli_iohandler::set_cookie() — Method in class cli_iohandler

Sends and sets cookies

factory::set_environment() — Method in class factory
$ iohandler_base#successProperty in class iohandler_base

Array of success messages

iohandler_base::set_language() — Method in class iohandler_base

Set language service

iohandler_base::set_task_count() — Method in class iohandler_base

Sets the number of tasks belonging to the installer in the current mode.

iohandler_base::set_progress() — Method in class iohandler_base

Sets the progress information

iohandler_interface::send_response() — Method in class iohandler_interface

Renders or returns response message

iohandler_interface::set_task_count() — Method in class iohandler_interface

Sets the number of tasks belonging to the installer in the current mode.

iohandler_interface::set_progress() — Method in class iohandler_interface

Sets the progress information

iohandler_interface::set_active_stage_menu() — Method in class iohandler_interface

Marks stage as active in the navigation bar

iohandler_interface::set_finished_stage_menu() — Method in class iohandler_interface

Marks stage as completed in the navigation bar

iohandler_interface::set_cookie() — Method in class iohandler_interface

Sends and sets cookies

navigation_provider::set_nav_property() — Method in class navigation_provider

Set a property in the navigation array

installer::set_modules() — Method in class installer

Sets modules to execute

installer::set_iohandler() — Method in class installer

Sets input-output handler objects

installer::set_purge_cache_before() — Method in class installer

Sets whether to purge cache before the installation process

check_filesystem::set_test_passed() — Method in class check_filesystem

Sets $this->tests_passed

check_server_environment::set_test_passed() — Method in class check_server_environment

Sets $this->tests_passed

check_update::set_test_passed() — Method in class check_update

Sets $this->tests_passed

show_file_statusClass in namespace phpbb\install\module\update_filesystem\task
module_base::setup() — Method in class module_base

Dependency getter

json_response::send() — Method in class json_response

Send the data to the client and exit the script.

language::set_user_language() — Method in class language

Function to set user's language to display.

language::set_default_language() — Method in class language

Function to set the board's default language to display.

language::set_fallback_array() — Method in class language

Returns language fallback data

language_file_loader::set_extension_manager() — Method in class language_file_loader

Extension manager setter

log::set_is_admin() — Method in class log

Set is_in_admin in order to return administrative user profile links in get_logs()

log::set_log_table() — Method in class log

Set table name

$ admin_form#subjectProperty in class admin_form
$ admin_form#sender_nameProperty in class admin_form
$ admin_form#sender_addressProperty in class admin_form
admin_form::submit() — Method in class admin_form
{inheritDoc}
form::submit() — Method in class form

Submit form, generate the email and send it

$ message#server_nameProperty in class message
$ message#subjectProperty in class message
$ message#sender_ipProperty in class message
$ message#sender_nameProperty in class message
$ message#sender_addressProperty in class message
$ message#sender_langProperty in class message
$ message#sender_idProperty in class message
$ message#sender_usernameProperty in class message
$ message#sender_jabberProperty in class message
$ message#sender_notify_typeProperty in class message
message::set_subject() — Method in class message

Set the subject of the email

message::set_body() — Method in class message

Set the body of the email text

message::set_template() — Method in class message

Set the name of the email template to use

message::set_template_vars() — Method in class message

Set the array with the "template" data for the email

message::set_sender_from_user() — Method in class message

Set the senders data from \phpbb\user object

message::set_sender() — Method in class message

Set the senders data

message::set_sender_notify_type() — Method in class message

Which notification type should be used? Jabber, Email, ...?

message::send() — Method in class message

Send the email

topic_form::submit() — Method in class topic_form
{inheritDoc}
$ user_form#subjectProperty in class user_form
user_form::submit() — Method in class user_form
{inheritDoc}
guesser::sort_priority() — Method in class guesser

Sort the priority of supplied guessers This is a compare function for usort. A guesser with higher priority should be used first and vice versa. usort() orders the array values from low to high depending on what the comparison function returns to it. Return value should be smaller than 0 if value a is smaller than value b. This has been reversed in the comparison function in order to sort the guessers from high to low.

guesser_base::set_priority() — Method in class guesser_base

Set the guesser priority

guesser_interface::set_priority() — Method in class guesser_interface

Set the guesser priority

$ manager#subscription_typesProperty in class manager
base::set_notification_manager() — Method in class base

Set notification manager (required)

admin_activate_user::set_config() — Method in class admin_activate_user
admin_activate_user::set_user_loader() — Method in class admin_activate_user
base::set_notification_manager() — Method in class base

Set notification manager (required)

base::set_initial_data() — Method in class base

Set initial data from the database

base::set_data() — Method in class base

Set special data (only important for the classes that extend this)

group_request::set_user_loader() — Method in class group_request
pm::set_config() — Method in class pm
pm::set_user_loader() — Method in class pm
post::set_config() — Method in class post
post::set_user_loader() — Method in class post
quote::set_utils() — Method in class quote

Set the utils service used to retrieve quote authors

topic::set_config() — Method in class topic
topic::set_user_loader() — Method in class topic
type_interface::set_initial_data() — Method in class type_interface

Set initial data from the database

helper::string_compare() — Method in class helper

Compare two strings byte by byte

$ md5_phpbb2#salted_md5Property in class md5_phpbb2
salted_md5Class in namespace phpbb\passwords\driver
sha1Class in namespace phpbb\passwords\driver
sha1_smfClass in namespace phpbb\passwords\driver
sha1_wcf1Class in namespace phpbb\passwords\driver
sha_xf1Class in namespace phpbb\passwords\driver
$ path_helper#symfony_requestProperty in class path_helper
path_helper::strip_url_params() — Method in class path_helper

Strip parameters from an already built URL.

plupload::set_default_directories() — Method in class plupload

Sets the default directories for uploads

plupload::set_upload_directories() — Method in class plupload

Sets the upload directories to the specified paths

manager::submit_cp_field() — Method in class manager

Submit profile field for validation.

$ request#super_globalsProperty in class request
$ request#super_globals_disabledProperty in class request
request::super_globals_disabled() — Method in class request

Getter for $super_globals_disabled

request::server() — Method in class request

Shortcut method to retrieve SERVER variables.

request_interface::server() — Method in class request_interface

Shortcut method to retrieve SERVER variables.

type_cast_helper::set_var() — Method in class type_cast_helper

Set variable $result to a particular type.

type_cast_helper_interface::set_var() — Method in class type_cast_helper_interface

Set variable $result to a particular type.

$ helper#symfony_requestProperty in class helper
router::setContext() — Method in class router
{@inheritdoc}
base::search_backend() — Method in class base
base::save_ids() — Method in class base

Caches post/topic ids

$ fulltext_mysql#statsProperty in class fulltext_mysql

Associative array holding index stats

$ fulltext_mysql#split_wordsProperty in class fulltext_mysql

Holds the words entered by user, obtained by splitting the entered query on whitespace

$ fulltext_mysql#search_queryProperty in class fulltext_mysql

Contains tidied search query.

fulltext_mysql::split_keywords() — Method in class fulltext_mysql

Splits keywords entered by a user into an array of words stored in $this->split_words Stores the tidied search query in $this->search_query

fulltext_mysql::split_message() — Method in class fulltext_mysql

Turns text into an array of words

$ fulltext_native#statsProperty in class fulltext_native

Associative array holding index stats

$ fulltext_native#search_queryProperty in class fulltext_native

Contains tidied search query.

fulltext_native::split_keywords() — Method in class fulltext_native

This function fills $this->search_query with the cleaned user search query

fulltext_native::split_message() — Method in class fulltext_native

Split a text into words of a given length

$ fulltext_postgres#statsProperty in class fulltext_postgres

Associative array holding index stats

$ fulltext_postgres#split_wordsProperty in class fulltext_postgres

Holds the words entered by user, obtained by splitting the entered query on whitespace

$ fulltext_postgres#search_queryProperty in class fulltext_postgres

Contains tidied search query.

fulltext_postgres::supports_phrase_search() — Method in class fulltext_postgres

Returns if phrase search is supported or not

fulltext_postgres::split_keywords() — Method in class fulltext_postgres

Splits keywords entered by a user into an array of words stored in $this->split_words Stores the tidied search query in $this->search_query

fulltext_postgres::split_message() — Method in class fulltext_postgres

Turns text into an array of words

$ fulltext_sphinx#statsProperty in class fulltext_sphinx

Associative array holding index stats

$ fulltext_sphinx#split_wordsProperty in class fulltext_sphinx

Holds the words entered by user, obtained by splitting the entered query on whitespace

$ fulltext_sphinx#sphinxProperty in class fulltext_sphinx

Sphinx searchd client object

$ fulltext_sphinx#search_queryProperty in class fulltext_sphinx

Contains tidied search query.

fulltext_sphinx::split_keywords() — Method in class fulltext_sphinx

Splits keywords entered by a user into an array of words stored in $this->split_words Stores the tidied search query in $this->search_query

fulltext_sphinx::sphinx_clean_search_string() — Method in class fulltext_sphinx

Cleans search query passed into Sphinx search engine, as follows:

  1. Hyphenated words are replaced with keyword search for either the exact phrase with spaces or as a single word without spaces eg search for "know-it-all" becomes ("know it all"|"knowitall*")
  2. Words with apostrophes are contracted eg "it's" becomes "its"
  3. <, >, " and & are decoded from HTML entities.
config_section::set_end_comment() — Method in class config_section

Adds a comment after the closing bracket in the textual representation

config_variable::set_value() — Method in class config_variable

Allows changing the variable's value

sessionClass in namespace phpbb

Session class

$ session#session_idProperty in class session
session::session_begin() — Method in class session

Start session management

session::session_create() — Method in class session

Create a new session

session::session_kill() — Method in class session

Kills a session

session::session_gc() — Method in class session

Session garbage collection

session::set_cookie() — Method in class session

Sets a cookie

session::set_login_key() — Method in class session

Set/Update a persistent login key

symfony_requestClass in namespace phpbb

WARNING: The Symfony request does not escape the input and should be used very carefully prefer the phpbb request as possible

asset::set_url() — Method in class asset

Set URL

asset::set_path() — Method in class asset

Set path component

$ assets_bag#stylesheetsProperty in class assets_bag
$ assets_bag#scriptsProperty in class assets_bag
base::set_filenames() — Method in class base

Sets the template filenames for handles.

context::set_num_rows() — Method in class context

Set S_NUM_ROWS for each row in this template block

template::set_filenames() — Method in class template

Sets the template filenames for handles.

template::set_style() — Method in class template

Set style location based on (current) user's chosen style.

template::set_custom_style() — Method in class template

Set custom style location (able to use directory outside of phpBB).

definition::set() — Method in class definition

DEFINE a variable

environment::setNamespaceLookUpOrder() — Method in class environment

Set the namespace look up order to load templates from

lexer::strip_surrounding_quotes() — Method in class lexer

Strip surrounding quotes

$ loader#safe_directoriesProperty in class loader
loader::setSafeDirectories() — Method in class loader

Set safe directories

twig::set_style() — Method in class twig

Set style location based on (current) user's chosen style.

twig::set_custom_style() — Method in class twig

Set custom style location (able to use directory outside of phpBB).

parser_interface::set_var() — Method in class parser_interface

Set a variable to be used by the parser

parser_interface::set_vars() — Method in class parser_interface

Set multiple variables to be used by the parser

renderer_interface::set_smilies_path() — Method in class renderer_interface

Set the smilies' path

renderer_interface::set_viewcensors() — Method in class renderer_interface

Set the "viewcensors" option

renderer_interface::set_viewflash() — Method in class renderer_interface

Set the "viewflash" option

renderer_interface::set_viewimg() — Method in class renderer_interface

Set the "viewimg" option

renderer_interface::set_viewsmilies() — Method in class renderer_interface

Set the "viewsmilies" option

link_helper::should_shorten() — Method in class link_helper

Test whether we should shorten this tag's text

parser::set_var() — Method in class parser

Set a variable to be used by the parser

parser::set_vars() — Method in class parser

Set multiple variables to be used by the parser

renderer::set_smilies_path() — Method in class renderer

Set the smilies' path

renderer::set_viewcensors() — Method in class renderer

Set the "viewcensors" option

renderer::set_viewflash() — Method in class renderer

Set the "viewflash" option

renderer::set_viewimg() — Method in class renderer

Set the "viewimg" option

renderer::set_viewsmilies() — Method in class renderer

Set the "viewsmilies" option

$ base#save_changesProperty in class base
base::save_record() — Method in class base
{@inheritdoc}
base::set_name() — Method in class base

Sets the name of the reparser

manager::schedule() — Method in class manager

Sets the interval for a text_reparser cron task

manager::schedule_all() — Method in class manager

Sets the interval for all text_reparser cron tasks

contact_admin_info::save_record() — Method in class contact_admin_info
{@inheritdoc}
poll_option::save_record() — Method in class poll_option
{@inheritdoc}
user_signature::save_keyoptions() — Method in class user_signature

Save the keyoptions var from \phpbb\user

reparser_interface::set_name() — Method in class reparser_interface

Sets the name of the reparser

row_based_plugin::save_record() — Method in class row_based_plugin
{@inheritdoc}
$ nestedset#sql_whereProperty in class nestedset

Additional SQL restrictions Allows to have multiple nested sets in one table

$ user#styleProperty in class user
user::setup() — Method in class user

Setup basic user-specific items (style, language, ...)

version_helper::set_file_location() — Method in class version_helper

Set location to the file

version_helper::set_current_version() — Method in class version_helper

Set current version

queue::save() — Method in class queue

Save queue

smtp_classClass in namespace [Global Namespace]

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

$ smtp_class#server_responseProperty in class smtp_class
$ smtp_class#socketProperty in class smtp_class
$ smtp_class#socket_tlsProperty in class smtp_class
smtp_class::server_send() — Method in class smtp_class

Send command to smtp server

smtp_class::server_parse() — Method in class smtp_class

We use the line to give the support people an indication at which command the error occurred

smtp_class::starttls() — Method in class smtp_class

SMTP STARTTLS (RFC 3207)

T

$ acp_attachments#templateProperty in class acp_attachments
acp_attachments::test_upload() — Method in class acp_attachments

Test Settings

acp_board::timezone_select() — Method in class acp_board

Select guest timezone

$ acp_extensions#tpl_nameProperty in class acp_extensions
$ acp_profile#type_collectionProperty in class acp_profile
$ acp_styles#templateProperty in class acp_styles
$ acp_styles#text_formatter_cacheProperty in class acp_styles
$ bbcode#template_bitfieldProperty in class bbcode
$ compress_tar#typeProperty in class compress_tar
diff::trim_newlines() — Method in class diff

Removes trailing newlines from a line of text. This is meant to be used with array_walk().

$ jabber#timeoutProperty in class jabber
$ messenger#templateProperty in class messenger
messenger::to() — Method in class messenger

Sets an email address to send to

messenger::template() — Method in class messenger

Set email template to use

twitterClass in namespace phpbb\auth\provider\oauth\service

Twitter OAuth service

token_storageClass in namespace phpbb\auth\provider\oauth

OAuth storage wrapper for phpBB's cache

driver_interface::tidy() — Method in class driver_interface

Tidy cache

dummy::tidy() — Method in class dummy

Tidy cache

file::tidy() — Method in class file

Tidy cache

memory::tidy() — Method in class memory

Tidy cache

$ captcha_abstract#typeProperty in class captcha_abstract
$ qa#typeProperty in class qa
$ qa#table_captcha_questionsProperty in class qa
$ qa#table_captcha_answersProperty in class qa
$ qa#table_qa_confirmProperty in class qa
$ db#tableProperty in class db

Name of the database table used for configuration.

$ db_text#tableProperty in class db_text

Name of the database table used.

$ helper#templateProperty in class helper
$ resolver#templateProperty in class resolver

phpbb\template\template object

$ resolver#type_cast_helperProperty in class resolver

Request type cast helper object

$ convertor#templateProperty in class convertor
$ convert#tablesProperty in class convert
$ convert#truncate_statementProperty in class convert
$ convertor#templateProperty in class convertor
$ manager#tasksProperty in class manager

Set of \phpbb\cron\task\wrapper objects.

$ manager#templateProperty in class manager
tidy_cacheClass in namespace phpbb\cron\task\core

Tidy cache cron task.

tidy_pluploadClass in namespace phpbb\cron\task\core

Cron task for cleaning plupload's temporary upload directory.

tidy_searchClass in namespace phpbb\cron\task\core

Tidy search cron task.

tidy_sessionsClass in namespace phpbb\cron\task\core

Tidy sessions cron task.

tidy_warningsClass in namespace phpbb\cron\task\core

Tidy warnings cron task.

taskClass in namespace phpbb\cron\task

Cron task interface

$ wrapper#taskProperty in class wrapper
$ wrapper#templateProperty in class wrapper
$ driver#transactionProperty in class driver
$ driver#transactionsProperty in class driver
$ base_extractor#timeProperty in class base_extractor
$ migration#table_prefixProperty in class migration
$ schema_generator#table_prefixProperty in class schema_generator
$ schema_generator#tablesProperty in class schema_generator
tool_interfaceClass in namespace phpbb\db\migration\tool

Migration tool interface

$ migrator#table_prefixProperty in class migrator
migrator::try_apply() — Method in class migrator

Attempts to apply a step of the given migration or one of its dependencies

migrator::try_revert() — Method in class migrator

Attempts to revert a step of the given migration or one of its dependencies

$ sql_insert_buffer#table_nameProperty in class sql_insert_buffer
toolsClass in namespace phpbb\db\tools

Database Tools for handling cross-db actions such as altering columns, etc.

tools_interfaceClass in namespace phpbb\db\tools

Interface for a Database Tools for handling cross-db actions such as altering columns, etc.

tablesClass in namespace phpbb\di\extension

Container tables extension

dispatcher::trigger_event() — Method in class dispatcher

Construct and dispatch an event

dispatcher_interface::trigger_event() — Method in class dispatcher_interface

Construct and dispatch an event

$ kernel_exception_subscriber#templateProperty in class kernel_exception_subscriber

Template object

$ kernel_exception_subscriber#type_casterProperty in class kernel_exception_subscriber
$ feed#templateProperty in class feed
feed::topics() — Method in class feed

Controller for /feed/topics route

feed::topics_new() — Method in class feed

Controller for /feed/topics_new route

feed::topics_active() — Method in class feed

Controller for /feed/topics_active route

feed::topic() — Method in class feed

Controller for /feed/topic/{topic_id} route

topicClass in namespace phpbb\feed

Topic feed for a specific topic

$ topic#topic_idProperty in class topic
$ topic#topic_dataProperty in class topic
topic_baseClass in namespace phpbb\feed

Abstract class for topic based feeds

topicsClass in namespace phpbb\feed

New Topics feed

topics_activeClass in namespace phpbb\feed

Active Topics feed

type_interfaceClass in namespace phpbb\files\types
filesystem::touch() — Method in class filesystem

Sets access and modification time of file.

filesystem::to_iterator() — Method in class filesystem

Convert file(s) to \Traversable object

filesystem_interface::touch() — Method in class filesystem_interface

Sets access and modification time of file.

teampageClass in namespace phpbb\groupposition

Teampage group position class

$ controller#templateProperty in class controller
$ help#templateProperty in class help
$ manager#templateProperty in class manager
$ helper#templateProperty in class helper
$ install#templateProperty in class install
$ installer_index#templateProperty in class installer_index
timeout_checkClass in namespace phpbb\install\controller
$ update#templateProperty in class update
$ kernel_exception_subscriber#templateProperty in class kernel_exception_subscriber
$ ftp_file_updater#transferProperty in class ftp_file_updater
$ ajax_iohandler#templateProperty in class ajax_iohandler
$ iohandler_base#task_progress_countProperty in class iohandler_base
iohandler_base::translate_message() — Method in class iohandler_base

Localize message.

$ check_filesystem#tests_passedProperty in class check_filesystem
$ check_server_environment#tests_passedProperty in class check_server_environment
$ check_update#tests_passedProperty in class check_update
$ module_base#task_collectionProperty in class module_base

Array of tasks for installer module

$ module_base#task_step_countProperty in class module_base
task_baseClass in namespace phpbb\install

Base class for installer task

task_interfaceClass in namespace phpbb\install

Interface for installer tasks

$ message#templateProperty in class message
$ message#template_varsProperty in class message
topic_formClass in namespace phpbb\message

Class topic_form Form used to send topics as notification emails

$ topic_form#topic_idProperty in class topic_form
$ topic_form#topic_rowProperty in class topic_form
post::trim_user_ary() — Method in class post

Trim the user array passed down to 3 users if the array contains more than 4 users.

topicClass in namespace phpbb\notification\type

Topic notifications class This class handles notifications for new topics

topic_in_queueClass in namespace phpbb\notification\type

Topic in queue notifications class This class handles notifications for topics when they are put in the moderation queue (for moderators)

type_interfaceClass in namespace phpbb\notification\type

Base notifications interface

$ pagination#templateProperty in class pagination
$ argon2i#threadsProperty in class argon2i
$ argon2i#time_costProperty in class argon2i
$ manager#typeProperty in class manager

Default hashing method

$ manager#type_mapProperty in class manager

Hashing algorithm type map Will be used to map hash prefix to type

$ permissions#typesProperty in class permissions
$ plupload#temporary_directoryProperty in class plupload

Temporary upload directory for plupload uploads.

plupload::temporary_filepath() — Method in class plupload
$ manager#templateProperty in class manager
$ manager#type_collectionProperty in class manager
type_baseClass in namespace phpbb\profilefields\type
$ type_base#templateProperty in class type_base

Template object

type_boolClass in namespace phpbb\profilefields\type
$ type_bool#templateProperty in class type_bool

Template object

type_dateClass in namespace phpbb\profilefields\type
$ type_date#templateProperty in class type_date

Template object

type_dropdownClass in namespace phpbb\profilefields\type
$ type_dropdown#templateProperty in class type_dropdown

Template object

type_intClass in namespace phpbb\profilefields\type
$ type_int#templateProperty in class type_int

Template object

type_interfaceClass in namespace phpbb\profilefields\type
type_stringClass in namespace phpbb\profilefields\type
$ type_string#templateProperty in class type_string

Template object

type_string_commonClass in namespace phpbb\profilefields\type
type_textClass in namespace phpbb\profilefields\type
$ type_text#templateProperty in class type_text

Template object

type_urlClass in namespace phpbb\profilefields\type
$ report#templateProperty in class report
$ report_reason_list_provider#templateProperty in class report_reason_list_provider
$ request#type_cast_helperProperty in class request
type_cast_helperClass in namespace phpbb\request

A helper class that provides convenience methods for type casting.

type_cast_helper_interfaceClass in namespace phpbb\request

An interface for type cast operations.

fulltext_mysql::tidy() — Method in class fulltext_mysql

Destroy old cache entries

fulltext_native::tidy() — Method in class fulltext_native

Tidy up indexes: Tag 'common words' and remove words no longer referenced in the match table

$ fulltext_postgres#tsearch_queryProperty in class fulltext_postgres

Stores the tsearch query

fulltext_postgres::tidy() — Method in class fulltext_postgres

Destroy old cache entries

fulltext_sphinx::tidy() — Method in class fulltext_sphinx

Nothing needs to be destroyed

config_comment::to_string() — Method in class config_comment

Simply returns the comment as it was created

config_section::to_string() — Method in class config_section

Turns this object into a string which can be written to a config file

config_variable::to_string() — Method in class config_variable

Turns this object into a string readable by sphinx

$ session#time_nowProperty in class session
templateClass in namespace phpbb\template
lexer::tokenize() — Method in class lexer
twigClass in namespace phpbb\template\twig

Twig Template class.

$ twig#twigProperty in class twig

Twig Environment

cache_interface::tidy() — Method in class cache_interface

Tidy/prune this text formatter's cache(s)

factory::tidy() — Method in class factory

Tidy/prune this text formatter's cache(s)

link_helper::truncate_local_url() — Method in class link_helper

Remove the board's root URL from a the start of a string

link_helper::truncate_text() — Method in class link_helper

Truncate the replacement text set in a LINK_TEXT tag

$ row_based_plugin#tableProperty in class row_based_plugin
$ nestedset#table_nameProperty in class nestedset
tree_interfaceClass in namespace phpbb\tree
$ reset_password#templateProperty in class reset_password
$ user#timezoneProperty in class user

DateTimeZone object holding the timezone of the user

transferClass in namespace [Global Namespace]

Transfer class, wrapper for ftp/sftp/ssh

$ transfer#timeoutProperty in class transfer
$ transfer#tmp_pathProperty in class transfer

U

SphinxClient::UpdateAttributes() — Method in class SphinxClient
$ acp_attachments#userProperty in class acp_attachments
$ acp_attachments#u_actionProperty in class acp_attachments
acp_attachments_info::uninstall() — Method in class acp_attachments_info
$ acp_ban#u_actionProperty in class acp_ban
acp_ban_info::uninstall() — Method in class acp_ban_info
$ acp_bbcodes#u_actionProperty in class acp_bbcodes
acp_bbcodes_info::uninstall() — Method in class acp_bbcodes_info
$ acp_board#u_actionProperty in class acp_board
acp_board::username_length() — Method in class acp_board

Maximum/Minimum username length

acp_board_info::uninstall() — Method in class acp_board_info
$ acp_bots#u_actionProperty in class acp_bots
acp_bots_info::uninstall() — Method in class acp_bots_info
$ acp_captcha#u_actionProperty in class acp_captcha
acp_captcha_info::uninstall() — Method in class acp_captcha_info
$ acp_contact#u_actionProperty in class acp_contact
$ acp_disallow#u_actionProperty in class acp_disallow
acp_disallow_info::uninstall() — Method in class acp_disallow_info
$ acp_email#u_actionProperty in class acp_email
acp_email_info::uninstall() — Method in class acp_email_info
$ acp_extensions#u_actionProperty in class acp_extensions
acp_extensions_info::uninstall() — Method in class acp_extensions_info
$ acp_forums#u_actionProperty in class acp_forums
acp_forums::update_forum_data() — Method in class acp_forums

Update forum data

acp_forums_info::uninstall() — Method in class acp_forums_info
$ acp_groups#u_actionProperty in class acp_groups
acp_groups_info::uninstall() — Method in class acp_groups_info
$ acp_help_phpbb#u_actionProperty in class acp_help_phpbb
acp_help_phpbb_info::uninstall() — Method in class acp_help_phpbb_info
$ acp_icons#u_actionProperty in class acp_icons
acp_icons_info::uninstall() — Method in class acp_icons_info
$ acp_inactive#u_actionProperty in class acp_inactive
acp_inactive_info::uninstall() — Method in class acp_inactive_info
$ acp_jabber#u_actionProperty in class acp_jabber
acp_jabber_info::uninstall() — Method in class acp_jabber_info
$ acp_language#u_actionProperty in class acp_language
acp_language_info::uninstall() — Method in class acp_language_info
$ acp_logs#u_actionProperty in class acp_logs
acp_logs_info::uninstall() — Method in class acp_logs_info
$ acp_main#u_actionProperty in class acp_main
acp_main_info::uninstall() — Method in class acp_main_info
$ acp_modules#u_actionProperty in class acp_modules
acp_modules_info::uninstall() — Method in class acp_modules_info
$ acp_permission_roles#u_actionProperty in class acp_permission_roles
acp_permission_roles_info::uninstall() — Method in class acp_permission_roles_info
$ acp_permissions#u_actionProperty in class acp_permissions
acp_permissions_info::uninstall() — Method in class acp_permissions_info
$ acp_php_info#u_actionProperty in class acp_php_info
acp_php_info_info::uninstall() — Method in class acp_php_info_info
$ acp_profile#u_actionProperty in class acp_profile
acp_profile::update_insert() — Method in class acp_profile

Update, then insert if not successfull

acp_profile_info::uninstall() — Method in class acp_profile_info
$ acp_prune#u_actionProperty in class acp_prune
acp_prune_info::uninstall() — Method in class acp_prune_info
$ acp_ranks#u_actionProperty in class acp_ranks
acp_ranks_info::uninstall() — Method in class acp_ranks_info
$ acp_reasons#u_actionProperty in class acp_reasons
acp_reasons_info::uninstall() — Method in class acp_reasons_info
$ acp_search#u_actionProperty in class acp_search
acp_search_info::uninstall() — Method in class acp_search_info
$ acp_styles#u_actionProperty in class acp_styles
$ acp_styles#u_base_actionProperty in class acp_styles
$ acp_styles#userProperty in class acp_styles
acp_styles::update_styles_tree() — Method in class acp_styles

Update styles tree

acp_styles::uninstall_style() — Method in class acp_styles

Uninstall style

acp_styles_info::uninstall() — Method in class acp_styles_info
$ acp_update#u_actionProperty in class acp_update
acp_update_info::uninstall() — Method in class acp_update_info
$ acp_users#u_actionProperty in class acp_users
acp_users_info::uninstall() — Method in class acp_users_info
$ acp_words#u_actionProperty in class acp_words
acp_words_info::uninstall() — Method in class acp_words_info
compress::unique_filename() — Method in class compress

Checks if a file by that name as already been added and, if it has, returns a new, unique name.

compress_zip::unix_to_dos_time() — Method in class compress_zip

Convert unix to dos time

$ jabber#usernameProperty in class jabber
$ jabber#use_sslProperty in class jabber
$ mcp_ban#u_actionProperty in class mcp_ban
mcp_ban_info::uninstall() — Method in class mcp_ban_info
$ mcp_logs#u_actionProperty in class mcp_logs
mcp_logs_info::uninstall() — Method in class mcp_logs_info
$ mcp_main#u_actionProperty in class mcp_main
mcp_main_info::uninstall() — Method in class mcp_main_info
$ mcp_notes#u_actionProperty in class mcp_notes
mcp_notes_info::uninstall() — Method in class mcp_notes_info
$ mcp_pm_reports#u_actionProperty in class mcp_pm_reports
mcp_pm_reports_info::uninstall() — Method in class mcp_pm_reports_info
$ mcp_queue#u_actionProperty in class mcp_queue
mcp_queue_info::uninstall() — Method in class mcp_queue_info
$ mcp_reports#u_actionProperty in class mcp_reports
mcp_reports_info::uninstall() — Method in class mcp_reports_info
$ mcp_warn#u_actionProperty in class mcp_warn
mcp_warn_info::uninstall() — Method in class mcp_warn_info
$ messenger#use_queueProperty in class messenger
delete::unlink_attachment() — Method in class delete

Delete attachment from filesystem

$ manager#uploadProperty in class manager
manager::unlink() — Method in class manager

Wrapper method for deleting attachments from filesystem

manager::upload() — Method in class manager

Wrapper method for uploading attachment

uploadClass in namespace phpbb\attachment

Attachment upload class

$ upload#userProperty in class upload
upload::upload() — Method in class upload

Upload Attachment - filedata is generated here Uses upload class

$ apache#userProperty in class apache
base::unlink_account() — Method in class base

Unlinks an external account from a phpBB account.

$ db#userProperty in class db
$ ldap#userProperty in class ldap
$ oauth#userProperty in class oauth
$ oauth#users_tableProperty in class oauth
oauth::unlink_account() — Method in class oauth

Unlinks an external account from a phpBB account.

$ token_storage#userProperty in class token_storage
provider_interface::unlink_account() — Method in class provider_interface

Unlinks an external account from a phpBB account.

uploadClass in namespace phpbb\avatar\driver

Handles avatars uploaded to the board

base::unload() — Method in class base

Unload cache object

driver_interface::unload() — Method in class driver_interface

Unload cache object

dummy::unload() — Method in class dummy

Unload cache object

file::unload() — Method in class file

Unload cache object

memcached::unload() — Method in class memcached

Unload cache object

redis::unload() — Method in class redis

Unload cache object

captcha_abstract::uninstall() — Method in class captcha_abstract
qa::uninstall() — Method in class qa

API function - we don't drop the tables here, as that would cause the loss of all entered questions.

recaptcha::uninstall() — Method in class recaptcha
class_loader::unregister() — Method in class class_loader

Removes the class loader from the SPL autoloader stack.

$ command#userProperty in class command
$ fix_left_right_ids#userProperty in class fix_left_right_ids
update_hashesClass in namespace phpbb\console\command\fixup
$ activate#user_loaderProperty in class activate
$ delete#user_loaderProperty in class delete
$ content_visibility#userProperty in class content_visibility

User object

$ helper#userProperty in class helper
$ prune_shadow_topics#userProperty in class prune_shadow_topics
$ tidy_plupload#userProperty in class tidy_plupload
$ tidy_search#userProperty in class tidy_search

User object

$ tidy_sessions#userProperty in class tidy_sessions
update_hashesClass in namespace phpbb\cron\task\core

Update old hashes to the current default hashing algorithm

$ update_hashes#update_lockProperty in class update_hashes
$ datetime#userProperty in class datetime
$ driver#userProperty in class driver
migration::update_schema() — Method in class migration

Updates the database schema by providing a set of change instructions

migration::update_data() — Method in class migration

Updates data by returning a list of instructions to be executed

migration_interface::update_schema() — Method in class migration_interface

Updates the database schema by providing a set of change instructions

migration_interface::update_data() — Method in class migration_interface

Updates data by returning a list of instructions to be executed

$ profilefield_base_migration#user_column_nameProperty in class profilefield_base_migration
profilefield_base_migration::update_schema() — Method in class profilefield_base_migration

Updates the database schema by providing a set of change instructions

profilefield_base_migration::update_data() — Method in class profilefield_base_migration

Updates data by returning a list of instructions to be executed

config::update() — Method in class config

Update an existing config setting.

config::update_if_equals() — Method in class config

Update a config setting if the first argument equal to the current config value

config_text::update() — Method in class config_text

Update an existing config_text setting.

$ module#userProperty in class module
migrator::update() — Method in class migrator

Runs a single update step from the next migration to be applied.

migrator::update_do() — Method in class migrator

Effectively runs a single update step from the next migration to be applied.

migrator::unfulfillable() — Method in class migrator

Checks if a migration's dependencies can even theoretically be satisfied.

$ tools#unsigned_typesProperty in class tools

A list of types being unsigned for better reference in some db's

$ container_builder#use_extensionsProperty in class container_builder

Indicates whether extensions should be used (default to true).

$ container_builder#use_cacheProperty in class container_builder

Indicates whether the container should be dumped to the filesystem (default to true).

error_collector::uninstall() — Method in class error_collector
$ kernel_exception_subscriber#userProperty in class kernel_exception_subscriber

User object

manager::update_state() — Method in class manager

Update the database entry for an extension

$ base#userProperty in class base
base::user_viewprofile() — Method in class base

Returns the link to the user profile.

$ feed#userProperty in class feed
unauthorized_exceptionClass in namespace phpbb\feed\exception
unauthorized_forum_exceptionClass in namespace phpbb\feed\exception
unauthorized_topic_exceptionClass in namespace phpbb\feed\exception
$ helper#userProperty in class helper
$ filespec#uploadnameProperty in class filespec
$ filespec#uploadProperty in class filespec
$ base#uploadProperty in class base
$ form#uploadProperty in class form
form::upload() — Method in class form

Handle upload for upload types. Arguments passed to this method will be handled by the upload type classes themselves.

$ local#uploadProperty in class local
local::upload() — Method in class local

Handle upload for upload types. Arguments passed to this method will be handled by the upload type classes themselves.

$ remote#uploadProperty in class remote
remote::upload() — Method in class remote

Handle upload for upload types. Arguments passed to this method will be handled by the upload type classes themselves.

type_interface::upload() — Method in class type_interface

Handle upload for upload types. Arguments passed to this method will be handled by the upload type classes themselves.

uploadClass in namespace phpbb\files

File upload class Init class (all parameters optional and able to be set/overwritten separately) - scope is global and valid for all uploads

$ upload#upload_timeoutProperty in class upload
$ helper#userProperty in class helper
$ legend#userProperty in class legend

User object

$ teampage#userProperty in class teampage

User object

$ help#userProperty in class help
updateClass in namespace phpbb\install\console\command\update
archive_download::update_archive() — Method in class archive_download

Sends response with the updated files' archive

updateClass in namespace phpbb\install\controller

Updater controller

user_interaction_required_exceptionClass in namespace phpbb\install\exception

This exception should be thrown when user interaction is inevitable

$ container_factory#update_helperProperty in class container_factory
$ compression_file_updater#update_helperProperty in class compression_file_updater
compression_file_updater::update_file() — Method in class compression_file_updater

Update file

file_updater::update_file() — Method in class file_updater

Update file

file_updater_interface::update_file() — Method in class file_updater_interface

Update file

$ ftp_file_updater#update_helperProperty in class ftp_file_updater
ftp_file_updater::update_file() — Method in class ftp_file_updater

Update file

update_navigationClass in namespace phpbb\install\helper\navigation
update_helperClass in namespace phpbb\install\helper

General helper functionality for the updater

$ install_extensions#userProperty in class install_extensions
$ notify_user#userProperty in class notify_user
$ check_update#update_helperProperty in class check_update
update_moduleClass in namespace phpbb\install\module\requirements
$ diff_files#update_helperProperty in class diff_files
$ file_check#update_helperProperty in class file_check
update_filesClass in namespace phpbb\install\module\update_filesystem\task

File updater task

$ update_files#update_helperProperty in class update_files
updater_configurationClass in namespace phpbb\install
$ language#user_languageProperty in class language
$ log#userProperty in class log

User object

$ form#userProperty in class form
user_formClass in namespace phpbb\message

Class user_form Allows users to send emails to other users

module_manager::update_module_data() — Method in class module_manager

Update/Add module

$ manager#user_loaderProperty in class manager
$ manager#userProperty in class manager
$ manager#user_notifications_tableProperty in class manager
manager::update_notifications() — Method in class manager

Update notification

manager::update_notification() — Method in class manager

Update a notification

base::update_notification() — Method in class base

Update a notification

$ board#user_loaderProperty in class board
$ board#userProperty in class board
board::update_notification() — Method in class board

Update a notification

$ email#userProperty in class email
$ jabber#userProperty in class jabber
$ messenger_base#user_loaderProperty in class messenger_base
method_interface::update_notification() — Method in class method_interface

Update a notification

$ admin_activate_user#user_loaderProperty in class admin_activate_user
admin_activate_user::users_to_query() — Method in class admin_activate_user

Users needed to query before this notification can be displayed

$ base#userProperty in class base
$ base#user_notifications_tableProperty in class base
$ group_request#user_loaderProperty in class group_request
group_request::users_to_query() — Method in class group_request

Users needed to query before this notification can be displayed

group_request_approved::users_to_query() — Method in class group_request_approved

Users needed to query before this notification can be displayed

$ pm#user_loaderProperty in class pm
pm::users_to_query() — Method in class pm

Users needed to query before this notification can be displayed

$ post#user_loaderProperty in class post
post::users_to_query() — Method in class post

Users needed to query before this notification can be displayed

$ quote#utilsProperty in class quote
quote::update_notifications() — Method in class quote

Update a notification

report_pm::users_to_query() — Method in class report_pm

Users needed to query before this notification can be displayed

report_pm_closed::users_to_query() — Method in class report_pm_closed

Users needed to query before this notification can be displayed

report_post::users_to_query() — Method in class report_post

Users needed to query before this notification can be displayed

report_post_closed::users_to_query() — Method in class report_post_closed

Users needed to query before this notification can be displayed

$ topic#user_loaderProperty in class topic
topic::users_to_query() — Method in class topic

Users needed to query before this notification can be displayed

type_interface::users_to_query() — Method in class type_interface

Users needed to query before this notification can be displayed

$ pagination#userProperty in class pagination
helper::unique_id() — Method in class helper

Return unique id

path_helper::update_web_root_path() — Method in class path_helper

Update a web path to the correct relative root path

$ permissions#userProperty in class permissions

User object

$ plupload#userProperty in class plupload
$ plupload#upload_directoryProperty in class plupload

Final destination for uploaded files, i.e. the "files" directory.

$ manager#userProperty in class manager
manager::update_profile_field_data() — Method in class manager

Update profile field data directly.

$ type_base#userProperty in class type_base

User object

$ type_bool#userProperty in class type_bool

User object

$ type_date#userProperty in class type_date

User object

$ type_dropdown#userProperty in class type_dropdown

User object

$ type_int#userProperty in class type_int

User object

$ type_string#userProperty in class type_string

User object

$ type_text#userProperty in class type_text

User object

$ report#userProperty in class report
$ report_handler#userProperty in class report_handler
$ report_reason_list_provider#userProperty in class report_reason_list_provider
request::untrimmed_variable() — Method in class request

Get a variable, but without trimming strings.

$ fulltext_mysql#userProperty in class fulltext_mysql

User object

$ fulltext_native#userProperty in class fulltext_native

User object

$ fulltext_postgres#userProperty in class fulltext_postgres

User object

$ fulltext_sphinx#userProperty in class fulltext_sphinx

User object

$ session#update_session_pageProperty in class session
session::unset_admin() — Method in class session
session::update_session() — Method in class session

Update the session data

session::update_session_infos() — Method in class session
session::update_user_lastvisit() — Method in class session

Update user last visit time

user_object_not_availableClass in namespace phpbb\template\exception

This exception is thrown when the user object was not set but it is required by the called method

usernameClass in namespace phpbb\template\twig\extension
$ twig#userProperty in class twig

Current user

$ quote_helper#userProperty in class quote_helper
utilsClass in namespace phpbb\textformatter\s9e

Text manipulation utilities

utils::unparse() — Method in class utils

Return a parsed text to its original form

utils_interfaceClass in namespace phpbb\textformatter

Used to manipulate a parsed text

utils_interface::unparse() — Method in class utils_interface

Return a parsed text to its original form

manager::update_resume_data() — Method in class manager

Updates the resume data in the database

user_signatureClass in namespace phpbb\textreparser\plugins
$ reset_password#userProperty in class reset_password
$ reset_password#users_tableProperty in class reset_password
userClass in namespace phpbb

Base user class

user_loaderClass in namespace phpbb

User loader class

$ user_loader#users_tableProperty in class user_loader
$ user_loader#usersProperty in class user_loader

Users loaded from the DB

$ version_helper#use_sslProperty in class version_helper
$ phpbb_questionnaire_phpbb_data_provider#unique_idProperty in class phpbb_questionnaire_phpbb_data_provider
$ transfer#usernameProperty in class transfer
ucp_activateClass in namespace [Global Namespace]

ucp_activate User activation

$ ucp_activate#u_actionProperty in class ucp_activate
ucp_attachmentsClass in namespace [Global Namespace]

ucp_attachments User attachments

$ ucp_attachments#u_actionProperty in class ucp_attachments
ucp_attachments_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

ucp_attachments_info::uninstall() — Method in class ucp_attachments_info
ucp_auth_linkClass in namespace [Global Namespace]
$ ucp_auth_link#u_actionProperty in class ucp_auth_link
ucp_auth_link_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

ucp_auth_link_info::uninstall() — Method in class ucp_auth_link_info
ucp_confirmClass in namespace [Global Namespace]

ucp_confirm Visual confirmation

$ ucp_confirm#u_actionProperty in class ucp_confirm
ucp_groupsClass in namespace [Global Namespace]
ucp_groups
$ ucp_groups#u_actionProperty in class ucp_groups
ucp_groups_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

ucp_groups_info::uninstall() — Method in class ucp_groups_info
ucp_login_linkClass in namespace [Global Namespace]

ucp_login_link Allows users of external accounts link those accounts to their phpBB accounts during an attempted login.

$ ucp_login_link#u_actionProperty in class ucp_login_link
ucp_mainClass in namespace [Global Namespace]

ucp_main UCP Front Panel

$ ucp_main#u_actionProperty in class ucp_main
ucp_main_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

ucp_main_info::uninstall() — Method in class ucp_main_info
ucp_notificationsClass in namespace [Global Namespace]
$ ucp_notifications#u_actionProperty in class ucp_notifications
ucp_notifications_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

ucp_notifications_info::uninstall() — Method in class ucp_notifications_info
ucp_pmClass in namespace [Global Namespace]

Private Message Class

$ ucp_pm#u_actionProperty in class ucp_pm
ucp_pm_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

ucp_pm_info::uninstall() — Method in class ucp_pm_info
ucp_prefsClass in namespace [Global Namespace]

ucp_prefs Changing user preferences

$ ucp_prefs#u_actionProperty in class ucp_prefs
ucp_prefs_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

ucp_prefs_info::uninstall() — Method in class ucp_prefs_info
ucp_profileClass in namespace [Global Namespace]

ucp_profile Changing profile settings

$ ucp_profile#u_actionProperty in class ucp_profile
ucp_profile_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

ucp_profile_info::uninstall() — Method in class ucp_profile_info
ucp_registerClass in namespace [Global Namespace]

ucp_register Board registration

$ ucp_register#u_actionProperty in class ucp_register
ucp_resendClass in namespace [Global Namespace]

ucp_resend Resending activation emails

$ ucp_resend#u_actionProperty in class ucp_resend
ucp_zebraClass in namespace [Global Namespace]
$ ucp_zebra#u_actionProperty in class ucp_zebra
ucp_zebra_infoClass in namespace [Global Namespace]

This file is part of the phpBB Forum Software package.

ucp_zebra_info::uninstall() — Method in class ucp_zebra_info

V

acp_bots::validate_botname() — Method in class acp_bots

Validate bot name against username table

bbcode_firstpass::validate_email() — Method in class bbcode_firstpass

Validate email

bbcode_firstpass::validate_url() — Method in class bbcode_firstpass

Validate url

$ jabber#verify_peerProperty in class jabber
$ jabber#verify_peer_nameProperty in class jabber
parse_message::validate_bbcode_by_extension() — Method in class parse_message

Function to perform custom bbcode validation by extensions can be used in bbcode_init() to assign regexp replacement Example: 'regexp' => array('#[b](.*?)[/b]#uise' => "\$this->validate_bbcode_by_extension('\$1')")

apache::validate_session() — Method in class apache

The session validation function checks whether the user is still logged into phpBB.

base::validate_session() — Method in class base

The session validation function checks whether the user is still logged into phpBB.

provider_interface::validate_session() — Method in class provider_interface

The session validation function checks whether the user is still logged into phpBB.

$ base#varsProperty in class base
$ file#var_expiresProperty in class file
char_cube3d::vectorlen() — Method in class char_cube3d

Vector length

captcha_abstract::validate() — Method in class captcha_abstract
qa::validate() — Method in class qa

API function - see what has to be done to validate

qa::validate_input() — Method in class qa

Check if the entered data can be inserted/used param mixed $data : an array as created from acp_get_question_input or acp_get_question_data

recaptcha::validate() — Method in class recaptcha
recaptcha_v3::validate() — Method in class recaptcha_v3

Validate the user's input.

add::validate_user_data() — Method in class add

Validate the submitted user data

md_exporter::version_is_filtered() — Method in class md_exporter

The version to check

md_exporter::validate_event_name() — Method in class md_exporter

Validates a template event name

md_exporter::validate_since() — Method in class md_exporter

Validate "Since" Information

md_exporter::validate_changed() — Method in class md_exporter

Validate "Changed" Information

md_exporter::validate_version() — Method in class md_exporter

Validate "version" Information

md_exporter::validate_file_list() — Method in class md_exporter

Validate the files list

md_exporter::validate_events_from_file() — Method in class md_exporter

Validates whether all events from $file are in the md file and vice-versa

php_exporter::version_is_filtered() — Method in class php_exporter

The version to check

php_exporter::validate_since() — Method in class php_exporter

Validate "@since" Information

php_exporter::validate_changed() — Method in class php_exporter

Validate "@changed" Information

php_exporter::validate_event() — Method in class php_exporter

Validate "@event" Information

php_exporter::validate_vars_docblock_array() — Method in class php_exporter

Validates that two arrays contain the same strings

version_check_exceptionClass in namespace phpbb\exception

Define an exception related to the version checker.

manager::version_check() — Method in class manager

Check the version and return the available updates (for an extension).

upload::valid_extension() — Method in class upload

Check for allowed extension

upload::valid_dimensions() — Method in class upload

Check for allowed dimension

upload::valid_content() — Method in class upload

Check for bad content (IE mime-sniffing)

validateClass in namespace phpbb\install\console\command\install\config
validateClass in namespace phpbb\install\console\command\update\config
$ check_update#version_helperProperty in class check_update
pagination::validate_start() — Method in class pagination

Get current page number

type_base::validate_options_on_submit() — Method in class type_base

Allows exclusion of options in single steps of the creation process

type_bool::validate_profile_field() — Method in class type_bool

Validate entered profile field data

type_bool::validate_options_on_submit() — Method in class type_bool

Allows exclusion of options in single steps of the creation process

type_date::validate_profile_field() — Method in class type_date

Validate entered profile field data

type_dropdown::validate_profile_field() — Method in class type_dropdown

Validate entered profile field data

type_dropdown::validate_options_on_submit() — Method in class type_dropdown

Allows exclusion of options in single steps of the creation process

type_int::validate_profile_field() — Method in class type_int

Validate entered profile field data

type_interface::validate_profile_field() — Method in class type_interface

Validate entered profile field data

type_interface::validate_options_on_submit() — Method in class type_interface

Allows exclusion of options in single steps of the creation process

type_string::validate_profile_field() — Method in class type_string

Validate entered profile field data

$ type_string_common#validation_optionsProperty in class type_string_common
type_string_common::validate_options() — Method in class type_string_common

Return possible validation options

type_string_common::validate_string_profile_field() — Method in class type_string_common

Validate entered profile field data

type_text::validate_profile_field() — Method in class type_text

Validate entered profile field data

type_url::validate_profile_field() — Method in class type_url

Validate entered profile field data

report_handler_interface::validate_report_request() — Method in class report_handler_interface

Checks if the message is reportable

report_handler_pm::validate_report_request() — Method in class report_handler_pm

Checks if the message is reportable

report_handler_post::validate_report_request() — Method in class report_handler_post

Checks if the message is reportable

request::variable() — Method in class request

Central type safe input handling function.

request::variable_names() — Method in class request

Returns all variable names for a given super global

request_interface::variable() — Method in class request_interface

Central type safe input handling function.

request_interface::variable_names() — Method in class request_interface

Returns all variable names for a given super global

session::validate_referer() — Method in class session

Check if the request originated from the same page.

loader::validateName() — Method in class loader

Override for parent::validateName()

$ renderer#viewcensorsProperty in class renderer
$ renderer#viewflashProperty in class renderer
$ renderer#viewimgProperty in class renderer
$ renderer#viewsmiliesProperty in class renderer
version_helperClass in namespace phpbb

Class to handle version checking and comparison

$ version_helper#version_schemaProperty in class version_helper
version_helper::validate_versions() — Method in class version_helper

Validate versions info input

viewonline_helperClass in namespace phpbb

Class to handle viewonline related tasks

W

acp_styles::welcome_message() — Method in class acp_styles

Show welcome message

$ bbcode_firstpass#warn_msgProperty in class bbcode_firstpass
$ compress_tar#wroteProperty in class compress_tar
wincacheClass in namespace phpbb\cache\driver

ACM for WinCache

$ gd#widthProperty in class gd
gd::wave() — Method in class gd
Sinus
$ gd_wave#widthProperty in class gd_wave
gd_wave::wave_height() — Method in class gd_wave
$ non_gd#widthProperty in class non_gd
console_migrator_output_handler::write() — Method in class console_migrator_output_handler

Write output using the configured closure.

manager::wrap_task() — Method in class manager

Wraps a task inside an instance of \phpbb\cron\task\wrapper.

wrapperClass in namespace phpbb\cron\task

Cron task wrapper class.

$ base_extractor#writeProperty in class base_extractor
base_extractor::write_end() — Method in class base_extractor

Closes file and/or dumps download data

extractor_interface::write_start() — Method in class extractor_interface

Writes header comments to the database backup

extractor_interface::write_end() — Method in class extractor_interface

Closes file and/or dumps download data

extractor_interface::write_table() — Method in class extractor_interface

Extracts database table structure

extractor_interface::write_data() — Method in class extractor_interface

Extracts data from database table

mssql_extractor::write_end() — Method in class mssql_extractor

Writes closing line(s) to database backup

mssql_extractor::write_start() — Method in class mssql_extractor

Writes header comments to the database backup

mssql_extractor::write_table() — Method in class mssql_extractor

Extracts database table structure

mssql_extractor::write_data() — Method in class mssql_extractor

Extracts data from database table

mssql_extractor::write_data_mssqlnative() — Method in class mssql_extractor

Extracts data from database table (for MSSQL Native driver)

mssql_extractor::write_data_odbc() — Method in class mssql_extractor

Extracts data from database table (for ODBC driver)

mysql_extractor::write_start() — Method in class mysql_extractor

Writes header comments to the database backup

mysql_extractor::write_table() — Method in class mysql_extractor

Extracts database table structure

mysql_extractor::write_data() — Method in class mysql_extractor

Extracts data from database table

mysql_extractor::write_data_mysqli() — Method in class mysql_extractor

Extracts data from database table (for MySQLi driver)

oracle_extractor::write_table() — Method in class oracle_extractor

Extracts database table structure

oracle_extractor::write_data() — Method in class oracle_extractor

Extracts data from database table

oracle_extractor::write_start() — Method in class oracle_extractor

Writes header comments to the database backup

postgres_extractor::write_start() — Method in class postgres_extractor

Writes header comments to the database backup

postgres_extractor::write_table() — Method in class postgres_extractor

Extracts database table structure

postgres_extractor::write_data() — Method in class postgres_extractor

Extracts data from database table

postgres_extractor::write_end() — Method in class postgres_extractor

Writes closing line(s) to database backup

sqlite3_extractor::write_start() — Method in class sqlite3_extractor

Writes header comments to the database backup

sqlite3_extractor::write_table() — Method in class sqlite3_extractor

Extracts database table structure

sqlite3_extractor::write_data() — Method in class sqlite3_extractor

Extracts data from database table

sqlite3_extractor::write_end() — Method in class sqlite3_extractor

Writes closing line(s) to database backup

html_migrator_output_handler::write() — Method in class html_migrator_output_handler

Write output using the configured closure.

installer_migrator_output_handler::write() — Method in class installer_migrator_output_handler

Write output using the configured closure.

log_wrapper_migrator_output_handler::write() — Method in class log_wrapper_migrator_output_handler

Write output using the configured closure.

migrator_output_handler_interface::write() — Method in class migrator_output_handler_interface

Write output using the configured closure.

null_migrator_output_handler::write() — Method in class null_migrator_output_handler

Write output using the configured closure.

container_builder::with_environment() — Method in class container_builder

Enable the extensions.

container_builder::with_extensions() — Method in class container_builder

Enable the extensions.

container_builder::without_extensions() — Method in class container_builder

Disable the extensions.

container_builder::with_cache() — Method in class container_builder

Enable the caching of the container.

container_builder::without_cache() — Method in class container_builder

Disable the caching of the container.

container_builder::with_cache_dir() — Method in class container_builder

Set the cache directory.

container_builder::with_compiled_container() — Method in class container_builder

Enable the compilation of the container.

container_builder::without_compiled_container() — Method in class container_builder

Disable the compilation of the container.

container_builder::with_config_path() — Method in class container_builder

Set a custom path to find the configuration of the container.

container_builder::with_custom_parameters() — Method in class container_builder

Set custom parameters to inject into the container.

container_builder::with_config() — Method in class container_builder

Set custom parameters to inject into the container.

$ filespec#widthProperty in class filespec
$ filesystem#working_directoryProperty in class filesystem

Stores current working directory

$ iohandler_base#warningsProperty in class iohandler_base

Array of warnings

$ installer#web_rootProperty in class installer
$ path_helper#web_root_pathProperty in class path_helper
$ fulltext_mysql#word_lengthProperty in class fulltext_mysql

Associative array stores the min and max word length to be searched

$ fulltext_native#word_lengthProperty in class fulltext_native

Associative array stores the min and max word length to be searched

$ fulltext_postgres#word_lengthProperty in class fulltext_postgres

Associative array stores the min and max word length to be searched

$ environment#web_root_pathProperty in class environment
transfer::write_file() — Method in class transfer

Write file to location

X

jabber::xmlize() — Method in class jabber
xmlize()
$ char_cube3d#xProperty in class char_cube3d

Y

$ char_cube3d#yProperty in class char_cube3d

Z

$ char_cube3d#zProperty in class char_cube3d

_

$ SphinxClient#_hostProperty in class SphinxClient
$ SphinxClient#_portProperty in class SphinxClient
$ SphinxClient#_offsetProperty in class SphinxClient
$ SphinxClient#_limitProperty in class SphinxClient
$ SphinxClient#_modeProperty in class SphinxClient
$ SphinxClient#_weightsProperty in class SphinxClient
$ SphinxClient#_sortProperty in class SphinxClient
$ SphinxClient#_sortbyProperty in class SphinxClient
$ SphinxClient#_min_idProperty in class SphinxClient
$ SphinxClient#_max_idProperty in class SphinxClient
$ SphinxClient#_filtersProperty in class SphinxClient
$ SphinxClient#_groupbyProperty in class SphinxClient
$ SphinxClient#_groupfuncProperty in class SphinxClient
$ SphinxClient#_groupsortProperty in class SphinxClient
$ SphinxClient#_groupdistinctProperty in class SphinxClient
$ SphinxClient#_maxmatchesProperty in class SphinxClient
$ SphinxClient#_cutoffProperty in class SphinxClient
$ SphinxClient#_retrycountProperty in class SphinxClient
$ SphinxClient#_retrydelayProperty in class SphinxClient
$ SphinxClient#_anchorProperty in class SphinxClient
$ SphinxClient#_indexweightsProperty in class SphinxClient
$ SphinxClient#_rankerProperty in class SphinxClient
$ SphinxClient#_rankexprProperty in class SphinxClient
$ SphinxClient#_maxquerytimeProperty in class SphinxClient
$ SphinxClient#_fieldweightsProperty in class SphinxClient
$ SphinxClient#_overridesProperty in class SphinxClient
$ SphinxClient#_selectProperty in class SphinxClient
$ SphinxClient#_errorProperty in class SphinxClient
$ SphinxClient#_warningProperty in class SphinxClient
$ SphinxClient#_connerrorProperty in class SphinxClient
$ SphinxClient#_reqsProperty in class SphinxClient
$ SphinxClient#_mbencProperty in class SphinxClient
$ SphinxClient#_arrayresultProperty in class SphinxClient
$ SphinxClient#_timeoutProperty in class SphinxClient
SphinxClient::__construct() — Method in class SphinxClient
SphinxClient::__destruct() — Method in class SphinxClient
SphinxClient::_Send() — Method in class SphinxClient
SphinxClient::_MBPush() — Method in class SphinxClient
SphinxClient::_MBPop() — Method in class SphinxClient
SphinxClient::_Connect() — Method in class SphinxClient
SphinxClient::_GetResponse() — Method in class SphinxClient
SphinxClient::_PackFloat() — Method in class SphinxClient
SphinxClient::_ParseSearchResponse() — Method in class SphinxClient
acp_inactive::__construct() — Method in class acp_inactive
acp_users::__construct() — Method in class acp_users
auth_admin::__construct() — Method in class auth_admin

Init auth settings

bbcode::__construct() — Method in class bbcode
Constructor
bitfield::__construct() — Method in class bitfield
compress_tar::__construct() — Method in class compress_tar
Constructor
compress_zip::__construct() — Method in class compress_zip
Constructor
$ diff#_editsProperty in class diff

Array of changes.

diff::__construct() — Method in class diff

Computes diffs between sequences of strings.

diff::_check() — Method in class diff

Checks a diff for validity.

$ diff3#_conflicting_blocksProperty in class diff3

Conflict counter.

diff3::__construct() — Method in class diff3

Computes diff between 3 sequences of strings.

diff3_block_builder::__construct() — Method in class diff3_block_builder
diff3_block_builder::_init() — Method in class diff3_block_builder
diff3_block_builder::_append() — Method in class diff3_block_builder
diff3_op::__construct() — Method in class diff3_op
diff3_op::_compare_conflict_seq() — Method in class diff3_op

Find code portions from $orig in $final1 and use $final2 as merged instance if provided

diff3_op_copy::__construct() — Method in class diff3_op_copy
diff_engine::_diag() — Method in class diff_engine

Divides the Largest Common Subsequence (LCS) of the sequences (XOFF, XLIM) and (YOFF, YLIM) into NCHUNKS approximately equally sized segments.

diff_engine::_lcs_pos() — Method in class diff_engine
diff_engine::_compareseq() — Method in class diff_engine

Finds LCS of two sequences.

diff_engine::_shift_boundaries() — Method in class diff_engine

Adjusts inserts/deletes of identical lines to join changes as much as possible.

diff_op_add::__construct() — Method in class diff_op_add
diff_op_change::__construct() — Method in class diff_op_change
diff_op_copy::__construct() — Method in class diff_op_copy
diff_op_delete::__construct() — Method in class diff_op_delete
$ diff_renderer#_leading_context_linesProperty in class diff_renderer

Number of leading context "lines" to preserve.

$ diff_renderer#_trailing_context_linesProperty in class diff_renderer

Number of trailing context "lines" to preserve.

diff_renderer::__construct() — Method in class diff_renderer
Constructor.
diff_renderer::_block() — Method in class diff_renderer
diff_renderer::_start_diff() — Method in class diff_renderer
diff_renderer::_end_diff() — Method in class diff_renderer
diff_renderer::_block_header() — Method in class diff_renderer
diff_renderer::_start_block() — Method in class diff_renderer
diff_renderer::_end_block() — Method in class diff_renderer
diff_renderer::_lines() — Method in class diff_renderer
diff_renderer::_context() — Method in class diff_renderer
diff_renderer::_added() — Method in class diff_renderer
diff_renderer::_deleted() — Method in class diff_renderer
diff_renderer::_changed() — Method in class diff_renderer
$ diff_renderer_inline#_leading_context_linesProperty in class diff_renderer_inline
$ diff_renderer_inline#_trailing_context_linesProperty in class diff_renderer_inline
$ diff_renderer_inline#_ins_prefixProperty in class diff_renderer_inline
$ diff_renderer_inline#_ins_suffixProperty in class diff_renderer_inline
$ diff_renderer_inline#_del_prefixProperty in class diff_renderer_inline
$ diff_renderer_inline#_del_suffixProperty in class diff_renderer_inline
$ diff_renderer_inline#_block_headProperty in class diff_renderer_inline
$ diff_renderer_inline#_split_levelProperty in class diff_renderer_inline
diff_renderer_inline::_start_diff() — Method in class diff_renderer_inline
diff_renderer_inline::_end_diff() — Method in class diff_renderer_inline
diff_renderer_inline::_block_header() — Method in class diff_renderer_inline
diff_renderer_inline::_start_block() — Method in class diff_renderer_inline
diff_renderer_inline::_lines() — Method in class diff_renderer_inline
diff_renderer_inline::_added() — Method in class diff_renderer_inline
diff_renderer_inline::_deleted() — Method in class diff_renderer_inline
diff_renderer_inline::_changed() — Method in class diff_renderer_inline
diff_renderer_inline::_split_on_words() — Method in class diff_renderer_inline
diff_renderer_inline::_encode() — Method in class diff_renderer_inline
$ diff_renderer_raw#_leading_context_linesProperty in class diff_renderer_raw
$ diff_renderer_raw#_trailing_context_linesProperty in class diff_renderer_raw
diff_renderer_raw::_block_header() — Method in class diff_renderer_raw
diff_renderer_raw::_context() — Method in class diff_renderer_raw
diff_renderer_raw::_added() — Method in class diff_renderer_raw
diff_renderer_raw::_deleted() — Method in class diff_renderer_raw
diff_renderer_raw::_changed() — Method in class diff_renderer_raw
$ diff_renderer_side_by_side#_leading_context_linesProperty in class diff_renderer_side_by_side
$ diff_renderer_side_by_side#_trailing_context_linesProperty in class diff_renderer_side_by_side
diff_renderer_side_by_side::_start_diff() — Method in class diff_renderer_side_by_side
diff_renderer_side_by_side::_end_diff() — Method in class diff_renderer_side_by_side
diff_renderer_side_by_side::_block_header() — Method in class diff_renderer_side_by_side
diff_renderer_side_by_side::_added() — Method in class diff_renderer_side_by_side
diff_renderer_side_by_side::_perform_add() — Method in class diff_renderer_side_by_side
diff_renderer_side_by_side::_deleted() — Method in class diff_renderer_side_by_side
diff_renderer_side_by_side::_perform_delete() — Method in class diff_renderer_side_by_side
diff_renderer_side_by_side::_context() — Method in class diff_renderer_side_by_side
diff_renderer_side_by_side::_perform_context() — Method in class diff_renderer_side_by_side
diff_renderer_side_by_side::_changed() — Method in class diff_renderer_side_by_side
$ diff_renderer_unified#_leading_context_linesProperty in class diff_renderer_unified
$ diff_renderer_unified#_trailing_context_linesProperty in class diff_renderer_unified
diff_renderer_unified::_block_header() — Method in class diff_renderer_unified
diff_renderer_unified::_context() — Method in class diff_renderer_unified
diff_renderer_unified::_added() — Method in class diff_renderer_unified
diff_renderer_unified::_deleted() — Method in class diff_renderer_unified
diff_renderer_unified::_changed() — Method in class diff_renderer_unified
diff_renderer_unified::_start_diff() — Method in class diff_renderer_unified
diff_renderer_unified::_end_diff() — Method in class diff_renderer_unified
diff_renderer_unified::_end_block() — Method in class diff_renderer_unified
ftp::__construct() — Method in class ftp

Standard parameters for FTP session

ftp_fsock::__construct() — Method in class ftp_fsock

Standard parameters for FTP session

jabber::__construct() — Method in class jabber
Constructor
jabber::_xml_depth() — Method in class jabber
_xml_depth()
mapped_diff::__construct() — Method in class mapped_diff

Computes a diff between sequences of strings.

mcp_logs::__construct() — Method in class mcp_logs
mcp_main::__construct() — Method in class mcp_main
mcp_notes::__construct() — Method in class mcp_notes
mcp_pm_reports::__construct() — Method in class mcp_pm_reports
mcp_queue::__construct() — Method in class mcp_queue
mcp_reports::__construct() — Method in class mcp_reports
mcp_warn::__construct() — Method in class mcp_warn
messenger::__construct() — Method in class messenger
Constructor
p_master::__construct() — Method in class p_master

Constuctor Set module include path

parse_message::__construct() — Method in class parse_message

Init - give message here or manually

delete::__construct() — Method in class delete

Attachment delete class constructor

manager::__construct() — Method in class manager

Constructor for attachment manager

resync::__construct() — Method in class resync

Constructor for attachment resync class

upload::__construct() — Method in class upload

Constructor for attachments upload class

auth::_set_group_hold_ary() — Method in class auth

Private function snippet for setting a specific piece of the hold_ary

apache::__construct() — Method in class apache

Apache Authentication Constructor

db::__construct() — Method in class db

Database Authentication Constructor

ldap::__construct() — Method in class ldap

LDAP Authentication Constructor

oauth::__construct() — Method in class oauth
Constructor.
bitly::__construct() — Method in class bitly
Constructor.
facebook::__construct() — Method in class facebook
Constructor.
google::__construct() — Method in class google
Constructor.
twitter::__construct() — Method in class twitter
Constructor.
token_storage::__construct() — Method in class token_storage
Constructor.
token_storage::_retrieve_access_token() — Method in class token_storage

A helper function that performs the query for retrieve access token functions.

token_storage::_retrieve_state() — Method in class token_storage

A helper function that performs the query for retrieve state functions.

provider_collection::__construct() — Method in class provider_collection
Constructor
driver::__construct() — Method in class driver

Construct a driver object

upload::__construct() — Method in class upload

Construct a driver object

manager::__construct() — Method in class manager

Construct an avatar manager object

apcu::_read() — Method in class apcu

Fetch an item from the cache

apcu::_write() — Method in class apcu

Store data in the cache

apcu::_delete() — Method in class apcu

Remove an item from the cache

driver_interface::_exists() — Method in class driver_interface

Check if a given cache entry exists

dummy::__construct() — Method in class dummy

Set cache path

dummy::_exists() — Method in class dummy

Check if a given cache entry exists

file::__construct() — Method in class file

Set cache path

file::_exists() — Method in class file

Check if a given cache entry exists

memcached::__construct() — Method in class memcached

Memcached constructor

memcached::_read() — Method in class memcached

Fetch an item from the cache

memcached::_write() — Method in class memcached

Store data in the cache

memcached::_delete() — Method in class memcached

Remove an item from the cache

memory::__construct() — Method in class memory

Set cache path

memory::_exists() — Method in class memory

Check if a given cache entry exists

memory::_isset() — Method in class memory

Check if a cache var exists

redis::__construct() — Method in class redis

Creates a redis cache driver.

redis::_read() — Method in class redis

Fetch an item from the cache

redis::_write() — Method in class redis

Store data in the cache

redis::_delete() — Method in class redis

Remove an item from the cache

wincache::_read() — Method in class wincache

Fetch an item from the cache

wincache::_write() — Method in class wincache

Store data in the cache

wincache::_delete() — Method in class wincache

Remove an item from the cache

service::__construct() — Method in class service

Creates a cache service around a cache driver

service::__call() — Method in class service
char_cube3d::__construct() — Method in class char_cube3d
colour_manager::__construct() — Method in class colour_manager

Create the colour manager, link it to the image resource

factory::__construct() — Method in class factory
Constructor
non_gd::__construct() — Method in class non_gd

Define filtered pngs on init

qa::__construct() — Method in class qa
Constructor
recaptcha::__construct() — Method in class recaptcha
Constructor
class_loader::__construct() — Method in class class_loader

Creates a new \phpbb\class_loader, which loads files with the given file extension from the given path.

config::__construct() — Method in class config

Creates a configuration container with a default set of values

db::__construct() — Method in class db

Creates a configuration container with a default set of values

db_text::__construct() — Method in class db_text
config_php_file::__construct() — Method in class config_php_file
Constructor
application::__construct() — Method in class application
purge::__construct() — Method in class purge
Constructor
command::__construct() — Method in class command
Constructor
command::__construct() — Method in class command
Constructor
cron_list::__construct() — Method in class cron_list
Constructor
run::__construct() — Method in class run

Construct method

console_migrator_output_handler::__construct() — Method in class console_migrator_output_handler
Constructor
migrate::__construct() — Method in class migrate
Constructor
migration_command::__construct() — Method in class migration_command
Constructor
migration_tips::__construct() — Method in class migration_tips
Constructor
command::__construct() — Method in class command
Constructor.
fix_left_right_ids::__construct() — Method in class fix_left_right_ids
Constructor
update_hashes::__construct() — Method in class update_hashes

Update_hashes constructor

list_all::__construct() — Method in class list_all
Constructor
reparse::__construct() — Method in class reparse
Constructor
delete::__construct() — Method in class delete
Constructor
generate::__construct() — Method in class generate
Constructor
check::__construct() — Method in class check

Construct method

activate::__construct() — Method in class activate

Construct method

add::__construct() — Method in class add

Construct method

delete::__construct() — Method in class delete

Construct method

reclean::__construct() — Method in class reclean

Construct method

exception_subscriber::__construct() — Method in class exception_subscriber
Constructor.
content_visibility::__construct() — Method in class content_visibility
Constructor
helper::__construct() — Method in class helper
Constructor
resolver::__construct() — Method in class resolver

Construct method

convertor::__construct() — Method in class convertor
Constructor
convert::__construct() — Method in class convert
convertor::__construct() — Method in class convertor
Constructor
cron_runner_listener::__construct() — Method in class cron_runner_listener
Constructor
manager::__construct() — Method in class manager

Constructor. Loads all available tasks.

prune_all_forums::__construct() — Method in class prune_all_forums
Constructor.
prune_forum::__construct() — Method in class prune_forum
Constructor.
prune_notifications::__construct() — Method in class prune_notifications
Constructor.
prune_shadow_topics::__construct() — Method in class prune_shadow_topics
Constructor.
queue::__construct() — Method in class queue
Constructor.
tidy_cache::__construct() — Method in class tidy_cache
Constructor.
tidy_plupload::__construct() — Method in class tidy_plupload
Constructor.
tidy_search::__construct() — Method in class tidy_search
Constructor.
tidy_sessions::__construct() — Method in class tidy_sessions
Constructor.
tidy_warnings::__construct() — Method in class tidy_warnings
Constructor.
update_hashes::__construct() — Method in class update_hashes
Constructor.
reparser::__construct() — Method in class reparser
Constructor
wrapper::__construct() — Method in class wrapper
Constructor.
wrapper::__call() — Method in class wrapper

Forwards all other method calls to the wrapped task implementation.

datetime::__construct() — Method in class datetime

Constructs a new instance of \phpbb\datetime, expanded to include an argument to inject the user context and modify the timezone to the users selected timezone if one is not set.

datetime::__toString() — Method in class datetime

Magic method to convert DateTime object to string

driver::__construct() — Method in class driver
Constructor
driver::_process_boolean_tree_first() — Method in class driver
driver::_process_boolean_tree() — Method in class driver
factory::__construct() — Method in class factory
Constructor.
mssql_odbc::_sql_query_limit() — Method in class mssql_odbc

Build LIMIT query

mssqlnative::_sql_query_limit() — Method in class mssqlnative

Build LIMIT query

mysql_base::_sql_query_limit() — Method in class mysql_base

Build LIMIT query

oracle::_sql_query_limit() — Method in class oracle

Build LIMIT query

oracle::_sql_custom_build() — Method in class oracle
oracle::_sql_bit_and() — Method in class oracle
oracle::_sql_bit_or() — Method in class oracle
postgres::_sql_query_limit() — Method in class postgres

Build LIMIT query

sqlite3::_sql_transaction() — Method in class sqlite3

SQL Transaction

sqlite3::_sql_query_limit() — Method in class sqlite3

Build LIMIT query

sqlite3::_sql_error() — Method in class sqlite3

return sql error array

sqlite3::_sql_custom_build() — Method in class sqlite3

Build db-specific query data

sqlite3::_sql_close() — Method in class sqlite3

Close sql connection

sqlite3::_sql_report() — Method in class sqlite3

Build db-specific report

base_extractor::__construct() — Method in class base_extractor
Constructor
factory::__construct() — Method in class factory

Extractor factory constructor

exception::__construct() — Method in class exception

Throw an exception.

exception::__toString() — Method in class exception

Output the error as a string

migration::__construct() — Method in class migration
Constructor
schema_generator::__construct() — Method in class schema_generator
Constructor
config::__construct() — Method in class config
Constructor
config_text::__construct() — Method in class config_text
Constructor
module::__construct() — Method in class module
Constructor
permission::__construct() — Method in class permission
Constructor
migrator::__construct() — Method in class migrator

Constructor of the database migrator

html_migrator_output_handler::__construct() — Method in class html_migrator_output_handler
Constructor
installer_migrator_output_handler::__construct() — Method in class installer_migrator_output_handler
Constructor
log_wrapper_migrator_output_handler::__construct() — Method in class log_wrapper_migrator_output_handler
Constructor
sql_insert_buffer::__construct() — Method in class sql_insert_buffer
mssql::__construct() — Method in class mssql

Constructor. Set DB Object and set $return_statements return_statements.

postgres::__construct() — Method in class postgres

Constructor. Set DB Object and set $return_statements return_statements.

tools::__construct() — Method in class tools

Constructor. Set DB Object and set $return_statements return_statements.

container_builder::__construct() — Method in class container_builder
Constructor
config::__construct() — Method in class config
core::__construct() — Method in class core
Constructor
ordered_service_collection::__construct() — Method in class ordered_service_collection
Constructor
proxy_instantiator::__construct() — Method in class proxy_instantiator

proxy_instantiator constructor

service_collection::__construct() — Method in class service_collection
Constructor
service_collection_iterator::__construct() — Method in class service_collection_iterator

Construct an ArrayIterator for service_collection

error_collector::__construct() — Method in class error_collector
Constructor.
kernel_exception_subscriber::__construct() — Method in class kernel_exception_subscriber

Construct method

md_exporter::__construct() — Method in class md_exporter
php_exporter::__construct() — Method in class php_exporter
recursive_event_filter_iterator::__construct() — Method in class recursive_event_filter_iterator
Construct
http_exception::__construct() — Method in class http_exception
Constructor
runtime_exception::__construct() — Method in class runtime_exception
Constructor
base::__construct() — Method in class base
Constructor
extension_base::__construct() — Method in class extension_base
Constructor
manager::__construct() — Method in class manager

Creates a manager and loads information from database

provider::__construct() — Method in class provider

Constructor. Loads all available items.

base::__construct() — Method in class base
Constructor
feed::__construct() — Method in class feed
Constructor
no_feed_exception::__construct() — Method in class no_feed_exception
Constructor
no_forum_exception::__construct() — Method in class no_forum_exception
Constructor
no_topic_exception::__construct() — Method in class no_topic_exception
Constructor
unauthorized_forum_exception::__construct() — Method in class unauthorized_forum_exception
Constructor
unauthorized_topic_exception::__construct() — Method in class unauthorized_topic_exception
Constructor
helper::__construct() — Method in class helper
Constructor
factory::__construct() — Method in class factory
Constructor
filespec::__construct() — Method in class filespec

File upload class

form::__construct() — Method in class form

Construct a form upload type

local::__construct() — Method in class local

Construct a form upload type

remote::__construct() — Method in class remote

Construct a form upload type

upload::__construct() — Method in class upload

Init file upload class.

filesystem_exception::__construct() — Method in class filesystem_exception
Constructor
filesystem::__construct() — Method in class filesystem
Constructor
finder::__construct() — Method in class finder

Creates a new finder instance with its dependencies

helper::__construct() — Method in class helper
Constructor
legend::__construct() — Method in class legend
Constructor
teampage::__construct() — Method in class teampage
Constructor
controller::__construct() — Method in class controller
Constructor
help::__construct() — Method in class help
Constructor
manager::__construct() — Method in class manager
Constructor
finder::__construct() — Method in class finder

Creates a new finder instance.

show::__construct() — Method in class show
Constructor
validate::__construct() — Method in class validate
Constructor
install::__construct() — Method in class install
Constructor
show::__construct() — Method in class show
Constructor
validate::__construct() — Method in class validate
Constructor
update::__construct() — Method in class update
Constructor
archive_download::__construct() — Method in class archive_download
Constructor
helper::__construct() — Method in class helper
Constructor
install::__construct() — Method in class install
Constructor
installer_index::__construct() — Method in class installer_index
Constructor
timeout_check::__construct() — Method in class timeout_check
Constructor
update::__construct() — Method in class update
Constructor
kernel_exception_subscriber::__construct() — Method in class kernel_exception_subscriber
Constructor
jump_to_restart_point_exception::__construct() — Method in class jump_to_restart_point_exception
Constructor
config::__construct() — Method in class config
Constructor
container_factory::__construct() — Method in class container_factory
Constructor
compression_file_updater::__construct() — Method in class compression_file_updater
Constructor
factory::__construct() — Method in class factory
Constructor
file_updater::__construct() — Method in class file_updater
Constructor
ftp_file_updater::__construct() — Method in class ftp_file_updater
Constructor
install_helper::__construct() — Method in class install_helper
Constructor
ajax_iohandler::__construct() — Method in class ajax_iohandler
Constructor
factory::__construct() — Method in class factory
Constructor
iohandler_base::__construct() — Method in class iohandler_base
Constructor
convertor_navigation::__construct() — Method in class convertor_navigation
Constructor
install_navigation::__construct() — Method in class install_navigation
Constructor
navigation_provider::__construct() — Method in class navigation_provider
Constructor
update_navigation::__construct() — Method in class update_navigation
Constructor
update_helper::__construct() — Method in class update_helper
Constructor
installer::__construct() — Method in class installer
Constructor
create_config_file::__construct() — Method in class create_config_file
Constructor
install_extensions::__construct() — Method in class install_extensions
Constructor
notify_user::__construct() — Method in class notify_user
Constructor
populate_migrations::__construct() — Method in class populate_migrations
Constructor
check_filesystem::__construct() — Method in class check_filesystem
Constructor
check_server_environment::__construct() — Method in class check_server_environment
Constructor
check_update::__construct() — Method in class check_update
Constructor
diff_files::__construct() — Method in class diff_files
Constructor
download_updated_files::__construct() — Method in class download_updated_files
Constructor
file_check::__construct() — Method in class file_check
Construct
show_file_status::__construct() — Method in class show_file_status
Constructor
update_files::__construct() — Method in class update_files
Constructor
module_base::__construct() — Method in class module_base

Installer module constructor

task_base::__construct() — Method in class task_base
Constructor
language::__construct() — Method in class language
Constructor
language_file_helper::__construct() — Method in class language_file_helper
Constructor
language_file_loader::__construct() — Method in class language_file_loader
Constructor
db::__construct() — Method in class db

Creates a named released instance of the lock.

flock::__construct() — Method in class flock
Constructor.
log::__construct() — Method in class log
Constructor
admin_form::__construct() — Method in class admin_form
Construct
form::__construct() — Method in class form
Construct
message::__construct() — Method in class message
Construct
guesser::__construct() — Method in class guesser

Construct a mimetype guesser object

module_manager::__construct() — Method in class module_manager
Constructor
manager::__construct() — Method in class manager

Notification Constructor

board::__construct() — Method in class board

Notification Method Board Constructor

email::__construct() — Method in class email

Notification Method email Constructor

jabber::__construct() — Method in class jabber

Notification Method jabber Constructor

messenger_base::__construct() — Method in class messenger_base

Notification Method Board Constructor

base::__construct() — Method in class base

Notification Type Base Constructor

base::__get() — Method in class base

Magic method to get data from this notification

base::__set() — Method in class base

Magic method to set data on this notification

base::__toString() — Method in class base

Magic method to get a string of this notification

pagination::__construct() — Method in class pagination
Constructor
argon2i::__construct() — Method in class argon2i

Constructor of passwords driver object

base::__construct() — Method in class base

Constructor of passwords driver object

bcrypt::__construct() — Method in class bcrypt

Constructor of passwords driver object

bcrypt_wcf2::__construct() — Method in class bcrypt_wcf2

Constructor of passwords driver object

helper::__construct() — Method in class helper

Construct a driver helper object

md5_phpbb2::__construct() — Method in class md5_phpbb2

Constructor of passwords driver object

manager::__construct() — Method in class manager

Construct a passwords object

path_helper::__construct() — Method in class path_helper
Constructor
permissions::__construct() — Method in class permissions
Constructor
plupload::__construct() — Method in class plupload
Constructor.
lang_helper::__construct() — Method in class lang_helper
Construct
manager::__construct() — Method in class manager
Construct
type_base::__construct() — Method in class type_base
Construct
type_bool::__construct() — Method in class type_bool
Construct
type_date::__construct() — Method in class type_date
Construct
type_dropdown::__construct() — Method in class type_dropdown
Construct
type_int::__construct() — Method in class type_int
Construct
type_string::__construct() — Method in class type_string
Construct
type_text::__construct() — Method in class type_text
Construct
report::__construct() — Method in class report
empty_report_exception::__construct() — Method in class empty_report_exception
Constructor
pm_reporting_disabled_exception::__construct() — Method in class pm_reporting_disabled_exception
Constructor
handler_factory::__construct() — Method in class handler_factory
Constructor
report_handler::__construct() — Method in class report_handler
Constructor
report_reason_list_provider::__construct() — Method in class report_reason_list_provider
Constructor
deactivated_super_global::__construct() — Method in class deactivated_super_global

Constructor generates an error message fitting the super global to be used within the other functions.

request::__construct() — Method in class request

Initialises the request class, that means it stores all input data in $input input and then calls \phpbb\request\deactivated_super_global \phpbb\request\deactivated_super_global

request::_variable() — Method in class request

Helper function used by variable() and untrimmed_variable().

file_locator::__construct() — Method in class file_locator
helper::__construct() — Method in class helper
Constructor
loader_resolver::__construct() — Method in class loader_resolver
chained_resources_locator::__construct() — Method in class chained_resources_locator

Construct method

default_resources_locator::__construct() — Method in class default_resources_locator

Construct method

installer_resources_locator::__construct() — Method in class installer_resources_locator

Construct method

router::__construct() — Method in class router

Construct method

fulltext_mysql::__construct() — Method in class fulltext_mysql

Constructor Creates a new \phpbb\search\fulltext_mysql, which is used as a search backend

fulltext_native::__construct() — Method in class fulltext_native

Initialises the fulltext_native search backend with min/max word length

fulltext_postgres::__construct() — Method in class fulltext_postgres

Constructor Creates a new \phpbb\search\fulltext_postgres, which is used as a search backend

fulltext_sphinx::__construct() — Method in class fulltext_sphinx

Constructor Creates a new \phpbb\search\fulltext_postgres, which is used as a search backend

config::__construct() — Method in class config

Constructor which optionally loads data from a variable

config_comment::__construct() — Method in class config_comment

Create a new comment

config_section::__construct() — Method in class config_section

Construct a new section

config_variable::__construct() — Method in class config_variable

Constructs a new variable object

symfony_request::__construct() — Method in class symfony_request
Constructor
asset::__construct() — Method in class asset
Constructor
context::__construct() — Method in class context
definition::__call() — Method in class definition

Get a DEFINE'd variable

environment::__construct() — Method in class environment
Constructor
extension::__construct() — Method in class extension
Constructor
config::__construct() — Method in class config
Constructor.
routing::__construct() — Method in class routing
Constructor
loader::__construct() — Method in class loader
Constructor
definenode::__construct() — Method in class definenode
event::__construct() — Method in class event
includeasset::__construct() — Method in class includeasset
includephp::__construct() — Method in class includephp
php::__construct() — Method in class php
event::__construct() — Method in class event
Constructor
includephp::__construct() — Method in class includephp
Constructor
php::__construct() — Method in class php
Constructor
twig::__construct() — Method in class twig
Constructor.
acp_utils::__construct() — Method in class acp_utils
bbcode_merger::__construct() — Method in class bbcode_merger
factory::__construct() — Method in class factory
Constructor
parser::__construct() — Method in class parser
Constructor
quote_helper::__construct() — Method in class quote_helper
Constructor
renderer::__construct() — Method in class renderer
Constructor
manager::__construct() — Method in class manager
Constructor
contact_admin_info::__construct() — Method in class contact_admin_info
Constructor
row_based_plugin::__construct() — Method in class row_based_plugin
Constructor
nestedset::__construct() — Method in class nestedset
Construct
nestedset_forum::__construct() — Method in class nestedset_forum
Construct
reset_password::__construct() — Method in class reset_password

Reset password controller constructor.

user::__construct() — Method in class user

Constructor to set the lang path

user::__get() — Method in class user

Magic getter for BC compatibility

user_loader::__construct() — Method in class user_loader

User loader constructor

version_helper::__construct() — Method in class version_helper
Constructor
viewonline_helper::__construct() — Method in class viewonline_helper
phpbb_hook::__construct() — Method in class phpbb_hook

Initialize hook class.

phpbb_questionnaire_data_collector::__construct() — Method in class phpbb_questionnaire_data_collector
Constructor.
phpbb_questionnaire_phpbb_data_provider::__construct() — Method in class phpbb_questionnaire_phpbb_data_provider
Constructor.
queue::__construct() — Method in class queue
constructor
smtp_class::__construct() — Method in class smtp_class
transfer::__construct() — Method in class transfer

Constructor - init some basic values

ucp_main::__construct() — Method in class ucp_main