1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
|
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_Form
* @subpackage Decorator
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
/** Zend_Form_Decorator_Abstract */
require_once 'Zend/Form/Decorator/Abstract.php';
/**
* Zend_Form_Decorator_ViewScript
*
* Render a view script as a decorator
*
* Accepts the options:
* - separator: separator to use between view script content and provided content (defaults to PHP_EOL)
* - placement: whether to append or prepend view script content to provided content (defaults to prepend)
* - viewScript: view script to use
*
* The view script is rendered as a partial; the element being decorated is
* passed in as the 'element' variable:
* <code>
* // in view script:
* echo $this->element->getLabel();
* </code>
*
* Any options other than separator, placement, and viewScript are passed to
* the partial as local variables.
*
* @category Zend
* @package Zend_Form
* @subpackage Decorator
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: ViewScript.php 20096 2010-01-06 02:05:09Z bkarwin $
*/
class Zend_Form_Decorator_ViewScript extends Zend_Form_Decorator_Abstract
{
/**
* Default placement: append
* @var string
*/
protected $_placement = 'APPEND';
/**
* View script to render
* @var string
*/
protected $_viewScript;
/**
* Set view script
*
* @param string $script
* @return Zend_Form_Decorator_ViewScript
*/
public function setViewScript($script)
{
$this->_viewScript = (string) $script;
return $this;
}
/**
* Get view script
*
* @return string|null
*/
public function getViewScript()
{
if (null === $this->_viewScript) {
if (null !== ($element = $this->getElement())) {
if (null !== ($viewScript = $element->getAttrib('viewScript'))) {
$this->setViewScript($viewScript);
return $viewScript;
}
}
if (null !== ($viewScript = $this->getOption('viewScript'))) {
$this->setViewScript($viewScript)
->removeOption('viewScript');
}
}
return $this->_viewScript;
}
/**
* Render a view script
*
* @param string $content
* @return string
*/
public function render($content)
{
$element = $this->getElement();
$view = $element->getView();
if (null === $view) {
return $content;
}
$viewScript = $this->getViewScript();
if (empty($viewScript)) {
require_once 'Zend/Form/Exception.php';
throw new Zend_Form_Exception('No view script registered with ViewScript decorator');
}
$separator = $this->getSeparator();
$placement = $this->getPlacement();
$vars = $this->getOptions();
$vars['element'] = $element;
$vars['content'] = $content;
$vars['decorator'] = $this;
$renderedContent = $view->partial($viewScript, $vars);
// Get placement again to see if it has changed
$placement = $this->getPlacement();
switch ($placement) {
case self::PREPEND:
return $renderedContent . $separator . $content;
case self::APPEND:
return $content . $separator . $renderedContent;
default:
return $renderedContent;
}
}
}
|