lib/cancelgroupform.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('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/form.php';
  36
  37 /**
  38  * Form for leaving a group
  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      UnsubscribeForm
  48  */
  49 class CancelGroupForm extends Form
  50 {
  51     /**
  52      * group for user to leave
  53      */
  54
  55     var $group = null;
  56     var $profile = null;
  57
  58     /**
  59      * Constructor
  60      *
  61      * @param HTMLOutputter $out   output channel
  62      * @param group         $group group to leave
  63      */
  64     function __construct($out=null, $group=null, $profile=null)
  65     {
  66         parent::__construct($out);
  67
  68         $this->group = $group;
  69         $this->profile = $profile;
  70     }
  71
  72     /**
  73      * ID of the form
  74      *
  75      * @return string ID of the form
  76      */
  77     function id()
  78     {
  79         return 'group-cancel-' . $this->group->id;
  80     }
  81
  82     /**
  83      * class of the form
  84      *
  85      * @return string of the form class
  86      */
  87     function formClass()
  88     {
  89         return 'form_group_leave ajax';
  90     }
  91
  92     /**
  93      * Action of the form
  94      *
  95      * @return string URL of the action
  96      */
  97     function action()
  98     {
  99         $params = array();
 100         if ($this->profile) {
 101             $params['profile_id'] = $this->profile->id;
 102         }
 103         return common_local_url('cancelgroup',
 104                                 array('id' => $this->group->id), $params);
 105     }
 106
 107     /**
 108      * Action elements
 109      *
 110      * @return void
 111      */
 112     function formActions()
 113     {
 114         // TRANS: Submit button text on form to cancel group join request.
 115         $this->out->submit('submit', _m('BUTTON','Cancel join request'));
 116     }
 117 }