lib/usernoprofileexception.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Class for an exception when the user profile is missing
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Exception
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('GNUSOCIAL')) { exit(1); }
  31
  32 /**
  33  * Class for an exception when the user profile is missing
  34  *
  35  * @category Exception
  36  * @package  StatusNet
  37  * @author   Evan Prodromou <evan@status.net>
  38  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
  39  * @link     http://status.net/
  40  */
  41
  42 class UserNoProfileException extends NoProfileException
  43 {
  44     protected $user = null;
  45
  46     /**
  47      * constructor
  48      *
  49      * @param User $user User that's missing a profile
  50      */
  51
  52     public function __construct(User $user)
  53     {
  54         $this->user = $user;
  55
  56         // TRANS: Exception text shown when no profile can be found for a user.
  57         // TRANS: %1$s is a user nickname, $2$d is a user ID (number).
  58         $message = sprintf(_('User %1$s (%2$d) has no profile record.'),
  59                            $user->nickname, $user->id);
  60
  61         parent::__construct($user->id, $message);
  62     }
  63
  64     /**
  65      * Accessor for user
  66      *
  67      * @return User the user that triggered this exception
  68      */
  69
  70     public function getUser()
  71     {
  72         return $this->user;
  73     }
  74 }