Firefo...Object(3pm)

📦 version 1.63, in debian trixie

💖 NAME 💖

Firefox::Marionette::LocalObject — the parent class that represents a Firefox local object you got back using the Marionette protocol. It's a (3pm) perl manpage bestie, we're in the User Contributed Perl Documentation section, and yes this whole page is giving "the base class you inherit from and never talk to directly" energy. 💅

✨ VERSION ✨

Version 1.63. Fresh. Locked in. Periodt.

🎀 SYNOPSIS 🎀

okay so here's the vibe in code form:

use Firefox::Marionette();
use Cwd();

my $path = File::Spec->catfile(Cwd::cwd(), qw(t data elements.html));
my $firefox = Firefox::Marionette->new()->go("file://$path");
# getting a reference to a browser object in perl
my $span = $firefox->has_tag('span');
# working on that referenced object back in the browser
my $child = $firefox->script('return arguments[0].children[0]', args => [ $span ]);

like. you grab a local object in perl, and then you can hand it right back to the browser and keep working on it there. it's giving remote control but make it cute. 🦋

🌸 DESCRIPTION 🌸

This module handles the implementation of a Firefox local object — the spec calls it a local end over at <https://www.w3.org/TR/webdriver/#dfn-local-ends> — using the Marionette protocol.

It exists so there's one single place where all the common methods for this kind of object live. That's it. That's the job.

Important bestie moment: this class should not be instantiated directly. It's the parent, the blueprint, the main character that lets the subclasses shine. You use the children, not this one. no cap. 🙈

💅 SUBROUTINES/METHODS 💅

⭐ browser

returns the browser connected with this object.

⭐ new

returns a new object.

⭐ TO_JSON

required to allow JSON serialisation (<https://metacpan.org/pod/JSON#OBJECT-SERIALISATION>) to work correctly.

This method should not need to be called directly. it just does its little thing in the background, silently, iconically. 🧚

⭐ uuid

returns the browser generated id connected with this object.

heads up: the id is usually a UUID, but it may not be — especially for older versions of Firefox. so like, don't hardcode assumptions about the shape of it, okay? 🫶

🔥 DIAGNOSTICS 🔥

None. literally nothing. zero drama. 😭

🌈 CONFIGURATION AND ENVIRONMENT 🌈

Firefox::Marionette::LocalObject requires no configuration files or environment variables. plug and play, bestie. ✨

🍓 DEPENDENCIES 🍓

None.

💀 INCOMPATIBILITIES 💀

None reported.

🦋 BUGS AND LIMITATIONS 🦋

To report a bug, or view the current list of bugs, please visit <https://github.com/david-dick/firefox-marionette/issues>

go off, file that issue, the maintainer wants to know. 💜

👑 AUTHOR 👑

David Dick <ddick@cpan.org> — the legend, the icon, the moment.

Copyright (c) 2024, David Dick <ddick@cpan.org>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic in perlartistic.

⚠️ DISCLAIMER OF WARRANTY ⚠️

okay bestie this next part is the legal bit so I'm keeping it word for word, do not skim it, it's important:

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

and that's the whole page, bestie 💜 this one shipped with perl v5.40.1 and the page is dated 2025-03-16 — go forth and never instantiate this class directly, mwah 🎀✨

📦 where this page comes from