UR::Ro...ototype(3pm)

✨ UR::Role::Prototype — the manual page 💖

okay so bestie, this page lives in the User Contributed Perl Documentation section, and it's about UR::Role::Prototype — aka the whole entire implementation for defining and composing roles 🎀

---

🌸 NAME 🌸

UR::Role::Prototype — literally the implementation for defining and composing roles, periodt 💅

---

🦋 DESCRIPTION 🦋

So the basic deets on using roles? Those live in the documentation for UR::Role. Go read that first, bestie, no cap 🙈

Here's the tea: when a role gets defined using the role keyword, it creates a UR::Role::Prototype instance. Role prototypes represent an uncomposed role. And the way they have, like, most of the same properties as UR::Object::Type instances? Iconic. Chef's kiss. 👑

---

💜 Methods 💜

okay these are the methods, let's go one by one, don't skip 🫶

• property_data($property_name) — Returns a hashref of property data about the named property. Just hand it a name, get the data back. Slay. ✨
• has_property_names() — Returns a list of all the properties named in the role's has. All of them. Every single one. 💖
• id_by_property_names() — Returns a list of all the properties named in the roles's id_by. (yes the original says "roles's", we don't fix it, we respect it 😭)
• method_names() — Returns a list of all the function names in the role's namespace. Vibe check on the whole namespace, fr fr. 🌈
• define(%role_definition) — Define a role and return the role prototype. That's the whole gig. 🎀
• role_name() — Return the name of the role. Simple, clean, main character energy. 👑
• class_names() — Returns a list of the names of the classes composing this role. The whole squad. 💅
• requires() — Returns an arrayref of strings. These strings must exist in composing classes, either as properties or methods. Not optional, bestie, it's a requirement, hence the name 😌
• excludes() — Returns an arrayref of role names that may not be composed with this role. It's giving "you can't sit with us" 💀

---

🧚 Role namespace methods 🧚

so when a role is defined, these methods get injected into the role's namespace. injected!! like little gifts 🎁

• create(%params) — Return a UR::Role::PrototypeWithParams object representing this role with a set of params immediately before it is composed into a class. Peep the section on Parameterized Roles in UR::Role for the full lore. 🍓
• __role__() — Calls the above create() method with no arguments. This is used by the role composition mechanism to trigger autoloading the role's module when role names are given as strings in a class definition. Lowkey the secret sauce 🔥

---

⭐ SEE ALSO ⭐

go read these next, bestie, iykyk:

• UR
• UR::Object::Type::Initializer
• UR::Role::Instance
• UR::Role::PrototypeWithParams

---

and that's the whole page, we ate and left no crumbs 💖✨

shoutout to the source: this came from perl v5.32.1, dated 2022-01-17, filed under UR::Ro...ototype(3pm) in the User Contributed Perl Documentation. mwah, bye bestie 🫶🎀