| 1 |
lars |
1 |
<?php
|
|
|
2 |
/*
|
|
|
3 |
* $Id: Reader.php 227 2007-08-28 02:17:00Z hans $
|
|
|
4 |
*
|
|
|
5 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
6 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
7 |
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
8 |
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
9 |
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
10 |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
11 |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
12 |
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
13 |
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
14 |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
15 |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
16 |
*
|
|
|
17 |
* This software consists of voluntary contributions made by many individuals
|
|
|
18 |
* and is licensed under the LGPL. For more information please see
|
|
|
19 |
* <http://phing.info>.
|
|
|
20 |
*/
|
|
|
21 |
|
|
|
22 |
/**
|
|
|
23 |
* Abstract class for reading character streams.
|
|
|
24 |
*
|
|
|
25 |
* @author Hans Lellelid <hans@xmpl.org>
|
|
|
26 |
* @author Yannick Lecaillez <yl@seasonfive.com>
|
|
|
27 |
* @version $Revision: 1.5 $
|
|
|
28 |
* @package phing.system.io
|
|
|
29 |
*/
|
|
|
30 |
abstract class Reader {
|
|
|
31 |
|
|
|
32 |
/**
|
|
|
33 |
* Read data from source.
|
|
|
34 |
*
|
|
|
35 |
* If length is specified, then only that number of chars is read,
|
|
|
36 |
* otherwise stream is read until EOF.
|
|
|
37 |
*
|
|
|
38 |
* @param int $len
|
|
|
39 |
*/
|
|
|
40 |
abstract public function read($len = null);
|
|
|
41 |
|
|
|
42 |
/**
|
|
|
43 |
* Close stream.
|
|
|
44 |
* @throws IOException if there is an error closing stream
|
|
|
45 |
*/
|
|
|
46 |
abstract public function close();
|
|
|
47 |
|
|
|
48 |
/**
|
|
|
49 |
* Returns the filename, url, etc. that is being read from.
|
|
|
50 |
* This is critical for, e.g., ExpatParser's ability to know
|
|
|
51 |
* the filename that is throwing an ExpatParserException, etc.
|
|
|
52 |
* @return string
|
|
|
53 |
*/
|
|
|
54 |
abstract function getResource();
|
|
|
55 |
|
|
|
56 |
/**
|
|
|
57 |
* Move stream position relative to current pos.
|
|
|
58 |
* @param int $n
|
|
|
59 |
*/
|
|
|
60 |
public function skip($n) {}
|
|
|
61 |
|
|
|
62 |
/**
|
|
|
63 |
* Reset the current position in stream to beginning or last mark (if supported).
|
|
|
64 |
*/
|
|
|
65 |
public function reset() {}
|
|
|
66 |
|
|
|
67 |
/**
|
|
|
68 |
* If supported, places a "marker" (like a bookmark) at current stream position.
|
|
|
69 |
* A subsequent call to reset() will move stream position back
|
|
|
70 |
* to last marker (if supported).
|
|
|
71 |
*/
|
|
|
72 |
public function mark() {}
|
|
|
73 |
|
|
|
74 |
/**
|
|
|
75 |
* Whether marking is supported.
|
|
|
76 |
* @return boolean
|
|
|
77 |
*/
|
|
|
78 |
public function markSupported() {
|
|
|
79 |
return false;
|
|
|
80 |
}
|
|
|
81 |
|
|
|
82 |
/**
|
|
|
83 |
* Is stream ready for reading.
|
|
|
84 |
* @return boolean
|
|
|
85 |
*/
|
|
|
86 |
public function ready() {
|
|
|
87 |
return true;
|
|
|
88 |
}
|
|
|
89 |
|
|
|
90 |
}
|
|
|
91 |
|