.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 "Text::MicroMason::AllowGlobals 3pm"
.TH Text::MicroMason::AllowGlobals 3pm "2023-08-10" "perl v5.36.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"
Text::MicroMason::AllowGlobals \- Share package vars between templates
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Instead of using this class directly, pass its name to be mixed in:
.PP
.Vb 2
\&    use Text::MicroMason;
\&    my $mason = Text::MicroMason\->new( \-AllowGlobals );
.Ve
.PP
Share package variables:
.PP
.Vb 1
\&    $mason\->set_globals( \*(Aq$name\*(Aq => \*(AqBob\*(Aq );
.Ve
.PP
Use the standard compile and execute methods to parse and evaluate templates:
.PP
.Vb 2
\&  print $mason\->compile( text=>$template )\->();
\&  print $mason\->execute( text=>$template );
.Ve
.PP
Then, in a template, you can refer to those globals:
.PP
.Vb 1
\&    Welcome, <% $name %>!
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SS "Public Methods"
.IX Subsection "Public Methods"
.IP "\fBset_globals()\fR" 4
.IX Item "set_globals()"
Accepts a list of pairs of global variable names and corresponding values.
.Sp
Adds each variable name to the allowed list and sets it to the initial value.
.IP "\fBallow_globals()\fR" 4
.IX Item "allow_globals()"
Gets or sets the variables names to be allowed.
.Sp
If called with arguments, adds them to the list.
.Sp
Returns the variables to be allowed as a list, or as a space-separated string in scalar context.
.SS "Supported Attributes"
.IX Subsection "Supported Attributes"
.IP "allow_globals" 4
.IX Item "allow_globals"
Optional array or space-separated string of global variable names to be allowed.
.SS "Private Methods"
.IX Subsection "Private Methods"
.IP "\fBassemble()\fR" 4
.IX Item "assemble()"
Adds the allow_globals_statement to each token stream before assembling it.
.IP "\fBallow_globals_statement()\fR" 4
.IX Item "allow_globals_statement()"
This method prepends the \*(L"use vars\*(R" statement needed for the template subroutines to compile.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
For an overview of this templating framework, see Text::MicroMason.
.PP
This is a mixin class intended for use with Text::MicroMason::HTMLMason.
.PP
For distribution, installation, support, copyright and license 
information, see Text::MicroMason::Docs::ReadMe.