Net::Op...tension(3)

🌸 NAME 🌸

okay bestie, this page is literally Net::Op...tension(3) β€” yes, that's the manual name, abbreviations and all πŸ’… β€” and it's part of the User Contributed Perl Documentation. The actual module is Net::OpenID::Extension, and it's the base class for OpenID extensions. That's the whole NAME vibe, and it ate. πŸ¦‹

✨ VERSION ✨

version 1.20 β€” that's the version, no cap. πŸŽ€

πŸŽ€ METHODS πŸŽ€

okay so these are the CLASS->... methods, bestie. Lowkey the whole extension personality lives here, and I'm obsessed. ✨

πŸ¦‹ CLASS->namespace_uris πŸ¦‹

Return a hashref mapping namespace URIs to the aliases you will use to refer to them in the other methods. For example:

return {
    'http://example.com/some-extension' => 'someext',
};

πŸ’– CLASS->new_request(@parameters) πŸ’–

When your extension is added to the Net::OpenID::ClaimedIdentity object in consumer-land, this method will be called to create a request object. Any additional arguments passed when adding the extension will be passed through verbatim in @parameters.

The object you return here should at minimum provide the interface defined in Net::OpenID::ExtensionMessage.

You can return "undef" here if you have nothing useful to return. Yes bestie, the undef escape hatch is valid. 🫢

🌈 CLASS->received_request(\%args) 🌈

In server-land, when a caller asks for the request object for your extension this method will be called to create a request object. %args maps the aliases you returned from the "namespace_uris" method to a hashref of the key-value pairs provided in that namespace.

The object you return here should at minimum provide the interface defined in Net::OpenID::ExtensionMessage, and should behave identically to the corresponding object returned from "new_request".

You can return "undef" here if you have nothing useful to return. πŸ’œ

🌸 CLASS->new_response(@parameters) 🌸

When your extension is added to the response in server-land, this method will be called to create a response object. Any additional arguments passed when adding the extension will be passed through verbatim in @parameters.

You can return "undef" here if you have nothing useful to return. πŸ“

⭐ CLASS->received_response(\%args) ⭐

In consumer-land, when a caller asks for the request object for your extension in Net::OpenID::VerifiedIdentity this method will be called to create a response object. %args maps the aliases you returned from the "namespace_uris" method to a hashref of the key-value pairs provided in that namespace.

You can return "undef" here if you have nothing useful to return. 😭


mwah πŸ’‹ this page is from perl v5.42.0, dated 2016-02-13, and it's literally the Net::Op...tension(3) manual β€” user-contributed Perl documentation energy, periodt. βœ¨πŸ‘‘

πŸ“¦ where this page comes from