From e0803df283f0255ffb14fc520292e92c3fe2365f Mon Sep 17 00:00:00 2001 From: Marco Vito Moscaritolo Date: Sun, 31 May 2015 17:32:03 +0200 Subject: [PATCH] Fixed dockblock. --- PHPCI/Application.php | 18 ++++++++++++++++++ PHPCI/Controller/BuildController.php | 9 +++++++++ PHPCI/Controller/BuildStatusController.php | 10 ++++++++++ PHPCI/Controller/HomeController.php | 9 +++++++++ PHPCI/Controller/ProjectController.php | 11 +++++++++++ PHPCI/Controller/SessionController.php | 12 ++++++++++-- PHPCI/Controller/UserController.php | 9 +++++++++ PHPCI/Controller/WebhookController.php | 10 ++++++++++ 8 files changed, 86 insertions(+), 2 deletions(-) diff --git a/PHPCI/Application.php b/PHPCI/Application.php index 2d4b37a9..9b7fec03 100644 --- a/PHPCI/Application.php +++ b/PHPCI/Application.php @@ -41,6 +41,16 @@ class Application extends b8\Application */ protected $projectStore; + /** + * Create the PHPCI web application. + * + * @param Config $config + * @param Request $request + * @param Response $response + * @param UserStore $userStore + * @param ProjectStore $projectStore + * @param Container $container + */ public function __construct( Config $config, Request $request, @@ -161,6 +171,13 @@ class Application extends b8\Application return $this->controller; } + /** + * Check if the specified controller exist. + * + * @param array $route + * + * @return boolean + */ public function controllerExists($route) { return $this->container->has('application.controller.' . strtolower($route['controller'])); @@ -168,6 +185,7 @@ class Application extends b8\Application /** * Injects variables into the layout before rendering it. + * * @param View $layout */ protected function setLayoutVariables(View &$layout) diff --git a/PHPCI/Controller/BuildController.php b/PHPCI/Controller/BuildController.php index cbc0876e..6d47ec7a 100644 --- a/PHPCI/Controller/BuildController.php +++ b/PHPCI/Controller/BuildController.php @@ -41,6 +41,15 @@ class BuildController extends \PHPCI\Controller */ protected $buildService; + /** + * Create the Build controller + * + * @param Config $config + * @param Request $request + * @param Response $response + * @param BuildStore $buildStore + * @param BuildService $buildService + */ public function __construct( Config $config, Request $request, diff --git a/PHPCI/Controller/BuildStatusController.php b/PHPCI/Controller/BuildStatusController.php index 0d3c881d..85cb4f49 100644 --- a/PHPCI/Controller/BuildStatusController.php +++ b/PHPCI/Controller/BuildStatusController.php @@ -44,6 +44,16 @@ class BuildStatusController extends \PHPCI\Controller */ protected $projectStore; + /** + * Create the BuildStatus controller. + * + * @param Config $config + * @param Request $request + * @param Response $response + * @param BuildStore $buildStore + * @param ProjectStore $projectStore + * @param HttpClient $shieldsClient + */ public function __construct( Config $config, Request $request, diff --git a/PHPCI/Controller/HomeController.php b/PHPCI/Controller/HomeController.php index 55c79bd8..97831bbc 100644 --- a/PHPCI/Controller/HomeController.php +++ b/PHPCI/Controller/HomeController.php @@ -37,6 +37,15 @@ class HomeController extends \PHPCI\Controller */ protected $projectStore; + /** + * Create the Home controller. + * + * @param Config $config + * @param Request $request + * @param Response $response + * @param BuildStore $buildStore + * @param ProjectStore $projectStore + */ public function __construct( Config $config, Request $request, diff --git a/PHPCI/Controller/ProjectController.php b/PHPCI/Controller/ProjectController.php index 70a6e00b..9005b03b 100644 --- a/PHPCI/Controller/ProjectController.php +++ b/PHPCI/Controller/ProjectController.php @@ -54,6 +54,17 @@ class ProjectController extends PHPCI\Controller */ protected $buildService; + /** + * Create the Project controller. + * + * @param Config $config + * @param Request $request + * @param Response $response + * @param BuildStore $buildStore + * @param ProjectStore $projectStore + * @param ProjectService $projectService + * @param BuildService $buildService + */ public function __construct( Config $config, Request $request, diff --git a/PHPCI/Controller/SessionController.php b/PHPCI/Controller/SessionController.php index 91b6cb0b..c38d59ee 100644 --- a/PHPCI/Controller/SessionController.php +++ b/PHPCI/Controller/SessionController.php @@ -30,6 +30,14 @@ class SessionController extends \PHPCI\Controller */ protected $userStore; + /** + * Create the Sesssion controller. + * + * @param Config $config + * @param Request $request + * @param Response $response + * @param UserStore $userStore + */ public function __construct( Config $config, Request $request, @@ -44,8 +52,8 @@ class SessionController extends \PHPCI\Controller } /** - * Handles user login (form and processing) - */ + * Handles user login (form and processing) + */ public function login() { $isLoginFailure = false; diff --git a/PHPCI/Controller/UserController.php b/PHPCI/Controller/UserController.php index eed41830..3b5578b4 100644 --- a/PHPCI/Controller/UserController.php +++ b/PHPCI/Controller/UserController.php @@ -38,6 +38,15 @@ class UserController extends Controller */ protected $userService; + /** + * Create the User controller. + * + * @param Config $config + * @param Request $request + * @param Response $response + * @param UserStore $userStore + * @param UserService $userService + */ public function __construct( Config $config, Request $request, diff --git a/PHPCI/Controller/WebhookController.php b/PHPCI/Controller/WebhookController.php index a1212f4f..cd94564c 100644 --- a/PHPCI/Controller/WebhookController.php +++ b/PHPCI/Controller/WebhookController.php @@ -48,6 +48,16 @@ class WebhookController extends \b8\Controller */ protected $buildService; + /** + * Create the Webhook controller. + * + * @param Config $config + * @param Request $request + * @param Response $response + * @param BuildStore $buildStore + * @param ProjectStore $projectStore + * @param BuildService $buildService + */ public function __construct( Config $config, Request $request,