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_storageClass in namespace [Global Namespace]
acp_storage_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_quote_bbcodeProperty in class parse_message
$ parse_message#allow_url_bbcodeProperty in class parse_message
attachment_categoryClass in namespace phpbb\attachment
$ 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.

$ html_output_formatter#availableForegroundColorsProperty in class html_output_formatter
$ html_output_formatter#availableBackgroundColorsProperty in class html_output_formatter
$ html_output_formatter#availableOptionsProperty in class html_output_formatter
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

doctrine::asset_exists() — Method in class doctrine

Returns whether an asset name exists in a list of assets (case insensitive).

doctrine::alter_schema() — Method in class doctrine

Alter the current database representation using a callback and execute the changes.

doctrine::alter_table() — Method in class doctrine

Alter table.

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

filespec_storage::additional_checks() — Method in class filespec_storage

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
$ helper#avatar_helperProperty 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

Adds an error message to the rendering queue

cli_iohandler::add_warning_message() — Method in class cli_iohandler

Adds a warning message to the rendering queue

cli_iohandler::add_log_message() — Method in class cli_iohandler

Adds a log message to the rendering queue

cli_iohandler::add_success_message() — Method in class cli_iohandler

Adds a success message to the rendering queue

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

$ base_group#authProperty in class base_group
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_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_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_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

search_backend_interface::author_search() — Method in class search_backend_interface

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

config::add_section() — Method in class config

Appends a new empty section to the end of the config

adapter_interfaceClass in namespace phpbb\storage\adapter
adapter_factoryClass in namespace phpbb\storage
$ adapter_factory#adaptersProperty in class adapter_factory
attachmentClass in namespace phpbb\storage\controller

Controller for /download/attachment/{id} routes

$ attachment#authProperty in class attachment
avatarClass in namespace phpbb\storage\controller

Controller for /download/avatar/{file} routes

$ avatar#allowed_extensionsProperty in class avatar
$ file_info#adapterProperty in class file_info
$ storage#adapterProperty in class storage
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

$ mention_helper#authProperty in class mention_helper
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)

$ user_loader#avatar_helperProperty in class user_loader
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

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_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.

connection::beginTransaction() — Method in class connection

{@inheritDoc}

statement::bindValue() — Method in class statement

{@inheritDoc}

statement::bindParam() — Method in class statement

{@inheritDoc}

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

base_groupClass in namespace phpbb\mention\source
base_userClass in namespace phpbb\mention\source
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\backend

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
adapter_factory::build_options() — Method in class adapter_factory

Obtains configuration for a given storage

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#controller_helperProperty 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::catalog_mode() — Method in class acp_extensions

Handles the catalog mode of the extensions list

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#configProperty in class acp_language
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_search#configProperty in class acp_search
$ acp_storage#configProperty in class acp_storage
$ 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 to a temporary folder

$ helper#configProperty in class helper
$ 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
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.

extension_manager::check_requirements() — Method in class extension_manager

Checks the requirements of the manager and returns true if it can be used.

$ installer#composer_filenameProperty in class installer
installer::check_requirements() — Method in class installer

Checks the requirements of the manager and returns true if it can be used.

console_ioClass in namespace phpbb\composer\io
$ translate_composer_trait#composer_errorProperty in class translate_composer_trait
$ manager#cacheProperty in class manager
manager::check_requirements() — Method in class manager

Checks the requirements of the manager and returns true if it can be used.

manager_interface::check_requirements() — Method in class manager_interface

Checks the requirements of the manager and returns true if it can be used.

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

{@inheritdoc}

migrate::configure() — Method in class migrate

{@inheritdoc}

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

{@inheritdoc}

migration_tips::configure() — Method in class migration_tips

{@inheritdoc}

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

{@inheritdoc}

enable::configure() — Method in class enable

{@inheritdoc}

install::configure() — Method in class install

Sets the command name and description

list_available::configure() — Method in class list_available

Sets the command name and description

manage::configure() — Method in class manage

Sets the command name and description

purge::configure() — Method in class purge

{@inheritdoc}

remove::configure() — Method in class remove

Sets the command name and description

show::configure() — Method in class show

{@inheritdoc}

update::configure() — Method in class update

Sets the command name and description

$ 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
case_insensitive_stringClass in namespace phpbb\db\doctrine

Case-insensitive string type (only supported by Postgres).

comparatorClass in namespace phpbb\db\doctrine
connection_factoryClass in namespace phpbb\db\doctrine

Doctrine DBAL connection factory.

connection_parameter_factoryClass in namespace phpbb\db\doctrine

Helper class to generate Doctrine DBAL configuration.

connectionClass in namespace phpbb\db\doctrine\oci8
connection::commit() — Method in class connection

{@inheritDoc}

driver::connect() — Method in class driver

{@inheritDoc}

result::columnCount() — Method in class result

{@inheritDoc}

oracle_platform::check_index_name_length() — Method in class oracle_platform

Check whether the index name is too long

table_helper::convert_column_data() — Method in class table_helper

Converts phpBB's column representation to Doctrine's representation.

type_converter::convert() — Method in class type_converter

Convert legacy type to Doctrine's type system.

$ 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_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.

$ 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.

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
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
$ 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.

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

$ filespec_storage#class_initializedProperty in class filespec_storage
filespec_storage::clean_filename() — Method in class filespec_storage

Cleans destination filename

filespec_storage::check_content() — Method in class filespec_storage

Check the first 256 bytes for forbidden content

base::check_upload_size() — Method in class base

Check if upload exceeds maximum file size

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.

helper::clean_path() — Method in class helper

Eliminates useless . and .. components from specified path.

$ factory#cacheProperty in class factory
$ 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

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
$ base_group#configProperty in class base_group
$ base_group#cache_ttlProperty in class base_group
$ base_user#configProperty in class base_user
$ base_user#cache_ttlProperty in class base_user
$ group#cache_ttlProperty in class group
$ team#cache_ttlProperty in class team
$ 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

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

Create fulltext index

$ 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::cleanup() — Method in class fulltext_native

Clean up a text to remove non-alphanumeric characters

$ 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::create_index() — Method in class fulltext_sphinx

Create fulltext index

fulltext_sphinx::config_generate() — Method in class fulltext_sphinx

Generates content of sphinx.conf

search_backend_interface::create_index() — Method in class search_backend_interface

Create fulltext index

configClass in namespace phpbb\search\backend\sphinx

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

config_itemClass in namespace phpbb\search\backend\sphinx

\phpbb\search\backend\sphinx\config_item Represents a single config item inside the sphinx configuration

config_sectionClass in namespace phpbb\search\backend\sphinx

\phpbb\search\backend\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 variables list of this section

config_variableClass in namespace phpbb\search\backend\sphinx

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

$ search_backend_factory#configProperty in class search_backend_factory
$ 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() — Method in class session

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

adapter_interface::configure() — Method in class adapter_interface

Set adapter parameters

adapter_interface::copy() — Method in class adapter_interface

Copies a file

local::configure() — Method in class local

Set adapter parameters

local::copy() — Method in class local

Copies a file

local::create_dir() — Method in class local

Creates a directory recursively.

$ adapter_factory#configProperty in class adapter_factory
$ attachment#configProperty in class attachment
$ attachment#content_visibilityProperty in class attachment
$ avatar#configProperty in class avatar
controllerClass in namespace phpbb\storage\controller

Generic controller for storage

$ controller#cacheProperty in class controller
$ storage#cacheProperty in class storage

Cache driver

storage::copy() — Method in class storage

Copies a file

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

Template context.

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.

$ twig#configProperty in class twig
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_mention_helper() — Method in class renderer

Configure the mention_helper object used to display extended information in mentions

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_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_language#dbProperty in class acp_language
$ acp_language#dispatcherProperty in class acp_language
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

$ helper#dispatcherProperty in class helper
$ 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

installer::do_install() — Method in class installer

Update the current installed set of packages

installer::do_get_installed_packages() — Method in class installer

Returns the list of currently installed packages

installer::do_get_available_packages() — Method in class installer

Gets the list of the available packages of the configured type in the configured repositories

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

$ add#dataProperty in class add
$ add#dbProperty in class add
deleteClass in namespace phpbb\console\command\user
$ 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_doctrineProperty 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

comparator::diffTable() — Method in class comparator

{@inerhitDoc}

driverClass in namespace phpbb\db\doctrine\oci8
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
$ 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
doctrineClass in namespace phpbb\db\tools

BC layer for database tools.

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
$ filespec_storage#destination_fileProperty in class filespec_storage
$ 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
sanitizer::decode() — Method in class sanitizer

Decode and sanitize json data

$ 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

$ base_group#dbProperty in class base_group
$ base_user#dbProperty in class base_user
$ 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

$ router#debug_url_generatorProperty in class router
$ router#debug_url_matcherProperty in class router
$ base#dbProperty in class base
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.

base::delete_index() — Method in class base

Drop fulltext index

fulltext_mysql::delete_index() — Method in class fulltext_mysql

Drop fulltext index

fulltext_native::delete_index() — Method in class fulltext_native

Drop fulltext index

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 fulltext index

search_backend_interface::delete_index() — Method in class search_backend_interface

Drop fulltext index

config_section::delete_variables_by_name() — Method in class config_section

Deletes all variables with the given name

$ session#dataProperty in class session
adapter_interface::delete() — Method in class adapter_interface

Removes files or directories

$ local#dir_depthProperty in class local
local::delete() — Method in class local

Removes files or directories

$ attachment#dispatcherProperty in class attachment
attachment::download_allowed() — Method in class attachment

Check if downloading item is allowed FIXME (See: https://tracker.phpbb.com/browse/PHPBB3-15264 and http://area51.phpbb.com/phpBB/viewtopic.php?f=81&t=51921)

avatar::decode_filename() — Method in class avatar

Decode avatar filename

$ controller#dbProperty in class controller
$ storage#dbProperty in class storage
storage::delete() — Method in class storage

Removes files or directories

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
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
$ mention_helper#dbProperty in class mention_helper
$ 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
$ 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.

extension_managerClass in namespace phpbb\composer

Class to safely manage extensions through composer.

$ extension_manager#extension_managerProperty in class extension_manager
$ manager#exception_prefixProperty in class manager
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

Executes the command db:list.

migrate::execute() — Method in class migrate

Executes the command db:migrate.

$ migration_command#extension_managerProperty in class migration_command
revert::execute() — Method in class revert

Executes the command db:migrate.

$ migration_tips#extension_managerProperty in class migration_tips
migration_tips::execute() — Method in class migration_tips

Executes the command dev:migration-tips.

disable::execute() — Method in class disable

Executes the command extension:disable.

enableClass in namespace phpbb\console\command\extension
enable::execute() — Method in class enable

Executes the command extension:enable.

install::execute() — Method in class install

Executes the command extension:install

list_available::execute() — Method in class list_available

Executes the command extension:install

manage::execute() — Method in class manage

Executes the command extension:install

purge::execute() — Method in class purge

Executes the command extension:purge.

remove::execute() — Method in class remove

Executes the command extension:install

show::execute() — Method in class show

Executes the command extension:show.

update::execute() — Method in class update

Executes the command extension:install

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

connection::exec() — Method in class connection

{@inheritDoc}

statement::execute() — Method in class statement

{@inheritDoc}

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#events_by_fileProperty 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
$ filespec_storage#extensionProperty in class filespec_storage
$ filespec_storage#errorProperty in class filespec_storage
$ 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
install_extensions::execute_step() — Method in class install_extensions

{@inheritdoc}

$ populate_migrations#extension_managerProperty in class populate_migrations
sequential_task::execute_step() — Method in class sequential_task

Callback function to execute a unit of work.

sequential_task::execute() — Method in class sequential_task

Execute the tasks with timeout management.

$ 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.

adapter_interface::exists() — Method in class adapter_interface

Checks the existence of files or directories

local::exists() — Method in class local

Checks the existence of files or directories

local::ensure_directory_exists() — Method in class local

Ensures that the directory of a file exists.

exceptionClass in namespace phpbb\storage\exception
storage::exists() — Method in class storage

Checks the existence of files or directories

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
eventClass in namespace phpbb\template\twig\tokenparser
$ event#environmentProperty in class event
$ twig#extension_managerProperty in class twig
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_storage#filesystemProperty in class acp_storage
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

$ 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#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
$ extension_manager#filesystemProperty in class extension_manager
html_output_formatter::format() — Method in class html_output_formatter

{@inheritdoc}

html_output_formatter::formatHtml() — Method in class html_output_formatter
$ 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

$ content_visibility#forums_tableProperty in class content_visibility
convertor::finish() — Method in class convertor

Render the final page of the convertor

$ 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

result::fetchNumeric() — Method in class result

{@inheritDoc}

result::fetchAssociative() — Method in class result

{@inheritDoc}

result::fetchOne() — Method in class result

{@inheritDoc}

result::fetchAllNumeric() — Method in class result

{@inheritDoc}

result::fetchAllAssociative() — Method in class result

{@inheritDoc}

result::fetchFirstColumn() — Method in class result

{@inheritDoc}

result::free() — Method in class result

{@inheritDoc}

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

$ manager#finder_factoryProperty in class manager
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
filespec_storageClass in namespace phpbb\files

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

$ filespec_storage#filenameProperty in class filespec_storage
$ filespec_storage#filesizeProperty in class filespec_storage
$ filespec_storage#file_movedProperty in class filespec_storage
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

form_storageClass in namespace phpbb\files\types
$ form_storage#factoryProperty in class form_storage
form_storage::form_upload() — Method in class form_storage

Form upload method Upload file from users harddisk

$ local#factoryProperty in class local
$ local_storage#factoryProperty in class local_storage
$ 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

factoryClass in namespace phpbb\finder

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

finderClass in namespace phpbb\finder

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

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

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
$ 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

friendClass in namespace phpbb\mention\source
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

mention::find_users_for_notification() — Method in class mention

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

$ 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
$ installer_resources_locator#filesystemProperty in class installer_resources_locator

phpBB's filesystem handler

base::forum_ids_with_indexing_enabled() — Method in class base

Return the ids of the forums that have indexing enabled

fulltext_mysqlClass in namespace phpbb\search\backend

Fulltext search for MySQL

fulltext_nativeClass in namespace phpbb\search\backend

phpBB's own db driven fulltext search, version 2

fulltext_postgresClass in namespace phpbb\search\backend

Fulltext search for PostgreSQL

fulltext_sphinxClass in namespace phpbb\search\backend

Fulltext search based on the sphinx search daemon

$ session#forwarded_forProperty in class session
adapter_interface::free_space() — Method in class adapter_interface

Get space available in bytes

$ local#filesystemProperty in class local

Filesystem component

local::file_size() — Method in class local

Get file size

local::file_mimetype() — Method in class local

Get file mimetype

local::file_image_width() — Method in class local

Get image width

local::file_image_height() — Method in class local

Get image height

local::free_space() — Method in class local

Get space available in bytes

attachment::filenameFallback() — Method in class attachment

Remove non valid characters https://github.com/symfony/http-foundation/commit/c7df9082ee7205548a97031683bc6550b5dc9551

controller::file_exists() — Method in class controller

Check if file exists

controller::file_gc() — Method in class controller

Garbage Collection

file_infoClass in namespace phpbb\storage
$ storage#factoryProperty in class storage
storage::file_info() — Method in class storage

Get file info

storage::free_space() — Method in class storage

Get space available in bytes

$ 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::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_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

$ 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_storage::get_current_provider() — Method in class acp_storage

Get the current provider from config

acp_storage::get_new_provider() — Method in class acp_storage

Get the new provider from the request

acp_storage::get_provider_options() — Method in class acp_storage

Get adapter definitions from a provider

acp_storage::get_current_definition() — Method in class acp_storage

Get the current value of the definition of a storage from config

acp_storage::get_new_definition() — Method in class acp_storage

Get the new value of the definition of a storage from the request

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)

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

