NAME

Data::Verifier::Results - Results of a Data::Verifier

SYNOPSIS

    use Data::Verifier;

    my $dv = Data::Verifier->new(profile => {
        name => {
            required    => 1,
            type        => 'Str',
            filters     => [ qw(collapse trim) ]
        }
        age  => {
            type        => 'Int';
        },
        sign => {
            required    => 1,
            type        => 'Str'
        }
    });

    my $results = $dv->verify({
        name => 'Cory', age => 'foobar'
    });

    $results->success; # no

    $results->is_invalid('name'); # no
    $results->is_invalid('age'); # yes

    $results->is_missing('name'); # no
    $results->is_missing('sign'); # yes

SUCCESS OR FAILURE

success

Returns true or false based on if the verification's success.

VALUES

The values present in the result are the filtered, valid values. These may differ from the ones supplied to the verify method due to either filters or coercions.

valid_count

Returns the number of valid fields in this Results.

values

Returns a hashref of all the fields this profiled verified as the keys and the values that remain after verification.

delete_value ($name)

Deletes the specified value from the results.

get_original_value ($name)

Get the original value for the specified field.

get_value ($name)

Returns the value for the specified field. The value may be different from the one originally supplied due to filtering or coercion.

value_count

Returns the number of values in this Results.

VALID FIELDS

is_valid ($name)

Returns true if the field is valid.

valids

Returns a list of keys for which we have valid values.

INVALID FIELDS

is_invalid ($name)

Returns true if the specific field is invalid.

invalids

Returns a list of invalid field names.

invalid_count

Returns the count of invalid fields in this result.

MISSING FIELDS

is_missing ($name)

Returns true if the specified field is missing.

missings

Returns a list of missing field names.

missing_count

Returns the count of missing fields in this result.

FIELDS

get_field ($name)

Gets the field object, if it exists, for the name provided.

set_field ($name)

Sets the field object (you shouldn't be doing this directly) for the name provided.

SERIALIZATION

Data::Verifier uses MooseX::Storage to allow quick and easy serialization. So a quick call to freeze will serialize this object into JSON and thaw will inflate it. The only caveat is that we don't serialize the value attribute. Since coercion allows you to make the result any type you want, it can't reliably be serialized. Use original value if you are serializing Result objects and using them to refill forms or something.

AUTHOR

Cory G Watson, <gphat at cpan.org>

COPYRIGHT & LICENSE

Copyright 2009 Cold Hard Code, LLC

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

cpanm Data::Verifier

perl -MCPAN -e shell
install Data::Verifier