Moritz Onken > Text-Filter-URI-0.03 > Text::Filter::URI

Download:
Text-Filter-URI-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.03   Source  

NAME ^

Text::Filter::URI - Filter a string to meet URI requirements

SYNOPSIS ^

Use either the exported function or the OO interface:

    use Text::Filter::URI qw( filter_uri );

    my $uri = filter_uri("A text which needs to   be filtered  ");
    # $uri = "a-text-which-needs-to-be-filtered"

    my $f = Text::Filter::URI->new(input => $input, output => $output);
    $f->filter;

See Text::Filter for details on $input and $output.

EXPORT ^

filter_uri

This method can be exported using use Text::Filter::URI qw( filter_uri );

It expects a string or an array of strings and returns the filtered strings accordingly.

METHODS ^

These methods are used for the OO interface. This allows you to use the full power of Text::Filter.

new

The constructor new takes a hash for configuration. See "CONSTRUCTOR" in Text::Filter for more information on these settings.

There is one additional parameter:

separator

Define an individual string for separating the words. Defaults to -.

filter

Call this method after calling new to actually filter the $input.

Unicode characters get encoded to their ascii equivalents using the Text::Unidecode. This module maps characters like to the ascii character a. This method contains several regular expressions which convert every not word character (\W) and the underscore to a blank. Blanks at the beginning and the end are removed. All remaining blanks are replaced by the separator (defaults to -). Then it creates a lowercased version of the string.

AUTHOR ^

Moritz Onken, <onken@netcubed.de>

BUGS ^

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

COPYRIGHT & LICENSE ^

Copyright 2008 Moritz Onken, all rights reserved.

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

syntax highlighting: