Working with complex decorators in the Zend Framework

Introduction

Zend Framework is a great system. This opinion has developed over a long time of close “communication” with this system. And it is wonderful not because of any super-capabilities provided to the programmer, but because this system surprisingly invites the programmer to his own improvement for him, the programmer, good, offering a simple and at the same time powerful foundation for his own developments.

Working on a project using the Zend Framework, I decided to try to make the most of its capabilities and immediately noticed the Zend_Form component (I deliberately call Zend_Form a component, not a class, because the Zend_Form component consists of the Zend_Form class and a whole set of related classes and interfaces). The documentation says quite simply: “Zend_Form makes it easy to create forms and manage them in your web applications.” In general, this is true, but without preliminary preparation, seven pots will come down from you before you can create and display one more or less complex form. Conceptually, a form in the Zend Framework consists of:

• items
• decorators
• of filters
• validators

Elements are, in fact, what we mean by form elements: input fields, drop-down lists, etc.

The decorator is the entire layout, which is logically connected with the form element (surrounds it), but is not part of it. Simply put, the decorator - the design element of the form.



In this article I will prove the need for a group decorator and publish its code. If you are too lazy to read the fruit of the author’s frauds, you can go directly to the code.

So what's the problem?

Work with decorators so far, in my opinion, the most difficult and painstaking part of the work on the introduction of forms. In the examples given in the documentation, everything is just fine, except for one thing - all these are very simple, I would even say, primitive examples.

But as soon as you need to display something like this



how problems immediately begin. The main problem is that the decorator's repository in the Zend_Form component has a single-level structure, that is, you cannot create nested decorators, you cannot create a decorator for the decorator, etc.

For example, the above form fragment is encoded with the following code:



As we can see, there are two independent branches in the element tree: a table cell, framing the form element itself (input), and a cell framing the label (label). The trouble is that the label is not a form element (it is also a decorator). So, to create such a structure you need to get out with the help of dirty hacks:

$ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .

1. $ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .
2. $ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .
3. $ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .
4. $ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .
5. $ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .
6. $ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .
7. $ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .
8. $ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .
9. $ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .
10. $ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .
12. $ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .
13. $ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .
14. $ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .

