More linting and fixing of comments and PHP Doc, types, etc.

This commit is contained in:
jgen
2014-04-28 01:26:22 -04:00
parent a0a39784d4
commit 022c162f40
11 changed files with 194 additions and 65 deletions

View File

@@ -24,8 +24,12 @@ class ConfigSaveEvent extends Event {
* Sent when the setup page is ready to be added to
*/
class SetupBuildingEvent extends Event {
var $panel;
/** @var \SetupPanel */
public $panel;
/**
* @param SetupPanel $panel
*/
public function __construct(SetupPanel $panel) {
$this->panel = $panel;
}
@@ -35,8 +39,12 @@ class SetupBuildingEvent extends Event {
*
*/
class SetupPanel {
var $blocks = array();
/** @var \SetupBlock[] */
public $blocks = array();
/**
* @param SetupBlock $block
*/
public function add_block(SetupBlock $block) {
$this->blocks[] = $block;
}
@@ -46,9 +54,14 @@ class SetupPanel {
*
*/
class SetupBlock extends Block {
var $header;
var $body;
/** @var string */
public $header;
/** @var string */
public $body;
/**
* @param string $title
*/
public function __construct($title) {
$this->header = $title;
$this->section = "main";
@@ -56,20 +69,31 @@ class SetupBlock extends Block {
$this->body = "";
}
/**
* @param string $text
*/
public function add_label($text) {
$this->body .= $text;
}
/**
* @param string $name
* @param null|string $label
*/
public function add_text_option($name, $label=null) {
global $config;
$val = html_escape($config->get_string($name));
if(!is_null($label)) {
$this->body .= "<label for='$name'>$label</label>";
$this->body .= "<label for='{$name}'>{$label}</label>";
}
$this->body .= "<input type='text' id='$name' name='_config_$name' value='$val'>\n";
$this->body .= "<input type='hidden' name='_type_$name' value='string'>\n";
$this->body .= "<input type='text' id='{$name}' name='_config_{$name}' value='{$val}'>\n";
$this->body .= "<input type='hidden' name='_type_{$name}' value='string'>\n";
}
/**
* @param string $name
* @param null|string $label
*/
public function add_longtext_option($name, $label=null) {
global $config;
$val = html_escape($config->get_string($name));
@@ -81,6 +105,10 @@ class SetupBlock extends Block {
$this->body .= "<input type='hidden' name='_type_$name' value='string'>\n";
}
/**
* @param string $name
* @param null|string $label
*/
public function add_bool_option($name, $label=null) {
global $config;
$checked = $config->get_bool($name) ? " checked" : "";
@@ -97,6 +125,10 @@ class SetupBlock extends Block {
// $this->body .= "<input type='hidden' id='$name' name='$name' value='$val'>";
// }
/**
* @param string $name
* @param null|string $label
*/
public function add_int_option($name, $label=null) {
global $config;
$val = html_escape($config->get_string($name));
@@ -107,6 +139,10 @@ class SetupBlock extends Block {
$this->body .= "<input type='hidden' name='_type_$name' value='int'>\n";
}
/**
* @param string $name
* @param null|string $label
*/
public function add_shorthand_int_option($name, $label=null) {
global $config;
$val = to_shorthand_int($config->get_string($name));