lib/joinform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for joining 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 joining 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 JoinForm extends Form
  46 {
  47     /**
  48      * group for user to join
  49      */
  50     var $group = null;
  51
  52     /**
  53      * Constructor
  54      *
  55      * @param HTMLOutputter $out   output channel
  56      * @param User_group    $group group to join
  57      */
  58     function __construct(HTMLOutputter $out=null, User_group $group=null)
  59     {
  60         parent::__construct($out);
  61
  62         $this->group = $group;
  63     }
  64
  65     /**
  66      * ID of the form
  67      *
  68      * @return string ID of the form
  69      */
  70     function id()
  71     {
  72         return 'group-join-' . $this->group->getID();
  73     }
  74
  75     /**
  76      * class of the form
  77      *
  78      * @return string of the form class
  79      */
  80     function formClass()
  81     {
  82         return 'form_group_join ajax';
  83     }
  84
  85     /**
  86      * Action of the form
  87      *
  88      * @return string URL of the action
  89      */
  90     function action()
  91     {
  92         return common_local_url('joingroup', array('id' => $this->group->getID()));
  93     }
  94
  95     /**
  96      * Action elements
  97      *
  98      * @return void
  99      */
 100     function formActions()
 101     {
 102         // TRANS: Button text for joining a group.
 103         $this->out->submit('submit', _m('BUTTON','Join'));
 104     }
 105 }