[platal.git] / classes / pliterator.php

<?php
/***************************************************************************
 *  Copyright (C) 2003-2011 Polytechnique.org                              *
 *  http://opensource.polytechnique.org/                                   *
 *                                                                         *
 *  This program is free software; you can redistribute it and/or modify   *
 *  it under the terms of the GNU General Public License as published by   *
 *  the Free Software Foundation; either version 2 of the License, or      *
 *  (at your option) any later version.                                    *
 *                                                                         *
 *  This program is distributed in the hope that it will be useful,        *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
 *  GNU General Public License for more details.                           *
 *                                                                         *
 *  You should have received a copy of the GNU General Public License      *
 *  along with this program; if not, write to the Free Software            *
 *  Foundation, Inc.,                                                      *
 *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
 ***************************************************************************/

/** An iterator.
 */
interface PlIterator
{
    /** Fetch and return the next element of the iterator.
     * If no more element is available, return null.
     */
    public function next();

    /** Return the number of element of the iterator.
     */
    public function total();

    /** True if the current element is the first element.
     */
    public function first();

    /** True if the current element is the last element.
     */
    public function last();
}

// vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
?>
Commit	Line	Data
2b1ee50b	1	<?php
2b1ee50b	2	/***************************************************************************
e92ecb8c	3	* Copyright (C) 2003-2011 Polytechnique.org *
2b1ee50b	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
5177a1b5 FB	22	/** An iterator.
5177a1b5 FB	23	*/
2b1ee50b	24	interface PlIterator
2b1ee50b	25	{
5177a1b5 FB	26	/** Fetch and return the next element of the iterator.
	27	* If no more element is available, return null.
	28	*/
2b1ee50b	29	public function next();
5177a1b5 FB	30
	31	/** Return the number of element of the iterator.
	32	*/
2b1ee50b	33	public function total();
5177a1b5 FB	34
	35	/** True if the current element is the first element.
	36	*/
2b1ee50b	37	public function first();
5177a1b5 FB	38
	39	/** True if the current element is the last element.
	40	*/
2b1ee50b	41	public function last();
	42	}
	43
fa7ffd66	44	// vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
2b1ee50b	45	?>