- optimization of {foreach} code size and processing

This commit is contained in:
uwetews
2015-12-28 00:58:22 +01:00
parent c8c82a292a
commit afec7564d6
4 changed files with 159 additions and 121 deletions

View File

@@ -1,4 +1,7 @@
 ===== 3.1.30-dev ===== (xx.xx.xx)  ===== 3.1.30-dev ===== (xx.xx.xx)
28.12.2015
- optimization of {foreach} code size and processing
27.12.2015 27.12.2015
- improve inheritance code - improve inheritance code
- update external methods - update external methods

View File

@@ -121,7 +121,7 @@ class Smarty extends Smarty_Internal_TemplateBase
/** /**
* smarty version * smarty version
*/ */
const SMARTY_VERSION = '3.1.30-dev/11'; const SMARTY_VERSION = '3.1.30-dev/12';
/** /**
* define variable scopes * define variable scopes

View File

@@ -92,32 +92,33 @@ class Smarty_Internal_Compile_Foreach extends Smarty_Internal_Compile_Private_Fo
$this->isNamed = false; $this->isNamed = false;
// check and get attributes // check and get attributes
$_attr = $this->getAttributes($compiler, $args); $_attr = $this->getAttributes($compiler, $args);
$from = $_attr['from']; $from = $_attr[ 'from' ];
$item = $compiler->getId($_attr['item']); $item = $compiler->getId($_attr[ 'item' ]);
if ($item === false) { if ($item === false) {
$item = $compiler->getVariableName($_attr['item']); $item = $compiler->getVariableName($_attr[ 'item' ]);
} }
$key = $name = null;
$attributes = array('item' => $item); $attributes = array('item' => $item);
if (isset($_attr['key'])) { if (isset($_attr[ 'key' ])) {
$key = $compiler->getId($_attr['key']); $key = $compiler->getId($_attr[ 'key' ]);
if ($key === false) { if ($key === false) {
$key = $compiler->getVariableName($_attr['key']); $key = $compiler->getVariableName($_attr[ 'key' ]);
} }
$attributes['key'] = $key; $attributes[ 'key' ] = $key;
} }
if (isset($_attr['name'])) { if (isset($_attr[ 'name' ])) {
$this->isNamed = true; $this->isNamed = true;
$attributes['name'] = $compiler->getId($_attr['name']); $name = $attributes[ 'name' ] = $compiler->getId($_attr[ 'name' ]);
} }
foreach ($attributes as $a => $v) { foreach ($attributes as $a => $v) {
if ($v === false) { if ($v === false) {
$compiler->trigger_template_error("'{$a}' attribute/variable has illegal value", null, true); $compiler->trigger_template_error("'{$a}' attribute/variable has illegal value", null, true);
} }
} }
$fromName = $compiler->getVariableName($_attr['from']); $fromName = $compiler->getVariableName($_attr[ 'from' ]);
if ($fromName) { if ($fromName) {
foreach (array('item', 'key') as $a) { foreach (array('item', 'key') as $a) {
if (isset($attributes[$a]) && $attributes[$a] == $fromName) { if (isset($attributes[ $a ]) && $attributes[ $a ] == $fromName) {
$compiler->trigger_template_error("'{$a}' and 'from' may not have same variable name '{$fromName}'", $compiler->trigger_template_error("'{$a}' and 'from' may not have same variable name '{$fromName}'",
null, true); null, true);
} }
@@ -125,147 +126,100 @@ class Smarty_Internal_Compile_Foreach extends Smarty_Internal_Compile_Private_Fo
} }
$itemVar = "\$_smarty_tpl->tpl_vars['{$item}']"; $itemVar = "\$_smarty_tpl->tpl_vars['{$item}']";
$local = '$__foreach_' . (isset($attributes['name']) ? $attributes['name'] : $attributes['item']) . '_' . $local = '$__foreach_' . $attributes[ 'item' ] . '_' . $this->counter ++ . '_';
$this->counter ++ . '_';
$needIteration = false;
// search for used tag attributes // search for used tag attributes
$itemAttr = array(); $itemAttr = array();
$namedAttr = array(); $namedAttr = array();
$this->scanForProperties($attributes, $compiler); $this->scanForProperties($attributes, $compiler);
if (!empty($this->matchResults['item'])) { if (!empty($this->matchResults[ 'item' ])) {
$itemAttr = $this->matchResults['item']; $itemAttr = $this->matchResults[ 'item' ];
} }
if (!empty($this->matchResults['named'])) { if (!empty($this->matchResults[ 'named' ])) {
$namedAttr = $this->matchResults['named']; $namedAttr = $this->matchResults[ 'named' ];
} }
if (isset($itemAttr['last'])) { if (isset($itemAttr[ 'first' ])) {
$needIteration = true; $itemAttr[ 'index' ] = true;
} }
if (isset($namedAttr['last'])) { if (isset($namedAttr[ 'first' ])) {
$needIteration = true; $namedAttr[ 'index' ] = true;
}
if (isset($namedAttr[ 'last' ])) {
$namedAttr[ 'iteration' ] = true;
$namedAttr[ 'total' ] = true;
}
if (isset($itemAttr[ 'last' ])) {
$itemAttr[ 'iteration' ] = true;
$itemAttr[ 'total' ] = true;
} }
$keyTerm = ''; $keyTerm = '';
if (isset($itemAttr['key'])) { if (isset($itemAttr[ 'key' ])) {
$keyTerm = "{$itemVar}->key => "; $keyTerm = "{$itemVar}->key => ";
} elseif (isset($attributes['key'])) { } elseif (isset($attributes[ 'key' ])) {
$keyTerm = "\$_smarty_tpl->tpl_vars['{$key}']->value => "; $keyTerm = "\$_smarty_tpl->tpl_vars['{$key}']->value => ";
} }
$saveVars = array();
$restoreVars = array();
if ($this->isNamed) { if ($this->isNamed) {
$foreachVar = "\$_smarty_tpl->tpl_vars['__smarty_foreach_{$attributes['name']}']"; $foreachVar = "\$_smarty_tpl->tpl_vars['__smarty_foreach_{$attributes['name']}']";
if (!empty($namedAttr)) {
$saveVars['saved'] = "isset({$foreachVar}) ? {$foreachVar} : false;";
$restoreVars[] = "if ({$local}saved) {\n{$foreachVar} = {$local}saved;\n}\n";
}
} }
foreach (array('item', 'key') as $a) { $this->openTag($compiler, 'foreach', array('foreach', $compiler->nocache, $local, $itemVar, true));
if (isset($attributes[$a])) {
$saveVars['saved_' . $a] =
"isset(\$_smarty_tpl->tpl_vars['{$attributes[$a]}']) ? \$_smarty_tpl->tpl_vars['{$attributes[$a]}'] : false;";
$restoreVars[] =
"if ({$local}saved_{$a}) {\n\$_smarty_tpl->tpl_vars['{$attributes[$a]}'] = {$local}saved_{$a};\n}\n";
}
}
$this->openTag($compiler, 'foreach',
array('foreach', $compiler->nocache, $local, $restoreVars, $itemVar, true));
// maybe nocache because of nocache variables // maybe nocache because of nocache variables
$compiler->nocache = $compiler->nocache | $compiler->tag_nocache; $compiler->nocache = $compiler->nocache | $compiler->tag_nocache;
$needTotal = isset($itemAttr[ 'show' ]) || isset($itemAttr[ 'total' ]) || isset($namedAttr[ 'total' ]) ||
isset($namedAttr[ 'show' ]) || isset($itemAttr[ 'last' ]) || isset($namedAttr[ 'last' ]);
// generate output code // generate output code
$output = "<?php\n"; $output = "<?php\n";
$output .= "\$_from = $from;\n"; $output .= "\$_from = \$_smarty_tpl->smarty->ext->_foreach->init(\$_smarty_tpl, $from, " .
$output .= "if (!is_array(\$_from) && !is_object(\$_from)) {\n"; var_export($item, true);
$output .= "settype(\$_from, 'array');\n"; if ($name || $needTotal || $key) {
$output .= "}\n"; $output .= ', ' . var_export($needTotal, true);
foreach ($saveVars as $k => $code) {
$output .= "{$local}{$k} = {$code}\n";
} }
if (isset($itemAttr['show']) || isset($itemAttr['total']) || isset($namedAttr['total']) || isset($namedAttr['show']) || isset($itemAttr['last']) || isset($namedAttr['last'])) { if ($name || $key) {
$output .= "{$local}total = \$_smarty_tpl->smarty->ext->_foreach->count(\$_from);\n"; $output .= ', ' . var_export($key, true);
} }
$output .= "{$itemVar} = new Smarty_Variable();\n"; if ($name) {
if (isset($itemAttr['show'])) { $output .= ', ' . var_export($name, true) . ', ' . var_export($namedAttr, true);
$output .= "{$itemVar}->show = ({$local}total > 0);\n";
} }
if (isset($itemAttr['total'])) { $output .= ");\n";
$output .= "{$itemVar}->total= {$local}total;\n"; if (isset($itemAttr[ 'show' ])) {
$output .= "{$itemVar}->show = ({$itemVar}->total > 0);\n";
} }
if ($this->isNamed) { if (isset($itemAttr[ 'iteration' ])) {
$prop = array(); $output .= "{$itemVar}->iteration = 0;\n";
if (isset($namedAttr['total'])) {
$prop['total'] = "'total' => {$local}total";
}
if (isset($namedAttr['iteration'])) {
$prop['iteration'] = "'iteration' => 0";
}
if (isset($namedAttr['index'])) {
$prop['index'] = "'index' => -1";
}
if (isset($namedAttr['show'])) {
$prop['show'] = "'show' => ({$local}total > 0)";
}
if (!empty($namedAttr)) {
$_vars = 'array(' . join(', ', $prop) . ')';
$output .= "{$foreachVar} = new Smarty_Variable({$_vars});\n";
}
} }
if (isset($attributes['key'])) { if (isset($itemAttr[ 'index' ])) {
$output .= "\$_smarty_tpl->tpl_vars['{$key}'] = new Smarty_Variable();\n"; $output .= "{$itemVar}->index = -1;\n";
} }
if (isset($namedAttr['first']) || isset($itemAttr['first'])) {
$output .= "{$local}first = true;\n";
}
if (isset($itemAttr['iteration'])) {
$output .= "{$itemVar}->iteration=0;\n";
}
if (isset($itemAttr['index'])) {
$output .= "{$itemVar}->index=-1;\n";
}
if ($needIteration) {
$output .= "{$local}iteration=0;\n";
}
$output .= "{$itemVar}->_loop = false;\n";
$output .= "foreach (\$_from as {$keyTerm}{$itemVar}->value) {\n"; $output .= "foreach (\$_from as {$keyTerm}{$itemVar}->value) {\n";
$output .= "{$itemVar}->_loop = true;\n"; $output .= "{$itemVar}->_loop = true;\n";
if (isset($attributes['key']) && isset($itemAttr['key'])) { if (isset($attributes[ 'key' ]) && isset($itemAttr[ 'key' ])) {
$output .= "\$_smarty_tpl->tpl_vars['{$key}']->value = {$itemVar}->key;\n"; $output .= "\$_smarty_tpl->tpl_vars['{$key}']->value = {$itemVar}->key;\n";
} }
if (isset($itemAttr['iteration'])) { if (isset($itemAttr[ 'iteration' ])) {
$output .= "{$itemVar}->iteration++;\n"; $output .= "{$itemVar}->iteration++;\n";
} }
if (isset($itemAttr['index'])) { if (isset($itemAttr[ 'index' ])) {
$output .= "{$itemVar}->index++;\n"; $output .= "{$itemVar}->index++;\n";
} }
if ($needIteration) { if (isset($itemAttr[ 'first' ])) {
$output .= "{$local}iteration++;\n"; $output .= "{$itemVar}->first = !{$itemVar}->index;\n";
} }
if (isset($itemAttr['first'])) { if (isset($itemAttr[ 'last' ])) {
$output .= "{$itemVar}->first = {$local}first;\n"; $output .= "{$itemVar}->last = {$itemVar}->iteration == {$itemVar}->total;\n";
}
if (isset($itemAttr['last'])) {
$output .= "{$itemVar}->last = {$local}iteration == {$local}total;\n";
} }
if ($this->isNamed) { if ($this->isNamed) {
if (isset($namedAttr['iteration'])) { if (isset($namedAttr[ 'iteration' ])) {
$output .= "{$foreachVar}->value['iteration']++;\n"; $output .= "{$foreachVar}->value['iteration']++;\n";
} }
if (isset($namedAttr['index'])) { if (isset($namedAttr[ 'index' ])) {
$output .= "{$foreachVar}->value['index']++;\n"; $output .= "{$foreachVar}->value['index']++;\n";
} }
if (isset($namedAttr['first'])) { if (isset($namedAttr[ 'first' ])) {
$output .= "{$foreachVar}->value['first'] = {$local}first;\n"; $output .= "{$foreachVar}->value['first'] = !{$foreachVar}->value['index'];\n";
} }
if (isset($namedAttr['last'])) { if (isset($namedAttr[ 'last' ])) {
$output .= "{$foreachVar}->value['last'] = {$local}iteration == {$local}total;\n"; $output .= "{$foreachVar}->value['last'] = {$foreachVar}->value['iteration'] == {$foreachVar}->value['total'];\n";
} }
} }
if (isset($namedAttr['first']) || isset($itemAttr['first'])) { $output .= "{$local}saved = {$itemVar};\n";
$output .= "{$local}first = false;\n";
}
$output .= "{$local}saved_local_item = {$itemVar};\n";
$output .= "?>"; $output .= "?>";
return $output; return $output;
@@ -294,10 +248,10 @@ class Smarty_Internal_Compile_Foreachelse extends Smarty_Internal_CompileBase
// check and get attributes // check and get attributes
$_attr = $this->getAttributes($compiler, $args); $_attr = $this->getAttributes($compiler, $args);
list($openTag, $nocache, $local, $restoreVars, $itemVar, $foo) = $this->closeTag($compiler, array('foreach')); list($openTag, $nocache, $local, $itemVar, $foo) = $this->closeTag($compiler, array('foreach'));
$this->openTag($compiler, 'foreachelse', array('foreachelse', $nocache, $local, $restoreVars, $itemVar, false)); $this->openTag($compiler, 'foreachelse', array('foreachelse', $nocache, $local, $itemVar, false));
$output = "<?php\n"; $output = "<?php\n";
$output .= "{$itemVar} = {$local}saved_local_item;\n"; $output .= "{$itemVar} = {$local}saved;\n";
$output .= "}\n"; $output .= "}\n";
$output .= "if (!{$itemVar}->_loop) {\n?>"; $output .= "if (!{$itemVar}->_loop) {\n?>";
return $output; return $output;
@@ -329,19 +283,16 @@ class Smarty_Internal_Compile_Foreachclose extends Smarty_Internal_CompileBase
$compiler->tag_nocache = true; $compiler->tag_nocache = true;
} }
list($openTag, $compiler->nocache, $local, $restoreVars, $itemVar, $restore) = list($openTag, $compiler->nocache, $local, $itemVar, $restore) =
$this->closeTag($compiler, array('foreach', 'foreachelse')); $this->closeTag($compiler, array('foreach', 'foreachelse'));
$output = "<?php\n"; $output = "<?php\n";
if ($restore) { if ($restore) {
$output .= "{$itemVar} = {$local}saved_local_item;\n"; $output .= "{$itemVar} = {$local}saved;\n";
} }
$output .= "}\n"; $output .= "}\n";
foreach ($restoreVars as $restore) { $output .= "\$_smarty_tpl->smarty->ext->_foreach->restore(\$_smarty_tpl);\n";
$output .= $restore;
}
$output .= "?>"; $output .= "?>";
return $output; return $output;
} }
} }

View File

@@ -1,16 +1,100 @@
<?php <?php
/** /**
* Foreach Runtime Methods count * Foreach Runtime Methods count(), init(), restore()
* *
* @package Smarty * @package Smarty
* @subpackage PluginsInternal * @subpackage PluginsInternal
* @author Uwe Tews * @author Uwe Tews
* *
**/ */
class Smarty_Internal_Runtime_Foreach class Smarty_Internal_Runtime_Foreach
{ {
/** /**
* Stack of saved variables
*
* @var array
*/
private $stack = array();
/**
* Init foreach loop
* - save item and key variables, named foreach property data if defined
* - init item and key variables, named foreach property data if required
* - count total if required
*
* @param \Smarty_Internal_Template $tpl
* @param mixed $from values to loop over
* @param string $item variable name
* @param bool $needTotal flag if we need to count values
* @param null|string $key variable name
* @param null|string $name of named foreach
* @param array $properties of named foreach
*
* @return mixed $from
*/
public function init(Smarty_Internal_Template $tpl, $from, $item, $needTotal = false, $key = null, $name = null,
$properties = array())
{
$saveVars = array();
if (isset($tpl->tpl_vars[ $item ])) {
$saveVars[ $item ] = $tpl->tpl_vars[ $item ];
}
if ($key) {
if (isset($tpl->tpl_vars[ $key ])) {
$saveVars[ $key ] = $tpl->tpl_vars[ $key ];
}
$tpl->tpl_vars[ $key ] = new Smarty_Variable();
}
if (!is_array($from) && !is_object($from)) {
settype($from, 'array');
}
$total = $needTotal ? $this->count($from) : 1;
$tpl->tpl_vars[ $item ] = new Smarty_Variable();
if ($needTotal) {
$tpl->tpl_vars[ $item ]->total = $total;
}
$tpl->tpl_vars[ $item ]->_loop = false;
if ($name) {
$namedVar = "__smarty_foreach_{$name}";
if (isset($tpl->tpl_vars[ $namedVar ])) {
$saveVars[ $namedVar ] = $tpl->tpl_vars[ $namedVar ];
}
$namedProp = array();
if (isset($properties[ 'total' ])) {
$namedProp[ 'total' ] = $total;
}
if (isset($properties[ 'iteration' ])) {
$namedProp[ 'iteration' ] = 0;
}
if (isset($properties[ 'index' ])) {
$namedProp[ 'index' ] = - 1;
}
if (isset($properties[ 'show' ])) {
$namedProp[ 'show' ] = ($total > 0);
}
$tpl->tpl_vars[ $namedVar ] = new Smarty_Variable($namedProp);
}
$this->stack[] = $saveVars;
return $from;
}
/**
* Restore saved variables
*
* @param \Smarty_Internal_Template $tpl
*/
public function restore(Smarty_Internal_Template $tpl)
{
foreach (array_pop($this->stack) as $k => $v) {
$tpl->tpl_vars[ $k ] = $v;
}
}
/*
*
* [util function] counts an array, arrayAccess/traversable or PDOStatement object * [util function] counts an array, arrayAccess/traversable or PDOStatement object
* *
* @param mixed $value * @param mixed $value