File: lib/plugins/function.cycle.php

Recommend this page to a friend!
  Classes of David Tamas  >  g-template-php  >  lib/plugins/function.cycle.php  >  Download  
File: lib/plugins/function.cycle.php
Role: Example script
Content type: text/plain
Description: Example script
Class: g-template-php
Process and render templates generating PHP code
Author: By
Last change:
Date: 2 years ago
Size: 3,379 bytes
 

 

Contents

Class file image Download
<?php
/**
 * gTemplate Plugins
 *
 * @package gTemplate
 * @subpackage Plugins
 */

/**
 * gTemplate {cycle} function plugin
 *
 * Type: function<br>
 * Name: cycle<br>
 * Purpose: cycle through given values<br>
 * Input:
 * - name = name of cycle (optional)
 * - values = comma separated list of values to cycle,
 * or an array of values to cycle
 * (this can be left out for subsequent calls)
 * - reset = boolean - resets given var to true
 * - print = boolean - print var or not. default is true
 * - advance = boolean - whether or not to advance the cycle
 * - delimiter = the value delimiter, default is ","
 * - assign = boolean, assigns to template var instead of
 * printed.
 *
 * Examples:<br>
 * <pre>
 * {cycle values="#eeeeee,#d0d0d0d"}
 * {cycle name=row values="one,two,three" reset=true}
 * {cycle name=row}
 * </pre>
 *
 * @version 1.0
 * @author Tamas David (G-Lex) <glex at mittudomain.info>
 * @link https://github.com/glex86/g-template-php G-Template Engine on Github
 *
 * @internal Some source codes are taken from Smarty
 * @internal author Monte Ohrt <monte at ohrt dot com>
 * @internal author credit to Mark Priatel <mpriatel@rogers.com>
 * @internal author credit to Gerard <gerard@interfold.com>
 * @internal author credit to Jason Sweat <jsweat_php@yahoo.com>
 * @internal internal link http://smarty.net Smarty
 */
function tpl_function_cycle($params, &$gTpl)
{
    static
$cycle_vars;
   
   
$name = (empty($params['name'])) ? 'default' : $params['name'];
   
$print = (isset($params['print'])) ? (bool)$params['print'] : true;
   
$advance = (isset($params['advance'])) ? (bool)$params['advance'] : true;
   
$reset = (isset($params['reset'])) ? (bool)$params['reset'] : false;
           
    if (!
in_array('values', array_keys($params))) {
        if(!isset(
$cycle_vars[$name]['values'])) {
           
$gTpl->trigger_error("cycle: missing 'values' parameter");
            return;
        }
    } else {
        if(isset(
$cycle_vars[$name]['values'])
            &&
$cycle_vars[$name]['values'] != $params['values'] ) {
           
$cycle_vars[$name]['index'] = 0;
        }
       
$cycle_vars[$name]['values'] = $params['values'];
    }

    if (isset(
$params['delimiter'])) {
       
$cycle_vars[$name]['delimiter'] = $params['delimiter'];
    } elseif (!isset(
$cycle_vars[$name]['delimiter'])) {
       
$cycle_vars[$name]['delimiter'] = ',';
    }
   
    if(
is_array($cycle_vars[$name]['values'])) {
       
$cycle_array = $cycle_vars[$name]['values'];
    } else {
       
$cycle_array = explode($cycle_vars[$name]['delimiter'],$cycle_vars[$name]['values']);
    }
   
    if(!isset(
$cycle_vars[$name]['index']) || $reset ) {
       
$cycle_vars[$name]['index'] = 0;
    }
   
    if (isset(
$params['assign'])) {
       
$print = false;
       
$gTpl->assign($params['assign'], $cycle_array[$cycle_vars[$name]['index']]);
    }
       
    if(
$print) {
       
$retval = $cycle_array[$cycle_vars[$name]['index']];
    } else {
       
$retval = null;
    }

    if(
$advance) {
        if (
$cycle_vars[$name]['index'] >= count($cycle_array) -1 ) {
           
$cycle_vars[$name]['index'] = 0;
        } else {
           
$cycle_vars[$name]['index']++;
        }
    }
   
    return
$retval;
}


For more information send a message to info at phpclasses dot org.