MQdb::DBObject(3pm)

💖 MQdb::DBObject — bestie, it's the blueprint 💖

User Contributed Perl Documentation · MQdb::DBObject(3pm) · ok so sit down, hydrate, and let's talk about the literal blueprint of the whole toolkit 🦋

---

✨ NAME ✨

MQdb::DBObject — DESCRIPTION of Object 🌸 (yes that's the actual NAME line, it's giving mysterious, we love that for it)

---

🌈 SYNOPSIS 🌈

Root class for all objects in MappedQuery toolkit

that's it. that's the synopsis. no arguments, no options, no drama — it's just the mom friend of the class hierarchy. 👑

---

🎀 DESCRIPTION 🎀

OK so here's the tea bestie 🍓 — MQdb::DBObject is the root object for the toolkit and for every derived subclass that comes from it. Literally everything in the MappedQuery structure is designed to be persisted in a database. And when we say "database" we mean it in the broad sense, like, any object persistence system counts. Currently the toolkit works with SQL based systems, but object databases or custom storage engines? Also possible, no cap. 💅

It provides the base common methods that all the objects use. So like, every subclass gets to inherit the basics and go be its own main character. 🌟

---

💜 AUTHOR 💜

Contact Jessica Severin: jessica.severin@gmail.com 📧 — hi Jessica, icon behaviour fr fr 🫶

---

📜 LICENSE 📜

this part is legally important so we're keeping every single word exactly as written, bestie — no edits, no vibes, just facts:

 * Software License Agreement (BSD License)
 * MappedQueryDB [MQdb] toolkit
 * copyright (c) 2006-2009 Jessica Severin
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Jessica Severin nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

read it, don't skim it, it's literally a whole BSD license bestie 😭

---

🧚 APPENDIX 🧚

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _ — so if you see an underscore, that's the secret menu, iykyk 🙈

---

🌸 new

• Description — instance creation method 🎉
• Returntype — instance of this Class (subclass)
• Exceptions — none

baby's first method, it just makes you a new one. iconic.

---

🌸 init

• Description — initialization method which subclasses can extend
• Returntype — $self
• Exceptions — subclass dependent

---

🌸 copy

• Description — Shallow copy which copies all base attributes of object to new instance of same class
• Returntype — same as calling instance
• Exceptions — subclass dependent

shallow. say it with me. SHALLOW copy. it's not cloning your whole soul, just the base attributes 💅

---

🌸 class

• Description — fixed string symbol for this class. Must be implemented for each subclass and each subclass within toolkit should return a unique name. used by global methods.
• Returntype — string
• Exceptions — error if subclass does not redefine

bestie if your subclass doesn't redefine this you're getting an ERROR. no unique name, no entry. periodt. 💀

---

🌸 database

• Description — the MQdb::Database where this object is permanently persisted to. Here database is any object persistance system.
• Returntype — MQdb::Database
• Exceptions — die if invalid setter value type is provided

set it to the wrong type and it will literally die on you 😭 vibe check failed.

---

🌸 primary_id

• Description — the unique identifier for this object within database.
• Returntype — scalar or UNDEF
• Exceptions — none

---

🌸 id

• Description — the unique identifier for this object within database. Returns empty string if not persisted.
• Returntype — scalar or ''
• Exceptions — none

not persisted yet? you get the empty string, babe. it's a ✨placeholder era✨

---

🌸 db_id

• Description — the worldwide unique identifier for this object. A URL-like combination of database, class, and id
• Returntype — string or undef if database is not defined
• Exceptions — none

worldwide unique!! it's the passport of object identifiers 🛂✨

---

🌸 display_desc

• Description — general purpose debugging method that returns a nice human readable description of the object instance contents. Each subclass should implement and return a nice string.
• Returntype — string scalar
• Exceptions — none

---

🌸 display_info

• Description — convenience method which prints the display_desc string with a carriage return to STDOUT. useful for debugging.
• Returntype — none
• Exceptions — none

it just prints to STDOUT with a carriage return, that's the whole job, and honestly? relatable. 🫶

---

🌸 xml

• Description — every object in system should be persistable in XML format. returns an XML description of the object and all child objects. Each subclass must implement and return a proper XML string. Best if one implements xml_start() and xml_end() and use here.
• Returntype — string scalar
• Exceptions — none
• Default — default is a simple xml_start + xml_end

---

🌸 xml_start

• Description — every object in system should be persistable in XML format. returns an XML description of the object and all child objects. Each subclass should OVERRIDE this method and return a proper XML string. xml_start is the primary XML start tag
• Example — return sprintf("<feature id='%d' name='%d' ..... >", $id, $name....);
• Returntype — string scalar
• Exceptions — none

OVERRIDE. THIS. bestie, it's in all caps in the original for a reason 🔥

---

🌸 xml_end

• Description — every object in system should be persistable in XML format. returns an XML description of the object and all child objects. Each subclass should OVERRIDE this method and return a proper XML string. xml_end is the primary XML end tag
• Example — return "</feature>";
• Returntype — string scalar
• Exceptions — none

---

🌸 simple_xml

• Description — short hand for xml_start() . xml_end() Can be used when only the primary XML start tag and attributes are needed No need to override if xml_start() and xml_end() are implemented
• Returntype — string scalar
• Exceptions — none

the lazy girl's dream: if you already did xml_start() and xml_end(), you do NOT have to override this one. slay. 💅

---

and that's the whole page bestie!! every method, every returntype, every exception, nothing skipped, we ate and left no crumbs 🍓✨

this page was brought to you by perl v5.36.0, dated 2022-12-13, in the MQdb::DBObject(3pm) manual — mwah, go persist something 💖🦋👑