mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-05-05 15:16:16 +02:00
Code Issues Releases Wiki Activity

[ticket/12715] Cleanup comments in \phpbb\db\*

Browse Source 
PHPBB3-12715
This commit is contained in:
Tristan Darricau 2014-06-15 13:22:42 +02:00
parent 4ac9315728
commit 3039d000c6
5 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
phpBB/phpbb/db/migration/schema_generator.php
View File

@ -217,7 +217,7 @@ class schema_generator
* Check if one of the migrations files' dependencies can't be resolved
* by the supplied list of migrations
*
* @throws UnexpectedValueException If a dependency can't be resolved
* @throws \UnexpectedValueException If a dependency can't be resolved
*/
protected function check_dependencies()
{

2
phpBB/phpbb/db/migration/tool/config.php
View File

@ -66,6 +66,7 @@ class config implements \phpbb\db\migration\tool\tool_interface
* like to update
* @param mixed $config_value The value of the config setting
* @return null
* @throws \phpbb\db\migration\exception
*/
public function update($config_name, $config_value)
{
@ -87,6 +88,7 @@ class config implements \phpbb\db\migration\tool\tool_interface
* like to update
* @param mixed $config_value The value of the config setting
* @return null
* @throws \phpbb\db\migration\exception
*/
public function update_if_equals($compare, $config_name, $config_value)
{

3
phpBB/phpbb/db/migration/tool/module.php
View File

@ -167,6 +167,7 @@ class module implements \phpbb\db\migration\tool\tool_interface
* modules in that info file.
* path, specify that here
* @return null
* @throws \phpbb\db\migration\exception
*/
public function add($class, $parent = 0, $data = array())
{
@ -331,6 +332,7 @@ class module implements \phpbb\db\migration\tool\tool_interface
* @param int|string $module The module id|module_langname
* specify that here
* @return null
* @throws \phpbb\db\migration\exception
*/
public function remove($class, $parent = 0, $module = '')
{
@ -466,6 +468,7 @@ class module implements \phpbb\db\migration\tool\tool_interface
* @param string $class Module Class
* @param string $basename Module Basename
* @return array Module Information
* @throws \phpbb\db\migration\exception
*/
protected function get_module_info($class, $basename)
{

3
phpBB/phpbb/db/migration/tool/permission.php
View File

@ -283,6 +283,7 @@ class permission implements \phpbb\db\migration\tool\tool_interface
* @param string $old_role_name The old role name
* @param string $new_role_name The new role name
* @return null
* @throws \phpbb\db\migration\exception
*/
public function role_update($old_role_name, $new_role_name)
{
@ -345,6 +346,7 @@ class permission implements \phpbb\db\migration\tool\tool_interface
* @param bool $has_permission True if you want to give them permission,
* false if you want to deny them permission
* @return null
* @throws \phpbb\db\migration\exception
*/
public function permission_set($name, $auth_option, $type = 'role', $has_permission = true)
{
@ -490,6 +492,7 @@ class permission implements \phpbb\db\migration\tool\tool_interface
* auth_options you would like to set
* @param string $type The type (role|group)
* @return null
* @throws \phpbb\db\migration\exception
*/
public function permission_unset($name, $auth_option, $type = 'role')
{

8
phpBB/phpbb/db/migrator.php
View File

@ -167,8 +167,9 @@ class migrator
/**
* Attempts to apply a step of the given migration or one of its dependencies
*
* @param string The class name of the migration
* @param string $name The class name of the migration
* @return bool Whether any update step was successfully run
* @throws \phpbb\db\migration\exception
*/
protected function try_apply($name)
{
@ -302,7 +303,7 @@ class migrator
/**
* Attempts to revert a step of the given migration or one of its dependencies
*
* @param string The class name of the migration
* @param string $name The class name of the migration
* @return bool Whether any update step was successfully run
*/
protected function try_revert($name)
@ -368,6 +369,7 @@ class migrator
* @param bool|string $state Current state of the migration
* @param bool $revert true to revert a data step
* @return bool|string migration state. True if completed, serialized array if not finished
* @throws \phpbb\db\migration\exception
*/
protected function process_data_step($steps, $state, $revert = false)
{
@ -464,6 +466,7 @@ class migrator
* @param mixed $last_result Result to pass to the callable (only for 'custom' method)
* @param bool $reverse False to install, True to attempt uninstallation by reversing the call
* @return array Array with parameters for call_user_func_array(), 0 is the callable, 1 is parameters
* @throws \phpbb\db\migration\exception
*/
protected function get_callable_from_step(array $step, $last_result = 0, $reverse = false)
{
@ -722,6 +725,7 @@ class migrator
* to prevent errors (if including multiple directories, check
* with the last call to prevent throwing errors unnecessarily).
* @return array Array of migration names
* @throws \phpbb\db\migration\exception
*/
public function load_migrations(\phpbb\finder $finder, $path, $check_fulfillable = true)
{