1 package Moose::Meta::Attribute::Native::Trait::String;
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' }
33 Moose::Meta::Attribute::Native::Trait::String - Helper trait for Str attributes
47 replace_text => 'replace',
51 my $page = MyHomePage->new();
52 $page->add_text("foo"); # same as $page->text($page->text . "foo");
56 This module provides a simple string attribute, to which mutating string
57 operations can be applied more easily (no need to make an lvalue attribute
58 metaclass or use temporary variables). Additional methods are provided for
61 If your attribute definition does not include any of I<is>, I<isa>,
62 I<default> or I<handles> but does use the C<String> metaclass,
63 then this module applies defaults as in the L</SYNOPSIS>
64 above. This allows for a very basic string definition:
66 has 'foo' => (traits => ['String']);
69 =head1 PROVIDED METHODS
71 These methods are implemented in
72 L<Moose::Meta::Attribute::Native::MethodProvider::String>. It is important to
73 note that all those methods do in place modification of the value stored in
80 Increments the value stored in this slot using the magical string autoincrement
81 operator. Note that Perl doesn't provide analogous behavior in C<-->, so
82 C<dec> is not available.
84 =item B<append($string)>
86 Append a string, like C<.=>.
88 =item B<prepend($string)>
92 =item B<replace($pattern, $replacement)>
94 Performs a regexp substitution (L<perlop/s>). There is no way to provide the
95 C<g> flag, but code references will be accepted for the replacement, causing
96 the regex to be modified with a single C<e>. C</smxi> can be applied using the
99 =item B<match($pattern)>
101 Like C<replace> but without the replacement. Provided mostly for completeness.
113 Sets the string to the empty string (not the value passed to C<default>).
121 L<perlfunc/substr>. We go to some lengths to match the different functionality
122 based on C<substr>'s arity.
132 =item B<method_provider>
134 =item B<has_method_provider>
140 All complex software has bugs lurking in it, and this module is no
141 exception. If you find a bug please either email me, or add the bug
146 Stevan Little E<lt>stevan@iinteractive.comE<gt>
148 =head1 COPYRIGHT AND LICENSE
150 Copyright 2007-2009 by Infinity Interactive, Inc.
152 L<http://www.iinteractive.com>
154 This library is free software; you can redistribute it and/or modify
155 it under the same terms as Perl itself.