mirror of
https://github.com/phpbb/phpbb.git
synced 2025-06-29 06:38:52 +00:00
[ticket/11015] Change more docblocks.
PHPBB3-11015
This commit is contained in:
parent
e765ccd075
commit
3687febdac
10 changed files with 18 additions and 18 deletions
|
@ -300,7 +300,7 @@ class phpbb_db_tools
|
||||||
/**
|
/**
|
||||||
* Constructor. Set DB Object and set {@link $return_statements return_statements}.
|
* Constructor. Set DB Object and set {@link $return_statements return_statements}.
|
||||||
*
|
*
|
||||||
* @param phpbb_dbal $db DBAL object
|
* @param phpbb_db_driver $db Database connection
|
||||||
* @param bool $return_statements True if only statements should be returned and no SQL being executed
|
* @param bool $return_statements True if only statements should be returned and no SQL being executed
|
||||||
*/
|
*/
|
||||||
function phpbb_db_tools(&$db, $return_statements = false)
|
function phpbb_db_tools(&$db, $return_statements = false)
|
||||||
|
|
|
@ -34,7 +34,7 @@ class phpbb_extension_manager
|
||||||
/**
|
/**
|
||||||
* Creates a manager and loads information from database
|
* Creates a manager and loads information from database
|
||||||
*
|
*
|
||||||
* @param dbal $db A database connection
|
* @param phpbb_db_driver $db A database connection
|
||||||
* @param phpbb_config $config phpbb_config
|
* @param phpbb_config $config phpbb_config
|
||||||
* @param string $extension_table The name of the table holding extensions
|
* @param string $extension_table The name of the table holding extensions
|
||||||
* @param string $phpbb_root_path Path to the phpbb includes directory.
|
* @param string $phpbb_root_path Path to the phpbb includes directory.
|
||||||
|
|
|
@ -34,7 +34,7 @@ class phpbb_extension_metadata_manager
|
||||||
/**
|
/**
|
||||||
* Creates the metadata manager
|
* Creates the metadata manager
|
||||||
*
|
*
|
||||||
* @param dbal $db A database connection
|
* @param phpbb_db_driver $db A database connection
|
||||||
* @param string $extension_manager An instance of the phpbb extension manager
|
* @param string $extension_manager An instance of the phpbb extension manager
|
||||||
* @param string $phpbb_root_path Path to the phpbb includes directory.
|
* @param string $phpbb_root_path Path to the phpbb includes directory.
|
||||||
* @param string $phpEx php file extension
|
* @param string $phpEx php file extension
|
||||||
|
|
|
@ -596,7 +596,7 @@ function phpbb_parse_range_request($request_array, $filesize)
|
||||||
/**
|
/**
|
||||||
* Increments the download count of all provided attachments
|
* Increments the download count of all provided attachments
|
||||||
*
|
*
|
||||||
* @param dbal $db The database object
|
* @param phpbb_db_driver $db The database object
|
||||||
* @param array|int $ids The attach_id of each attachment
|
* @param array|int $ids The attach_id of each attachment
|
||||||
*
|
*
|
||||||
* @return null
|
* @return null
|
||||||
|
@ -617,7 +617,7 @@ function phpbb_increment_downloads($db, $ids)
|
||||||
/**
|
/**
|
||||||
* Handles authentication when downloading attachments from a post or topic
|
* Handles authentication when downloading attachments from a post or topic
|
||||||
*
|
*
|
||||||
* @param dbal $db The database object
|
* @param phpbb_db_driver $db The database object
|
||||||
* @param phpbb_auth $auth The authentication object
|
* @param phpbb_auth $auth The authentication object
|
||||||
* @param int $topic_id The id of the topic that we are downloading from
|
* @param int $topic_id The id of the topic that we are downloading from
|
||||||
*
|
*
|
||||||
|
@ -651,7 +651,7 @@ function phpbb_download_handle_forum_auth($db, $auth, $topic_id)
|
||||||
/**
|
/**
|
||||||
* Handles authentication when downloading attachments from PMs
|
* Handles authentication when downloading attachments from PMs
|
||||||
*
|
*
|
||||||
* @param dbal $db The database object
|
* @param phpbb_db_driver $db The database object
|
||||||
* @param phpbb_auth $auth The authentication object
|
* @param phpbb_auth $auth The authentication object
|
||||||
* @param int $user_id The user id
|
* @param int $user_id The user id
|
||||||
* @param int $msg_id The id of the PM that we are downloading from
|
* @param int $msg_id The id of the PM that we are downloading from
|
||||||
|
@ -678,7 +678,7 @@ function phpbb_download_handle_pm_auth($db, $auth, $user_id, $msg_id)
|
||||||
/**
|
/**
|
||||||
* Checks whether a user can download from a particular PM
|
* Checks whether a user can download from a particular PM
|
||||||
*
|
*
|
||||||
* @param dbal $db The database object
|
* @param phpbb_db_driver $db The database object
|
||||||
* @param int $user_id The user id
|
* @param int $user_id The user id
|
||||||
* @param int $msg_id The id of the PM that we are downloading from
|
* @param int $msg_id The id of the PM that we are downloading from
|
||||||
*
|
*
|
||||||
|
|
|
@ -48,7 +48,7 @@ class phpbb_lock_db
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A database connection
|
* A database connection
|
||||||
* @var dbal
|
* @var phpbb_db_driver
|
||||||
*/
|
*/
|
||||||
private $db;
|
private $db;
|
||||||
|
|
||||||
|
@ -59,7 +59,7 @@ class phpbb_lock_db
|
||||||
*
|
*
|
||||||
* @param string $config_name A config variable to be used for locking
|
* @param string $config_name A config variable to be used for locking
|
||||||
* @param array $config The phpBB configuration
|
* @param array $config The phpBB configuration
|
||||||
* @param dbal $db A database connection
|
* @param phpbb_db_driver $db A database connection
|
||||||
*/
|
*/
|
||||||
public function __construct($config_name, phpbb_config $config, phpbb_db_driver $db)
|
public function __construct($config_name, phpbb_config $config, phpbb_db_driver $db)
|
||||||
{
|
{
|
||||||
|
|
|
@ -41,8 +41,8 @@ class phpbb_search_fulltext_mysql extends phpbb_search_base
|
||||||
protected $config;
|
protected $config;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* DBAL object
|
* Database connection
|
||||||
* @var dbal
|
* @var phpbb_db_driver
|
||||||
*/
|
*/
|
||||||
protected $db;
|
protected $db;
|
||||||
|
|
||||||
|
|
|
@ -85,8 +85,8 @@ class phpbb_search_fulltext_native extends phpbb_search_base
|
||||||
protected $config;
|
protected $config;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* DBAL object
|
* Database connection
|
||||||
* @var dbal
|
* @var phpbb_db_driver
|
||||||
*/
|
*/
|
||||||
protected $db;
|
protected $db;
|
||||||
|
|
||||||
|
|
|
@ -66,8 +66,8 @@ class phpbb_search_fulltext_postgres extends phpbb_search_base
|
||||||
protected $config;
|
protected $config;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* DBAL object
|
* Database connection
|
||||||
* @var dbal
|
* @var phpbb_db_driver
|
||||||
*/
|
*/
|
||||||
protected $db;
|
protected $db;
|
||||||
|
|
||||||
|
|
|
@ -84,8 +84,8 @@ class phpbb_search_fulltext_sphinx
|
||||||
protected $config;
|
protected $config;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* DBAL object
|
* Database connection
|
||||||
* @var dbal
|
* @var phpbb_db_driver
|
||||||
*/
|
*/
|
||||||
protected $db;
|
protected $db;
|
||||||
|
|
||||||
|
|
|
@ -59,7 +59,7 @@ class phpbb_session_testable_factory
|
||||||
/**
|
/**
|
||||||
* Retrieve the configured session class instance
|
* Retrieve the configured session class instance
|
||||||
*
|
*
|
||||||
* @param dbal $dbal The database connection to use for session data
|
* @param phpbb_db_driver $dbal The database connection to use for session data
|
||||||
* @return phpbb_mock_session_testable A session instance
|
* @return phpbb_mock_session_testable A session instance
|
||||||
*/
|
*/
|
||||||
public function get_session(phpbb_db_driver $dbal)
|
public function get_session(phpbb_db_driver $dbal)
|
||||||
|
|
Loading…
Add table
Reference in a new issue