19 files changed, 106 insertions, 89 deletions
diff --git a/phpBB/faq.php b/phpBB/faq.php
index 052f78816e..53de850195 100644
--- a/phpBB/faq.php
+++ b/phpBB/faq.php
@@ -76,7 +76,7 @@ $template->assign_vars(array(
 	'SWITCH_COLUMN_MANUALLY'	=> (!$found_switch) ? true : false,
 ));
 
-page_header($l_title, false);
+page_header($l_title);
 
 $template->set_filenames(array(
 	'body' => 'faq_body.html')
diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php
index ebd676b17a..4d962db308 100644
--- a/phpBB/includes/functions.php
+++ b/phpBB/includes/functions.php
@@ -2679,7 +2679,7 @@ function confirm_box($check, $title = '', $hidden = '', $html_body = 'confirm_bo
 	}
 	else
 	{
-		page_header(((!isset($user->lang[$title])) ? $user->lang['CONFIRM'] : $user->lang[$title]), false);
+		page_header((!isset($user->lang[$title])) ? $user->lang['CONFIRM'] : $user->lang[$title]);
 	}
 
 	$template->set_filenames(array(
@@ -2956,7 +2956,7 @@ function login_box($redirect = '', $l_explain = '', $l_success = '', $admin = fa
 		'PASSWORD_CREDENTIAL'	=> ($admin) ? 'password_' . $credential : 'password',
 	));
 
-	page_header($user->lang['LOGIN'], false);
+	page_header($user->lang['LOGIN']);
 
 	$template->set_filenames(array(
 		'body' => 'login_body.html')
@@ -3032,7 +3032,7 @@ function login_forum_box($forum_data)
 		$template->assign_var('LOGIN_ERROR', $user->lang['WRONG_PASSWORD']);
 	}
 
-	page_header($user->lang['LOGIN'], false);
+	page_header($user->lang['LOGIN']);
 
 	$template->assign_vars(array(
 		'FORUM_NAME'			=> isset($forum_data['forum_name']) ? $forum_data['forum_name'] : '',
@@ -3945,7 +3945,7 @@ function msg_handler($errno, $msg_text, $errfile, $errline)
 				}
 				else
 				{
-					page_header($msg_title, false);
+					page_header($msg_title);
 				}
 			}
 
@@ -4622,7 +4622,7 @@ function phpbb_build_hidden_fields_for_query_params($request, $exclude = null)
 /**
 * Generate page header
 */
-function page_header($page_title = '', $display_online_list = true, $item_id = 0, $item = 'forum')
+function page_header($page_title = '', $display_online_list = false, $item_id = 0, $item = 'forum')
 {
 	global $db, $config, $template, $SID, $_SID, $_EXTRA_URL, $user, $auth, $phpEx, $phpbb_root_path;
 	global $phpbb_dispatcher, $request, $phpbb_container, $phpbb_admin_path;
diff --git a/phpBB/includes/functions_module.php b/phpBB/includes/functions_module.php
index e043883145..ef2e009a6e 100644
--- a/phpBB/includes/functions_module.php
+++ b/phpBB/includes/functions_module.php
@@ -956,7 +956,7 @@ class p_master
 	/**
 	* Display module
 	*/
-	function display($page_title, $display_online_list = true)
+	function display($page_title, $display_online_list = false)
 	{
 		global $template, $user;
 
diff --git a/phpBB/index.php b/phpBB/index.php
index c363781667..49baf33392 100644
--- a/phpBB/index.php
+++ b/phpBB/index.php
@@ -193,7 +193,7 @@ $vars = array('page_title');
 extract($phpbb_dispatcher->trigger_event('core.index_modify_page_title', compact($vars)));
 
 // Output page
-page_header($page_title);
+page_header($page_title, true);
 
 $template->set_filenames(array(
 	'body' => 'index_body.html')
diff --git a/phpBB/mcp.php b/phpBB/mcp.php
index 3fc89ba01b..1449346deb 100644
--- a/phpBB/mcp.php
+++ b/phpBB/mcp.php
@@ -284,7 +284,7 @@ $template->assign_vars(array(
 ));
 
 // Generate the page, do not display/query online list
-$module->display($module->get_page_title(), false);
+$module->display($module->get_page_title());
 
 /**
 * Functions used to generate additional URL paramters
diff --git a/phpBB/memberlist.php b/phpBB/memberlist.php
index 738b0be01c..ba4a4372a5 100644
--- a/phpBB/memberlist.php
+++ b/phpBB/memberlist.php
@@ -1623,7 +1623,7 @@ switch ($mode)
 }
 
 // Output the page
-page_header($page_title, false);
+page_header($page_title);
 
 $template->set_filenames(array(
 	'body' => $template_html)
diff --git a/phpBB/phpbb/cache/driver/apc.php b/phpBB/phpbb/cache/driver/apc.php
index a28d91c00a..77b7b11181 100644
--- a/phpBB/phpbb/cache/driver/apc.php
+++ b/phpBB/phpbb/cache/driver/apc.php
@@ -18,9 +18,7 @@ class apc extends \phpbb\cache\driver\memory
 	var $extension = 'apc';
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
diff --git a/phpBB/phpbb/cache/driver/driver_interface.php b/phpBB/phpbb/cache/driver/driver_interface.php
index 0715a4b934..8444028115 100644
--- a/phpBB/phpbb/cache/driver/driver_interface.php
+++ b/phpBB/phpbb/cache/driver/driver_interface.php
@@ -18,46 +18,73 @@ interface driver_interface
 {
 	/**
 	* Load global cache
+	*
+	* @return mixed False if an error was encountered, otherwise the data type of the cached data
 	*/
 	public function load();
 
 	/**
 	* Unload cache object
+	*
+	* @return null
 	*/
 	public function unload();
 
 	/**
 	* Save modified objects
+	*
+	* @return null
 	*/
 	public function save();
 
 	/**
 	* Tidy cache
+	*
+	* @return null
 	*/
 	public function tidy();
 
 	/**
 	* Get saved cache object
+	*
+	* @param string $var_name 		Cache key
+	* @return mixed 				False if an error was encountered, otherwise the saved cached object
 	*/
 	public function get($var_name);
 
 	/**
 	* Put data into cache
+	*
+	* @param string $var_name 		Cache key
+	* @param mixed $var 			Cached data to store
+	* @param int $ttl 				Time-to-live of cached data
+	* @return null
 	*/
 	public function put($var_name, $var, $ttl = 0);
 
 	/**
 	* Purge cache data
+	*
+	* @return null
 	*/
 	public function purge();
 
 	/**
 	* Destroy cache data
+	*
+	* @param string $var_name 		Cache key
+	* @param string $table 			Table name
+	* @return null
 	*/
 	public function destroy($var_name, $table = '');
 
 	/**
 	* Check if a given cache entry exists
+	*
+	* @param string $var_name 		Cache key
+	*
+	* @return bool 					True if cache file exists and has not expired.
+	*								False otherwise.
 	*/
 	public function _exists($var_name);
 
diff --git a/phpBB/phpbb/cache/driver/eaccelerator.php b/phpBB/phpbb/cache/driver/eaccelerator.php
index 2629cb53e5..d1ad69ef6d 100644
--- a/phpBB/phpbb/cache/driver/eaccelerator.php
+++ b/phpBB/phpbb/cache/driver/eaccelerator.php
@@ -22,9 +22,7 @@ class eaccelerator extends \phpbb\cache\driver\memory
 	var $serialize_header = '#phpbb-serialized#';
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
@@ -39,10 +37,8 @@ class eaccelerator extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	 * Perform cache garbage collection
-	 *
-	 * @return null
-	 */
+	* {@inheritDoc}
+	*/
 	function tidy()
 	{
 		eaccelerator_gc();
diff --git a/phpBB/phpbb/cache/driver/file.php b/phpBB/phpbb/cache/driver/file.php
index 6686da6953..a57a805193 100644
--- a/phpBB/phpbb/cache/driver/file.php
+++ b/phpBB/phpbb/cache/driver/file.php
@@ -33,7 +33,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load global cache
+	* {@inheritDoc}
 	*/
 	function load()
 	{
@@ -41,7 +41,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Unload cache object
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
@@ -58,7 +58,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Save modified objects
+	* {@inheritDoc}
 	*/
 	function save()
 	{
@@ -93,7 +93,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Tidy cache
+	* {@inheritDoc}
 	*/
 	function tidy()
 	{
@@ -155,7 +155,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Get saved cache object
+	* {@inheritDoc}
 	*/
 	function get($var_name)
 	{
@@ -177,7 +177,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Put data into cache
+	* {@inheritDoc}
 	*/
 	function put($var_name, $var, $ttl = 31536000)
 	{
@@ -194,7 +194,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Purge cache data
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
@@ -280,7 +280,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Destroy cache data
+	* {@inheritDoc}
 	*/
 	function destroy($var_name, $table = '')
 	{
@@ -359,7 +359,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Check if a given cache entry exist
+	* {@inheritDoc}
 	*/
 	function _exists($var_name)
 	{
@@ -385,7 +385,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load cached sql query
+	* {@inheritDoc}
 	*/
 	function sql_load($query)
 	{
@@ -431,7 +431,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Ceck if a given sql query exist in cache
+	* {@inheritDoc}
 	*/
 	function sql_exists($query_id)
 	{
@@ -439,7 +439,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch row from cache (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchrow($query_id)
 	{
@@ -452,7 +452,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch a field from the current row of a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchfield($query_id, $field)
 	{
@@ -465,7 +465,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Seek a specific row in an a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_rowseek($rownum, $query_id)
 	{
@@ -479,7 +479,7 @@ class file extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Free memory used for a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_freeresult($query_id)
 	{
@@ -758,6 +758,10 @@ class file extends \phpbb\cache\driver\base
 
 	/**
 	* Removes/unlinks file
+	*
+	* @param string $filename Filename to remove
+	* @param bool $check Check file permissions
+	* @return bool True if the file was successfully removed, otherwise false
 	*/
 	function remove_file($filename, $check = false)
 	{
diff --git a/phpBB/phpbb/cache/driver/memcache.php b/phpBB/phpbb/cache/driver/memcache.php
index c725ec0fb0..eb3fced973 100644
--- a/phpBB/phpbb/cache/driver/memcache.php
+++ b/phpBB/phpbb/cache/driver/memcache.php
@@ -56,9 +56,7 @@ class memcache extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Unload the cache resources
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
@@ -68,9 +66,7 @@ class memcache extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
diff --git a/phpBB/phpbb/cache/driver/memory.php b/phpBB/phpbb/cache/driver/memory.php
index 292024212b..b618b0f3e6 100644
--- a/phpBB/phpbb/cache/driver/memory.php
+++ b/phpBB/phpbb/cache/driver/memory.php
@@ -50,7 +50,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load global cache
+	* {@inheritDoc}
 	*/
 	function load()
 	{
@@ -66,7 +66,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Unload cache object
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
@@ -81,7 +81,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Save modified objects
+	* {@inheritDoc}
 	*/
 	function save()
 	{
@@ -96,7 +96,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Tidy cache
+	* {@inheritDoc}
 	*/
 	function tidy()
 	{
@@ -106,7 +106,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Get saved cache object
+	* {@inheritDoc}
 	*/
 	function get($var_name)
 	{
@@ -126,7 +126,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Put data into cache
+	* {@inheritDoc}
 	*/
 	function put($var_name, $var, $ttl = 2592000)
 	{
@@ -142,7 +142,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Purge cache data
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
@@ -183,7 +183,7 @@ abstract class memory extends \phpbb\cache\driver\base
 
 
 	/**
-	* Destroy cache data
+	* {@inheritDoc}
 	*/
 	function destroy($var_name, $table = '')
 	{
@@ -237,7 +237,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Check if a given cache entry exist
+	* {@inheritDoc}
 	*/
 	function _exists($var_name)
 	{
@@ -257,7 +257,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load cached sql query
+	* {@inheritDoc}
 	*/
 	function sql_load($query)
 	{
@@ -335,7 +335,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Ceck if a given sql query exist in cache
+	* {@inheritDoc}
 	*/
 	function sql_exists($query_id)
 	{
@@ -343,7 +343,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch row from cache (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchrow($query_id)
 	{
@@ -356,7 +356,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch a field from the current row of a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchfield($query_id, $field)
 	{
@@ -369,7 +369,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Seek a specific row in an a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_rowseek($rownum, $query_id)
 	{
@@ -383,7 +383,7 @@ abstract class memory extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Free memory used for a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_freeresult($query_id)
 	{
@@ -400,6 +400,10 @@ abstract class memory extends \phpbb\cache\driver\base
 
 	/**
 	* Removes/unlinks file
+	*
+	* @param string $filename Filename to remove
+	* @param bool $check Check file permissions
+	* @return bool True if the file was successfully removed, otherwise false
 	*/
 	function remove_file($filename, $check = false)
 	{
diff --git a/phpBB/phpbb/cache/driver/null.php b/phpBB/phpbb/cache/driver/null.php
index ea535ca1e1..8af63eb725 100644
--- a/phpBB/phpbb/cache/driver/null.php
+++ b/phpBB/phpbb/cache/driver/null.php
@@ -23,7 +23,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load global cache
+	* {@inheritDoc}
 	*/
 	function load()
 	{
@@ -31,21 +31,21 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Unload cache object
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
 	}
 
 	/**
-	* Save modified objects
+	* {@inheritDoc}
 	*/
 	function save()
 	{
 	}
 
 	/**
-	* Tidy cache
+	* {@inheritDoc}
 	*/
 	function tidy()
 	{
@@ -54,7 +54,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Get saved cache object
+	* {@inheritDoc}
 	*/
 	function get($var_name)
 	{
@@ -62,28 +62,28 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Put data into cache
+	* {@inheritDoc}
 	*/
 	function put($var_name, $var, $ttl = 0)
 	{
 	}
 
 	/**
-	* Purge cache data
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
 	}
 
 	/**
-	* Destroy cache data
+	* {@inheritDoc}
 	*/
 	function destroy($var_name, $table = '')
 	{
 	}
 
 	/**
-	* Check if a given cache entry exist
+	* {@inheritDoc}
 	*/
 	function _exists($var_name)
 	{
@@ -91,7 +91,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Load cached sql query
+	* {@inheritDoc}
 	*/
 	function sql_load($query)
 	{
@@ -107,7 +107,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Ceck if a given sql query exist in cache
+	* {@inheritDoc}
 	*/
 	function sql_exists($query_id)
 	{
@@ -115,7 +115,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch row from cache (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchrow($query_id)
 	{
@@ -123,7 +123,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Fetch a field from the current row of a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_fetchfield($query_id, $field)
 	{
@@ -131,7 +131,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Seek a specific row in an a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_rowseek($rownum, $query_id)
 	{
@@ -139,7 +139,7 @@ class null extends \phpbb\cache\driver\base
 	}
 
 	/**
-	* Free memory used for a cached database result (database)
+	* {@inheritDoc}
 	*/
 	function sql_freeresult($query_id)
 	{
diff --git a/phpBB/phpbb/cache/driver/redis.php b/phpBB/phpbb/cache/driver/redis.php
index 2b6f9bf36d..2f2a32a12d 100644
--- a/phpBB/phpbb/cache/driver/redis.php
+++ b/phpBB/phpbb/cache/driver/redis.php
@@ -92,9 +92,7 @@ class redis extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Unload the cache resources
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function unload()
 	{
@@ -104,9 +102,7 @@ class redis extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
diff --git a/phpBB/phpbb/cache/driver/wincache.php b/phpBB/phpbb/cache/driver/wincache.php
index 1f040e9ab2..d0f636d9cb 100644
--- a/phpBB/phpbb/cache/driver/wincache.php
+++ b/phpBB/phpbb/cache/driver/wincache.php
@@ -18,9 +18,7 @@ class wincache extends \phpbb\cache\driver\memory
 	var $extension = 'wincache';
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
diff --git a/phpBB/phpbb/cache/driver/xcache.php b/phpBB/phpbb/cache/driver/xcache.php
index 4d0d683b3d..6c9323ec83 100644
--- a/phpBB/phpbb/cache/driver/xcache.php
+++ b/phpBB/phpbb/cache/driver/xcache.php
@@ -33,9 +33,7 @@ class xcache extends \phpbb\cache\driver\memory
 	}
 
 	/**
-	* Purge cache data
-	*
-	* @return null
+	* {@inheritDoc}
 	*/
 	function purge()
 	{
diff --git a/phpBB/phpbb/controller/helper.php b/phpBB/phpbb/controller/helper.php
index 10fdbb1375..54c30c93fc 100644
--- a/phpBB/phpbb/controller/helper.php
+++ b/phpBB/phpbb/controller/helper.php
@@ -77,9 +77,9 @@ class helper
 	* @param int $status_code The status code to be sent to the page header
 	* @return Response object containing rendered page
 	*/
-	public function render($template_file, $page_title = '', $status_code = 200)
+	public function render($template_file, $page_title = '', $status_code = 200, $display_online_list = false)
 	{
-		page_header($page_title);
+		page_header($page_title, $display_online_list);
 
 		$this->template->set_filenames(array(
 			'body'	=> $template_file,
diff --git a/phpBB/posting.php b/phpBB/posting.php
index aee9ba50af..ef90c229da 100644
--- a/phpBB/posting.php
+++ b/phpBB/posting.php
@@ -1589,7 +1589,7 @@ if ($allowed)
 posting_gen_attachment_entry($attachment_data, $filename_data, $allowed);
 
 // Output page ...
-page_header($page_title, false);
+page_header($page_title);
 
 $template->set_filenames(array(
 	'body' => 'posting_body.html')
@@ -1617,7 +1617,7 @@ function upload_popup($forum_style = 0)
 
 	($forum_style) ? $user->setup('posting', $forum_style) : $user->setup('posting');
 
-	page_header($user->lang['PROGRESS_BAR'], false);
+	page_header($user->lang['PROGRESS_BAR']);
 
 	$template->set_filenames(array(
 		'popup'	=> 'posting_progress_bar.html')
diff --git a/phpBB/ucp.php b/phpBB/ucp.php
index 0c587cbf28..8c773886a6 100644
--- a/phpBB/ucp.php
+++ b/phpBB/ucp.php
@@ -128,7 +128,7 @@ switch ($mode)
 		);
 
 		// Disable online list
-		page_header($user->lang[$title], false);
+		page_header($user->lang[$title]);
 
 		$template->assign_vars(array(
 			'S_AGREEMENT'			=> true,
@@ -353,7 +353,7 @@ $module->load_active();
 $module->assign_tpl_vars(append_sid("{$phpbb_root_path}ucp.$phpEx"));
 
 // Generate the page, do not display/query online list
-$module->display($module->get_page_title(), false);
+$module->display($module->get_page_title());
 
 /**
 * Function for assigning a template var if the zebra module got included