X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=actions%2Fnudge.php;h=c23d3e64356f4af88ea166663e9d61d56cc95c09;hb=68b34b32667025b6d3ab74c0a6b5b356d1f24b10;hp=49223d43153fac1680b4b73fea07615f209ba873;hpb=12c475c101c070cbcc4c63f7b1049f6d3282b9ee;p=quix0rs-gnu-social.git

diff --git a/actions/nudge.php b/actions/nudge.php
index 49223d4315..c23d3e6435 100644
--- a/actions/nudge.php
+++ b/actions/nudge.php
@@ -1,5 +1,17 @@
 <?php
-/*
+
+/**
+ * User by ID action class.
+ *
+ * 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,13 +29,32 @@
  * 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/mail.php');
+require_once INSTALLDIR.'/lib/mail.php';
 
+/**
+ * Nudge a user action class.
+ *
+ * @category Action
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @author   Robin Millette <millette@controlyourself.ca>
+ * @author   Sarven Capadisli <csarven@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://laconi.ca/
+ */
 class NudgeAction extends Action
 {
-
+     /**
+     * Class handler.
+     *
+     * @param array $args array of arguments
+     *
+     * @return nothing
+     */
     function handle($args)
     {
         parent::handle($args);
@@ -33,18 +64,18 @@ class NudgeAction extends Action
             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->clientError(_('There was a problem with your session token. Try again, please.'));
             return;
@@ -58,30 +89,44 @@ class NudgeAction extends Action
         $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');
             $this->element('title', null, _('Nudge sent'));
             $this->elementEnd('head');
             $this->elementStart('body');
-            common_nudge_response();
+            $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;
+    }
 }