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.  * This file is released under the LGPL
  25.  * "GNU Lesser General Public License"
  26.  * More information can be found here:
  27.  * {@link http://www.gnu.org/copyleft/lesser.html}
  28.  *
  29.  * @author     Jordi Boggiano <[email protected]>
  30.  * @copyright  Copyright (c) 2008, Jordi Boggiano
  31.  * @license    http://www.gnu.org/copyleft/lesser.html  GNU Lesser General Public License
  32.  * @link       http://dwoo.org/
  33.  * @version    0.9.1
  34.  * @date       2008-05-30
  35.  * @package    Dwoo
  36.  */
  37. class Dwoo_Plugin_foreach extends Dwoo_Block_Plugin implements Dwoo_ICompilable_Block
  38. {
  39.     public static $cnt=0;
  40.  
  41.     public function init($from, $key=null, $item=null, $name='default', $implode=null)
  42.     {
  43.     }
  44.  
  45.     public static function preProcessing(Dwoo_Compiler $compiler, array $params, $prepend, $append, $type)
  46.     {
  47.         $params = $compiler->getCompiledParams($params);
  48.         $tpl = $compiler->getTemplateSource(true);
  49.  
  50.         // assigns params
  51.         $src = $params['from'];
  52.  
  53.         if ($params['item'] !== 'null') {
  54.             if ($params['key'] !== 'null') {
  55.                 $key = $params['key'];
  56.             }
  57.             $val = $params['item'];
  58.         } elseif ($params['key'] !== 'null') {
  59.             $val = $params['key'];
  60.         } else {
  61.             throw new Dwoo_Compilation_Exception($compiler, 'Foreach <em>item</em> parameter missing');
  62.         }
  63.         $name = $params['name'];
  64.  
  65.         if (substr($val, 0, 1) !== '"' && substr($val, 0, 1) !== '\'') {
  66.             throw new Dwoo_Compilation_Exception($compiler, 'Foreach <em>item</em> parameter must be of type string');
  67.         }
  68.         if (isset($key) && substr($val, 0, 1) !== '"' && substr($val, 0, 1) !== '\'') {
  69.             throw new Dwoo_Compilation_Exception($compiler, 'Foreach <em>key</em> parameter must be of type string');
  70.         }
  71.  
  72.         // evaluates which global variables have to be computed
  73.         $varName = '$dwoo.foreach.'.trim($name, '"\'').'.';
  74.         $shortVarName = '$.foreach.'.trim($name, '"\'').'.';
  75.         $usesAny = strpos($tpl, $varName) !== false || strpos($tpl, $shortVarName) !== false;
  76.         $usesFirst = strpos($tpl, $varName.'first') !== false || strpos($tpl, $shortVarName.'first') !== false;
  77.         $usesLast = strpos($tpl, $varName.'last') !== false || strpos($tpl, $shortVarName.'last') !== false;
  78.         $usesIndex = $usesFirst || strpos($tpl, $varName.'index') !== false || strpos($tpl, $shortVarName.'index') !== false;
  79.         $usesIteration = $usesLast || strpos($tpl, $varName.'iteration') !== false || strpos($tpl, $shortVarName.'iteration') !== false;
  80.         $usesShow = strpos($tpl, $varName.'show') !== false || strpos($tpl, $shortVarName.'show') !== false;
  81.         $usesTotal = $usesLast || strpos($tpl, $varName.'total') !== false || strpos($tpl, $shortVarName.'total') !== false;
  82.  
  83.         // override globals vars if implode is used
  84.         if ($params['implode'] !== 'null') {
  85.             $implode = $params['implode'];
  86.             $usesAny = true;
  87.             $usesLast = true;
  88.         }
  89.  
  90.         // gets foreach id
  91.         $cnt = self::$cnt++;
  92.  
  93.         // builds pre processing output
  94.         $out = Dwoo_Compiler::PHP_OPEN . "\n".'$_fh'.$cnt.'_data = '.$src.';';
  95.         // adds foreach properties
  96.         if ($usesAny) {
  97.             $out .= "\n".'$this->globals["foreach"]['.$name.'] = array'."\n(";
  98.             if ($usesIndex) $out .="\n\t".'"index"        => 0,';
  99.             if ($usesIteration) $out .="\n\t".'"iteration"        => 1,';
  100.             if ($usesFirst) $out .="\n\t".'"first"        => null,';
  101.             if ($usesLast) $out .="\n\t".'"last"        => null,';
  102.             if ($usesShow) $out .="\n\t".'"show"        => $this->isArray($_fh'.$cnt.'_data, true, true),';
  103.             if ($usesTotal) $out .="\n\t".'"total"        => $this->isArray($_fh'.$cnt.'_data) ? count($_fh'.$cnt.'_data) : 0,';
  104.             $out.="\n);\n".'$_fh'.$cnt.'_glob =& $this->globals["foreach"]['.$name.'];';
  105.         }
  106.         // checks if foreach must be looped
  107.         $out .= "\n".'if ($this->isArray($_fh'.$cnt.'_data, true, true) === true)'."\n{";
  108.         // iterates over keys
  109.         $out .= "\n\t".'foreach ($_fh'.$cnt.'_data as '.(isset($key)?'$this->scope['.$key.']=>':'').'$this->scope['.$val.'])'."\n\t{";
  110.         // updates properties
  111.         if ($usesFirst) {
  112.             $out .= "\n\t\t".'$_fh'.$cnt.'_glob["first"] = (string) ($_fh'.$cnt.'_glob["index"] === 0);';
  113.         }
  114.         if ($usesLast) {
  115.             $out .= "\n\t\t".'$_fh'.$cnt.'_glob["last"] = (string) ($_fh'.$cnt.'_glob["iteration"] === $_fh'.$cnt.'_glob["total"]);';
  116.         }
  117.         $out .= "\n/* -- foreach start output */\n".Dwoo_Compiler::PHP_CLOSE;
  118.  
  119.         // build post processing output and cache it
  120.         $postOut = Dwoo_Compiler::PHP_OPEN . "\n";
  121.  
  122.         if (isset($implode)) {
  123.             $postOut .= '/* -- implode */'."\n".'if (!$_fh'.$cnt.'_glob["last"]) {'.
  124.                 "\n\t".'echo '.$implode.";\n}\n";
  125.         }
  126.         $postOut .= '/* -- foreach end output */';
  127.         // update properties
  128.         if ($usesIndex) {
  129.             $postOut.="\n\t\t".'$_fh'.$cnt.'_glob["index"]+=1;';
  130.         }
  131.         if ($usesIteration) {
  132.             $postOut.="\n\t\t".'$_fh'.$cnt.'_glob["iteration"]+=1;';
  133.         }
  134.         // end loop
  135.         $postOut .= "\n\t}\n}\n";
  136.  
  137.         // get block params and save the post-processing output already
  138.         $currentBlock =& $compiler->getCurrentBlock();
  139.         $currentBlock['params']['postOutput'] = $postOut . Dwoo_Compiler::PHP_CLOSE;
  140.  
  141.         return $out;
  142.     }
  143.  
  144.     public static function postProcessing(Dwoo_Compiler $compiler, array $params, $prepend, $append, $content)
  145.     {
  146.         return $content . $params['postOutput'];
  147.     }
  148. }

Documentation generated on Sun, 03 Aug 2008 15:12:36 +0200 by phpDocumentor 1.4.0