diff --git a/phpBB/docs/coding-guidelines.html b/phpBB/docs/coding-guidelines.html index a1f52c757b..e34e1d9929 100644 --- a/phpBB/docs/coding-guidelines.html +++ b/phpBB/docs/coding-guidelines.html @@ -333,7 +333,33 @@ for ($i = 0; $i < $outer_size; $i++)
Apart from following the rules for function names, all classes should be prefixed with phpbb_ to avoid name clashes.
+Apart from following the rules for function names, all classes should meet the following conditions:
+includes/
.phpbb_
to avoid name clashes, the filename should not contain the prefix.dir
in the example below, not dirs
.So given the following example directory structure you would result in the below listed lookups
++includes/ + 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 +
The basic philosophy here is to not hurt code clarity for the sake of laziness. This has to be balanced by a little bit of common sense, though; print_login_status_for_a_given_user()
goes too far, for example -- that function would be better named print_user_login_status()
, or just print_login_status()
.