Source for file for.php

Documentation is available at for.php

  1. <?php
  2.  
  3. /**
  4.  * Similar to the php for block
  5.  * <pre>
  6.  *  * name : foreach name to access it's iterator variables through {$.foreach.name.var} see {@link http://wiki.dwoo.org/index.php/IteratorVariables} for details
  7.  *  * from : array to iterate from (which equals 0) or a number as a start value
  8.  *  * to : value to stop iterating at (equals count($array) by default if you set an array in from)
  9.  *  * step : defines the incrementation of the pointer at each iteration
  10.  *  * skip : allows you to skip some entries at the start, mostly useless excepted for smarty compatibility
  11.  * </pre>
  12.  * This software is provided 'as-is', without any express or implied warranty.
  13.  * In no event will the authors be held liable for any damages arising from the use of this software.
  14.  *
  15.  * This file is released under the LGPL
  16.  * "GNU Lesser General Public License"
  17.  * More information can be found here:
  18.  * {@link http://www.gnu.org/copyleft/lesser.html}
  19.  *
  20.  * @author     Jordi Boggiano <j.boggiano@seld.be>
  21.  * @copyright  Copyright (c) 2008, Jordi Boggiano
  22.  * @license    http://www.gnu.org/copyleft/lesser.html  GNU Lesser General Public License
  23.  * @link       http://dwoo.org/
  24.  * @version    0.9.1
  25.  * @date       2008-05-30
  26.  * @package    Dwoo
  27.  */
  28. class Dwoo_Plugin_for extends Dwoo_Block_Plugin implements Dwoo_ICompilable_Block, Dwoo_IElseable
  29. {
  30.     public static $cnt=0;
  31.  
  32.     public function init($name, $from, $to=null, $step=1, $skip=0)
  33.     {
  34.     }
  35.  
  36.     public static function preProcessing(Dwoo_Compiler $compiler, array $params, $prepend, $append, $type)
  37.     {
  38.         // get block params and save the current template pointer to use it in the postProcessing method
  39.         $currentBlock =& $compiler->getCurrentBlock();
  40.         $currentBlock['params']['tplPointer'] = $compiler->getPointer();
  41.  
  42.         return '';
  43.     }
  44.  
  45.     public static function postProcessing(Dwoo_Compiler $compiler, array $params, $prepend, $append, $content)
  46.     {
  47.         $params = $compiler->getCompiledParams($params);
  48.         $tpl = $compiler->getTemplateSource($params['tplPointer']);
  49.  
  50.         // assigns params
  51.         $from = $params['from'];
  52.         $name = $params['name'];
  53.         $step = $params['step'];
  54.         $skip = $params['skip'];
  55.         $to = $params['to'];
  56.  
  57.          // evaluates which global variables have to be computed
  58.         $varName = '$dwoo.for.'.trim($name, '"\'').'.';
  59.         $shortVarName = '$.for.'.trim($name, '"\'').'.';
  60.         $usesAny = strpos($tpl, $varName) !== false || strpos($tpl, $shortVarName) !== false;
  61.         $usesFirst = strpos($tpl, $varName.'first') !== false || strpos($tpl, $shortVarName.'first') !== false;
  62.         $usesLast = strpos($tpl, $varName.'last') !== false || strpos($tpl, $shortVarName.'last') !== false;
  63.         $usesIndex = strpos($tpl, $varName.'index') !== false || strpos($tpl, $shortVarName.'index') !== false;
  64.         $usesIteration = $usesFirst || $usesLast || strpos($tpl, $varName.'iteration') !== false || strpos($tpl, $shortVarName.'iteration') !== false;
  65.         $usesShow = strpos($tpl, $varName.'show') !== false || strpos($tpl, $shortVarName.'show') !== false;
  66.         $usesTotal = $usesLast || strpos($tpl, $varName.'total') !== false || strpos($tpl, $shortVarName.'total') !== false;
  67.  
  68.         // gets foreach id
  69.         $cnt = self::$cnt++;
  70.  
  71.         // builds pre processing output for
  72.         $out = Dwoo_Compiler::PHP_OPEN . "\n".'$_for'.$cnt.'_from = $_for'.$cnt.'_src = '.$from.';'.
  73.                                         "\n".'$_for'.$cnt.'_to = '.$to.';'.
  74.                                         "\n".'$_for'.$cnt.'_step = abs('.$step.');'.
  75.                                         "\n".'$_for'.$cnt.'_skip = abs('.$skip.');'.
  76.                                         "\n".'if (is_numeric($_for'.$cnt.'_from) && !is_numeric($_for'.$cnt.'_to)) { $this->triggerError(\'For requires the <em>to</em> parameter when using a numerical <em>from</em>\'); }';
  77.         // adds foreach properties
  78.         if ($usesAny) {
  79.             $out .= "\n".'$this->globals["for"]['.$name.'] = array'."\n(";
  80.             if ($usesIndex) $out .="\n\t".'"index"        => 0,';
  81.             if ($usesIteration) $out .="\n\t".'"iteration"        => 1,';
  82.             if ($usesFirst) $out .="\n\t".'"first"        => null,';
  83.             if ($usesLast) $out .="\n\t".'"last"        => null,';
  84.             if ($usesShow) $out .="\n\t".'"show"        => ($this->isArray($_for'.$cnt.'_from, true)) || (is_numeric($_for'.$cnt.'_from) && $_for'.$cnt.'_from != $_for'.$cnt.'_to),';
  85.             if ($usesTotal) $out .="\n\t".'"total"        => $this->isArray($_for'.$cnt.'_from) ? count($_for'.$cnt.'_from) - $_for'.$cnt.'_skip : (is_numeric($_for'.$cnt.'_from) ? abs(($_for'.$cnt.'_to + 1 - $_for'.$cnt.'_from)/$_for'.$cnt.'_step) : 0),';
  86.             $out.="\n);\n".'$_for'.$cnt.'_glob =& $this->globals["for"]['.$name.'];';
  87.         }
  88.         // checks if foreach must be looped
  89.         $out .= "\n".'if ($this->isArray($_for'.$cnt.'_from, true) || (is_numeric($_for'.$cnt.'_from) && abs(($_for'.$cnt.'_from - $_for'.$cnt.'_to)/$_for'.$cnt.'_step) !== 0))'."\n{";
  90.         // iterates over keys
  91.         $out .= "\n\t".'if ($this->isArray($_for'.$cnt.'_from, true)) {
  92.         $_for'.$cnt.'_from = 0;
  93.         $_for'.$cnt.'_to = is_numeric($_for'.$cnt.'_to) ? $_for'.$cnt.'_to - $_for'.$cnt.'_step : count($_for'.$cnt.'_src)-1;
  94.     }
  95.     $_for'.$cnt.'_keys = array();
  96.     if (($_for'.$cnt.'_from + $_for'.$cnt.'_skip) <= $_for'.$cnt.'_to) {
  97.         for ($tmp=($_for'.$cnt.'_from + $_for'.$cnt.'_skip); $tmp <= $_for'.$cnt.'_to; $tmp += $_for'.$cnt.'_step)
  98.             $_for'.$cnt.'_keys[] = $tmp;
  99.     } else {
  100.         for ($tmp=($_for'.$cnt.'_from - $_for'.$cnt.'_skip); $tmp > $_for'.$cnt.'_to; $tmp -= $_for'.$cnt.'_step)
  101.             $_for'.$cnt.'_keys[] = $tmp;
  102.     }
  103.     foreach ($_for'.$cnt.'_keys as $this->scope['.$name.'])'."\n\t{";
  104.         // updates properties
  105.         if ($usesIndex) {
  106.             $out.="\n\t\t".'$_for'.$cnt.'_glob["index"] = $this->scope['.$name.'];';
  107.         }
  108.         if ($usesFirst) {
  109.             $out .= "\n\t\t".'$_for'.$cnt.'_glob["first"] = (string) ($_for'.$cnt.'_glob["iteration"] === 1);';
  110.         }
  111.         if ($usesLast) {
  112.             $out .= "\n\t\t".'$_for'.$cnt.'_glob["last"] = (string) ($_for'.$cnt.'_glob["iteration"] === $_for'.$cnt.'_glob["total"]);';
  113.         }
  114.         $out .= "\n/* -- for start output */\n".Dwoo_Compiler::PHP_CLOSE;
  115.  
  116.  
  117.         // build post processing output and cache it
  118.         $postOut = Dwoo_Compiler::PHP_OPEN . '/* -- for end output */';
  119.         // update properties
  120.         if ($usesIteration) {
  121.             $postOut.="\n\t\t".'$_for'.$cnt.'_glob["iteration"]+=1;';
  122.         }
  123.         // end loop
  124.         $postOut .= "\n\t}\n}\n".Dwoo_Compiler::PHP_CLOSE;
  125.  
  126.         if (isset($params['hasElse'])) {
  127.             $postOut .= $params['hasElse'];
  128.         }
  129.  
  130.         return $out . $content . $postOut;
  131.     }
  132. }

Documentation generated on Sun, 07 Sep 2008 23:57:48 +0200 by phpDocumentor 1.4.0