X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Finterfaces%2Fio%2Fpointer%2Fclass_InputPointer.php;h=c38cdd5bd755185f82c6d1342f30a1bae9f4e11c;hp=3a53fb18dbb1a9cb0315b5db86171e88f047e1f6;hb=1a91dabdfed365947d1ce11675aacae9d424edff;hpb=a863937b246c06e143d147fe4108543056971472 diff --git a/inc/classes/interfaces/io/pointer/class_InputPointer.php b/inc/classes/interfaces/io/pointer/class_InputPointer.php index 3a53fb18..c38cdd5b 100644 --- a/inc/classes/interfaces/io/pointer/class_InputPointer.php +++ b/inc/classes/interfaces/io/pointer/class_InputPointer.php @@ -4,7 +4,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.shipsimu.org * @@ -21,24 +21,31 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -interface InputPointer extends StreamableInput, Pointer { +interface InputPointer extends StreamableInput, FilePointer { /** * Read data a file pointer * - * @return mixed The result of fread() - * @throws NullPointerException If the file pointer instance - * is not set by setPointer() - * @throws InvalidResourceException If there is being set + * @return $data Read data from file */ function readFromFile (); + /** + * Reads a line, maximum 4096 Bytes from current file pointer + * + * @return $data Read data from file + */ + function readLine (); + /** * Reads given amount of bytes from file. * - * @param $bytes Amount of bytes to read + * @param $bytes Amount of bytes to read or whole line (only text files) * @return $data Data read from file + * @throws NullPointerException If the file pointer instance + * is not set by setPointer() + * @throws InvalidResourceException If there is being set */ - function read ($bytes); + function read ($bytes = NULL); } // [EOF]