HeadFilter

Extends \BaseParamFilterReader Implements \ChainableReader

Reads the first <code>n</code> lines of a stream.

(Default is first 10 lines.)

Example:

Or:

   
author

Yannick Lecaillez

author

hans lellelid, hans@velum.net

version

$Id: 59ab5735aceef51a04aaeb8332da1cceb3fb1ea9 $

access

public

see
package

phing.filters

Methods

__construct

__construct(\Reader $in = null) 
inherited

Arguments

$in

\Reader

Scans the parameters list for the "lines" parameter and uses it to set the number of lines to be returned in the filtered stream.

_initialize() 

Creates a new HeadFilter using the passed in Reader for instantiation.

chain(\Reader $reader) : object

Arguments

$reader

\Reader

Response

object

A new filter based on this configuration, but filtering

    the specified reader.

Close stream.

close() 
inherited abstract
throws

if there is an error closing stream

Returns whether the end of file has been reached with input stream.

eof() : boolean
inherited

Response

boolean

Returns the initialized status.

getInitialized() : boolean
inherited

Response

boolean

whether or not the filter is initialized

Returns the number of lines to be returned in the filtered stream.

getLines() : integer

Response

integer

The number of lines to be returned in the filtered stream.

getParameters

getParameters() 
inherited

Returns the project this filter is part of.

getProject() : object
inherited

Response

object

The project this filter is part of

Returns the filename, url, etc. that is being read from.

getResource() : string
inherited abstract

This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.

Response

string

Convenience method to support logging in filters.

log(string $msg, integer $level = \Project::MSG_INFO) 
inherited

Arguments

$msg

string

Message to log.

$level

integer

Priority level.

If supported, places a "marker" (like a bookmark) at current stream position.

mark() 
inherited

A subsequent call to reset() will move stream position back to last marker (if supported).

Whether marking is supported.

markSupported() : boolean
inherited

Response

boolean

Read data from source.

read(integer $len = null) 
inherited abstract

If length is specified, then only that number of chars is read, otherwise stream is read until EOF.

Arguments

$len

integer

Reads a line of text ending with '\n' (or until the end of the stream).

readLine() : \the
inherited

The returned String retains the '\n'.

throws

if the underlying reader throws one during

                   reading

Response

\the

line read, or null if the end of the stream has already been reached

Is stream ready for reading.

ready() : boolean
inherited

Response

boolean

Reset the current position in stream to beginning or last mark (if supported).

reset() 
inherited

Sets the initialized status.

setInitialized(boolean $initialized) 
inherited

Arguments

$initialized

boolean

Whether or not the filter is initialized.

Sets the number of lines to be returned in the filtered stream.

setLines(integer $lines) 

Arguments

$lines

integer

the number of lines to be returned in the filtered stream.

setParameters

setParameters( $parameters) 
inherited

Arguments

$parameters

Sets the project to work with.

setProject(object $project) 
inherited

Arguments

$project

object

The project this filter is part of.

           Should not be <code>null</code>.

setReader

setReader(\Reader $in) 
inherited

Arguments

$in

\Reader

Move stream position relative to current pos.

skip(integer $n) 
inherited

Arguments

$n

integer

Constants

Parameter name for the number of lines to be returned.

LINES_KEY

Properties

Number of lines currently read in.

_linesRead : integer
var

Type(s)

integer

Number of lines to be returned in the filtered stream.

_lines : integer
var

Type(s)

integer

The passed in parameter array.

_parameters : 
inherited

Type(s)

Have the parameters passed been interpreted?

initialized : 
inherited

Type(s)

The Phing project this filter is part of.

project : 
inherited

Type(s)

in

in : \Reader
inherited
var

Type(s)

\Reader