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 : for name to access it's iterator variables through {$.for.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.  * </pre>
  11.  * This software is provided 'as-is', without any express or implied warranty.
  12.  * In no event will the authors be held liable for any damages arising from the use of this software.
  13.  *
  14.  * @author     Jordi Boggiano <j.boggiano@seld.be>
  15.  * @copyright  Copyright (c) 2008, Jordi Boggiano
  16.  * @license    http://dwoo.org/LICENSE   Modified BSD License
  17.  * @link       http://dwoo.org/
  18.  * @version    1.0.0
  19.  * @date       2008-10-23
  20.  * @package    Dwoo
  21.  */
  22. class Dwoo_Plugin_for extends Dwoo_Block_Plugin implements Dwoo_ICompilable_Block, Dwoo_IElseable
  23. {
  24.     public static $cnt=0;
  25.  
  26.     public function init($name, $from, $to=null, $step=1, $skip=0)
  27.     {
  28.     }
  29.  
  30.     public static function preProcessing(Dwoo_Compiler $compiler, array $params, $prepend, $append, $type)
  31.     {
  32.         // get block params and save the current template pointer to use it in the postProcessing method
  33.         $currentBlock =& $compiler->getCurrentBlock();
  34.         $currentBlock['params']['tplPointer'] = $compiler->getPointer();
  35.  
  36.         return '';
  37.     }
  38.  
  39.     public static function postProcessing(Dwoo_Compiler $compiler, array $params, $prepend, $append, $content)
  40.     {
  41.         $params = $compiler->getCompiledParams($params);
  42.         $tpl = $compiler->getTemplateSource($params['tplPointer']);
  43.  
  44.         // assigns params
  45.         $from = $params['from'];
  46.         $name = $params['name'];
  47.         $step = $params['step'];
  48.         $to = $params['to'];
  49.  
  50.          // evaluates which global variables have to be computed
  51.         $varName = '$dwoo.for.'.trim($name, '"\'').'.';
  52.         $shortVarName = '$.for.'.trim($name, '"\'').'.';
  53.         $usesAny = strpos($tpl, $varName) !== false || strpos($tpl, $shortVarName) !== false;
  54.         $usesFirst = strpos($tpl, $varName.'first') !== false || strpos($tpl, $shortVarName.'first') !== false;
  55.         $usesLast = strpos($tpl, $varName.'last') !== false || strpos($tpl, $shortVarName.'last') !== false;
  56.         $usesIndex = strpos($tpl, $varName.'index') !== false || strpos($tpl, $shortVarName.'index') !== false;
  57.         $usesIteration = $usesFirst || $usesLast || strpos($tpl, $varName.'iteration') !== false || strpos($tpl, $shortVarName.'iteration') !== false;
  58.         $usesShow = strpos($tpl, $varName.'show') !== false || strpos($tpl, $shortVarName.'show') !== false;
  59.         $usesTotal = $usesLast || strpos($tpl, $varName.'total') !== false || strpos($tpl, $shortVarName.'total') !== false;
  60.  
  61.         // gets foreach id
  62.         $cnt = self::$cnt++;
  63.  
  64.         // builds pre processing output for
  65.         $out = Dwoo_Compiler::PHP_OPEN . "\n".'$_for'.$cnt.'_from = '.$from.';'.
  66.                                         "\n".'$_for'.$cnt.'_to = '.$to.';'.
  67.                                         "\n".'$_for'.$cnt.'_step = abs('.$step.');'.
  68.                                         "\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>\'); }'.
  69.                                         "\n".'$tmp_shows = $this->isArray($_for'.$cnt.'_from, true) || (is_numeric($_for'.$cnt.'_from) && (abs(($_for'.$cnt.'_from - $_for'.$cnt.'_to)/$_for'.$cnt.'_step) !== 0 || $_for'.$cnt.'_from == $_for'.$cnt.'_to));';
  70.         // adds foreach properties
  71.         if ($usesAny) {
  72.             $out .= "\n".'$this->globals["for"]['.$name.'] = array'."\n(";
  73.             if ($usesIndex) $out .="\n\t".'"index"        => 0,';
  74.             if ($usesIteration) $out .="\n\t".'"iteration"        => 1,';
  75.             if ($usesFirst) $out .="\n\t".'"first"        => null,';
  76.             if ($usesLast) $out .="\n\t".'"last"        => null,';
  77.             if ($usesShow) $out .="\n\t".'"show"        => $tmp_shows,';
  78.             if ($usesTotal) $out .="\n\t".'"total"        => $this->isArray($_for'.$cnt.'_from) ? floor(count($_for'.$cnt.'_from) / $_for'.$cnt.'_step) : (is_numeric($_for'.$cnt.'_from) ? abs(($_for'.$cnt.'_to + 1 - $_for'.$cnt.'_from)/$_for'.$cnt.'_step) : 0),';
  79.             $out.="\n);\n".'$_for'.$cnt.'_glob =& $this->globals["for"]['.$name.'];';
  80.         }
  81.         // checks if for must be looped
  82.         $out .= "\n".'if ($tmp_shows)'."\n{";
  83.         // set from/to to correct values if an array was given
  84.         $out .= "\n\t".'if ($this->isArray($_for'.$cnt.'_from, true)) {
  85.         $_for'.$cnt.'_to = is_numeric($_for'.$cnt.'_to) ? $_for'.$cnt.'_to - $_for'.$cnt.'_step : count($_for'.$cnt.'_from) - 1;
  86.         $_for'.$cnt.'_from = 0;
  87.     }';
  88.     // reverse from and to if needed
  89.     $out .= "\n\t".'if ($_for'.$cnt.'_from > $_for'.$cnt.'_to) {
  90.         $tmp = $_for'.$cnt.'_from;
  91.         $_for'.$cnt.'_from = $_for'.$cnt.'_to;
  92.         $_for'.$cnt.'_to = $tmp;
  93.     }
  94.     for ($this->scope['.$name.'] = $_for'.$cnt.'_from; $this->scope['.$name.'] <= $_for'.$cnt.'_to; $this->scope['.$name.'] += $_for'.$cnt.'_step)'."\n\t{";
  95.         // updates properties
  96.         if ($usesIndex) {
  97.             $out.="\n\t\t".'$_for'.$cnt.'_glob["index"] = $this->scope['.$name.'];';
  98.         }
  99.         if ($usesFirst) {
  100.             $out .= "\n\t\t".'$_for'.$cnt.'_glob["first"] = (string) ($_for'.$cnt.'_glob["iteration"] === 1);';
  101.         }
  102.         if ($usesLast) {
  103.             $out .= "\n\t\t".'$_for'.$cnt.'_glob["last"] = (string) ($_for'.$cnt.'_glob["iteration"] === $_for'.$cnt.'_glob["total"]);';
  104.         }
  105.         $out .= "\n/* -- for start output */\n".Dwoo_Compiler::PHP_CLOSE;
  106.  
  107.  
  108.         // build post processing output and cache it
  109.         $postOut = Dwoo_Compiler::PHP_OPEN . '/* -- for end output */';
  110.         // update properties
  111.         if ($usesIteration) {
  112.             $postOut.="\n\t\t".'$_for'.$cnt.'_glob["iteration"]+=1;';
  113.         }
  114.         // end loop
  115.         $postOut .= "\n\t}\n}\n".Dwoo_Compiler::PHP_CLOSE;
  116.  
  117.         if (isset($params['hasElse'])) {
  118.             $postOut .= $params['hasElse'];
  119.         }
  120.  
  121.         return $out . $content . $postOut;
  122.     }
  123. }

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