File size: 4.52Kb
<?php
/**
* Foreach Runtime Methods count(), init(), restore()
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*
*/
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 (!is_array($from) && !is_object($from)) {
settype($from, 'array');
}
$total = ($needTotal || isset($properties[ 'total' ])) ? $this->count($from) : 1;
if (isset($tpl->tpl_vars[ $item ])) {
$saveVars[ $item ] = $tpl->tpl_vars[ $item ];
}
$tpl->tpl_vars[ $item ] = new Smarty_Variable(null, $tpl->isRenderingCache);
if (empty($from)) {
$from = null;
$total = 0;
if ($needTotal) {
$tpl->tpl_vars[ $item ]->total = 0;
}
} else {
if ($key) {
if (isset($tpl->tpl_vars[ $key ])) {
$saveVars[ $key ] = $tpl->tpl_vars[ $key ];
}
$tpl->tpl_vars[ $key ] = new Smarty_Variable(null, $tpl->isRenderingCache);
}
if ($needTotal) {
$tpl->tpl_vars[ $item ]->total = $total;
}
}
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
*
* @param mixed $value
*
* @return int the count for arrays and objects that implement countable, 1 for other objects that don't, and 0
* for empty elements
*/
public function count($value)
{
if (is_array($value) === true || $value instanceof Countable) {
return count($value);
} elseif ($value instanceof IteratorAggregate) {
// Note: getIterator() returns a Traversable, not an Iterator
// thus rewind() and valid() methods may not be present
return iterator_count($value->getIterator());
} elseif ($value instanceof Iterator) {
if ($value instanceof Generator) {
return 1;
}
return iterator_count($value);
} elseif ($value instanceof PDOStatement) {
return $value->rowCount();
} elseif ($value instanceof Traversable) {
return iterator_count($value);
} elseif ($value instanceof ArrayAccess) {
if ($value->offsetExists(0)) {
return 1;
}
} elseif (is_object($value)) {
return count($value);
}
return 0;
}
}