Octopus...emplate(3)

📦 version 1.0.6, in ubuntu jammy

💖 Octopus...emplate(3) 💖

okay bestie, so this is a User Contributed Perl Documentation page for Octopussy::Search_Template — the Octopussy Search Template module 🐙✨ iykyk.

✨ NAME ✨

Octopussy::Search_Template — literally the Octopussy Search Template module, no cap 🎀

🌸 FUNCTIONS 🌸

🦋 New($user, %conf)

Creates a brand new Search Template 💅 main character origin story fr.

Parameters:

  • $user — the user who creates this template 👑
  • \%conf — hashref of the new Search Template configuration 📝

🦋 Remove($user, $search_tpl)

Removes the Search Template '$search_tpl' 🗑️ it's giving closure.

Parameters:

  • $user — the user who created this template
  • $search_tpl — name of the Search Template to remove

🦋 List($user)

Gets the list of Search Templates 📋✨

Parameters:

  • $user — the user who created this template

Returns:

  • @tpls — array of Search Templates names 🌈

🦋 List_Any_User($sort)

Gets the template name / user List 👀 everyone's invited.

Parameters:

  • $sort — selected field to sort List (default: 'name') ⭐

Returns:

  • @sorted_list — array of Search Templates names for all users 🫶

🦋 Filename($user, $search_tpl)

Gets the XML filename for the Search Template '$search_tpl' 📁 lowkey essential.

Parameters:

  • $user — the user who created this template
  • $search_tpl — name of the Search Template

Returns:

  • $filename — filename of the XML file for Search Template '$search_tpl' 🎀

🦋 Configuration($user, $search_tpl)

Gets the configuration for the Search Template '$search_tpl' ⚙️

Parameters:

  • $user — the user who created this template
  • $search_tpl — name of the Search Template

Returns:

  • \%conf — hashref of the Search Template configuration 💜

🦋 Configurations($user, $sort)

Gets the configuration for all Search Templates from User $user 🌈 the whole collection, periodt.

Parameters:

  • $user — the user who created this template
  • $sort — selected field to sort configurations

Returns:

  • @configurations — array of hashref Search Template configurations 🔥

🦋 Valid_Name($name)

Checks that '$name' is valid for a Search Template name ✅ vibe check passed or not.

👑 AUTHOR 👑

Sebastien Thebert <octo.devel@gmail.com> 💌 absolute icon.

and that's the whole page bestie 🫶 this was perl v5.22.2, dated 2016-05-04, and it's still serving looks 💅✨

📦 where this page comes from