Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

Params::ValidationCompiler

Name Params::ValidationCompiler
Version 0.27
Located at /usr/share/perl5/vendor_perl
File /usr/share/perl5/vendor_perl/Params/ValidationCompiler.pm
Is Core No
Search CPAN for this module Params::ValidationCompiler
Documentation Params::ValidationCompiler
Module Details Params::ValidationCompiler


NAME

Params::ValidationCompiler - Build an optimized subroutine parameter validator once, use it forever


VERSION

version 0.27


SYNOPSIS

    use Types::Standard qw( Int Str );
    use Params::ValidationCompiler qw( validation_for );
    {
        my $validator = validation_for(
            params => {
                foo => { type => Int },
                bar => {
                    type     => Str,
                    optional => 1,
                },
                baz => {
                    type    => Int,
                    default => 42,
                },
            },
        );
        sub foo {
            my %args = $validator->(@_);
        }
    }
    {
        my $validator = validation_for(
            params => [
                { type => Int },
                {
                    type     => Str,
                    optional => 1,
                },
            ],
        );
        sub bar {
            my ( $int, $str ) = $validator->(@_);
        }
    }
    {
        my $validator = validation_for(
            params => [
                foo => { type => Int },
                bar => {
                    type     => Str,
                    optional => 1,
                },
            ],
            named_to_list => 1,
        );
        sub baz {
            my ( $foo, $bar ) = $validator->(@_);
        }
    }


DESCRIPTION

This module creates a customized, highly efficient parameter checking subroutine. It can handle named or positional parameters, and can return the parameters as key/value pairs or a list of values.

In addition to type checks, it also supports parameter defaults, optional parameters, and extra ``slurpy'' parameters.


EXPORTS

This module has two options exports, validation_for and source_for. Both of these subs accept the same options:

validation_for(...)

This returns a subroutine that implements the specific parameter checking. This subroutine expects to be given the parameters to validate in @_. If all the parameters are valid, it will return the validated parameters (with defaults as appropriate), either as a list of key-value pairs or as a list of just values. If any of the parameters are invalid it will throw an exception.

For validators expected named params, the generated subroutine accepts either a list of key-value pairs or a single hashref. Otherwise the validator expects a list of values.

For now, you must shift off the invocant yourself.

This subroutine accepts the following additional parameters:

source_for(...)

This returns a two element list. The first is a string containing the source code for the generated sub. The second is a hashref of ``environment'' variables to be used when generating the subroutine. These are the arguments that are passed to the Eval::Closure manpage.


SUPPORT

Bugs may be submitted at https://github.com/houseabsolute/Params-ValidationCompiler/issues.

I am also usually active on IRC as 'autarch' on irc://irc.perl.org.


SOURCE

The source code repository for Params-ValidationCompiler can be found at https://github.com/houseabsolute/Params-ValidationCompiler.


DONATIONS

If you'd like to thank me for the work I've done on this module, please consider making a ``donation'' to me via PayPal. I spend a lot of free time creating free software, and would appreciate any support you'd care to offer.

Please note that I am not suggesting that you must do this in order for me to continue working on this particular software. I will continue to do so, inasmuch as I have in the past, for as long as it interests me.

Similarly, a donation made in this way will probably not make me work on this software much more, unless I get so many donations that I can consider working on free software full time (let's all have a chuckle at that together).

To donate, log into PayPal and send money to autarch@urth.org, or use the button at http://www.urth.org/~autarch/fs-donation.html.


AUTHOR

Dave Rolsky <autarch@urth.org>


CONTRIBUTORS


COPYRIGHT AND LICENSE

This software is Copyright (c) 2016 - 2018 by Dave Rolsky.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)

The full text of the license can be found in the LICENSE file included with this distribution.

Perl Diver brought to you by ScriptSolutions.com © 1997- 2024