classes/core/ArrayItemIterator.inc.php

<?php

// $Id: ArrayItemIterator.inc.php,v 1.12 2008/07/01 01:16:09 asmecher Exp $


import('core.ItemIterator');

class ArrayItemIterator extends ItemIterator {
   var $theArray;

   var $itemsPerPage;

   var $page;

   var $count;

   var $wasEmpty;

   function ArrayItemIterator(&$theArray, $page=-1, $itemsPerPage=-1) {
      if ($page>=1 && $itemsPerPage>=1) {
         $this->theArray = $this->array_slice_key($theArray, ($page-1) * $itemsPerPage, $itemsPerPage);
         $this->page = $page;
      } else {
         $this->theArray = &$theArray;
         $this->page = 1;
         $this->itemsPerPage = max(count($this->theArray),1);
      }
      $this->count = count($theArray);
      $this->itemsPerPage = $itemsPerPage;
      $this->wasEmpty = count($this->theArray)==0;
      reset($this->theArray);
   }

   function &next() {
      if (!is_array($this->theArray)) {
         $value = null;
         return $value;
      }
      $value = current($this->theArray);
      if (next($this->theArray)==null) {
         $this->theArray = null;
      }
      return $value;
   }

   function &nextWithKey() {
      $key = key($this->theArray);
      $value = $this->next();
      return array($key, $value);
   }

   function atFirstPage() {
      return $this->page==1;
   }

   function atLastPage() {
      return ($this->page * $this->itemsPerPage) + 1 > $this->count;
   }

   function getPage() {
      return $this->page;
   }

   function getCount() {
      return $this->count;
   }

   function getPageCount() {
      return max(1, ceil($this->count / $this->itemsPerPage));
   }

   function eof() {
      return (($this->theArray == null) || (count($this->theArray)==0));
   }

   function wasEmpty() {
      return $this->wasEmpty;
   }

   function &toArray() {
      return $this->theArray;
   }

   function array_slice_key($array, $offset, $len=-1) {
      // A version of array_slice that takes keys into account.
      // Thanks to pies at sputnik dot pl. (Retrieved from
      // http://ca3.php.net/manual/en/function.array-slice.php)

      // This is made redundant by PHP 5.0.2's updated
      // array_slice, but we can't assume everyone has that.

      if (!is_array($array)) return false;

      $return = array();
      $length = $len >= 0? $len: count($array);
      $keys = array_slice(array_keys($array), $offset, $length);
      foreach($keys as $key) {
         $return[$key] = $array[$key];
      }

      return $return;
   }

   function isInBounds() {
      return ($this->getPageCount() >= $this->page);
   }

   function &getLastPageRangeInfo() {
      import('db.DBResultRange');
      $returner =& new DBResultRange(
         $this->itemsPerPage,
         $this->getPageCount()
      );
      return $returner;
   }
}

?>

---