filters/TidyFilter.php

Show:

inherited

Classes
- \TidyFilter

Table of Contents

\TidyFilter
jump to top

Package: phing\filters

This filter uses the bundled-with-PHP Tidy extension to filter input.

p> Example:<br/>

Implements: \ChainableReader
Parent(s): \BaseParamFilterReader < \BaseFilterReader < \FilterReader < \Reader
Author: Hans Lellelid
Copyright: © 2003 seasonfive. All rights reserved
Version: $Revision: 552 $ $Date: 2009-08-29 14:18:13 +0200 (Sat, 29 Aug 2009) $

Properties


                 $_parameters= 'array()'

inherited

The passed in parameter array.

Inherited from: \BaseParamFilterReader::$$_parameters

Default valuearray()Details

Type: n/a
Inherited_from: \BaseParamFilterReader::$$_parameters

array
                 $configParameters= 'array()'

Parameter[]

Default valuearray()Details

Type: array

string
                 $encoding= ''utf8''

Encoding of resulting document.

Default value'utf8'Details

Type: string


                 $initialized= 'false'

inherited

Have the parameters passed been interpreted?

Inherited from: \BaseFilterReader::$$initialized \BaseParamFilterReader::$$initialized

Default valuefalseDetails

Type: n/a
Inherited_from: \BaseFilterReader::$$initialized
Inherited_from: \BaseParamFilterReader::$$initialized


                 $project= 'null'

inherited

The Phing project this filter is part of.

Inherited from: \BaseFilterReader::$$project \BaseParamFilterReader::$$project

Default valuenullDetails

Type: n/a
Inherited_from: \BaseFilterReader::$$project
Inherited_from: \BaseParamFilterReader::$$project

Methods

__construct(
          \Reader $in
              =
              null
          )
        
        :
          void

inherited

Constructor 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.

Parameters

Name	Type	Description
$in	\Reader

_initialize(
          
          )
        
        :
          void

Initializes any parameters (e.g. config options).

This method is only called when this filter is used through a tag in build file.

chain(
          \reader $reader
          )
        
        :
          \a

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

Parameters

Name	Type	Description
$reader	\reader	A Reader object providing the underlying stream. Must not be `null`.

Returns

Type	Description
\a	new filter based on this configuration, but filtering the specified reader

inherited

Inherited from: FilterReader::close()\BaseFilterReader::close()\BaseParamFilterReader::close()

createConfig(
          
          )
        
        :
          \Parameter

Adds a element (which is a Parameter).

Returns

Type	Description
\Parameter

eof(
          
          )
        
        :
          boolean

inherited

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

Inherited from: \BaseFilterReader::eof()\BaseParamFilterReader::eof()

Returns

Type	Description
boolean

getDistilledConfig(
          
          )
        
        :
          array

Converts the Parameter objects being used to store configuration into a simle assoc array.

Returns

Type	Description
array

getInitialized(
          
          )
        
        :
          boolean

inherited

Returns the initialized status.

Inherited from: \BaseFilterReader::getInitialized()\BaseParamFilterReader::getInitialized()

Returns

Type	Description
boolean	whether or not the filter is initialized

getParameters(
          
          )
        
        :
          void

inherited

Inherited from: \BaseParamFilterReader::getParameters()

getProject(
          
          )
        
        :
          object

inherited

Returns the project this filter is part of.

Inherited from: \BaseFilterReader::getProject()\BaseParamFilterReader::getProject()

Returns

Type	Description
object	The project this filter is part of

getResource(
          
          )
        
        :
          void

inherited

Inherited from: FilterReader::getResource()\BaseFilterReader::getResource()\BaseParamFilterReader::getResource()

log(
          string $msg, int $level
              =
              Project::MSG_INFO
          )
        
        :
          void

inherited

Convenience method to support logging in filters.

Inherited from: \BaseFilterReader::log()\BaseParamFilterReader::log()

Parameters

Name	Type	Description
$msg	string	Message to log.
$level	int	Priority level.

inherited

Inherited from: Reader::mark()\BaseFilterReader::mark()\BaseParamFilterReader::mark()

markSupported(
          
          )
        
        :
          void

inherited

Inherited from: Reader::markSupported()\BaseFilterReader::markSupported()\BaseParamFilterReader::markSupported()

read(
          \off $len
              =
              null
          )
        
        :
          \the

Reads input and returns Tidy-filtered output.

Parameters

Name	Type	Description
$len	\off	Offset at which to start storing characters.

Returns

Type	Description
\the	resulting stream, or -1 if the end of the resulting stream has been reached

Throws

Exception	Description
\IOException	if the underlying stream throws an IOException during reading

readLine(
          
          )
        
        :
          \the

inherited

Reads 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'.

Returns

Type	Description
\the	line read, or <code>null</code> if the end of the stream has already been reached

Throws

Exception	Description
\IOException	if the underlying reader throws one during reading

inherited

Inherited from: Reader::ready()\BaseFilterReader::ready()\BaseParamFilterReader::ready()

inherited

Inherited from: FilterReader::reset()\BaseFilterReader::reset()\BaseParamFilterReader::reset()

setConfigParameters(
          array $params
          )
        
        :
          void

Sets the config params.

Parameters

Name	Type	Description
$params	array	Parameter[]

Details

See: \chain()

setEncoding(
          string $v
          )
        
        :
          void

Set the encoding for resulting (X)HTML document.

Parameters

Name	Type	Description
$v	string

setInitialized(
          boolean $initialized
          )
        
        :
          void

inherited

Sets the initialized status.

Inherited from: \BaseFilterReader::setInitialized()\BaseParamFilterReader::setInitialized()

Parameters

Name	Type	Description
$initialized	boolean	Whether or not the filter is initialized.

setParameters(
           $parameters
          )
        
        :
          void

inherited

Inherited from: \BaseParamFilterReader::setParameters()

Parameters

Name	Type	Description
$parameters

setProject(
          object $project
          )
        
        :
          void

inherited

Sets the project to work with.

Inherited from: \BaseFilterReader::setProject()\BaseParamFilterReader::setProject()

Parameters

Name	Type	Description
$project	object	The project this filter is part of. Should not be `null`.

setReader(
          
          )
        
        :
          void

inherited

Inherited from: FilterReader::setReader()\BaseFilterReader::setReader()\BaseParamFilterReader::setReader()

inherited

Inherited from: FilterReader::skip()\BaseFilterReader::skip()\BaseParamFilterReader::skip()

filters/TidyFilter.php

\TidyFilterjump to top

Properties

Methods

\TidyFilter
jump to top