.\" 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::PostProcess 3pm"
.TH Text::MicroMason::PostProcess 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::PostProcess \- Apply Filters to All Template Output
.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( \-PostProcess );
.Ve
.PP
Use the standard compile and execute methods to parse and evaluate templates:
.PP
.Vb 2
\&  print $mason\->compile( text=>$template )\->( @%args );
\&  print $mason\->execute( text=>$template, @args );
.Ve
.PP
You can define output filters at creation or subsequently:
.PP
.Vb 1
\&    $mason = Text::MicroMason\->new( \-PostProcess, post_process => $func );
\&
\&    $mason\->post_processors( $func );
\&
\&    $mason\->compile( text => $template, post_process => $func );
\&
\&    $mason\->execute( text => $template, { post_process => $func }, @args );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This mixin class adds filtering of all template output to any MicroMason class.
.PP
Filter functions can accept the string to be output and return a filtered version:
.PP
.Vb 5
\&  $mason\->post_process( sub {
\&    my $foo = shift;
\&    $foo =~ s/a\-Z/A\-Z/;
\&    return $foo;
\&  } );
.Ve
.PP
If a filter function has an empty prototype, it's assumed to work on \f(CW$_:\fR
.PP
.Vb 3
\&  $mason\->post_process( sub () {
\&    s/a\-Z/A\-Z/
\&  } );
.Ve
.SS "Public Methods"
.IX Subsection "Public Methods"
.IP "\fBpost_processors()\fR" 4
.IX Item "post_processors()"
Gets and sets the functions to be used for output filtering.
.Sp
Called with no arguments, returns the list of filter functions:
.Sp
.Vb 1
\&  my @functions = $mason\->post_processors();
.Ve
.Sp
Called with one array-ref argument, sets the list of filter functions:
.Sp
.Vb 1
\&  $mason\->post_processors( \e@functions );
.Ve
.Sp
Called with one or more function-ref arguments, appends to the list:
.Sp
.Vb 1
\&  $mason\->post_processors( $filter1, $filter2 );
.Ve
.SS "Supported Attributes"
.IX Subsection "Supported Attributes"
.IP "post_process" 4
.IX Item "post_process"
Stores a reference to a function or an array of functions to be used:
.Sp
.Vb 2
\&  $mason\->{post_process} = $function;
\&  $mason\->{post_process} = [ $function1, $function2 ];
.Ve
.Sp
You can set this attribute when you create your mason object, or in calls to the compile and execute methods.
.SS "Private Methods"
.IX Subsection "Private Methods"
.IP "\fBpost_process()\fR" 4
.IX Item "post_process()"
.Vb 1
\&  $mason\->post_process( $output ) : $filtered_output
.Ve
.Sp
Applies the post-processing filter.
.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::Base.
.PP
For distribution, installation, support, copyright and license 
information, see Text::MicroMason::Docs::ReadMe.