Creando un personalizado marcado de formulario usando Zend_Form_Decorator Representando un objeto form es completamente opcional -- usted no necesita usar los métodos Zend_Form render() en absoluto. Sin embargo, si lo hace, los decoradores son usados para representar varios objetos form. Un arbitrario número de decoradores pueden estar junto a cada elemento (elements, display groups, sub forms o el objeto form por si mismo); Sin embargo, solo un decorador de un tipo dado puede estar al lado de cada elemento. Los decoradores son llamados en el orden en que han sido introducidos. Dependiendo del decorador, se puede reemplazar el contenido que se ha pasado o adjunto o pre enviado. El estado del objeto es determinado via las opciones de configuración pasadas al constructor o el método decorador setOptions(). Cuando se crean decoradores mediante funciones addDecorator() o métodos relacionados, las opciones pueden ser pasadas como argumentos al método. Esto puese ser usado para una especifica ubicación, un separador se usa entre el contenido pasado y el nuevo contenido generado y cualquier opción que el decorador soporte. Antes que cada método decorador render() es llamado, el actual item es determinado en el decorador usando setElement(), dando al decorador conocimiento del item representado. Esto permite crear decoradores que solo representan especificas porciones del item -- tal como etiquetas, el valor, mensajes de error, etc. Encadenando muchos decoradores que representan especificos segmentos, usted puede construir complejos marcados representando al item entero. Operación Para configurar un decorador, pasar una matriz de opciones o un objeto Zend_Config a este constructor, a una matriz setOptions(), o a un objeto Zend_Config setConfig(). Opciones standarizadas incluyen: placement: La ubicación puede ser cualquiera de los dos 'append' o 'prepend' (caso insensitivo) e indica cualquier contenido pasado a render() será adjuntado o antepuesto respectivamente. En el caso de que el decorador reemplace el contenido, esta configuración es ignorada. La configuración por defecto es adjuntada. separator: El separator es usado entre el contenido pasado a render() y el nuevo contenido generado por el decorador, o entre items generados por el decorador (ejemplo FormElements usa el separador entre cada item generado). En el caso que un decorador reemplace el contenido, esta configuración puede ser ignorada. El valor por defecto es PHP_EOL. La interface del decorador especifica los métodos para interactuar con las opciones. Esto incluye: setOption($key, $value): determina una sola opción. getOption($key): recuperar un solo valor de opción. getOptions(): recuperar todas las opciones. removeOption($key): remover o eliminar una sola opción. clearOptions(): remover o eliminar todas las opciones. Decoradores son diseñados para interactuar con varios tipos de clases Zend_Form: Zend_Form, Zend_Form_Element, Zend_Form_DisplayGroup, y todas las clases derivan de ellas. El método setElement() permite determinar el objeto del decorador que esta actualmente trabajando con, y getElement() es usado para recuperarlo. Cada método decorador render() acepta una cadena $content. Cuando el primer decorador es llamado, esta cadena esta tipicamente vacía, mientras las subsecuentes llamadas serán puestas. Basados en el tipo de decorador y en las opciones pasadas, el decorador ya sea reemplazará la cadena, antenpodrá la cadena o adjuntará la cadena; una separador opcional será usado en las dos últimas situaciones. Decoradores estándar Zend_Form entrega muchos decoradores estándar; ver el capítulo Decoradores estándar para detalles. Decoradores personalizados Si usted encuentra que sus necesidades son complejas o necesita una enorme personalización, usted debería considerar crear un personalizado decorador. Decoradores necesitan solo implementar Zend_Decorator_Interface. La interface especifica lo siguiente: Para hacerlo mas simple, usted puede simplemente extender Zend_Decorator_Abstract, el cual implementa todos los métodos excepto render(). Como ejemplo, vamos a decir quue usted quiere reducir el número de decoradores que utiliza, y construir un "compuesto" decorador que cuidó la etiqueta generadora, elemento, algún mensaje de error, y describir en HTML div. Usted puede construir como un 'Compuesto' decorador como sigue: getElement(); $label = $element->getLabel(); if ($translator = $element->getTranslator()) { $label = $translator->translate($label); } if ($element->isRequired()) { $label .= '*'; } $label .= ':'; return $element->getView() ->formLabel($element->getName(), $label); } public function buildInput() { $element = $this->getElement(); $helper = $element->helper; return $element->getView()->$helper( $element->getName(), $element->getValue(), $element->getAttribs(), $element->options ); } public function buildErrors() { $element = $this->getElement(); $messages = $element->getMessages(); if (empty($messages)) { return ''; } return '
' . $element->getView()->formErrors($messages) . '
'; } public function buildDescription() { $element = $this->getElement(); $desc = $element->getDescription(); if (empty($desc)) { return ''; } return '
' . $desc . '
'; } public function render($content) { $element = $this->getElement(); if (!$element instanceof Zend_Form_Element) { return $content; } if (null === $element->getView()) { return $content; } $separator = $this->getSeparator(); $placement = $this->getPlacement(); $label = $this->buildLabel(); $input = $this->buildInput(); $errors = $this->buildErrors(); $desc = $this->buildDescription(); $output = '
' . $label . $input . $errors . $desc . '
' switch ($placement) { case (self::PREPEND): return $output . $separator . $content; case (self::APPEND): default: return $content . $separator . $output; } } } ]]> Usted puede entonces ubicarlo en el directorio decorador: addPrefixPath('My_Decorator', 'My/Decorator/', 'decorator'); // para todos los elementos: $form->addElementPrefixPath('My_Decorator', 'My/Decorator/', 'decorator'); ]]> Usted puede especificar este decorador como 'Compuesto' y adjuntarlo a un elemento: setDecorators(array('Composite')); ]]> Mientras este ejemplo mostró cómo crear un decorador que genera salidas complejas de muchas propiedades de elementos, usted puede también crear decoradores que manejen un solo aspecto de un elemento; los decoradores 'Decorador' y 'etiqueta' son excelentes ejemplos para esta práctica. Hacerlo le permite mezclar y combinar decoradores para llegar a complejas salidas -- y también anular aspectos de decoración para personalizar sus necesidades. Por ejemplo, si usted quiere simplemente desplegar que un error a ocurrido cuando validabamos un elemento, pero no desplegar individualmente cada uno de los mensajes de error, usted podría crear su propio decorador 'Errores': The value you provided was invalid; please try again'; $placement = $this->getPlacement(); $separator = $this->getSeparator(); switch ($placement) { case 'PREPEND': return $output . $separator . $content; case 'APPEND': default: return $content . $separator . $output; } } } ]]> En este ejemplo particular, debido al segmento del decorador final, 'Errors', se combina como Zend_Form_Decorator_Errors, será generado en lugar de el decorador -- significa que usted no necesitará cambiar ningún decorador para modificar la salida. Nombrando sus decoradores después de los existentes decoradores estándar, usted puede modificar decoradores sin necesitad de modificar sus elementos decoradores. Generando individuales decoradores Desde que los decoradores pueden capturar distintos metadatos del elemento o formulario que ellos decoran, es a menudo útil generar un decorador individual Afortunadamente, esta caracteristica es posible inicializando el método en cada tipo de clase form (forms, sub form, display group, element). Para hacer eso, simplemente render[DecoratorName](), cuando "[DecoratorName]" es el "nombre corto" de su decorador; opcionalmente, usted puede pasar en el contenido lo que usted quiera. Por ejemplo: renderLabel(); // genera sólo el campo display group, con algún contenido: echo $group->renderFieldset('fieldset content'); // genera sólo el formulario HTML, con algún contenido: echo $form->renderHtmlTag('wrap this content'); ]]> Si el decorador no existe, una excepción es inicializada. Esto puede ser útil particularmente cuando se genera un formulario con el decorador ViewScript; cada elemento puede usar sus decoradores adjuntos para generar contenido, pero con concreto control.