From 57e2b670d6eebd04d7e9b0b7514834d968899aab Mon Sep 17 00:00:00 2001 From: Guy Sartorelli Date: Wed, 6 Nov 2024 15:02:58 +1300 Subject: [PATCH] API Remove custom logic in favour of Form::saveInto() --- src/Controllers/ElementalAreaController.php | 38 +++++---------------- src/Forms/EditFormFactory.php | 23 ++++++++++--- src/Models/BaseElement.php | 21 ------------ 3 files changed, 28 insertions(+), 54 deletions(-) diff --git a/src/Controllers/ElementalAreaController.php b/src/Controllers/ElementalAreaController.php index db7a7886..899a8ca5 100644 --- a/src/Controllers/ElementalAreaController.php +++ b/src/Controllers/ElementalAreaController.php @@ -298,8 +298,7 @@ public function getElementForm(): Form } /** - * Arrive here from FormRequestHandler::httpSubmission() during a POST request to - * /admin/linkfield/linkForm/ + * Arrive here from FormRequestHandler::httpSubmission() during a POST request. * The 'save' method is called because it is the FormAction set on the Form */ public function save(array $data, Form $form): HTTPResponse @@ -331,11 +330,15 @@ public function save(array $data, Form $form): HTTPResponse $this->jsonError(403); } - // Remove the namespace prefixes that were added by EditFormFactory - $dataWithoutNamespaces = static::removeNamespacesFromFields($data, $element->ID); + // Remove the namespace prefixes + $factory = Injector::inst()->get(EditFormFactory::class); + $factory->removeNamespaceFromFields($form->Fields(), ['Record' => $element]); + // Update the record + $form->saveInto($element); + // Add the namespace prefixes back - this is necessary for the response to be handled correctly + $factory->namespaceFields($form->Fields(), ['Record' => $element]); - // Update and write the data object which will trigger model validation - $element->updateFromFormData($dataWithoutNamespaces); + // Write the data object which will trigger model validation if ($element->isChanged()) { try { $element->write(); @@ -352,29 +355,6 @@ public function save(array $data, Form $form): HTTPResponse return $response; } - /** - * Remove the pseudo namespaces that were added to form fields by the form factory - * - * @param array $data - * @param int $elementID - * @return array - */ - public static function removeNamespacesFromFields(array $data, $elementID) - { - $output = []; - $template = sprintf(EditFormFactory::FIELD_NAMESPACE_TEMPLATE, $elementID, ''); - foreach ($data as $key => $value) { - // Only look at fields that match the namespace template - if (substr($key ?? '', 0, strlen($template ?? '')) !== $template) { - continue; - } - - $fieldName = substr($key ?? '', strlen($template ?? '')); - $output[$fieldName] = $value; - } - return $output; - } - private function reorderElements(BaseElement $element, int $afterElementID): void { if ($afterElementID < 0) { diff --git a/src/Forms/EditFormFactory.php b/src/Forms/EditFormFactory.php index 319595b0..8455d94b 100644 --- a/src/Forms/EditFormFactory.php +++ b/src/Forms/EditFormFactory.php @@ -86,11 +86,8 @@ protected function getFormValidator(RequestHandler $controller = null, $name, $c /** * Given a {@link FieldList}, give all fields a unique name so they can be used in the same context as * other elemental edit forms and the page (or other DataObject) that owns them. - * - * @param FieldList $fields - * @param array $context */ - protected function namespaceFields(FieldList $fields, array $context) + public function namespaceFields(FieldList $fields, array $context): void { $elementID = $context['Record']->ID; @@ -103,4 +100,22 @@ protected function namespaceFields(FieldList $fields, array $context) $field->setName($namespacedName); } } + + /** + * Remove the pseudo namespaces that were added in namespaceFields() + */ + public function removeNamespaceFromFields(FieldList $fields, array $context): void + { + $elementID = $context['Record']->ID; + $template = sprintf(EditFormFactory::FIELD_NAMESPACE_TEMPLATE, $elementID, ''); + + foreach ($fields->dataFields() as $namespacedName => $field) { + // Only look at fields that match the namespace template + if (substr($namespacedName, 0, strlen($template)) !== $template) { + continue; + } + $newName = substr($namespacedName, strlen($template)); + $field->setName($newName); + } + } } diff --git a/src/Models/BaseElement.php b/src/Models/BaseElement.php index b2e59996..dc1adccf 100644 --- a/src/Models/BaseElement.php +++ b/src/Models/BaseElement.php @@ -646,27 +646,6 @@ public function getRenderTemplates($suffix = '') return $templateFlat; } - /** - * Given form data (wit - * - * @param $data - */ - public function updateFromFormData($data) - { - $cmsFields = $this->getCMSFields(); - - foreach ($data as $field => $datum) { - $field = $cmsFields->dataFieldByName($field); - - if (!$field) { - continue; - } - - $field->setSubmittedValue($datum); - $field->saveInto($this); - } - } - /** * Strip all namespaces from class namespace. *