wip

Classes/Service/ViewHelper/Field/FieldContextEntry.php

@@ -14,9 +14,8 @@
 namespace Romm\Formz\Service\ViewHelper\Field;
 
 use Romm\Formz\Configuration\Form\Field\Field;
-use TYPO3\CMS\Core\SingletonInterface;
 
-class FieldContextEntry implements SingletonInterface
+class FieldContextEntry
 {
     /**
      * @var Field
@@ -37,10 +36,6 @@ public function __construct(Field $field)
     }
 
     /**
-     * Returns the current field which was defined by the `FieldViewHelper`.
-     *
-     * Returns null if no current field was found.
-     *
      * @return Field|null
      */
     public function getField()

Classes/Service/ViewHelper/Field/FieldViewHelperService.php

@@ -27,6 +27,10 @@
 class FieldViewHelperService implements SingletonInterface
 {
     /**
+     * Contains all current fields being rendered by FormZ: if a field is
+     * rendered beneath another field, several entries will be added to this
+     * property.
+     *
      * @var FieldContextEntry[]
      */
     protected $contextEntries;
@@ -37,7 +41,9 @@ class FieldViewHelperService implements SingletonInterface
     protected $view;
 
     /**
-     * @todo rename ?
+     * Adds a new context entry to the entries array. The other field-related
+     * methods will be processed on this entry until the field rendering has
+     * ended.
      *
      * @param Field $field
      */
@@ -47,8 +53,15 @@ public function setCurrentField(Field $field)
     }
 
     /**
-     * Checks that the `FieldViewHelper` has been called. If not, an exception
-     * is thrown.
+     * Removes the current field context entry.
+     */
+    public function removeCurrentField()
+    {
+        array_pop($this->contextEntries);
+    }
+
+    /**
+     * Checks that a field context is found.
      *
      * @return bool
      */
@@ -58,11 +71,7 @@ public function fieldContextExists()
     }
 
     /**
-     * Returns the current field which was defined by the `FieldViewHelper`.
-     *
-     * Returns null if no current field was found.
-     *
-     * @return Field|null
+     * @return Field
      */
     public function getCurrentField()
     {
@@ -109,14 +118,6 @@ public function getView(Layout $layout)
         return $this->view[$identifier];
     }
 
-    /**
-     * Reset every state that can be used by this service.
-     */
-    public function resetState()
-    {
-        array_pop($this->contextEntries);
-    }
-
     /**
      * @return FieldContextEntry
      */

Classes/Service/ViewHelper/Slot/SlotViewHelperService.php

@@ -27,15 +27,21 @@ class SlotViewHelperService implements SingletonInterface
     protected $contextEntries = [];
 
     /**
-     * @todo
-     *
      * @param RenderingContextInterface $renderingContext
      */
-    public function initialize(RenderingContextInterface $renderingContext)
+    public function activate(RenderingContextInterface $renderingContext)
     {
         $this->contextEntries[] = GeneralUtility::makeInstance(SlotContextEntry::class, $renderingContext);
     }
 
+    /**
+     * Removes the current context entry.
+     */
+    public function resetState()
+    {
+        array_pop($this->contextEntries);
+    }
+
     /**
      * @see \Romm\Formz\Service\ViewHelper\Slot\SlotContextEntry::addSlot()
      *
@@ -104,14 +110,6 @@ public function restoreTemplateVariables($slotName)
         $this->getCurrentContext()->restoreTemplateVariables($slotName);
     }
 
-    /**
-     * Removes the current context entry.
-     */
-    public function resetState()
-    {
-        array_pop($this->contextEntries);
-    }
-
     /**
      * @return SlotContextEntry
      */

Classes/ViewHelpers/FieldViewHelper.php

@@ -105,9 +105,10 @@ public function render()
         $this->injectFieldInService($this->arguments['name']);
 
         /*
-         * @todo
+         * Activating the slot service, which will be used all along the
+         * rendering of this very field.
          */
-        $this->slotService->initialize($this->renderingContext);
+        $this->slotService->activate($this->renderingContext);
 
         /*
          * Calling this here will process every view helper beneath this one,
@@ -136,7 +137,7 @@ public function render()
         /*
          * Resetting all services data.
          */
-        $this->fieldService->resetState();
+        $this->fieldService->removeCurrentField();
         $this->slotService->resetState();
 
         $viewHelperVariableContainer->setView($currentView);

Classes/ViewHelpers/FormatMessageViewHelper.php

