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