lib/grantroleform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for granting a role
   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  Form
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>, Brion Vibber <brion@status.net>
  25  * @copyright 2009-2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Form for sandboxing a user
  36  *
  37  * @category Form
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://status.net/
  42  *
  43  * @see      UnSandboxForm
  44  */
  45 class GrantRoleForm extends ProfileActionForm
  46 {
  47     function __construct($role, $label, $writer, $profile, $r2args)
  48     {
  49         parent::__construct($writer, $profile, $r2args);
  50         $this->role = $role;
  51         $this->label = $label;
  52     }
  53
  54     /**
  55      * Action this form provides
  56      *
  57      * @return string Name of the action, lowercased.
  58      */
  59     function target()
  60     {
  61         return 'grantrole';
  62     }
  63
  64     /**
  65      * Title of the form
  66      *
  67      * @return string Title of the form, internationalized
  68      */
  69     function title()
  70     {
  71         return $this->label;
  72     }
  73
  74     function formData()
  75     {
  76         parent::formData();
  77         $this->out->hidden('role', $this->role);
  78     }
  79
  80     /**
  81      * Description of the form
  82      *
  83      * @return string description of the form, internationalized
  84      */
  85     function description()
  86     {
  87         // TRANS: Description on form for granting a role.
  88         return sprintf(_('Grant this user the "%s" role'), $this->label);
  89     }
  90 }