The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Params-Dry-1.2003
River stage one • 1 direct dependent • 1 total dependent
++
/ Params::Dry::Types

NAME

Params::Dry::Types - Build-in types for Params::Dry - Simple Global Params Management System which helps you to keep always DRY rule

VERSION

version 1.20.03

EXPORT

  • :const imports PASS and FAIL constants

BUILD IN TYPES

  • String - can be used with parameters (like: String[20]) which mean max 20 chars string

  • Int - can be used with parameters (like: Int[3]) which mean max 3 chars int not counting signs, shortcut of Number::Int

  • Float - number with decimal part, shortcut of Number::Float

  • Bool - boolean value (can be 0 or 1), shortcut of Number::Bool

  • Object - check if is an object. Optional parameter extend check of exact object checking ex. Object[DBI::db]

  • Defined - pass if value is defined

  • Value - pass if it is not a reference

  • Ref - any reference, Optional parameter defines type of the reference

  • Scalar - shortcut of Ref[Scalar] or Ref::Scalar

  • Array - shortcut of Ref[Array] or Ref::Array

  • Hash - shortcut of Ref[Hash] or Ref::Hash

  • Code - shortcut of Ref[Code] or Ref::Code

  • Regexp - shortcut of Ref[Regexp] or Ref::Regexp

RESERVED/USED SUBTYPES

Subtypes/Namespaces which are already used/reserved

  • Params::Dry::Types - main types

  • Params::Dry::Types::Number - number types

  • Params::Dry::Types::String - string types

  • Params::Dry::Types::Ref - ref types

  • Params::Dry::Types::Object - reserved for extended object types

EXTENDING INTERNAL TYPES

You can always write your module to check parameters. Please use always subnamespace of Params::Dry::Types

You will to your check function param value and list of the type parameters

Example.

    package Params::Dry::Types::Super;

    use Params::Dry::Types qw(:const);

    sub String {
        Params::Dry::Types::String(@_) and $_[0] =~ /Super/ and return PASS;
        return FAIL;
    }

    ...

    package main;

    sub test {
        my $self = __@_;

        my $p_super_name = rq 'super_name', 'Super::String'; # that's all folks!

        ...
    }

AUTHOR

Pawel Guspiel (neo77), <neo at cpan.org>

BUGS

Please report any bugs or feature requests to bug-params at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Params-Dry. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Params::Dry::Types
    perldoc Params::Dry::Types::Number
    perldoc Params::Dry::Types::String
    perldoc Params::Dry::Types::Ref
    perldoc Params::Dry::Types::Object
    perldoc Params::Dry

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2013 Pawel Guspiel (neo77).

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.