PFT::Map::Index(3)

💖 PFT::Map::Index 💖

okay bestie, gather round, because this is PFT::Map::Index from the User Contributed Perl Documentation collection and it is literally the little symbol-resolver that could. no cap, this module resolves symbols in PFT Entries and honestly? iconic behaviour. 🎀

---

✨ NAME ✨

PFT::Map::Index — Resolve symbols in PFT Entries 💅

---

🌸 SYNOPSIS 🌸

okay so there are like three whole moods you can be in here, and we're gonna walk through every single one.

Explicit construction — you're doing it yourself, main character energy:

use PFT::Map::Index;

die unless $map->isa('PFT::Map');
my $index = PFT::Map::Index->new($map);

Using map property — letting the map hand you one, lowkey easier:

my $index = $map->index;

Resolution — the actual moment we've all been waiting for, bestie:

die unless $node->isa('PFT::Map::Node');
die unless $sym->isa('PFT::Text::Symbol');
$index->resolve($node, $sym);

---

🦋 DESCRIPTION 🦋

So a PFT::Map::Index object handles the unique identifiers of content items that are mapped in a PFT::Map object. That's its whole job and it does it gorgeously, fr fr.

You can use it to resolve symbols of a PFT::Map::Node, or to query the map — for example, the set of entries between date X and date Y. so versatile. 🫶

🍓 Properties 🍓

• map — Reference to the associated map. that's it, that's the property. simple, elegant, slay. ✨

💜 Methods 💜

content_id

Given a PFT::Content::Base object (or any subclass of it, we love an inheritance moment 👑), this returns a string that uniquely identifies it across the site. E.g.:

my $id = $resolver->content_id($content);
my $id = $resolver->content_id($virtual_page, $hdr);
my $id = $resolver->content_id(undef, $hdr);

okay so about that header — the header is optional for the first two forms. unless you supply it, it'll be retrieved by the content. but in the third form the content is not supplied, so the header is mandatory. no header, no id, bestie. that's the rule. 💀

resolve

The function resolves a symbol retrieved from the text of a PFT::Map::Node. The returned value will be one of the following:

• A list of nodes (i.e. a PFT::Map::Node instances); 💖
• A list of strings (e.g. http://manpages.org); 🌈
• An empty list (meaning: failed resolution). 😭

okay so that last one? an empty list means the resolution failed. not me getting an empty list and thinking everything was fine. 🙈

---

and that's the whole page, babe. this was perl v5.42.0, dated 2025-07-25 — go forth and resolve those symbols. periodt. 💅✨🎀