$ this ->setElementDecorators(array( 'ViewHelper' , array( 'decorator' => array( 'br' => 'HtmlTag' ), 'options' => array( 'tag' => 'span' , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'tdOpen' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::PREPEND)), array( 'decorator' => array( 'tdClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'closeOnly' => true , 'placement' => Zend_Form_Decorator_Abstract::APPEND)), array( 'decorator' => array( 'label' => 'Label' ), 'options' => array( 'separator' => '*' )), 'Errors' , array( 'decorator' => array( 'mainCell' => 'HtmlTag' ), 'options' => array( 'tag' => 'td' , 'class' => 'tregleft' )), array( 'decorator' => array( 'mainRowClose' => 'HtmlTag' ), 'options' => array( 'tag' => 'tr' )) )); $usernameFieldLabel = $ this ->user_name->getDecorator( 'label' ); $defaultSeparator = $usernameFieldLabel->getOption( 'separator' ); $usernameFieldLabel->setOption( 'separator' , $defaultSeparator. '

"_".' ); * This source code was highlighted with Source Code Highlighter .

Of the disadvantages:

• manual substitution of closing and opening tags td
• improper use of separator

And simply, not every code, even using hacks, will be able to be displayed like this with the help of decorators. Everything would be much simpler if there was a decorator to which other decorators could be added.

Solution to the problem

Googling, I did not find anything normal and decided to write my own group decorator.

Here is what happened:

1. <? php
2. require_once 'Zend / Form / Decorator / Abstract.php' ;
4. class Zend_Form_Decorator_GroupDecorator extends Zend_Form_Decorator_Abstract {
5. / **
6. * Items (decorators) to group
7. * @var array
8. * /
9. protected $ _items = null ;
11. / **
12. * Temporary form to perform decorators operations
13. * @var Zend_Form_Element
14. * /
15. private $ _temporaryDecoratorsContainer = null ;
17. / **
18. * Constructor
19. *
20. * @param array | Zend_Config $ options
21. * @return void
22. * /
23. public function __construct ($ options = null ) {
24. parent :: __ construct ($ options);
25. $ this -> _ temporaryDecoratorsContainer = new Zend_Form_Element ( '_temporaryDecoratorsContainer' , array ( 'DisableLoadDefaultDecorators' => true ));
26. $ this -> getItems ();
27. }
29. / **
30. * Set items to use
31. *
32. * @param array $ items
33. * @return Zend_Form_Decorator_GroupDecorator
34. * /
35. public function setItems ($ items) {
36. $ this -> _ items = $ this -> _ temporaryDecoratorsContainer-> clearDecorators () -> addDecorators ($ items) -> getDecorators ();
37. return $ this ;
38. }
40. / **
41. * Get tag
42. *
43. * If no items are registered, either through setItems () or as an option, uses empty array.
44. *
45. * @return array
46. * /
47. public function getItems () {
48. if ( null === $ this -> _ items) {
49. if ( null === ($ items = $ this -> getOption ( 'items' ))) {
50. $ this -> setItems (array ());
51. } else {
52. $ this -> setItems ($ items);
53. $ this -> removeOption ( 'items' );
54. }
55. }
56. return $ this -> _ items;
57. }
59. public function addDecorator ($ decorator, $ options = null ) {
60. $ this -> _ temporaryDecoratorsContainer-> addDecorator ($ decorator, $ options);
61. return $ this ;
62. }
64. public function clearDecorators () {
65. $ this -> _ temporaryDecoratorsContainer-> clearDecorators ();
66. $ this -> _ items = array ();
67. }
69. public function getDecorator ($ index = null ) {
70. if ( null === $ index) {
71. return $ this -> _ items;
72. }
73. if (is_numeric ($ index)) {
74. $ _items = array_values ​​($ this -> _ items);
75. return ($ index <count ($ _ items))? $ _ items [$ index]: null ;
76. }
77. if (is_string ($ index)) {
78. return (array_key_exists ($ index, $ this -> _ items))? $ this -> _ items [$ index]: null ;
79. }
80. return null ;
81. }
83. public function insertDecoratorBefore ($ index, $ decorator, $ options = null ) {
84. $ _decoratorsToAdd = $ this -> _ temporaryDecoratorsContainer-> clearDecorators () -> addDecorator ($ decorator, $ options) -> getDecorators ();
85. if (is_string ($ index)) {
86. $ index = array_search ($ index, array_keys ($ this -> _ items));
87. }
88. if ( false ! == $ index) {
89. $ first = ($ index> 0)? array_slice ($ this -> _ items, 0, $ index, true ): array ();
90. $ last = ($ index <count ($ this -> _ items))? array_slice ($ this -> _ items, $ index, null , true ): array ();
91. $ this -> _ items = array_merge ($ first, (array) $ _ decoratorsToAdd, $ last);
92. }
93. return $ this ;
94. }
96. / **
97. * Render content wrapped in a group of decorators
98. *
99. * @param string $ content
100. * @return string
101. * /
102. public function render ($ content) {
103. $ placement = $ this -> getPlacement ();
104. $ items = $ this -> getItems ();
105. $ _content = '' ;
106. foreach ($ items as $ _decorator) {
107. if ($ _decorator instanceOf Zend_Form_Decorator_Interface) {
108. $ _decorator-> setElement ($ this -> getElement ());
109. $ _content = $ _decorator-> render ($ _ content);
110. }
111. else {
112. require_once 'Zend / Form / Decorator / Exception.php' ;
113. throw new Zend_Form_Decorator_Exception ( 'Invalid decorator' . $ _decorator. 'provided; must be string or Zend_Form_Decorator_Interface' );
114. }
115. }
116. switch ($ placement) {
117. case self :: APPEND:
118. return $ content. $ _content;
119. break ;
120. case self :: PREPEND:
121. return $ _content. $ content;
122. break ;
123. default :
124. return $ _content. $ content. $ _ content;
125. break ;
126. }
127. }
128. }
129. ?>

* This source code was highlighted with Source Code Highlighter .

This decorator can:

• Create and display decorators of arbitrary nesting, and therefore of any complexity
• Perform operations with decorators (add, delete, insert) on the fly, thereby allowing you to edit group default decorators

Now the above example of creating a form element will look like this:

1. <? php
2. class Form_MemberRegister extends Zend_Form {
3. public function init () {
4. $ this -> setDisableLoadDefaultDecorators ( true );
6. $ this -> addDecorator ( 'FormElements' )
7. -> addDecorator (array ( 'table' => 'HtmlTag' ), array ( 'tag' => 'table' , 'class' => 'treg' ))
8. -> addDecorator ( 'Form' );
10. $ this -> addElement ( 'text' , 'user_name' , array ( 'label' => 'Login:' ));
11. $ this -> addElement ( 'password' , 'password' , array ( 'label' => 'Password:' ));
12. $ this -> addElement ( 'password' , 'password2' , array ( 'label' => 'Repeat password:' ));
13. $ this -> addElement ( 'text' , 'email' , array ( 'label' => 'E-mail:' ));
15. $ this -> setElementDecorators (array (
16. array ( 'decorator' => array ( 'labelGroup' => 'GroupDecorator' ), 'options' => array ( 'items' => array (
17. array ( 'decorator' => 'Text' , 'options' => array ( 'text' => '*' )),
18. array ( 'decorator' => array ( 'span' => 'HtmlTag' ), 'options' => array ( 'tag' => 'span' , 'class' => 'red' ))
19. array ( 'decorator' => 'Label' , 'options' => array ( 'placement' => Zend_Form_Decorator_Abstract :: PREPEND)),
20. array ( 'decorator' => array ( 'labelCell' => 'HtmlTag' ), 'options' => array ( 'tag' => 'td' , 'class' => 'tregleft' ))
21. ))),
22. array ( 'decorator' => array ( 'elementGroup' => 'GroupDecorator' ), 'options' => array ( 'items' => array (
23. 'ViewHelper' ,
24. array ( 'decorator' => array ( 'elementCell' => 'HtmlTag' ), 'options' => array ( 'tag' => 'td' ))
25. )), 'placement' => Zend_Form_Decorator_Abstract :: APPEND),
26. array ( 'decorator' => array ( 'mainRowClose' => 'HtmlTag' ), 'options' => array ( 'tag' => 'tr' ))
27. ))
29. / **
30. * @var Zend_Form_Decorator_GroupDecorator
31. * /
32. $ usernameFieldLabel = $ this -> user_name-> getDecorator ( 'labelGroup' );
33. $ usernameFieldLabel-> insertDecoratorBefore ( 'labelCell' , array ( 'usernameNotes' => $ this -> _ getNotesDecorator ($ this -> user_name, 'Login can consist only of Latin letters and the sign "_".' ))));
35. / **
36. * @var Zend_Form_Decorator_GroupDecorator
37. * /
38. $ emailFieldDecorator = $ this -> email-> getDecorator ( 'elementGroup' );
39. $ emailFieldDecorator-> insertDecoratorBefore ( 'elementCell' , array ( 'emailNotes' => $ this -> _ getNotesDecorator ($ this -> email, ' Enter only existing and working e-mail. At this address you will be sent a link to confirm registration. ' )));
40. }
42. protected function _getNotesDecorator ($ element, $ notesText = '' ) {
43. $ _d = new Zend_Form_Decorator_GroupDecorator (array ( 'items' => array (
44. array ( 'decorator' => array ( 'notesText' => 'Text' ), 'options' => array ( 'text' => $ notesText)),
45. array ( 'decorator' => array ( 'notesTag' => 'HtmlTag' ), 'options' => array ( 'tag' => 'small' )),
46. array (
47. 'decorator' => array ( 'br' => 'HtmlTag' ),
48. 'options' => array ( 'tag' => 'br' , 'openOnly' => true , 'placement' => Zend_Form_Decorator_Abstract :: PREPEND)
49. )
50. )));
51. return $ _d-> setElement ($ element);
52. }
53. }
54. ?>

* This source code was highlighted with Source Code Highlighter .

I apologize in advance if the post was too long.

If there is another, more elegant solution to the problem, let me know - I will sprinkle ashes on my head :)

PS: For opponents of tabular typesetting, I want to note that this is a post about programming, I am not a typesetter - I just needed to display the specified template.