Changeset 5936

Timestamp:

01/14/12 19:51:31 (4 months ago)

Author:

vain

Message:

• added chaining to setter + test

Location:

trunk

Files:

• core/viewhelper/form/form.php (modified) (1 diff)
• tests/unittests/core/viewhelper/form/form.core.php (modified) (5 diffs)

trunk/core/viewhelper/form/form.php

@@ -638 +638 @@
      * Shortcut to set the Legend text of the fieldset decorator.
      *
-     * The legend belongs to the fieldset decorator.
+     * The legend tag belongs to the fieldset decorator.
      * The fieldset decorator is a default decorator instantiated, when rendering the form.
      * It does not exist at the time of form definition.
-     * So we keep the legend value till the fieldset decorator is instantiated.
-     * Then the decorator attributes array is automatically set applied to the form and it's objects.
-     *
-     * Note: you can use the long form anytime, when defining your form.
-     *
-     * @param string String for the legend of the fieldset.
+     * So we keep the legend value stored, till the fieldset decorator is instantiated.
+     * Then the decorator attributes array is automatically assigned to the form and it's objects.
+     *
+     * Note: you can use the long form (array notation) anytime, when defining your form.
+     * Though using method chaining is a bit nicer (fluent interface).
+     *
+     * @param string String for the legend tag of the fieldset.
+     *
+     * @return object Clansuite_Form
      */
     public function setLegend($legend)
     {
         $this->setDecoratorAttributesArray(array('form' => array('fieldset' => array('legend' => $legend))));
+
+        return $this;
     }
 

trunk/tests/unittests/core/viewhelper/form/form.core.php

@@ -1 +1 @@
 <?php
+/**
+ * @todo method chaining tests on all setter methods
+ */
 class Clansuite_Form_Test extends Clansuite_UnitTestCase
 {
@@ -7 +10 @@
     protected $form;
 
-    public function markTestIncomplete($msg)
-    {
-        $this->assertTrue(false, $msg);
-    }
-
     /**
      * Sets up the fixture, for example, opens a network connection.
@@ -70 +68 @@
         # set external url
         $this->form->setAction('index.php?mod=news&action=show');
-        $this->assertEqual( WWW_ROOT . 'index.php?mod=index.php%3Fmod%3Dnews%26action%3Dshow', $this->form->getAction());
+        $this->assertEqual( WWW_ROOT . 'index.php?mod%3Dnews%26action%3Dshow', $this->form->getAction());
     }
 
@@ -78 +76 @@
 
         # via getter - qualified url
-        $this->assertEqual( WWW_ROOT . 'index.php?mod=index.php%3Fmod%3Dnews%26action%3Dshow', $this->form->getAction());
+        $this->assertEqual( WWW_ROOT . 'index.php?mod%3Dnews%26action%3Dshow', $this->form->getAction());
     }
 
@@ -294 +292 @@
         # via getter - returns string
         $this->assertEqual('legend-set', $this->form->getLegend());
+
+        # allows method chaining
+        $this->assertEqual($this->form, $this->form->setLegend('returns form object'));
+    }
+
+    public function testSetLegend_allowsMethodChaining()
+    {
+        $return_value = $this->form->setLegend('returns form object');
+
+        $this->assertIdentical($this->form, $return_value);
     }