/ 
Text-Pipe-0.06
River stage one • 8 direct dependents • 8 total dependents
/ Text::Pipe::Split

NAME

Text::Pipe::Split - Common text filter API

SYNOPSIS

Text::Pipe::Split->new;

DESCRIPTION

This pipe segment can split a string along a pattern into an array. It works like perl's split().

Text::Pipe::Split inherits from Text::Pipe::Base.

The superclass Text::Pipe::Base defines these methods and functions:

new(), ()(), (|(), bit_or(), filter_single(), init()

The superclass Class::Accessor::Complex defines these methods and functions:

carp(), cluck(), croak(), flatten(), mk_abstract_accessors(),
mk_array_accessors(), mk_boolean_accessors(),
mk_class_array_accessors(), mk_class_hash_accessors(),
mk_class_scalar_accessors(), mk_concat_accessors(),
mk_forward_accessors(), mk_hash_accessors(), mk_integer_accessors(),
mk_new(), mk_object_accessors(), mk_scalar_accessors(),
mk_set_accessors(), mk_singleton()

The superclass Class::Accessor defines these methods and functions:

_carp(), _croak(), _mk_accessors(), accessor_name_for(),
best_practice_accessor_name_for(), best_practice_mutator_name_for(),
follow_best_practice(), get(), make_accessor(), make_ro_accessor(),
make_wo_accessor(), mk_accessors(), mk_ro_accessors(),
mk_wo_accessors(), mutator_name_for(), set()

The superclass Class::Accessor::Installer defines these methods and functions:

install_accessor(), subname()

The superclass Class::Accessor::Constructor defines these methods and functions:

NO_DIRTY(), WITH_DIRTY(), _make_constructor(), mk_constructor(),
mk_constructor_with_dirty(), mk_singleton_constructor()

The superclass Data::Inherited defines these methods and functions:

every_hash(), every_list(), flush_every_cache_by_key()

The superclass Class::Accessor::Constructor::Base defines these methods and functions:

HYGIENIC(), STORE(), clear_dirty(), clear_hygienic(),
clear_unhygienic(), contains_hygienic(), contains_unhygienic(),
delete_hygienic(), delete_unhygienic(), dirty(), dirty_clear(),
dirty_set(), elements_hygienic(), elements_unhygienic(), hygienic(),
hygienic_clear(), hygienic_contains(), hygienic_delete(),
hygienic_elements(), hygienic_insert(), hygienic_is_empty(),
hygienic_size(), insert_hygienic(), insert_unhygienic(),
is_empty_hygienic(), is_empty_unhygienic(), set_dirty(),
size_hygienic(), size_unhygienic(), unhygienic(), unhygienic_clear(),
unhygienic_contains(), unhygienic_delete(), unhygienic_elements(),
unhygienic_insert(), unhygienic_is_empty(), unhygienic_size()

The superclass Tie::StdHash defines these methods and functions:

CLEAR(), DELETE(), EXISTS(), FETCH(), FIRSTKEY(), NEXTKEY(), SCALAR(),
TIEHASH()

METHODS

clear_limit
$obj->clear_limit;

Clears the value.

clear_pattern
$obj->clear_pattern;

Clears the value.

limit
my $value = $obj->limit;
$obj->limit($value);

A basic getter/setter method. If called without an argument, it returns the value. If called with a single argument, it sets the value.

limit_clear
$obj->limit_clear;

Clears the value.

pattern
my $value = $obj->pattern;
$obj->pattern($value);

A basic getter/setter method. If called without an argument, it returns the value. If called with a single argument, it sets the value.

pattern_clear
$obj->pattern_clear;

Clears the value.

filter

Takes a string input and splits it along the pattern, respecting the limit like perl's split() function.

If something else than a string is passed, it is returned unchanged.

TAGS

If you talk about this module in blogs, on del.icio.us or anywhere else, please use the textpipe tag.

VERSION

This document describes version 0.06 of Text::Pipe::Split.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to <bug-text-pipe@rt.cpan.org>, or through the web interface at http://rt.cpan.org.

INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.

AUTHOR

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE

Copyright 2007 by Marcel Grünauer

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