helper::get_template_vars() — Method in class helper

Get an avatar's template variables.

helper::get_user_avatar() — Method in class helper

Get user avatar data.

helper::get_group_avatar() — Method in class helper

Get group avatar data.

helper::get_avatar() — Method in class helper

Get avatar data.

helper::get_no_avatar_source() — Method in class helper

Get the "no avatar" source string.

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

installer::get_installed_packages() — Method in class installer

Returns the list of currently installed packages

installer::get_available_packages() — Method in class installer

Gets the list of the available packages of the configured type in the configured repositories

installer::generate_ext_json_file() — Method in class installer

Generates and write the json file used to install the set of packages

installer::get_core_packages() — Method in class installer

Get the core installed packages

installer::get_core_php_requirement() — Method in class installer

Get the PHP version required by the core

installer::get_composer_repositories() — Method in class installer

Generate the repositories entry of the packages json file

installer::get_composer_ext_json_filename() — Method in class installer

Get the name of the json file used for the packages.

installer::get_extra_dependencies() — Method in class installer

Get extra dependencies required to install the packages

io_interface::get_composer_error() — Method in class io_interface

Returns the composer errors that occurred since the last tcall of the method.

null_io::get_composer_error() — Method in class null_io

Returns the composer errors that occurred since the last tcall of the method.

translate_composer_trait::get_composer_error() — Method in class translate_composer_trait
manager::get_managed_packages() — Method in class manager

Returns the list of managed packages for the current type

manager::get_all_managed_packages() — Method in class manager

Returns the list of managed packages for all phpBB types

manager::get_available_packages() — Method in class manager

Returns the list of available packages

manager_interface::get_managed_packages() — Method in class manager_interface

Returns the list of managed packages for the current type

manager_interface::get_all_managed_packages() — Method in class manager_interface

Returns the list of managed packages for all phpBB types

manager_interface::get_available_packages() — Method in class manager_interface

Returns the list of available packages

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.

case_insensitive_string::getSQLDeclaration() — Method in class case_insensitive_string

{@inheritdoc}

case_insensitive_string::getName() — Method in class case_insensitive_string

{@inheritdoc}

connection_factory::get_connection() — Method in class connection_factory

Creates a Doctrine DBAL connection from phpBB configuration.

connection_factory::get_connection_from_params() — Method in class connection_factory

Creates a database connection from the specified parameters.

connection_parameter_factory::get_configuration() — Method in class connection_parameter_factory

Returns configuration options for Doctrine DBAL.

driver::getDatabasePlatform() — Method in class driver

{@inheritDoc}

driver::getSchemaManager() — Method in class driver

{@inheritDoc}

driver::getExceptionConverter() — Method in class driver

{@inheritDoc}

oracle_platform::getVarcharTypeDeclarationSQL() — Method in class oracle_platform

{@inheritDoc}

oracle_platform::getAsciiStringTypeDeclarationSQL() — Method in class oracle_platform

{@inheritDoc}

oracle_platform::getCreateIndexSQL() — Method in class oracle_platform

{@inheritDoc}

oracle_platform::getIdentitySequenceName() — Method in class oracle_platform

{@inheritdoc}

oracle_platform::getCreateAutoincrementSql() — Method in class oracle_platform

{@inheritDoc}

postgresql_platform::getIdentitySequenceName() — Method in class postgresql_platform

{@inheritdoc}

postgresql_platform::getIntegerTypeDeclarationSQL() — Method in class postgresql_platform

{@inheritDoc}

postgresql_platform::getBigIntTypeDeclarationSQL() — Method in class postgresql_platform

{@inheritDoc}

postgresql_platform::getSmallIntTypeDeclarationSQL() — Method in class postgresql_platform

{@inheritDoc}

postgresql_platform::getDefaultValueDeclarationSQL() — Method in class postgresql_platform

{@inheritDoc}

postgresql_platform::getListSequencesSQL() — Method in class postgresql_platform

{@inheritDoc}

postgresql_platform::getDropIndexSQL() — Method in class postgresql_platform

{@inheritDoc}

