The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
SWISH-Prog-0.30
River stage one • 7 direct dependents • 8 total dependents
++
/ SWISH::Prog::Doc

NAME

SWISH::Prog::Doc - Document object class for passing to SWISH::Prog::Indexer

SYNOPSIS

  # subclass SWISH::Prog::Doc
  # and override filter() method
  
  package MyDoc;
  use base qw( SWISH::Prog::Doc );
  
  sub filter {
    my $doc = shift;
    
    # alter url
    my $url = $doc->url;
    $url =~ s/my.foo.com/my.bar.org/;
    $doc->url( $url );
    
    # alter content
    my $buf = $doc->content;
    $buf =~ s/foo/bar/gi;
    $doc->content( $buf );
  }
  
  1;

DESCRIPTION

SWISH::Prog::Doc is the base class for Doc objects in the SWISH::Prog framework. Doc objects are created by SWISH::Prog::Aggregator classes and processed by SWISH::Prog::Indexer classes.

You can subclass SWISH::Prog::Doc and add a filter() method to alter the values of the Doc object before it is indexed.

METHODS

All of the following methods may be overridden when subclassing this module, but the recommendation is to override only filter().

new

Instantiate Doc object.

All of the following params are also available as accessors/mutators.

url
type
content
parser
modtime
size
action
debug
charset
data

init

Calls filter() on object.

filter

Override this method to alter the values in the object prior to it being process()ed by the Indexer.

The default is to do nothing.

This method can also be set using the filter() callback in SWISH::Prog->new().

as_string

Return the Doc object rendered as a scalar string, ready to be indexed. This will include the proper headers. See SWISH::Prog::Headers.

NOTE: as_string() is also used if you use a Doc object as a string. Example:

 print $doc->as_string;     # one way
 print $doc;                # same thing

AUTHOR

Peter Karman, <perl@peknet.com>

BUGS

Please report any bugs or feature requests to bug-swish-prog at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SWISH-Prog. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc SWISH::Prog

You can also look for information at:

COPYRIGHT AND LICENSE

Copyright 2008-2009 by Peter Karman

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

http://swish-e.org/