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/controller | |
| 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/controller')
| -rw-r--r-- | phpBB/phpbb/controller/helper.php | 6 | ||||
| -rw-r--r-- | phpBB/phpbb/controller/provider.php | 8 | ||||
| -rw-r--r-- | phpBB/phpbb/controller/resolver.php | 2 |
3 files changed, 9 insertions, 7 deletions
diff --git a/phpBB/phpbb/controller/helper.php b/phpBB/phpbb/controller/helper.php index 7b232294f0..930bc42a98 100644 --- a/phpBB/phpbb/controller/helper.php +++ b/phpBB/phpbb/controller/helper.php @@ -101,7 +101,7 @@ class helper * @param string $route Name of the route to travel * @param array $params String or array of additional url parameters * @param bool $is_amp Is url using & (true) or & (false) - * @param string $session_id Possibility to use a custom session id instead of the global one + * @param string|bool $session_id Possibility to use a custom session id instead of the global one * @return string The URL already passed through append_sid() */ public function route($route, array $params = array(), $is_amp = true, $session_id = false) @@ -139,8 +139,8 @@ class helper * Output an error, effectively the same thing as trigger_error * * @param string $message The error message - * @param string $code The error code (e.g. 404, 500, 503, etc.) - * @return Response A Reponse instance + * @param int $code The error code (e.g. 404, 500, 503, etc.) + * @return Response A Response instance */ public function error($message, $code = 500) { diff --git a/phpBB/phpbb/controller/provider.php b/phpBB/phpbb/controller/provider.php index bd85385a41..fffd4f0428 100644 --- a/phpBB/phpbb/controller/provider.php +++ b/phpBB/phpbb/controller/provider.php @@ -37,7 +37,7 @@ class provider /** * Construct method * - * @param array() $routing_files Array of strings containing paths + * @param array $routing_files Array of strings containing paths * to YAML files holding route information */ public function __construct($routing_files = array()) @@ -46,6 +46,8 @@ class provider } /** + * Find the list of routing files + * * @param \phpbb\finder $finder * @return null */ @@ -61,10 +63,10 @@ class provider } /** - * Find a list of controllers and return it + * Find a list of controllers * * @param string $base_path Base path to prepend to file paths - * @return null + * @return provider */ public function find($base_path = '') { diff --git a/phpBB/phpbb/controller/resolver.php b/phpBB/phpbb/controller/resolver.php index 77532767fc..efab34b701 100644 --- a/phpBB/phpbb/controller/resolver.php +++ b/phpBB/phpbb/controller/resolver.php @@ -122,7 +122,7 @@ class resolver implements ControllerResolverInterface * * @param \Symfony\Component\HttpFoundation\Request $request Symfony Request object * @param mixed $controller A callable (controller class, method) - * @return bool False + * @return array An array of arguments to pass to the controller * @throws \phpbb\controller\exception */ public function getArguments(Request $request, $controller) |