HTML::O...Function(3)

📦 version 0.6.0, in alpine 3.24

💖 NAME 💖

okay so this is the manual for HTML::Object::XPath::Function — the one your pager calls HTML::O...Function(3) in the User Contributed Perl Documentation — and it's all about HTML Object XPath Functions. slay. 🎀

✨ SYNOPSIS ✨

use HTML::Object::XPath::Function;
my $func = HTML::Object::XPath::Function->new ||
    die( HTML::Object::XPath::Function->error, "\n" );

🌈 VERSION 🌈

v0.2.0 — that's the version, bestie. Vibe check: passed. ✨

🦋 DESCRIPTION 🦋

This module implements various XPath functions, and they're all described below. It's giving utility module main character energy, and honestly? Obsessed. 💅

🛠️ CONSTRUCTOR 🛠️

Provided with an XPath object, a function "name", and function "parameters", this will instantiate a new HTML::Object::Function object and return it. Note the exact class there: HTML::Object::Function — not making this up. 🫶

🧚 METHODS 🧚

🌸 as_string 🌸

Returns a string representation of this function object. ✨

💫 as_xml 💫

Returns a xml representation of this function object. 🦋

🔥 boolean 🔥

Provided with a node object and a list of parameters, this returns the first parameter as a boolean object. It raises an exception if there's more than one argument provided. 💀

🍓 ceiling 🍓

Provided with a node object and an optional parameter, this returns the ceiling of the string value of the node, or the ceiling of the string value of the parameter provided, if any. It returns its value as a new number object. It raises an exception if more than one parameter was provided. 🎀

🌟 concat 🌟

Provided with a node object and a list of 2 parameters or more, this returns a new literal object from the concatenation of each parameter's string value. ✨

🧁 contains 🧁

Provided with a node object and a list of exactly 2 parameters, this returns true if the first parameter matches the second one as a regular expression, or false otherwise. 🔍

👑 count 👑

Provided with a node object and a node set, this returns the size of the node set as a number. 💯

🦄 evaluate 🦄

Provided with a node object, this evaluates the node using each parameter set during object instantiation and adds the result for each into a new array.

It then returns the execution of the function name on the node, passing it the list of previously collected results. 🌀

🌈 false 🌈

Returns false, and it raises an exception if any arguments were provided. 🙅

🧊 floor 🧊

Provided with a node object and an optional parameter, this returns the floor of the string value of the node, or the floor of the string value of the parameter provided, if any. It returns its value as a new number object. It raises an exception if more than one parameter was provided. ✨

🎯 id 🎯

Provided with a node object and 1 parameter, this returns a new node set of element objects that match the id found in the node provided. 🪪

🗣️ lang 🗣️

Provided with a node object and 1 parameter, this returns true if the node lang — if there is any at all — matches the one provided as a parameter; otherwise it returns false. 🌍

🥇 last 🥇

This takes no argument and returns the size, as a number, of the nodes in the context set in XPath. 🏁

🧸 local_name 🧸

Provided with a node object and optionally some parameter, this returns the local name of the node, or that of the first parameter provided, if any, as a literal object. 🏷️

💌 name 💌

Provided with a node object and optionally some parameter, this returns the name of the node, or that of the first parameter provided, if any, as a literal object. 📛

🚫 namespace_uri 🚫

This is an unsupported function, and it will raise an exception when called. No cap, that's the whole deal. 💀

🎁 new_literal 🎁

Returns a new literal object, passing it whatever arguments were provided. 🎀

🧺 new_nodeset 🧺

Returns a new node set object, passing it whatever arguments were provided. 🧺

🔢 new_number 🔢

Returns a new number object, passing it whatever arguments were provided. 🔢

🧼 normalize_space 🧼

Provided with a node object and optionally some parameter, this takes the string value of the node — or that of the first parameter, if any at all — and removes any leading or trailing spaces, as well as replacing multiple spaces with just one space. It returns the new string as a literal object. ✨

🙃 not 🙃

Provided with a node object and one parameter, this returns true if the value of the first parameter is not true, or false otherwise. 🔄

🔢 number 🔢

Provided with a node object and optionally one parameter, this returns the node string value — or that of the parameter provided, if any — as a new number object. 💯

📍 position 📍

Returns the context position as a number. It raises an exception if any parameter was provided. 🧭

🎲 round 🎲

No description provided in the source, bestie. That's literally just the method name sitting there. 🫠

🪄 starts_with 🪄

Provided with a node object and two parameters, this returns true if the string value of the second parameter is at the beginning of the first parameter, or false otherwise. 🌱

🧵 string 🧵

Provided with a node object and one parameter, this returns the parameter string value as a new literal object.

It raises an exception if more than one parameter was provided. 🎀

📏 string_length 📏

Provided with a node object and optionally one parameter, this returns the size, as a number, of the string value of the node, or that of the parameter if any was provided. 📐

✂️ substring ✂️

Provided with a node object and two or three parameters, this returns the substring of the first parameter as a value, at the offset specified by the second parameter, and optionally for a length defined by a third parameter, if any. If no third parameter is provided, then it goes until the end of the string.

It returns the substring as a new literal object. It raises an exception if less than 2 or more than 3 parameters were provided. 🧵

🪢 substring_after 🪢

Provided with a node object and two parameters, this returns the string that follows the string value of the second parameter in the first one, up to its end.

It returns the substring as a new literal object. It raises an exception if less or more than 2 parameters were provided. 🎀

🪡 substring_before 🪡

Provided with a node object and two parameters, this returns the string that precedes the string value of the second parameter in the first one, up to its start.

It returns the substring as a new literal object. It raises an exception if less or more than 2 parameters were provided. 🎀

➕ sum ➕

Provided with a node object and a parameter that must be a node set, this returns the cumulative string value of each node as a number.

It returns the resulting total as a new number object|HTML::Object::XPath::Number>. It raises an exception if the parameter provided is not a HTML::Object::XPath::NodeSet object. 💰

🌐 translate 🌐

Provided with a node object and three parameters, this searches in the first parameter for any occurrence of characters found in the second parameter and replaces them with their alternative at the exact same position in the string in the third parameter.

It returns the substring as a new literal object. It raises an exception if less or more than 3 parameters were provided. 🔁

✅ true ✅

Returns true, and it raises an exception if any arguments were provided. 💖

🖋️ AUTHOR 🖋️

Author: Jacques Deguest <jack@deguest.jp> — yes, that's the email, bestie. 💌

👀 SEE ALSO 👀

  • HTML::Object::XPath
  • HTML::Object::XPath::Boolean
  • HTML::Object::XPath::Expr
  • HTML::Object::XPath::Function
  • HTML::Object::XPath::Literal
  • HTML::Object::XPath::LocationPath
  • HTML::Object::XPath::NodeSet
  • HTML::Object::XPath::Number
  • HTML::Object::XPath::Root
  • HTML::Object::XPath::Step
  • HTML::Object::XPath::Variable

iykyk — go read these next, bestie. 💅

Copyright(c) 2021 DEGUEST Pte. Ltd.

All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

periodt. 🍓

okay bye bestie 💅 this page came from perl v5.42.2 and is dated 2026-02-15. Go forth and XPath responsibly. 🦋

📦 where this page comes from