Form::Factory::Feature::Role::CustomControlMessage - control features with custom messages

Form-Factory documentation Contained in the Form-Factory distribution.

Index

Code Index:

NAME

Top

Form::Factory::Feature::Role::CustomControlMessage - control features with custom messages

VERSION

Top

version 0.020

SYNOPSIS

Top

  has_control foo => (
      control   => 'text',
      features  => {
          match_code => {
              message => 'Foo values must be even',
              code    => sub { $_[0] % 2 == 0 },
          },
      },
  );

DESCRIPTION

Top

A control feature may consume this role in order to allow the user to specify a custom message on failure. This message may include a single "%s" placeholder, which will be filled in with the label or name of the control.

METHODS

Top

format_message

  my $formatted_message = $feature->format_message($unformatted_message);

Given a message containing a single %s placeholder, it fills that placeholder with the control's label. If the control does not implement Form::Factory::Control::Role::Labeled, the control's name is used instead.

control_info

Reports an informational message automatically filtered through format_message.

control_warning

Reports a warning automatically filtered through format_message.

control_error

Reports an error automatically filtered through format_error.

AUTHOR

Top

Andrew Sterling Hanenkamp <hanenkamp@cpan.org>

COPYRIGHT AND LICENSE

Top

Copyright 2009 Qubling Software LLC.

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

Form-Factory documentation Contained in the Form-Factory distribution. 
package Form::Factory::Feature::Role::CustomControlMessage;
BEGIN {
  $Form::Factory::Feature::Role::CustomControlMessage::VERSION = '0.020';
}
use Moose::Role;

with qw( Form::Factory::Feature::Role::CustomMessage );


sub format_message {
    my $self    = shift;
    my $message = $self->message || shift;
    my $control = $self->control;

    my $control_label 
        = $control->does('Form::Factory::Control::Role::Labeled') ? $control->label
        :                                                           $control->name
        ;

    sprintf $message, $control_label;
}


sub control_info {
    my $self    = shift;
    my $message = $self->format_message(shift);
    $self->result->field_info($self->control->name, $message);
}


sub control_warning {
    my $self = shift;
    my $message = $self->format_message(shift);
    $self->result->field_warning($self->control->name, $message);
}


sub control_error {
    my $self = shift;
    my $message = $self->format_message(shift);
    $self->result->field_error($self->control->name, $message);
}



1;