sqlsrv_platform::getDefaultConstraintDeclarationSQL() — Method in class sqlsrv_platform

{@inheritDoc}

sqlsrv_platform::getAlterTableSQL() — Method in class sqlsrv_platform

{@inheritDoc}

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

doctrine::get_schema_manager() — Method in class doctrine
doctrine::get_schema() — Method in class doctrine
doctrine::get_filtered_index_list() — Method in class doctrine

Returns an array of indices for either unique and primary keys, or simple indices.

doctrine::get_asset_names() — Method in class doctrine

Returns an array of lowercase asset names.

factory::get() — Method in class factory
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\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

filespec_storage::get() — Method in class filespec_storage

Get property from file object

filespec_storage::get_extension() — Method in class filespec_storage

Get file extension

filespec_storage::get_mimetype() — Method in class filespec_storage

Get mime type

filespec_storage::get_filesize() — Method in class filespec_storage

Get file size

local::get_upload_ary() — Method in class local

Retrieve upload array

local_storage::get_upload_ary() — Method in class local_storage

Retrieve upload array

filesystem_exception::get_filename() — Method in class filesystem_exception

Returns the filename that triggered the error

helper::get_symfony_filesystem() — Method in class helper

Get an instance of symfony's filesystem object.

temp::get_dir() — Method in class temp

Get a temporary directory to write files

factory::get() — Method in class factory

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

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

{@inheritdoc}

install_extensions::get_task_lang_name() — Method in class install_extensions

{@inheritdoc}

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_helper::get_language_data_from_composer_file() — Method in class language_file_helper

Collect some data from the composer.json file

language_file_helper::get_language_data_from_json() — Method in class language_file_helper

Collect some data from the composer.json data

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

$ base_group#groupsProperty in class base_group
base_group::get_groups() — Method in class base_group

Returns data for all board groups

base_group::get_priority() — Method in class base_group

Returns the priority of the currently selected name Please note that simple inner priorities for a certain source can be set with ORDER BY SQL clause

base_group::get() — Method in class base_group

Searches database for names to mention and alters the passed array of found items

base_user::get_priority() — Method in class base_user

Returns the priority of the currently selected name Please note that simple inner priorities for a certain source can be set with ORDER BY SQL clause

base_user::get() — Method in class base_user

Searches database for names to mention and alters the passed array of found items

groupClass in namespace phpbb\mention\source
group::get_priority() — Method in class group

Returns the priority of the currently selected name Please note that simple inner priorities for a certain source can be set with ORDER BY SQL clause

source_interface::get() — Method in class source_interface

Searches database for names to mention and alters the passed array of found items

source_interface::get_priority() — Method in class source_interface

Returns the priority of the currently selected name Please note that simple inner priorities for a certain source can be set with ORDER BY SQL clause

topic::get_priority() — Method in class topic

Returns the priority of the currently selected name Please note that simple inner priorities for a certain source can be set with ORDER BY SQL clause

user::get_priority() — Method in class user

Returns the priority of the currently selected name Please note that simple inner priorities for a certain source can be set with ORDER BY SQL clause

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

mention::get_type() — Method in class mention

Get notification type name

mention::get_redirect_url() — Method in class mention

{inheritDoc}

mention::get_email_template() — Method in class mention

Get email template

mention::get_email_template_variables() — Method in class mention

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.

base::get_posts_batch_after() — Method in class base

Get batch of posts after id

base::get_max_post_id() — Method in class base

Get post with higher id

base::get_type() — Method in class base

Gets backend class

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_mysql::get_acp_options() — Method in class fulltext_mysql

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

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

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

fulltext_native::get_acp_options() — Method in class fulltext_native

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

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

{@inheritdoc}

fulltext_postgres::get_acp_options() — Method in class fulltext_postgres

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

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_common_words() — Method in class fulltext_sphinx

Returns the common_words array

fulltext_sphinx::get_word_length() — Method in class fulltext_sphinx

Returns the word_length array

fulltext_sphinx::get_stats() — Method in class fulltext_sphinx

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

fulltext_sphinx::get_acp_options() — Method in class fulltext_sphinx

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

