Merge branch '1.0.x' of git://gitorious.org/statusnet/mainline

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

diff --git a/actions/avatarbynickname.php b/actions/avatarbynickname.php
index d2d078b61f1590cdf4ba8c6959e63bc28f98f717..fa97a86ebf69b98127791ddf7a42731e8c7c4264 100644 (file)
--- a/actions/avatarbynickname.php
+++ b/actions/avatarbynickname.php
@@ -1,7 +1,18 @@
 <?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * Retrieve user avatar by nickname 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,36 +28,60 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
+}
 
+/**
+ * Retrieve user avatar by nickname action class.
+ *
+ * @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/
+ */
 class AvatarbynicknameAction extends Action
 {
+    /**
+     * Class handler.
+     *
+     * @param array $args query arguments
+     *
+     * @return boolean false if nickname or user isn't found
+     */
     function handle($args)
     {
         parent::handle($args);
         $nickname = $this->trimmed('nickname');
         if (!$nickname) {
+            // TRANS: Client error displayed trying to get an avatar without providing a nickname.
             $this->clientError(_('No nickname.'));
             return;
         }
         $size = $this->trimmed('size');
         if (!$size) {
+            // TRANS: Client error displayed trying to get an avatar without providing an avatar size.
             $this->clientError(_('No size.'));
             return;
         }
         $size = strtolower($size);
         if (!in_array($size, array('original', '96', '48', '24'))) {
+            // TRANS: Client error displayed trying to get an avatar providing an invalid avatar size.
             $this->clientError(_('Invalid size.'));
             return;
         }
 
         $user = User::staticGet('nickname', $nickname);
         if (!$user) {
+            // TRANS: Client error displayed trying to get an avatar for a non-existing user.
             $this->clientError(_('No such user.'));
             return;
         }
         $profile = $user->getProfile();
         if (!$profile) {
+            // TRANS: Client error displayed trying to get an avatar for a user without a profile.
             $this->clientError(_('User has no profile.'));
             return;
         }
@@ -60,11 +95,16 @@ class AvatarbynicknameAction extends Action
             $url = $avatar->url;
         } else {
             if ($size == 'original') {
-                $url = common_default_avatar(AVATAR_PROFILE_SIZE);
+                $url = Avatar::defaultImage(AVATAR_PROFILE_SIZE);
             } else {
-                $url = common_default_avatar($size+0);
+                $url = Avatar::defaultImage($size+0);
             }
         }
         common_redirect($url, 302);
     }
+
+    function isReadOnly($args)
+    {
+        return true;
+    }
 }