1 package Moose::Meta::Attribute::Native::Trait::String;
4 our $VERSION = '0.89_02';
5 $VERSION = eval $VERSION;
6 our $AUTHORITY = 'cpan:STEVAN';
8 use Moose::Meta::Attribute::Native::MethodProvider::String;
10 with 'Moose::Meta::Attribute::Native::Trait';
12 has 'method_provider' => (
15 predicate => 'has_method_provider',
16 default => 'Moose::Meta::Attribute::Native::MethodProvider::String',
19 sub _default_default { q{} }
20 sub _default_is { 'rw' }
21 sub _helper_type { 'Str' }
23 after '_check_handles_values' => sub {
25 my $handles = $self->handles;
27 unless ( scalar keys %$handles ) {
28 my $method_constructors = $self->method_constructors;
29 my $attr_name = $self->name;
31 foreach my $method ( keys %$method_constructors ) {
32 $handles->{$method} = ( $method . '_' . $attr_name );
47 Moose::Meta::Attribute::Native::Trait::String - Helper trait for Str attributes
61 replace_text => 'replace',
65 my $page = MyHomePage->new();
66 $page->add_text("foo"); # same as $page->text($page->text . "foo");
70 This module provides a simple string attribute, to which mutating string
71 operations can be applied more easily (no need to make an lvalue attribute
72 metaclass or use temporary variables). Additional methods are provided for
75 If your attribute definition does not include any of I<is>, I<isa>,
76 I<default> or I<handles> but does use the C<String> metaclass,
77 then this module applies defaults as in the L</SYNOPSIS>
78 above. This allows for a very basic string definition:
80 has 'foo' => (traits => ['String']);
83 =head1 PROVIDED METHODS
85 These methods are implemented in
86 L<Moose::Meta::Attribute::Native::MethodProvider::String>. It is important to
87 note that all those methods do in place modification of the value stored in
94 Increments the value stored in this slot using the magical string autoincrement
95 operator. Note that Perl doesn't provide analogous behavior in C<-->, so
96 C<dec> is not available.
98 =item B<append($string)>
100 Append a string, like C<.=>.
102 =item B<prepend($string)>
106 =item B<replace($pattern, $replacement)>
108 Performs a regexp substitution (L<perlop/s>). There is no way to provide the
109 C<g> flag, but code references will be accepted for the replacement, causing
110 the regex to be modified with a single C<e>. C</smxi> can be applied using the
113 =item B<match($pattern)>
115 Like C<replace> but without the replacement. Provided mostly for completeness.
127 Sets the string to the empty string (not the value passed to C<default>).
135 L<perlfunc/substr>. We go to some lengths to match the different functionality
136 based on C<substr>'s arity.
146 =item B<method_provider>
148 =item B<has_method_provider>
154 All complex software has bugs lurking in it, and this module is no
155 exception. If you find a bug please either email me, or add the bug
160 Stevan Little E<lt>stevan@iinteractive.comE<gt>
162 =head1 COPYRIGHT AND LICENSE
164 Copyright 2007-2009 by Infinity Interactive, Inc.
166 L<http://www.iinteractive.com>
168 This library is free software; you can redistribute it and/or modify
169 it under the same terms as Perl itself.