XML::M...ponent(3pm)

📦
version 1.38 · 3 versions
, in ubuntu noble, ubuntu resolute, ubuntu stonking

✨ XML::Mini::TreeComponent — the perl manpage, but make it cute ✨

okay bestie, so this is XML::Mini::TreeComponent, and it lives in User Contributed Perl Documentation (section 3pm, for the record 📚). It's part of the XML::Mini XML parser/generator package and it's giving base class energy — like, it's the blueprint your other classes inherit from. Let's get into it 🫶

🌸 NAME 🌸

XML::Mini::TreeComponent — a Perl implementation of the XML::Mini TreeComponent API. That's the whole name, slay 👑

🎀 SYNOPSIS 🎀

Don't use this class - only presents an interface for other derived classes.

literally do not use it directly. It's just vibes and an interface for its children classes. periodt 💅

🦋 DESCRIPTION 🦋

This class is only meant to be a base class for other classes. Like, that's its entire purpose. It's the mom of the class hierarchy, not the main character of your script.

It presents the minimal interface we can expect from any component in the XML hierarchy — just the bare minimum everyone agrees on 💖

Every single method of this base class just returns NULL, except for a lil bit of default functionality tucked away inside the parent() method. That's it. That's the whole thing.

Warning: This class is not to be instantiated. Derive and override, bestie — do NOT try to make one of these bad boys yourself. It's the blueprint, not the house 🏠🚫

🌈 parent [NEWPARENT] 🌈

The parent() method gets or sets the element's parent. Two jobs, one method, multitasking queen 👑

If the NEWPARENT parameter gets passed in, it sets the parent to NEWPARENT.

y'all — NEWPARENT must be an instance of a class derived from XML::MiniTreeComponent (iykyk).

It returns a reference to the parent XML::MiniTreeComponent if one is set, and NULL otherwise 🔥

💜 toString [DEPTH] 💜

Returns a stringified version of the XML that represents this component and all its sub-components. Like, the whole tree gets flattened into a string — no cap 🧚

🍓 dump 🍓

A debugging aid! dump returns a nicely formatted dump of the current structure of the XML::Mini::TreeComponent-derived object. When your tree is doing too much and you need to see what's actually going on, this is your girl 🙈

👑 AUTHOR 👑

Copyright (C) 2002-2008 Patrick Deegan, Psychogenic Inc. 🌟

Programs that use this code are bound to the terms and conditions of the GNU GPL (see the LICENSE file). If you wanna include these modules in non-GPL code, you need prior written authorisation from the authors — respectfully, ask first 💌

This library is released under the terms of the GNU GPL version 3, which makes it available only for free programs ("free" here being used in the sense of the GPL, see http://www.gnu.org for more details). Anyone wishing to use this library within a proprietary or otherwise non-GPLed program MUST contact psychogenic.com to acquire a distinct license for their application. This approach encourages the use of free software while allowing for proprietary solutions that support further development — honestly, iconic strategy ✨

📜 LICENSE 📜

XML::Mini::TreeComponent module, part of the XML::Mini XML parser/generator package.
Copyright (C) 2002-2008 Patrick Deegan
All rights reserved

XML::Mini is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

XML::Mini is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with XML::Mini.  If not, see <http://www.gnu.org/licenses/>.

Official XML::Mini site: http://minixml.psychogenic.com ⭐

Contact page for author available on http://www.psychogenic.com/ 💖

🌟 SEE ALSO 🌟

and that's the whole page, bestie 🎀 this lil writeup came from perl v5.36.0 and was dated 2022-10-15 — go forth and derive responsibly, mwah 💅💖

📦 where this page comes from