From cb2e374bc2a2e439bc5bd54adc868d9e819c1b64 Mon Sep 17 00:00:00 2001 From: Robin Millette Date: Thu, 22 Jan 2009 15:20:58 +0000 Subject: uiredesign + phpdocs --- actions/favoritesrss.php | 80 ++++++++++++++++++++++++++++++++++++------------ 1 file changed, 60 insertions(+), 20 deletions(-) (limited to 'actions') diff --git a/actions/favoritesrss.php b/actions/favoritesrss.php index 3f4ffc63a..19339325c 100644 --- a/actions/favoritesrss.php +++ b/actions/favoritesrss.php @@ -1,5 +1,17 @@ + * @author Robin Millette + * @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,22 +29,37 @@ * along with this program. If not, see . */ -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/rssaction.php'); +if (!defined('LACONICA')) { + exit(1); +} -// Formatting of RSS handled by Rss10Action +require_once INSTALLDIR.'/lib/rssaction.php'; +/** + * RSS feed for user favorites action class. + * + * Formatting of RSS handled by Rss10Action + * + * @category Action + * @package Laconica + * @author Evan Prodromou + * @author Robin Millette + * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3 + * @link http://laconi.ca/ + */ class FavoritesrssAction extends Rss10Action { - var $user = null; + /** + * Initialization. + * + * @return boolean false if user doesn't exist + */ function init() { - $nickname = $this->trimmed('nickname'); + $nickname = $this->trimmed('nickname'); $this->user = User::staticGet('nickname', $nickname); - if (!$this->user) { $this->clientError(_('No such user.')); return false; @@ -41,26 +68,33 @@ class FavoritesrssAction extends Rss10Action } } - function get_notices($limit=0) + /** + * Get notices + * + * @param integer $limit max number of notices to return + * + * @return array notices + */ + function getNotices($limit=0) { - - $user = $this->user; - - $notice = $user->favoriteNotices(0, $limit); - + $user = $this->user; + $notice = $user->favoriteNotices(0, $limit); $notices = array(); - while ($notice->fetch()) { $notices[] = clone($notice); } - return $notices; } - function get_channel() + /** + * Get channel. + * + * @return array associative array on channel information + */ + function getChannel() { $user = $this->user; - $c = array('url' => common_local_url('favoritesrss', + $c = array('url' => common_local_url('favoritesrss', array('nickname' => $user->nickname)), 'title' => sprintf(_("%s favorite notices"), $user->nickname), @@ -71,8 +105,14 @@ class FavoritesrssAction extends Rss10Action return $c; } - function get_image() + /** + * Get image. + * + * @return voir + */ + function getImage() { return null; } -} \ No newline at end of file +} + -- cgit v1.2.3-54-g00ecf From dfb21679e22e982bcbd26c48230f269735d601e0 Mon Sep 17 00:00:00 2001 From: Robin Millette Date: Thu, 22 Jan 2009 15:30:58 +0000 Subject: uiredesign + phpdocs --- actions/publicxrds.php | 70 +++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 55 insertions(+), 15 deletions(-) (limited to 'actions') diff --git a/actions/publicxrds.php b/actions/publicxrds.php index e765fb1c9..a0f54e667 100644 --- a/actions/publicxrds.php +++ b/actions/publicxrds.php @@ -1,5 +1,17 @@ + * @author Robin Millette + * @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,48 +29,75 @@ * along with this program. If not, see . */ -if (!defined('LACONICA')) { exit(1); } - -require_once(INSTALLDIR.'/lib/openid.php'); +if (!defined('LACONICA')) { + exit(1); +} -# XXX: factor out similarities with XrdsAction +require_once INSTALLDIR.'/lib/openid.php'; +/** + * Public XRDS for OpenID + * + * @category Action + * @package Laconica + * @author Evan Prodromou + * @author Robin Millette + * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3 + * @link http://laconi.ca/ + * + * @todo factor out similarities with XrdsAction + */ class PublicxrdsAction extends Action { + /** + * 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); - header('Content-Type: application/xrds+xml'); - common_start_xml(); $this->elementStart('XRDS', array('xmlns' => 'xri://$xrds')); - $this->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)', 'xmlns:simple' => 'http://xrds-simple.net/core/1.0', 'version' => '2.0')); - $this->element('Type', null, 'xri://$xrds*simple'); - foreach (array('finishopenidlogin', 'finishaddopenid', 'finishimmediate') as $finish) { $this->show_service(Auth_OpenID_RP_RETURN_TO_URL_TYPE, common_local_url($finish)); } - $this->elementEnd('XRD'); - $this->elementEnd('XRDS'); common_end_xml(); } - function show_service($type, $uri, $params=null, $sigs=null, $localId=null) + /** + * Show service. + * + * @param string $type XRDS type + * @param string $uri URI + * @param array $params type parameters, null by default + * @param array $sigs type signatures, null by default + * @param string $localId local ID, null by default + * + * @return void + */ + function showService($type, $uri, $params=null, $sigs=null, $localId=null) { $this->elementStart('Service'); if ($uri) { @@ -80,4 +119,5 @@ class PublicxrdsAction extends Action } $this->elementEnd('Service'); } -} \ No newline at end of file +} + -- cgit v1.2.3-54-g00ecf From b39d4788b9c5b6c1166b10135d3a38355c62ba53 Mon Sep 17 00:00:00 2001 From: Robin Millette Date: Thu, 22 Jan 2009 15:37:35 +0000 Subject: uiredesign + phpdocs --- actions/xrds.php | 108 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 72 insertions(+), 36 deletions(-) (limited to 'actions') diff --git a/actions/xrds.php b/actions/xrds.php index 14cb9d503..629de3a86 100644 --- a/actions/xrds.php +++ b/actions/xrds.php @@ -1,5 +1,17 @@ + * @author Robin Millette + * @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,35 +29,63 @@ * along with this program. If not, see . */ -if (!defined('LACONICA')) { exit(1); } +if (!defined('LACONICA')) { + exit(1); +} -require_once(INSTALLDIR.'/lib/omb.php'); +require_once INSTALLDIR.'/lib/omb.php'; +/** + * XRDS for OpenID + * + * @category Action + * @package Laconica + * @author Evan Prodromou + * @author Robin Millette + * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3 + * @link http://laconi.ca/ + */ class XrdsAction extends Action { - + /** + * Is read only? + * + * @return boolean true + */ function isReadOnly() { return true; } + /** + * Class handler. + * + * @param array $args query arguments + * + * @return void + */ function handle($args) { parent::handle($args); $nickname = $this->trimmed('nickname'); - $user = User::staticGet('nickname', $nickname); + $user = User::staticGet('nickname', $nickname); if (!$user) { $this->clientError(_('No such user.')); return; } - $this->show_xrds($user); + $this->showXrds($user); } - function show_xrds($user) + /** + * Show XRDS for a user. + * + * @param class $user XRDS for this user. + * + * @return void + */ + function showXrds($user) { - header('Content-Type: application/xrds+xml'); - common_start_xml(); $this->elementStart('XRDS', array('xmlns' => 'xri://$xrds')); @@ -53,66 +93,61 @@ class XrdsAction extends Action 'xml:id' => 'oauth', 'xmlns:simple' => 'http://xrds-simple.net/core/1.0', 'version' => '2.0')); - $this->element('Type', null, 'xri://$xrds*simple'); - - $this->show_service(OAUTH_ENDPOINT_REQUEST, + $this->showService(OAUTH_ENDPOINT_REQUEST, common_local_url('requesttoken'), array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY), array(OAUTH_HMAC_SHA1), $user->uri); - - $this->show_service(OAUTH_ENDPOINT_AUTHORIZE, + $this->showService(OAUTH_ENDPOINT_AUTHORIZE, common_local_url('userauthorization'), array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY), array(OAUTH_HMAC_SHA1)); - - $this->show_service(OAUTH_ENDPOINT_ACCESS, + $this->showService(OAUTH_ENDPOINT_ACCESS, common_local_url('accesstoken'), array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY), array(OAUTH_HMAC_SHA1)); - - $this->show_service(OAUTH_ENDPOINT_RESOURCE, + $this->showService(OAUTH_ENDPOINT_RESOURCE, null, array(OAUTH_AUTH_HEADER, OAUTH_POST_BODY), array(OAUTH_HMAC_SHA1)); - $this->elementEnd('XRD'); - # XXX: decide whether to include user's ID/nickname in postNotice URL - + // XXX: decide whether to include user's ID/nickname in postNotice URL $this->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)', 'xml:id' => 'omb', 'xmlns:simple' => 'http://xrds-simple.net/core/1.0', 'version' => '2.0')); - $this->element('Type', null, 'xri://$xrds*simple'); - - $this->show_service(OMB_ENDPOINT_POSTNOTICE, + $this->showService(OMB_ENDPOINT_POSTNOTICE, common_local_url('postnotice')); - - $this->show_service(OMB_ENDPOINT_UPDATEPROFILE, + $this->showService(OMB_ENDPOINT_UPDATEPROFILE, common_local_url('updateprofile')); - $this->elementEnd('XRD'); - $this->elementStart('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)', 'version' => '2.0')); - $this->element('Type', null, 'xri://$xrds*simple'); - - $this->show_service(OAUTH_DISCOVERY, + $this->showService(OAUTH_DISCOVERY, '#oauth'); - $this->show_service(OMB_NAMESPACE, + $this->showService(OMB_NAMESPACE, '#omb'); - $this->elementEnd('XRD'); - $this->elementEnd('XRDS'); common_end_xml(); } - function show_service($type, $uri, $params=null, $sigs=null, $localId=null) + /** + * Show service. + * + * @param string $type XRDS type + * @param string $uri URI + * @param array $params type parameters, null by default + * @param array $sigs type signatures, null by default + * @param string $localId local ID, null by default + * + * @return void + */ + function showService($type, $uri, $params=null, $sigs=null, $localId=null) { $this->elementStart('Service'); if ($uri) { @@ -134,4 +169,5 @@ class XrdsAction extends Action } $this->elementEnd('Service'); } -} \ No newline at end of file +} + -- cgit v1.2.3-54-g00ecf From 3db07789141b0a5592ea1ad944cb0ed73c314e29 Mon Sep 17 00:00:00 2001 From: Robin Millette Date: Thu, 22 Jan 2009 15:37:58 +0000 Subject: uiredesign + phpdocs --- actions/publicxrds.php | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'actions') diff --git a/actions/publicxrds.php b/actions/publicxrds.php index a0f54e667..aad59d779 100644 --- a/actions/publicxrds.php +++ b/actions/publicxrds.php @@ -49,7 +49,6 @@ require_once INSTALLDIR.'/lib/openid.php'; */ class PublicxrdsAction extends Action { - /** * Is read only? * @@ -78,7 +77,7 @@ class PublicxrdsAction extends Action 'version' => '2.0')); $this->element('Type', null, 'xri://$xrds*simple'); foreach (array('finishopenidlogin', 'finishaddopenid', 'finishimmediate') as $finish) { - $this->show_service(Auth_OpenID_RP_RETURN_TO_URL_TYPE, + $this->showService(Auth_OpenID_RP_RETURN_TO_URL_TYPE, common_local_url($finish)); } $this->elementEnd('XRD'); -- cgit v1.2.3-54-g00ecf