lib/leaveform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for leaving a group
   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('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * Form for leaving a group
  35  *
  36  * @category Form
  37  * @package  StatusNet
  38  * @author   Evan Prodromou <evan@status.net>
  39  * @author   Sarven Capadisli <csarven@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      UnsubscribeForm
  44  */
  45 class LeaveForm extends Form
  46 {
  47     /**
  48      * group for user to leave
  49      */
  50
  51     var $group = null;
  52
  53     /**
  54      * Constructor
  55      *
  56      * @param HTMLOutputter $out   output channel
  57      * @param User_group    $group group to leave
  58      */
  59     function __construct(HTMLOutputter $out=null, User_group $group=null)
  60     {
  61         parent::__construct($out);
  62
  63         $this->group = $group;
  64     }
  65
  66     /**
  67      * ID of the form
  68      *
  69      * @return string ID of the form
  70      */
  71     function id()
  72     {
  73         return 'group-leave-' . $this->group->getID();
  74     }
  75
  76     /**
  77      * class of the form
  78      *
  79      * @return string of the form class
  80      */
  81     function formClass()
  82     {
  83         return 'form_group_leave ajax';
  84     }
  85
  86     /**
  87      * Action of the form
  88      *
  89      * @return string URL of the action
  90      */
  91     function action()
  92     {
  93         return common_local_url('leavegroup', array('id' => $this->group->getID()));
  94     }
  95
  96     /**
  97      * Action elements
  98      *
  99      * @return void
 100      */
 101     function formActions()
 102     {
 103         // TRANS: Button text on form to leave a group.
 104         $this->out->submit('submit', _m('BUTTON','Leave'));
 105     }
 106 }