.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 "Petal::Hash::Test 3pm"
.TH Petal::Hash::Test 3pm "2020-05-22" "perl v5.30.2" "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"
Petal::Hash::Test \- Test and Tutorial Petal modifier
.SH "SUMMARY"
.IX Header "SUMMARY"
Petal modifiers are snippets of code which are used to extend the
expression engine capabilities. This test shows how to write your
own modifiers.
.SH "API"
.IX Header "API"
The modifier \s-1API\s0 is very, very simple. It consists of two elements:
.SS "The package name"
.IX Subsection "The package name"
Your modifier should be called Petal::Hash::<SomeThing>, where <SomeThing>
is the name that you want to give to your modifier.
.PP
For example, this modifier is called Petal::Hash::Test. Petal will
automatically pick it the module up and assign it the 'test:' prefix.
.PP
.Vb 3
\&    package Petal::Hash::Test;
\&    use warnings;
\&    use strict;
.Ve
.ie n .SS "The method $class\->process ($hash, $argument);"
.el .SS "The method \f(CW$class\fP\->process ($hash, \f(CW$argument\fP);"
.IX Subsection "The method $class->process ($hash, $argument);"
This class method will define the modifier in itself.
.PP
* \f(CW$class\fR is the package name of your modifier (which might come in
handy if you're subclassing a modifier),
.PP
* \f(CW$hash\fR is the execution context, i.e. the objects and data which
will 'fill' your template,
.PP
* \f(CW$argument\fR is whatever was after your modifier's prefix. For example,
for the expression 'test:foo bar', \f(CW$argument\fR would be 'foo bar'.
.PP
In this test / tutorial we're going to write a modifier which
uppercases a Petal expression.
.PP
.Vb 5
\&  sub process
\&  {
\&      my $class    = shift;
\&      my $hash     = shift;
\&      my $argument = shift;
\&
\&      return uc ($hash\->get ($argument));
\&  }
\&
\&  1;
\&
\&  _\|_END_\|_
.Ve
.PP
And that's it! Simple!
.SH "AUTHOR"
.IX Header "AUTHOR"
Jean-Michel Hiver
.PP
This module is redistributed under the same license as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
The template hash module:
.PP
.Vb 1
\&  Petal::Hash
.Ve