]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/leaveform.php
Same goes to onStartShowAside() which has 'Action' as type-hint.
[quix0rs-gnu-social.git] / 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('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 LeaveForm extends Form
50 {
51     /**
52      * group for user to leave
53      */
54
55     var $group = null;
56
57     /**
58      * Constructor
59      *
60      * @param HTMLOutputter $out   output channel
61      * @param group         $group group to leave
62      */
63     function __construct($out=null, $group=null)
64     {
65         parent::__construct($out);
66
67         $this->group = $group;
68     }
69
70     /**
71      * ID of the form
72      *
73      * @return string ID of the form
74      */
75     function id()
76     {
77         return 'group-leave-' . $this->group->id;
78     }
79
80     /**
81      * class of the form
82      *
83      * @return string of the form class
84      */
85     function formClass()
86     {
87         return 'form_group_leave ajax';
88     }
89
90     /**
91      * Action of the form
92      *
93      * @return string URL of the action
94      */
95     function action()
96     {
97         return common_local_url('leavegroup',
98                                 array('id' => $this->group->id));
99     }
100
101     /**
102      * Action elements
103      *
104      * @return void
105      */
106     function formActions()
107     {
108         // TRANS: Button text on form to leave a group.
109         $this->out->submit('submit', _m('BUTTON','Leave'));
110     }
111 }