From 3558a6f2e6e8ae8e8129199d70818b6dcd2f67c4 Mon Sep 17 00:00:00 2001 From: Bryan Crowe Date: Tue, 28 Jan 2014 21:25:49 -0500 Subject: [PATCH] Fix doc blocks accuracy --- src/Console/Command/UpgradeShell.php | 1 + src/Controller/Component/Acl/IniAcl.php | 3 +++ src/Controller/Component/Auth/BaseAuthenticate.php | 5 ++++- src/Controller/Controller.php | 2 ++ src/Database/IdentifierQuoter.php | 1 + 5 files changed, 11 insertions(+), 1 deletion(-) diff --git a/src/Console/Command/UpgradeShell.php b/src/Console/Command/UpgradeShell.php index aa37f1df90d..6d7637cb572 100644 --- a/src/Console/Command/UpgradeShell.php +++ b/src/Console/Command/UpgradeShell.php @@ -210,6 +210,7 @@ public function app_uses() { * Replace all the App::uses() calls with `use`. * * @param string $file The file to search and replace. + * @return mixed Replacement of uses call */ protected function _replaceUses($file) { $pattern = '#App::uses\([\'"]([a-z0-9_]+)[\'"],\s*[\'"]([a-z0-9/_]+)(?:\.([a-z0-9/_]+))?[\'"]\)#i'; diff --git a/src/Controller/Component/Acl/IniAcl.php b/src/Controller/Component/Acl/IniAcl.php index c1ec96ea44f..9711a927cb4 100644 --- a/src/Controller/Component/Acl/IniAcl.php +++ b/src/Controller/Component/Acl/IniAcl.php @@ -57,6 +57,7 @@ public function initialize(Component $component) { * @param string $aro ARO The requesting object identifier. * @param string $aco ACO The controlled object identifier. * @param string $action Action (defaults to *) + * @return void */ public function allow($aro, $aco, $action = "*") { } @@ -67,6 +68,7 @@ public function allow($aro, $aco, $action = "*") { * @param string $aro ARO The requesting object identifier. * @param string $aco ACO The controlled object identifier. * @param string $action Action (defaults to *) + * @return void */ public function deny($aro, $aco, $action = "*") { } @@ -77,6 +79,7 @@ public function deny($aro, $aco, $action = "*") { * @param string $aro ARO The requesting object identifier. * @param string $aco ACO The controlled object identifier. * @param string $action Action (defaults to *) + * @return void */ public function inherit($aro, $aco, $action = "*") { } diff --git a/src/Controller/Component/Auth/BaseAuthenticate.php b/src/Controller/Component/Auth/BaseAuthenticate.php index 458ba995113..8fff01b723b 100644 --- a/src/Controller/Component/Auth/BaseAuthenticate.php +++ b/src/Controller/Component/Auth/BaseAuthenticate.php @@ -192,10 +192,13 @@ public function getUser(Request $request) { } /** - * Handle unauthenticated access attempt. + * Handle unauthenticated access attempt. In implementation, will return true to indicate + * the unauthenticated request has been dealt with and no more action is required by + * AuthComponent or void (default). * * @param Cake\Network\Request $request A request object. * @param Cake\Network\Response $response A response object. + * @return void */ public function unauthenticated(Request $request, Response $response) { } diff --git a/src/Controller/Controller.php b/src/Controller/Controller.php index 83c70c77e75..a38bfea9d16 100644 --- a/src/Controller/Controller.php +++ b/src/Controller/Controller.php @@ -736,6 +736,7 @@ public function beforeRender(Event $event) { * false to stop redirection event, * string controllers a new redirection URL or * array with the keys url, status and exit to be used by the redirect method. + * @return void * @link http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacks */ public function beforeRedirect(Event $event, $url, $status = null, $exit = true) { @@ -745,6 +746,7 @@ public function beforeRedirect(Event $event, $url, $status = null, $exit = true) * Called after the controller action is run and rendered. * * @param Event $event An Event instance + * @return void * @link http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacks */ public function afterFilter(Event $event) { diff --git a/src/Database/IdentifierQuoter.php b/src/Database/IdentifierQuoter.php index ac4eed862e1..a6cbc8a4e2f 100644 --- a/src/Database/IdentifierQuoter.php +++ b/src/Database/IdentifierQuoter.php @@ -154,6 +154,7 @@ protected function _quoteJoins($joins) { * Quotes the table name and columns for an insert query * * @param Query $query + * @return void */ protected function _quoteInsert($query) { list($table, $columns) = $query->clause('insert');