summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobin Millette <millette@controlyourself.ca>2009-01-22 09:39:53 +0000
committerRobin Millette <millette@plantard.controlezvous.ca>2009-01-22 09:39:53 +0000
commita1cb64679b06e7962c2ffffc1fc5f115494cc005 (patch)
treebe33ee96e73ec56a241396d7135f2123655e57db
parentf871f52624b0a21880e2f54a7da60447dbde3c62 (diff)
uiredesign + phpdocs
-rw-r--r--actions/disfavor.php61
-rw-r--r--actions/favor.php76
2 files changed, 92 insertions, 45 deletions
diff --git a/actions/disfavor.php b/actions/disfavor.php
index d4a189d19..09b3bf18d 100644
--- a/actions/disfavor.php
+++ b/actions/disfavor.php
@@ -1,5 +1,17 @@
<?php
-/*
+
+/**
+ * Disfavor 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,59 +29,65 @@
* 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/favorform.php';
+/**
+ * Disfavor 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 DisfavorAction extends Action
{
-
+ /**
+ * Class handler.
+ *
+ * @param array $args query arguments
+ *
+ * @return void
+ */
function handle($args)
{
-
parent::handle($args);
-
if (!common_logged_in()) {
$this->clientError(_('Not logged in.'));
return;
}
-
$user = common_current_user();
-
if ($_SERVER['REQUEST_METHOD'] != 'POST') {
- common_redirect(common_local_url('showfavorites', array('nickname' => $user->nickname)));
+ common_redirect(common_local_url('showfavorites',
+ array('nickname' => $user->nickname)));
return;
}
-
- $id = $this->trimmed('notice');
-
+ $id = $this->trimmed('notice');
$notice = Notice::staticGet($id);
-
- $token = $this->trimmed('token-'.$notice->id);
-
+ $token = $this->trimmed('token-'.$notice->id);
if (!$token || $token != common_session_token()) {
$this->clientError(_("There was a problem with your session token. Try again, please."));
return;
}
-
- $fave = new Fave();
- $fave->user_id = $this->id;
+ $fave = new Fave();
+ $fave->user_id = $this->id;
$fave->notice_id = $notice->id;
if (!$fave->find(true)) {
$this->clientError(_('This notice is not a favorite!'));
return;
}
-
$result = $fave->delete();
-
if (!$result) {
common_log_db_error($fave, 'DELETE', __FILE__);
$this->serverError(_('Could not delete favorite.'));
return;
}
-
$user->blowFavesCache();
-
if ($this->boolean('ajax')) {
$this->startHTML('text/xml;charset=utf-8', true);
$this->elementStart('head');
@@ -86,3 +104,4 @@ class DisfavorAction extends Action
}
}
}
+
diff --git a/actions/favor.php b/actions/favor.php
index 92756366d..8ecde4b11 100644
--- a/actions/favor.php
+++ b/actions/favor.php
@@ -1,4 +1,18 @@
<?php
+
+/**
+ * Favor 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,57 +31,63 @@
* 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';
require_once INSTALLDIR.'/lib/disfavorform.php';
+/**
+ * Favor 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 FavorAction extends Action
{
-
+ /**
+ * Class handler.
+ *
+ * @param array $args query arguments
+ *
+ * @return void
+ */
function handle($args)
{
parent::handle($args);
-
if (!common_logged_in()) {
$this->clientError(_('Not logged in.'));
return;
}
-
$user = common_current_user();
-
if ($_SERVER['REQUEST_METHOD'] != 'POST') {
- common_redirect(common_local_url('showfavorites', array('nickname' => $user->nickname)));
+ common_redirect(common_local_url('showfavorites',
+ array('nickname' => $user->nickname)));
return;
}
-
- $id = $this->trimmed('notice');
-
+ $id = $this->trimmed('notice');
$notice = Notice::staticGet($id);
-
- # CSRF protection
-
- $token = $this->trimmed('token-'.$notice->id);
+ $token = $this->trimmed('token-'.$notice->id);
if (!$token || $token != common_session_token()) {
$this->clientError(_("There was a problem with your session token. Try again, please."));
return;
}
-
if ($user->hasFave($notice)) {
$this->clientError(_('This notice is already a favorite!'));
return;
}
-
$fave = Fave::addNew($user, $notice);
-
if (!$fave) {
$this->serverError(_('Could not create favorite.'));
return;
}
-
- $this->notify($fave, $notice, $user);
+ $this->notify($notice, $user);
$user->blowFavesCache();
-
if ($this->boolean('ajax')) {
$this->startHTML('text/xml;charset=utf-8', true);
$this->elementStart('head');
@@ -84,16 +104,24 @@ class FavorAction extends Action
}
}
- function notify($fave, $notice, $user)
+ /**
+ * Notifies a user when his notice is favorited.
+ *
+ * @param class $notice favorited notice
+ * @param class $user user declaring a favorite
+ *
+ * @return void
+ */
+ function notify($notice, $user)
{
$other = User::staticGet('id', $notice->profile_id);
if ($other && $other->id != $user->id) {
if ($other->email && $other->emailnotifyfav) {
mail_notify_fave($other, $user, $notice);
}
- # XXX: notify by IM
- # XXX: notify by SMS
+ // XXX: notify by IM
+ // XXX: notify by SMS
}
}
-
}
+