makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-27 21:58:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source 
PHPBB3-12715
This commit is contained in:
Tristan Darricau 2014-06-15 12:38:00 +02:00
parent 8966e4a269
commit 358a10d8a9
3 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
phpBB/phpbb/controller/helper.php
View file

@ -101,7 +101,7 @@ class helper
* @param string $route Name of the route to travel * @param string $route Name of the route to travel
* @param array $params String or array of additional url parameters * @param array $params String or array of additional url parameters
* @param bool $is_amp Is url using & (true) or & (false) * @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() * @return string The URL already passed through append_sid()
*/ */
public function route($route, array $params = array(), $is_amp = true, $session_id = false) 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 * Output an error, effectively the same thing as trigger_error
* *
* @param string $message The error message * @param string $message The error message
* @param string $code The error code (e.g. 404, 500, 503, etc.) * @param int $code The error code (e.g. 404, 500, 503, etc.)
* @return Response A Reponse instance * @return Response A Response instance
*/ */
public function error($message, $code = 500) public function error($message, $code = 500)
{ {

8
phpBB/phpbb/controller/provider.php
View file

@ -37,7 +37,7 @@ class provider
/** /**
* Construct method * 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 * to YAML files holding route information
*/ */
public function __construct($routing_files = array()) public function __construct($routing_files = array())
@ -46,6 +46,8 @@ class provider
} }
/** /**
* Find the list of routing files
*
* @param \phpbb\finder $finder * @param \phpbb\finder $finder
* @return null * @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 * @param string $base_path Base path to prepend to file paths
* @return null * @return provider
*/ */
public function find($base_path = '') public function find($base_path = '')
{ {

2
phpBB/phpbb/controller/resolver.php
View file

@ -122,7 +122,7 @@ class resolver implements ControllerResolverInterface
* *
* @param \Symfony\Component\HttpFoundation\Request $request Symfony Request object * @param \Symfony\Component\HttpFoundation\Request $request Symfony Request object
* @param mixed $controller A callable (controller class, method) * @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 * @throws \phpbb\controller\exception
*/ */
public function getArguments(Request $request, $controller) public function getArguments(Request $request, $controller)