]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/SearchSub/forms/searchsub.php
Merge commit 'refs/merge-requests/199' of git://gitorious.org/statusnet/mainline...
[quix0rs-gnu-social.git] / plugins / SearchSub / forms / searchsub.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Form for subscribing to a search
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  SearchSubPlugin
23  * @package   StatusNet
24  * @author    Brion Vibber <brion@status.net>
25  * @author    Evan Prodromou <evan@status.net>
26  * @author    Sarven Capadisli <csarven@status.net>
27  * @copyright 2009-2011 StatusNet, Inc.
28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
29  * @link      http://status.net/
30  */
31
32 if (!defined('STATUSNET') && !defined('LACONICA')) {
33     exit(1);
34 }
35
36 /**
37  * Form for subscribing to a user
38  *
39  * @category SearchSubPlugin
40  * @package  StatusNet
41  * @author   Brion Vibber <brion@status.net>
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 SearchSubForm extends Form
50 {
51     /**
52      * Name of search to subscribe to
53      */
54     var $search = '';
55
56     /**
57      * Constructor
58      *
59      * @param HTMLOutputter $out     output channel
60      * @param string        $search     name of search to subscribe to
61      */
62     function __construct($out=null, $search=null)
63     {
64         parent::__construct($out);
65
66         $this->search = $search;
67     }
68
69     /**
70      * ID of the form
71      *
72      * @return int ID of the form
73      */
74     function id()
75     {
76         return 'search-subscribe-' . $this->search;
77     }
78
79
80     /**
81      * class of the form
82      *
83      * @return string of the form class
84      */
85     function formClass()
86     {
87         // class to match existing styles...
88         return 'form_user_subscribe ajax';
89     }
90
91
92     /**
93      * Action of the form
94      *
95      * @return string URL of the action
96      */
97     function action()
98     {
99         return common_local_url('searchsub', array('search' => $this->search));
100     }
101
102     /**
103      * Legend of the Form
104      *
105      * @return void
106      */
107     function formLegend()
108     {
109         // TRANS: Form legend.
110         $this->out->element('legend', null, _m('Subscribe to this search'));
111     }
112
113     /**
114      * Data elements of the form
115      *
116      * @return void
117      */
118     function formData()
119     {
120         $this->out->hidden('subscribeto-' . $this->search,
121                            $this->search,
122                            'subscribeto');
123     }
124
125     /**
126      * Action elements
127      *
128      * @return void
129      */
130     function formActions()
131     {
132         $this->out->submit('submit',
133                            // TRANS: Button text for subscribing to a search.
134                            _m('BUTTON','Subscribe'),
135                            'submit',
136                            null,
137                            // TRANS: Button title for subscribing to a search.
138                            _m('Subscribe to this search.'));
139     }
140 }