@@ -148,8 +148,7 @@ protected function getFieldName()
         if (empty($fieldName)
             && $this->fieldService->fieldContextExists()
         ) {
-            $field = $this->fieldService->getCurrentField();
-            $fieldName = $field->getName();
+            $fieldName = $this->fieldService->getCurrentField()->getName();
         }
 
         if (null === $fieldName) {

Tests/Unit/Service/ViewHelper/Field/FieldContentEntryTest.php

@@ -0,0 +1,52 @@
+<?php
+namespace Romm\Formz\Tests\Unit\Service\ViewHelper\Field;
+
+use Romm\Formz\Configuration\Form\Field\Field;
+use Romm\Formz\Service\ViewHelper\Field\FieldContextEntry;
+use Romm\Formz\Tests\Unit\AbstractUnitTest;
+
+class FieldContentEntryTest extends AbstractUnitTest
+{
+    /**
+     * @test
+     */
+    public function initializationDoneProperly()
+    {
+        $field = new Field;
+
+        $fieldContextEntry = new FieldContextEntry($field);
+        $this->assertSame($field, $fieldContextEntry->getField());
+    }
+
+    /**
+     * @test
+     */
+    public function setFieldOptionSetsFieldOption()
+    {
+        $fieldContextEntry = new FieldContextEntry(new Field);
+
+        $fieldContextEntry->setOption('foo', 'bar');
+        $this->assertEquals(
+            ['foo' => 'bar'],
+            $fieldContextEntry->getOptions()
+        );
+
+        $fieldContextEntry->setOption('bar', 'baz');
+        $this->assertEquals(
+            [
+                'foo' => 'bar',
+                'bar' => 'baz'
+            ],
+            $fieldContextEntry->getOptions()
+        );
+
+        $fieldContextEntry->setOption('foo', 'baz');
+        $this->assertEquals(
+            [
+                'foo' => 'baz',
+                'bar' => 'baz'
+            ],
+            $fieldContextEntry->getOptions()
+        );
+    }
+}

Tests/Unit/Service/ViewHelper/Field/FieldViewHelperServiceTest.php

@@ -11,7 +11,7 @@ class FieldViewHelperServiceTest extends AbstractUnitTest
     /**
      * @test
      */
-    public function formContextActivatedTwiceThrowsException()
+    public function setCurrentFieldSetsCurrentField()
     {
         $fieldService = new FieldViewHelperService;
         $field = new Field;
@@ -25,51 +25,35 @@ public function formContextActivatedTwiceThrowsException()
     /**
      * @test
      */
-    public function setFieldOptionSetsFieldOption()
+    public function resetStateResetsState()
     {
         $fieldService = new FieldViewHelperService;
+        $field = new Field;
+
+        $this->assertFalse($fieldService->fieldContextExists());
+        $fieldService->setCurrentField($field);
+        $this->assertTrue($fieldService->fieldContextExists());
 
-        $fieldService->setFieldOption('foo', 'bar');
-        $this->assertEquals(
-            ['foo' => 'bar'],
-            $fieldService->getFieldOptions()
-        );
-
-        $fieldService->setFieldOption('bar', 'baz');
-        $this->assertEquals(
-            [
-                'foo' => 'bar',
-                'bar' => 'baz'
-            ],
-            $fieldService->getFieldOptions()
-        );
-
-        $fieldService->setFieldOption('foo', 'baz');
-        $this->assertEquals(
-            [
-                'foo' => 'baz',
-                'bar' => 'baz'
-            ],
-            $fieldService->getFieldOptions()
-        );
+        $fieldService->removeCurrentField();
+
+        $this->assertFalse($fieldService->fieldContextExists());
     }
 
     /**
      * @test
      */
-    public function resetStateResetsState()
+    public function nestingFieldsWorks()
     {
         $fieldService = new FieldViewHelperService;
-        $field = new Field;
-
-        $fieldService->setCurrentField($field);
-        $fieldService->setFieldOption('foo', 'bar');
-
-        $fieldService->resetState();
-
-        $this->assertFalse($fieldService->fieldContextExists());
-        $this->assertNull($fieldService->getCurrentField());
-        $this->assertEmpty($fieldService->getFieldOptions());
+        $field1 = new Field;
+        $field2 = new Field;
+
+        $fieldService->setCurrentField($field1);
+        $this->assertSame($field1, $fieldService->getCurrentField());
+        $fieldService->setCurrentField($field2);
+        $this->assertSame($field2, $fieldService->getCurrentField());
+        $fieldService->removeCurrentField();
+        $this->assertSame($field1, $fieldService->getCurrentField());
     }
 
     /**