Scroll to navigation

MooseX::AttributeHelpers::Trait::String(3pm) User Contributed Perl Documentation MooseX::AttributeHelpers::Trait::String(3pm)

NAME

MooseX::AttributeHelpers::String - simple string attribute

SYNOPSIS

  package MyHomePage;
  use Moose;
  use MooseX::AttributeHelpers;
  
  has 'text' => (
      metaclass => 'String',
      is        => 'rw',
      isa       => 'Str',
      default   => sub { '' },
      provides  => {
          append => "add_text",
          replace => "replace_text",
      }
  );
  my $page = MyHomePage->new();
  $page->add_text("foo"); # same as $page->text($page->text . "foo");

DESCRIPTION

This module provides a simple string attribute, to which mutating string operations can be applied more easily (no need to make an lvalue attribute metaclass or use temporary variables). Additional methods are provided for completion.
If your attribute definition does not include any of is, isa, default or provides but does use the "String" metaclass, then this module applies defaults as in the "SYNOPSIS" above. This allows for a very basic counter definition: 
  has 'foo' => (metaclass => 'String');
  $obj->append_foo;

METHODS

meta
method_provider
has_method_provider
helper_type
process_options_for_provides
Run before its superclass method.
check_provides_values
Run after its superclass method.

PROVIDED METHODS

It is important to note that all those methods do in place modification of the value stored in the attribute.
inc
Increments the value stored in this slot using the magical string autoincrement operator. Note that Perl doesn't provide analogeous behavior in "--", so "dec" is not available.
append $string
Append a string, like ".=".
prepend $string
Prepend a string.
replace $pattern $replacement
Performs a regexp substitution ("s" in perlop). There is no way to provide the "g" flag, but code references will be accepted for the replacement, causing the regex to be modified with a single "e". "/smxi" can be applied using the "qr" operator.
match $pattern
Like replace but without the replacement. Provided mostly for completeness.
"chop"
"chop" in perlfunc
"chomp"
"chomp" in perlfunc
"clear"
Sets the string to the empty string (not the value passed to "default").

BUGS

All complex software has bugs lurking in it, and this module is no exception. If you find a bug please either email me, or add the bug to cpan-RT.

AUTHOR

Stevan Little <stevan@iinteractive.com>

COPYRIGHT AND LICENSE

Copyright 2007-2009 by Infinity Interactive, Inc.
<http://www.iinteractive.com>
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
2010-01-02 perl v5.10.1