.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05) .\" .\" 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" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "UNIVERSAL::require 3pm" .TH UNIVERSAL::require 3pm "2009-03-30" "perl v5.10.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" UNIVERSAL::require \- require() modules from a variable .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& # This only needs to be said once in your program. \& require UNIVERSAL::require; \& \& # Same as "require Some::Module" \& my $module = \*(AqSome::Module\*(Aq; \& $module\->require or die $@; \& \& # Same as "use Some::Module" \& BEGIN { $module\->use or die $@ } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" If you've ever had to do this... .PP .Vb 1 \& eval "require $module"; .Ve .PP to get around the bareword caveats on \fIrequire()\fR, this module is for you. It creates a universal \fIrequire()\fR class method that will work with every Perl module and its secure. So instead of doing some arcane \fIeval()\fR work, you can do this: .PP .Vb 1 \& $module\->require; .Ve .PP It doesn't save you much typing, but it'll make alot more sense to someone who's not a ninth level Perl acolyte. .SH "Methods" .IX Header "Methods" \fIrequire\fR .IX Subsection "require" .PP .Vb 2 \& my $return_val = $module\->require or die $@; \& my $return_val = $module\->require($version) or die $@; .Ve .PP This works exactly like Perl's require, except without the bareword restriction, and it doesn't die. Since \fIrequire()\fR is placed in the \&\s-1UNIVERSAL\s0 namespace, it will work on \fBany\fR module. You just have to use UNIVERSAL::require somewhere in your code. .PP Should the module require fail, or not be a high enough \f(CW$version\fR, it will simply return false and \fBnot die\fR. The error will be in $@ as well as \f(CW$UNIVERSAL::require::ERROR\fR. .PP .Vb 1 \& $module\->require or die $@; .Ve .PP \fIuse\fR .IX Subsection "use" .PP .Vb 2 \& my $require_return = $module\->use or die $@; \& my $require_return = $module\->use(@imports) or die $@; .Ve .PP Like \f(CW\*(C`UNIVERSAL::require\*(C'\fR, this allows you to \f(CW\*(C`use\*(C'\fR a \f(CW$module\fR without having to eval to work around the bareword requirement. It returns the same as require. .PP Should either the require or the import fail it will return false. The error will be in $@. .PP If possible, call this inside a \s-1BEGIN\s0 block to emulate a normal \f(CW\*(C`use\*(C'\fR as closely as possible. .PP .Vb 1 \& BEGIN { $module\->use } .Ve .SH "SECURITY NOTES" .IX Header "SECURITY NOTES" UNIVERSAL::require makes use of \f(CW\*(C`eval STRING\*(C'\fR. In previous versions of UNIVERSAL::require it was discovered that one could craft a class name which would result in code being executed. This hole has been closed. The only variables now exposed to \f(CW\*(C`eval STRING\*(C'\fR are the caller's package, filename and line which are not tainted. .PP UNIVERSAL::require is taint clean. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2001, 2005 by Michael G Schwern . .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .PP See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR .SH "AUTHOR" .IX Header "AUTHOR" Michael G Schwern .SH "SEE ALSO" .IX Header "SEE ALSO" Module::Load, \*(L"require\*(R" in perlfunc,