From dab28c5847ca637a248792ba555d94e6c9d84685 Mon Sep 17 00:00:00 2001
From: Matthias Schmidt <gravatronics@live.com>
Date: Sun, 24 Feb 2019 14:31:08 +0100
Subject: [PATCH] Add loadValuesFromObject support for form containers

See #2509
---
 .../form/builder/FormDocument.class.php       | 26 ++++++++++++-------
 .../builder/container/FormContainer.class.php | 10 +++++++
 .../container/IFormContainer.class.php        | 15 ++++++++++-
 3 files changed, 40 insertions(+), 11 deletions(-)

diff --git a/wcfsetup/install/files/lib/system/form/builder/FormDocument.class.php b/wcfsetup/install/files/lib/system/form/builder/FormDocument.class.php
index 7dc0ebf344..005e2e5983 100644
--- a/wcfsetup/install/files/lib/system/form/builder/FormDocument.class.php
+++ b/wcfsetup/install/files/lib/system/form/builder/FormDocument.class.php
@@ -1,6 +1,7 @@
 <?php
 namespace wcf\system\form\builder;
 use wcf\data\IStorableObject;
+use wcf\system\form\builder\container\IFormContainer;
 use wcf\system\form\builder\data\FormDataHandler;
 use wcf\system\form\builder\data\IFormDataHandler;
 use wcf\system\form\builder\field\data\processor\DefaultFormFieldDataProcessor;
@@ -277,19 +278,24 @@ class FormDocument implements IFormDocument {
 		
 		/** @var IFormNode $node */
 		foreach ($this->getIterator() as $node) {
-			if ($node instanceof IFormField && $node->isAvailable()) {
-				if ($node->getObjectProperty() !== $node->getId()) {
-					try {
-						$node->loadValueFromObject($object);
+			if ($node->isAvailable()) {
+				if ($node instanceof IFormField) {
+					if ($node->getObjectProperty() !== $node->getId()) {
+						try {
+							$node->loadValueFromObject($object);
+						}
+						catch (\InvalidArgumentException $e) {
+							// if an object property is explicitly set,
+							// ignore invalid values as this might not be
+							// the appropriate field
+						}
 					}
-					catch (\InvalidArgumentException $e) {
-						// if an object property is explicitly set,
-						// ignore invalid values as this might not be
-						// the appropriate field
+					else {
+						$node->loadValueFromObject($object);
 					}
 				}
-				else {
-					$node->loadValueFromObject($object);
+				else if ($node instanceof IFormContainer) {
+					$node->loadValuesFromObject($object);
 				}
 			}
 		}
diff --git a/wcfsetup/install/files/lib/system/form/builder/container/FormContainer.class.php b/wcfsetup/install/files/lib/system/form/builder/container/FormContainer.class.php
index 075c458bb8..ae9d6d2283 100644
--- a/wcfsetup/install/files/lib/system/form/builder/container/FormContainer.class.php
+++ b/wcfsetup/install/files/lib/system/form/builder/container/FormContainer.class.php
@@ -1,5 +1,6 @@
 <?php
 namespace wcf\system\form\builder\container;
+use wcf\data\IStorableObject;
 use wcf\system\form\builder\IFormChildNode;
 use wcf\system\form\builder\IFormDocument;
 use wcf\system\form\builder\TFormChildNode;
@@ -39,6 +40,15 @@ class FormContainer implements IFormContainer {
 		]), true);
 	}
 	
+	/**
+	 * @inheritDoc
+	 */
+	public function loadValuesFromObject(IStorableObject $object) {
+		// does nothing
+		
+		return $this;
+	}
+	
 	/**
 	 * @inheritDoc
 	 */
diff --git a/wcfsetup/install/files/lib/system/form/builder/container/IFormContainer.class.php b/wcfsetup/install/files/lib/system/form/builder/container/IFormContainer.class.php
index 72455c732d..5e80f09ddf 100644
--- a/wcfsetup/install/files/lib/system/form/builder/container/IFormContainer.class.php
+++ b/wcfsetup/install/files/lib/system/form/builder/container/IFormContainer.class.php
@@ -1,5 +1,6 @@
 <?php
 namespace wcf\system\form\builder\container;
+use wcf\data\IStorableObject;
 use wcf\system\form\builder\IFormChildNode;
 use wcf\system\form\builder\IFormElement;
 use wcf\system\form\builder\IFormParentNode;
@@ -13,4 +14,16 @@ use wcf\system\form\builder\IFormParentNode;
  * @package	WoltLabSuite\Core\System\Form\Builder\Container
  * @since	5.2
  */
-interface IFormContainer extends IFormChildNode, IFormElement, IFormParentNode {}
+interface IFormContainer extends IFormChildNode, IFormElement, IFormParentNode {
+	/**
+	 * This method is called by `IFormDocument::loadValuesFromObject()` to inform the container
+	 * that object data is loaded.
+	 * 
+	 * This method is *not* intended to generally call `IFormField::loadValueFromObject()` on
+	 * its form field children as these methods are already called by `IFormDocument::loadValuesFromObject()`.
+	 * 
+	 * @param	IStorableObject		$object		object used to load field values
+	 * @return	static					this container
+	 */
+	public function loadValuesFromObject(IStorableObject $object);
+}
-- 
2.20.1