Update translator documentation.

[quix0rs-gnu-social.git] / actions / nudge.php

diff --git a/actions/nudge.php b/actions/nudge.php
index de930e4628dbb481d2ddc755169d8ea1c9712136..401285b9f30febfe2816c23788f0a083e41d1f13 100644 (file)
--- a/actions/nudge.php
+++ b/actions/nudge.php
@@ -1,7 +1,19 @@
 <?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+
+/**
+ * User by ID action class.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @author   Robin Millette <millette@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ *
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2008, 2009, StatusNet, Inc.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
@@ -17,71 +29,108 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
+}
 
-require_once(INSTALLDIR.'/lib/mail.php');
+require_once INSTALLDIR.'/lib/mail.php';
 
+/**
+ * Nudge a user action class.
+ *
+ * @category Action
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @author   Robin Millette <millette@status.net>
+ * @author   Sarven Capadisli <csarven@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ */
 class NudgeAction extends Action
 {
-
+     /**
+     * Class handler.
+     *
+     * @param array $args array of arguments
+     *
+     * @return nothing
+     */
     function handle($args)
     {
         parent::handle($args);
 
         if (!common_logged_in()) {
-            $this->client_error(_('Not logged in.'));
+            // TRANS: Client error displayed trying to nudge a user without being logged in.
+            $this->clientError(_('Not logged in.'));
             return;
         }
 
-        $user = common_current_user();
+        $user  = common_current_user();
         $other = User::staticGet('nickname', $this->arg('nickname'));
 
         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
-            common_redirect(common_local_url('showstream', array('nickname' => $other->nickname)));
+            common_redirect(common_local_url('showstream',
+                array('nickname' => $other->nickname)));
             return;
         }
 
-        # CSRF protection
-
+        // CSRF protection
         $token = $this->trimmed('token');
-        
+
         if (!$token || $token != common_session_token()) {
-            $this->client_error(_('There was a problem with your session token. Try again, please.'));
+            // TRANS: Client error displayed when the session token does not match or is not given.
+            $this->clientError(_('There was a problem with your session token. Try again, please.'));
             return;
         }
 
         if (!$other->email || !$other->emailnotifynudge) {
-            $this->client_error(_('This user doesn\'t allow nudges or hasn\'t confirmed or set his email yet.'));
+            // TRANS: Client error displayed trying to nudge a user that cannot be nudged.
+            $this->clientError(_('This user doesn\'t allow nudges or hasn\'t confirmed or set their email address yet.'));
             return;
         }
 
         $this->notify($user, $other);
 
         if ($this->boolean('ajax')) {
-            common_start_html('text/xml;charset=utf-8', true);
+            $this->startHTML('text/xml;charset=utf-8');
             $this->elementStart('head');
+            // TRANS: Page title after sending a nudge.
             $this->element('title', null, _('Nudge sent'));
             $this->elementEnd('head');
             $this->elementStart('body');
-            common_nudge_response();
+            // TRANS: Confirmation text after sending a nudge.
+            $this->element('p', array('id' => 'nudge_response'), _('Nudge sent!'));
             $this->elementEnd('body');
             $this->elementEnd('html');
         } else {
             // display a confirmation to the user
             common_redirect(common_local_url('showstream',
-                                             array('nickname' => $other->nickname)));
+                                             array('nickname' => $other->nickname)),
+                            303);
         }
     }
 
+     /**
+     * Do the actual notification
+     *
+     * @param class $user  nudger
+     * @param class $other nudgee
+     *
+     * @return nothing
+     */
     function notify($user, $other)
     {
         if ($other->id != $user->id) {
             if ($other->email && $other->emailnotifynudge) {
                 mail_notify_nudge($user, $other);
             }
-            # XXX: notify by IM
-            # XXX: notify by SMS
+            // XXX: notify by IM
+            // XXX: notify by SMS
         }
     }
-}
 
+    function isReadOnly($args)
+    {
+        return true;
+    }
+}