HTML::Filter(3) User Contributed Perl Documentation HTML::Filter(3)NAME
HTML::Filter - Filter HTML text through the parser
NOTE
This module is deprecated. The "HTML::Parser" now provides the functionally of "HTML::Filter" much more efficiently with the the "default"
handler.
SYNOPSIS
require HTML::Filter;
$p = HTML::Filter->new->parse_file("index.html");
DESCRIPTION
"HTML::Filter" is an HTML parser that by default prints the original text of each HTML element (a slow version of cat(1) basically). The
callback methods may be overridden to modify the filtering for some HTML elements and you can override output() method which is called to
print the HTML text.
"HTML::Filter" is a subclass of "HTML::Parser". This means that the document should be given to the parser by calling the $p->parse() or
$p->parse_file() methods.
EXAMPLES
The first example is a filter that will remove all comments from an HTML file. This is achieved by simply overriding the comment method to
do nothing.
package CommentStripper;
require HTML::Filter;
@ISA=qw(HTML::Filter);
sub comment { } # ignore comments
The second example shows a filter that will remove any <TABLE>s found in the HTML file. We specialize the start() and end() methods to
count table tags and then make output not happen when inside a table.
package TableStripper;
require HTML::Filter;
@ISA=qw(HTML::Filter);
sub start
{
my $self = shift;
$self->{table_seen}++ if $_[0] eq "table";
$self->SUPER::start(@_);
}
sub end
{
my $self = shift;
$self->SUPER::end(@_);
$self->{table_seen}-- if $_[0] eq "table";
}
sub output
{
my $self = shift;
unless ($self->{table_seen}) {
$self->SUPER::output(@_);
}
}
If you want to collect the parsed text internally you might want to do something like this:
package FilterIntoString;
require HTML::Filter;
@ISA=qw(HTML::Filter);
sub output { push(@{$_[0]->{fhtml}}, $_[1]) }
sub filtered_html { join("", @{$_[0]->{fhtml}}) }
SEE ALSO
HTML::Parser
COPYRIGHT
Copyright 1997-1999 Gisle Aas.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
perl v5.18.2 2013-03-25 HTML::Filter(3)
Check Out this Related Man Page
HTML::FormFu::Filter(3pm) User Contributed Perl Documentation HTML::FormFu::Filter(3pm)NAME
HTML::FormFu::Filter - Filter Base Class
SYNOPSIS ---
elements:
- type: Text
name: foo
filters:
- type: Encode
candidates:
- utf8
- Hebrew
- type: Text
name: bar
filters:
- LowerCase
- Encode
filters:
- TrimEdges
DESCRIPTION
"filters()" and "filter" can be called on any form, block element (includes fieldsets) or field element.
If called on a field element, no "name" argument should be passed.
If called on a form or block element, if no "name" argument is provided, a new filter is created for and added to every field on that form
or block.
See "FORM LOGIC AND VALIDATION" in HTML::FormFu for further details.
METHODS
type
Returns the "type" argument originally used to create the filter.
localise_args
Provide arguments that should be passed to localize to replace "[_1]", "[_2]", etc. in the localized string.
parent
Returns the HTML::FormFu::Element::_Field object that the filter is associated with.
get_parent
Arguments: \%options
Traverses the parent hierarchy, returning the first parent that matches the supplied options.
form
Returns the HTML::FormFu object that the filter's field is attached to.
name
Shorthand for "$filter->parent->name"
CORE FILTERS
HTML::FormFu::Filter::Callback
HTML::FormFu::Filter::CompoundJoin
HTML::FormFu::Filter::CompoundSprintf
HTML::FormFu::Filter::CopyValue
HTML::FormFu::Filter::Default
HTML::FormFu::Filter::Encode
HTML::FormFu::Filter::FormatNumber
HTML::FormFu::Filter::HTMLEscape
HTML::FormFu::Filter::HTMLScrubber
HTML::FormFu::Filter::LowerCase
HTML::FormFu::Filter::NonNumeric
HTML::FormFu::Filter::Regex
HTML::FormFu::Filter::Split
HTML::FormFu::Filter::TrimEdges
HTML::FormFu::Filter::UpperCase
HTML::FormFu::Filter::Whitespace
FILTER BASE CLASSES
The following are base classes for other filters, and generally needn't be used directly.
HTML::FormFu::Filter::_Compound
AUTHOR
Carl Franks, "cfranks@cpan.org"
Based on the original source code of HTML::Widget::Filter, by Sebastian Riedel.
LICENSE
This library is free software, you can redistribute it and/or modify it under the same terms as Perl itself.
perl v5.14.2 2012-01-23 HTML::FormFu::Filter(3pm)