classes/pliterator.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2011 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program is distributed in the hope that it will be useful,        *
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  ***************************************************************************/
  21
  22 /** An iterator.
  23  */
  24 interface PlIterator
  25 {
  26     /** Fetch and return the next element of the iterator.
  27      * If no more element is available, return null.
  28      */
  29     public function next();
  30
  31     /** Return the number of element of the iterator.
  32      */
  33     public function total();
  34
  35     /** True if the current element is the first element.
  36      */
  37     public function first();
  38
  39     /** True if the current element is the last element.
  40      */
  41     public function last();
  42 }
  43
  44 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
  45 ?>