diff --git a/phpBB/docs/coding-guidelines.html b/phpBB/docs/coding-guidelines.html
index 45bdb5d422..d220bfa740 100644
--- a/phpBB/docs/coding-guidelines.html
+++ b/phpBB/docs/coding-guidelines.html
@@ -190,19 +190,12 @@ class ...
- phpBB3
Core files and all files not assigned to a separate package
- - acm
/includes/cache
Cache System
+ - acm
/phpbb/cache
Cache System
- acp
/adm
, /includes/acp
, /includes/functions_admin.php
Administration Control Panel
- - dbal
/includes/db
Database Abstraction Layer.
Base class is dbal
+ - dbal
/phpbb/db
, /includes/db
Database Abstraction Layer.
- /includes/db/dbal.php
Base DBAL class, defining the overall framework
- /includes/db/firebird.php
Firebird/Interbase Database Abstraction Layer
- /includes/db/msssql.php
MSSQL Database Abstraction Layer
- /includes/db/mssql_odbc.php
MSSQL ODBC Database Abstraction Layer for MSSQL
- /includes/db/mysql.php
MySQL Database Abstraction Layer for MySQL 3.x/4.0.x/4.1.x/5.x
- /includes/db/mysqli.php
MySQLi Database Abstraction Layer
- /includes/db/oracle.php
Oracle Database Abstraction Layer
- /includes/db/postgres.php
PostgreSQL Database Abstraction Layer
- /includes/db/sqlite.php
Sqlite Database Abstraction Layer
+ /phpbb/db/driver/
Database Abstraction Layer classes
+ /phpbb/db/migration/
Migrations are used for updating the database from one release to another
- diff
/includes/diff
Diff Engine
@@ -210,12 +203,12 @@ class ...
- images
/images
All global images not connected to styles
- install
/install
Installation System
- language
/language
All language files
- - login
/includes/auth
Login Authentication Plugins
+ - login
/phpbb/auth
Login Authentication Plugins
- VC
/includes/captcha
CAPTCHA
- mcp
mcp.php
, /includes/mcp
, report.php
Moderator Control Panel
- ucp
ucp.php
, /includes/ucp
User Control Panel
- utf
/includes/utf
UTF8-related functions/classes
- - search
/includes/search
, search.php
Search System
+ - search
/phpbb/search
, search.php
Search System
- styles
/styles
phpBB Styles/Templates/Themes
@@ -249,7 +242,7 @@ PHPBB_QA (Set board to QA-Mode, which means the updater also c
If the PHPBB_USE_BOARD_URL_PATH
constant is set to true, phpBB uses generate_board_url() (this will return the boards url with the script path included) on all instances where web-accessible images are loaded. The exact locations are:
- - /includes/user.php - phpbb_user::img()
+ - /phpbb/user.php - \phpbb\user::img()
- /includes/functions_content.php - smiley_text()
@@ -332,28 +325,26 @@ for ($i = 0; $i < $outer_size; $i++)
Apart from following the rules for function names, all classes should meet the following conditions:
- Every class must be defined in a separate file.
- - The classes have to be located in a subdirectory of
includes/
.
- - Classnames to be prefixed with
phpbb_
to avoid name clashes, the filename should not contain the prefix.
- - Class names have to reflect the location of the file they are defined in. The longest list of prefixes, separated by underscores, which is a valid path must be the directory in which the file is located. So the directory names must not contain any underscores, but the filename may. If the filename would be empty the last directory name is used for the filename as well.
+ - The classes have to be located in a subdirectory of
phpbb/
.
+ - Classnames must be namespaced with
\phpbb\
to avoid name clashes.
+ - Class names/namespaces have to reflect the location of the file they are defined in. The namespace must be the directory in which the file is located. So the directory names must not contain any underscores, but the filename may.
- Directories should typically be a singular noun (e.g.
dir
in the example below, not dirs
.
So given the following example directory structure you would result in the below listed lookups
-includes/
+phpbb/
class_name.php
dir/
class_name.php
- dir.php
subdir/
class_name.php
-phpbb_class_name - includes/class_name.php
-phpbb_dir_class_name - includes/dir/class_name.php
-phpbb_dir - includes/dir/dir.php
-phpbb_dir_subdir_class_name - includes/dir/subdir/class_name.php
+\phpbb\class_name - phpbb/class_name.php
+\phpbb\dir\class_name - phpbb/dir/class_name.php
+\phpbb\dir\subdir\class_name - phpbb/dir/subdir/class_name.php