]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/adminform.php
use none instead of unset
[quix0rs-gnu-social.git] / lib / adminform.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Base class for administrative forms
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  Widget
23  * @package   StatusNet
24  * @author    Zach Copley <zach@status.net>
25  * @copyright 2009 StatusNet, Inc.
26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27  * @link      http://status.net/
28  */
29
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
31     exit(1);
32 }
33
34 /**
35  * Base class for Administrative forms
36  *
37  * Just a place holder for some utility methods to simply some
38  * repetitive form building code
39  *
40  * @category Widget
41  * @package  StatusNet
42  * @author   Zach Copley <zach@status.net>
43  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
44  * @link     http://status.net/
45  *
46  * @see      Form
47  */
48 class AdminForm extends Form
49 {
50     /**
51      * Utility to simplify some of the duplicated code around
52      * params and settings.
53      *
54      * @param string $setting      Name of the setting
55      * @param string $title        Title to use for the input
56      * @param string $instructions Instructions for this field
57      * @param string $section      config section, default = 'site'
58      *
59      * @return void
60      */
61     function input($setting, $title, $instructions, $section='site')
62     {
63         $this->out->input($setting, $title, $this->value($setting, $section), $instructions);
64     }
65
66     /**
67      * Utility to simplify getting the posted-or-stored setting value
68      *
69      * @param string $setting Name of the setting
70      * @param string $main    configuration section, default = 'site'
71      *
72      * @return string param value if posted, or current config value
73      */
74     function value($setting, $main='site')
75     {
76         $value = $this->out->trimmed($setting);
77         if (empty($value)) {
78             $value = common_config($main, $setting);
79         }
80         return $value;
81     }
82 }