From 356840c8deb340bd166c5b893255bde00f8e8d4d Mon Sep 17 00:00:00 2001
From: Matthias Schmidt <gravatronics@live.com>
Date: Sun, 31 Dec 2017 14:03:41 +0100
Subject: [PATCH] Add boolean form field

See #2509
---
 .../acp/templates/__booleanFormField.tpl      | 19 +++++++
 .../builder/field/BooleanFormField.class.php  | 57 +++++++++++++++++++
 wcfsetup/install/lang/de.xml                  |  2 +
 wcfsetup/install/lang/en.xml                  |  2 +
 4 files changed, 80 insertions(+)
 create mode 100644 wcfsetup/install/files/acp/templates/__booleanFormField.tpl
 create mode 100644 wcfsetup/install/files/lib/system/form/builder/field/BooleanFormField.class.php

diff --git a/wcfsetup/install/files/acp/templates/__booleanFormField.tpl b/wcfsetup/install/files/acp/templates/__booleanFormField.tpl
new file mode 100644
index 0000000000..cda9ee47a8
--- /dev/null
+++ b/wcfsetup/install/files/acp/templates/__booleanFormField.tpl
@@ -0,0 +1,19 @@
+<dl{if !$field->getClasses()|empty} class="{implode from=$field->getClasses() item='class'}{$class}{/implode}"{/if}{foreach from=$field->getAttributes() key='attributeName' item='attributeValue'} {$attributeName}="{$attributeValue}"{/foreach}>
+	<dt><label for="{@$field->getPrefixedId()}">{@$field->getLabel()}</label></dt>
+	<dd>
+		<ol class="flexibleButtonGroup">
+			<li>
+				<input type="radio" id="{@$field->getPrefixedId()}" name="{@$field->getPrefixedId()}" value="1"{if $field->isAutofocused()} autofocus{/if}{if $field->isRequired()} required{/if}{if $field->isImmutable()} disabled{/if}{if $field->getValue()} checked{/if}>
+				<label for="{@$field->getPrefixedId()}" class="green"><span class="icon icon16 fa-check"></span> {lang}wcf.global.form.boolean.yes{/lang}</label>
+			</li>
+			<li>
+				<input type="radio" id="{@$field->getPrefixedId()}_no" name="{@$field->getPrefixedId()}" value="0" name="{@$field->getPrefixedId()}"{if $field->isImmutable()} disabled{/if}{if !$field->getValue()} checked{/if}>
+				<label for="{@$field->getPrefixedId()}_no" class="red"><span class="icon icon16 fa-times"></span> {lang}wcf.global.form.boolean.no{/lang}</label>
+			</li>
+		</ol>
+		
+		{include file='__formFieldDescription'}
+		
+		{include file='__formFieldErrors'}
+	</dd>
+</dl>
diff --git a/wcfsetup/install/files/lib/system/form/builder/field/BooleanFormField.class.php b/wcfsetup/install/files/lib/system/form/builder/field/BooleanFormField.class.php
new file mode 100644
index 0000000000..b5e401b40f
--- /dev/null
+++ b/wcfsetup/install/files/lib/system/form/builder/field/BooleanFormField.class.php
@@ -0,0 +1,57 @@
+<?php
+namespace wcf\system\form\builder\field;
+use wcf\system\form\builder\field\validation\FormFieldValidationError;
+
+/**
+ * Implementation of a form field for boolean values.
+ * 
+ * @author	Matthias Schmidt
+ * @copyright	2001-2018 WoltLab GmbH
+ * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package	WoltLabSuite\Core\System\Form\Builder\Field
+ * @since	3.2
+ */
+class BooleanFormField extends AbstractFormField {
+	/**
+	 * @inheritDoc
+	 */
+	protected $templateName = '__booleanFormField';
+	
+	/**
+	 * @inheritDoc
+	 */
+	public function getSaveValue() {
+		return $this->__value ? 1 : 0;
+	}
+	
+	/**
+	 * @inheritDoc
+	 */
+	public function readValue() {
+		if (isset($_POST[$this->getPrefixedId()])) {
+			$this->__value = true;
+		}
+	}
+	
+	/**
+	 * @inheritDoc
+	 */
+	public function validate() {
+		if ($this->isRequired() && !$this->getValue()) {
+			$this->addValidationError(new FormFieldValidationError('empty'));
+		}
+		
+		parent::validate();
+	}
+	
+	/**
+	 * @inheritDoc
+	 */
+	public function value($value) {
+		if (!is_bool($value)) {
+			throw new \InvalidArgumentException("Given value is no bool, " . gettype($value) . " given.");
+		}
+		
+		return parent::value($value);
+	}
+}
diff --git a/wcfsetup/install/lang/de.xml b/wcfsetup/install/lang/de.xml
index adbb82ee33..8dcb2607f2 100644
--- a/wcfsetup/install/lang/de.xml
+++ b/wcfsetup/install/lang/de.xml
@@ -2985,6 +2985,8 @@ Fehler sind beispielsweise:
 	</category>
 	
 	<category name="wcf.global.form">
+		<item name="wcf.global.form.boolean.no"><![CDATA[Nein]]></item>
+		<item name="wcf.global.form.boolean.yes"><![CDATA[Ja]]></item>
 		<item name="wcf.global.form.data"><![CDATA[Allgemeine Daten]]></item>
 		<item name="wcf.global.form.error"><![CDATA[{if LANGUAGE_USE_INFORMAL_VARIANT}Deine{else}Ihre{/if} Angaben sind ungültig. Bitte {if LANGUAGE_USE_INFORMAL_VARIANT}überprüfe{else}überprüfen Sie{/if} die markierten Eingabefelder.]]></item>
 		<item name="wcf.global.form.error.empty"><![CDATA[Bitte {if LANGUAGE_USE_INFORMAL_VARIANT}fülle{else}füllen Sie{/if} dieses Eingabefeld aus.]]></item>
diff --git a/wcfsetup/install/lang/en.xml b/wcfsetup/install/lang/en.xml
index e4a11a6f3a..8a3f12f09b 100644
--- a/wcfsetup/install/lang/en.xml
+++ b/wcfsetup/install/lang/en.xml
@@ -2932,6 +2932,8 @@ Errors are:
 	</category>
 	
 	<category name="wcf.global.form">
+		<item name="wcf.global.form.boolean.no"><![CDATA[No]]></item>
+		<item name="wcf.global.form.boolean.yes"><![CDATA[Yes]]></item>
 		<item name="wcf.global.form.data"><![CDATA[General Information]]></item>
 		<item name="wcf.global.form.error"><![CDATA[Please correct the erroneous fields marked below.]]></item>
 		<item name="wcf.global.form.error.empty"><![CDATA[Please fill in this field.]]></item>
-- 
2.20.1