SRU::R...Explain(3pm)

💖 SRU::Request::Explain — the glow-up guide 💖

okay so bestie, you found the manual page for SRU::Request::Explain, living in the User Contributed Perl Documentation section of your friendly neighbourhood perl man pages (that's the 3pm vibe, iykyk). Sit down, grab a strawberry 🍓, and let's get into it.

---

✨ NAME ✨

SRU::Request::Explain — it's a class for representing SRU explain requests. iconic

---

🌸 SYNOPSIS 🌸

Making a new request? Literally so easy:

## creating a new request
my $request = SRU::Request::Explain->new();

That's it. That's the whole thing. slay. 💅

---

🦋 DESCRIPTION 🦋

So SRU::Request::Explain is a class for representing SRU 'explain' requests. And what's an explain request, you ask? It's basically the server's version of a "tell me about yourself" icebreaker 🫶 — explain requests essentially ask the server to describe its services.

No cap, that's the whole job description.

---

👑 METHODS 👑

💜 new()

The constructor, bestie. You can pass it the optional parameters parameters: version, recordPacking, stylesheet, and extraRequestData parameters.

Check it:

my $request = SRU::Request::Explain->new(
    version     => '1.1',
    stylesheet  => 'http://www.example.com/styles/mystyle.xslt'
);

🎀 real talk though: normally you'll probably want to use the factory SRU::Response::newFromURI to create requests, instead of calling new() yourself. The factory is the main character here. Let it cook. 👑

---

⭐ version()

⭐ recordPacking()

⭐ stylesheet()

⭐ extraRequestData()

⭐ validParams()

yes bestie, they're all listed together like that, and yes, that's exactly how the page does it. These are the methods you get on this class. Periodt. 💅

---

🌈 COPYRIGHT AND LICENSE 🌈

This software is copyright (c) 2013 by Ed Summers. 🫶

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

and that's the whole page, bestie!! 💖 This lil manual came to you courtesy of perl v5.34.0, dated 2022-06-17, and it's filed under SRU::R...Explain(3pm). Go forth and explain ur services. ✨🦋🎀