uiredesign + phpdocs

This commit is contained in:
Robin Millette 2009-01-21 00:06:56 +00:00 committed by Robin Millette
parent 1ab0de3ddd
commit 592403cdc3
1 changed files with 48 additions and 10 deletions

View File

@ -1,5 +1,17 @@
<?php <?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 * Laconica - a distributed open-source microblogging tool
* Copyright (C) 2008, Controlez-Vous, Inc. * Copyright (C) 2008, Controlez-Vous, Inc.
* *
@ -17,13 +29,31 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. * 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>
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://laconi.ca/
*/
class NudgeAction extends Action class NudgeAction extends Action
{ {
/**
* Class handler.
*
* @param array $args array of arguments
*
* @return nothing
*/
function handle($args) function handle($args)
{ {
parent::handle($args); parent::handle($args);
@ -37,12 +67,12 @@ class NudgeAction extends Action
$other = User::staticGet('nickname', $this->arg('nickname')); $other = User::staticGet('nickname', $this->arg('nickname'));
if ($_SERVER['REQUEST_METHOD'] != 'POST') { 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; return;
} }
# CSRF protection // CSRF protection
$token = $this->trimmed('token'); $token = $this->trimmed('token');
if (!$token || $token != common_session_token()) { if (!$token || $token != common_session_token()) {
@ -73,14 +103,22 @@ class NudgeAction extends Action
} }
} }
/**
* Do the actual notification
*
* @param class $user nudger
* @param class $other nudgee
*
* @return nothing
*/
function notify($user, $other) function notify($user, $other)
{ {
if ($other->id != $user->id) { if ($other->id != $user->id) {
if ($other->email && $other->emailnotifynudge) { if ($other->email && $other->emailnotifynudge) {
mail_notify_nudge($user, $other); mail_notify_nudge($user, $other);
} }
# XXX: notify by IM // XXX: notify by IM
# XXX: notify by SMS // XXX: notify by SMS
} }
} }
} }