diff options
| author | Andreas Fischer <bantu@phpbb.com> | 2014-06-16 01:12:03 +0200 |
|---|---|---|
| committer | Andreas Fischer <bantu@phpbb.com> | 2014-06-16 01:12:03 +0200 |
| commit | f27be59cf1bc97ac9da6bc7f963b1e0c44ee248b (patch) | |
| tree | 20e82f52d2e6ffb5b5f3717849e823e56a1f5468 /phpBB/phpbb/db | |
| parent | ad11925c7730e4f3c6b1cffe46c6ba531f04f4d9 (diff) | |
| parent | f4ef1ab6bd4b18ea002ec1d5bf733d4f6b357e57 (diff) | |
| download | forums-f27be59cf1bc97ac9da6bc7f963b1e0c44ee248b.tar forums-f27be59cf1bc97ac9da6bc7f963b1e0c44ee248b.tar.gz forums-f27be59cf1bc97ac9da6bc7f963b1e0c44ee248b.tar.bz2 forums-f27be59cf1bc97ac9da6bc7f963b1e0c44ee248b.tar.xz forums-f27be59cf1bc97ac9da6bc7f963b1e0c44ee248b.zip | |
Merge pull request #2600 from Nicofuma/ticket/12715
[ticket/12715] Fix mistakes in the doc blocks
* Nicofuma/ticket/12715: (30 commits)
[ticket/12715] Add missing new line in the notification manager
[ticket/12715] Cleanup comments in \phpbb\symfony_request
[ticket/12715] Cleanup comments in \phpbb\permissions
[ticket/12715] Cleanup comments in \phpbb\path_helper
[ticket/12715] Cleanup comments in \phpbb\pagination
[ticket/12715] Cleanup comments in \phpbb\datetime
[ticket/12715] Cleanup comments in \phpbb\content_visibility
[ticket/12715] Cleanup comments in \phpbb\tree\*
[ticket/12715] Cleanup comments in \phpbb\template\*
[ticket/12715] Cleanup comments in \phpbb\plupload\*
[ticket/12715] Cleanup comments in \phpbb\profilefields\*
[ticket/12715] Cleanup comments in \phpbb\passwords\*
[ticket/12715] Cleanup comments in \phpbb\notification\*
[ticket/12715] Cleanup comments in \phpbb\mimetype\*
[ticket/12715] Cleanup comments in \phpbb\message\*
[ticket/12715] Cleanup comments in \phpbb\log\*
[ticket/12715] Cleanup comments in \phpbb\lock\*
[ticket/12715] Cleanup comments in \phpbb\groupposition\*
[ticket/12715] Cleanup comments in \phpbb\feed\*
[ticket/12715] Cleanup comments in \phpbb\extension\*
...
Diffstat (limited to 'phpBB/phpbb/db')
| -rw-r--r-- | phpBB/phpbb/db/migration/schema_generator.php | 2 | ||||
| -rw-r--r-- | phpBB/phpbb/db/migration/tool/config.php | 2 | ||||
| -rw-r--r-- | phpBB/phpbb/db/migration/tool/module.php | 3 | ||||
| -rw-r--r-- | phpBB/phpbb/db/migration/tool/permission.php | 3 | ||||
| -rw-r--r-- | phpBB/phpbb/db/migrator.php | 8 |
5 files changed, 15 insertions, 3 deletions
diff --git a/phpBB/phpbb/db/migration/schema_generator.php b/phpBB/phpbb/db/migration/schema_generator.php index 818e27a362..91d8307d91 100644 --- a/phpBB/phpbb/db/migration/schema_generator.php +++ b/phpBB/phpbb/db/migration/schema_generator.php @@ -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() { diff --git a/phpBB/phpbb/db/migration/tool/config.php b/phpBB/phpbb/db/migration/tool/config.php index 1027b425ff..f93e7118c4 100644 --- a/phpBB/phpbb/db/migration/tool/config.php +++ b/phpBB/phpbb/db/migration/tool/config.php @@ -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) { diff --git a/phpBB/phpbb/db/migration/tool/module.php b/phpBB/phpbb/db/migration/tool/module.php index 17deb1b19c..db43046a95 100644 --- a/phpBB/phpbb/db/migration/tool/module.php +++ b/phpBB/phpbb/db/migration/tool/module.php @@ -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) { diff --git a/phpBB/phpbb/db/migration/tool/permission.php b/phpBB/phpbb/db/migration/tool/permission.php index ba856fbeda..d2df27613a 100644 --- a/phpBB/phpbb/db/migration/tool/permission.php +++ b/phpBB/phpbb/db/migration/tool/permission.php @@ -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') { diff --git a/phpBB/phpbb/db/migrator.php b/phpBB/phpbb/db/migrator.php index 5255c73c1c..c2f7b5ab23 100644 --- a/phpBB/phpbb/db/migrator.php +++ b/phpBB/phpbb/db/migrator.php @@ -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) { |