Source for file foreach.php

Documentation is available at foreach.php

  1. <?php
  2.  
  3. /**
  4.  * Similar to the php foreach block, loops over an array
  5.  *
  6.  * Note that if you don't provide the item parameter, the key will act as item
  7.  * <pre>
  8.  *  * from : the array that you want to iterate over
  9.  *  * key : variable name for the key (or for the item if item is not defined)
  10.  *  * item : variable name for each item
  11.  *  * name : foreach name to access it's iterator variables through {$.foreach.name.var} see {@link http://wiki.dwoo.org/index.php/IteratorVariables} for details
  12.  * </pre>
  13.  * Example :
  14.  *
  15.  * <code>
  16.  * {foreach $array val}
  17.  *   {$val.something}
  18.  * {/foreach}
  19.  * </code>
  20.  *
  21.  * This software is provided 'as-is', without any express or implied warranty.
  22.  * In no event will the authors be held liable for any damages arising from the use of this software.
  23.  *
  24.  * @author     Jordi Boggiano <j.boggiano@seld.be>
  25.  * @copyright  Copyright (c) 2008, Jordi Boggiano
  26.  * @license    http://dwoo.org/LICENSE   Modified BSD License
  27.  * @link       http://dwoo.org/
  28.  * @version    1.0.1
  29.  * @date       2008-12-24
  30.  * @package    Dwoo
  31.  */
  32. class Dwoo_Plugin_foreach extends Dwoo_Block_Plugin implements Dwoo_ICompilable_Block, Dwoo_IElseable
  33. {
  34.     public static $cnt=0;
  35.  
  36.     public function init($from, $key=null, $item=null, $name='default', $implode=null)
  37.     {
  38.     }
  39.  
  40.     public static function preProcessing(Dwoo_Compiler $compiler, array $params, $prepend, $append, $type)
  41.     {
  42.         // get block params and save the current template pointer to use it in the postProcessing method
  43.         $currentBlock =& $compiler->getCurrentBlock();
  44.         $currentBlock['params']['tplPointer'] = $compiler->getPointer();
  45.  
  46.         return '';
  47.     }
  48.  
  49.     public static function postProcessing(Dwoo_Compiler $compiler, array $params, $prepend, $append, $content)
  50.     {
  51.         $params = $compiler->getCompiledParams($params);
  52.         $tpl = $compiler->getTemplateSource($params['tplPointer']);
  53.  
  54.         // assigns params
  55.         $src = $params['from'];
  56.  
  57.         if ($params['item'] !== 'null') {
  58.             if ($params['key'] !== 'null') {
  59.                 $key = $params['key'];
  60.             }
  61.             $val = $params['item'];
  62.         } elseif ($params['key'] !== 'null') {
  63.             $val = $params['key'];
  64.         } else {
  65.             throw new Dwoo_Compilation_Exception($compiler, 'Foreach <em>item</em> parameter missing');
  66.         }
  67.         $name = $params['name'];
  68.  
  69.         if (substr($val, 0, 1) !== '"' && substr($val, 0, 1) !== '\'') {
  70.             throw new Dwoo_Compilation_Exception($compiler, 'Foreach <em>item</em> parameter must be of type string');
  71.         }
  72.         if (isset($key) && substr($val, 0, 1) !== '"' && substr($val, 0, 1) !== '\'') {
  73.             throw new Dwoo_Compilation_Exception($compiler, 'Foreach <em>key</em> parameter must be of type string');
  74.         }
  75.  
  76.         // evaluates which global variables have to be computed
  77.         $varName = '$dwoo.foreach.'.trim($name, '"\'').'.';
  78.         $shortVarName = '$.foreach.'.trim($name, '"\'').'.';
  79.         $usesAny = strpos($tpl, $varName) !== false || strpos($tpl, $shortVarName) !== false;
  80.         $usesFirst = strpos($tpl, $varName.'first') !== false || strpos($tpl, $shortVarName.'first') !== false;
  81.         $usesLast = strpos($tpl, $varName.'last') !== false || strpos($tpl, $shortVarName.'last') !== false;
  82.         $usesIndex = $usesFirst || strpos($tpl, $varName.'index') !== false || strpos($tpl, $shortVarName.'index') !== false;
  83.         $usesIteration = $usesLast || strpos($tpl, $varName.'iteration') !== false || strpos($tpl, $shortVarName.'iteration') !== false;
  84.         $usesShow = strpos($tpl, $varName.'show') !== false || strpos($tpl, $shortVarName.'show') !== false;
  85.         $usesTotal = $usesLast || strpos($tpl, $varName.'total') !== false || strpos($tpl, $shortVarName.'total') !== false;
  86.  
  87.         // override globals vars if implode is used
  88.         if ($params['implode'] !== 'null') {
  89.             $implode = $params['implode'];
  90.             $usesAny = true;
  91.             $usesLast = true;
  92.             $usesIteration = true;
  93.             $usesTotal = true;
  94.         }
  95.  
  96.         // gets foreach id
  97.         $cnt = self::$cnt++;
  98.  
  99.         // build pre content output
  100.         $pre = Dwoo_Compiler::PHP_OPEN . "\n".'$_fh'.$cnt.'_data = '.$src.';';
  101.         // adds foreach properties
  102.         if ($usesAny) {
  103.             $pre .= "\n".'$this->globals["foreach"]['.$name.'] = array'."\n(";
  104.             if ($usesIndex) $pre .="\n\t".'"index"        => 0,';
  105.             if ($usesIteration) $pre .="\n\t".'"iteration"        => 1,';
  106.             if ($usesFirst) $pre .="\n\t".'"first"        => null,';
  107.             if ($usesLast) $pre .="\n\t".'"last"        => null,';
  108.             if ($usesShow) $pre .="\n\t".'"show"        => $this->isArray($_fh'.$cnt.'_data, true, true),';
  109.             if ($usesTotal) $pre .="\n\t".'"total"        => $this->isArray($_fh'.$cnt.'_data) ? count($_fh'.$cnt.'_data) : 0,';
  110.             $pre.="\n);\n".'$_fh'.$cnt.'_glob =& $this->globals["foreach"]['.$name.'];';
  111.         }
  112.         // checks if foreach must be looped
  113.         $pre .= "\n".'if ($this->isArray($_fh'.$cnt.'_data'.(isset($params['hasElse']) ? ', true, true' : '').') === true)'."\n{";
  114.         // iterates over keys
  115.         $pre .= "\n\t".'foreach ($_fh'.$cnt.'_data as '.(isset($key)?'$this->scope['.$key.']=>':'').'$this->scope['.$val.'])'."\n\t{";
  116.         // updates properties
  117.         if ($usesFirst) {
  118.             $pre .= "\n\t\t".'$_fh'.$cnt.'_glob["first"] = (string) ($_fh'.$cnt.'_glob["index"] === 0);';
  119.         }
  120.         if ($usesLast) {
  121.             $pre .= "\n\t\t".'$_fh'.$cnt.'_glob["last"] = (string) ($_fh'.$cnt.'_glob["iteration"] === $_fh'.$cnt.'_glob["total"]);';
  122.         }
  123.         $pre .= "\n/* -- foreach start output */\n".Dwoo_Compiler::PHP_CLOSE;
  124.  
  125.         // build post content output
  126.         $post = Dwoo_Compiler::PHP_OPEN . "\n";
  127.  
  128.         if (isset($implode)) {
  129.             $post .= '/* -- implode */'."\n".'if (!$_fh'.$cnt.'_glob["last"]) {'.
  130.                 "\n\t".'echo '.$implode.";\n}\n";
  131.         }
  132.         $post .= '/* -- foreach end output */';
  133.         // update properties
  134.         if ($usesIndex) {
  135.             $post.="\n\t\t".'$_fh'.$cnt.'_glob["index"]+=1;';
  136.         }
  137.         if ($usesIteration) {
  138.             $post.="\n\t\t".'$_fh'.$cnt.'_glob["iteration"]+=1;';
  139.         }
  140.         // end loop
  141.         $post .= "\n\t}\n}".Dwoo_Compiler::PHP_CLOSE;
  142.         if (isset($params['hasElse'])) {
  143.             $post .= $params['hasElse'];
  144.         }
  145.  
  146.         return $pre . $content . $post;
  147.     }
  148. }

Documentation generated on Wed, 24 Dec 2008 02:13:28 +0100 by phpDocumentor 1.4.0