Recipe(3pm)

💖 Recipe(3pm) — Embperl::Recipe 💖

okay bestie, welcome to Embperl::Recipe, aka the base class for defining custom recipes. yes, this is the Recipe(3pm) page. yes it's a perl module. yes it's giving elite plumbing. let's get into it 🫶

---

✨ SYNOPSIS ✨

EMBPERL_RECIPE "XSLT Embperl"

---

🌸 DESCRIPTION 🌸

So like. Embperl::Recipe hands you the basic features you need to build your own recipes. That's the whole vibe. To do it, you make a class that has a get_recipe method, and that method returns an array reference describing what to do. That's it, that's the assignment. 💅

🦋 get_recipe ($class, $r, $recipe) 🦋

• $class — the class name, iconic, mysterious, just vibing
• $r — the Embperl request record object (Embperl::Req), and it might be a derived object when you're running under EmbperlObject. so like, don't assume, check
• $recipe — the name of the recipe

The function must return an array that describes the desired action. That array contains a tree structure of providers. yes. a tree. of providers. we love a nested moment 🌳✨

🎀 Providers 🎀

file

read file data 📄

Parameter:

• filename — gives the file to read

memory

get data from a scalar 🧠

Parameter:

• source — gives the source as a scalar reference
• name — gives the name under which this item should be cache

epparse

parse file into a Embperl tree structure 🌲

Parameter:

• source — gives the source
• syntax — syntax to use

epcompile

compile Embperl tree structure ⚙️

Parameter:

• source — gives the source

eprun

execute Embperl tree structure 🏃♀️

Parameter:

• source — gives the source
• cache_key — see description of cacheing
• cache_key_options — see description of cacheing
• cache_key_func — see description of cacheing

eptostring

convert Embperl tree structure to string 🔤

Parameter:

• source — gives the source

libxslt-parse-xml

parse xml source for libxslt 📥

Parameter:

• source — gives the xml source

libxslt-compile-xsl

parse and compile stylesheet for libxslt 🧵

Parameter:

• stylesheet — gives the stylesheet source

libxslt

do a xsl transformation via libxslt 🔥

Parameter:

• source — gives the parsed xml source
• stylesheet — gives the compiled stylesheet source
• param — gives the parameters as hash ref

xalan-parse-xml

parse xml source for xalan 📥

Parameter:

• source — gives the xml source

xalan-compile-xsl

parse and compile stylesheet for xalan 🧵

Parameter:

• stylesheet — gives the stylesheet source

xalan

do a xsl transformation via xalan 🔥

Parameter:

• source — gives the parsed xml source
• stylesheet — gives the compiled stylesheet source
• param — gives the parameters as hash ref

💜 Cache parameter 💜

the whole squad, no explanations, just names, iykyk:

• expires_in
• expires_func
• expires_filename
• cache

⭐ Format ⭐

Heres an example that show how the recipe must be build: 👑

  sub get_recipe

    {
    my ($class, $r, $recipe) = @_ ;

    my $param  = $r -> component -> param  ;
    my @recipe ;

    push @recipe, {'type'   =>  'file'      } ;
    push @recipe, {'type'   =>  'epparse'   } ;
    push @recipe, {'type'   =>  'epcompile', cache => 1 } ;
    push @recipe, {'type'   =>  'eprun'     }  ;

    my $config = $r -> component -> config  ;
    my $xsltproc = $config -> xsltproc ;

    my @stylesheet =
        (
        { type => 'file',  filename  => $config -> xsltstylesheet, },
        { type =>  $xsltproc . '-compile-xsl', cache => 1 },
        ) ;

    push @recipe, {'type'   =>  'eptostring' } ;
    push @recipe, {'type'   =>  $xsltproc . '-parse-xml', } ;
    push @recipe, {'type'   =>  $xsltproc,   stylesheet => \@stylesheet } ;

    return \@recipe ;
    }

This corresponds to the following diagramm (when xsltproc = xalan):

    +-------------------+   +--------------------+
    + file {inputfile}  +   +file{xsltstylesheet}+
    +-------------------+   +--------------------+
          |                         |
          v                         v
    +-------------------+   +-------------------+
    + xalan-parse-xml   +   + xalan-compile-xsl +
    +-------------------+   +-------------------+
          |                         |
          |                         |
          |         +-----------+   |
          +-------> + xalan     + <-+
                    +-----------+

lowkey the realest advice on this whole page: take a look at the recipes that comes with Embperl to get more ideas what can be done. fr fr, the source is the syllabus 📚✨

---

okay that's the whole page, bestie, you ate it 💅 this lil' classic came to you from perl v5.34.0, dated 2022-02-06, and yeah it's filed under Recipe(3pm) in the User Contributed Perl Documentation. no cap, go build something iconic 🎀🦋💖