XML_SaxFilters
[ class tree: XML_SaxFilters ] [ index: XML_SaxFilters ] [ all elements ]

Class: XML_SaxFilters_AbstractFilter

Source Location: /XML_SaxFilters-0.3.0/SaxFilters/AbstractFilter.php

Class Overview


Base class for Sax Filters to extend.


Author(s):

Variables

Methods


Child classes:

LanguageFilter
Base class for Sax Filters to extend.
UrlFilter
Base class for Sax Filters to extend.
WhitespaceFilter
Strips whitespace
TagsToLowerFilter
Converts tags and attribute names to lower case
HTMLFilter
Reconstructs the HTML - this filter is chained directly to the parser. By
SimpleFilter
Base class for Sax Filters to extend.
FormFilter
Base class for Sax Filters to extend.
LinkFilter
Base class for Sax Filters to extend.
StrongFilter
Base class for Sax Filters to extend.
EmFilter
Base class for Sax Filters to extend.
CodeFilter
Base class for Sax Filters to extend.
TextBlock
Base class for Sax Filters to extend.
NewLineFilter
Base class for Sax Filters to extend.
ListFilter
Base class for Sax Filters to extend.
ListItemFilter
Base class for Sax Filters to extend.
DataSetFilter
Filter for converting an XML data set to HTML

Inherited Variables

Inherited Methods


Class Details

[line 33]
Base class for Sax Filters to extend.

Provides methods for dealing with listeners, parents and writers.

  • Abstract:
  • Access: public


[ Top ]


Class Variables

$writer =

[line 55]

Stores the writer object
  • Var: implementing WriterInterface
  • See: XML_SaxFilters_IO_WriterInterface
  • Access: public

Type:   object class


[ Top ]



Method Detail

attachToParent   [line 108]

void attachToParent( object class &$child)

Calls the parent setChild() method allow a child filter

to set another child filter in the parent

  • Access: public

Parameters:

object class   &$child   —  or subclass of AbstractFilter

[ Top ]

close   [line 186]


data   [line 200]

void data( string &$data)

Sax character data handler
  • Access: protected

Overridden in child classes as:

LanguageFilter::data()
UrlFilter::data()
WhitespaceFilter::data()
HTMLFilter::data()
SimpleFilter::data()
FormFilter::data()
LinkFilter::data()
StrongFilter::data()
EmFilter::data()
CodeFilter::data()
TextBlock::data()
NewLineFilter::data()
ListFilter::data()
ListItemFilter::data()
DataSetFilter::data()
Character Data Handler

Parameters:

string   &$data   —  contents of element

[ Top ]

detachFromParent   [line 119]

void detachFromParent( )

Calls the parent unsetChild() method removing any child filter

from the parent

  • Access: public

[ Top ]

endDoc   [line 256]

void endDoc( )

End of parsing handler
  • Access: protected

Overridden in child classes as:

SimpleFilter::endDoc()
DataSetFilter::endDoc()
End of parsing

[ Top ]

escape   [line 229]

void escape( string &$data)

Escape handler (PEAR::XML_HTMLSax only)
  • Access: protected

Overridden in child classes as:

HTMLFilter::escape()

Parameters:

string   &$data   —  contents of escape

[ Top ]

getWriter   [line 140]

object class &getWriter( )

Unsets the writer
  • Return: implementing WriterInterface
  • Access: public

[ Top ]

jasp   [line 243]

void jasp( string &$data)

JSP/ASP markup handler (PEAR::XML_HTMLSax only)
  • Access: protected

Parameters:

string   &$data   —  contents of escape

[ Top ]

open   [line 172]

void open( string &$tag, array &$attribs)

Sax start element handler
  • Access: protected

Overridden in child classes as:

LanguageFilter::open()
UrlFilter::open()
WhitespaceFilter::open()
TagsToLowerFilter::open()
HTMLFilter::open()
SimpleFilter::open()
FormFilter::open()
LinkFilter::open()
StrongFilter::open()
EmFilter::open()
CodeFilter::open()
TextBlock::open()
NewLineFilter::open()
ListFilter::open()
ListItemFilter::open()
DataSetFilter::open()
Start Element Handler

Parameters:

string   &$tag   —  element tag name
array   &$attribs   —  element attributes

[ Top ]

pi   [line 215]

void pi( string &$target, string &$instruction)

Sax processing instruction handler
  • Access: protected

Parameters:

string   &$target   —  target processor
string   &$instruction   —  instruction for processor

[ Top ]

setChild   [line 63]

void setChild( object class &$child)

Sets the child filter to which events are delegated
  • Access: public

Parameters:

object class   &$child   —  or subclass of AbstractFilter

[ Top ]

setParent   [line 85]

void setParent( object class &$parent)

Sets the parent filter allow the child to talk back
  • Access: public

Parameters:

object class   &$parent   —  or subclass of AbstractFilter

[ Top ]

setWriter   [line 130]

void setWriter( object class &$writer)

Sets the writer
  • Access: public

Parameters:

object class   &$writer   —  implementing WriterInterface

[ Top ]

startDoc   [line 157]

void startDoc( )

Start of parsing handler
  • Access: protected

Overridden in child classes as:

SimpleFilter::startDoc()
DataSetFilter::startDoc()
Start of parsing

[ Top ]

unsetChild   [line 73]

void unsetChild( )

Unsets the child filter
  • Access: public

[ Top ]

unsetParent   [line 95]

void unsetParent( )

Breaks the connection to from the child to the parent filter.
  • Access: public

[ Top ]

__destroy   [line 150]

void __destroy( )

Called whenever a filter is unset. Provides a clean up state where

a filter can check parsing for errors

  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 10:15:10 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.