<?php
/* $Id$ */
namespace Mammut\IO;

use Mammut\Exception\IllegalStateException;

(defined('MAMMUT') && (basename(__FILE__) != basename($_SERVER['PHP_SELF']))) or die('ACCESS DENIED');

/**
 * Text IO line reading interface.
 *
 * @since 1.1.0.0
 * @author Stefan Daurer <s.daurer@q-spot.org>
 * @package Mammut\IO
 */
interface iLineReader {

	/**
	 * Reads the next line into a string
	 *
	 * @param $trim boolean
	 *        	TRUE if the line separator should be removed. If set to false, all NL and CR characters will be removed.
	 *        	
	 * @throws \Mammut\Exception\IllegalStateException if file is not open for writing
	 * @return mixed string line or false on EOF
	 */
	public function readLine($trim = TRUE);
}