]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/subscribeform.php
Same goes to onStartShowAside() which has 'Action' as type-hint.
[quix0rs-gnu-social.git] / lib / subscribeform.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Form for subscribing to a user
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 subscribing to a user
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 SubscribeForm extends Form
50 {
51     /**
52      * Profile of user to subscribe to
53      */
54     var $profile = null;
55
56     /**
57      * Constructor
58      *
59      * @param HTMLOutputter $out     output channel
60      * @param Profile       $profile profile of user to subscribe to
61      */
62     function __construct($out=null, $profile=null)
63     {
64         parent::__construct($out);
65
66         $this->profile = $profile;
67     }
68
69     /**
70      * ID of the form
71      *
72      * @return int ID of the form
73      */
74     function id()
75     {
76         return 'subscribe-' . $this->profile->id;
77     }
78
79     /**
80      * class of the form
81      *
82      * @return string of the form class
83      */
84     function formClass()
85     {
86         return 'form_user_subscribe ajax';
87     }
88
89     /**
90      * Action of the form
91      *
92      * @return string URL of the action
93      */
94     function action()
95     {
96         return common_local_url('subscribe');
97     }
98
99     /**
100      * Legend of the Form
101      *
102      * @return void
103      */
104     function formLegend()
105     {
106         // TRANS: Form of form to subscribe to a user.
107         $this->out->element('legend', null, _('Subscribe to this user'));
108     }
109
110     /**
111      * Data elements of the form
112      *
113      * @return void
114      */
115     function formData()
116     {
117         $this->out->hidden('subscribeto-' . $this->profile->id,
118                            $this->profile->id,
119                            'subscribeto');
120     }
121
122     /**
123      * Action elements
124      *
125      * @return void
126      */
127     function formActions()
128     {
129         // TRANS: Button text to subscribe to a user.
130         $this->out->submit('submit', _m('BUTTON','Subscribe'), 'submit', null,
131                            // TRANS: Button title to subscribe to a user.
132                            _('Subscribe to this user.'));
133     }
134 }