Renamed FormRenderer (Form) and FormElementWrapper (FormElement), upd…

…ated config and readme to deprecate old naming conventions to new
PowerKiKi · Oct 4, 2012 · 257c216 · 257c216
1 parent 327fc0d
commit 257c216
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -75,7 +75,7 @@ Form Usage
 
     <?php
     // render a whole form
-    echo $this->ztbFormRenderer($this->form);
+    echo $this->ztbForm($this->form);
     ?>
 
 
@@ -84,7 +84,7 @@ Form Usage
     $form = $this->form;
     $form->prepare();
     echo $this->form()->openTag($form);
-    echo $this->ztbFormElementWrapper($this->form->get('element'));
+    echo $this->ztbFormElement($this->form->get('element'));
     echo $this->form()->closeTag();
     ?>>
 

diff --git a/config/module.config.php b/config/module.config.php
@@ -16,13 +16,19 @@
     ),
     'view_helpers' => array(
         'invokables' => array(
-            'formelementwrapper' => 'ZfcTwitterBootstrap\Form\View\Helper\FormElementWrapper',
-            'ztbformelementwrapper' => 'ZfcTwitterBootstrap\Form\View\Helper\FormElementWrapper',
-            'formrenderer' => 'ZfcTwitterBootstrap\Form\View\Helper\FormRenderer',
-            'ztbformrenderer' => 'ZfcTwitterBootstrap\Form\View\Helper\FormRenderer',
+            // @deprecated
+            'formelementwrapper' => 'ZfcTwitterBootstrap\Form\View\Helper\FormElement',
+            // @deprecated
+            'ztbformelementwrapper' => 'ZfcTwitterBootstrap\Form\View\Helper\FormElement',
+            // @deprecated
+            'formrenderer' => 'ZfcTwitterBootstrap\Form\View\Helper\Form',
+            // @deprecated
+            'ztbformrenderer' => 'ZfcTwitterBootstrap\Form\View\Helper\Form',
             'formdescription' => 'ZfcTwitterBootstrap\Form\View\Helper\FormDescription',
             'ztbformdescription' => 'ZfcTwitterBootstrap\Form\View\Helper\FormDescription',
             'ztbalert' => 'ZfcTwitterBootstrap\View\Helper\Alert',
+            'ztbform' => 'ZfcTwitterBootstrap\Form\View\Helper\Form',
+            'ztbformelement' => 'ZfcTwitterBootstrap\Form\View\Helper\FormElement',
             'ztblabel' => 'ZfcTwitterBootstrap\View\Helper\Label',
             'ztbbadge' => 'ZfcTwitterBootstrap\View\Helper\Badge',
         ),

diff --git a/...otstrap/Form/View/Helper/FormRenderer.php → ...witterBootstrap/Form/View/Helper/Form.php b/...otstrap/Form/View/Helper/FormRenderer.php → ...witterBootstrap/Form/View/Helper/Form.php
@@ -11,7 +11,7 @@
 
 use Traversable;
 use Zend\Form\ElementInterface;
-use Zend\Form\Form;
+use Zend\Form\Form as ZendForm;
 use Zend\Form\Fieldset;
 use Zend\Form\View\Helper\Form as FormHelper;
 use Zend\View\Helper\AbstractHelper;
@@ -23,7 +23,7 @@
  * @package ZfcTwitterBootstrap\View
  * @subpackage Helper
  */
-class FormRenderer extends AbstractHelper
+class Form extends AbstractHelper
 {
     /**
      * @var Zend\View\Helper\Form
@@ -38,10 +38,10 @@ class FormRenderer extends AbstractHelper
     /**
      * Set Form Element Helper
      *
-     * @param ZfcTwitterBootstrap\View\Helper\FormElementWrapper $helper
-     * @return ZfcTwitterBootstrap\View\Helper\FormRenderer
+     * @param ZfcTwitterBootstrap\View\Helper\FormElement $helper
+     * @return ZfcTwitterBootstrap\View\Helper\Form
      */
-    public function setElementHelper(FormElementWrapper $helper)
+    public function setElementHelper(FormElement $helper)
     {
         $helper->setView($this->getView());
         $this->formElementHelper = $helper;
@@ -50,12 +50,12 @@ public function setElementHelper(FormElementWrapper $helper)
     /**
      * Get Form Element Helper
      *
-     * @return ZfcTwitterBootstrap\View\Helper\FormElementWrapper
+     * @return ZfcTwitterBootstrap\View\Helper\FormElement
      */
     public function getElementHelper()
     {
         if (!$this->formElementHelper) {
-            $this->setElementHelper(new FormElementWrapper());
+            $this->setElementHelper(new FormElement());
         }
         return $this->formElementHelper;
     }
@@ -64,7 +64,7 @@ public function getElementHelper()
      * Set Form Helper
      *
      * @param Zend\Form\View\Helper\Form $form
-     * @return FormRenderer
+     * @return Form
      */
     public function setFormHelper(FormHelper $form)
     {
@@ -92,7 +92,7 @@ public function getFormHelper()
      * @param Zend\Form\Form $form
      * @return void
      */
-    public function __invoke(Form $form)
+    public function __invoke(ZendForm $form)
     {
         $form->prepare();
         $html = $this->getFormHelper()->openTag($form);

diff --git a/...p/Form/View/Helper/FormElementWrapper.php → ...ootstrap/Form/View/Helper/FormElement.php b/...p/Form/View/Helper/FormElementWrapper.php → ...ootstrap/Form/View/Helper/FormElement.php
@@ -10,7 +10,7 @@
 namespace ZfcTwitterBootstrap\Form\View\Helper;
 
 use Zend\Form\ElementInterface;
-use Zend\Form\View\Helper\FormElement;
+use Zend\Form\View\Helper\FormElement as ZendFormElement;
 use Zend\Form\View\Helper\FormLabel;
 use Zend\Form\View\Helper\FormElementErrors;
 use Zend\View\Helper\EscapeHtml;
@@ -22,15 +22,15 @@
  * @package ZfcTwitterBootstrap\View
  * @subpackage Helper
  */
-class FormElementWrapper extends FormElement
+class FormElement extends ZendFormElement
 {
     /**
      * @var Zend\Form\View\Helper\FormLabel
      */
     protected $labelHelper;
 
     /**
-     * @var Zend\Form\View\Helper\FormElement
+     * @var Zend\Form\View\Helper\ZendFormElement
      */
     protected $elementHelper;
 
@@ -117,7 +117,7 @@ public function getEscapeHtmlHelper()
      * @param Zend\Form\View\Helper\FormElement $elementHelper
      * @return FormElement
      */
-    public function setElementHelper(FormElement $elementHelper)
+    public function setElementHelper(ZendFormElement $elementHelper)
     {
         $elementHelper->setView($this->getView());
         $this->elementHelper = $elementHelper;