From 2fbf1fad3e59ba1edc733580192d63d4477a199a Mon Sep 17 00:00:00 2001 From: Michael M Slusarz Date: Mon, 27 Sep 2010 11:50:44 -0600 Subject: [PATCH] phpdoc; use Horde_Url::redirect() --- framework/Core/lib/Horde/Core/Ajax/Application.php | 34 ++++++++++++++++------ 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/framework/Core/lib/Horde/Core/Ajax/Application.php b/framework/Core/lib/Horde/Core/Ajax/Application.php index 7d71804fd..f91f55634 100644 --- a/framework/Core/lib/Horde/Core/Ajax/Application.php +++ b/framework/Core/lib/Horde/Core/Ajax/Application.php @@ -124,14 +124,17 @@ abstract class Horde_Core_Ajax_Application */ public function logOut() { - Horde::redirect(Horde::getServiceLink('logout', $this->_app)->setRaw(true)); - exit; + Horde::getServiceLink('logout', $this->_app)->setRaw(true)->redirect(); } /** - * Returns a hash of group IDs and group names that the user has access to. + * Returns a hash of group IDs and group names that the user has access + * to. * - * @return array Groups hash. + * @return object Object with the following properties: + *
+     * 'groups' - (array) Groups hash.
+     * 
*/ public function listGroups() { @@ -148,6 +151,7 @@ abstract class Horde_Core_Ajax_Application } catch (Horde_Group_Exception $e) { Horde::logMessage($e); } + return $result; } @@ -155,10 +159,16 @@ abstract class Horde_Core_Ajax_Application * Parses a valid email address out of a complete address string. * * Variables used: - * - mbox (string): The name of the new mailbox. - * - parent (string): The parent mailbox. + *
+     * 'mbox' - (string) The name of the new mailbox.
+     * 'parent' - (string) The parent mailbox.
+     * 
+ * + * @return object Object with the following properties: + *
+     * 'email' - (string) The parsed email address.
+     * 
* - * @return string The parsed email address. * @throws Horde_Exception * @throws Horde_Mail_Exception */ @@ -173,14 +183,20 @@ abstract class Horde_Core_Ajax_Application if (!count($res)) { throw new Horde_Exception(_("No valid email address found")); } - return (object)array('email' => Horde_Mime_Address::writeAddress($res[0]->mailbox, $res[0]->host)); + + return (object)array( + 'email' => Horde_Mime_Address::writeAddress($res[0]->mailbox, $res[0]->host) + ); } /** * Loads a chunk of PHP code (usually an HTML template) from the * application's templates directory. * - * @return string A chunk of PHP output. + * @return object Object with the following properties: + *
+     * 'chunk' - (string) A chunk of PHP output.
+     * 
*/ public function chunkContent() { -- 2.11.0