summaryrefslogtreecommitdiff
path: root/actions
diff options
context:
space:
mode:
authorRobin Millette <millette@plantard.controlezvous.ca>2009-01-20 20:55:16 +0000
committerRobin Millette <millette@plantard.controlezvous.ca>2009-01-20 20:55:16 +0000
commit4471f62bc5d883fda015156ec7d3391cc7f3ac41 (patch)
tree2f7d5701c85ab8d2c8d1dfa36f8792ad78213e49 /actions
parent15264328420839c5ec3951f306169f5640037bce (diff)
uiredesign + phpdocs
Diffstat (limited to 'actions')
-rw-r--r--actions/logout.php47
1 files changed, 41 insertions, 6 deletions
diff --git a/actions/logout.php b/actions/logout.php
index 86d6270ab..0ff8dc754 100644
--- a/actions/logout.php
+++ b/actions/logout.php
@@ -1,5 +1,16 @@
<?php
-/*
+/**
+ * Logout action.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package Laconica
+ * @author Evan Prodromou <evan@controlyourself.ca>
+ * @author Robin Millette <millette@controlyourself.ca>
+ * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link http://laconi.ca/
+ *
* Laconica - a distributed open-source microblogging tool
* Copyright (C) 2008, Controlez-Vous, Inc.
*
@@ -17,18 +28,42 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('LACONICA')) {
+ exit(1);
+}
-require_once(INSTALLDIR.'/lib/openid.php');
+require_once INSTALLDIR.'/lib/openid.php';
+/**
+ * Logout action class.
+ *
+ * @category Action
+ * @package Laconica
+ * @author Evan Prodromou <evan@controlyourself.ca>
+ * @author Robin Millette <millette@controlyourself.ca>
+ * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link http://laconi.ca/
+ */
class LogoutAction extends Action
{
+ /**
+ * This is read only.
+ *
+ * @return boolean true
+ */
function isReadOnly()
{
return true;
}
-
+
+ /**
+ * Class handler.
+ *
+ * @param array $args array of arguments
+ *
+ * @return nothing
+ */
function handle($args)
{
parent::handle($args);
@@ -36,8 +71,8 @@ class LogoutAction extends Action
$this->clientError(_('Not logged in.'));
} else {
common_set_user(null);
- common_real_login(false); # not logged in
- common_forgetme(); # don't log back in!
+ common_real_login(false); // not logged in
+ common_forgetme(); // don't log back in!
common_redirect(common_local_url('public'));
}
}