filters/HeadFilter.php
inherited
Classes
\HeadFilter
Reads the first <code>n</code> lines of a stream.
(Default is first 10 lines.)
<
p> Example:
Or:
- Implements
- \ChainableReader
- Parent(s)
- \BaseParamFilterReader < \BaseFilterReader < \FilterReader < \Reader
- See
- \FilterReader
- Access
- public
- Author
- Yannick Lecaillez
- Author
- hans lellelid, hans@velum.net
- Copyright
- © 2003 seasonfive. All rights reserved
- Version
- $Revision: 526 $ $Date: 2009-08-11 14:11:17 +0200 (Tue, 11 Aug 2009) $
Constants
Properties
integer
$_lines= '10'
Number of lines to be returned in the filtered stream.
10Details- Type
- integer
integer
$_linesRead= '0'
Number of lines currently read in.
0Details- Type
- integer
$_parameters= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \BaseParamFilterReader::$$_parameters
$initialized= 'false'
Have the parameters passed been interpreted?
Inherited from: \BaseFilterReader::$$initialized\BaseParamFilterReader::$$initializedfalseDetails- Type
- n/a
- Inherited_from
- \BaseFilterReader::$$initialized
- Inherited_from
- \BaseParamFilterReader::$$initialized
$project= 'null'
The Phing project this filter is part of.
Inherited from: \BaseFilterReader::$$project\BaseParamFilterReader::$$projectnullDetails- Type
- n/a
- Inherited_from
- \BaseFilterReader::$$project
- Inherited_from
- \BaseParamFilterReader::$$project
Methods
__construct(
\Reader $in
=
null
)
:
voidConstructor used by Phing's introspection mechanism.
Inherited from: \BaseFilterReader::__construct()\BaseParamFilterReader::__construct()The original filter reader is only used for chaining purposes, never for filtering purposes (and indeed it would be useless for filtering purposes, as it has no real data to filter). ChainedReaderHelper uses this placeholder instance to create a chain of real filters.
| Name | Type | Description |
|---|---|---|
| $in | \Reader |
_initialize(
)
:
voidScans the parameters list for the "lines" parameter and uses it to set the number of lines to be returned in the filtered stream.
chain(
object $reader
)
:
objectCreates a new HeadFilter using the passed in Reader for instantiation.
| Name | Type | Description |
|---|---|---|
| $reader | object | A Reader object providing the underlying stream. Must not be |
| Type | Description |
|---|---|
| object | A new filter based on this configuration, but filtering the specified reader. |
close(
)
:
voideof(
)
:
booleanReturns whether the end of file has been reached with input stream.
Inherited from: \BaseFilterReader::eof()\BaseParamFilterReader::eof()| Type | Description |
|---|---|
| boolean |
getInitialized(
)
:
booleanReturns the initialized status.
Inherited from: \BaseFilterReader::getInitialized()\BaseParamFilterReader::getInitialized()| Type | Description |
|---|---|
| boolean | whether or not the filter is initialized |
getLines(
)
:
integerReturns the number of lines to be returned in the filtered stream.
| Type | Description |
|---|---|
| integer | The number of lines to be returned in the filtered stream. |
getProject(
)
:
objectReturns the project this filter is part of.
Inherited from: \BaseFilterReader::getProject()\BaseParamFilterReader::getProject()| Type | Description |
|---|---|
| object | The project this filter is part of |
getResource(
)
:
voidlog(
string $msg, int $level
=
Project::MSG_INFO
)
:
voidConvenience method to support logging in filters.
Inherited from: \BaseFilterReader::log()\BaseParamFilterReader::log()| Name | Type | Description |
|---|---|---|
| $msg | string | Message to log. |
| $level | int | Priority level. |
mark(
)
:
void
markSupported(
)
:
voidread(
\off $len
=
null
)
:
\theReturns first n lines of stream.
| Name | Type | Description |
|---|---|---|
| $len | \off | Offset at which to start storing characters. |
| Type | Description |
|---|---|
| \the | resulting stream, or -1 if the end of the resulting stream has been reached |
| Exception | Description |
|---|---|
| \IOException | If an I/O error occurs |
- Exception
- IOException if the underlying stream throws an IOException during reading
readLine(
)
:
\theReads a line of text ending with '\n' (or until the end of the stream).
Inherited from: \BaseFilterReader::readLine()\BaseParamFilterReader::readLine()The returned String retains the '\n'.
| Type | Description |
|---|---|
| \the | line read, or <code>null</code> if the end of the stream has already been reached |
| Exception | Description |
|---|---|
| \IOException | if the underlying reader throws one during reading |
ready(
)
:
void
reset(
)
:
voidsetInitialized(
boolean $initialized
)
:
voidSets the initialized status.
Inherited from: \BaseFilterReader::setInitialized()\BaseParamFilterReader::setInitialized()| Name | Type | Description |
|---|---|---|
| $initialized | boolean | Whether or not the filter is initialized. |
setLines(
integer $lines
)
:
voidSets the number of lines to be returned in the filtered stream.
| Name | Type | Description |
|---|---|---|
| $lines | integer | the number of lines to be returned in the filtered stream. |
setParameters(
$parameters
)
:
void| Name | Type | Description |
|---|---|---|
| $parameters |
setProject(
object $project
)
:
voidSets the project to work with.
Inherited from: \BaseFilterReader::setProject()\BaseParamFilterReader::setProject()| Name | Type | Description |
|---|---|---|
| $project | object | The project this filter is part of. Should not be |
setReader(
)
:
voidskip(
)
:
void