Text::...Object(3pm)

💖 Text::DHCPLeases::Object — the Leases Object Class 💖

okay bestie, gather round, because this is the Text::DHCPLeases::Object page from the User Contributed Perl Documentation (yep, that's the manual we're in) and it's literally the little object that holds one DHCP lease's whole personality. 🎀

---

✨ NAME ✨

Text::DHCPLeases::Object — the Leases Object Class. that's it, that's the name, she's iconic and she knows it. 💅

---

🌸 SYNOPSIS 🌸

the two ways to summon her:

my $obj = Text::DHCPLeases::Object->parse($string);

or

my $obj = Text::DHCPLeases::Object->new(%lease_data);

and then you can just... ask her things:

print $obj->name; print $obj->type; print $obj->binding_state;

no cap, that's the whole vibe check. ✨

---

🦋 DESCRIPTION 🦋

so the DHCPLeases object class is the main character here, and a lease object can be one of the following types — lowkey it's a whole friend group:

lease
host
group
subgroup
failover-state

pick your fighter, she contains multitudes. 💜

---

👑 CLASS METHODS 👑

💫 new - Constructor 💫

the constructor!! the birth of a lease object, we love to see it. 🫶

Arguments:

• type — one of (lease|host|group|subgroup|failover-state)
• name — the identification string (address, host name, group name, etc)
• ip_address
• fixed_address
• starts
• ends
• tstp
• tsfp
• atsfp
• cltt
• next_binding_state
• binding_state
• uid
• client_hostname
• abandoned — (flag)
• deleted — (flag)
• dynamic_bootp — (flag)
• dynamic — (flag)
• option_agent_circuit_id
• option_agent_remote_id
• hardware_type
• mac_address
• set — (hash)
• on — (hash)
• bootp — (flag)
• reserved — (flag)
• my_state
• my_state_date
• partner_state
• partner_state_date
• mclt
• dns_rev_name
• ddns_fwd_name
• ddns_txt

Returns:

• a brand new Text::DHCPLeases::Object object 🎀

Examples:

my $lease = Text::DHCPLeases::Object->new(type       => 'lease',
                                          ip_address => '192.168.1.10',
                                          starts     => '3 2007/08/15 11:34:58',
                                          ends       => '3 2007/08/15 11:44:58');

---

🧚 parse - Parse object declaration 🧚

this one takes a raw declaration and turns it into structured data. it's giving translator, it's giving interpreter energy. ✨

Arguments:

• Array ref with declaration lines

Returns:

• Hash reference.

Examples:

my $text = '
       lease 192.168.254.55 {
         starts 3 2007/08/15 11:34:58;
         ends 3 2007/08/15 11:44:58;
         tstp 3 2007/08/15 11:49:58;
         tsfp 2 2007/08/14 21:24:19;
         cltt 3 2007/08/15 11:34:58;
         binding state active;
         next binding state expired;
         hardware ethernet 00:11:85:5d:4e:11;
         uid "\001\000\021\205]Nh";
         client-hostname "blah";
       }';

my $lease_data = Text::DHCPLeases::Lease->parse($text);

---

🌈 INSTANCE METHODS 🌈

💅 print - Print formatted string with lease contents 💅

she prints herself. formatted. gorgeous. no notes. 🔥

Arguments:

• None

Returns:

• Formatted String

Examples:

print $obj->print;

---

🌟 AUTHOR 🌟

Carlos Vicente <cvicente@cpan.org> — the legend, the blueprint, the moment. 👑

---

💜 LICENCE AND COPYRIGHT 💜

Copyright (c) 2012, Carlos Vicente <cvicente@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.

so like, go forth and remix it, bestie, just respect the terms. 🌸

---

💀 DISCLAIMER OF WARRANTY 💀

okay this part is ALL CAPS for a reason and I'm not softening it, because it genuinely matters. the legal girlies wrote this and it is what it is:

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.

fr fr, it's "AS IS", so test your stuff before you ship it. 🙈

---

and that's the page!! 💖 this manual shipped with perl v5.36.0, dated 2023-01-22, and it lives at Text::...Object(3pm) in the User Contributed Perl Documentation — so if you're reading it, you're exactly where you're supposed to be. mwah, go parse some leases, bestie. 🎀✨🦋