lib/blockform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for blocking a user
   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>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @copyright 2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/form.php';
  36
  37 /**
  38  * Form for blocking a user
  39  *
  40  * @category Form
  41  * @package  StatusNet
  42  * @author   Evan Prodromou <evan@status.net>
  43  * @author   Sarven Capadisli <csarven@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  *
  47  * @see      UnblockForm
  48  */
  49
  50 class BlockForm extends Form
  51 {
  52     /**
  53      * Profile of user to block
  54      */
  55
  56     var $profile = null;
  57
  58     /**
  59      * Return-to args
  60      */
  61
  62     var $args = null;
  63
  64     /**
  65      * Constructor
  66      *
  67      * @param HTMLOutputter $out     output channel
  68      * @param Profile       $profile profile of user to block
  69      * @param array         $args    return-to args
  70      */
  71
  72     function __construct($out=null, $profile=null, $args=null)
  73     {
  74         parent::__construct($out);
  75
  76         $this->profile = $profile;
  77         $this->args    = $args;
  78     }
  79
  80     /**
  81      * ID of the form
  82      *
  83      * @return int ID of the form
  84      */
  85
  86     function id()
  87     {
  88         return 'block-' . $this->profile->id;
  89     }
  90
  91
  92     /**
  93      * class of the form
  94      *
  95      * @return string class of the form
  96      */
  97
  98     function formClass()
  99     {
 100         return 'form_user_block';
 101     }
 102
 103
 104     /**
 105      * Action of the form
 106      *
 107      * @return string URL of the action
 108      */
 109
 110     function action()
 111     {
 112         return common_local_url('block');
 113     }
 114
 115
 116     /**
 117      * Legend of the Form
 118      *
 119      * @return void
 120      */
 121     function formLegend()
 122     {
 123         $this->out->element('legend', null, _('Block this user'));
 124     }
 125
 126
 127     /**
 128      * Data elements of the form
 129      *
 130      * @return void
 131      */
 132
 133     function formData()
 134     {
 135         $this->out->hidden('blockto-' . $this->profile->id,
 136                            $this->profile->id,
 137                            'blockto');
 138         if ($this->args) {
 139             foreach ($this->args as $k => $v) {
 140                 $this->out->hidden('returnto-' . $k, $v);
 141             }
 142         }
 143     }
 144
 145     /**
 146      * Action elements
 147      *
 148      * @return void
 149      */
 150
 151     function formActions()
 152     {
 153         $this->out->submit('submit', _('Block'), 'submit', null, _('Block this user'));
 154     }
 155 }