adminform.php 2.6 KB

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