NAME

XML::Filter::XML_Directory_Pruner - SAX2 filter for restricting the output of the XML::Directory::SAX

SYNOPSIS

 use XML::SAX::Writer;
 use XML::Directory::SAX;
 use XML::Filter::XML_Directory_Pruner;

 my $output = "";

 my $writer = XML::SAX::Writer->new(Output=>\$output);
 my $pruner = XML::Filter::XML_Directory_Pruner->new(Handler=>$writer);

 $pruner->exclude(matching=>["(.*)\\.ph\$"]);
 $pruner->include(ending=>[".pm"]);

 my $directory = XML::Directory::SAX->new(Handler => $pruner,
                                          detail  => 2,
                                          depth   => 1);

 $directory->parse_dir($INC[0]);

DESCRIPTION

XML::Filter::XML_Directory_Pruner is a SAX2 filter for restricting the output of the XML::Directory::SAX handler.

PACKAGE METHODS

PACKAGE->mtype($file)

Return the media type, as defined by the MIME::Types package, associated with $file.

OBJECT METHODS

$pkg = PACKAGE->new()

Inherits from XML::SAX::Base

$pkg->include(%args)

Include *only* that files that match either the starting or ending pattern.

Valid arguments are

include
Array ref.
matching
Array ref. One or more regular expressions.

note that when this expression is compared, leaning toothpicks (e.g. : /$pattern/) are provided for you.

In earlier releases, only a string was expected. Newer releases are backward compatible.
starting
Array ref.
ending
Array ref.

$pkg->exclude(%args)

Exclude files with a particular name or pattern from being included in the directory listing.

Valid arguments are

exclude
Array ref.
matching
Array ref. One or more regular expressions.

note that when this expression is compared, leaning toothpicks (e.g. : /$pattern/) are provided for you.

In earlier releases, only a string was expected. Newer releases are backward compatible.
starting
Array ref.
ending
Array ref.
directories
Boolean. Default is false.

files

Boolean. Default is false.