util 
[ doc home ] [ class tree: util ] [ index: util ] [ all elements ]

Class: IsterBufferFilter

Source Location: /IsterBufferFilter.php

Class Overview

IsterObject
   |
   --IsterBufferFilter

This class represents a filter to apply to a buffer.


Author(s): Ingo Schramm   

Copyright: Copyright (c) 2005 Ister.ORG Ingo Schramm

Variables

Methods


Child classes:

IsterHttpResponseFilter
This class represents a filter to apply to a HTTP response.

Inherited Constants

Inherited Variables

Inherited Methods

Class: IsterObject

IsterObject::IsterObject()
Constructor
IsterObject::abstractMethodError()
Report attempt to call an abstract method.
IsterObject::addLogger()
Add an IsterLogger to process log messages.
IsterObject::deleteLogger()
Delete an already registered IsterLogger.
IsterObject::getLoggerNames()
Fetch the names of all currently registered IsterLoggers.
IsterObject::getMem()
Return maximum amount of memory an application has allocated at this point.
IsterObject::log()
Trigger a log message.
IsterObject::passPHPmessage()
Catch PHP E_WARNING and E_NOTICE messages.
IsterObject::serialize()
Serialize the object.
IsterObject::setLogLocal()
Set logging local for the current object.
IsterObject::setupLogger()
Setup a logger.
IsterObject::triggerError()
Alias for log();
IsterObject::unserialize()
Unserialize the object.
IsterObject::__sleep()
Executed prior to serialize().
IsterObject::__wakeup()
Executed prior to unserialize().

Class Details

This class represents a filter to apply to a buffer.

Note that only subclasses of IsterStreamFilter can really filter a buffer since this class returns the buffer completely unchanged.


copyright:  Copyright (c) 2005 Ister.ORG Ingo Schramm
author:  Ingo Schramm


[ Top ]


Class Variables

protected string $name Name of this object.
[ Top ]



Class Methods


constructor IsterBufferFilter

IsterBufferFilter IsterBufferFilter( string $name)

Constructor

Parameters:

string   $name   The name of the filter.

[ Top ]

method apply

string apply( string $buffer)

Apply the filter to a given buffer.

Note: This method returns the buffer unchanged. You must overwrite this method to make something happen.


Parameters:

string   $buffer  

[ Top ]

method getName

string getName( )

Get the name of this filter.

[ Top ]


Documentation generated on Tue, 20 Dec 2005 11:20:40 +0100 by phpDocumentor 1.3.0RC4