3 * Smarty Internal Plugin Compile Foreach
4 * Compiles the {foreach} {foreachelse} {/foreach} tags
12 * Smarty Internal Plugin Compile Foreach Class
15 * @subpackage Compiler
17 class Smarty_Internal_Compile_Foreach extends Smarty_Internal_CompileBase
20 * Attribute definition: Overwrites base class.
23 * @see Smarty_Internal_CompileBase
25 public $required_attributes = array('from', 'item');
27 * Attribute definition: Overwrites base class.
30 * @see Smarty_Internal_CompileBase
32 public $optional_attributes = array('name', 'key');
34 * Attribute definition: Overwrites base class.
37 * @see Smarty_Internal_CompileBase
39 public $shorttag_order = array('from', 'item', 'key', 'name');
42 * Compiles code for the {foreach} tag
44 * @param array $args array with attributes from parser
45 * @param object $compiler compiler object
46 * @param array $parameter array with compilation parameter
48 * @return string compiled code
50 public function compile($args, $compiler, $parameter)
52 // check and get attributes
53 $_attr = $this->getAttributes($compiler, $args);
55 $from = $_attr['from'];
56 $item = $_attr['item'];
57 if (!strncmp("\$_smarty_tpl->tpl_vars[$item]", $from, strlen($item) + 24)) {
58 $compiler->trigger_template_error("item variable {$item} may not be the same variable as at 'from'", $compiler->lex->taglineno);
61 if (isset($_attr['key'])) {
67 $this->openTag($compiler, 'foreach', array('foreach', $compiler->nocache, $item, $key));
68 // maybe nocache because of nocache variables
69 $compiler->nocache = $compiler->nocache | $compiler->tag_nocache;
71 if (isset($_attr['name'])) {
72 $name = $_attr['name'];
74 $SmartyVarName = '$smarty.foreach.' . trim($name, '\'"') . '.';
79 $ItemVarName = '$' . trim($item, '\'"') . '@';
80 // evaluates which Smarty variables and properties have to be computed
82 $usesSmartyFirst = strpos($compiler->lex->data, $SmartyVarName . 'first') !== false;
83 $usesSmartyLast = strpos($compiler->lex->data, $SmartyVarName . 'last') !== false;
84 $usesSmartyIndex = strpos($compiler->lex->data, $SmartyVarName . 'index') !== false;
85 $usesSmartyIteration = strpos($compiler->lex->data, $SmartyVarName . 'iteration') !== false;
86 $usesSmartyShow = strpos($compiler->lex->data, $SmartyVarName . 'show') !== false;
87 $usesSmartyTotal = strpos($compiler->lex->data, $SmartyVarName . 'total') !== false;
89 $usesSmartyFirst = false;
90 $usesSmartyLast = false;
91 $usesSmartyTotal = false;
92 $usesSmartyShow = false;
95 $usesPropFirst = $usesSmartyFirst || strpos($compiler->lex->data, $ItemVarName . 'first') !== false;
96 $usesPropLast = $usesSmartyLast || strpos($compiler->lex->data, $ItemVarName . 'last') !== false;
97 $usesPropIndex = $usesPropFirst || strpos($compiler->lex->data, $ItemVarName . 'index') !== false;
98 $usesPropIteration = $usesPropLast || strpos($compiler->lex->data, $ItemVarName . 'iteration') !== false;
99 $usesPropShow = strpos($compiler->lex->data, $ItemVarName . 'show') !== false;
100 $usesPropTotal = $usesSmartyTotal || $usesSmartyShow || $usesPropShow || $usesPropLast || strpos($compiler->lex->data, $ItemVarName . 'total') !== false;
101 // generate output code
103 $output .= " \$_smarty_tpl->tpl_vars[$item] = new Smarty_Variable; \$_smarty_tpl->tpl_vars[$item]->_loop = false;\n";
105 $output .= " \$_smarty_tpl->tpl_vars[$key] = new Smarty_Variable;\n";
107 $output .= " \$_from = $from; if (!is_array(\$_from) && !is_object(\$_from)) { settype(\$_from, 'array');}\n";
108 if ($usesPropTotal) {
109 $output .= " \$_smarty_tpl->tpl_vars[$item]->total= \$_smarty_tpl->_count(\$_from);\n";
111 if ($usesPropIteration) {
112 $output .= " \$_smarty_tpl->tpl_vars[$item]->iteration=0;\n";
114 if ($usesPropIndex) {
115 $output .= " \$_smarty_tpl->tpl_vars[$item]->index=-1;\n";
118 $output .= " \$_smarty_tpl->tpl_vars[$item]->show = (\$_smarty_tpl->tpl_vars[$item]->total > 0);\n";
121 if ($usesSmartyTotal) {
122 $output .= " \$_smarty_tpl->tpl_vars['smarty']->value['foreach'][$name]['total'] = \$_smarty_tpl->tpl_vars[$item]->total;\n";
124 if ($usesSmartyIteration) {
125 $output .= " \$_smarty_tpl->tpl_vars['smarty']->value['foreach'][$name]['iteration']=0;\n";
127 if ($usesSmartyIndex) {
128 $output .= " \$_smarty_tpl->tpl_vars['smarty']->value['foreach'][$name]['index']=-1;\n";
130 if ($usesSmartyShow) {
131 $output .= " \$_smarty_tpl->tpl_vars['smarty']->value['foreach'][$name]['show']=(\$_smarty_tpl->tpl_vars[$item]->total > 0);\n";
134 $output .= "foreach (\$_from as \$_smarty_tpl->tpl_vars[$item]->key => \$_smarty_tpl->tpl_vars[$item]->value) {\n\$_smarty_tpl->tpl_vars[$item]->_loop = true;\n";
136 $output .= " \$_smarty_tpl->tpl_vars[$key]->value = \$_smarty_tpl->tpl_vars[$item]->key;\n";
138 if ($usesPropIteration) {
139 $output .= " \$_smarty_tpl->tpl_vars[$item]->iteration++;\n";
141 if ($usesPropIndex) {
142 $output .= " \$_smarty_tpl->tpl_vars[$item]->index++;\n";
144 if ($usesPropFirst) {
145 $output .= " \$_smarty_tpl->tpl_vars[$item]->first = \$_smarty_tpl->tpl_vars[$item]->index === 0;\n";
148 $output .= " \$_smarty_tpl->tpl_vars[$item]->last = \$_smarty_tpl->tpl_vars[$item]->iteration === \$_smarty_tpl->tpl_vars[$item]->total;\n";
151 if ($usesSmartyFirst) {
152 $output .= " \$_smarty_tpl->tpl_vars['smarty']->value['foreach'][$name]['first'] = \$_smarty_tpl->tpl_vars[$item]->first;\n";
154 if ($usesSmartyIteration) {
155 $output .= " \$_smarty_tpl->tpl_vars['smarty']->value['foreach'][$name]['iteration']++;\n";
157 if ($usesSmartyIndex) {
158 $output .= " \$_smarty_tpl->tpl_vars['smarty']->value['foreach'][$name]['index']++;\n";
160 if ($usesSmartyLast) {
161 $output .= " \$_smarty_tpl->tpl_vars['smarty']->value['foreach'][$name]['last'] = \$_smarty_tpl->tpl_vars[$item]->last;\n";
171 * Smarty Internal Plugin Compile Foreachelse Class
174 * @subpackage Compiler
176 class Smarty_Internal_Compile_Foreachelse extends Smarty_Internal_CompileBase
179 * Compiles code for the {foreachelse} tag
181 * @param array $args array with attributes from parser
182 * @param object $compiler compiler object
183 * @param array $parameter array with compilation parameter
185 * @return string compiled code
187 public function compile($args, $compiler, $parameter)
189 // check and get attributes
190 $_attr = $this->getAttributes($compiler, $args);
192 list($openTag, $nocache, $item, $key) = $this->closeTag($compiler, array('foreach'));
193 $this->openTag($compiler, 'foreachelse', array('foreachelse', $nocache, $item, $key));
195 return "<?php }\nif (!\$_smarty_tpl->tpl_vars[$item]->_loop) {\n?>";
200 * Smarty Internal Plugin Compile Foreachclose Class
203 * @subpackage Compiler
205 class Smarty_Internal_Compile_Foreachclose extends Smarty_Internal_CompileBase
208 * Compiles code for the {/foreach} tag
210 * @param array $args array with attributes from parser
211 * @param object $compiler compiler object
212 * @param array $parameter array with compilation parameter
214 * @return string compiled code
216 public function compile($args, $compiler, $parameter)
218 // check and get attributes
219 $_attr = $this->getAttributes($compiler, $args);
220 // must endblock be nocache?
221 if ($compiler->nocache) {
222 $compiler->tag_nocache = true;
225 list($openTag, $compiler->nocache, $item, $key) = $this->closeTag($compiler, array('foreach', 'foreachelse'));