fulltext_sphinx::get_type() — Method in class fulltext_sphinx

Gets backend class

search_backend_interface::get_name() — Method in class search_backend_interface

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

search_backend_interface::get_search_query() — Method in class search_backend_interface

Returns the search_query

search_backend_interface::get_common_words() — Method in class search_backend_interface

Returns the common_words array

search_backend_interface::get_word_length() — Method in class search_backend_interface

Returns the word_length array

search_backend_interface::get_acp_options() — Method in class search_backend_interface

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

search_backend_interface::get_type() — Method in class search_backend_interface

Gets backend class

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_item::get_name() — Method in class config_item

Getter for the item's name

config_section::get_variable_by_name() — Method in class config_section

Get a variable object by its name

search_backend_factory::get() — Method in class search_backend_factory

Obtains a specified search backend

search_backend_factory::get_active() — Method in class search_backend_factory

Obtains active search backend

adapter_interface::get_contents() — Method in class adapter_interface

Read the contents of a file

adapter_interface::get_link() — Method in class adapter_interface

Get direct link

local::get_contents() — Method in class local

Read the contents of a file

local::get_path() — Method in class local

Get the path to the file, appending subdirectories for directory depth if $dir_depth > 0.

local::get_filename() — Method in class local

To be used in other PR

local::get_link() — Method in class local

Get direct link

adapter_factory::get() — Method in class adapter_factory

Obtains a configured adapters for a given storage

exception::get_filename() — Method in class exception

Returns the filename that triggered the error

file_info::get() — Method in class file_info

Load propertys lazily

local::get_name() — Method in class local

Gets adapter name

local::get_adapter_class() — Method in class local

Gets adapter class

local::get_options() — Method in class local

Gets adapter options

provider_interface::get_name() — Method in class provider_interface

Gets adapter name

provider_interface::get_adapter_class() — Method in class provider_interface

Gets adapter class

provider_interface::get_options() — Method in class provider_interface

Gets adapter options

storage::get_name() — Method in class storage

Returns storage name

storage::get_adapter() — Method in class storage

Returns an adapter instance

storage::get_contents() — Method in class storage

Read the contents of a file

storage::get_link() — Method in class storage

Get direct link

storage::get_size() — Method in class storage

Get total storage size

storage::get_num_files() — Method in class storage

Get number of storage files

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 includes all css assets

assets_bag::get_scripts_content() — Method in class assets_bag

Returns the HTML code to includes 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.

icon::getName() — Method in class icon

Returns the name of this extension.

icon::getFunctions() — Method in class icon

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

icon::get_first_icon() — Method in class icon

Finds the first icon that has a "true" value and returns it.

icon::get_style_list() — Method in class icon

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

routing::getFunctions() — Method in class routing

{@inheritdoc}

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.

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_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

$ mention_helper#group_profile_urlProperty in class mention_helper
mention_helper::get_mentionable_groups() — Method in class mention_helper

Get group IDs allowed to be mentioned by current user

mention_helper::get_user_ids_for_group() — Method in class mention_helper

Selects IDs of user members of a certain group

mention_helper::get_mentioned_user_ids() — Method in class mention_helper

Get a list of mentioned user IDs

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_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_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.

helperClass in namespace phpbb\avatar

Avatar helper object.

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.

html_output_formatterClass in namespace phpbb\composer\io
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
$ filespec_storage#heightProperty in class filespec_storage
upload::handle_upload() — Method in class upload

Handle upload based on type

helperClass in namespace phpbb\filesystem
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

mention::handle() — Method in class mention

Handle requests to mention controller

$ base_group#helperProperty in class base_group
$ mention#helperProperty in class mention
$ 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
attachment::handle() — Method in class attachment

Handler

avatar::handle() — Method in class avatar

Handler

controller::handle() — Method in class controller

Handler

$ routing#helperProperty in class routing
$ reset_password#helperProperty in class reset_password
$ version_helper#hostProperty in class version_helper
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

Execute action depending on the action and state

acp_search_info::install() — Method in class acp_search_info
acp_storage_info::install() — Method in class acp_storage_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