CustomIteratorSupport.php

<?php

class CustomIteratorSupport implements TemplateIteratorProvider {

	protected $iteratorPos;
	protected $iteratorTotalItems;

	/**
	 * Set the current iterator properties - where we are on the iterator.
	 *
	 * @param int $pos position in iterator
	 * @param int $totalItems total number of items
	 */
	public function iteratorProperties($pos, $totalItems) {
		$this->iteratorPos        = $pos;
		$this->iteratorTotalItems = $totalItems;
	}

	/**
	 * @return array
	 */
	public static function get_template_iterator_variables() {
		return array('MultiplyPos');
	}

	/**
	 * Return the numerical position of this object in the container set, multiplied by the given amount
	 *
	 * @param int $startIndex Number to start count from.
	 * @param int $multiple Number to multiply the position by
	 * @return int
	 */
	public function MultiplyPos($startIndex = 1, $multiple = 1) {
		return ($this->iteratorPos + $startIndex) * $multiple;
	}

}