.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Validation::Class::Exporter 3pm" .TH Validation::Class::Exporter 3pm "2022-06-22" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Validation::Class::Exporter \- Simple Exporter for Validation::Class Classes .SH "VERSION" .IX Header "VERSION" version 7.900058 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& package MyApp::Validator; \& \& use Validation::Class; \& use Validation::Class::Exporter; \& \& my @settings = ( \& classes => [ \& MyApp::Validator::DomainAlpha \& MyApp::Validator::DomainBeta \& ] \& ); \& \& Validation::Class::Exporter\->apply_spec( \& routines => [\*(Aqthing\*(Aq], # export additional routines as is \& settings => [@settings] # passed to the \`load\` keyword in V::C \& ); \& \& sub thing { \& \& my $args = pop; \& \& my $class = shift || caller; \& \& # routine as a keyword \& \& # ... do some thing \& \& }; .Ve .PP \&... in your application class: .PP .Vb 1 \& package MyApp; \& \& use MyApp::Validator; \& \& thing [\*(Aqa\*(Aq, \*(Aqb\*(Aq]; .Ve .PP \&... in your application: .PP .Vb 1 \& package main; \& \& my $app = MyApp\->new; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module (while experimental) encapsulates the exporting of keywords and routines. It applies the Validation::Class framework along with any keyword routines and/or sub-routines specified with the \fBapply_spec()\fR method. It does this by simply by copying the spec into the calling class. .PP To simplify writing exporter modules, \f(CW\*(C`Validation::Class::Exporter\*(C'\fR also imports \f(CW\*(C`strict\*(C'\fR and \f(CW\*(C`warnings\*(C'\fR into your exporter module, as well as into modules that use it. .SH "METHODS" .IX Header "METHODS" .SS "apply_spec" .IX Subsection "apply_spec" When you call this method, \f(CW\*(C`Validation::Class::Exporter\*(C'\fR builds a custom \&\f(CW\*(C`import\*(C'\fR method on the calling class. The \f(CW\*(C`import\*(C'\fR method will export the functions you specify, and can also automatically export \f(CW\*(C`Validation::Class\*(C'\fR making the calling class a Validation::Class derived class. .PP This method accepts the following parameters: .IP "\(bu" 8 routines => [ ... ] .Sp This list of function \fInames only\fR will be exported into the calling class exactly as is, the functions can be used traditionally or as keywords so their parameter handling should be configured accordingly. .IP "\(bu" 8 settings => [ ... ] .Sp This list of key/value pair will be passed to the load method imported from \&\f(CW\*(C`Validation::Class::load\*(C'\fR and will be applied on the calling class. .Sp This approach affords you some trickery in that you can utilize the load method to apply the current class' configuration to the calling class' configuration, etc. .SH "AUTHOR" .IX Header "AUTHOR" Al Newkirk .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2011 by Al Newkirk. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.