Soda Tasting, an online show for those who love soda

Bookmark and Share

phpBB Files at a Glance

phpBB Files at a Glance

Postby Thoul » November 24th 2003, 8:16 pm

This is a quick glance at the PHP files used in phpBB and what each one is used to accomplish.

Files in the root folder
These are the main phpBB files that users often access.

common.php
Starts the real processing of phpBB page by setting up variables, including commonly used files and getting configuration data.

config.php
Holds database details (username, password, etc).

extension.inc
First file included in a phpBB page. Holds the filename extension of PHP files and a place holder for starting calculation of page generation times.

faq.php
Displays a forum's FAQ and BBCode Guide pages.

groupcp.php
User Group Control Panel pages.

index.php
Displays main forum page and category pages.

login.php
Handles logging users in and out.

memberlist.php
Displays a list of all forum members and some profile information.

modcp.php
Moderator Control Panel pages.

posting.php
Displays posting form for new topics, new private messages and replies to both.

privmsg.php
Private Messages control panel. Displays PM boxes (Inbox, Outbox, etc.) and handles moving/deleting of PMs. Note that all PM sending is done through posting.php.

profile.php
A placeholder page for registration, profile editing and other profile related functions. It will include usercp_viewprofile.php, usercp_register.php, usercp_sendpasswd.php, usercp_activate.php or usercp_email.php as needed.

search.php
The forum search engine.

viewforum.php
Displays a list of topics in a forum.

viewonline.php
Displays a list of online users.

viewtopic.php
Displays posts in a topic.

Files in the admin/ folder
These files create the Administration Panel of a forum.

admin_board.php
Manages the Configuration page.

admin_db_utilities.php
Database maintenance utilities provided by phpBB.

admin_disallow.php
Allows you to disallow certain usernames from being registered.

admin_forum_prune.php
Manage forum pruning settings.

admin_forumauth.php
Set the authorization levels for a forum.

admin_forums.php
Create, delete and otherwise manage forums and categories.

admin_groups.php
Create, delete and otherwise manage usergroups.

admin_mass_email.php
Send an e-mail to all forum members.

admin_ranks.php
Manage and create rank settings.

admin_smilies.php
Edit and add smilies for your forum.

admin_styles.php
Add, edit or delete forum styles.

admin_ug_auth.php
Set permissions for users and usergroups.

admin_user_ban.php
Manage user ban settings.

admin_users.php
An admin-only version of the profile editor with some added options. Admins can edit anyone's profile.

admin_words.php
Control the word censor.

index.php
Creates the three main Admin Panel index pages. The first is the frameset that displays the navigation frame and the main page of the Admin Panel. The other two pages created by index.php are the navigation frame and the main ACP page.

page_footer_admin.php
Builds the admin panel page footer, closes the database connection and outputs the page.

page_header_admin.php
Creates the admin panel page header and defines global template variables that can be used on any page.

pagestart.php
Checks to see if a user trying to access the admin panel is logged in and a board admin. Also includes page_header_admin.php.

Files in the includes/ folder
These files are never accessed directly. Instead, they are included into the files listed above when needed. Typically, these files will contain a series of functions or classes used in the other files.

auth.php
Functions that handle phpBB authorization system.

bbcode.php
Functions that handle converting BBCode to matching HTML, posted URLs to clickable links and reverting those conversions.

constants.php
Defines PHP-style constants used throughout phpBB.

db.php
A placeholder file that will include the database management file appropriate for the database the forum is installed on. In addition, this file will connect to the database.

emailer.php
Contains the emailer class, which is used to compose and send all outgoing e-mails from the forum.

functions.php
Holds commonly used functions.

functions_admin.php
Holds functions used in the admin panel.

functions_post.php
Holds functions relating to making or viewing posts.

functions_search.php
Holds functions dealing with the the forum search engine.

functions_selects.php
Functions related to building HTML select boxes for forms (a.k.a. drop down lists).

functions_validate.php
Contains functions for checking form input and ensuring that it meets certain specifications.

page_header.php
Creates the commonly used forum header and defines global template variables that can be used on any page.

page_tail.php
Builds the commonly used forum footer, closes the database connection and outputs the page.

prune.php
Handles pruning of forums.

sessions.php
Contains the session management functions.

smtp.php
Includes phpBB's SMTP e-mail functions, used for sending e-mail when a SMTP server is defined in the Admin Panel.

sql_parse.php
Parses uploaded *.sql files into a format usable for database interaction. Used by the installer, database restoration utility and some hack installers.

template.php
Contains the Template class, which handles the creation of HTML output based on the *.tpl files.

topic_review.php
Generates the Topic Review box at the bottom of a reply posting page.

usercp_activate.php
Deals with user activation of accounts.

usercp_avatar.php
Handles avatar management in profiles, including uploads and the avatar gallery.

usercp_email.php
Displays a form for sending e-mail to other users through the forum.

usercp_register.php
Processes user registration and profile editing.

usercp_sendpasswd.php
Sends forgotten passwords.

usercp_viewprofile.php
Displays a user's profile page.

Files in the language/ folder
These files hold all the language specific messages on a forum. The actual files will be in subdirectories named after the language. The English language files, for example, are in lang_english. French files would be in lang_french. Each language directory also includes an "email" subdirectory, which contains template files for e-mails a forum may send out.

lang_admin.php
Language strings for the admin panel.

lang_bbcode.php
FAQ entries for the BBCode Guide.

lang_faq.php
FAQ entries for the main forum FAQ.

lang_main.php
Language strings for the main forum areas.

search_stopwords.txt
Words that should be excluded from indexing by the forum search engine. You can add words, one per line, to this file to prevent your database from being overcrowded by commonly used words. Many common words like "a," "and," "the", etc. are already included.

search_synonyms.txt
Also used by the search engine, this file lists two words per line. It makes the forum look for both words when either is entered into the forum search. This allows searching to return results for alternate spellings of words; for example, "color" also returns results for "colour."

Files in the db/ folder
These files make up the Database Abstraction Layer. Each file corresponds to a particular type of database software based on the name of the file. The phpBB Database Layer tutorial has more details about these files.
User avatar
Thoul
Admin/Webmaster
 
Posts: 18551
Joined: July 30th 2002, 11:30 am
Location: USA

Return to phpBB 2: Technical Reference

Who is online

Users browsing this forum: No registered users and 0 guests