[Global Namespace]
Namespaces
Classes
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
- 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
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
ACP Permission/Auth class
BBCode class
BBCODE FIRSTPASS BBCODE first pass class (functions for parsing messages for db storage)
Class for handling archives (compression/decompression)
Tar/tar.gz compression routine Header/checksum creation derived from tarfile.pl, (c) Tom Horsley, 1994
Zip creation class from phpMyAdmin 2.3.0 (c) Tobias Ratschiller, Olivier Müller, Loïc Chapeaux, Marc Delisle, http://www.phpmyadmin.net/
Code from pear.php.net, Text_Diff-1.1.0 package http://pear.php.net/package/Text_Diff/
A class for computing three way diffs.
Code from pear.php.net, Text_Diff-1.1.0 package http://pear.php.net/package/Text_Diff/ (native engine)
Code from pear.php.net, Text_Diff-1.1.0 package http://pear.php.net/package/Text_Diff/
"Inline" diff renderer.
"raw" diff renderer.
"chora (Horde)" diff renderer - similar style.
Renders a unified diff
FTP transfer class
FTP fsock transfer class
Jabber class from Flyspray project
This file is part of the phpBB Forum Software package.
mcp_logs Handling warning the users
This file is part of the phpBB Forum Software package.
mcp_main Handling mcp actions
This file is part of the phpBB Forum Software package.
mcp_notes Displays notes about a user
This file is part of the phpBB Forum Software package.
mcp_reports Handling the reports queue
This file is part of the phpBB Forum Software package.
mcp_queue Handling the moderation queue
This file is part of the phpBB Forum Software package.
mcp_reports Handling the reports queue
This file is part of the phpBB Forum Software package.
mcp_warn Handling warning the users
This file is part of the phpBB Forum Software package.
Class handling all types of 'plugins' (a future term)
Main message parser for posting, pm, etc. takes raw message and parses it for attachments, bbcode and smilies
This class collects data which is used to create some usage statistics.
Questionnaire PHP data provider
Questionnaire phpBB data provider
Questionnaire System data provider
handling email and jabber queue
SMTP Class Auth Mechanisms originally taken from the AUTH Modules found within the PHP Extension and Application Repository (PEAR) See docs/AUTHORS for more details
Transfer class, wrapper for ftp/sftp/ssh
ucp_activate User activation
ucp_attachments User attachments
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
ucp_confirm Visual confirmation
This file is part of the phpBB Forum Software package.
ucp_login_link Allows users of external accounts link those accounts to their phpBB accounts during an attempted login.
ucp_main UCP Front Panel
This file is part of the phpBB Forum Software package.
This file is part of the phpBB Forum Software package.
Private Message Class
This file is part of the phpBB Forum Software package.
ucp_prefs Changing user preferences
This file is part of the phpBB Forum Software package.
ucp_profile Changing profile settings
This file is part of the phpBB Forum Software package.
ucp_register Board registration
ucp_resend Resending activation emails
This file is part of the phpBB Forum Software package.
Functions
No description
Add the search bots into the database This code should be used in execute_last if the source database did not have bots If you are converting bots this function should not be called
Add any of the pre-defined "special" groups which are missing from the database
Add a secret token to the form (requires the S_FORM_TOKEN template variable)
No description
deprecated
Add log entry
Add permission language - this will make sure custom files will be included
Adds a user to the specified group and optionally makes them a group leader This function does not create the group if it does not exist and so should only be called after the groups have been created
Insert the warning into the database
Generate back link for acp pages
Header for acp pages
Append session id to url.
No description
Generate a key value based on existing values
Function auto_prune(), this function now relies on passed vars
Remove avatar
Remove avatar also for users not having the group as default
No description
custom version of nl2br which takes custom BBCodes into account
Build the hidden field for the recipients. Needed, as the variable is not read via $request->variable().
Build configuration template for acp configuration pages
Build select field options in acp pages
Returns url from the session/current page with an re-appended SID with optionally stripping vars from the url
Bump Topic Check - used by posting and viewtopic
deprecated
Cache moderators. Called whenever permissions are changed via admin_permissions. Changes of usernames and group names must be carried through for the moderators table.
Censoring
Change a post's poster
Change Topic Type
Check the form key. Required for all altering actions not secured by confirm_box
checks a link hash - for GET requests
Check Rule against Message Information
Delete Messages From Sentbox we are doing this here because this saves us a bunch of checks and queries
Closes a report
No description
Compose private message Called from ucp_pm with mode == 'compose'
Build Confirm box
No description
No description
No description
Copies permissions from one forum to others
Create Thumbnail
Convert a value from days to seconds
Return the preceding value
Reverse the encoding of wild-carded bans
Convert an IP address from the hexadecimal notation to normal dotted-quad notation
Decode text whereby text is coming from the db and expected to be pre-parsed content We are placing this outside of the message parser because we are often in need of it...
NOTE: special chars are kept encoded
Defining action option for message rules
Defining check option for message rules
Defining condition option for message rules
Defining rule option for message rules
deprecated
Delete Attachments
Delete PM(s)
Delete Post
Remove post(s)
Deletes shadow topics pointing to a specified forum.
Remove topic(s)
No description
Display ban options
Assign/Build custom bbcodes for display in screens supporting using of bbcodes The custom bbcodes buttons will be placed within the template block 'custom_tags'
Display Forums
deprecated
Display reasons
Display user activity (action forum/topic)
Check if downloading item is allowed
Enables a particular flag in a bitfield column of a given table.
Handler for exit calls in phpBB.
Check if extension is allowed to be posted.
Extract the variables defined in a configuration file
Garbage Collection
Get physical file listing
No description
Ensure that all users have a default group specified and update related information such as their colour
Closing the cache object and the database Cool function name, eh? We might want to add operations to it later
User authorisation levels output
Generates an alphanumeric random string of given length
Generates a user-friendly alphanumeric random string of given length We remove 0 and O so users cannot confuse those in passwords etc.
Generate sort selection fields
Generate board url (example: http://www.example.com/phpBB)
Create forum rules for given forum
Add a secret hash for use in links/GET requests
Fill smiley templates (or just the variables) with smilies, either in a window or inline
For display of custom parsed text on user-facing pages Expects $text to be the value directly from the database (stored value)
For decoding custom parsed text for edits as well as extracting the flags Expects $text to be the value directly from the database (pre-parsed content)
For parsing custom parsed text to be stored within the database.
No description
Generates avatar filename from the database entry
Obtain the height of the specified avatar
Obtain the width of the specified avatar
Return a nicely formatted backtrace.
Return the bitfield calculated by the previous function
Generate regexp for naughty words censoring Depends on whether installed PHP version supports unicode properties
Get topic tracking info from db (for cookie based tracking only this function is used)
Retrieves configuration information from the source forum and caches it as an array Both database and file driven configuration formats can be handled (the type used is specified in $config_schema, see convert_phpbb20.php for more details)
Get old config value
Generates a text with approx. the specified length which contains the specified words and their context
Get database size
Get all folder
Get folder status
Return formatted string for filesizes
Get forum branch
Obtain authed forums list
Returns forum parents as an array. Get them from forum_data if available, or update the database otherwise
Obtain the size of the specified gallery avatar (using the cache if possible) and cache the value
Return the group_id for a given group name
Get group name
Calculate the size of the specified image Called from the following functions for calculating the size of specific image types
Calculate the needed size for Thumbnail
Obtain list of moderators of each forum
No description
Get Messages from folder/user
This function returns a regular expression pattern for commonly used expressions Use with / as delimiter for email mode and # for url modes mode can be: email|bbcode_htm|url|url_inline|www_url|www_url_inline|relative_url|relative_url_inline|ipv4|ipv6
Generates an array of coloured recipient names from a list of PMs - (groups & users)
Get number of 'num_recipients' recipients from first position
Obtain the size of the specified remote avatar (using the cache if possible) and cache the value Whilst it's unlikely that remote avatars will be duplicated, it is possible so caching seems the best option This should only be called from a post processing step due to the possibility of network timeouts
deprecated
Retrieve contents from remotely stored file
Obtain the size of the specified smilie (using the cache if possible) and cache the value
No description
Obtain the height of the specified smilie
Obtain the width of the specified smilie
Return supported image types
deprecated
Get tables of a database
Get topic tracking info by using already fetched info
Get list of unread topics
Obtain the size of the specified uploaded avatar (using the cache if possible) and cache the value
deprecated
Get user avatar
Get user information (only for message display)
deprecated
Get user rank title and image
Get username details for placing into templates.
Changes a group avatar's filename to conform to the naming scheme
Add or edit a group. If we're editing a group we only update user parameters such as rank, etc. if they are changed
Group Delete
Obtain either the members of a specified group, the groups the specified user is subscribed to or checking if a specified user is in a specified group. This function does not return pending memberships.
Generate list of groups (option fields without select)
Set users default group
Re-cache moderators and foes if group has a or m permissions
Add user(s) to group
This is used to promote (to leader), demote or set as default a member/s
Remove a user/s from a given group. When we remove users we update their default group_id. We do this by examining which "special" groups they belong to. The selection is made based on a reasonable priority system
A small version of validate_username to check for a group name's existence. To be called directly.
Build radio fields in acp pages
Handle all actions possible with marked messages
For composing messages, handle list actions
Get a browser friendly UTF-8 encoded filename
No description
No description
No description
No description
No description
No description
Return the next value
Register class loaders for installer
No description
Installer shutdown function. Tries to resolve errors that might have occured during execution of installer
Function to mimic php's empty() function (it is the same)
Convert a boolean into the appropriate phpBB constant indicating whether the item is locked
Return whether the value is positive
Convert a boolean into the appropriate phpBB constant indicating whether the topic is locked
Determine whether a user is anonymous and return the appropriate new user_id
Pick a language, any language .
Load Drafts
Lock/Unlock Topic/Post
Generate login box or verify password
Generate forum login box
Encodes the given string for proper display in UTF-8 or US-ASCII.
Replaces magic urls of form http://xxx.xxx., www.xxx. and [email protected].
A subroutine of make_clickable used with preg_replace It places correct HTML around an url, shortens the displayed text and makes sure no entities are inside URLs
Simple version of jumpbox, just lists authed forums
Generate Jumpbox
Generate a bbcode_uid value
No description
No description
Marks a topic/forum as read Marks a topic as posted to
Grant permissions to a specified user or group
Delete Posts
Delete Topics
Fork Topic
MCP Forum View
MCP Front Panel
Move Topic
Handling actions in post details screen
Restore Topics
Resync topics
View topic in MCP
Merge selected posts into selected topic
Merge selected topics into selected topic
Display Message History
Execute message options
Meta refresh assignment Adds META template variable with meta http tag.
Determine the MIME-type of a specified filename This does not actually inspect the file, but simply uses the file extension
Convert a value from minutes to hours
Move PM from one to another folder
Move post(s)
Move topic(s)
Error and message handler, call with trigger_error if read
Boolean inverse of the value
Convert nulls to empty strings for fields which allowed a NULL value in the source but not the destination
Convert nulls to zeros for fields which allowed a NULL value in the source but not the destination
Return number of private message recipients
Queries the session table to get information about online guests
Queries the session table to get information about online users
Uses the result of obtain_users_online to generate a localized, readable representation.
Generate page header
General attachment parsing
deprecated
Parse cfg file
No description
No description
Add an option to the quick-mod tools.
Convert the attachment category constants This is only used if the Attachment MOD was installed
Convert the attachment extension names This is only used if the Attachment MOD was installed
Obtain list of forums in which different attachment categories can be used
Returns an explanation string with maximum avatar settings
Convert the avatar type constants
HTML-less version of build_cfg_template
Handle topic bumping
Cache moderators. Called whenever permissions are changed via admin_permissions. Changes of usernames and group names must be carried through for the moderators table.
deprecated
Check and display the SQL report if requested.
deprecated
Check for correct password
Validate ids
No description
deprecated
Wrapper for php's checkdnsrr function.
deprecated
Global function for chmodding directories and files for internal use
deprecated
Eliminates useless . and .. components from specified path.
Cleans a search string by removing single wildcards from it and replacing multiple spaces with a single one.
Convert authentication user, group and forum table has to be filled in order to work
Convert the group name, making sure to avoid conflicts with 3.0 special groups
Convert the group type constants
No description
No description
Convert the topic type constants
Copy thumbnails of uploaded images from the 2.0.x forum This is only used if the Attachment MOD was installed
Checks whether there are any usernames on the old board that would map to the same username_clean on phpBB3. Prints out a list if any exist and exits.
deprecated
Delete all PM(s) for a given user and delete the ones without references
Delete all PM(s) for given users and delete the ones without references
Adjust 2.0.x disallowed names to 3.0.x format
Checks whether a user can download from a particular PM
Handles authentication when downloading attachments from a post or topic
Handles authentication when downloading attachments from PMs
deprecated
Hashes an email address to a big integer
Generate URL parameters for MCP modules
Removes absolute path to phpBB root directory from error messages and converts backslashes to forward slashes.
Searches for HTTP range request in request headers.
Formats the quote according to the given BBCode status setting
Format the timezone offset with hours and minutes
Set forum flags - only prune old polls by default
Generate the debug output string
Concatenate an array into a string list.
deprecated
Get avatar
Find out about the avatar's dimensions
Find out about the avatar's dimensions
Gets user ids of currently banned registered users.
Convert Birthday from Birthday MOD to phpBB Format
Get the board contact details (e.g. for emails)
Get a clickable board contact details link
Obtain the path to uploaded files on the 2.0.x forum This is only used if the Attachment MOD was installed
Get simple forum data
deprecated
Get group avatar
Returns the install redirect path for phpBB.
Get the maximum PM setting for the groups of the user
Get the number of ips for a given poster
Get the number of posters for a given ip
deprecated
Determine which plural form we should use.
Get simple pm data
Get simple post data
Obtain the folder_id for the custom folder created to replace the savebox from 2.0.x (used to store saved private messages)
Return list of timezone identifiers We also add the selected timezone if we can create an object with it.
Get simple topic data
deprecated
Get user avatar
Get user rank title and image
Wrapper for getdate() which returns the equivalent array for UTC timestamps.
Do the various checks required for removing posts as well as removing it
deprecated
Hash the password
HTTP range support (RFC 2616 Section 14.35)
deprecated
Login using http authenticate.
Transfer attachment specific configuration options These were not stored in the main config table on 2.0.x This is only used if the Attachment MOD was installed
Transfer avatars, copying the image if it was uploaded
Calculate the reason a user became inactive We can't actually tell the difference between a manual deactivation and one for profile changes from the data available to assume the latter
Calculate the date a user became inactive
No description
Increments the download count of all provided attachments
No description
deprecated
Wrapper for inet_pton()
Inserts new config display_vars into an exisiting display_vars array at the given position.
Insert/Convert forums
Normalises an internet protocol address, also checks whether the specified address is valid.
deprecated
Checks if a path ($path) is absolute or relative
Check if the browser is internet explorer version 7+
deprecated
Test if a file/directory is writable
Pick a language, any language .
Load the autoloaders added by the extensions.
Wrapper for sending out emails with the PHP's mail function
sorting in mcp
Functions used to generate additional URL paramters
No description
No description
No description
No description
No description
No description
No description
Function for assigning a template var if the zebra module got included
Wrapper for mt_rand() which allows swapping $min and $max parameters.
Calculate whether a private message was new using the bitfield
Get option bitfield from custom data
Set option bitfield
Analyses a range request array.
deprecated
No description
Determine the last user to edit a post In practice we only tracked edits by the original poster in 2.0.x so this will only be set if they had edited their own post
Reparse the message stripping out the bbcode_uid values and adding new ones and setting the bitfield
Calculate the correct to_address field for private messages
Escapes and quotes a string for use as an HTML/XML attribute value.
deprecated
A wrapper for realpath
No description
Returns the HTTP version used in the current request.
No description
Same as phpbb_set_encoding, but forcing boards default language
Function for recoding text with the default language
Set primary group.
Prepare profile data
Just undos the replacing of '<' and '>'
No description
Verifies whether a style ID corresponds to an active style.
Options to pick a timezone and date/time
deprecated
Casts a numeric string $input to an appropriate numeric type (i.e. integer or float)
Return correct user id value Everyone's id will be one higher to allow the guest/anonymous user to have a positive id as well
Compares two time zone labels.
deprecated
Delete attached file
Calculate whether a private message was unread using the bitfield
Removes moderators and administrators from foe lists.
Show upload popup (progress bar)
Return correct user id value Everyone's id will be one higher to allow the guest/anonymous user to have a positive id as well
Handler for init calls in phpBB. This function is called in \phpbb\user::setup(); This function supports hooks.
Check to see if email address is a valid address and contains a MX record
Validate hex colour value
Validate Timezone Name
Wrapper for version_compare() that allows using uppercase A and B for alpha and beta releases.
Place new messages into appropriate folder
Generate inline attachment entry
Assign Inline attachments (build option fields)
Generate Topic Icons for display
Build topic types able to be selected
Prune function
Re-Apply session id after page reloads
Rebuild message header
Recalculate Nested Sets
Redirects the user to another page then exits the script nicely This function is intended for urls within the board. It's not meant to redirect to cross-domains.
Sets compatibility globals in the global scope
No description
Obtain the dimensions of all remotely hosted avatars This should only be called from execute_last There can be significant network overhead if there are a large number of remote avatars
Removes the group avatar of the default group from the users in user_ids who have that group as default.
Removes the group rank of the default group from the users in user_ids who have that group as default.
Cleanly remove invalid user entries after converting the users table.
Funtion to make a user leave the NEWLY_REGISTERED system group.
deprecated
Wrapper function of \phpbb\request\request::variable which exists for backwards compatability.
Transfers the relevant configuration information from the source forum The mapping of fields is specified in $config_schema, see convert_phpbb20.php for more details
A simplified function to deliver avatars The argument needs to be checked before calling this function.
Send file to browser
Outputs correct status line header.
deprecated
Sets a configuration option's value.
deprecated
Increments an integer config value directly in the database.
Check if the browser has the file already and set the appropriate headers-
Set correct users max messages in PM folder.
No description
Convert a boolean into the appropriate phpBB constant indicating whether the user is active
deprecated
Casts a variable to the given type.
Returns the first block of the specified IPv6 address and as many additional ones as specified in the length parameter.
Display defined message rules
Generate size select options
Smiley processing
Replacement or substitute for PHP's mail command
No description
No description
No description
No description
No description
Split topic
Determine whether we are approaching the maximum execution time. Should be called once at the beginning of the script in which it's used.
Convert a textual value to it's equivalent boolean value
Convert the name of a user's primary group to the appropriate equivalent phpBB group id
Strips all bbcode from a text in place
Pick a template/theme combo
Submit PM
Submit Post
All-encompasing sync function
Sync post count. We might need to do this in batches.
Tidy database, doing some maintanance tasks
No description
Topic Review
Generate topic status
Transform an array into a serialized format
Transform a serialized array into an actual array
Truncates string while retaining special characters if going over the max length The default max length is 60 at the moment The maximum storage length is there to fit the string within the given length. The string may be further truncated due to html entities.
deprecated
Pick a timezone
Return unique id
Update any dynamic configuration variables after the conversion is finished
deprecated
Removes moderators and administrators from foe lists.
Update the count of PM's in custom folders for all users
Check for read forums and update topic tracking info accordingly
Get latest registered username and update database to reflect it
Update user PM count
Update last post information Should be used instead of sync() if only the last post information are out of sync... faster
Update/Sync posted information for topics
Updates topics_posted entries
Update the count of unread private messages for all users
Update unread message status
deprecated
Upload Attachment - filedata is generated here Uses upload class
Flips user_type from active to inactive and vice versa, handles group membership updates
Adds an user
deprecated
Add a ban or ban exclusion to the banlist. Bans either a user, an IP or an email address
Delete user(s) and their related data
Obtain user_ids from usernames or vice versa. Returns false on success else the error string
Add users to the pre-defined "special" groups
Internet Protocol Address Whois RFC3912: WHOIS Protocol Specification
deprecated
Unban User
Updates a username across all relevant tables/fields
UTF8-safe basename() function
Case folds a unicode string as per Unicode 5.0, section 3.13
Assume the input is NFC: Takes the input and does a "special" case fold. It does minor normalization as well.
Takes the input and does a "special" case fold. It does minor normalization and returns NFKC compatable text
Converts an NCR to a UTF-8 char
This function is used to generate a "clean" version of a string.
Trying to convert returned system message to utf8
Convert Numeric Character References to UTF-8 chars
Callback used in decode_ncr()
Replace all UTF-8 chars that are not in ASCII with their NCR using their Numeric Character Reference's Hexadecimal notation.
Callback used in utf8_encode_ncr() and utf8_encode_ucr()
Replace some special UTF-8 chars that are not in ASCII with their UCR.
A wrapper for htmlspecialchars($value, ENT_COMPAT, 'UTF-8')
wrapper around PHP's native normalizer from intl previously a PECL extension, included in the core since PHP 5.3.0 http://php.net/manual/en/normalizer.normalize.php
Converts a UTF-8 char to an NCR
Recode a string to UTF-8
UTF-8 aware alternative to str_split Convert a string to an array
Return the length (in characters) of a UTF-8 string
UTF-8 aware alternative to strpos
UTF-8 aware alternative to strrpos
UTF-8 aware alternative to strspn Find length of initial segment matching the mask
UTF-8 aware alternative to strtolower
UTF-8 aware alternative to strtoupper
UTF-8 aware alternative to substr
UTF-8 aware alternative to ucfirst Make a string's first character uppercase
UTF8-compatible wordwrap replacement
Going through a config array and validate values, writing errors to $error. The validation method accepts parameters separated by ':' for string and int.
Data validation ... used primarily but not exclusively by ucp modules
Validate Date
Validate jabber address Taken from the jabber class within flyspray (see author notes)
Validate Language Pack ISO Name
Validate Match
Validate Number
Check to see if the password meets the complexity settings
Checks whatever or not a variable is OK for use in the Database param mixed $value_ary An array of the form array(array('lang' => ..., 'value' => ..., 'column_type' =>))' param mixed $error The error array
Validate String
Check to see if email address is banned or already present in the DB
No description
Validate a website address
View message folder Called from ucp_pm with mode == 'view' && action == 'view_folder'
Lists inactive users
View log
View private message
Lists warned users
Topic and forum watching common code
No description
Wraps an url into a simple html page. Used to display attachments in IE.
Print out/assign recipient information